Share via

Microsoft.DBforPostgreSQL serverGroupsv2/roles

  • Article

Bicep resource definition

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

resource symbolicname 'Microsoft.DBforPostgreSQL/serverGroupsv2/roles@2023-03-02-preview' = {
  name: 'string'
  properties: {
    externalIdentity: {
      objectId: 'string'
      principalType: 'string'
      tenantId: 'string'
    }
    password: 'string'
    roleType: 'string'
  }
}

Property values

Microsoft.DBforPostgreSQL/serverGroupsv2/roles

Name Description Value
name The resource name string

Constraints:
Pattern = ^[-\w\._]+$ (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: serverGroupsv2
properties The properties of a role. RoleProperties (required)

RoleProperties

Name Description Value
externalIdentity RolePropertiesExternalIdentity
password The password of the cluster role. If an identity is used, password will not be required. string

Constraints:
Sensitive value. Pass in as a secure parameter.
roleType 'admin'
'user'

RolePropertiesExternalIdentity

Name Description Value
objectId string (required)
principalType 'group'
'servicePrincipal'
'user' (required)
tenantId string

ARM template resource definition

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

{
  "type": "Microsoft.DBforPostgreSQL/serverGroupsv2/roles",
  "apiVersion": "2023-03-02-preview",
  "name": "string",
  "properties": {
    "externalIdentity": {
      "objectId": "string",
      "principalType": "string",
      "tenantId": "string"
    },
    "password": "string",
    "roleType": "string"
  }
}

Property values

Microsoft.DBforPostgreSQL/serverGroupsv2/roles

Name Description Value
apiVersion The api version '2023-03-02-preview'
name The resource name string

Constraints:
Pattern = ^[-\w\._]+$ (required)
properties The properties of a role. RoleProperties (required)
type The resource type 'Microsoft.DBforPostgreSQL/serverGroupsv2/roles'

RoleProperties

Name Description Value
externalIdentity RolePropertiesExternalIdentity
password The password of the cluster role. If an identity is used, password will not be required. string

Constraints:
Sensitive value. Pass in as a secure parameter.
roleType 'admin'
'user'

RolePropertiesExternalIdentity

Name Description Value
objectId string (required)
principalType 'group'
'servicePrincipal'
'user' (required)
tenantId string

Terraform (AzAPI provider) resource definition

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

resource "azapi_resource" "symbolicname" {
  type = "Microsoft.DBforPostgreSQL/serverGroupsv2/roles@2023-03-02-preview"
  name = "string"
  body = jsonencode({
    properties = {
      externalIdentity = {
        objectId = "string"
        principalType = "string"
        tenantId = "string"
      }
      password = "string"
      roleType = "string"
    }
  })
}

Property values

Microsoft.DBforPostgreSQL/serverGroupsv2/roles

Name Description Value
name The resource name string

Constraints:
Pattern = ^[-\w\._]+$ (required)
parent_id The ID of the resource that is the parent for this resource. ID for resource of type: serverGroupsv2
properties The properties of a role. RoleProperties (required)
type The resource type "Microsoft.DBforPostgreSQL/serverGroupsv2/roles@2023-03-02-preview"

RoleProperties

Name Description Value
externalIdentity RolePropertiesExternalIdentity
password The password of the cluster role. If an identity is used, password will not be required. string

Constraints:
Sensitive value. Pass in as a secure parameter.
roleType 'admin'
'user'

RolePropertiesExternalIdentity

Name Description Value
objectId string (required)
principalType 'group'
'servicePrincipal'
'user' (required)
tenantId string