Private Endpoint Connections - Create Or Update

Odwołanie

Service:: Cosmos DB Resource Provider

API Version:: 2024-05-15

Zatwierdź lub odrzuć połączenie prywatnego punktu końcowego z daną nazwą.

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

Parametry identyfikatora URI

Nazwa	W	Wymagane	Typ	Opis
accountName	path	True	string	Nazwa konta bazy danych usługi Cosmos DB. Regex pattern: `^[a-z0-9]+(-[a-z0-9]+)*`
privateEndpointConnectionName	path	True	string	Nazwa połączenia prywatnego punktu końcowego.
resourceGroupName	path	True	string	Nazwa grupy zasobów. W nazwie jest uwzględniana wielkość liter.
subscriptionId	path	True	string	Identyfikator subskrypcji docelowej.
api-version	query	True	string	Wersja interfejsu API do użycia dla tej operacji.

Treść żądania

Nazwa	Typ	Opis
properties.groupId	string	Identyfikator grupy prywatnego punktu końcowego.
properties.privateEndpoint	PrivateEndpointProperty	Prywatny punkt końcowy, do którego należy połączenie.
properties.privateLinkServiceConnectionState	PrivateLinkServiceConnectionStateProperty	Stan połączenia prywatnego punktu końcowego.
properties.provisioningState	string	Stan aprowizacji prywatnego punktu końcowego.

Odpowiedzi

Nazwa	Typ	Opis
200 OK	PrivateEndpointConnection	Pomyślnie zatwierdzono lub odrzucono połączenie prywatnego punktu końcowego.
202 Accepted		Akceptowane. Aktualizacja połączenia prywatnego punktu końcowego zostanie ukończona asynchronicznie.
Other Status Codes	ErrorResponse	Odpowiedź na błąd opisująca, dlaczego operacja nie powiodła się.

Zabezpieczenia

azure_auth

Przepływ OAuth2 usługi Azure Active Directory

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

Scopes

Nazwa	Opis
user_impersonation	Personifikuj konto użytkownika

Przykłady

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

Definicje

Nazwa	Opis
ErrorResponse	Odpowiedź na błąd.
PrivateEndpointConnection	Połączenie prywatnego punktu końcowego
PrivateEndpointProperty	Prywatny punkt końcowy, do którego należy połączenie.
PrivateLinkServiceConnectionStateProperty	Stan połączenia prywatnego punktu końcowego.

ErrorResponse

Odpowiedź na błąd.

Nazwa	Typ	Opis
code	string	Kod błędu.
message	string	Komunikat o błędzie wskazujący, dlaczego operacja nie powiodła się.

PrivateEndpointConnection

Połączenie prywatnego punktu końcowego

Nazwa	Typ	Opis
id	string	W pełni kwalifikowany identyfikator zasobu dla zasobu. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
name	string	Nazwa zasobu
properties.groupId	string	Identyfikator grupy prywatnego punktu końcowego.
properties.privateEndpoint	PrivateEndpointProperty	Prywatny punkt końcowy, do którego należy połączenie.
properties.privateLinkServiceConnectionState	PrivateLinkServiceConnectionStateProperty	Stan połączenia prywatnego punktu końcowego.
properties.provisioningState	string	Stan aprowizacji prywatnego punktu końcowego.
type	string	Typ zasobu. Np. "Microsoft.Compute/virtualMachines" lub "Microsoft.Storage/storageAccounts"

PrivateEndpointProperty

Prywatny punkt końcowy, do którego należy połączenie.

Nazwa	Typ	Opis
id	string	Identyfikator zasobu prywatnego punktu końcowego.

PrivateLinkServiceConnectionStateProperty

Stan połączenia prywatnego punktu końcowego.

Nazwa	Typ	Opis
actionsRequired	string	Każda akcja wymagana poza podstawowym przepływem pracy (zatwierdzanie/odrzucanie/rozłączanie)
description	string	Opis połączenia usługi private link.
status	string	Stan połączenia usługi private link.

Share via