Private Endpoint Connections - Create Or Update

Servizio:
Cosmos DB Resource Provider
Versione API:
2026-03-15

Approvare o rifiutare una connessione endpoint privato con un nome specificato.

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

Parametri dell'URI

Nome In Necessario Tipo Descrizione
accountName
 path True

string

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

Nome dell'account del database Cosmos DB.
privateEndpointConnectionName
 path True

string

Nome della connessione dell'endpoint privato.
resourceGroupName
 path True

string

minLength: 1
maxLength: 90

Nome del gruppo di risorse. Il nome è insensibile alle maiuscole e minuscole.
subscriptionId
 path True

string (uuid)

ID della sottoscrizione di destinazione. Il valore deve essere un UUID.
api-version
 query True

string

minLength: 1

Versione dell'API da usare per questa operazione.

Corpo della richiesta

Nome Tipo Descrizione
properties.groupId

string

ID gruppo dell'endpoint privato.
properties.privateEndpoint

PrivateEndpointProperty

Endpoint privato a cui appartiene la connessione.
properties.privateLinkServiceConnectionState

PrivateLinkServiceConnectionStateProperty

Stato della connessione dell'endpoint privato.
properties.provisioningState

string

Stato di provisioning dell'endpoint privato.

Risposte

Nome Tipo Descrizione
200 OK

PrivateEndpointConnection

L'operazione di aggiornamento della risorsa 'PrivateEndpointConnection' è riuscita
202 Accepted

Operazione sulle risorse accettata.

Intestazioni

  • Location: string
  • Retry-After: integer
Other Status Codes

ErrorResponse

Risposta di errore imprevista.

Sicurezza

azure_auth

Flusso OAuth2 di Azure Active Directory.

Tipo: oauth2
Flow: implicit
URL di autorizzazione: https://login.microsoftonline.com/common/oauth2/authorize

Ambiti

Nome Descrizione
user_impersonation impersonare il tuo account utente

Esempio

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

Esempio di richiesta

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

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

Risposta di esempio

Codice di stato:
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"
  }
}
Codice di stato:
202 
Azure-AsyncOperation: https://management.azure.com/subscriptions/{subscriptionId}/providers/Microsoft.DocumentDB/locations/{location}/operationsStatus/{operationId}?api-version=2026-03-15
Location: https://management.azure.com/subscriptions/{subscriptionId}/providers/Microsoft.DocumentDB/locations/{location}/operationResults/{operationId}?api-version=2026-03-15

Definizioni

Nome Descrizione
createdByType

Tipo di identità che ha creato la risorsa.
ErrorResponse

Risposta di errore.
PrivateEndpointConnection

Una connessione endpoint privato
PrivateEndpointProperty

Endpoint privato a cui appartiene la connessione.
PrivateLinkServiceConnectionStateProperty

Stato della connessione dell'endpoint privato.
systemData

Metadati relativi alla creazione e all'ultima modifica della risorsa.

createdByType

Enumerazione

Tipo di identità che ha creato la risorsa.

Valore Descrizione
User
Application
ManagedIdentity
Key

ErrorResponse

Oggetto

Risposta di errore.

Nome Tipo Descrizione
code

string

Codice di errore.
message

string

Messaggio di errore che indica il motivo per cui l'operazione non è riuscita.

PrivateEndpointConnection

Oggetto

Una connessione endpoint privato

Nome Tipo Descrizione
id

string (arm-id)

Identificatore di risorsa completamente qualificato per la risorsa. Ad esempio, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
name

string

nome della risorsa.
properties.groupId

string

ID gruppo dell'endpoint privato.
properties.privateEndpoint

PrivateEndpointProperty

Endpoint privato a cui appartiene la connessione.
properties.privateLinkServiceConnectionState

PrivateLinkServiceConnectionStateProperty

Stato della connessione dell'endpoint privato.
properties.provisioningState

string

Stato di provisioning dell'endpoint privato.
systemData

systemData

Metadati di Azure Resource Manager contenenti le informazioni createdBy e modifiedBy.
type

string

Tipo di risorsa. Ad esempio, "Microsoft.Compute/virtualMachines" o "Microsoft.Storage/storageAccounts"

PrivateEndpointProperty

Oggetto

Endpoint privato a cui appartiene la connessione.

Nome Tipo Descrizione
id

string

ID risorsa dell'endpoint privato.

PrivateLinkServiceConnectionStateProperty

Oggetto

Stato della connessione dell'endpoint privato.

Nome Tipo Descrizione
actionsRequired

string

Qualsiasi azione necessaria oltre il flusso di lavoro di base (approvazione/rifiuto/disconnessione)
description

string

Descrizione della connessione al servizio di collegamento privato.
status

string

Stato della connessione al servizio collegamento privato.

systemData

Oggetto

Metadati relativi alla creazione e all'ultima modifica della risorsa.

Nome Tipo Descrizione
createdAt

string (date-time)

Timestamp della creazione della risorsa (UTC).
createdBy

string

Identità che ha creato la risorsa.
createdByType

createdByType

Tipo di identità che ha creato la risorsa.
lastModifiedAt

string (date-time)

Timestamp dell'ultima modifica della risorsa (UTC)
lastModifiedBy

string

Identità che ha modificato l'ultima volta la risorsa.
lastModifiedByType

createdByType

Tipo di identità che ha modificato l'ultima volta la risorsa.