你当前正在访问 Microsoft Azure Global Edition 技术文档网站。 如果需要访问由世纪互联运营的 Microsoft Azure 中国技术文档网站，请访问 https://docs.azure.cn。

az keyvault private-endpoint-connection

管理保管库/HSM 专用终结点连接。

命令

名称	说明	类型	状态
az keyvault private-endpoint-connection approve	批准密钥库/HSM 的专用终结点连接请求。	核心	GA
az keyvault private-endpoint-connection delete	删除与 密钥库/HSM 关联的指定专用终结点连接。	核心	GA
az keyvault private-endpoint-connection list	列出与 HSM 关联的所有专用终结点连接。	核心	GA
az keyvault private-endpoint-connection reject	拒绝 密钥库/HSM 的专用终结点连接请求。	核心	GA
az keyvault private-endpoint-connection show	显示与 密钥库/HSM 关联的专用终结点连接的详细信息。	核心	GA
az keyvault private-endpoint-connection wait	将 CLI 置于等待状态，直到满足专用终结点连接的条件。	核心	GA

az keyvault private-endpoint-connection approve

批准密钥库/HSM 的专用终结点连接请求。

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

示例

根据 ID 批准密钥库的专用终结点连接请求。

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 批准密钥库的专用终结点连接请求。

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

使用保管库名称和连接名称批准密钥库的专用终结点连接请求。

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

使用保管库名称和连接名称批准密钥库的专用终结点连接请求。

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 互斥，请只指定其中一个）。

--id

与 密钥库/HSM 关联的专用终结点连接的 ID。 如果指定了 --vault-name/--hsm-name 和 --name/-n，则应省略此项。

--name -n

与 密钥库/HSM 关联的专用终结点连接的名称。 如果未指定 --id，则为必需。

--no-wait

不等待长时间运行的操作完成。

默认值: False

--resource-group -g

仅当密钥库属于指定的资源组时继续。

--vault-name

密钥库的名称。 如果未指定 --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

删除与 密钥库/HSM 关联的指定专用终结点连接。

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

示例

按 ID 删除密钥库的专用终结点连接请求。

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 删除密钥库的专用终结点连接请求。

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

使用保管库名称和连接名称删除密钥库的专用终结点连接请求。

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

使用保管库名称和连接名称删除密钥库的专用终结点连接请求。

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 互斥，请只指定其中一个）。

--id

与 密钥库/HSM 关联的专用终结点连接的 ID。 如果指定了 --vault-name/--hsm-name 和 --name/-n，则应省略此项。

--name -n

与 密钥库/HSM 关联的专用终结点连接的名称。 如果未指定 --id，则为必需。

--no-wait

不等待长时间运行的操作完成。

默认值: False

--resource-group -g

仅当密钥库属于指定的资源组时继续。

--vault-name

密钥库的名称。 如果未指定 --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

仅当密钥库属于指定的资源组时继续。

全局参数

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

拒绝 密钥库/HSM 的专用终结点连接请求。

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

示例

按 ID 拒绝密钥库的专用终结点连接请求。

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 拒绝密钥库的专用终结点连接请求。

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

使用保管库名称和连接名称拒绝密钥库的专用终结点连接请求。

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

使用保管库名称和连接名称拒绝密钥库的专用终结点连接请求。

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 互斥，请只指定其中一个）。

--id

与 密钥库/HSM 关联的专用终结点连接的 ID。 如果指定了 --vault-name/--hsm-name 和 --name/-n，则应省略此项。

--name -n

与 密钥库/HSM 关联的专用终结点连接的名称。 如果未指定 --id，则为必需。

--no-wait

不等待长时间运行的操作完成。

默认值: False

--resource-group -g

仅当密钥库属于指定的资源组时继续。

--vault-name

密钥库的名称。 如果未指定 --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

显示与 密钥库/HSM 关联的专用终结点连接的详细信息。

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

示例

按 ID 显示密钥库专用终结点连接请求的详细信息。

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 显示密钥库专用终结点连接请求的详细信息。

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

使用保管库名称和连接名称显示密钥库专用终结点连接请求的详细信息。

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

使用保管库名称和连接名称显示密钥库专用终结点连接请求的详细信息。

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 互斥，请只指定其中一个）。

--id

与 密钥库/HSM 关联的专用终结点连接的 ID。 如果指定了 --vault-name/--hsm-name 和 --name/-n，则应省略此项。

--name -n

与 密钥库/HSM 关联的专用终结点连接的名称。 如果未指定 --id，则为必需。

--resource-group -g

仅当密钥库属于指定的资源组时继续。

--vault-name

密钥库的名称。 如果未指定 --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]

示例

暂停 CLI，直到 ID 批准/拒绝专用终结点连接。

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

等待在“Succeeded”中使用“provisioningState”创建。

默认值: False

--custom

等待条件满足自定义 JMESPath 查询。 例如 provisioningState！='InProgress'， instanceView.statuses[？code=='PowerState/running']。

--deleted

等到删除为止。

默认值: False

--exists

等待资源存在。

默认值: False

--hsm-name

HSM 的名称。 如果未指定 --id，则为必需。（--hsm-name 和 --vault-name 互斥，请只指定其中一个）。

--id

与 密钥库/HSM 关联的专用终结点连接的 ID。 如果指定了 --vault-name/--hsm-name 和 --name/-n，则应省略此项。

--interval

轮询间隔（以秒为单位）。

默认值: 30

--name -n

与 密钥库/HSM 关联的专用终结点连接的名称。 如果未指定 --id，则为必需。

--resource-group -g

仅当密钥库属于指定的资源组时继续。

--timeout

最大等待（以秒为单位）。

默认值: 3600

--updated

等到 provisioningState 更新为“Succeeded”。

默认值: False

--vault-name

密钥库的名称。 如果未指定 --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 获取完整的调试日志。