通过

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

Microsoft.DocumentDB databaseAccounts/privateEndpointConnections

  • 项目

Bicep 资源定义

可以使用目标操作部署 databaseAccounts/privateEndpointConnections 资源类型：

有关每个 API 版本中已更改属性的列表，请参阅 更改日志。

资源格式

若要创建 Microsoft.DocumentDB/databaseAccounts/privateEndpointConnections 资源，请将以下 Bicep 添加到模板。

resource symbolicname 'Microsoft.DocumentDB/databaseAccounts/privateEndpointConnections@2024-12-01-preview' = {
  parent: resourceSymbolicName
  name: 'string'
  properties: {
    groupId: 'string'
    privateEndpoint: {
      id: 'string'
    }
    privateLinkServiceConnectionState: {
      description: 'string'
      status: 'string'
    }
    provisioningState: 'string'
  }
}

属性值

Microsoft.DocumentDB/databaseAccounts/privateEndpointConnections

名字 描述 价值
名字 资源名称 string （必需）
父母 在 Bicep 中，可以为子资源指定父资源。 仅当子资源在父资源外部声明时，才需要添加此属性。

有关详细信息，请参阅 父资源外部的子资源。		 类型资源的符号名称：databaseAccounts
性能 资源属性。 PrivateEndpointConnectionProperties

PrivateEndpointConnectionProperties

名字 描述 价值
groupId 专用终结点的组 ID。 字符串
privateEndpoint 连接所属的专用终结点。 PrivateEndpointProperty
privateLinkServiceConnectionState 专用终结点连接的连接状态。 PrivateLinkServiceConnectionStateProperty
provisioningState 专用终结点的预配状态。 字符串

PrivateEndpointProperty

名字 描述 价值
id 专用终结点的资源 ID。 字符串

PrivateLinkServiceConnectionStateProperty

名字 描述 价值
描述 专用链接服务连接说明。 字符串
地位 专用链接服务连接状态。 字符串

ARM 模板资源定义

可以使用目标操作部署 databaseAccounts/privateEndpointConnections 资源类型：

有关每个 API 版本中已更改属性的列表，请参阅 更改日志。

资源格式

若要创建 Microsoft.DocumentDB/databaseAccounts/privateEndpointConnections 资源，请将以下 JSON 添加到模板。

{
  "type": "Microsoft.DocumentDB/databaseAccounts/privateEndpointConnections",
  "apiVersion": "2024-12-01-preview",
  "name": "string",
  "properties": {
    "groupId": "string",
    "privateEndpoint": {
      "id": "string"
    },
    "privateLinkServiceConnectionState": {
      "description": "string",
      "status": "string"
    },
    "provisioningState": "string"
  }
}

属性值

Microsoft.DocumentDB/databaseAccounts/privateEndpointConnections

名字 描述 价值
apiVersion API 版本 '2024-12-01-preview'
名字 资源名称 string （必需）
性能 资源属性。 PrivateEndpointConnectionProperties
类型 资源类型 “Microsoft.DocumentDB/databaseAccounts/privateEndpointConnections”

PrivateEndpointConnectionProperties

名字 描述 价值
groupId 专用终结点的组 ID。 字符串
privateEndpoint 连接所属的专用终结点。 PrivateEndpointProperty
privateLinkServiceConnectionState 专用终结点连接的连接状态。 PrivateLinkServiceConnectionStateProperty
provisioningState 专用终结点的预配状态。 字符串

PrivateEndpointProperty

名字 描述 价值
id 专用终结点的资源 ID。 字符串

PrivateLinkServiceConnectionStateProperty

名字 描述 价值
描述 专用链接服务连接说明。 字符串
地位 专用链接服务连接状态。 字符串

Terraform （AzAPI 提供程序）资源定义

可以使用目标操作部署 databaseAccounts/privateEndpointConnections 资源类型：

  • 资源组

有关每个 API 版本中已更改属性的列表，请参阅 更改日志。

资源格式

若要创建 Microsoft.DocumentDB/databaseAccounts/privateEndpointConnections 资源，请将以下 Terraform 添加到模板。

resource "azapi_resource" "symbolicname" {
  type = "Microsoft.DocumentDB/databaseAccounts/privateEndpointConnections@2024-12-01-preview"
  name = "string"
  body = jsonencode({
    properties = {
      groupId = "string"
      privateEndpoint = {
        id = "string"
      }
      privateLinkServiceConnectionState = {
        description = "string"
        status = "string"
      }
      provisioningState = "string"
    }
  })
}

属性值

Microsoft.DocumentDB/databaseAccounts/privateEndpointConnections

名字 描述 价值
名字 资源名称 string （必需）
parent_id 此资源的父资源的 ID。 类型资源的 ID：databaseAccounts
性能 资源属性。 PrivateEndpointConnectionProperties
类型 资源类型 “Microsoft.DocumentDB/databaseAccounts/privateEndpointConnections@2024-12-01-preview”

PrivateEndpointConnectionProperties

名字 描述 价值
groupId 专用终结点的组 ID。 字符串
privateEndpoint 连接所属的专用终结点。 PrivateEndpointProperty
privateLinkServiceConnectionState 专用终结点连接的连接状态。 PrivateLinkServiceConnectionStateProperty
provisioningState 专用终结点的预配状态。 字符串

PrivateEndpointProperty

名字 描述 价值
id 专用终结点的资源 ID。 字符串

PrivateLinkServiceConnectionStateProperty

名字 描述 价值
描述 专用链接服务连接说明。 字符串
地位 专用链接服务连接状态。 字符串