Share via

az kusto data-connection event-hub

  • Experimental
  • Reference

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

Commands

Name Description Type Status
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 event-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 event-hub create --cluster-name
                                          --data-connection-name
                                          --database-name
                                          --resource-group
                                          [--compression {GZip, None}]
                                          [--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-hub-resource-id]
                                          [--event-system-properties]
                                          [--location]
                                          [--managed-identity]
                                          [--mapping-rule-name]
                                          [--no-wait]
                                          [--table-name]

Examples

KustoDataConnectionsCreateOrUpdate

az kusto data-connection event-hub create --cluster-name "kustoclusterrptest4" --name "DataConnections8" --database-name "KustoDatabase8" --location "westus" --consumer-group "testConsumerGroup1" --event-hub-resource-id "/subscriptions/12345678-1234-1234-1234-123456789098/resourceGroups/kustorptest/providers/Microsoft.EventHub/namespaces/eventhubTestns1/eventhubs/eventhubTest1" --managed-identity-resource-id "/subscriptions/12345678-1234-1234-1234-123456789098/resourceGroups/kustorptest/providers/Microsoft.ManagedIdentity/userAssignedIdentities/managedidentityTest1" --resource-group "kustorptest"

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

--compression

The event hub messages compression type.

Accepted values: GZip, None
--consumer-group

The event hub consumer group.

--data-format

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

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.

Accepted values: Multi, Single
--event-hub-resource-id

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

--event-system-properties

System properties of the event hub.

--location -l

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

--managed-identity --managed-identity-resource-id

Empty for non-managed identity based data connection. For system assigned identity, provide cluster resource Id. For user assigned identity (UAI) provide the UAI resource Id.

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

Default value: False
--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.

--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 kusto data-connection event-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 event-hub data-connection-validation [--cluster-name]
                                                              [--compression {GZip, None}]
                                                              [--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]
                                                              [--database-routing {Multi, Single}]
                                                              [--event-hub-resource-id]
                                                              [--event-system-properties]
                                                              [--ids]
                                                              [--location]
                                                              [--managed-identity]
                                                              [--mapping-rule-name]
                                                              [--no-wait]
                                                              [--resource-group]
                                                              [--subscription]
                                                              [--table-name]

Examples

KustoDataConnectionValidation

az kusto data-connection event-hub data-connection-validation --cluster-name "kustoclusterrptest4" --database-name "KustoDatabase8" --name "DataConnections8" --consumer-group "testConsumerGroup1" --event-hub-resource-id "/subscriptions/12345678-1234-1234-1234-123456789098/resourceGroups/kustorptest/providers/Microsoft.EventHub/namespaces/eventhubTestns1/eventhubs/eventhubTest1" --managed-identity-resource-id "/subscriptions/12345678-1234-1234-1234-123456789098/resourceGroups/kustorptest/providers/Microsoft.ManagedIdentity/userAssignedIdentities/managedidentityTest1" --resource-group "kustorptest"

Optional Parameters

--cluster-name

The name of the Kusto cluster.

--compression

The event hub messages compression type.

Accepted values: GZip, None
--consumer-group

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

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.

--database-routing

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

Accepted values: Multi, Single
--event-hub-resource-id

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

--event-system-properties

System properties of the event 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.

--location -l

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

--managed-identity --managed-identity-resource-id

Empty for non-managed identity based data connection. For system assigned identity, provide cluster resource Id. For user assigned identity (UAI) provide the UAI resource Id.

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

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.

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

--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 kusto data-connection event-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 event-hub update [--cluster-name]
                                          [--compression {GZip, None}]
                                          [--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]
                                          [--database-routing {Multi, Single}]
                                          [--event-hub-resource-id]
                                          [--event-system-properties]
                                          [--ids]
                                          [--location]
                                          [--managed-identity]
                                          [--mapping-rule-name]
                                          [--no-wait]
                                          [--resource-group]
                                          [--subscription]
                                          [--table-name]

Examples

KustoDataConnectionsUpdate

az kusto data-connection event-hub update --cluster-name "kustoclusterrptest4" --name "DataConnections8" --database-name "KustoDatabase8" --location "westus" --consumer-group "testConsumerGroup1" --event-hub-resource-id "/subscriptions/12345678-1234-1234-1234-123456789098/resourceGroups/kustorptest/providers/Microsoft.EventHub/namespaces/eventhubTestns1/eventhubs/eventhubTest1" --managed-identity-resource-id "/subscriptions/12345678-1234-1234-1234-123456789098/resourceGroups/kustorptest/providers/Microsoft.ManagedIdentity/userAssignedIdentities/managedidentityTest1" --resource-group "kustorptest"

Optional Parameters

--cluster-name

The name of the Kusto cluster.

--compression

The event hub messages compression type.

Accepted values: GZip, None
--consumer-group

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

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.

--database-routing

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

Accepted values: Multi, Single
--event-hub-resource-id

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

--event-system-properties

System properties of the event 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.

--location -l

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

--managed-identity --managed-identity-resource-id

Empty for non-managed identity based data connection. For system assigned identity, provide cluster resource Id. For user assigned identity (UAI) provide the UAI resource Id.

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

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.

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

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