add docs, still need to write them :(

santisq · Dec 19, 2024 · c1a11ff · c1a11ff
1 parent f5174c4
commit c1a11ff
Show file tree

Hide file tree

Showing 11 changed files with 521 additions and 120 deletions.
diff --git a/docs/en-US/Connect-Kusto.md b/docs/en-US/Connect-Kusto.md
@@ -17,71 +17,57 @@ schema: 2.0.0
 
 ```powershell
 Connect-Kusto
-    -Cluster <String>
+    -Cluster <Uri>
     [[-Database] <String>]
-    [-UserPrompt]
-    [-RequestProperties <ClientRequestProperties>]
-    [-ServerTimeout <TimeSpan>]
-    [-NoTruncation]
+    [-Authority <String>]
+    [-UserId <String>]
     [<CommonParameters>]
 ```
 
-### Credential
+### ClientCredential
 
 ```powershell
 Connect-Kusto
-    -Cluster <String>
+    -Cluster <Uri>
     [[-Database] <String>]
     -Authority <String>
     -ClientSecretCredential <PSCredential>
-    [-RequestProperties <ClientRequestProperties>]
-    [-ServerTimeout <TimeSpan>]
-    [-NoTruncation]
     [<CommonParameters>]
 ```
 
 ### Certificate
 
 ```powershell
 Connect-Kusto
-    -Cluster <String>
+    -Cluster <Uri>
     [[-Database] <String>]
     -Authority <String>
     -ClientId <String>
     -Certificate <X509Certificate2>
     [-UseTrustedIssuer]
-    [-RequestProperties <ClientRequestProperties>]
-    [-ServerTimeout <TimeSpan>]
-    [-NoTruncation]
     [<CommonParameters>]
 ```
 
 ### CertificateThumbprint
 
 ```powershell
 Connect-Kusto
-    -Cluster <String>
+    -Cluster <Uri>
     [[-Database] <String>]
     -Authority <String>
     -ClientId <String>
     -Thumbprint <String>
-    [-RequestProperties <ClientRequestProperties>]
-    [-ServerTimeout <TimeSpan>]
-    [-NoTruncation]
     [<CommonParameters>]
 ```
 
 ### Identity
 
 ```powershell
 Connect-Kusto
-    -Cluster <String>
+    -Cluster <Uri>
     [[-Database] <String>]
     [-Identity]
     [-ClientId <String>]
-    [-RequestProperties <ClientRequestProperties>]
-    [-ServerTimeout <TimeSpan>]
-    [-NoTruncation]
     [<CommonParameters>]
 ```
 
@@ -107,7 +93,19 @@ PS C:\> {{ Add example code here }}
 
 ```yaml
 Type: String
-Parameter Sets: Credential, Certificate, CertificateThumbprint
+Parameter Sets: UserPrompt
+Aliases: TenantId
+
+Required: False
+Position: Named
+Default value: None
+Accept pipeline input: False
+Accept wildcard characters: False
+```
+
+```yaml
+Type: String
+Parameter Sets: ClientCredential, Certificate, CertificateThumbprint
 Aliases: TenantId
 
 Required: True
@@ -165,54 +163,6 @@ 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: False
-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 }}
@@ -245,22 +195,6 @@ 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: False
-Accept pipeline input: False
-Accept wildcard characters: False
-```
-
 ### -ClientId
 
 {{ Fill ClientId Description }}
@@ -295,7 +229,7 @@ Accept wildcard characters: False
 
 ```yaml
 Type: PSCredential
-Parameter Sets: Credential
+Parameter Sets: ClientCredential
 Aliases:
 
 Required: True
@@ -310,7 +244,7 @@ Accept wildcard characters: False
 {{ Fill Cluster Description }}
 
 ```yaml
-Type: String
+Type: Uri
 Parameter Sets: (All)
 Aliases:
 
@@ -321,14 +255,14 @@ Accept pipeline input: False
 Accept wildcard characters: False
 ```
 
-### -ProgressAction
+### -UserId
 
-{{ Fill ProgressAction Description }}
+{{ Fill UserId Description }}
 
 ```yaml
-Type: ActionPreference
-Parameter Sets: (All)
-Aliases: proga
+Type: String
+Parameter Sets: UserPrompt
+Aliases:
 
 Required: False
 Position: Named
@@ -339,7 +273,8 @@ Accept wildcard characters: False
 
 ### CommonParameters
 
-This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216).
+This cmdlet supports the common parameters.
+For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216).
 
 ## INPUTS
 

diff --git a/docs/en-US/Invoke-KustoControlCommand.md b/docs/en-US/Invoke-KustoControlCommand.md
@@ -13,9 +13,13 @@ schema: 2.0.0
 
 ## SYNTAX
 
-```
-Invoke-KustoControlCommand [-Command] <String> [-Database <String>] [[-OutputType] <OutputType>]
- [-ProgressAction <ActionPreference>] [<CommonParameters>]
+```powershell
+Invoke-KustoControlCommand
+    [-Command] <String>
+    [-Database <String>]
+    [[-OutputType] <OutputType>]
+    [-RequestProperties <ClientRequestProperties>]
+    [<CommonParameters>]
 ```
 
 ## DESCRIPTION
@@ -83,14 +87,14 @@ Accept pipeline input: False
 Accept wildcard characters: False
 ```
 
-### -ProgressAction
+### -RequestProperties
 
-{{ Fill ProgressAction Description }}
+{{ Fill RequestProperties Description }}
 
 ```yaml
-Type: ActionPreference
+Type: ClientRequestProperties
 Parameter Sets: (All)
-Aliases: proga
+Aliases:
 
 Required: False
 Position: Named
@@ -101,7 +105,8 @@ Accept wildcard characters: False
 
 ### CommonParameters
 
-This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216).
+This cmdlet supports the common parameters.
+For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216).
 
 ## INPUTS
 

diff --git a/docs/en-US/Invoke-KustoIngestFromStorage.md b/docs/en-US/Invoke-KustoIngestFromStorage.md
@@ -14,9 +14,16 @@ schema: 2.0.0
 ## SYNTAX
 
 ```powershell
-Invoke-KustoIngestFromStorage [-Path] <String> [-Table] <String> [-Database <String>]
- [-Mapping <IngestionMapping>] [-Format <DataSourceFormat>] [-IgnoreFirstRecord] [-MaxRetries <Int32>]
- [-RetryDelay <TimeSpan>] [-ProgressAction <ActionPreference>] [<CommonParameters>]
+Invoke-KustoIngestFromStorage
+    [-Path] <String>
+    [-Table] <String>
+    [-Database <String>]
+    [-Mapping <IngestionMapping>]
+    [-Format <DataSourceFormat>]
+    [-IgnoreFirstRecord]
+    [-MaxRetries <Int32>]
+    [-RetryDelay <TimeSpan>]
+    [<CommonParameters>]
 ```
 
 ## DESCRIPTION
@@ -79,7 +86,7 @@ Aliases:
 
 Required: False
 Position: Named
-Default value: None
+Default value: False
 Accept pipeline input: False
 Accept wildcard characters: False
 ```
@@ -182,7 +189,8 @@ Accept wildcard characters: False
 
 ### CommonParameters
 
-This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216).
+This cmdlet supports the common parameters.
+For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216).
 
 ## INPUTS
 

diff --git a/docs/en-US/Invoke-KustoIngestFromStream.md b/docs/en-US/Invoke-KustoIngestFromStream.md
@@ -13,10 +13,18 @@ schema: 2.0.0
 
 ## SYNTAX
 
-```
-Invoke-KustoIngestFromStream [-Stream] <Stream> [-LeaveOpen] [-Table] <String> [-Database <String>]
- [-Mapping <IngestionMapping>] [-Format <DataSourceFormat>] [-IgnoreFirstRecord] [-MaxRetries <Int32>]
- [-RetryDelay <TimeSpan>] [-ProgressAction <ActionPreference>] [<CommonParameters>]
+```powershell
+Invoke-KustoIngestFromStream
+    [-Stream] <Stream>
+    [-Table] <String>
+    [-Database <String>]
+    [-LeaveOpen]
+    [-Mapping <IngestionMapping>]
+    [-Format <DataSourceFormat>]
+    [-IgnoreFirstRecord]
+    [-MaxRetries <Int32>]
+    [-RetryDelay <TimeSpan>]
+    [<CommonParameters>]
 ```
 
 ## DESCRIPTION
@@ -79,7 +87,7 @@ Aliases:
 
 Required: False
 Position: Named
-Default value: None
+Default value: False
 Accept pipeline input: False
 Accept wildcard characters: False
 ```
@@ -95,7 +103,7 @@ Aliases:
 
 Required: False
 Position: Named
-Default value: None
+Default value: False
 Accept pipeline input: False
 Accept wildcard characters: False
 ```

diff --git a/docs/en-US/Invoke-KustoQuery.md b/docs/en-US/Invoke-KustoQuery.md
@@ -13,9 +13,13 @@ schema: 2.0.0
 
 ## SYNTAX
 
-```
-Invoke-KustoQuery [-Query] <String> [-Database <String>] [[-OutputType] <OutputType>]
- [-ProgressAction <ActionPreference>] [<CommonParameters>]
+```powershell
+Invoke-KustoQuery
+    [-Query] <String>
+    [-Database <String>]
+    [[-OutputType] <OutputType>]
+    [-RequestProperties <ClientRequestProperties>]
+    [<CommonParameters>]
 ```
 
 ## DESCRIPTION
@@ -99,6 +103,22 @@ 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
+```
+
 ### CommonParameters
 
 This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216).