-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
4 changed files
with
403 additions
and
15 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
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 |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.