az keyvault private-endpoint-connection

コンテナー/HSM プライベート エンドポイント接続を管理します。

コマンド

名前	説明	型	状態
az keyvault private-endpoint-connection approve	Key Vault/HSM のプライベート エンドポイント接続要求を承認します。	コア	GA
az keyvault private-endpoint-connection delete	Key Vault/HSM に関連付けられている指定されたプライベート エンドポイント接続を削除します。	コア	GA
az keyvault private-endpoint-connection list	HSM に関連付けられているすべてのプライベート エンドポイント接続を一覧表示します。	コア	GA
az keyvault private-endpoint-connection reject	Key Vault/HSM のプライベート エンドポイント接続要求を拒否します。	コア	GA
az keyvault private-endpoint-connection show	Key Vault/HSM に関連付けられているプライベート エンドポイント接続の詳細を表示します。	コア	GA
az keyvault private-endpoint-connection wait	プライベート エンドポイント接続の条件が満たされるまで、CLI を待機状態にします。	コア	GA

az keyvault private-endpoint-connection approve

Key Vault/HSM のプライベート エンドポイント接続要求を承認します。

az keyvault private-endpoint-connection approve [--description]
                                                [--hsm-name]
                                                [--id]
                                                [--name]
                                                [--no-wait]
                                                [--resource-group]
                                                [--vault-name]

例

ID で Key Vault のプライベート エンドポイント接続要求を承認します。

az keyvault private-endpoint-connection approve --id "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myrg/providers/Microsoft.KeyVault/vaults/mykv/privateEndpointConnections/mykv.00000000-0000-0000-0000-000000000000"

ID で Key Vault のプライベート エンドポイント接続要求を承認します。

id = (az keyvault show -n mykv --query "privateEndpointConnections[0].id")
az keyvault private-endpoint-connection approve --id $id

コンテナー名と接続名を使用して、Key Vault のプライベート エンドポイント接続要求を承認します。

az keyvault private-endpoint-connection approve -g myrg --vault-name mykv --name myconnection

コンテナー名と接続名を使用して、Key Vault のプライベート エンドポイント接続要求を承認します。

name = (az keyvault show -n mykv --query "privateEndpointConnections[0].name")
az keyvault private-endpoint-connection approve -g myrg --vault-name mykv --name $name

HSM 名と接続名を使用して、HSM のプライベート エンドポイント接続要求を承認します。

az keyvault private-endpoint-connection approve -g myrg --hsm-name myhsm --name myconnection

省略可能のパラメーター

--description

承認操作のコメント。

--hsm-name

HSM の名前。 --id が指定されていない場合は必須です。(--hsm-name と --vault-name は相互に排他的です。そのうちの 1 つだけを指定してください)。

--id

Key Vault/HSM に関連付けられているプライベート エンドポイント接続の ID。 --vault-name/--hsm-name と --name/-n を指定した場合、これは省略する必要があります。

--name -n

Key Vault/HSM に関連付けられているプライベート エンドポイント接続の名前。 --id が指定されていない場合は必須です。

--no-wait

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

規定値: False

--resource-group -g

Key Vault が指定したリソース グループに属している場合にのみ続行します。

--vault-name

Key Vault の名前。 --id が指定されていない場合は必須です。

グローバル パラメーター

--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 keyvault private-endpoint-connection delete

Key Vault/HSM に関連付けられている指定されたプライベート エンドポイント接続を削除します。

az keyvault private-endpoint-connection delete [--hsm-name]
                                               [--id]
                                               [--name]
                                               [--no-wait]
                                               [--resource-group]
                                               [--vault-name]

例

ID で Key Vault のプライベート エンドポイント接続要求を削除します。

az keyvault private-endpoint-connection delete --id "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myrg/providers/Microsoft.KeyVault/vaults/mykv/privateEndpointConnections/mykv.00000000-0000-0000-0000-000000000000"

ID で Key Vault のプライベート エンドポイント接続要求を削除します。

id = (az keyvault show -n mykv --query "privateEndpointConnections[0].id")
az keyvault private-endpoint-connection delete --id $id

コンテナー名と接続名を使用して、Key Vault のプライベート エンドポイント接続要求を削除します。

az keyvault private-endpoint-connection delete -g myrg --vault-name mykv --name myconnection

コンテナー名と接続名を使用して、Key Vault のプライベート エンドポイント接続要求を削除します。

name = (az keyvault show -n mykv --query "privateEndpointConnections[0].name")
az keyvault private-endpoint-connection delete -g myrg --vault-name mykv --name $name

HSM 名と接続名を使用して、HSM のプライベート エンドポイント接続要求を削除します。

az keyvault private-endpoint-connection delete -g myrg --hsm-name myhsm --name myconnection

省略可能のパラメーター

--hsm-name

HSM の名前。 --id が指定されていない場合は必須です。(--hsm-name と --vault-name は相互に排他的です。そのうちの 1 つだけを指定してください)。

--id

Key Vault/HSM に関連付けられているプライベート エンドポイント接続の ID。 --vault-name/--hsm-name と --name/-n を指定した場合、これは省略する必要があります。

--name -n

Key Vault/HSM に関連付けられているプライベート エンドポイント接続の名前。 --id が指定されていない場合は必須です。

--no-wait

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

規定値: False

--resource-group -g

Key Vault が指定したリソース グループに属している場合にのみ続行します。

--vault-name

Key Vault の名前。 --id が指定されていない場合は必須です。

グローバル パラメーター

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

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

az keyvault private-endpoint-connection list --hsm-name
                                             [--resource-group]

例

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

az keyvault private-endpoint-connection list -g myrg --hsm-name myhsm

必須のパラメーター

--hsm-name

HSM の名前。

省略可能のパラメーター

--resource-group -g

Key Vault が指定したリソース グループに属している場合にのみ続行します。

グローバル パラメーター

--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 keyvault private-endpoint-connection reject

Key Vault/HSM のプライベート エンドポイント接続要求を拒否します。

az keyvault private-endpoint-connection reject [--description]
                                               [--hsm-name]
                                               [--id]
                                               [--name]
                                               [--no-wait]
                                               [--resource-group]
                                               [--vault-name]

例

ID で Key Vault のプライベート エンドポイント接続要求を拒否します。

az keyvault private-endpoint-connection reject --id "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myrg/providers/Microsoft.KeyVault/vaults/mykv/privateEndpointConnections/mykv.00000000-0000-0000-0000-000000000000"

ID で Key Vault のプライベート エンドポイント接続要求を拒否します。

id = (az keyvault show -n mykv --query "privateEndpointConnections[0].id")
az keyvault private-endpoint-connection reject --id $id

コンテナー名と接続名を使用して、Key Vault のプライベート エンドポイント接続要求を拒否します。

az keyvault private-endpoint-connection reject -g myrg --vault-name mykv --name myconnection

コンテナー名と接続名を使用して、Key Vault のプライベート エンドポイント接続要求を拒否します。

name = (az keyvault show -n mykv --query "privateEndpointConnections[0].name")
az keyvault private-endpoint-connection reject -g myrg --vault-name mystorageaccount --name $name

HSM 名と接続名を使用して、HSM のプライベート エンドポイント接続要求を拒否します。

az keyvault private-endpoint-connection reject -g myrg --hsm-name myhsm --name myconnection

省略可能のパラメーター

--description

拒否操作のコメント。

--hsm-name

HSM の名前。 --id が指定されていない場合は必須です。(--hsm-name と --vault-name は相互に排他的です。そのうちの 1 つだけを指定してください)。

--id

Key Vault/HSM に関連付けられているプライベート エンドポイント接続の ID。 --vault-name/--hsm-name と --name/-n を指定した場合、これは省略する必要があります。

--name -n

Key Vault/HSM に関連付けられているプライベート エンドポイント接続の名前。 --id が指定されていない場合は必須です。

--no-wait

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

規定値: False

--resource-group -g

Key Vault が指定したリソース グループに属している場合にのみ続行します。

--vault-name

Key Vault の名前。 --id が指定されていない場合は必須です。

グローバル パラメーター

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

Key Vault/HSM に関連付けられているプライベート エンドポイント接続の詳細を表示します。

az keyvault private-endpoint-connection show [--hsm-name]
                                             [--id]
                                             [--name]
                                             [--resource-group]
                                             [--vault-name]

例

Id で Key Vault のプライベート エンドポイント接続要求の詳細を表示します。

az keyvault private-endpoint-connection show --id "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myrg/providers/Microsoft.KeyVault/vaults/mykv/privateEndpointConnections/mykv.00000000-0000-0000-0000-000000000000"

Id で Key Vault のプライベート エンドポイント接続要求の詳細を表示します。

id = (az keyvault show -n mykv --query "privateEndpointConnections[0].id")
az keyvault private-endpoint-connection show --id $id

コンテナー名と接続名を使用して、Key Vault のプライベート エンドポイント接続要求の詳細を表示します。

az keyvault private-endpoint-connection show -g myrg --vault-name mykv --name myconnection

コンテナー名と接続名を使用して、Key Vault のプライベート エンドポイント接続要求の詳細を表示します。

name = (az keyvault show -n mykv --query "privateEndpointConnections[0].name")
az keyvault private-endpoint-connection show -g myrg --vault-name mykv --name $name

省略可能のパラメーター

--hsm-name

HSM の名前。 --id が指定されていない場合は必須です。(--hsm-name と --vault-name は相互に排他的です。そのうちの 1 つだけを指定してください)。

--id

Key Vault/HSM に関連付けられているプライベート エンドポイント接続の ID。 --vault-name/--hsm-name と --name/-n を指定した場合、これは省略する必要があります。

--name -n

Key Vault/HSM に関連付けられているプライベート エンドポイント接続の名前。 --id が指定されていない場合は必須です。

--resource-group -g

Key Vault が指定したリソース グループに属している場合にのみ続行します。

--vault-name

Key Vault の名前。 --id が指定されていない場合は必須です。

グローバル パラメーター

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

プライベート エンドポイント接続の条件が満たされるまで、CLI を待機状態にします。

az keyvault private-endpoint-connection wait [--created]
                                             [--custom]
                                             [--deleted]
                                             [--exists]
                                             [--hsm-name]
                                             [--id]
                                             [--interval]
                                             [--name]
                                             [--resource-group]
                                             [--timeout]
                                             [--updated]
                                             [--vault-name]

例

プライベート エンドポイント接続が ID によって承認または拒否されるまで CLI を一時停止します。

az keyvault private-endpoint-connection wait --id "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myrg/providers/Microsoft.KeyVault/vaults/mykv/privateEndpointConnections/mykv.00000000-0000-0000-0000-000000000000" --created

コンテナー名と接続名を使用して、プライベート エンドポイント接続が承認または拒否されるまで CLI を一時停止します。

az keyvault private-endpoint-connection wait -g myrg --vault-name mykv --name myconnection --created

省略可能のパラメーター

--created

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

規定値: False

--custom

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

--deleted

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

規定値: False

--exists

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

規定値: False

--hsm-name

HSM の名前。 --id が指定されていない場合は必須です。(--hsm-name と --vault-name は相互に排他的です。そのうちの 1 つだけを指定してください)。

--id

Key Vault/HSM に関連付けられているプライベート エンドポイント接続の ID。 --vault-name/--hsm-name と --name/-n を指定した場合、これは省略する必要があります。

--interval

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

規定値: 30

--name -n

Key Vault/HSM に関連付けられているプライベート エンドポイント接続の名前。 --id が指定されていない場合は必須です。

--resource-group -g

Key Vault が指定したリソース グループに属している場合にのみ続行します。

--timeout

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

規定値: 3600

--updated

provisioningState が 'Succeeded' で更新されるまで待ちます。

規定値: False

--vault-name

Key Vault の名前。 --id が指定されていない場合は必須です。

グローバル パラメーター

--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 を使います。