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

Microsoft.DocumentDB databaseAccounts/privateEndpointConnections 2023-03-15-preview

Bicep 资源定义

可以使用面向以下操作部署 databaseAccounts/privateEndpointConnections 资源类型:

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

资源格式

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

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

属性值

databaseAccounts/privateEndpointConnections

名称 说明
name 资源名称

了解如何在 Bicep 中设置子资源的名称和类型。
字符串 (必需)
父级 (parent) 在 Bicep 中,可以为子资源指定父资源。 仅当子资源在父资源外部声明时,才需要添加此属性。

有关详细信息,请参阅 父资源之外的子资源
类型的资源的符号名称: databaseAccounts
properties 资源属性。 PrivateEndpointConnectionProperties

PrivateEndpointConnectionProperties

名称 说明
groupId 专用终结点的组 ID。 字符串
privateEndpoint 连接所属的专用终结点。 PrivateEndpointProperty
privateLinkServiceConnectionState 专用终结点连接的连接状态。 PrivateLinkServiceConnectionStateProperty
provisioningState 专用终结点的预配状态。 字符串

PrivateEndpointProperty

名称 说明 Value
id 专用终结点的资源 ID。 字符串

PrivateLinkServiceConnectionStateProperty

名称 说明
description 专用链接服务连接说明。 字符串
status 专用链接服务连接状态。 字符串

ARM 模板资源定义

可以使用面向以下操作部署 databaseAccounts/privateEndpointConnections 资源类型:

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

资源格式

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

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

属性值

databaseAccounts/privateEndpointConnections

名称 说明 Value
type 资源类型 'Microsoft.DocumentDB/databaseAccounts/privateEndpointConnections'
apiVersion 资源 API 版本 '2023-03-15-preview'
name 资源名称

了解如何在 JSON ARM 模板中设置子资源的名称和类型。
字符串 (必需)
properties 资源属性。 PrivateEndpointConnectionProperties

PrivateEndpointConnectionProperties

名称 说明
groupId 专用终结点的组 ID。 字符串
privateEndpoint 连接所属的专用终结点。 PrivateEndpointProperty
privateLinkServiceConnectionState 专用终结点连接的连接状态。 PrivateLinkServiceConnectionStateProperty
provisioningState 专用终结点的预配状态。 字符串

PrivateEndpointProperty

名称 说明 Value
id 专用终结点的资源 ID。 字符串

PrivateLinkServiceConnectionStateProperty

名称 说明
description 专用链接服务连接说明。 字符串
status 专用链接服务连接状态。 字符串

Terraform (AzAPI 提供程序) 资源定义

可以使用面向以下操作部署 databaseAccounts/privateEndpointConnections 资源类型:

  • 资源组

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

资源格式

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

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

属性值

databaseAccounts/privateEndpointConnections

名称 说明 Value
type 资源类型 “Microsoft.DocumentDB/databaseAccounts/privateEndpointConnections@2023-03-15-preview”
name 资源名称 字符串 (必需)
parent_id 此资源的父资源的 ID。 类型的资源的 ID: databaseAccounts
properties 资源属性。 PrivateEndpointConnectionProperties

PrivateEndpointConnectionProperties

名称 说明
groupId 专用终结点的组 ID。 字符串
privateEndpoint 连接所属的专用终结点。 PrivateEndpointProperty
privateLinkServiceConnectionState 专用终结点连接的连接状态。 PrivateLinkServiceConnectionStateProperty
provisioningState 专用终结点的预配状态。 字符串

PrivateEndpointProperty

名称 说明 Value
id 专用终结点的资源 ID。 字符串

PrivateLinkServiceConnectionStateProperty

名称 说明
description 专用链接服务连接说明。 字符串
status 专用链接服务连接状态。 字符串