Поделиться через

Private Endpoint Connections - List By Server

  • Ссылка
Служба:
SQL Database
Версия API:
2021-11-01

Получает все подключения к частной конечной точке на сервере.

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

Параметры URI

Имя В Обязательно Тип Описание
resourceGroupName
 path True

string

Имя группы ресурсов, к которой относится ресурс. Это значение можно получить от API-интерфейса диспетчера ресурсов Azure или портала.
serverName
 path True

string

Имя сервера.
subscriptionId
 path True

string

Идентификатор подписки Azure.
api-version
 query True

string

Версия API для использования в запросе.

Ответы

Имя Тип Описание
200 OK

PrivateEndpointConnectionListResult

Подключения к частной конечной точке успешно получены.
Other Status Codes

Ответы на ошибки: ***

  • 400 PrivateEndpointConnectionDoesNotExist — подключение к частной конечной точке не существует

  • 400 PrivateEndpointConnectionStatusNotPending — состояние подключения к частной конечной точке не ожидается

  • 400 NullRemotePrivateLinkServiceConnectionState — состояние подключения удаленной службы Приватный канал равно NULL

  • 400 NullPrivateEndpointConnectionProperties — свойства подключения к частной конечной точке — null

  • 400 NullRemotePrivateLinkServiceConnectionStateStatus — состояние подключения удаленной службы Приватный канал — null

  • 400 IncorrectPrivateLinkServiceConnectionStateStatus — состояние подключения службы Приватный канал должно быть "Утверждено" или "Отклонено"

  • 404 ResourceNotFound — запрошенный ресурс не найден.

Примеры

Gets list of private endpoint connections on a server.

Образец запроса

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

Пример ответа

Код состояния:
200 
{
  "value": [
    {
      "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/Default/providers/Microsoft.Sql/servers/test-svr/privateEndpointConnections/private-endpoint-connection-name-2",
      "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"
        }
      }
    },
    {
      "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/Default/providers/Microsoft.Sql/servers/test-svr/privateEndpointConnections/private-endpoint-connection-name-2",
      "name": "private-endpoint-connection-name-2",
      "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-2"
        },
        "privateLinkServiceConnectionState": {
          "status": "Approved",
          "description": "Auto-approved",
          "actionsRequired": "None"
        }
      }
    }
  ]
}

Определения

Имя Описание
PrivateEndpointConnection

Подключение к частной конечной точке
PrivateEndpointConnectionListResult

Список подключений к частной конечной точке.
PrivateEndpointProperty
PrivateEndpointProvisioningState

Состояние подключения к частной конечной точке.
PrivateLinkServiceConnectionStateActionsRequire

Действия, необходимые для подключения службы приватного канала.
PrivateLinkServiceConnectionStateProperty
PrivateLinkServiceConnectionStateStatus

Состояние подключения службы приватного канала.

PrivateEndpointConnection

Подключение к частной конечной точке

Имя Тип Описание
id

string

Идентификатор ресурса.
name

string

Имя ресурса.
properties.groupIds

string[]

Идентификаторы групп.
properties.privateEndpoint

PrivateEndpointProperty

Частная конечная точка, к которой принадлежит подключение.
properties.privateLinkServiceConnectionState

PrivateLinkServiceConnectionStateProperty

Состояние подключения к частной конечной точке.
properties.provisioningState

PrivateEndpointProvisioningState

Состояние подключения к частной конечной точке.
type

string

Тип ресурса.

PrivateEndpointConnectionListResult

Список подключений к частной конечной точке.

Имя Тип Описание
nextLink

string

Ссылка для получения следующей страницы результатов.
value

PrivateEndpointConnection[]

Массив результатов.

PrivateEndpointProperty

Имя Тип Описание
id

string

Идентификатор ресурса частной конечной точки.

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