az dt endpoint
Note
このリファレンスは、Azure CLI (バージョン 2.46.0 以降) の azure-iot 拡張機能の一部です。 拡張機能は、az dt endpoint コマンドを初めて実行するときに自動的にインストールされます。 拡張機能の詳細をご覧ください。
Digital Twins インスタンス エンドポイントを管理および構成します。
コマンド
名前 | 説明 | 型 | Status |
---|---|---|---|
az dt endpoint create |
Digital Twins インスタンスにエグレス エンドポイントを追加します。 |
拡張子 | GA |
az dt endpoint create eventgrid |
EventGrid トピック エンドポイントを Digital Twins インスタンスに追加します。 事前に作成されたリソースが必要です。 |
拡張子 | GA |
az dt endpoint create eventhub |
Digital Twins インスタンスに EventHub エンドポイントを追加します。 |
拡張子 | GA |
az dt endpoint create servicebus |
ServiceBus トピック エンドポイントを Digital Twins インスタンスに追加します。 |
拡張子 | GA |
az dt endpoint delete |
Digital Twins インスタンスからエンドポイントを削除します。 |
拡張子 | GA |
az dt endpoint list |
Digital Twins インスタンスで構成されているすべてのエグレス エンドポイントを一覧表示します。 |
拡張子 | GA |
az dt endpoint show |
Digital Twins インスタンスで構成されたエンドポイントの詳細を表示します。 |
拡張子 | GA |
az dt endpoint wait |
エンドポイント操作が完了するまで待ちます。 |
拡張子 | GA |
az dt endpoint delete
Digital Twins インスタンスからエンドポイントを削除します。
az dt endpoint delete --dt-name
--en
[--no-wait]
[--resource-group]
[--yes]
例
インスタンスからエンドポイントを削除し、操作が完了するまでブロックします。
az dt endpoint delete -n {instance_name} --endpoint-name {endpoint_name}
確認またはブロックせずに、インスタンスからエンドポイントを削除します。
az dt endpoint delete -n {instance_name} --endpoint-name {endpoint_name} -y --no-wait
必須のパラメーター
Digital Twins インスタンス名。
エンドポイント名。
省略可能のパラメーター
実行時間の長い操作の終了を待機しません。
Digital Twins インスタンス リソース グループ。 az configure --defaults group=<name>
を使用して、既定のグループを構成できます。
確認のダイアログを表示しません。
グローバル パラメーター
すべてのデバッグ ログを表示するようにログの詳細レベルを上げます。
このヘルプ メッセージを表示して終了します。
エラーのみを表示し、警告は抑制します。
出力形式。
JMESPath クエリ文字列。 詳細と例については、http://jmespath.org/ をご覧ください。
サブスクリプションの名前または ID。 az account set -s NAME_OR_ID
を使用して、既定のサブスクリプションを構成できます。
ログの詳細レベルを上げます。 詳細なデバッグ ログを表示するには --debug を使います。
az dt endpoint list
Digital Twins インスタンスで構成されているすべてのエグレス エンドポイントを一覧表示します。
az dt endpoint list --dt-name
[--resource-group]
例
インスタンスに構成されているすべてのエグレス エンドポイントを一覧表示します。
az dt endpoint list -n {instance_name}
必須のパラメーター
Digital Twins インスタンス名。
省略可能のパラメーター
Digital Twins インスタンス リソース グループ。 az configure --defaults group=<name>
を使用して、既定のグループを構成できます。
グローバル パラメーター
すべてのデバッグ ログを表示するようにログの詳細レベルを上げます。
このヘルプ メッセージを表示して終了します。
エラーのみを表示し、警告は抑制します。
出力形式。
JMESPath クエリ文字列。 詳細と例については、http://jmespath.org/ をご覧ください。
サブスクリプションの名前または ID。 az account set -s NAME_OR_ID
を使用して、既定のサブスクリプションを構成できます。
ログの詳細レベルを上げます。 詳細なデバッグ ログを表示するには --debug を使います。
az dt endpoint show
Digital Twins インスタンスで構成されたエンドポイントの詳細を表示します。
az dt endpoint show --dt-name
--en
[--resource-group]
例
インスタンスの名前で目的のエンドポイントを表示します。
az dt endpoint show -n {instance_name} --endpoint-name {endpoint_name}
必須のパラメーター
Digital Twins インスタンス名。
エンドポイント名。
省略可能のパラメーター
Digital Twins インスタンス リソース グループ。 az configure --defaults group=<name>
を使用して、既定のグループを構成できます。
グローバル パラメーター
すべてのデバッグ ログを表示するようにログの詳細レベルを上げます。
このヘルプ メッセージを表示して終了します。
エラーのみを表示し、警告は抑制します。
出力形式。
JMESPath クエリ文字列。 詳細と例については、http://jmespath.org/ をご覧ください。
サブスクリプションの名前または ID。 az account set -s NAME_OR_ID
を使用して、既定のサブスクリプションを構成できます。
ログの詳細レベルを上げます。 詳細なデバッグ ログを表示するには --debug を使います。
az dt endpoint wait
エンドポイント操作が完了するまで待ちます。
az dt endpoint wait --dt-name
--en
[--created]
[--custom]
[--deleted]
[--exists]
[--interval]
[--resource-group]
[--timeout]
例
インスタンスのエンドポイントが作成されるまで待ちます。
az dt endpoint wait -n {instance_name} --endpoint-name {endpoint_name} --created
既存のエンドポイントがインスタンスから削除されるまで待ちます。
az dt endpoint wait -n {instance_name} --endpoint-name {endpoint_name} --deleted
既存のエンドポイントの primaryConnectionString が null になるまで待ちます。
az dt endpoint wait -n {instance_name} --endpoint-name {endpoint_name} --custom "properties.primaryConnectionString==null"
必須のパラメーター
Digital Twins インスタンス名。
エンドポイント名。
省略可能のパラメーター
'provisioningState' が 'Succeeded' で作成されるまで待ちます。
条件がカスタム JMESPath クエリを満たすまで待ちます。 例: provisioningState!='InProgress'、instanceView.statuses[?code=='PowerState/running']。
削除されるまで待ちます。
リソースが存在するまで待ちます。
ポーリング間隔 (秒単位)。
Digital Twins インスタンス リソース グループ。 az configure --defaults group=<name>
を使用して、既定のグループを構成できます。
最大待機時間 (秒単位)。
グローバル パラメーター
すべてのデバッグ ログを表示するようにログの詳細レベルを上げます。
このヘルプ メッセージを表示して終了します。
エラーのみを表示し、警告は抑制します。
出力形式。
JMESPath クエリ文字列。 詳細と例については、http://jmespath.org/ をご覧ください。
サブスクリプションの名前または ID。 az account set -s NAME_OR_ID
を使用して、既定のサブスクリプションを構成できます。
ログの詳細レベルを上げます。 詳細なデバッグ ログを表示するには --debug を使います。
Azure CLI