Share via

az synapse kusto data-connection

  • Experimental
  • Reference

This command group is experimental and under development. Reference and support levels: https://aka.ms/CLI_refstatus

Manage kusto pool data connection with synapse.

Commands

Name Description Type Status
az synapse kusto data-connection delete

Deletes the data connection with the given name.

 Core Experimental
az synapse kusto data-connection event-grid

Manage kusto pool data connection with synapse sub group event-grid.

 Core Experimental
az synapse kusto data-connection event-grid create

Create a data connection.

 Core Experimental
az synapse kusto data-connection event-grid update

Updates a data connection.

 Core Experimental
az synapse kusto data-connection event-hub

Manage kusto pool data connection with synapse sub group event-hub.

 Core Experimental
az synapse kusto data-connection event-hub create

Create a data connection.

 Core Experimental
az synapse kusto data-connection event-hub update

Updates a data connection.

 Core Experimental
az synapse kusto data-connection iot-hub

Manage kusto pool data connection with synapse sub group iot-hub.

 Core Experimental
az synapse kusto data-connection iot-hub create

Create a data connection.

 Core Experimental
az synapse kusto data-connection iot-hub update

Updates a data connection.

 Core Experimental
az synapse kusto data-connection list

Returns the list of data connections of the given Kusto pool database.

 Core Experimental
az synapse kusto data-connection show

Returns a data connection.

 Core Experimental
az synapse kusto data-connection wait

Place the CLI in a waiting state until a condition of the synapse kusto data-connection is met.

 Core Experimental

az synapse kusto data-connection delete

Edit
Experimental

Command group 'synapse kusto data-connection' is experimental and under development. Reference and support levels: https://aka.ms/CLI_refstatus

Deletes the data connection with the given name.

az synapse kusto data-connection delete [--data-connection-name]
                                        [--database-name]
                                        [--ids]
                                        [--kusto-pool-name]
                                        [--no-wait]
                                        [--resource-group]
                                        [--subscription]
                                        [--workspace-name]
                                        [--yes]

Examples

KustoPoolDataConnectionsDelete

az synapse kusto data-connection delete --data-connection-name "kustoeventhubconnection1" --database-name "KustoDatabase8" --kusto-pool-name "kustoclusterrptest4" --resource-group "kustorptest" --workspace-name "synapseWorkspaceName"

Optional Parameters

--data-connection-name

The name of the data connection.

--database-name

The name of the database in the Kusto pool.

--ids

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.

--kusto-pool-name

The name of the Kusto pool.

--no-wait

Do not wait for the long-running operation to finish.

Default value: False
--resource-group -g

Name of resource group. You can configure the default group using az configure --defaults group=<name>.

--subscription

Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.

--workspace-name

The name of the workspace.

--yes -y

Do not prompt for confirmation.

Default value: False
Global Parameters
--debug

Increase logging verbosity to show all debug logs.

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

--output -o

Output format.

Accepted values: json, jsonc, none, table, tsv, yaml, yamlc
Default value: json
--query

JMESPath query string. See http://jmespath.org/ for more information and examples.

--subscription

Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.

--verbose

Increase logging verbosity. Use --debug for full debug logs.

az synapse kusto data-connection list

Edit
Experimental

Command group 'synapse kusto data-connection' is experimental and under development. Reference and support levels: https://aka.ms/CLI_refstatus

Returns the list of data connections of the given Kusto pool database.

az synapse kusto data-connection list --database-name
                                      --kusto-pool-name
                                      --resource-group
                                      --workspace-name

Examples

KustoPoolDataConnectionsListByDatabase

az synapse kusto data-connection list --database-name "KustoDatabase8" --kusto-pool-name "kustoclusterrptest4" --resource-group "kustorptest" --workspace-name "synapseWorkspaceName"

Required Parameters

--database-name

The name of the database in the Kusto pool.

--kusto-pool-name

The name of the Kusto pool.

--resource-group -g

Name of resource group. You can configure the default group using az configure --defaults group=<name>.

--workspace-name

The name of the workspace.

Global Parameters
--debug

Increase logging verbosity to show all debug logs.

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

--output -o

Output format.

Accepted values: json, jsonc, none, table, tsv, yaml, yamlc
Default value: json
--query

JMESPath query string. See http://jmespath.org/ for more information and examples.

--subscription

Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.

--verbose

Increase logging verbosity. Use --debug for full debug logs.

az synapse kusto data-connection show

Edit
Experimental

Command group 'synapse kusto data-connection' is experimental and under development. Reference and support levels: https://aka.ms/CLI_refstatus

Returns a data connection.

az synapse kusto data-connection show [--data-connection-name]
                                      [--database-name]
                                      [--ids]
                                      [--kusto-pool-name]
                                      [--resource-group]
                                      [--subscription]
                                      [--workspace-name]

Examples

KustoPoolDataConnectionsGet

az synapse kusto data-connection show --data-connection-name "DataConnections8" --database-name "KustoDatabase8" --kusto-pool-name "kustoclusterrptest4" --resource-group "kustorptest" --workspace-name "synapseWorkspaceName"

Optional Parameters

--data-connection-name

The name of the data connection.

--database-name

The name of the database in the Kusto pool.

--ids

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.

--kusto-pool-name

The name of the Kusto pool.

--resource-group -g

Name of resource group. You can configure the default group using az configure --defaults group=<name>.

--subscription

Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.

--workspace-name

The name of the workspace.

Global Parameters
--debug

Increase logging verbosity to show all debug logs.

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

--output -o

Output format.

Accepted values: json, jsonc, none, table, tsv, yaml, yamlc
Default value: json
--query

JMESPath query string. See http://jmespath.org/ for more information and examples.

--subscription

Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.

--verbose

Increase logging verbosity. Use --debug for full debug logs.

az synapse kusto data-connection wait

Edit
Experimental

Command group 'synapse kusto data-connection' 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 synapse kusto data-connection is met.

az synapse kusto data-connection wait [--created]
                                      [--custom]
                                      [--data-connection-name]
                                      [--database-name]
                                      [--deleted]
                                      [--exists]
                                      [--ids]
                                      [--interval]
                                      [--kusto-pool-name]
                                      [--resource-group]
                                      [--subscription]
                                      [--timeout]
                                      [--updated]
                                      [--workspace-name]

Examples

Pause executing next line of CLI script until the synapse kusto data-connection is successfully created.

az synapse kusto data-connection wait --data-connection-name "DataConnections8" --database-name "KustoDatabase8" --kusto-pool-name "kustoclusterrptest4" --resource-group "kustorptest" --workspace-name "synapseWorkspaceName" --created

Pause executing next line of CLI script until the synapse kusto data-connection is successfully deleted.

az synapse kusto data-connection wait --data-connection-name "DataConnections8" --database-name "KustoDatabase8" --kusto-pool-name "kustoclusterrptest4" --resource-group "kustorptest" --workspace-name "synapseWorkspaceName" --deleted

Optional Parameters

--created

Wait until created with 'provisioningState' at 'Succeeded'.

Default value: False
--custom

Wait until the condition satisfies a custom JMESPath query. E.g. provisioningState!='InProgress', instanceView.statuses[?code=='PowerState/running'].

--data-connection-name

The name of the data connection.

--database-name

The name of the database in the Kusto pool.

--deleted

Wait until deleted.

Default value: False
--exists

Wait until the resource exists.

Default value: False
--ids

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.

--interval

Polling interval in seconds.

Default value: 30
--kusto-pool-name

The name of the Kusto pool.

--resource-group -g

Name of resource group. You can configure the default group using az configure --defaults group=<name>.

--subscription

Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.

--timeout

Maximum wait in seconds.

Default value: 3600
--updated

Wait until updated with provisioningState at 'Succeeded'.

Default value: False
--workspace-name

The name of the workspace.

Global Parameters
--debug

Increase logging verbosity to show all debug logs.

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

--output -o

Output format.

Accepted values: json, jsonc, none, table, tsv, yaml, yamlc
Default value: json
--query

JMESPath query string. See http://jmespath.org/ for more information and examples.

--subscription

Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.

--verbose

Increase logging verbosity. Use --debug for full debug logs.