az dt endpoint

Note

This reference is part of the azure-iot extension for the Azure CLI (version 2.59.0 or higher). 拡張機能は、az dt endpoint コマンドを初めて実行するときに自動的にインストールされます。 Learn more about extensions.

Digital Twins インスタンスエンドポイントを管理および構成します。

コマンド

名前	説明	型	状態
az dt endpoint create	Digital Twins インスタンスにエグレスエンドポイントを追加します。	Extension	GA
az dt endpoint create eventgrid	EventGrid トピックエンドポイントを Digital Twins インスタンスに追加します。事前に作成されたリソースが必要です。	Extension	GA
az dt endpoint create eventhub	Digital Twins インスタンスに EventHub エンドポイントを追加します。	Extension	GA
az dt endpoint create servicebus	ServiceBus トピックエンドポイントを Digital Twins インスタンスに追加します。	Extension	GA
az dt endpoint delete	Digital Twins インスタンスからエンドポイントを削除します。	Extension	GA
az dt endpoint list	Digital Twins インスタンスで構成されているすべてのエグレスエンドポイントを一覧表示します。	Extension	GA
az dt endpoint show	Digital Twins インスタンスで構成されたエンドポイントの詳細を表示します。	Extension	GA
az dt endpoint wait	エンドポイント操作が完了するまで待ちます。	Extension	GA

az dt endpoint delete

Digital Twins インスタンスからエンドポイントを削除します。

az dt endpoint delete --dt-name --dtn
                      --en --endpoint-name
                      [--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

Endpoint name.

省略可能のパラメーター

The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.

--no-wait

実行時間の長い操作が完了するまで待つ必要はありません。

プロパティ	値
規定値:	False

--resource-group -g

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

--yes -y

確認を求めないでください。

プロパティ	値
規定値:	False

グローバルパラメーター

--debug

ログの詳細度を上げて、すべてのデバッグログを表示します。

プロパティ	値
規定値:	False

--help -h

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

--only-show-errors

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

プロパティ	値
規定値:	False

--output -o

Output format.

プロパティ	値
規定値:	json
指定可能な値:	json, jsonc, none, table, tsv, yaml, yamlc

--query

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

--subscription

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

--verbose

ログの詳細度を高める。完全なデバッグログには --debug を使用します。

プロパティ	値
規定値:	False

az dt endpoint list

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

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

例

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

az dt endpoint list -n {instance_name}

必須のパラメーター

--dt-name --dtn -n

Digital Twins インスタンス名。

省略可能のパラメーター

The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.

--resource-group -g

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

グローバルパラメーター

--debug

ログの詳細度を上げて、すべてのデバッグログを表示します。

プロパティ	値
規定値:	False

--help -h

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

--only-show-errors

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

プロパティ	値
規定値:	False

--output -o

Output format.

プロパティ	値
規定値:	json
指定可能な値:	json, jsonc, none, table, tsv, yaml, yamlc

--query

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

--subscription

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

--verbose

ログの詳細度を高める。完全なデバッグログには --debug を使用します。

プロパティ	値
規定値:	False

az dt endpoint show

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

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

例

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

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

必須のパラメーター

--dt-name --dtn -n

Digital Twins インスタンス名。

--en --endpoint-name

Endpoint name.

省略可能のパラメーター

The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.

--resource-group -g

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

グローバルパラメーター

--debug

ログの詳細度を上げて、すべてのデバッグログを表示します。

プロパティ	値
規定値:	False

--help -h

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

--only-show-errors

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

プロパティ	値
規定値:	False

--output -o

Output format.

プロパティ	値
規定値:	json
指定可能な値:	json, jsonc, none, table, tsv, yaml, yamlc

--query

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

--subscription

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

--verbose

ログの詳細度を高める。完全なデバッグログには --debug を使用します。

プロパティ	値
規定値:	False

az dt endpoint wait

エンドポイント操作が完了するまで待ちます。

az dt endpoint wait --dt-name --dtn
                    --en --endpoint-name
                    [--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

Endpoint name.

省略可能のパラメーター

The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.

--created

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

プロパティ	値
Parameter group:	Wait Condition Arguments
規定値:	False

--custom

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

プロパティ	値
Parameter group:	Wait Condition Arguments

--deleted

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

プロパティ	値
Parameter group:	Wait Condition Arguments
規定値:	False

--exists

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

プロパティ	値
Parameter group:	Wait Condition Arguments
規定値:	False

--interval

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

プロパティ	値
Parameter group:	Wait Condition Arguments
規定値:	30

--resource-group -g

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

--timeout

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

プロパティ	値
Parameter group:	Wait Condition Arguments
規定値:	3600

グローバルパラメーター

--debug

ログの詳細度を上げて、すべてのデバッグログを表示します。

プロパティ	値
規定値:	False

--help -h

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

--only-show-errors

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

プロパティ	値
規定値:	False

--output -o

Output format.

プロパティ	値
規定値:	json
指定可能な値:	json, jsonc, none, table, tsv, yaml, yamlc

--query

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

--subscription

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

--verbose

ログの詳細度を高める。完全なデバッグログには --debug を使用します。

プロパティ	値
規定値:	False

次の方法で共有

az dt endpoint

コマンド

az dt endpoint delete

例

必須のパラメーター

省略可能のパラメーター

az dt endpoint list

例

必須のパラメーター

省略可能のパラメーター

az dt endpoint show

例

必須のパラメーター

省略可能のパラメーター

az dt endpoint wait

例

必須のパラメーター

省略可能のパラメーター

フィードバック