Private Endpoint Connections - Create Or Update

Referensi

Service:: Cosmos DB Resource Provider

API Version:: 2024-05-15

Menyetujui atau menolak koneksi titik akhir privat dengan nama tertentu.

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

Parameter URI

Nama	Dalam	Diperlukan	Jenis	Deskripsi
accountName	path	True	string	Nama akun database Cosmos DB. Regex pattern: `^[a-z0-9]+(-[a-z0-9]+)*`
privateEndpointConnectionName	path	True	string	Nama koneksi titik akhir privat.
resourceGroupName	path	True	string	Nama grup sumber daya. Nama tidak peka huruf besar/kecil.
subscriptionId	path	True	string	ID langganan target.
api-version	query	True	string	Versi API yang digunakan untuk operasi ini.

Isi Permintaan

Nama	Jenis	Deskripsi
properties.groupId	string	Id grup titik akhir privat.
properties.privateEndpoint	PrivateEndpointProperty	Titik akhir privat tempat koneksi berada.
properties.privateLinkServiceConnectionState	PrivateLinkServiceConnectionStateProperty	Status Koneksi Koneksi Titik Akhir Privat.
properties.provisioningState	string	Status provisi titik akhir privat.

Respons

Nama	Jenis	Deskripsi
200 OK	PrivateEndpointConnection	Berhasil menyetujui atau menolak koneksi titik akhir privat.
202 Accepted		Diterima. Pembaruan koneksi titik akhir privat akan selesai secara asinkron.
Other Status Codes	ErrorResponse	Respons kesalahan yang menjelaskan mengapa operasi gagal.

Keamanan

azure_auth

Alur OAuth2 Azure Active Directory

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

Scopes

Nama	Deskripsi
user_impersonation	Meniru akun pengguna Anda

Contoh

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

Definisi

Nama	Deskripsi
ErrorResponse	Respons Kesalahan.
PrivateEndpointConnection	Koneksi titik akhir privat
PrivateEndpointProperty	Titik akhir privat tempat koneksi berada.
PrivateLinkServiceConnectionStateProperty	Status Koneksi Koneksi Titik Akhir Privat.

ErrorResponse

Respons Kesalahan.

Nama	Jenis	Deskripsi
code	string	Kode Kesalahan.
message	string	Pesan kesalahan yang menunjukkan mengapa operasi gagal.

PrivateEndpointConnection

Koneksi titik akhir privat

Nama	Jenis	Deskripsi
id	string	ID sumber daya yang sepenuhnya memenuhi syarat untuk sumber daya. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
name	string	Nama sumber daya.
properties.groupId	string	Id grup titik akhir privat.
properties.privateEndpoint	PrivateEndpointProperty	Titik akhir privat tempat koneksi berada.
properties.privateLinkServiceConnectionState	PrivateLinkServiceConnectionStateProperty	Status Koneksi Koneksi Titik Akhir Privat.
properties.provisioningState	string	Status provisi titik akhir privat.
type	string	Jenis sumber daya. Misalnya "Microsoft.Compute/virtualMachines" atau "Microsoft.Storage/storageAccounts"

PrivateEndpointProperty

Titik akhir privat tempat koneksi berada.

Nama	Jenis	Deskripsi
id	string	Id sumber daya titik akhir privat.

PrivateLinkServiceConnectionStateProperty

Status Koneksi Koneksi Titik Akhir Privat.

Nama	Jenis	Deskripsi
actionsRequired	string	Tindakan apa pun yang diperlukan di luar alur kerja dasar (setujui/tolak/putuskan sambungan)
description	string	Deskripsi koneksi layanan tautan privat.
status	string	Status koneksi layanan tautan privat.

Share via