Skip to content

Commit 883b46a

Browse files
StartAutomatingStartAutomating
authored andcommitted
Adding Kusto Template Support (Fixes #416)
1 parent e88ea84 commit 883b46a

File tree

1 file changed

+106
-0
lines changed

1 file changed

+106
-0
lines changed

docs/Kusto.Template.md

Lines changed: 106 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,106 @@
1+
Kusto.Template
2+
--------------
3+
4+
5+
6+
7+
### Synopsis
8+
Kusto Template Transpiler.
9+
10+
11+
12+
---
13+
14+
15+
### Description
16+
17+
Allows PipeScript to generate Kusto files.
18+
19+
Multiline comments with /*{}*/ will be treated as blocks of PipeScript.
20+
21+
Multiline comments can be preceeded or followed by 'empty' syntax, which will be ignored.
22+
23+
The Kusto Template Transpiler will consider the following syntax to be empty:
24+
25+
* ```null```
26+
* ```""```
27+
* ```''```
28+
29+
30+
31+
---
32+
33+
34+
### Parameters
35+
#### **CommandInfo**
36+
37+
The command information. This will include the path to the file.
38+
39+
40+
41+
42+
43+
44+
|Type |Required|Position|PipelineInput |
45+
|---------------|--------|--------|--------------|
46+
|`[CommandInfo]`|true |named |true (ByValue)|
47+
48+
49+
50+
#### **AsTemplateObject**
51+
52+
If set, will return the information required to dynamically apply this template to any text.
53+
54+
55+
56+
57+
58+
59+
|Type |Required|Position|PipelineInput|
60+
|----------|--------|--------|-------------|
61+
|`[Switch]`|true |named |false |
62+
63+
64+
65+
#### **Parameter**
66+
67+
A dictionary of parameters.
68+
69+
70+
71+
72+
73+
74+
|Type |Required|Position|PipelineInput|
75+
|---------------|--------|--------|-------------|
76+
|`[IDictionary]`|false |named |false |
77+
78+
79+
80+
#### **ArgumentList**
81+
82+
A list of arguments.
83+
84+
85+
86+
87+
88+
89+
|Type |Required|Position|PipelineInput|
90+
|--------------|--------|--------|-------------|
91+
|`[PSObject[]]`|false |named |false |
92+
93+
94+
95+
96+
97+
---
98+
99+
100+
### Syntax
101+
```PowerShell
102+
Kusto.Template -CommandInfo <CommandInfo> [-Parameter <IDictionary>] [-ArgumentList <PSObject[]>] [<CommonParameters>]
103+
```
104+
```PowerShell
105+
Kusto.Template -AsTemplateObject [-Parameter <IDictionary>] [-ArgumentList <PSObject[]>] [<CommonParameters>]
106+
```

0 commit comments

Comments
 (0)