Note
Access to this page requires authorization. You can try signing in or changing directories.
Access to this page requires authorization. You can try changing directories.
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@2025-01-01-preview' = {
parent: resourceSymbolicName
name: 'string'
properties: {
principalName: 'string'
principalType: 'string'
tenantId: 'string'
}
}
Property Values
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 server administrator associated to a Microsoft Entra principal. | AdministratorPropertiesForAddOrAdministratorProperties |
AdministratorPropertiesForAddOrAdministratorProperties
| Name | Description | Value |
|---|---|---|
| principalName | Name of the Microsoft Entra principal. | string |
| principalType | The type of Microsoft Entra principal to which the server administrator is associated. | 'Group' 'ServicePrincipal' 'Unknown' 'User' |
| tenantId | Identifier of the tenant in which the Microsoft Entra principal exists. | string |
Usage Examples
Azure Quickstart Samples
The following Azure Quickstart templates contain Bicep samples for deploying 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": "2025-01-01-preview",
"name": "string",
"properties": {
"principalName": "string",
"principalType": "string",
"tenantId": "string"
}
}
Property Values
Microsoft.DBforPostgreSQL/flexibleServers/administrators
| Name | Description | Value |
|---|---|---|
| apiVersion | The api version | '2025-01-01-preview' |
| name | The resource name | string (required) |
| properties | Properties of the server administrator associated to a Microsoft Entra principal. | AdministratorPropertiesForAddOrAdministratorProperties |
| type | The resource type | 'Microsoft.DBforPostgreSQL/flexibleServers/administrators' |
AdministratorPropertiesForAddOrAdministratorProperties
| Name | Description | Value |
|---|---|---|
| principalName | Name of the Microsoft Entra principal. | string |
| principalType | The type of Microsoft Entra principal to which the server administrator is associated. | 'Group' 'ServicePrincipal' 'Unknown' 'User' |
| tenantId | Identifier of the tenant in which the Microsoft Entra principal exists. | string |
Usage Examples
Azure Quickstart Templates
The following Azure 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@2025-01-01-preview"
name = "string"
parent_id = "string"
body = {
properties = {
principalName = "string"
principalType = "string"
tenantId = "string"
}
}
}
Property Values
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 server administrator associated to a Microsoft Entra principal. | AdministratorPropertiesForAddOrAdministratorProperties |
| type | The resource type | "Microsoft.DBforPostgreSQL/flexibleServers/administrators@2025-01-01-preview" |
AdministratorPropertiesForAddOrAdministratorProperties
| Name | Description | Value |
|---|---|---|
| principalName | Name of the Microsoft Entra principal. | string |
| principalType | The type of Microsoft Entra principal to which the server administrator is associated. | 'Group' 'ServicePrincipal' 'Unknown' 'User' |
| tenantId | Identifier of the tenant in which the Microsoft Entra principal exists. | string |