Private Endpoint Connections - Create Or Update

참조

서비스:: Cosmos DB Resource Provider

API 버전:: 2024-11-15

지정된 이름의 프라이빗 엔드포인트 연결을 승인하거나 거부합니다.

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

URI 매개 변수

Name	In(다음 안에)	필수	형식	Description
accountName	path	True	string	Cosmos DB 데이터베이스 계정 이름입니다. regex 패턴: `^[a-z0-9]+(-[a-z0-9]+)*`
privateEndpointConnectionName	path	True	string	프라이빗 엔드포인트 연결의 이름입니다.
resourceGroupName	path	True	string	리소스 그룹의 이름입니다. 이름은 대/소문자를 구분하지 않습니다.
subscriptionId	path	True	string	대상 구독의 ID입니다.
api-version	query	True	string	이 작업에 사용할 API 버전입니다.

요청 본문

Name	형식	Description
properties.groupId	string	프라이빗 엔드포인트의 그룹 ID입니다.
properties.privateEndpoint	PrivateEndpointProperty	연결이 속한 프라이빗 엔드포인트입니다.
properties.privateLinkServiceConnectionState	PrivateLinkServiceConnectionStateProperty	프라이빗 엔드포인트 연결의 연결 상태입니다.
properties.provisioningState	string	프라이빗 엔드포인트의 프로비전 상태입니다.

응답

Name	형식	Description
200 OK	PrivateEndpointConnection	프라이빗 엔드포인트 연결을 성공적으로 승인하거나 거부했습니다.
202 Accepted		허용. 프라이빗 엔드포인트 연결 업데이트가 비동기적으로 완료됩니다.
Other Status Codes	ErrorResponse	작업이 실패한 이유를 설명하는 오류 응답입니다.

보안

azure_auth

Azure Active Directory OAuth2 Flow

형식: oauth2
Flow: implicit
권한 부여 URL: https://login.microsoftonline.com/common/oauth2/authorize

범위

Name	Description
user_impersonation	사용자 계정 가장

예제

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-11-15

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

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-11-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

샘플 응답

상태 코드:: 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"
  }
}

상태 코드:: 202

정의

Name	Description
ErrorAdditionalInfo	리소스 관리 오류 추가 정보입니다.
ErrorDetail	오류 세부 정보입니다.
ErrorResponse	오류 응답
PrivateEndpointConnection	프라이빗 엔드포인트 연결
PrivateEndpointProperty	연결이 속한 프라이빗 엔드포인트입니다.
PrivateLinkServiceConnectionStateProperty	프라이빗 엔드포인트 연결의 연결 상태입니다.

ErrorAdditionalInfo

리소스 관리 오류 추가 정보입니다.

Name	형식	Description
info	object	추가 정보입니다.
type	string	추가 정보 유형입니다.

ErrorDetail

오류 세부 정보입니다.

Name	형식	Description
additionalInfo	ErrorAdditionalInfo[]	오류 추가 정보입니다.
code	string	오류 코드입니다.
details	ErrorDetail[]	오류 세부 정보입니다.
message	string	오류 메시지입니다.
target	string	오류 대상입니다.

ErrorResponse

오류 응답

Name	형식	Description
error	ErrorDetail	오류 개체입니다.

PrivateEndpointConnection

프라이빗 엔드포인트 연결

Name	형식	Description
id	string	리소스에 대한 정규화된 리소스 ID입니다. 예 - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
name	string	리소스의 이름
properties.groupId	string	프라이빗 엔드포인트의 그룹 ID입니다.
properties.privateEndpoint	PrivateEndpointProperty	연결이 속한 프라이빗 엔드포인트입니다.
properties.privateLinkServiceConnectionState	PrivateLinkServiceConnectionStateProperty	프라이빗 엔드포인트 연결의 연결 상태입니다.
properties.provisioningState	string	프라이빗 엔드포인트의 프로비전 상태입니다.
type	string	리소스의 형식입니다. 예: "Microsoft.Compute/virtualMachines" 또는 "Microsoft.Storage/storageAccounts"

PrivateEndpointProperty

연결이 속한 프라이빗 엔드포인트입니다.

Name	형식	Description
id	string	프라이빗 엔드포인트의 리소스 ID입니다.

PrivateLinkServiceConnectionStateProperty

프라이빗 엔드포인트 연결의 연결 상태입니다.

Name	형식	Description
actionsRequired	string	기본 워크플로를 넘어서 필요한 모든 작업(승인/거부/연결 끊기)
description	string	프라이빗 링크 서비스 연결 설명입니다.
status	string	프라이빗 링크 서비스 연결 상태입니다.

다음을 통해 공유