Private Endpoint Connections - Create Or Update

Référence

Service:: Cosmos DB Resource Provider

Version d'API:: 2024-11-15

Approuver ou rejeter une connexion de point de terminaison privé avec un nom donné.

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

Paramètres URI

Nom	Dans	Obligatoire	Type	Description
accountName	path	True	string	Nom du compte de base de données Cosmos DB. Modèle d’expression régulière: `^[a-z0-9]+(-[a-z0-9]+)*`
privateEndpointConnectionName	path	True	string	Nom de la connexion de point de terminaison privé.
resourceGroupName	path	True	string	Nom du groupe de ressources. Le nom ne respecte pas la casse.
subscriptionId	path	True	string	ID de l’abonnement cible.
api-version	query	True	string	Version de l’API à utiliser pour cette opération.

Corps de la demande

Nom	Type	Description
properties.groupId	string	ID de groupe du point de terminaison privé.
properties.privateEndpoint	PrivateEndpointProperty	Point de terminaison privé auquel la connexion appartient.
properties.privateLinkServiceConnectionState	PrivateLinkServiceConnectionStateProperty	État de connexion de la connexion de point de terminaison privé.
properties.provisioningState	string	État d’approvisionnement du point de terminaison privé.

Réponses

Nom	Type	Description
200 OK	PrivateEndpointConnection	Connexion de point de terminaison privé approuvée ou rejetée avec succès.
202 Accepted		Accepté. La mise à jour de la connexion de point de terminaison privé s’effectue de manière asynchrone.
Other Status Codes	ErrorResponse	Réponse d’erreur décrivant pourquoi l’opération a échoué.

Sécurité

azure_auth

Flux OAuth2 Azure Active Directory

Type: oauth2
Flux: implicit
URL d’autorisation: https://login.microsoftonline.com/common/oauth2/authorize

Étendues

Nom	Description
user_impersonation	Emprunter l’identité de votre compte d’utilisateur

Exemples

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

Exemple de requête

HTTP

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

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

Exemple de réponse

Code d’état:: 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"
  }
}

Code d’état:: 202

Définitions

Nom	Description
ErrorAdditionalInfo	Informations supplémentaires sur l’erreur de gestion des ressources.
ErrorDetail	Détail de l’erreur.
ErrorResponse	Réponse d’erreur
PrivateEndpointConnection	Une connexion de point de terminaison privé
PrivateEndpointProperty	Point de terminaison privé auquel la connexion appartient.
PrivateLinkServiceConnectionStateProperty	État de connexion de la connexion de point de terminaison privé.

ErrorAdditionalInfo

Informations supplémentaires sur l’erreur de gestion des ressources.

Nom	Type	Description
info	object	Informations supplémentaires.
type	string	Type d’informations supplémentaire.

ErrorDetail

Détail de l’erreur.

Nom	Type	Description
additionalInfo	ErrorAdditionalInfo[]	Informations supplémentaires sur l’erreur.
code	string	Code d’erreur.
details	ErrorDetail[]	Détails de l’erreur.
message	string	Message d’erreur.
target	string	Cible d’erreur.

ErrorResponse

Réponse d’erreur

Nom	Type	Description
error	ErrorDetail	Objet d’erreur.

PrivateEndpointConnection

Une connexion de point de terminaison privé

Nom	Type	Description
id	string	ID de ressource complet pour la ressource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
name	string	Nom de la ressource
properties.groupId	string	ID de groupe du point de terminaison privé.
properties.privateEndpoint	PrivateEndpointProperty	Point de terminaison privé auquel la connexion appartient.
properties.privateLinkServiceConnectionState	PrivateLinkServiceConnectionStateProperty	État de connexion de la connexion de point de terminaison privé.
properties.provisioningState	string	État d’approvisionnement du point de terminaison privé.
type	string	Type de la ressource. Par exemple, « Microsoft.Compute/virtualMachines » ou « Microsoft.Storage/storageAccounts »

PrivateEndpointProperty

Point de terminaison privé auquel la connexion appartient.

Nom	Type	Description
id	string	ID de ressource du point de terminaison privé.

PrivateLinkServiceConnectionStateProperty

État de connexion de la connexion de point de terminaison privé.

Nom	Type	Description
actionsRequired	string	Toute action requise au-delà du flux de travail de base (approuver/rejeter/déconnecter)
description	string	Description de la connexion du service private link.
status	string	État de connexion du service de liaison privée.

Partager via