az dt data-history connection

Note

This reference is part of the azure-iot extension for the Azure CLI (version 2.30.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

az dt data-history connection create

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

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.

az dt data-history connection delete

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

az dt data-history connection list

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

az dt data-history connection show

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

az dt data-history connection wait

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

az dt data-history connection delete

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

az dt data-history connection delete --cn
                                     --dt-name
                                     [--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

Required Parameters

--cn --conn-name

Name of data history connection.

--dt-name --dtn -n

Digital Twins instance name.

Optional Parameters

--no-wait

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

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

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

--resource-group -g

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

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
                                   --dt-name
                                   [--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

--resource-group -g

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

az dt data-history connection wait

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

az dt data-history connection wait --cn
                                   --dt-name
                                   [--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

--created

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

--custom

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

--deleted

Wait until deleted.

--exists

Wait until the resource exists.

--interval

Polling interval in seconds.

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.

default value: 3600
--updated

Wait until updated with provisioningState at 'Succeeded'.