Share via

az synapse kusto data-connection iot-hub

  • Experimental

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

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

Commands

Name Description Type Status
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 iot-hub create

Edit
Experimental

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

Create a data connection.

az synapse kusto data-connection iot-hub create --data-connection-name
                                                --database-name
                                                --kusto-pool-name
                                                --resource-group
                                                --workspace-name
                                                [--consumer-group]
                                                [--data-format {APACHEAVRO, AVRO, CSV, JSON, MULTIJSON, ORC, PARQUET, PSV, RAW, SCSV, SINGLEJSON, SOHSV, TSV, TSVE, TXT, W3CLOGFILE}]
                                                [--event-system-properties]
                                                [--iot-hub-resource-id]
                                                [--location]
                                                [--mapping-rule-name]
                                                [--no-wait]
                                                [--shared-access-policy-name]
                                                [--table-name]

Required Parameters

--data-connection-name

The name of the data connection.

--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.

Optional Parameters

The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.

--consumer-group

The iot hub consumer group.

--data-format

The data format of the message. Optionally the data format can be added to each message.

Property Value
Accepted values: APACHEAVRO, AVRO, CSV, JSON, MULTIJSON, ORC, PARQUET, PSV, RAW, SCSV, SINGLEJSON, SOHSV, TSV, TSVE, TXT, W3CLOGFILE
--event-system-properties

System properties of the iot hub.

--iot-hub-resource-id

The resource ID of the Iot hub to be used to create a data connection.

--location -l

Location. Values from: az account list-locations. You can configure the default location using az configure --defaults location=<location>.

--mapping-rule-name

The mapping rule to be used to ingest the data. Optionally the mapping information can be added to each message.

--no-wait

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

Property Value
Default value: False
--shared-access-policy-name

The name of the share access policy.

--table-name

The table where the data should be ingested. Optionally the table information can be added to each message.

Global Parameters
--debug

Increase logging verbosity to show all debug logs.

Property Value
Default value: False
--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

Property Value
Default value: False
--output -o

Output format.

Property Value
Default value: json
Accepted values: json, jsonc, none, table, tsv, yaml, yamlc
--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.

Property Value
Default value: False

az synapse kusto data-connection iot-hub update

Edit
Experimental

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

Updates a data connection.

az synapse kusto data-connection iot-hub update [--consumer-group]
                                                [--data-connection-name]
                                                [--data-format {APACHEAVRO, AVRO, CSV, JSON, MULTIJSON, ORC, PARQUET, PSV, RAW, SCSV, SINGLEJSON, SOHSV, TSV, TSVE, TXT, W3CLOGFILE}]
                                                [--database-name]
                                                [--event-system-properties]
                                                [--ids]
                                                [--iot-hub-resource-id]
                                                [--kusto-pool-name]
                                                [--location]
                                                [--mapping-rule-name]
                                                [--no-wait]
                                                [--resource-group]
                                                [--shared-access-policy-name]
                                                [--subscription]
                                                [--table-name]
                                                [--workspace-name]

Optional Parameters

The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.

--consumer-group

The iot hub consumer group.

--data-connection-name

The name of the data connection.

Property Value
Parameter group: Resource Id Arguments
--data-format

The data format of the message. Optionally the data format can be added to each message.

Property Value
Accepted values: APACHEAVRO, AVRO, CSV, JSON, MULTIJSON, ORC, PARQUET, PSV, RAW, SCSV, SINGLEJSON, SOHSV, TSV, TSVE, TXT, W3CLOGFILE
--database-name

The name of the database in the Kusto pool.

Property Value
Parameter group: Resource Id Arguments
--event-system-properties

System properties of the iot hub.

--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.

Property Value
Parameter group: Resource Id Arguments
--iot-hub-resource-id

The resource ID of the Iot hub to be used to create a data connection.

--kusto-pool-name

The name of the Kusto pool.

Property Value
Parameter group: Resource Id Arguments
--location -l

Location. Values from: az account list-locations. You can configure the default location using az configure --defaults location=<location>.

--mapping-rule-name

The mapping rule to be used to ingest the data. Optionally the mapping information can be added to each message.

--no-wait

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

Property Value
Default value: False
--resource-group -g

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

Property Value
Parameter group: Resource Id Arguments
--shared-access-policy-name

The name of the share access policy.

--subscription

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

Property Value
Parameter group: Resource Id Arguments
--table-name

The table where the data should be ingested. Optionally the table information can be added to each message.

--workspace-name

The name of the workspace.

Property Value
Parameter group: Resource Id Arguments
Global Parameters
--debug

Increase logging verbosity to show all debug logs.

Property Value
Default value: False
--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

Property Value
Default value: False
--output -o

Output format.

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

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

--verbose

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

Property Value
Default value: False