Microsoft.DBforPostgreSQL flexibleServers/administrators 2024-03-01-preview
Bicep resource definition
The flexibleServers/administrators 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/flexibleServers/administrators resource, add the following Bicep to your template.
resource symbolicname 'Microsoft.DBforPostgreSQL/flexibleServers/administrators@2024-03-01-preview' = {
parent: resourceSymbolicName
name: 'string'
properties: {
principalName: 'string'
principalType: 'string'
tenantId: 'string'
}
}
Property values
AdministratorPropertiesForAddOrAdministratorProperties
| Name | Description | Value |
|---|---|---|
| principalName | Active Directory administrator principal name. | string |
| principalType | The principal type used to represent the type of Active Directory Administrator. | 'Group' 'ServicePrincipal' 'Unknown' 'User' |
| tenantId | The tenantId of the Active Directory administrator. | string |
Microsoft.DBforPostgreSQL/flexibleServers/administrators
| 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: flexibleServers |
| properties | Properties of the active directory administrator. | AdministratorPropertiesForAddOrAdministratorProperties |
Quickstart samples
The following quickstart samples deploy this resource type.
| Bicep File | Description |
|---|---|
| Deploy Azure Database for PostgreSQL (flexible) with AAD | This template provides a way to deploy a Flexible server Azure database for PostgreSQL with AAD integration. |
ARM template resource definition
The flexibleServers/administrators 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/flexibleServers/administrators resource, add the following JSON to your template.
{
"type": "Microsoft.DBforPostgreSQL/flexibleServers/administrators",
"apiVersion": "2024-03-01-preview",
"name": "string",
"properties": {
"principalName": "string",
"principalType": "string",
"tenantId": "string"
}
}
Property values
AdministratorPropertiesForAddOrAdministratorProperties
| Name | Description | Value |
|---|---|---|
| principalName | Active Directory administrator principal name. | string |
| principalType | The principal type used to represent the type of Active Directory Administrator. | 'Group' 'ServicePrincipal' 'Unknown' 'User' |
| tenantId | The tenantId of the Active Directory administrator. | string |
Microsoft.DBforPostgreSQL/flexibleServers/administrators
| Name | Description | Value |
|---|---|---|
| apiVersion | The api version | '2024-03-01-preview' |
| name | The resource name | string (required) |
| properties | Properties of the active directory administrator. | AdministratorPropertiesForAddOrAdministratorProperties |
| type | The resource type | 'Microsoft.DBforPostgreSQL/flexibleServers/administrators' |
Quickstart templates
The following quickstart templates deploy this resource type.
| Template | Description |
|---|---|
Deploy Azure Database for PostgreSQL (flexible) with AAD |
This template provides a way to deploy a Flexible server Azure database for PostgreSQL with AAD integration. |
Terraform (AzAPI provider) resource definition
The flexibleServers/administrators 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/administrators resource, add the following Terraform to your template.
resource "azapi_resource" "symbolicname" {
type = "Microsoft.DBforPostgreSQL/flexibleServers/administrators@2024-03-01-preview"
name = "string"
body = jsonencode({
properties = {
principalName = "string"
principalType = "string"
tenantId = "string"
}
})
}
Property values
AdministratorPropertiesForAddOrAdministratorProperties
| Name | Description | Value |
|---|---|---|
| principalName | Active Directory administrator principal name. | string |
| principalType | The principal type used to represent the type of Active Directory Administrator. | 'Group' 'ServicePrincipal' 'Unknown' 'User' |
| tenantId | The tenantId of the Active Directory administrator. | string |
Microsoft.DBforPostgreSQL/flexibleServers/administrators
| 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: flexibleServers |
| properties | Properties of the active directory administrator. | AdministratorPropertiesForAddOrAdministratorProperties |
| type | The resource type | "Microsoft.DBforPostgreSQL/flexibleServers/administrators@2024-03-01-preview" |