Share via

az dt data-history connection

Note

This reference is part of the azure-iot extension for the Azure CLI (version 2.59.0 or higher). The extension will automatically install the first time you run an az dt data-history connection command. Learn more about extensions.

Manage and configure data history connections.

Commands

Name Description Type Status
az dt data-history connection create

Creates a data history connection between a Digital Twins instance and supported resources.

 Extension GA
az dt data-history connection create adx

Creates a data history connection between a Digital Twins instance and an Azure Data Explorer database. Requires pre-created Azure Data Explorer and Event Hub resources.

 Extension GA
az dt data-history connection delete

Delete a data history connection configured on a Digital Twins instance.

 Extension GA
az dt data-history connection list

List all data history connections configured on a Digital Twins instance.

 Extension GA
az dt data-history connection show

Show details of a data history connection configured on a Digital Twins instance.

 Extension GA
az dt data-history connection wait

Wait until an operation on a data history connection is complete.

 Extension GA

az dt data-history connection delete

Delete a data history connection configured on a Digital Twins instance.

az dt data-history connection delete --cn --conn-name
                                     --dt-name --dtn
                                     [--clean {false, true}]
                                     [--no-wait]
                                     [--resource-group]
                                     [--yes]

Examples

Delete a data history connection configured on an instance and block until the operation is complete.

az dt data-history connection delete -n {instance_name} --cn {time_series_database_connection_name}

Delete a data history connection configured on an instance without confirmation or blocking.

az dt data-history connection delete -n {instance_name} --cn {time_series_database_connection_name} -y --no-wait

Delete a data history connection configured on an instance and attempt to clean up artifacts that were created when the connection was created. If appropriate permissions are not in place, the attempt may fail. Recorded data will not be deleted.

az dt data-history connection delete -n {instance_name} --cn {time_series_database_connection_name} --clean

Required Parameters

--cn --conn-name

Name of data history connection.

--dt-name --dtn -n

Digital Twins instance 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.

--clean -c

Specifies whether or not to attempt to clean up artifacts that were created in order to establish a connection to the time series database. This is a best-effort attempt that will fail if appropriate permissions are not in place. Setting this to 'true' does not delete any recorded data.

Property Value
Default value: False
Accepted values: false, true
--no-wait

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

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

Digital Twins instance resource group. You can configure the default group using az configure --defaults group={name}.

--yes -y

Do not prompt for confirmation.

Property Value
Default value: False
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 dt data-history connection list

List all data history connections configured on a Digital Twins instance.

az dt data-history connection list --dt-name --dtn
                                   [--resource-group]

Examples

List all data history connections configured on an instance.

az dt data-history connection list -n {instance_name}

Required Parameters

--dt-name --dtn -n

Digital Twins instance 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.

--resource-group -g

Digital Twins instance resource group. You can configure the default group using az configure --defaults group={name}.

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 dt data-history connection show

Show details of a data history connection configured on a Digital Twins instance.

az dt data-history connection show --cn --conn-name
                                   --dt-name --dtn
                                   [--resource-group]

Examples

Show a data history connection configured on an instance.

az dt data-history connection show -n {instance_name} --cn {time_series_database_connection_name}

Required Parameters

--cn --conn-name

Name of data history connection.

--dt-name --dtn -n

Digital Twins instance 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.

--resource-group -g

Digital Twins instance resource group. You can configure the default group using az configure --defaults group={name}.

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 dt data-history connection wait

Wait until an operation on a data history connection is complete.

az dt data-history connection wait --cn --conn-name
                                   --dt-name --dtn
                                   [--created]
                                   [--custom]
                                   [--deleted]
                                   [--exists]
                                   [--interval]
                                   [--resource-group]
                                   [--timeout]
                                   [--updated]

Examples

Wait until a data history connection is created.

az dt data-history connection wait -n {instance_name} --cn {time_series_database_connection_name} --created

Wait until an existing data history connection is deleted.

az dt data-history connection wait -n {instance_name} --cn {time_series_database_connection_name} --deleted

Required Parameters

--cn --conn-name

Name of data history connection.

--dt-name --dtn -n

Digital Twins instance 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.

--created

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

Property Value
Parameter group: Wait Condition Arguments
Default value: False
--custom

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

Property Value
Parameter group: Wait Condition Arguments
--deleted

Wait until deleted.

Property Value
Parameter group: Wait Condition Arguments
Default value: False
--exists

Wait until the resource exists.

Property Value
Parameter group: Wait Condition Arguments
Default value: False
--interval

Polling interval in seconds.

Property Value
Parameter group: Wait Condition Arguments
Default value: 30
--resource-group -g

Digital Twins instance resource group. You can configure the default group using az configure --defaults group={name}.

--timeout

Maximum wait in seconds.

Property Value
Parameter group: Wait Condition Arguments
Default value: 3600
--updated

Wait until updated with provisioningState at 'Succeeded'.

Property Value
Parameter group: Wait Condition Arguments
Default value: False
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