Private Endpoint Connections - Create Or Update

Referenz

Service:: Cosmos DB Resource Provider

API Version:: 2024-05-15

Genehmigen oder ablehnen Sie eine Verbindung mit einem privaten Endpunkt mit einem bestimmten Namen.

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

URI-Parameter

Name	In	Erforderlich	Typ	Beschreibung
accountName	path	True	string	Name des Cosmos DB-Datenbankkontos. Regex pattern: `^[a-z0-9]+(-[a-z0-9]+)*`
privateEndpointConnectionName	path	True	string	Der Name der Verbindung mit dem privaten Endpunkt.
resourceGroupName	path	True	string	Der Name der Ressourcengruppe. Für den Namen wird die Groß-/Kleinschreibung nicht beachtet.
subscriptionId	path	True	string	Hierbei handelt es sich um die ID des Zielabonnements.
api-version	query	True	string	Hierbei handelt es sich um die für diesen Vorgang zu verwendende API-Version.

Anforderungstext

Name	Typ	Beschreibung
properties.groupId	string	Gruppen-ID des privaten Endpunkts.
properties.privateEndpoint	PrivateEndpointProperty	Privater Endpunkt, zu dem die Verbindung gehört.
properties.privateLinkServiceConnectionState	PrivateLinkServiceConnectionStateProperty	Verbindungsstatus der Verbindung mit dem privaten Endpunkt.
properties.provisioningState	string	Bereitstellungsstatus des privaten Endpunkts.

Antworten

Name	Typ	Beschreibung
200 OK	PrivateEndpointConnection	Die Verbindung mit einem privaten Endpunkt wurde erfolgreich genehmigt oder abgelehnt.
202 Accepted		Akzeptiert: Das Verbindungsupdate für den privaten Endpunkt wird asynchron abgeschlossen.
Other Status Codes	ErrorResponse	Fehlerantwort mit Beschreibung des Grunds für den Fehler.

Sicherheit

azure_auth

Azure Active Directory-OAuth2-Flow

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

Scopes

Name	Beschreibung
user_impersonation	Identitätswechsel Ihres Benutzerkontos

Beispiele

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

Definitionen

Name	Beschreibung
ErrorResponse	Fehlerantwort.
PrivateEndpointConnection	Eine verbindung mit einem privaten Endpunkt
PrivateEndpointProperty	Privater Endpunkt, zu dem die Verbindung gehört.
PrivateLinkServiceConnectionStateProperty	Verbindungsstatus der Verbindung mit dem privaten Endpunkt.

ErrorResponse

Fehlerantwort.

Name	Typ	Beschreibung
code	string	Fehlercode
message	string	Eine Fehlermeldung, die angibt, warum der Vorgang fehlgeschlagen ist.

PrivateEndpointConnection

Eine verbindung mit einem privaten Endpunkt

Name	Typ	Beschreibung
id	string	Vollqualifizierte Ressourcen-ID für die Ressource. Beispiel: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
name	string	Der Name der Ressource
properties.groupId	string	Gruppen-ID des privaten Endpunkts.
properties.privateEndpoint	PrivateEndpointProperty	Privater Endpunkt, zu dem die Verbindung gehört.
properties.privateLinkServiceConnectionState	PrivateLinkServiceConnectionStateProperty	Verbindungsstatus der Verbindung mit dem privaten Endpunkt.
properties.provisioningState	string	Bereitstellungsstatus des privaten Endpunkts.
type	string	Der Typ der Ressource. Z.B. "Microsoft.Compute/virtualMachines" oder "Microsoft.Storage/storageAccounts"

PrivateEndpointProperty

Privater Endpunkt, zu dem die Verbindung gehört.

Name	Typ	Beschreibung
id	string	Ressourcen-ID des privaten Endpunkts.

PrivateLinkServiceConnectionStateProperty

Verbindungsstatus der Verbindung mit dem privaten Endpunkt.

Name	Typ	Beschreibung
actionsRequired	string	Alle Aktionen, die über den grundlegenden Workflow hinaus erforderlich sind (genehmigen/ablehnen/trennen)
description	string	Die Verbindungsbeschreibung des Private Link-Diensts.
status	string	Die Private Link-Dienstverbindung status.

Share via