Share via

az kusto data-connection iot-hub

  • Experimental

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 iot-hub 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 sub group iot-hub.

Commands

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

Experimental

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

Create a data connection.

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

Required Parameters

--cluster-name

The name of the Kusto cluster.

--data-connection-name --name -n

The name of the data connection.

--database-name

The name of the database in the Kusto cluster.

--resource-group -g

Name of resource group. You can configure the default group using az configure --defaults group=<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-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-routing

Indication for database routing information from the data connection, by default only database routing information is allowed.

Property Value
Accepted values: Multi, Single
--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 kusto data-connection iot-hub data-connection-validation

Experimental

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

Checks that the data connection parameters are valid.

az kusto data-connection iot-hub data-connection-validation [--cluster-name]
                                                            [--consumer-group]
                                                            [--data-connection-name --name]
                                                            [--data-format {APACHEAVRO, AVRO, CSV, JSON, MULTIJSON, ORC, PARQUET, PSV, RAW, SCSV, SINGLEJSON, SOHSV, TSV, TSVE, TXT, W3CLOGFILE}]
                                                            [--database-name]
                                                            [--database-routing {Multi, Single}]
                                                            [--event-system-properties]
                                                            [--ids]
                                                            [--iot-hub-resource-id]
                                                            [--location]
                                                            [--mapping-rule-name]
                                                            [--no-wait]
                                                            [--resource-group]
                                                            [--shared-access-policy-name]
                                                            [--subscription]
                                                            [--table-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.

--cluster-name

The name of the Kusto cluster.

Property Value
Parameter group: Resource Id Arguments
--consumer-group

The iot hub consumer group.

--data-connection-name --name -n

The name of the data connection.

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

Property Value
Parameter group: Resource Id Arguments
--database-routing

Indication for database routing information from the data connection, by default only database routing information is allowed.

Property Value
Accepted values: Multi, Single
--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.

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

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

az kusto data-connection iot-hub update

Experimental

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

Updates a data connection.

az kusto data-connection iot-hub update [--cluster-name]
                                        [--consumer-group]
                                        [--data-connection-name --name]
                                        [--data-format {APACHEAVRO, AVRO, CSV, JSON, MULTIJSON, ORC, PARQUET, PSV, RAW, SCSV, SINGLEJSON, SOHSV, TSV, TSVE, TXT, W3CLOGFILE}]
                                        [--database-name]
                                        [--database-routing {Multi, Single}]
                                        [--event-system-properties]
                                        [--ids]
                                        [--iot-hub-resource-id]
                                        [--location]
                                        [--mapping-rule-name]
                                        [--no-wait]
                                        [--resource-group]
                                        [--shared-access-policy-name]
                                        [--subscription]
                                        [--table-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.

--cluster-name

The name of the Kusto cluster.

Property Value
Parameter group: Resource Id Arguments
--consumer-group

The iot hub consumer group.

--data-connection-name --name -n

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

Property Value
Parameter group: Resource Id Arguments
--database-routing

Indication for database routing information from the data connection, by default only database routing information is allowed.

Property Value
Accepted values: Multi, Single
--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.

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

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