Skip to content

Commit cb8ba4a

Browse files
committed
updating readme
1 parent d6d760b commit cb8ba4a

File tree

1 file changed

+31
-1
lines changed

1 file changed

+31
-1
lines changed

README.md

Lines changed: 31 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,34 @@ PowerShell Module for Azure Data Explorer management, query and ingestion
1414

1515
</div>
1616

17-
This module is currently under development, if you wish to test it:
17+
PowerShellKusto is an abstraction over [`Microsoft.Azure.Kusto.Data`][kustodata] and [`Microsoft.Azure.Kusto.Ingest`][kustoingest], to simplify the process of Azure Data Explorer management, query and ingestion. The cmdlet currently has the following cmdlets and more will be added in the future. If you'd like to see a cmdlet for a specific task, please sumbit a [new Issue][newissue]!
18+
19+
- `Connect-Kusto`: This cmdlet is the main entry point for the cmdlets in this module and it's used to establish a connection with your Azure Data Explorer Cluster.
20+
- `Invoke-KustoControlCommand`:
21+
- `Invoke-KustoIngestFromStorage`:
22+
- `Invoke-KustoIngestFromStream`:
23+
- `Invoke-KustoQuery`:
24+
- `New-KustoClientRequestProperties`:
25+
- `New-KustoColumnMapping`:
26+
- `New-KustoIngestionMapping`:
27+
- `Set-KustoBatchingPolicy`:
28+
- `Set-KustoIngestionMapping`:
29+
30+
## Documentation
31+
32+
Check out [__the docs__](./docs/en-US/Use-Object.md) for information about how to use this Module.
33+
34+
## Installation
35+
36+
### Gallery
37+
38+
The module is available through the [PowerShell Gallery][gallery_ref]:
39+
40+
```powershell
41+
Install-Module PowerShellKusto -Scope CurrentUser
42+
```
43+
44+
### Source
1845

1946
```powershell
2047
git clone 'https://github.com/santisq/PowerShellKusto.git'
@@ -37,3 +64,6 @@ Contributions are welcome, if you wish to contribute, fork this repository and s
3764
[license_badge]: https://img.shields.io/github/license/santisq/PowerShellKusto
3865
[license_ref]: https://github.com/santisq/PowerShellKusto/blob/main/LICENSE
3966
[psgithub]: https://github.com/PowerShell/PowerShell
67+
[kustodata]: https://www.nuget.org/packages/Microsoft.Azure.Kusto.Data/
68+
[kustoingest]: https://www.nuget.org/packages/Microsoft.Azure.Kusto.Ingest/
69+
[newissue]: https://github.com/santisq/PowerShellKusto/issues/new/choose

0 commit comments

Comments
 (0)