Private Endpoint Connections - Create Or Update

Ссылка

Служба:: Cosmos DB Resource Provider

Версия API:: 2024-11-15

Утверждение или отклонение подключения частной конечной точки с заданным именем.

PUT https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/databaseAccounts/{accountName}/privateEndpointConnections/{privateEndpointConnectionName}?api-version=2024-11-15

Параметры URI

Имя	В	Обязательно	Тип	Описание
accountName	path	True	string	Имя учетной записи базы данных Cosmos DB. Шаблон регулярного выражения: `^[a-z0-9]+(-[a-z0-9]+)*`
privateEndpointConnectionName	path	True	string	Имя подключения частной конечной точки.
resourceGroupName	path	True	string	Имя группы ресурсов. Имя не учитывает регистр.
subscriptionId	path	True	string	Идентификатор целевой подписки.
api-version	query	True	string	Версия API, используемая для этой операции.

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

Имя	Тип	Описание
properties.groupId	string	Идентификатор группы частной конечной точки.
properties.privateEndpoint	PrivateEndpointProperty	Частная конечная точка, к которой принадлежит подключение.
properties.privateLinkServiceConnectionState	PrivateLinkServiceConnectionStateProperty	Состояние подключения подключения к частной конечной точке.
properties.provisioningState	string	Состояние подготовки частной конечной точки.

Ответы

Имя	Тип	Описание
200 OK	PrivateEndpointConnection	Успешно утверждено или отклонено подключение частной конечной точки.
202 Accepted		Принятый. Обновление подключения к частной конечной точке завершится асинхронно.
Other Status Codes	ErrorResponse	Ответ на ошибку, описывающий причину сбоя операции.

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

azure_auth

Поток OAuth2 Azure Active Directory

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

Области

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

Примеры

Approve or reject a private endpoint connection with a given name.

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

HTTP

PUT https://management.azure.com/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/rg1/providers/Microsoft.DocumentDB/databaseAccounts/ddb1/privateEndpointConnections/privateEndpointConnectionName?api-version=2024-11-15

{
  "properties": {
    "privateLinkServiceConnectionState": {
      "status": "Approved",
      "description": "Approved by johndoe@contoso.com"
    }
  }
}

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

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

{
  "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/rg1/providers/Microsoft.DocumentDb/databaseAccounts/ddb1/privateEndpointConnections/privateEndpointConnectionName",
  "name": "privateEndpointConnectionName",
  "type": "Microsoft.DocumentDb/databaseAccounts/privateEndpointConnections",
  "properties": {
    "privateEndpoint": {
      "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/rg1Network/providers/Microsoft.Network/privateEndpoints/privateEndpointName"
    },
    "privateLinkServiceConnectionState": {
      "status": "Approved",
      "description": "Auto-approved",
      "actionsRequired": "None"
    },
    "groupId": "Sql",
    "provisioningState": "Succeeded"
  }
}

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

Определения

Имя	Описание
ErrorAdditionalInfo	Дополнительные сведения об ошибке управления ресурсами.
ErrorDetail	Сведения об ошибке.
ErrorResponse	Ответ на ошибку
PrivateEndpointConnection	Подключение к частной конечной точке
PrivateEndpointProperty	Частная конечная точка, к которой принадлежит подключение.
PrivateLinkServiceConnectionStateProperty	Состояние подключения подключения к частной конечной точке.

ErrorAdditionalInfo

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

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

ErrorDetail

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

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

ErrorResponse

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

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

PrivateEndpointConnection

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

Имя	Тип	Описание
id	string	Полный идентификатор ресурса для ресурса. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
name	string	Имя ресурса
properties.groupId	string	Идентификатор группы частной конечной точки.
properties.privateEndpoint	PrivateEndpointProperty	Частная конечная точка, к которой принадлежит подключение.
properties.privateLinkServiceConnectionState	PrivateLinkServiceConnectionStateProperty	Состояние подключения подключения к частной конечной точке.
properties.provisioningState	string	Состояние подготовки частной конечной точки.
type	string	Тип ресурса. Например, "Microsoft.Compute/virtualMachines" или "Microsoft.Storage/storageAccounts"

PrivateEndpointProperty

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

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

PrivateLinkServiceConnectionStateProperty

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

Имя	Тип	Описание
actionsRequired	string	Любое действие, которое требуется за рамки базового рабочего процесса (утверждение/ отклонение или отключение)
description	string	Описание подключения службы приватного канала.
status	string	Состояние подключения службы приватного канала.

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