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

Private Endpoint Connections - Get

参考

Service:: Key Vault

API Version:: 2022-07-01

获取与密钥保管库关联的指定专用终结点连接。

GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.KeyVault/vaults/{vaultName}/privateEndpointConnections/{privateEndpointConnectionName}?api-version=2022-07-01

URI 参数

名称	在	必需	类型	说明
privateEndpointConnectionName	path	True	string	与密钥保管库关联的专用终结点连接的名称。
resourceGroupName	path	True	string	包含 Key Vault 的资源组的名称。
subscriptionId	path	True	string	唯一标识 Microsoft Azure 订阅的订阅凭据。此订阅 ID 是每个服务调用的 URI 的一部分。
vaultName	path	True	string	密钥保管库的名称。 Regex pattern: `^[a-zA-Z0-9-]{3,24}$`
api-version	query	True	string	客户端 API 版本。

响应

名称	类型	说明
200 OK	PrivateEndpointConnection	已成功返回专用终结点连接。
204 No Content		专用终结点连接不存在。
Other Status Codes	CloudError	描述操作失败原因的错误响应。

示例

KeyVaultGetPrivateEndpointConnection

GET https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/sample-group/providers/Microsoft.KeyVault/vaults/sample-vault/privateEndpointConnections/sample-pec?api-version=2022-07-01

from azure.identity import DefaultAzureCredential
from azure.mgmt.keyvault import KeyVaultManagementClient

"""
# PREREQUISITES
    pip install azure-identity
    pip install azure-mgmt-keyvault
# USAGE
    python get_private_endpoint_connection.py

    Before run the sample, please set the values of the client ID, tenant ID and client secret
    of the AAD application as environment variables: AZURE_CLIENT_ID, AZURE_TENANT_ID,
    AZURE_CLIENT_SECRET. For more info about how to get the value, please see:
    https://docs.microsoft.com/azure/active-directory/develop/howto-create-service-principal-portal
"""


def main():
    client = KeyVaultManagementClient(
        credential=DefaultAzureCredential(),
        subscription_id="00000000-0000-0000-0000-000000000000",
    )

    response = client.private_endpoint_connections.get(
        resource_group_name="sample-group",
        vault_name="sample-vault",
        private_endpoint_connection_name="sample-pec",
    )
    print(response)


# x-ms-original-file: specification/keyvault/resource-manager/Microsoft.KeyVault/stable/2022-07-01/examples/getPrivateEndpointConnection.json
if __name__ == "__main__":
    main()

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

Sample Response

Status code:: 200

{
  "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/sample-group/providers/Microsoft.KeyVault/vaults/sample-vault/privateEndpointConnections/sample-pec",
  "name": "sample-pec",
  "type": "Microsoft.KeyVault/vaults/privateEndpointConnections",
  "etag": "",
  "properties": {
    "provisioningState": "Succeeded",
    "privateEndpoint": {
      "id": "/subscriptions/00000000-0000-0000-1234-000000000000/resourceGroups/sample-group/providers/Microsoft.Network/privateEndpoints/sample-pe"
    },
    "privateLinkServiceConnectionState": {
      "status": "Approved",
      "description": "This was automatically approved by user1234@contoso.com",
      "actionsRequired": "None"
    }
  }
}

Status code:: 204

定义

名称	说明
ActionsRequired	一条消息，指示服务提供商的更改是否需要对使用者进行任何更新。
CloudError	密钥保管库资源提供程序的错误响应
CloudErrorBody	密钥保管库资源提供程序的错误响应
PrivateEndpoint	专用终结点对象属性。
PrivateEndpointConnection	专用终结点连接资源。
PrivateEndpointConnectionProvisioningState	当前预配状态。
PrivateEndpointServiceConnectionStatus	专用终结点连接状态。
PrivateLinkServiceConnectionState	一个对象，表示专用链接连接的审批状态。

ActionsRequired

一条消息，指示服务提供商的更改是否需要对使用者进行任何更新。

名称	类型	说明
None	string

CloudError

密钥保管库资源提供程序的错误响应

名称	类型	说明
error	CloudErrorBody	密钥保管库资源提供程序的错误响应

CloudErrorBody

密钥保管库资源提供程序的错误响应

名称	类型	说明
code	string	错误代码。这是可以编程方式使用的助记键。
message	string	用户友好的错误消息。消息通常是本地化的，可能因服务版本而异。

PrivateEndpoint

专用终结点对象属性。

名称	类型	说明
id	string	专用终结点资源的完整标识符。

PrivateEndpointConnection

专用终结点连接资源。

名称	类型	说明
etag	string	每当专用终结点连接的状态发生更改时修改。
id	string	密钥保管库资源的完全限定标识符。
location	string	密钥保管库资源的 Azure 位置。
name	string	密钥保管库资源的名称。
properties.privateEndpoint	PrivateEndpoint	专用终结点对象的属性。
properties.privateLinkServiceConnectionState	PrivateLinkServiceConnectionState	专用链接连接的审批状态。
properties.provisioningState	PrivateEndpointConnectionProvisioningState	专用终结点连接的预配状态。
tags	object	分配给密钥保管库资源的标记。
type	string	密钥保管库资源的资源类型。

PrivateEndpointConnectionProvisioningState

当前预配状态。

名称	类型	说明
Creating	string
Deleting	string
Disconnected	string
Failed	string
Succeeded	string
Updating	string

PrivateEndpointServiceConnectionStatus

专用终结点连接状态。

名称	类型	说明
Approved	string
Disconnected	string
Pending	string
Rejected	string

PrivateLinkServiceConnectionState

一个对象，表示专用链接连接的审批状态。

名称	类型	说明
actionsRequired	ActionsRequired	一条消息，指示服务提供商的更改是否需要对使用者进行任何更新。
description	string	批准或拒绝的原因。
status	PrivateEndpointServiceConnectionStatus	指示连接是否已由密钥保管库所有者批准、拒绝或删除。