Share via

Microsoft.DocumentDB databaseAccounts/privateEndpointConnections 2023-11-15

  • Article

Bicep resource definition

The databaseAccounts/privateEndpointConnections resource type can be deployed with operations that target:

For a list of changed properties in each API version, see change log.

Resource format

To create a Microsoft.DocumentDB/databaseAccounts/privateEndpointConnections resource, add the following Bicep to your template.

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

Property values

databaseAccounts/privateEndpointConnections

Name Description Value
name The resource name

See how to set names and types for child resources in Bicep.		 string (required)
parent In Bicep, you can specify the parent resource for a child resource. You only need to add this property when the child resource is declared outside of the parent resource.

For more information, see Child resource outside parent resource.		 Symbolic name for resource of type: databaseAccounts
properties Resource properties. PrivateEndpointConnectionProperties

PrivateEndpointConnectionProperties

Name Description Value
groupId Group id of the private endpoint. string
privateEndpoint Private endpoint which the connection belongs to. PrivateEndpointProperty
privateLinkServiceConnectionState Connection State of the Private Endpoint Connection. PrivateLinkServiceConnectionStateProperty
provisioningState Provisioning state of the private endpoint. string

PrivateEndpointProperty

Name Description Value
id Resource id of the private endpoint. string

PrivateLinkServiceConnectionStateProperty

Name Description Value
description The private link service connection description. string
status The private link service connection status. string

ARM template resource definition

The databaseAccounts/privateEndpointConnections resource type can be deployed with operations that target:

For a list of changed properties in each API version, see change log.

Resource format

To create a Microsoft.DocumentDB/databaseAccounts/privateEndpointConnections resource, add the following JSON to your template.

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

Property values

databaseAccounts/privateEndpointConnections

Name Description Value
type The resource type 'Microsoft.DocumentDB/databaseAccounts/privateEndpointConnections'
apiVersion The resource api version '2023-11-15'
name The resource name

See how to set names and types for child resources in JSON ARM templates.		 string (required)
properties Resource properties. PrivateEndpointConnectionProperties

PrivateEndpointConnectionProperties

Name Description Value
groupId Group id of the private endpoint. string
privateEndpoint Private endpoint which the connection belongs to. PrivateEndpointProperty
privateLinkServiceConnectionState Connection State of the Private Endpoint Connection. PrivateLinkServiceConnectionStateProperty
provisioningState Provisioning state of the private endpoint. string

PrivateEndpointProperty

Name Description Value
id Resource id of the private endpoint. string

PrivateLinkServiceConnectionStateProperty

Name Description Value
description The private link service connection description. string
status The private link service connection status. string

Terraform (AzAPI provider) resource definition

The databaseAccounts/privateEndpointConnections resource type can be deployed with operations that target:

  • Resource groups

For a list of changed properties in each API version, see change log.

Resource format

To create a Microsoft.DocumentDB/databaseAccounts/privateEndpointConnections resource, add the following Terraform to your template.

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

Property values

databaseAccounts/privateEndpointConnections

Name Description Value
type The resource type "Microsoft.DocumentDB/databaseAccounts/privateEndpointConnections@2023-11-15"
name The resource name string (required)
parent_id The ID of the resource that is the parent for this resource. ID for resource of type: databaseAccounts
properties Resource properties. PrivateEndpointConnectionProperties

PrivateEndpointConnectionProperties

Name Description Value
groupId Group id of the private endpoint. string
privateEndpoint Private endpoint which the connection belongs to. PrivateEndpointProperty
privateLinkServiceConnectionState Connection State of the Private Endpoint Connection. PrivateLinkServiceConnectionStateProperty
provisioningState Provisioning state of the private endpoint. string

PrivateEndpointProperty

Name Description Value
id Resource id of the private endpoint. string

PrivateLinkServiceConnectionStateProperty

Name Description Value
description The private link service connection description. string
status The private link service connection status. string