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

Private Endpoint Connections - List By Resource

List 操作获取与保管库关联的专用终结点连接的相关信息。

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

URI 参数

Name In Required Type Description
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 版本。

响应

Name Type Description
200 OK

获取有关指定资源组中所有专用终结点连接的信息。

Other Status Codes

描述操作失败的原因的错误响应。

示例

KeyVaultListPrivateEndpointConnection

Sample Request

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

Sample Response

{
  "value": [
    {
      "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"
        }
      }
    },
    {
      "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"
        }
      }
    }
  ],
  "nextLink": null
}

定义

ActionsRequired

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

CloudError

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

CloudErrorBody

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

PrivateEndpoint

专用终结点对象属性。

PrivateEndpointConnection

专用终结点连接资源。

PrivateEndpointConnectionListResult

专用终结点连接列表。

PrivateEndpointConnectionProvisioningState

当前预配状态。

PrivateEndpointServiceConnectionStatus

专用终结点连接状态。

PrivateLinkServiceConnectionState

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

ActionsRequired

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

Name Type Description
None
  • string

CloudError

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

Name Type Description
error

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

CloudErrorBody

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

Name Type Description
code
  • string

错误代码。 这是一种可以编程方式使用的助记法。

message
  • string

用户友好的错误消息。 消息通常已本地化,可能会因服务版本而异。

PrivateEndpoint

专用终结点对象属性。

Name Type Description
id
  • string

专用终结点资源的完整标识符。

PrivateEndpointConnection

专用终结点连接资源。

Name Type Description
etag
  • string

每当专用终结点连接状态发生更改时修改。

id
  • string

密钥保管库资源的完全限定标识符。

location
  • string

Key Vault 资源的 Azure 位置。

name
  • string

密钥保管库资源的名称。

properties.privateEndpoint

专用终结点对象的属性。

properties.privateLinkServiceConnectionState

专用链接连接的审批状态。

properties.provisioningState

预配专用终结点连接的状态。

tags
  • object

分配给密钥保管库资源的标记。

type
  • string

Key Vault 资源的资源类型。

PrivateEndpointConnectionListResult

专用终结点连接列表。

Name Type Description
nextLink
  • string

用于获取下一组专用终结点连接的 URL。

value

专用终结点连接列表。

PrivateEndpointConnectionProvisioningState

当前预配状态。

Name Type Description
Creating
  • string
Deleting
  • string
Disconnected
  • string
Failed
  • string
Succeeded
  • string
Updating
  • string

PrivateEndpointServiceConnectionStatus

专用终结点连接状态。

Name Type Description
Approved
  • string
Disconnected
  • string
Pending
  • string
Rejected
  • string

PrivateLinkServiceConnectionState

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

Name Type Description
actionsRequired

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

description
  • string

批准或拒绝的原因。

status

指示密钥保管库所有者是否已批准、拒绝或删除连接。