az kusto data-connection
Note
This reference is part of the kusto extension for the Azure CLI (version 2.15.0 or higher). The extension will automatically install the first time you run an az kusto data-connection command. Learn more about extensions.
Command group 'kusto' is experimental and under development. Reference and support levels: https://aka.ms/CLI_refstatus
Manage data connection with kusto.
Commands
Name | Description | Type | Status |
---|---|---|---|
az kusto data-connection delete |
Deletes the data connection with the given name. |
Extension | Experimental |
az kusto data-connection event-grid |
Manage data connection with kusto sub group event-grid. |
Extension | Experimental |
az kusto data-connection event-grid create |
Create a data connection. |
Extension | Experimental |
az kusto data-connection event-grid data-connection-validation |
Checks that the data connection parameters are valid. |
Extension | Experimental |
az kusto data-connection event-grid update |
Updates a data connection. |
Extension | Experimental |
az kusto data-connection event-hub |
Manage data connection with kusto sub group event-hub. |
Extension | Experimental |
az kusto data-connection event-hub create |
Create a data connection. |
Extension | Experimental |
az kusto data-connection event-hub data-connection-validation |
Checks that the data connection parameters are valid. |
Extension | Experimental |
az kusto data-connection event-hub update |
Updates a data connection. |
Extension | Experimental |
az kusto data-connection iot-hub |
Manage data connection with kusto sub group iot-hub. |
Extension | Experimental |
az kusto data-connection iot-hub create |
Create a data connection. |
Extension | Experimental |
az kusto data-connection iot-hub data-connection-validation |
Checks that the data connection parameters are valid. |
Extension | Experimental |
az kusto data-connection iot-hub update |
Updates a data connection. |
Extension | Experimental |
az kusto data-connection list |
Returns the list of data connections of the given Kusto database. |
Extension | Experimental |
az kusto data-connection show |
Returns a data connection. |
Extension | Experimental |
az kusto data-connection wait |
Place the CLI in a waiting state until a condition of the kusto data-connection is met. |
Extension | Experimental |
az kusto data-connection delete
Command group 'kusto' is experimental and under development. Reference and support levels: https://aka.ms/CLI_refstatus
Deletes the data connection with the given name.
az kusto data-connection delete [--cluster-name]
[--data-connection-name]
[--database-name]
[--ids]
[--no-wait]
[--resource-group]
[--subscription]
[--yes]
Examples
KustoDataConnectionsDelete
az kusto data-connection delete --cluster-name "kustoclusterrptest4" --name "kustoeventhubconnection1" --database-name "KustoDatabase8" --resource-group "kustorptest"
Optional Parameters
The name of the Kusto cluster.
The name of the data connection.
The name of the database in the Kusto cluster.
One or more resource IDs (space-delimited). It should be a complete resource ID containing all information of 'Resource Id' arguments. You should provide either --ids or other 'Resource Id' arguments.
Do not wait for the long-running operation to finish.
Name of resource group. You can configure the default group using az configure --defaults group=<name>
.
Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID
.
Do not prompt for confirmation.
Global Parameters
Increase logging verbosity to show all debug logs.
Show this help message and exit.
Only show errors, suppressing warnings.
Output format.
JMESPath query string. See http://jmespath.org/ for more information and examples.
Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID
.
Increase logging verbosity. Use --debug for full debug logs.
az kusto data-connection list
Command group 'kusto' is experimental and under development. Reference and support levels: https://aka.ms/CLI_refstatus
Returns the list of data connections of the given Kusto database.
az kusto data-connection list --cluster-name
--database-name
--resource-group
Examples
KustoDatabasesListByCluster
az kusto data-connection list --cluster-name "kustoclusterrptest4" --database-name "KustoDatabase8" --resource-group "kustorptest"
Required Parameters
The name of the Kusto cluster.
The name of the database in the Kusto cluster.
Name of resource group. You can configure the default group using az configure --defaults group=<name>
.
Global Parameters
Increase logging verbosity to show all debug logs.
Show this help message and exit.
Only show errors, suppressing warnings.
Output format.
JMESPath query string. See http://jmespath.org/ for more information and examples.
Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID
.
Increase logging verbosity. Use --debug for full debug logs.
az kusto data-connection show
Command group 'kusto' is experimental and under development. Reference and support levels: https://aka.ms/CLI_refstatus
Returns a data connection.
az kusto data-connection show [--cluster-name]
[--data-connection-name]
[--database-name]
[--ids]
[--resource-group]
[--subscription]
Examples
KustoDataConnectionsGet
az kusto data-connection show --cluster-name "kustoclusterrptest4" --name "DataConnections8" --database-name "KustoDatabase8" --resource-group "kustorptest"
Optional Parameters
The name of the Kusto cluster.
The name of the data connection.
The name of the database in the Kusto cluster.
One or more resource IDs (space-delimited). It should be a complete resource ID containing all information of 'Resource Id' arguments. You should provide either --ids or other 'Resource Id' arguments.
Name of resource group. You can configure the default group using az configure --defaults group=<name>
.
Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID
.
Global Parameters
Increase logging verbosity to show all debug logs.
Show this help message and exit.
Only show errors, suppressing warnings.
Output format.
JMESPath query string. See http://jmespath.org/ for more information and examples.
Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID
.
Increase logging verbosity. Use --debug for full debug logs.
az kusto data-connection wait
Command group 'kusto' is experimental and under development. Reference and support levels: https://aka.ms/CLI_refstatus
Place the CLI in a waiting state until a condition of the kusto data-connection is met.
az kusto data-connection wait [--cluster-name]
[--created]
[--custom]
[--data-connection-name]
[--database-name]
[--deleted]
[--exists]
[--ids]
[--interval]
[--resource-group]
[--subscription]
[--timeout]
[--updated]
Examples
Pause executing next line of CLI script until the kusto data-connection is successfully created.
az kusto data-connection wait --cluster-name "kustoclusterrptest4" --name "DataConnections8" --database-name "KustoDatabase8" --resource-group "kustorptest" --created
Pause executing next line of CLI script until the kusto data-connection is successfully deleted.
az kusto data-connection wait --cluster-name "kustoclusterrptest4" --name "DataConnections8" --database-name "KustoDatabase8" --resource-group "kustorptest" --deleted
Optional Parameters
The name of the Kusto cluster.
Wait until created with 'provisioningState' at 'Succeeded'.
Wait until the condition satisfies a custom JMESPath query. E.g. provisioningState!='InProgress', instanceView.statuses[?code=='PowerState/running'].
The name of the data connection.
The name of the database in the Kusto cluster.
Wait until deleted.
Wait until the resource exists.
One or more resource IDs (space-delimited). It should be a complete resource ID containing all information of 'Resource Id' arguments. You should provide either --ids or other 'Resource Id' arguments.
Polling interval in seconds.
Name of resource group. You can configure the default group using az configure --defaults group=<name>
.
Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID
.
Maximum wait in seconds.
Wait until updated with provisioningState at 'Succeeded'.
Global Parameters
Increase logging verbosity to show all debug logs.
Show this help message and exit.
Only show errors, suppressing warnings.
Output format.
JMESPath query string. See http://jmespath.org/ for more information and examples.
Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID
.
Increase logging verbosity. Use --debug for full debug logs.