Private Endpoint Connections - Get

Служба:

SQL Database

Версия API:

2021-11-01

Возвращает подключение к частной конечной точке.

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	Имя группы ресурсов, к которой относится ресурс. Это значение можно получить от API-интерфейса диспетчера ресурсов Azure или портала.
serverName	path	True	string	Имя сервера.
subscriptionId	path	True	string	Идентификатор подписки Azure.
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 IncorrectPrivateLinkServiceConnectionStateStatus — состояние подключения службы Приватный канал должно быть "Утверждено" или "Отклонено" 404 ResourceNotFound — запрошенный ресурс не найден.

Примеры

Gets private endpoint connection.

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

HTTP

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

Java

/**
 * Samples for PrivateEndpointConnections Get.
 */
public final class Main {
    /*
     * x-ms-original-file:
     * specification/sql/resource-manager/Microsoft.Sql/stable/2021-11-01/examples/PrivateEndpointConnectionGet.json
     */
    /**
     * Sample code: Gets private endpoint connection.
     * 
     * @param azure The entry point for accessing resource management APIs in Azure.
     */
    public static void getsPrivateEndpointConnection(com.azure.resourcemanager.AzureResourceManager azure) {
        azure.sqlServers().manager().serviceClient().getPrivateEndpointConnections().getWithResponse("Default",
            "test-svr", "private-endpoint-connection-name", com.azure.core.util.Context.NONE);
    }
}

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

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

Код состояния:

200

{
  "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	Идентификатор ресурса.
name	string	Имя ресурса.
properties.groupIds	string[]	Идентификаторы групп.
properties.privateEndpoint	PrivateEndpointProperty	Частная конечная точка, к которой принадлежит подключение.
properties.privateLinkServiceConnectionState	PrivateLinkServiceConnectionStateProperty	Состояние подключения к частной конечной точке.
properties.provisioningState	PrivateEndpointProvisioningState	Состояние подключения к частной конечной точке.
type	string	Тип ресурса.

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