az dt data-history connection
Note
このリファレンスは、Azure CLI (バージョン 2.67.0 以降) の azure-iot 拡張機能の一部です。 拡張機能は、az dt data-history 接続 コマンドを初めて実行するときに自動的にインストールされます。 拡張機能の詳細については、 を参照してください。
データ履歴接続を管理および構成します。
コマンド
| 名前 | 説明 | 型 | 状態 |
|---|---|---|---|
| az dt data-history connection create |
Digital Twins インスタンスとサポートされているリソースの間にデータ履歴接続を作成します。 |
Extension | GA |
| az dt data-history connection create adx |
Digital Twins インスタンスと Azure Data Explorer データベースの間にデータ履歴接続を作成します。 事前に作成された Azure Data Explorer と Event Hub リソースが必要です。 |
Extension | GA |
| az dt data-history connection delete |
Digital Twins インスタンスで構成されたデータ履歴接続を削除します。 |
Extension | GA |
| az dt data-history connection list |
Digital Twins インスタンスで構成されているすべてのデータ履歴接続を一覧表示します。 |
Extension | GA |
| az dt data-history connection show |
Digital Twins インスタンスで構成されたデータ履歴接続の詳細を表示します。 |
Extension | GA |
| az dt data-history connection wait |
データ履歴接続に対する操作が完了するまで待ちます。 |
Extension | GA |
az dt data-history connection delete
Digital Twins インスタンスで構成されたデータ履歴接続を削除します。
az dt data-history connection delete --cn --conn-name
--dt-name --dtn
[--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
必須のパラメーター
データ履歴接続の名前。
Digital Twins インスタンス名。
オプションのパラメーター
次のパラメーターは省略可能ですが、コマンドを正常に実行するには、状況に応じて 1 つ以上が必要になる場合があります。
時系列データベースへの接続を確立するために作成された成果物をクリーンアップするかどうかを指定します。 これは、適切なアクセス許可が設定されていない場合に失敗するベスト エフォートの試行です。 これを 'true' に設定しても、記録されたデータは削除されません。
| プロパティ | 値 |
|---|---|
| 規定値: | False |
| 指定可能な値: | false, true |
実行時間の長い操作が完了するまで待つ必要はありません。
| プロパティ | 値 |
|---|---|
| 規定値: | False |
Digital Twins インスタンス リソース グループ。
az configure --defaults group={name}を使用して既定のグループを構成できます。
確認を求めないでください。
| プロパティ | 値 |
|---|---|
| 規定値: | False |
グローバル パラメーター
ログの詳細度を上げて、すべてのデバッグ ログを表示します。
| プロパティ | 値 |
|---|---|
| 規定値: | False |
このヘルプ メッセージを表示して終了します。
エラーのみを表示し、警告を抑制します。
| プロパティ | 値 |
|---|---|
| 規定値: | False |
出力フォーマット。
| プロパティ | 値 |
|---|---|
| 規定値: | json |
| 指定可能な値: | json, jsonc, none, table, tsv, yaml, yamlc |
JMESPath クエリ文字列。 詳細と例については、http://jmespath.org/ を参照してください。
サブスクリプションの名前または ID。
az account set -s NAME_OR_IDを使用して既定のサブスクリプションを構成できます。
ログの詳細度を高める。 完全なデバッグ ログには --debug を使用します。
| プロパティ | 値 |
|---|---|
| 規定値: | False |
az dt data-history connection list
Digital Twins インスタンスで構成されているすべてのデータ履歴接続を一覧表示します。
az dt data-history connection list --dt-name --dtn
[--resource-group]
例
インスタンスで構成されているすべてのデータ履歴接続を一覧表示します。
az dt data-history connection list -n {instance_name}
必須のパラメーター
Digital Twins インスタンス名。
オプションのパラメーター
次のパラメーターは省略可能ですが、コマンドを正常に実行するには、状況に応じて 1 つ以上が必要になる場合があります。
Digital Twins インスタンス リソース グループ。
az configure --defaults group={name}を使用して既定のグループを構成できます。
グローバル パラメーター
ログの詳細度を上げて、すべてのデバッグ ログを表示します。
| プロパティ | 値 |
|---|---|
| 規定値: | False |
このヘルプ メッセージを表示して終了します。
エラーのみを表示し、警告を抑制します。
| プロパティ | 値 |
|---|---|
| 規定値: | False |
出力フォーマット。
| プロパティ | 値 |
|---|---|
| 規定値: | json |
| 指定可能な値: | json, jsonc, none, table, tsv, yaml, yamlc |
JMESPath クエリ文字列。 詳細と例については、http://jmespath.org/ を参照してください。
サブスクリプションの名前または ID。
az account set -s NAME_OR_IDを使用して既定のサブスクリプションを構成できます。
ログの詳細度を高める。 完全なデバッグ ログには --debug を使用します。
| プロパティ | 値 |
|---|---|
| 規定値: | False |
az dt data-history connection show
Digital Twins インスタンスで構成されたデータ履歴接続の詳細を表示します。
az dt data-history connection show --cn --conn-name
--dt-name --dtn
[--resource-group]
例
インスタンスで構成されたデータ履歴接続を表示します。
az dt data-history connection show -n {instance_name} --cn {time_series_database_connection_name}
必須のパラメーター
データ履歴接続の名前。
Digital Twins インスタンス名。
オプションのパラメーター
次のパラメーターは省略可能ですが、コマンドを正常に実行するには、状況に応じて 1 つ以上が必要になる場合があります。
Digital Twins インスタンス リソース グループ。
az configure --defaults group={name}を使用して既定のグループを構成できます。
グローバル パラメーター
ログの詳細度を上げて、すべてのデバッグ ログを表示します。
| プロパティ | 値 |
|---|---|
| 規定値: | False |
このヘルプ メッセージを表示して終了します。
エラーのみを表示し、警告を抑制します。
| プロパティ | 値 |
|---|---|
| 規定値: | False |
出力フォーマット。
| プロパティ | 値 |
|---|---|
| 規定値: | json |
| 指定可能な値: | json, jsonc, none, table, tsv, yaml, yamlc |
JMESPath クエリ文字列。 詳細と例については、http://jmespath.org/ を参照してください。
サブスクリプションの名前または ID。
az account set -s NAME_OR_IDを使用して既定のサブスクリプションを構成できます。
ログの詳細度を高める。 完全なデバッグ ログには --debug を使用します。
| プロパティ | 値 |
|---|---|
| 規定値: | False |
az dt data-history connection wait
データ履歴接続に対する操作が完了するまで待ちます。
az dt data-history connection wait --cn --conn-name
--dt-name --dtn
[--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
必須のパラメーター
データ履歴接続の名前。
Digital Twins インスタンス名。
オプションのパラメーター
次のパラメーターは省略可能ですが、コマンドを正常に実行するには、状況に応じて 1 つ以上が必要になる場合があります。
'provisioningState' が 'Succeeded' で作成されるまで待ちます。
| プロパティ | 値 |
|---|---|
| パラメーター グループ: | Wait Condition Arguments |
| 規定値: | False |
条件がカスタム JMESPath クエリを満たすまで待ちます。 例: provisioningState!='InProgress'、instanceView.statuses[?code=='PowerState/running']。
| プロパティ | 値 |
|---|---|
| パラメーター グループ: | Wait Condition Arguments |
削除されるまで待ちます。
| プロパティ | 値 |
|---|---|
| パラメーター グループ: | Wait Condition Arguments |
| 規定値: | False |
リソースが存在するまで待ちます。
| プロパティ | 値 |
|---|---|
| パラメーター グループ: | Wait Condition Arguments |
| 規定値: | False |
ポーリング間隔 (秒単位)。
| プロパティ | 値 |
|---|---|
| パラメーター グループ: | Wait Condition Arguments |
| 規定値: | 30 |
Digital Twins インスタンス リソース グループ。
az configure --defaults group={name}を使用して既定のグループを構成できます。
最大待機時間 (秒単位)。
| プロパティ | 値 |
|---|---|
| パラメーター グループ: | Wait Condition Arguments |
| 規定値: | 3600 |
provisioningState が 'Succeeded' で更新されるまで待ちます。
| プロパティ | 値 |
|---|---|
| パラメーター グループ: | Wait Condition Arguments |
| 規定値: | False |
グローバル パラメーター
ログの詳細度を上げて、すべてのデバッグ ログを表示します。
| プロパティ | 値 |
|---|---|
| 規定値: | False |
このヘルプ メッセージを表示して終了します。
エラーのみを表示し、警告を抑制します。
| プロパティ | 値 |
|---|---|
| 規定値: | False |
出力フォーマット。
| プロパティ | 値 |
|---|---|
| 規定値: | json |
| 指定可能な値: | json, jsonc, none, table, tsv, yaml, yamlc |
JMESPath クエリ文字列。 詳細と例については、http://jmespath.org/ を参照してください。
サブスクリプションの名前または ID。
az account set -s NAME_OR_IDを使用して既定のサブスクリプションを構成できます。
ログの詳細度を高める。 完全なデバッグ ログには --debug を使用します。
| プロパティ | 値 |
|---|---|
| 規定値: | False |