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

Private Endpoint Connections - Get

获取专用终结点连接。

GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Sql/servers/{serverName}/privateEndpointConnections/{privateEndpointConnectionName}?api-version=2021-11-01

URI 参数

名称 必需 类型 说明
privateEndpointConnectionName
path True

string

专用终结点连接的名称。

resourceGroupName
path True

string

包含该资源的资源组名称。 可以从 Azure 资源管理器 API 或门户获取此值。

serverName
path True

string

服务器的名称。

subscriptionId
path True

string

用于标识 Azure 订阅的订阅 ID。

api-version
query True

string

要用于请求的 API 版本。

响应

名称 类型 说明
200 OK

PrivateEndpointConnection

已成功检索指定的专用终结点连接。

Other Status Codes

错误响应:***

  • 400 PrivateEndpointConnectionDoesNotExist - 专用终结点连接不存在

  • 400 PrivateEndpointConnectionStatusNotPending - 专用终结点连接状态不是挂起

  • 400 NullRemotePrivateLinkServiceConnectionState - 远程专用链接服务连接状态为 Null

  • 400 NullPrivateEndpointConnectionProperties - 专用终结点连接属性为 Null

  • 400 NullRemotePrivateLinkServiceConnectionStateStatus - 远程专用链接服务连接状态状态为 Null

  • 400 不正确的PrivateLinkServiceConnectionStateStatus - 专用链接服务连接状态状态必须为“已批准”或“已拒绝”

  • 404 ResourceNotFound - 找不到请求的资源。

示例

Gets private endpoint connection.

示例请求

GET https://management.azure.com/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/Default/providers/Microsoft.Sql/servers/test-svr/privateEndpointConnections/private-endpoint-connection-name?api-version=2021-11-01

示例响应

{
  "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/Default/providers/Microsoft.Sql/servers/test-svr/privateEndpointConnections/private-endpoint-connection-name",
  "name": "private-endpoint-connection-name",
  "type": "Microsoft.Sql/servers/privateEndpointConnections",
  "properties": {
    "provisioningState": "Ready",
    "privateEndpoint": {
      "id": "/subscriptions/55555555-6666-7777-8888-999999999999/resourceGroups/Default-Network/providers/Microsoft.Network/privateEndpoints/private-endpoint-name"
    },
    "privateLinkServiceConnectionState": {
      "status": "Approved",
      "description": "Auto-approved",
      "actionsRequired": "None"
    }
  }
}

定义

名称 说明
PrivateEndpointConnection

专用终结点连接

PrivateEndpointProperty
PrivateEndpointProvisioningState

专用终结点连接的状态。

PrivateLinkServiceConnectionStateActionsRequire

专用链接服务连接所需的操作。

PrivateLinkServiceConnectionStateProperty
PrivateLinkServiceConnectionStateStatus

专用链接服务连接状态。

PrivateEndpointConnection

专用终结点连接

名称 类型 说明
id

string

资源 ID。

name

string

资源名称。

properties.groupIds

string[]

组 ID。

properties.privateEndpoint

PrivateEndpointProperty

连接所属的专用终结点。

properties.privateLinkServiceConnectionState

PrivateLinkServiceConnectionStateProperty

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

properties.provisioningState

PrivateEndpointProvisioningState

专用终结点连接的状态。

type

string

资源类型。

PrivateEndpointProperty

名称 类型 说明
id

string

专用终结点的资源 ID。

PrivateEndpointProvisioningState

专用终结点连接的状态。

名称 类型 说明
Approving

string

Dropping

string

Failed

string

Ready

string

Rejecting

string

PrivateLinkServiceConnectionStateActionsRequire

专用链接服务连接所需的操作。

名称 类型 说明
None

string

PrivateLinkServiceConnectionStateProperty

名称 类型 说明
actionsRequired

PrivateLinkServiceConnectionStateActionsRequire

专用链接服务连接所需的操作。

description

string

专用链接服务连接说明。

status

PrivateLinkServiceConnectionStateStatus

专用链接服务连接状态。

PrivateLinkServiceConnectionStateStatus

专用链接服务连接状态。

名称 类型 说明
Approved

string

Disconnected

string

Pending

string

Rejected

string