az dt data-history connection

リファレンス

Note

このリファレンスは、Azure CLI (バージョン 2.46.0 以降) の azure-iot 拡張機能の一部です。拡張機能は、az dt data-history 接続コマンドを初めて実行するときに自動的にインストールされます。拡張機能の詳細をご覧ください。

データ履歴接続を管理および構成します。

コマンド

名前	説明	型	Status
az dt data-history connection create	Digital Twins インスタンスとサポートされているリソースの間にデータ履歴接続を作成します。	拡張子	GA
az dt data-history connection create adx	Digital Twins インスタンスと Azure Data Explorer データベースの間にデータ履歴接続を作成します。事前に作成された Azure Data Explorer と Event Hub リソースが必要です。	拡張子	GA
az dt data-history connection delete	Digital Twins インスタンスで構成されたデータ履歴接続を削除します。	拡張子	GA
az dt data-history connection list	Digital Twins インスタンスで構成されているすべてのデータ履歴接続を一覧表示します。	拡張子	GA
az dt data-history connection show	Digital Twins インスタンスで構成されたデータ履歴接続の詳細を表示します。	拡張子	GA
az dt data-history connection wait	データ履歴接続に対する操作が完了するまで待ちます。	拡張子	GA

az dt data-history connection delete

Digital Twins インスタンスで構成されたデータ履歴接続を削除します。

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

例

インスタンスで構成されたデータ履歴接続を削除し、操作が完了するまでブロックします。

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

確認またはブロックせずに、インスタンスで構成されたデータ履歴接続を削除します。

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

インスタンスで構成されているデータ履歴接続を削除し、接続の作成時に作成された成果物のクリーンアップを試みます。適切なアクセス許可が設定されていない場合、試行が失敗する可能性があります。記録されたデータは削除されません。

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

必須のパラメーター

--cn --conn-name

データ履歴接続の名前。

--dt-name --dtn -n

Digital Twins インスタンス名。

省略可能のパラメーター

--clean -c

時系列データベースへの接続を確立するために作成された成果物をクリーンアップするかどうかを指定します。これは、適切なアクセス許可が設定されていない場合に失敗するベストエフォートの試行です。これを 'true' に設定しても、記録されたデータは削除されません。

承認された値: false, true

既定値: False

--no-wait

実行時間の長い操作の終了を待機しません。

既定値: False

--resource-group -g

Digital Twins インスタンスリソースグループ。 az configure --defaults group=<name> を使用して、既定のグループを構成できます。

--yes -y

確認のダイアログを表示しません。

既定値: False

グローバルパラメーター

--debug

すべてのデバッグログを表示するようにログの詳細レベルを上げます。

--help -h

このヘルプメッセージを表示して終了します。

--only-show-errors

エラーのみを表示し、警告は抑制します。

--output -o

出力形式。

承認された値: json, jsonc, none, table, tsv, yaml, yamlc

既定値: json

--query

JMESPath クエリ文字列。詳細と例については、http://jmespath.org/ をご覧ください。

--subscription

サブスクリプションの名前または ID。 az account set -s NAME_OR_ID を使用して、既定のサブスクリプションを構成できます。

--verbose

ログの詳細レベルを上げます。詳細なデバッグログを表示するには --debug を使います。

az dt data-history connection list

Digital Twins インスタンスで構成されているすべてのデータ履歴接続を一覧表示します。

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

例

インスタンスで構成されているすべてのデータ履歴接続を一覧表示します。

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

必須のパラメーター

--dt-name --dtn -n

Digital Twins インスタンス名。

省略可能のパラメーター

--resource-group -g

Digital Twins インスタンスリソースグループ。 az configure --defaults group=<name> を使用して、既定のグループを構成できます。

グローバルパラメーター

--debug

すべてのデバッグログを表示するようにログの詳細レベルを上げます。

--help -h

このヘルプメッセージを表示して終了します。

--only-show-errors

エラーのみを表示し、警告は抑制します。

--output -o

出力形式。

承認された値: json, jsonc, none, table, tsv, yaml, yamlc

既定値: json

--query

JMESPath クエリ文字列。詳細と例については、http://jmespath.org/ をご覧ください。

--subscription

サブスクリプションの名前または ID。 az account set -s NAME_OR_ID を使用して、既定のサブスクリプションを構成できます。

--verbose

ログの詳細レベルを上げます。詳細なデバッグログを表示するには --debug を使います。

az dt data-history connection show

Digital Twins インスタンスで構成されたデータ履歴接続の詳細を表示します。

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

例

インスタンスで構成されたデータ履歴接続を表示します。

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

必須のパラメーター

--cn --conn-name

データ履歴接続の名前。

--dt-name --dtn -n

Digital Twins インスタンス名。

省略可能のパラメーター

--resource-group -g

Digital Twins インスタンスリソースグループ。 az configure --defaults group=<name> を使用して、既定のグループを構成できます。

グローバルパラメーター

--debug

すべてのデバッグログを表示するようにログの詳細レベルを上げます。

--help -h

このヘルプメッセージを表示して終了します。

--only-show-errors

エラーのみを表示し、警告は抑制します。

--output -o

出力形式。

承認された値: json, jsonc, none, table, tsv, yaml, yamlc

既定値: json

--query

JMESPath クエリ文字列。詳細と例については、http://jmespath.org/ をご覧ください。

--subscription

サブスクリプションの名前または ID。 az account set -s NAME_OR_ID を使用して、既定のサブスクリプションを構成できます。

--verbose

ログの詳細レベルを上げます。詳細なデバッグログを表示するには --debug を使います。

az dt data-history connection wait

データ履歴接続に対する操作が完了するまで待ちます。

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

例

データ履歴接続が作成されるまで待ちます。

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

既存のデータ履歴接続が削除されるまで待ちます。

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

必須のパラメーター

--cn --conn-name

データ履歴接続の名前。

--dt-name --dtn -n

Digital Twins インスタンス名。

省略可能のパラメーター

--created

'provisioningState' が 'Succeeded' で作成されるまで待ちます。

既定値: False

--custom

条件がカスタム JMESPath クエリを満たすまで待ちます。例: provisioningState!='InProgress'、instanceView.statuses[?code=='PowerState/running']。

--deleted

削除されるまで待ちます。

既定値: False

--exists

リソースが存在するまで待ちます。

既定値: False

--interval

ポーリング間隔 (秒単位)。

既定値: 30

--resource-group -g

Digital Twins インスタンスリソースグループ。 az configure --defaults group=<name> を使用して、既定のグループを構成できます。

--timeout

最大待機時間 (秒単位)。

既定値: 3600

--updated

provisioningState が 'Succeeded' で更新されるまで待ちます。

既定値: False

グローバルパラメーター

--debug

すべてのデバッグログを表示するようにログの詳細レベルを上げます。

--help -h

このヘルプメッセージを表示して終了します。

--only-show-errors

エラーのみを表示し、警告は抑制します。

--output -o

出力形式。

承認された値: json, jsonc, none, table, tsv, yaml, yamlc

既定値: json

--query

JMESPath クエリ文字列。詳細と例については、http://jmespath.org/ をご覧ください。

--subscription

サブスクリプションの名前または ID。 az account set -s NAME_OR_ID を使用して、既定のサブスクリプションを構成できます。

--verbose

ログの詳細レベルを上げます。詳細なデバッグログを表示するには --debug を使います。

次の方法で共有

az dt data-history connection

コマンド

az dt data-history connection delete

例

必須のパラメーター

省略可能のパラメーター

az dt data-history connection list

例

必須のパラメーター

省略可能のパラメーター

az dt data-history connection show

例

必須のパラメーター

省略可能のパラメーター

az dt data-history connection wait

例

必須のパラメーター

省略可能のパラメーター

その他のリソース