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

Private Endpoint Connections - Create Or Update

  • Ссылка
Служба:
Cosmos DB Resource Provider
Версия API:
2025-04-15

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

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

Параметры URI

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

string

minLength: 3
maxLength: 50
pattern: ^[a-z0-9]+(-[a-z0-9]+)*

Имя учетной записи базы данных Cosmos DB.
privateEndpointConnectionName
 path True

string

Имя подключения частной конечной точки.
resourceGroupName
 path True

string

minLength: 1
maxLength: 90

Имя группы ресурсов. Имя не зависит от регистра.
subscriptionId
 path True

string

minLength: 1

Идентификатор целевой подписки.
api-version
 query True

string

minLength: 1

Версия API, используемая для данной операции.

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

Имя Тип Описание
properties.groupId

string

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

PrivateEndpointProperty

Private endpoint which the connection belongs to.
properties.privateLinkServiceConnectionState

PrivateLinkServiceConnectionStateProperty

Connection State of the Private Endpoint Connection.
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.

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

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

{
  "properties": {
    "privateLinkServiceConnectionState": {
      "status": "Approved",
      "description": "Approved by [email protected]"
    }
  }
}

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

Код состояния:
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

Private endpoint which the connection belongs to.
PrivateLinkServiceConnectionStateProperty

Connection State of the Private Endpoint Connection.

ErrorAdditionalInfo

Object

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

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

object

Дополнительные сведения.
type

string

Дополнительный тип сведений.

ErrorDetail

Object

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

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

ErrorAdditionalInfo[]

Дополнительные сведения об ошибке.
code

string

Код ошибки.
details

ErrorDetail[]

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

string

Сообщение об ошибке.
target

string

Целевой объект ошибки.

ErrorResponse

Object

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

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

ErrorDetail

Объект ошибки.

PrivateEndpointConnection

Object

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

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

string

Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
name

string

The name of the resource
properties.groupId

string

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

PrivateEndpointProperty

Private endpoint which the connection belongs to.
properties.privateLinkServiceConnectionState

PrivateLinkServiceConnectionStateProperty

Connection State of the Private Endpoint Connection.
properties.provisioningState

string

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

string

Тип ресурса. Например, "Microsoft.Compute/virtualMachines" или "Microsoft.Storage/storageAccounts"

PrivateEndpointProperty

Object

Private endpoint which the connection belongs to.

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

string

Resource id of the private endpoint.

PrivateLinkServiceConnectionStateProperty

Object

Connection State of the Private Endpoint Connection.

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

string

Любое действие, которое требуется за рамки базового рабочего процесса (утверждение/ отклонение или отключение)
description

string

The private link service connection description.
status

string

The private link service connection status.