Private Endpoint Connection - Create Or Update

Ссылка

Служба:: API Management

Версия API:: 2024-05-01

Создает новое подключение к частной конечной точке или обновляет существующую.

PUT https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/privateEndpointConnections/{privateEndpointConnectionName}?api-version=2024-05-01

Параметры URI

Имя	В	Обязательно	Тип	Описание
privateEndpointConnectionName	path	True	string	Имя подключения частной конечной точки.
resourceGroupName	path	True	string minLength: 1 maxLength: 90	Имя группы ресурсов. Имя не учитывает регистр.
serviceName	path	True	string minLength: 1 maxLength: 50 pattern: ^[a-zA-Z](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$	Имя службы управления API.
subscriptionId	path	True	string (uuid)	Идентификатор целевой подписки. Значение должно быть UUID.
api-version	query	True	string minLength: 1	Версия API, используемая для этой операции.

Текст запроса

Имя	Тип	Описание
id	string	Идентификатор ресурса подключения к частной конечной точке.
properties	Properties	Состояние подключения частной конечной точки.

Ответы

Имя	Тип	Описание
200 OK	PrivateEndpointConnection	Запрос подключения к частной конечной точке завершен.
202 Accepted		Запрос на утверждение или отклонение подключения к частной конечной точке. Заголовок расположения содержит URL-адрес, в котором можно проверить состояние длительной операции. Заголовки location: string
Other Status Codes	ErrorResponse	Ответ на ошибку, описывающий причину сбоя операции.

Имя

Тип

Описание

200 OK

PrivateEndpointConnection

Запрос подключения к частной конечной точке завершен.

202 Accepted

Запрос на утверждение или отклонение подключения к частной конечной точке. Заголовок расположения содержит URL-адрес, в котором можно проверить состояние длительной операции.

Заголовки

location: string

Other Status Codes

ErrorResponse

Ответ на ошибку, описывающий причину сбоя операции.

Безопасность

azure_auth

Поток OAuth2 Azure Active Directory.

Тип: oauth2
Flow: implicit
URL-адрес авторизации: https://login.microsoftonline.com/common/oauth2/authorize

Области

Имя	Описание
user_impersonation	олицетворения учетной записи пользователя

Примеры

ApiManagementApproveOrRejectPrivateEndpointConnection

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

HTTP

PUT https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/privateEndpointConnections/privateEndpointConnectionName?api-version=2024-05-01

{
  "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/privateEndpointConnections/connectionName",
  "properties": {
    "privateLinkServiceConnectionState": {
      "status": "Approved",
      "description": "The Private Endpoint Connection is approved."
    }
  }
}

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

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

location: https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/apis/tempgroup?api-version=2024-05-01&asyncId=5c730e343244df1b9cb56e85&asyncCode=201

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

{
  "name": "privateEndpointConnectionName",
  "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/privateEndpointConnections/privateEndpointConnectionName",
  "type": "Microsoft.ApiManagement/service/privateEndpointConnections",
  "properties": {
    "provisioningState": "Succeeded",
    "privateEndpoint": {
      "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.Network/privateEndpoints/privateEndpointName"
    },
    "privateLinkServiceConnectionState": {
      "status": "Succeeded",
      "description": "The request has been approved."
    }
  }
}

Определения

Имя	Описание
ErrorAdditionalInfo	Дополнительные сведения об ошибке управления ресурсами.
ErrorDetail	Сведения об ошибке.
ErrorResponse	Ответ на ошибку
PrivateEndpoint	Ресурс частной конечной точки.
PrivateEndpointConnection	Ресурс подключения к частной конечной точке.
PrivateEndpointConnectionProvisioningState	Текущее состояние подготовки.
PrivateEndpointConnectionRequest	Запрос на утверждение или отклонение подключения частной конечной точки
PrivateEndpointServiceConnectionStatus	Состояние подключения к частной конечной точке.
PrivateLinkServiceConnectionState	Коллекция сведений о состоянии подключения между потребителем службы и поставщиком.
Properties	Состояние подключения частной конечной точки.

ErrorAdditionalInfo

Object

Дополнительные сведения об ошибке управления ресурсами.

Имя	Тип	Описание
info	object	Дополнительные сведения.
type	string	Дополнительный тип сведений.

ErrorDetail

Object

Сведения об ошибке.

Имя	Тип	Описание
additionalInfo	ErrorAdditionalInfo[]	Дополнительные сведения об ошибке.
code	string	Код ошибки.
details	ErrorDetail[]	Сведения об ошибке.
message	string	Сообщение об ошибке.
target	string	Целевой объект ошибки.

ErrorResponse

Object

Ответ на ошибку

Имя	Тип	Описание
error	ErrorDetail	Объект ошибки.