Private Endpoint Connections - Create Or Update

參考

Service:: Cosmos DB Resource Provider

API Version:: 2024-05-15

核准或拒絕具有指定名稱的私人端點連線。

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

URI 參數

名稱	位於	必要	類型	Description
accountName	path	True	string	Cosmos DB 資料庫帳戶名稱。 Regex pattern: `^[a-z0-9]+(-[a-z0-9]+)*`
privateEndpointConnectionName	path	True	string	私人端點連線的名稱。
resourceGroupName	path	True	string	資源群組的名稱。名稱不區分大小寫。
subscriptionId	path	True	string	目標訂用帳戶的標識碼。
api-version	query	True	string	用於此作業的 API 版本。

要求本文

名稱	類型	Description
properties.groupId	string	私人端點的群組標識碼。
properties.privateEndpoint	PrivateEndpointProperty	線上所屬的私人端點。
properties.privateLinkServiceConnectionState	PrivateLinkServiceConnectionStateProperty	私人端點連線的連線狀態。
properties.provisioningState	string	私人端點的布建狀態。

回應

名稱	類型	Description
200 OK	PrivateEndpointConnection	已成功核准或拒絕私人端點連線。
202 Accepted		已接受。私人端點連線更新會以異步方式完成。
Other Status Codes	ErrorResponse	描述作業失敗原因的錯誤回應。

安全性

azure_auth

Azure Active Directory OAuth2 Flow

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

Scopes

名稱	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-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

定義

名稱	Description
ErrorResponse	錯誤回應。
PrivateEndpointConnection	私人端點連線
PrivateEndpointProperty	線上所屬的私人端點。
PrivateLinkServiceConnectionStateProperty	私人端點連線的連線狀態。

ErrorResponse

錯誤回應。

名稱	類型	Description
code	string	錯誤碼。
message	string	指出作業失敗原因的錯誤訊息。

PrivateEndpointConnection

私人端點連線

名稱	類型	Description
id	string	資源的完整資源識別碼。 Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
name	string	資源的名稱
properties.groupId	string	私人端點的群組標識碼。
properties.privateEndpoint	PrivateEndpointProperty	線上所屬的私人端點。
properties.privateLinkServiceConnectionState	PrivateLinkServiceConnectionStateProperty	私人端點連線的連線狀態。
properties.provisioningState	string	私人端點的布建狀態。
type	string	資源類型。例如“Microsoft.Compute/virtualMachines” 或 “Microsoft.Storage/storageAccounts”

PrivateEndpointProperty

線上所屬的私人端點。

名稱	類型	Description
id	string	私人端點的資源標識碼。

PrivateLinkServiceConnectionStateProperty

私人端點連線的連線狀態。

名稱	類型	Description
actionsRequired	string	除了基本工作流程以外的任何動作， (核准/拒絕/中斷聯機)
description	string	私人鏈接服務連線描述。
status	string	私人鏈接服務連線狀態。

共用方式為