Share via

Microsoft.DBforPostgreSQL flexibleServers/virtualendpoints

  • Article

Bicep resource definition

The flexibleServers/virtualendpoints 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.DBforPostgreSQL/flexibleServers/virtualendpoints resource, add the following Bicep to your template.

resource symbolicname 'Microsoft.DBforPostgreSQL/flexibleServers/virtualendpoints@2024-08-01' = {
  name: 'string'
  properties: {
    endpointType: 'string'
    members: [
      'string'
    ]
  }
}

Property values

Microsoft.DBforPostgreSQL/flexibleServers/virtualendpoints

Name Description Value
name The resource name string

Constraints:
Min length = 3
Max length = 3
Pattern = ^[A-Za-z0-9][A-Za-z0-9-]{0,62}(?<!-)$ (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: flexibleServers
properties Properties of the virtual endpoint resource. VirtualEndpointResourceProperties

VirtualEndpointResourceProperties

Name Description Value
endpointType The endpoint type for the virtual endpoint. 'ReadWrite'
members List of members for a virtual endpoint string[]

ARM template resource definition

The flexibleServers/virtualendpoints 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.DBforPostgreSQL/flexibleServers/virtualendpoints resource, add the following JSON to your template.

{
  "type": "Microsoft.DBforPostgreSQL/flexibleServers/virtualendpoints",
  "apiVersion": "2024-08-01",
  "name": "string",
  "properties": {
    "endpointType": "string",
    "members": [ "string" ]
  }
}

Property values

Microsoft.DBforPostgreSQL/flexibleServers/virtualendpoints

Name Description Value
apiVersion The api version '2024-08-01'
name The resource name string

Constraints:
Min length = 3
Max length = 3
Pattern = ^[A-Za-z0-9][A-Za-z0-9-]{0,62}(?<!-)$ (required)
properties Properties of the virtual endpoint resource. VirtualEndpointResourceProperties
type The resource type 'Microsoft.DBforPostgreSQL/flexibleServers/virtualendpoints'

VirtualEndpointResourceProperties

Name Description Value
endpointType The endpoint type for the virtual endpoint. 'ReadWrite'
members List of members for a virtual endpoint string[]

Terraform (AzAPI provider) resource definition

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

resource "azapi_resource" "symbolicname" {
  type = "Microsoft.DBforPostgreSQL/flexibleServers/virtualendpoints@2024-08-01"
  name = "string"
  body = jsonencode({
    properties = {
      endpointType = "string"
      members = [
        "string"
      ]
    }
  })
}

Property values

Microsoft.DBforPostgreSQL/flexibleServers/virtualendpoints

Name Description Value
name The resource name string

Constraints:
Min length = 3
Max length = 3
Pattern = ^[A-Za-z0-9][A-Za-z0-9-]{0,62}(?<!-)$ (required)
parent_id The ID of the resource that is the parent for this resource. ID for resource of type: flexibleServers
properties Properties of the virtual endpoint resource. VirtualEndpointResourceProperties
type The resource type "Microsoft.DBforPostgreSQL/flexibleServers/virtualendpoints@2024-08-01"

VirtualEndpointResourceProperties

Name Description Value
endpointType The endpoint type for the virtual endpoint. 'ReadWrite'
members List of members for a virtual endpoint string[]