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

必須のパラメーター

--dt-name --dtn -n

Digital Twins インスタンス名。

--en --endpoint-name

エンドポイント名。

省略可能のパラメーター

--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 endpoint list

Digital Twins インスタンスで構成されているすべてのエグレス エンドポイントを一覧表示します。

az dt endpoint list --dt-name
                    [--resource-group]

インスタンスに構成されているすべてのエグレス エンドポイントを一覧表示します。

az dt endpoint 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 endpoint show

Digital Twins インスタンスで構成されたエンドポイントの詳細を表示します。

az dt endpoint show --dt-name
                    --en
                    [--resource-group]

インスタンスの名前で目的のエンドポイントを表示します。

az dt endpoint show -n {instance_name} --endpoint-name {endpoint_name}

必須のパラメーター

--dt-name --dtn -n

Digital Twins インスタンス名。

--en --endpoint-name

エンドポイント名。

省略可能のパラメーター

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

必須のパラメーター

--dt-name --dtn -n

Digital Twins インスタンス名。

--en --endpoint-name

エンドポイント名。

省略可能のパラメーター

--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
グローバル パラメーター
--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 を使います。