Private Endpoint Connections - Create Or Update

Référence

Service:: Cosmos DB Resource Provider

API Version:: 2024-05-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-05-15

Paramètres URI

Nom	Dans	Obligatoire	Type	Description
accountName	path	True	string	Nom du compte de base de données Cosmos DB. Regex pattern: `^[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 appartient la connexion.
properties.privateLinkServiceConnectionState	PrivateLinkServiceConnectionStateProperty	État de la 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é se termine de manière asynchrone.
Other Status Codes	ErrorResponse	Réponse d’erreur décrivant la raison de l’échec de l’opération.

Sécurité

azure_auth

Flux OAuth2 Azure Active Directory

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

Scopes

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

Exemples

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=2024-05-15

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

from typing import Any, IO, Union

from azure.identity import DefaultAzureCredential

from azure.mgmt.cosmosdb import CosmosDBManagementClient

"""
# PREREQUISITES
    pip install azure-identity
    pip install azure-mgmt-cosmosdb
# USAGE
    python cosmos_db_private_endpoint_connection_update.py

    Before run the sample, please set the values of the client ID, tenant ID and client secret
    of the AAD application as environment variables: AZURE_CLIENT_ID, AZURE_TENANT_ID,
    AZURE_CLIENT_SECRET. For more info about how to get the value, please see:
    https://docs.microsoft.com/azure/active-directory/develop/howto-create-service-principal-portal
"""


def main():
    client = CosmosDBManagementClient(
        credential=DefaultAzureCredential(),
        subscription_id="00000000-1111-2222-3333-444444444444",
    )

    response = client.private_endpoint_connections.begin_create_or_update(
        resource_group_name="rg1",
        account_name="ddb1",
        private_endpoint_connection_name="privateEndpointConnectionName",
        parameters={
            "properties": {
                "privateLinkServiceConnectionState": {
                    "description": "Approved by johndoe@contoso.com",
                    "status": "Approved",
                }
            }
        },
    ).result()
    print(response)


# x-ms-original-file: specification/cosmos-db/resource-manager/Microsoft.DocumentDB/stable/2024-05-15/examples/CosmosDBPrivateEndpointConnectionUpdate.json
if __name__ == "__main__":
    main()

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

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

Définitions

Nom	Description
ErrorResponse	Réponse d’erreur.
PrivateEndpointConnection	Une connexion de point de terminaison privé
PrivateEndpointProperty	Point de terminaison privé auquel appartient la connexion.
PrivateLinkServiceConnectionStateProperty	État de la connexion de la connexion de point de terminaison privé.

ErrorResponse

Réponse d’erreur.

Nom	Type	Description
code	string	Code d’erreur.
message	string	Message d’erreur indiquant la raison de l’échec de l’opération.

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 appartient la connexion.
properties.privateLinkServiceConnectionState	PrivateLinkServiceConnectionStateProperty	État de la 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 appartient la connexion.

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

PrivateLinkServiceConnectionStateProperty

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

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

Partager via