你当前正在访问 Microsoft Azure Global Edition 技术文档网站。如果需要访问由世纪互联运营的 Microsoft Azure 中国技术文档网站，请访问 https://docs.azure.cn。

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 参数

名称	在	必需	类型	说明
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	目标订阅的 ID。
api-version	query	True	string	要用于此操作的 API 版本。

请求正文

名称	类型	说明
properties.groupId	string	专用终结点的组 ID。
properties.privateEndpoint	PrivateEndpointProperty	连接所属的专用终结点。
properties.privateLinkServiceConnectionState	PrivateLinkServiceConnectionStateProperty	专用终结点连接的连接状态。
properties.provisioningState	string	专用终结点的预配状态。

响应

名称	类型	说明
200 OK	PrivateEndpointConnection	已成功批准或拒绝专用终结点连接。
202 Accepted		已接受。专用终结点连接更新将以异步方式完成。
Other Status Codes	ErrorResponse	描述操作失败原因的错误响应。

安全性

azure_auth

Azure Active Directory OAuth2 流

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

Scopes

名称	说明
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

定义

名称	说明
ErrorResponse	错误响应。
PrivateEndpointConnection	专用终结点连接
PrivateEndpointProperty	连接所属的专用终结点。
PrivateLinkServiceConnectionStateProperty	专用终结点连接的连接状态。

ErrorResponse

错误响应。

名称	类型	说明
code	string	错误代码。
message	string	指示操作失败原因的错误消息。

PrivateEndpointConnection

专用终结点连接

名称	类型	说明
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

连接所属的专用终结点。

名称	类型	说明
id	string	专用终结点的资源 ID。

PrivateLinkServiceConnectionStateProperty

专用终结点连接的连接状态。

名称	类型	说明
actionsRequired	string	基本工作流以外的任何操作 (批准/拒绝/断开连接)
description	string	专用链接服务连接说明。
status	string	专用链接服务连接状态。

Share via