az dt network private-endpoint connection

Note

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

Digital Twins インスタンスのプライベート エンドポイント接続を管理します。

コマンド

名前	説明	型	Status
az dt network private-endpoint connection delete	Digital Twins インスタンスに関連付けられているプライベート エンドポイント接続を削除します。	拡張	GA
az dt network private-endpoint connection list	Digital Twins インスタンスに関連付けられているプライベート エンドポイント接続を一覧表示します。	拡張	GA
az dt network private-endpoint connection set	Digital Twins インスタンスに関連付けられているプライベート エンドポイント接続の状態を設定します。	拡張	GA
az dt network private-endpoint connection show	Digital Twins インスタンスに関連付けられているプライベート エンドポイント接続を表示します。	拡張	GA
az dt network private-endpoint connection wait	プライベート エンドポイント接続の操作が完了するまで待ちます。	拡張	GA

az dt network private-endpoint connection delete

Digital Twins インスタンスに関連付けられているプライベート エンドポイント接続を削除します。

az dt network private-endpoint connection delete --cn
                                                 --dt-name
                                                 [--no-wait]
                                                 [--resource-group]
                                                 [--yes]

例

確認を行って、ba8408b6-1372-41b2-aef8-af43afc4729f という名前のプライベート エンドポイント接続を削除します。 完了するまでブロックします。

az dt network private-endpoint connection delete -n {instance_name} --cn ba8408b6-1372-41b2-aef8-af43afc4729f

ba8408b6-1372-41b2-aef8-af43afc4729f という名前のプライベート エンドポイント接続を確認なしで削除します。 すぐに戻ります。

az dt network private-endpoint connection delete -n {instance_name} --cn ba8408b6-1372-41b2-aef8-af43afc4729f -y --no-wait

必須のパラメーター

--cn --conn-name

プライベート エンドポイント接続名。

--dt-name --dtn -n

Digital Twins インスタンス名。

省略可能のパラメーター

--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 network private-endpoint connection list

Digital Twins インスタンスに関連付けられているプライベート エンドポイント接続を一覧表示します。

az dt network private-endpoint connection list --dt-name
                                               [--resource-group]

例

インスタンスに関連付けられているすべてのプライベート エンドポイント接続を一覧表示します。

az dt network private-endpoint 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 network private-endpoint connection set

Digital Twins インスタンスに関連付けられているプライベート エンドポイント接続の状態を設定します。

az dt network private-endpoint connection set --cn
                                              --dt-name
                                              --status {Approved, Disconnected, Pending, Rejected}
                                              [--actions-required]
                                              [--desc]
                                              [--group-ids]
                                              [--no-wait]
                                              [--resource-group]

例

インスタンスに関連付けられている保留中のプライベート エンドポイント接続を承認し、説明を追加します。

az dt network private-endpoint connection set -n {instance_name} --cn {connection_name} --status Approved --desc "A description."

インスタンスに関連付けられているプライベート エンドポイント接続を拒否し、説明を追加します。

az dt network private-endpoint connection set -n {instance_name} --cn {connection_name} --status Rejected --desc "Does not comply."

必須のパラメーター

--cn --conn-name

プライベート エンドポイント接続名。

--dt-name --dtn -n

Digital Twins インスタンス名。

--status

プライベート エンドポイント接続の状態。

承認された値: Approved, Disconnected, Pending, Rejected

省略可能のパラメーター

--actions-required --ar

サービス プロバイダーの変更にコンシューマーの更新が必要かどうかを示すメッセージ。

--desc --description

プライベート エンドポイント接続の説明。

--group-ids

プライベート エンドポイントが接続する必要があるグループ ID のスペース区切りリスト。

--no-wait

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

既定値: False

--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 network private-endpoint connection show

Digital Twins インスタンスに関連付けられているプライベート エンドポイント接続を表示します。

az dt network private-endpoint connection show --cn
                                               --dt-name
                                               [--resource-group]

例

ba8408b6-1372-41b2-aef8-af43afc4729f という名前のプライベート エンドポイント接続の詳細を表示します。

az dt network private-endpoint connection show -n {instance_name} --cn ba8408b6-1372-41b2-aef8-af43afc4729f

必須のパラメーター

--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 network private-endpoint connection wait

プライベート エンドポイント接続の操作が完了するまで待ちます。

az dt network private-endpoint connection wait --cn
                                               --dt-name
                                               [--custom]
                                               [--deleted]
                                               [--interval]
                                               [--resource-group]
                                               [--timeout]
                                               [--updated]

例

ba8408b6-1372-41b2-aef8-af43afc4729f という名前の既存のプライベート エンドポイント接続が更新されるまで待ちます。

az dt network private-endpoint connection wait -n {instance_name} --cn ba8408b6-1372-41b2-aef8-af43afc4729f --updated

ba8408b6-1372-41b2-aef8-af43afc4729f という名前の既存のプライベート エンドポイント接続が削除されるまで待ちます。

az dt network private-endpoint connection wait -n {instance_name} --cn ba8408b6-1372-41b2-aef8-af43afc4729f --deleted

ba8408b6-1372-41b2-aef8-af43afc4729f という名前の既存のプライベート エンドポイント接続が privateLinkServiceConnectionState プロパティにアクションを必要としないまで待ちます。

az dt network private-endpoint connection wait -n {instance_name} --cn ba8408b6-1372-41b2-aef8-af43afc4729f --custom "properties.privateLinkServiceConnectionState.actionsRequired=='None'"

必須のパラメーター

--cn --conn-name

プライベート エンドポイント接続名。

--dt-name --dtn -n

Digital Twins インスタンス名。

省略可能のパラメーター

--custom

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

--deleted

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

既定値: 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 を使います。