Private Endpoint Connections - Create Or Update

Ссылка

Service:: Cosmos DB Resource Provider

API Version:: 2024-05-15

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

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

Параметры URI

Имя	В	Обязательно	Тип	Описание
accountName	path	True	string	Имя учетной записи базы данных Cosmos DB. Regex pattern: `^[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

Type: oauth2
Flow: implicit
Authorization URL: https://login.microsoftonline.com/common/oauth2/authorize

Scopes

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

Примеры

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

Sample Request

HTTP

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

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

Sample Response

Status code:: 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"
  }
}

Status code:: 202

Определения

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

ErrorResponse

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

Имя	Тип	Описание
code	string	Код ошибки.
message	string	Сообщение об ошибке, указывающее, почему операция завершилась сбоем.

PrivateEndpointConnection

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

Имя	Тип	Описание
id	string	Полный идентификатор ресурса. Пример : /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	Состояние подключения службы приватного канала.

Share via