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

Private Link Resources - Get

获取需要为 Cosmos DB 帐户创建的专用链接资源。

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

URI 参数

名称 必需 类型 说明
accountName
path True

string

Cosmos DB 数据库帐户名称。

正则表达式模式: ^[a-z0-9]+(-[a-z0-9]+)*

groupName
path True

string

专用链接资源的名称。

resourceGroupName
path True

string

资源组的名称。 此名称不区分大小写。

subscriptionId
path True

string

目标订阅的 ID。

api-version
query True

string

要用于此操作的 API 版本。

响应

名称 类型 说明
200 OK

PrivateLinkResource

已成功检索指定的专用链接资源。

安全性

azure_auth

Azure Active Directory OAuth2 流

类型: oauth2
流向: implicit
授权 URL: https://login.microsoftonline.com/common/oauth2/authorize

作用域

名称 说明
user_impersonation 模拟用户帐户

示例

Gets private endpoint connection.

示例请求

GET https://management.azure.com/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/rg1/providers/Microsoft.DocumentDB/databaseAccounts/ddb1/privateLinkResources/sql?api-version=2024-05-15

示例响应

{
  "id": "subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/Default/providers/Microsoft.DocumentDb/databaseAccounts/ddb1/privateLinkResources/sql",
  "name": "sql",
  "type": "Microsoft.DocumentDB/databaseAccounts/privateLinkResources",
  "properties": {
    "groupId": "sql",
    "requiredMembers": [
      "ddb1",
      "ddb1-westus"
    ],
    "requiredZoneNames": [
      "privatelink.documents.azure.net"
    ]
  }
}

定义

PrivateLinkResource

专用链接资源

名称 类型 说明
id

string

数据库帐户的唯一资源标识符。

name

string

数据库帐户的名称。

properties.groupId

string

专用链接资源组 ID。

properties.requiredMembers

string[]

专用链接资源所需的成员名称。

properties.requiredZoneNames

string[]

专用链接资源所需的区域名称。

type

string

Azure 资源的类型。