Skip to content

Commit

Permalink
done with connectkusto
Browse files Browse the repository at this point in the history
  • Loading branch information
santisq committed Dec 16, 2024
1 parent d04fdc5 commit 2effebd
Show file tree
Hide file tree
Showing 4 changed files with 403 additions and 15 deletions.
339 changes: 339 additions & 0 deletions docs/en-US/Connect-Kusto.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,339 @@
---
external help file: PowerShellKusto.dll-Help.xml
Module Name: PowerShellKusto
online version:
schema: 2.0.0
---

# Connect-Kusto

## SYNOPSIS

{{ Fill in the Synopsis }}

## SYNTAX

### Credential

```powershell
Connect-Kusto
[-ClusterUri] <String>
[[-Database] <String>]
-Authority <String>
-Credential <PSCredential>
[-RequestProperties <ClientRequestProperties>]
[-ServerTimeout <TimeSpan>]
[-NoTruncation]
[<CommonParameters>]
```

### UserPrompt

```powershell
Connect-Kusto
[-ClusterUri] <String>
[[-Database] <String>]
[-Authority <String>]
[-UserPrompt]
[-RequestProperties <ClientRequestProperties>]
[-ServerTimeout <TimeSpan>]
[-NoTruncation]
[<CommonParameters>]
```

### Certificate

```powershell
Connect-Kusto
[-ClusterUri] <String>
[[-Database] <String>]
-Authority <String>
-AppId <String>
-Certificate <X509Certificate2>
[-UseTrustedIssuer]
[-RequestProperties <ClientRequestProperties>]
[-ServerTimeout <TimeSpan>]
[-NoTruncation]
[<CommonParameters>]
```

### CertificateThumbprint

```powershell
Connect-Kusto
[-ClusterUri] <String>
[[-Database] <String>]
-Authority <String>
-AppId <String>
-Thumbprint <String>
[-RequestProperties <ClientRequestProperties>]
[-ServerTimeout <TimeSpan>]
[-NoTruncation]
[<CommonParameters>]
```

### Identity

```powershell
Connect-Kusto
[-ClusterUri] <String>
[[-Database] <String>]
[-Identity]
[-RequestProperties <ClientRequestProperties>]
[-ServerTimeout <TimeSpan>]
[-NoTruncation]
[<CommonParameters>]
```

## DESCRIPTION

{{ Fill in the Description }}

## EXAMPLES

### Example 1

```powershell
PS C:\> {{ Add example code here }}
```

{{ Add example description here }}

## PARAMETERS

### -AppId

{{ Fill AppId Description }}

```yaml
Type: String
Parameter Sets: Certificate, CertificateThumbprint
Aliases:

Required: True
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```
### -Authority
{{ Fill Authority Description }}
```yaml
Type: String
Parameter Sets: Credential, Certificate, CertificateThumbprint
Aliases:

Required: True
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```
```yaml
Type: String
Parameter Sets: UserPrompt
Aliases:

Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```
### -Certificate
{{ Fill Certificate Description }}
```yaml
Type: X509Certificate2
Parameter Sets: Certificate
Aliases:

Required: True
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```
### -ClusterUri
{{ Fill ClusterUri Description }}
```yaml
Type: String
Parameter Sets: (All)
Aliases:

Required: True
Position: 0
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```
### -Credential
{{ Fill Credential Description }}
```yaml
Type: PSCredential
Parameter Sets: Credential
Aliases:

Required: True
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```
### -Database
{{ Fill Database Description }}
```yaml
Type: String
Parameter Sets: (All)
Aliases:

Required: False
Position: 1
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```
### -Identity
{{ Fill Identity Description }}
```yaml
Type: SwitchParameter
Parameter Sets: Identity
Aliases:

Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```
### -NoTruncation
{{ Fill NoTruncation Description }}
```yaml
Type: SwitchParameter
Parameter Sets: (All)
Aliases:

Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```
### -RequestProperties
{{ Fill RequestProperties Description }}
```yaml
Type: ClientRequestProperties
Parameter Sets: (All)
Aliases:

Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```
### -ServerTimeout
{{ Fill ServerTimeout Description }}
```yaml
Type: TimeSpan
Parameter Sets: (All)
Aliases:

Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```
### -Thumbprint
{{ Fill Thumbprint Description }}
```yaml
Type: String
Parameter Sets: CertificateThumbprint
Aliases:

Required: True
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```
### -UseTrustedIssuer
{{ Fill UseTrustedIssuer Description }}
```yaml
Type: SwitchParameter
Parameter Sets: Certificate
Aliases:

Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```
### -UserPrompt
{{ Fill UserPrompt Description }}
```yaml
Type: SwitchParameter
Parameter Sets: UserPrompt
Aliases:

Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```
### CommonParameters
This cmdlet supports the common parameters.
For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216).
## INPUTS
### None
## OUTPUTS
### System.Object
## NOTES
## RELATED LINKS
4 changes: 2 additions & 2 deletions module/PowerShellKusto.psd1
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@

@{
# Script module or binary module file associated with this manifest.
RootModule = 'bin/netstandard2.0/PowerShellKusto.dll'
RootModule = 'bin/net6/PowerShellKusto.dll'

# Version number of this module.
ModuleVersion = '1.0.0'
Expand All @@ -32,7 +32,7 @@
Description = 'PowerShell Module that wraps Microsoft.Azure.Kusto.Data & Microsoft.Azure.Kusto.Ingest'

# Minimum version of the PowerShell engine required by this module
PowerShellVersion = '5.1'
PowerShellVersion = '7.2.0'

# Name of the PowerShell host required by this module
# PowerShellHostName = ''
Expand Down
Loading

0 comments on commit 2effebd

Please sign in to comment.