Skip to content

Commit 641f901

Browse files
santisqsantisq
committed
update docs
1 parent cc17859 commit 641f901

13 files changed

+76
-108
lines changed

‎docs/en-US/Connect-Kusto.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -345,7 +345,7 @@ Parameter Sets: (All)
345345
Aliases:
346346
347347
Required: True
348-
Position: Named
348+
Position: 0
349349
Default value: None
350350
Accept pipeline input: False
351351
Accept wildcard characters: False

‎docs/en-US/Invoke-KustoControlCommand.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -16,8 +16,8 @@ Invokes management commands over an Azure Data Explorer Cluster.
1616
```powershell
1717
Invoke-KustoControlCommand
1818
[-Command] <String>
19-
[-Database <String>]
20-
[[-OutputType] <OutputType>]
19+
[[-Database] <String>]
20+
[-OutputType <OutputType>]
2121
[-RequestProperties <ClientRequestProperties>]
2222
[<CommonParameters>]
2323
```
@@ -101,7 +101,7 @@ Parameter Sets: (All)
101101
Aliases:
102102
103103
Required: False
104-
Position: Named
104+
Position: 1
105105
Default value: None
106106
Accept pipeline input: False
107107
Accept wildcard characters: False
@@ -118,7 +118,7 @@ Aliases:
118118
Accepted values: PSObject, Json, Csv, DataTable, Html
119119
120120
Required: False
121-
Position: 1
121+
Position: Named
122122
Default value: PSObject
123123
Accept pipeline input: False
124124
Accept wildcard characters: False

‎docs/en-US/Invoke-KustoQuery.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -16,8 +16,8 @@ Invokes a KQL or T-SQL query over an Azure Data Explorer Cluster.
1616
```powershell
1717
Invoke-KustoQuery
1818
[-Query] <String>
19-
[-Database <String>]
20-
[[-OutputType] <OutputType>]
19+
[[-Database] <String>]
20+
[-OutputType <OutputType>]
2121
[-RequestProperties <ClientRequestProperties>]
2222
[<CommonParameters>]
2323
```
@@ -74,7 +74,7 @@ Parameter Sets: (All)
7474
Aliases:
7575

7676
Required: False
77-
Position: Named
77+
Position: 1
7878
Default value: None
7979
Accept pipeline input: False
8080
Accept wildcard characters: False
@@ -91,7 +91,7 @@ Aliases:
9191
Accepted values: PSObject, Json, Csv, DataTable, Html
9292
9393
Required: False
94-
Position: 1
94+
Position: Named
9595
Default value: None
9696
Accept pipeline input: False
9797
Accept wildcard characters: False

‎docs/en-US/New-KustoClientRequestProperties.md

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -28,7 +28,8 @@ New-KustoClientRequestProperties
2828
## DESCRIPTION
2929

3030
The `New-KustoClientRequestProperties` cmdlet can be used to create a new `ClientRequestProperties` object
31-
to manage the interaction between client and service. This object can be later on passed as argument to the request cmdlets: [`Invoke-KustoControlCommand`](Invoke-KustoControlCommand.md) and [`Invoke-KustoQuery`](Invoke-KustoQuery.md).
31+
to manage the interaction between client and service. This object can be later on passed as argument to the request cmdlets: [`Invoke-KustoControlCommand`](Invoke-KustoControlCommand.md), [`Invoke-KustoQuery`](Invoke-KustoQuery.md),
32+
[`Set-KustoBatchingPolicy`](Set-KustoBatchingPolicy.md) and [`Set-KustoIngestionMapping`](Set-KustoIngestionMapping.md).
3233

3334
The object contains the following information:
3435

@@ -58,6 +59,7 @@ $requestProps = New-KustoClientRequestProperties -Options @{
5859
request_app_name = 'myApp'
5960
norequesttimeout = $true
6061
}
62+
Invoke-KustoQuery 'SELECT top(10) * FROM MyTable' -RequestProperties $requestProps
6163
```
6264

6365
> [!TIP]

‎docs/en-US/New-KustoColumnMapping.md

Lines changed: 30 additions & 23 deletions
Original file line numberDiff line numberDiff line change
@@ -23,23 +23,44 @@ New-KustoColumnMapping
2323

2424
## DESCRIPTION
2525

26-
{{ Fill in the Description }}
26+
The `New-KustoColumnMapping` cmdlet is used to create a new object of type `ColumnMapping`, this object can be later on passed as argument to the [`New-KustoIngestionMapping`](New-KustoIngestionMapping.md) cmdlet. See [__Ingestion mappings__](https://learn.microsoft.com/en-us/kusto/management/mappings?view=microsoft-fabric) for more details.
2727

2828
## EXAMPLES
2929

30-
### Example 1
30+
### Example 1: CSV mapping
3131

3232
```powershell
33-
PS C:\> {{ Add example code here }}
33+
$columns = @(
34+
New-KustoColumnMapping event_time -Properties @{ Ordinal = 0 }
35+
New-KustoColumnMapping event_name -Properties @{ Ordinal = 1 }
36+
New-KustoColumnMapping event_type -Properties @{ Ordinal = 2 }
37+
New-KustoColumnMapping ingestion_time -Properties @{ ConstValue = '2023-01-01T10:32:00' }
38+
New-KustoColumnMapping source_location -Properties @{ Transform = 'SourceLocation' })
3439
```
3540

36-
{{ Add example description here }}
41+
Demonstrates how to create columns for a new [__CSV mapping__](https://learn.microsoft.com/en-us/kusto/management/csv-mapping?view=microsoft-fabric).
42+
43+
### Example 2: JSON Mapping
44+
45+
```powershell
46+
$columns = @(
47+
New-KustoColumnMapping event_timestamp -Properties @{Path = '$.Timestamp' }
48+
New-KustoColumnMapping event_name -Properties @{ Path = '$.Event.Name' }
49+
New-KustoColumnMapping event_type -Properties @{ Path = '$.Event.Type' }
50+
New-KustoColumnMapping source_uri -Properties @{ Transform = 'SourceLocation' }
51+
New-KustoColumnMapping source_line -Properties @{ Transform = 'SourceLineNumber' }
52+
New-KustoColumnMapping event_time -Properties @{ Path = '$.Timestamp'; Transform = 'DateTimeFromUnixMilliseconds' }
53+
New-KustoColumnMapping ingestion_time -Properties @{ ConstValue = '2021-01-01T10:32:00' }
54+
New-KustoColumnMapping full_record -Properties @{ Path = '$' })
55+
```
56+
57+
Demonstrates how to create columns for a new [__JSON mapping__](https://learn.microsoft.com/en-us/kusto/management/json-mapping?view=microsoft-fabric).
3758

3859
## PARAMETERS
3960

4061
### -Name
4162

42-
{{ Fill Name Description }}
63+
Specifies the Target column name in the table.
4364

4465
```yaml
4566
Type: String
@@ -55,7 +76,7 @@ Accept wildcard characters: False
5576
5677
### -Properties
5778
58-
{{ Fill Properties Description }}
79+
Property-bag containing properties specific for each mapping as described in each specific mapping type page.
5980
6081
```yaml
6182
Type: Hashtable
@@ -71,7 +92,7 @@ Accept wildcard characters: False
7192
7293
### -Type
7394
74-
{{ Fill Type Description }}
95+
Specifies the Datatype with which to create the mapped column if it doesn't already exist in the table.
7596
7697
```yaml
7798
Type: ColumnType
@@ -86,22 +107,6 @@ Accept pipeline input: False
86107
Accept wildcard characters: False
87108
```
88109
89-
### -ProgressAction
90-
91-
{{ Fill ProgressAction Description }}
92-
93-
```yaml
94-
Type: ActionPreference
95-
Parameter Sets: (All)
96-
Aliases: proga
97-
98-
Required: False
99-
Position: Named
100-
Default value: None
101-
Accept pipeline input: False
102-
Accept wildcard characters: False
103-
```
104-
105110
### CommonParameters
106111
107112
This cmdlet supports the common parameters.
@@ -118,3 +123,5 @@ For more information, see [about_CommonParameters](http://go.microsoft.com/fwlin
118123
## NOTES
119124
120125
## RELATED LINKS
126+
127+
[__Ingestion mappings__](https://learn.microsoft.com/en-us/kusto/management/mappings?view=microsoft-fabric)

‎docs/en-US/New-KustoIngestionMapping.md

Lines changed: 20 additions & 29 deletions
Original file line numberDiff line numberDiff line change
@@ -9,53 +9,56 @@ schema: 2.0.0
99

1010
## SYNOPSIS
1111

12-
{{ Fill in the Synopsis }}
12+
Creates a `IngestionMapping` object.
1313

1414
## SYNTAX
1515

1616
```powershell
1717
New-KustoIngestionMapping
18-
[-Kind <IngestionMappingKind>]
18+
[[-Kind] <IngestionMappingKind>]
1919
[-Reference <String>]
20-
[-Columns <ColumnMapping[]>]
20+
[[-Columns] <ColumnMapping[]>]
2121
[<CommonParameters>]
2222
```
2323

2424
## DESCRIPTION
2525

26-
{{ Fill in the Description }}
26+
The `New-KustoIngestionMapping` is used to create a new object of type `IngestionMapping` that can be later on passed as argument to the [`Invoke-KustoIngestFromStorage`](Invoke-KustoIngestFromStorage.md), [`Invoke-KustoIngestFromStream`](Invoke-KustoIngestFromStream.md) and [`Set-KustoIngestionMapping`](Set-KustoIngestionMapping.md) commands.
2727

2828
## EXAMPLES
2929

30-
### Example 1
30+
### Example 1: Create a new Ingestion Mapping object
3131

3232
```powershell
33-
PS C:\> {{ Add example code here }}
34-
```
33+
$columns = @(
34+
New-KustoColumnMapping ....
35+
New-KustoColumnMapping ....
36+
New-KustoColumnMapping ....)
3537
36-
{{ Add example description here }}
38+
$mapping = New-KustoIngestionMapping -Columns $columns -Kind Json
39+
```
3740

3841
## PARAMETERS
3942

4043
### -Columns
4144

42-
{{ Fill Columns Description }}
45+
Specifies an array of `ColumnMapping` objects to be used with the ingestion mapping. See [`New-KustoColumnMapping`](New-KustoColumnMapping.md) for details on how to create new column mappings.
4346

4447
```yaml
4548
Type: ColumnMapping[]
4649
Parameter Sets: (All)
4750
Aliases:
4851

4952
Required: False
50-
Position: Named
53+
Position: 0
5154
Default value: None
5255
Accept pipeline input: False
5356
Accept wildcard characters: False
5457
```
5558
5659
### -Kind
5760
58-
{{ Fill Kind Description }}
61+
Specifies the type of mapping. __Default value is `Unknown`__.
5962

6063
```yaml
6164
Type: IngestionMappingKind
@@ -64,15 +67,15 @@ Aliases:
6467
Accepted values: Unknown, Csv, Json, Avro, Parquet, SStream, Orc, ApacheAvro, W3CLogFile
6568
6669
Required: False
67-
Position: Named
70+
Position: 1
6871
Default value: None
6972
Accept pipeline input: False
7073
Accept wildcard characters: False
7174
```
7275

7376
### -Reference
7477

75-
{{ Fill Reference Description }}
78+
A value that indicates how to map data from the source file to the actual columns in the table using a named mapping policy object.
7679

7780
```yaml
7881
Type: String
@@ -86,22 +89,6 @@ Accept pipeline input: False
8689
Accept wildcard characters: False
8790
```
8891

89-
### -ProgressAction
90-
91-
{{ Fill ProgressAction Description }}
92-
93-
```yaml
94-
Type: ActionPreference
95-
Parameter Sets: (All)
96-
Aliases: proga
97-
98-
Required: False
99-
Position: Named
100-
Default value: None
101-
Accept pipeline input: False
102-
Accept wildcard characters: False
103-
```
104-
10592
### CommonParameters
10693

10794
This cmdlet supports the common parameters.
@@ -118,3 +105,7 @@ For more information, see [about_CommonParameters](http://go.microsoft.com/fwlin
118105
## NOTES
119106

120107
## RELATED LINKS
108+
109+
[.create ingestion mapping command](https://learn.microsoft.com/en-us/kusto/management/create-ingestion-mapping-command?view=azure-data-explorer&preserve-view=true)
110+
111+
[Ingestion properties](https://learn.microsoft.com/en-us/kusto/ingestion-properties?view=microsoft-fabric#ingestion-properties)

‎docs/en-US/Set-KustoBatchingPolicy.md

Lines changed: 4 additions & 20 deletions
Original file line numberDiff line numberDiff line change
@@ -16,11 +16,11 @@ schema: 2.0.0
1616
```powershell
1717
Set-KustoBatchingPolicy
1818
[-Table] <String>
19-
[-Database <String>]
19+
[[-Database] <String>]
2020
[-MaximumBatchingTimeSpan <TimeSpan>]
2121
[-MaximumNumberOfItems <Int32>]
2222
[-MaximumRawDataSizeMB <Int32>]
23-
[[-OutputType] <OutputType>]
23+
[-OutputType <OutputType>]
2424
[-RequestProperties <ClientRequestProperties>]
2525
[<CommonParameters>]
2626
```
@@ -51,7 +51,7 @@ Parameter Sets: (All)
5151
Aliases:
5252

5353
Required: False
54-
Position: Named
54+
Position: 1
5555
Default value: None
5656
Accept pipeline input: False
5757
Accept wildcard characters: False
@@ -116,7 +116,7 @@ Aliases:
116116
Accepted values: PSObject, Json, Csv, DataTable, Html
117117

118118
Required: False
119-
Position: 1
119+
Position: Named
120120
Default value: None
121121
Accept pipeline input: False
122122
Accept wildcard characters: False
@@ -154,22 +154,6 @@ Accept pipeline input: False
154154
Accept wildcard characters: False
155155
```
156156
157-
### -ProgressAction
158-
159-
{{ Fill ProgressAction Description }}
160-
161-
```yaml
162-
Type: ActionPreference
163-
Parameter Sets: (All)
164-
Aliases: proga
165-
166-
Required: False
167-
Position: Named
168-
Default value: None
169-
Accept pipeline input: False
170-
Accept wildcard characters: False
171-
```
172-
173157
### CommonParameters
174158
175159
This cmdlet supports the common parameters.

‎docs/en-US/Set-KustoIngestionMapping.md

Lines changed: 1 addition & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -20,7 +20,7 @@ Set-KustoIngestionMapping
2020
[[-Database] <String>]
2121
-IngestionMapping <IngestionMapping>
2222
[-RemoveOldestIfRequired]
23-
[[-OutputType] <OutputType>]
23+
[-OutputType <OutputType>]
2424
[-RequestProperties <ClientRequestProperties>]
2525
[<CommonParameters>]
2626
```
@@ -154,22 +154,6 @@ Accept pipeline input: False
154154
Accept wildcard characters: False
155155
```
156156
157-
### -ProgressAction
158-
159-
{{ Fill ProgressAction Description }}
160-
161-
```yaml
162-
Type: ActionPreference
163-
Parameter Sets: (All)
164-
Aliases: proga
165-
166-
Required: False
167-
Position: Named
168-
Default value: None
169-
Accept pipeline input: False
170-
Accept wildcard characters: False
171-
```
172-
173157
### CommonParameters
174158
175159
This cmdlet supports the common parameters.

‎src/PowerShellKusto/Commands/InvokeKustoControlCommandCommand.cs

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,7 @@ public sealed class InvokeKustoControlCommandCommand : KustoReaderCommandBase
1313
[Parameter(Mandatory = true, Position = 0)]
1414
public string Command { get; set; } = null!;
1515

16-
[Parameter]
16+
[Parameter(Position = 1)]
1717
[ValidateNotNullOrEmpty]
1818
public string? Database { get; set; }
1919

0 commit comments

Comments
 (0)