Microsoft.DBforPostgreSQL servers/privateEndpointConnections 2018-06-01

• Latest
• 2018-06-01

Bicep resource definition

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

• Resource groups - See resource group deployment commands

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

Resource format

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

resource symbolicname 'Microsoft.DBforPostgreSQL/servers/privateEndpointConnections@2018-06-01' = {
  name: 'string'
  properties: {
    privateEndpoint: {
      id: 'string'
    }
    privateLinkServiceConnectionState: {
      description: 'string'
      status: 'string'
    }
  }
}

Property values

Microsoft.DBforPostgreSQL/servers/privateEndpointConnections

Name	Description	Value
name	The resource name	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: servers
properties	Resource properties.	PrivateEndpointConnectionProperties

PrivateEndpointConnectionProperties

Name	Description	Value
privateEndpoint	Private endpoint which the connection belongs to.	PrivateEndpointProperty
privateLinkServiceConnectionState	Connection state of the private endpoint connection.	PrivateLinkServiceConnectionStateProperty

PrivateEndpointProperty

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

PrivateLinkServiceConnectionStateProperty

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

ARM template resource definition

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

• Resource groups - See resource group deployment commands

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

Resource format

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

{
  "type": "Microsoft.DBforPostgreSQL/servers/privateEndpointConnections",
  "apiVersion": "2018-06-01",
  "name": "string",
  "properties": {
    "privateEndpoint": {
      "id": "string"
    },
    "privateLinkServiceConnectionState": {
      "description": "string",
      "status": "string"
    }
  }
}

Property values

Microsoft.DBforPostgreSQL/servers/privateEndpointConnections

Name	Description	Value
apiVersion	The api version	'2018-06-01'
name	The resource name	string (required)
properties	Resource properties.	PrivateEndpointConnectionProperties
type	The resource type	'Microsoft.DBforPostgreSQL/servers/privateEndpointConnections'

PrivateEndpointConnectionProperties

Name	Description	Value
privateEndpoint	Private endpoint which the connection belongs to.	PrivateEndpointProperty
privateLinkServiceConnectionState	Connection state of the private endpoint connection.	PrivateLinkServiceConnectionStateProperty

PrivateEndpointProperty

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

PrivateLinkServiceConnectionStateProperty

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

Terraform (AzAPI provider) resource definition

The servers/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.DBforPostgreSQL/servers/privateEndpointConnections resource, add the following Terraform to your template.

resource "azapi_resource" "symbolicname" {
  type = "Microsoft.DBforPostgreSQL/servers/privateEndpointConnections@2018-06-01"
  name = "string"
  body = jsonencode({
    properties = {
      privateEndpoint = {
        id = "string"
      }
      privateLinkServiceConnectionState = {
        description = "string"
        status = "string"
      }
    }
  })
}

Property values

Microsoft.DBforPostgreSQL/servers/privateEndpointConnections

Name	Description	Value
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: servers
properties	Resource properties.	PrivateEndpointConnectionProperties
type	The resource type	"Microsoft.DBforPostgreSQL/servers/privateEndpointConnections@2018-06-01"

PrivateEndpointConnectionProperties

Name	Description	Value
privateEndpoint	Private endpoint which the connection belongs to.	PrivateEndpointProperty
privateLinkServiceConnectionState	Connection state of the private endpoint connection.	PrivateLinkServiceConnectionStateProperty

PrivateEndpointProperty

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

PrivateLinkServiceConnectionStateProperty

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