Microsoft.DBForPostgreSql flexibleServers 2020-02-14-preview

Article
10/25/2024

Bicep resource definition

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

resource symbolicname 'Microsoft.DBForPostgreSql/flexibleServers@2020-02-14-preview' = {
  identity: {
    type: 'SystemAssigned'
  }
  location: 'string'
  name: 'string'
  properties: {
    administratorLogin: 'string'
    administratorLoginPassword: 'string'
    availabilityZone: 'string'
    createMode: 'string'
    delegatedSubnetArguments: {
      subnetArmResourceId: 'string'
    }
    displayName: 'string'
    haEnabled: 'string'
    logBackupStorageSku: 'string'
    maintenanceWindow: {
      customWindow: 'string'
      dayOfWeek: int
      startHour: int
      startMinute: int
    }
    pointInTimeUTC: 'string'
    privateDnsZoneArguments: {
      privateDnsZoneArmResourceId: 'string'
    }
    sourceResourceGroupName: 'string'
    sourceServerName: 'string'
    sourceSubscriptionId: 'string'
    standbyCount: int
    storageProfile: {
      backupRetentionDays: int
      geoRedundantBackup: 'string'
      storageMB: int
    }
    tags: {
      {customized property}: 'string'
    }
    version: 'string'
  }
  sku: {
    name: 'string'
    tier: 'string'
  }
  tags: {
    {customized property}: 'string'
  }
}

Property values

Identity

Name	Description	Value
type	The identity type.	'SystemAssigned'

MaintenanceWindow

Name	Description	Value
customWindow	indicates whether custom window is enabled or disabled	string
dayOfWeek	day of week for maintenance window	int
startHour	start hour for maintenance window	int
startMinute	start minute for maintenance window	int

Microsoft.DBForPostgreSql/flexibleServers

Name	Description	Value
identity	The Azure Active Directory identity of the server.	Identity
location	The geo-location where the resource lives	string (required)
name	The resource name	string (required)
properties	Properties of the server.	ServerProperties
sku	The SKU (pricing tier) of the server.	Sku
tags	Resource tags	Dictionary of tag names and values. See Tags in templates

ServerProperties

Name	Description	Value
administratorLogin	The administrator's login name of a server. Can only be specified when the server is being created (and is required for creation).	string
administratorLoginPassword	The administrator login password (required for server creation).	string Constraints: Sensitive value. Pass in as a secure parameter.
availabilityZone	availability Zone information of the server.	string
createMode	The mode to create a new PostgreSQL server.	'Default' 'PointInTimeRestore'
delegatedSubnetArguments		ServerPropertiesDelegatedSubnetArguments
displayName	The display name of a server.	string
haEnabled	stand by count value can be either enabled or disabled	'Disabled' 'Enabled'
logBackupStorageSku	The log backup storage sku of the server.	string
maintenanceWindow	Maintenance window of a server.	MaintenanceWindow
pointInTimeUTC	Restore point creation time (ISO8601 format), specifying the time to restore from.	string
privateDnsZoneArguments		ServerPropertiesPrivateDnsZoneArguments
sourceResourceGroupName	The resource group name of source serve PostgreSQL server name to restore from.	string
sourceServerName	The source PostgreSQL server name to restore from.	string
sourceSubscriptionId	The subscription id of source serve PostgreSQL server name to restore from.	string
standbyCount	The number of standbys.	int
storageProfile	Storage profile of a server.	StorageProfile
tags	Application-specific metadata in the form of key-value pairs.	ServerPropertiesTags
version	PostgreSQL Server version.	'11' '12'

ServerPropertiesDelegatedSubnetArguments

Name	Description	Value
subnetArmResourceId	delegated subnet arm resource id.	string

ServerPropertiesPrivateDnsZoneArguments

Name	Description	Value
privateDnsZoneArmResourceId	private dns zone arm resource id.	string

ServerPropertiesTags

Name	Description	Value

Sku

Name	Description	Value
name	The name of the sku, typically, tier + family + cores, e.g. Standard_D4s_v3.	string (required)
tier	The tier of the particular SKU, e.g. Burstable.	'Burstable' 'GeneralPurpose' 'MemoryOptimized' (required)

StorageProfile

Name	Description	Value
backupRetentionDays	Backup retention days for the server.	int
geoRedundantBackup	A value indicating whether Geo-Redundant backup is enabled on the server.	'Disabled' 'Enabled'
storageMB	Max storage allowed for a server.	int

TrackedResourceTags

Name	Description	Value

Quickstart samples

The following quickstart samples deploy this resource type.

Bicep File	Description
Create PgFlex server & enable protection via Backup Vault	Template that creates a PostgreSQL Flexible Server and enables protection via Backup Vault
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.
Deploy Azure Database for PostgreSQL (flexible) with VNet	This template provides a way to deploy a Flexible server Azure database for PostgreSQL with VNet integration.
SonarQube on Web App with PostgreSQL and VNet integration	This template provides easy to deploy SonarQube to Web App on Linux with PostgreSQL Flexible Server, VNet integration and private DNS.

ARM template resource definition

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

{
  "type": "Microsoft.DBForPostgreSql/flexibleServers",
  "apiVersion": "2020-02-14-preview",
  "name": "string",
  "identity": {
    "type": "SystemAssigned"
  },
  "location": "string",
  "properties": {
    "administratorLogin": "string",
    "administratorLoginPassword": "string",
    "availabilityZone": "string",
    "createMode": "string",
    "delegatedSubnetArguments": {
      "subnetArmResourceId": "string"
    },
    "displayName": "string",
    "haEnabled": "string",
    "logBackupStorageSku": "string",
    "maintenanceWindow": {
      "customWindow": "string",
      "dayOfWeek": "int",
      "startHour": "int",
      "startMinute": "int"
    },
    "pointInTimeUTC": "string",
    "privateDnsZoneArguments": {
      "privateDnsZoneArmResourceId": "string"
    },
    "sourceResourceGroupName": "string",
    "sourceServerName": "string",
    "sourceSubscriptionId": "string",
    "standbyCount": "int",
    "storageProfile": {
      "backupRetentionDays": "int",
      "geoRedundantBackup": "string",
      "storageMB": "int"
    },
    "tags": {
      "{customized property}": "string"
    },
    "version": "string"
  },
  "sku": {
    "name": "string",
    "tier": "string"
  },
  "tags": {
    "{customized property}": "string"
  }
}

Property values

Identity

Name	Description	Value
type	The identity type.	'SystemAssigned'

MaintenanceWindow

Name	Description	Value
customWindow	indicates whether custom window is enabled or disabled	string
dayOfWeek	day of week for maintenance window	int
startHour	start hour for maintenance window	int
startMinute	start minute for maintenance window	int

Microsoft.DBForPostgreSql/flexibleServers

Name	Description	Value
apiVersion	The api version	'2020-02-14-preview'
identity	The Azure Active Directory identity of the server.	Identity
location	The geo-location where the resource lives	string (required)
name	The resource name	string (required)
properties	Properties of the server.	ServerProperties
sku	The SKU (pricing tier) of the server.	Sku
tags	Resource tags	Dictionary of tag names and values. See Tags in templates
type	The resource type	'Microsoft.DBForPostgreSql/flexibleServers'

ServerProperties

Name	Description	Value
administratorLogin	The administrator's login name of a server. Can only be specified when the server is being created (and is required for creation).	string
administratorLoginPassword	The administrator login password (required for server creation).	string Constraints: Sensitive value. Pass in as a secure parameter.
availabilityZone	availability Zone information of the server.	string
createMode	The mode to create a new PostgreSQL server.	'Default' 'PointInTimeRestore'
delegatedSubnetArguments		ServerPropertiesDelegatedSubnetArguments
displayName	The display name of a server.	string
haEnabled	stand by count value can be either enabled or disabled	'Disabled' 'Enabled'
logBackupStorageSku	The log backup storage sku of the server.	string
maintenanceWindow	Maintenance window of a server.	MaintenanceWindow
pointInTimeUTC	Restore point creation time (ISO8601 format), specifying the time to restore from.	string
privateDnsZoneArguments		ServerPropertiesPrivateDnsZoneArguments
sourceResourceGroupName	The resource group name of source serve PostgreSQL server name to restore from.	string
sourceServerName	The source PostgreSQL server name to restore from.	string
sourceSubscriptionId	The subscription id of source serve PostgreSQL server name to restore from.	string
standbyCount	The number of standbys.	int
storageProfile	Storage profile of a server.	StorageProfile
tags	Application-specific metadata in the form of key-value pairs.	ServerPropertiesTags
version	PostgreSQL Server version.	'11' '12'

ServerPropertiesDelegatedSubnetArguments

Name	Description	Value
subnetArmResourceId	delegated subnet arm resource id.	string

ServerPropertiesPrivateDnsZoneArguments

Name	Description	Value
privateDnsZoneArmResourceId	private dns zone arm resource id.	string

ServerPropertiesTags

Name	Description	Value

Sku

Name	Description	Value
name	The name of the sku, typically, tier + family + cores, e.g. Standard_D4s_v3.	string (required)
tier	The tier of the particular SKU, e.g. Burstable.	'Burstable' 'GeneralPurpose' 'MemoryOptimized' (required)

StorageProfile

Name	Description	Value
backupRetentionDays	Backup retention days for the server.	int
geoRedundantBackup	A value indicating whether Geo-Redundant backup is enabled on the server.	'Disabled' 'Enabled'
storageMB	Max storage allowed for a server.	int

TrackedResourceTags

Name	Description	Value

Quickstart templates

The following quickstart templates deploy this resource type.

Template	Description
Create PgFlex server & enable protection via Backup Vault	Template that creates a PostgreSQL Flexible Server and enables protection via Backup Vault
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.
Deploy Azure Database for PostgreSQL (flexible) with VNet	This template provides a way to deploy a Flexible server Azure database for PostgreSQL with VNet integration.
SonarQube on Web App with PostgreSQL and VNet integration	This template provides easy to deploy SonarQube to Web App on Linux with PostgreSQL Flexible Server, VNet integration and private DNS.

Terraform (AzAPI provider) resource definition

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

resource "azapi_resource" "symbolicname" {
  type = "Microsoft.DBForPostgreSql/flexibleServers@2020-02-14-preview"
  name = "string"
  identity = {
    type = "SystemAssigned"
  }
  location = "string"
  body = jsonencode({
    properties = {
      administratorLogin = "string"
      administratorLoginPassword = "string"
      availabilityZone = "string"
      createMode = "string"
      delegatedSubnetArguments = {
        subnetArmResourceId = "string"
      }
      displayName = "string"
      haEnabled = "string"
      logBackupStorageSku = "string"
      maintenanceWindow = {
        customWindow = "string"
        dayOfWeek = int
        startHour = int
        startMinute = int
      }
      pointInTimeUTC = "string"
      privateDnsZoneArguments = {
        privateDnsZoneArmResourceId = "string"
      }
      sourceResourceGroupName = "string"
      sourceServerName = "string"
      sourceSubscriptionId = "string"
      standbyCount = int
      storageProfile = {
        backupRetentionDays = int
        geoRedundantBackup = "string"
        storageMB = int
      }
      tags = {
        {customized property} = "string"
      }
      version = "string"
    }
  })
  sku = {
    name = "string"
    tier = "string"
  }
  tags = {
    {customized property} = "string"
  }
}

Property values

Identity

Name	Description	Value
type	The identity type.	'SystemAssigned'

MaintenanceWindow

Name	Description	Value
customWindow	indicates whether custom window is enabled or disabled	string
dayOfWeek	day of week for maintenance window	int
startHour	start hour for maintenance window	int
startMinute	start minute for maintenance window	int

Microsoft.DBForPostgreSql/flexibleServers

Name	Description	Value
identity	The Azure Active Directory identity of the server.	Identity
location	The geo-location where the resource lives	string (required)
name	The resource name	string (required)
properties	Properties of the server.	ServerProperties
sku	The SKU (pricing tier) of the server.	Sku
tags	Resource tags	Dictionary of tag names and values.
type	The resource type	"Microsoft.DBForPostgreSql/flexibleServers@2020-02-14-preview"

ServerProperties

Name	Description	Value
administratorLogin	The administrator's login name of a server. Can only be specified when the server is being created (and is required for creation).	string
administratorLoginPassword	The administrator login password (required for server creation).	string Constraints: Sensitive value. Pass in as a secure parameter.
availabilityZone	availability Zone information of the server.	string
createMode	The mode to create a new PostgreSQL server.	'Default' 'PointInTimeRestore'
delegatedSubnetArguments		ServerPropertiesDelegatedSubnetArguments
displayName	The display name of a server.	string
haEnabled	stand by count value can be either enabled or disabled	'Disabled' 'Enabled'
logBackupStorageSku	The log backup storage sku of the server.	string
maintenanceWindow	Maintenance window of a server.	MaintenanceWindow
pointInTimeUTC	Restore point creation time (ISO8601 format), specifying the time to restore from.	string
privateDnsZoneArguments		ServerPropertiesPrivateDnsZoneArguments
sourceResourceGroupName	The resource group name of source serve PostgreSQL server name to restore from.	string
sourceServerName	The source PostgreSQL server name to restore from.	string
sourceSubscriptionId	The subscription id of source serve PostgreSQL server name to restore from.	string
standbyCount	The number of standbys.	int
storageProfile	Storage profile of a server.	StorageProfile
tags	Application-specific metadata in the form of key-value pairs.	ServerPropertiesTags
version	PostgreSQL Server version.	'11' '12'

ServerPropertiesDelegatedSubnetArguments

Name	Description	Value
subnetArmResourceId	delegated subnet arm resource id.	string

ServerPropertiesPrivateDnsZoneArguments

Name	Description	Value
privateDnsZoneArmResourceId	private dns zone arm resource id.	string

ServerPropertiesTags

Name	Description	Value

Sku

Name	Description	Value
name	The name of the sku, typically, tier + family + cores, e.g. Standard_D4s_v3.	string (required)
tier	The tier of the particular SKU, e.g. Burstable.	'Burstable' 'GeneralPurpose' 'MemoryOptimized' (required)

StorageProfile

Name	Description	Value
backupRetentionDays	Backup retention days for the server.	int
geoRedundantBackup	A value indicating whether Geo-Redundant backup is enabled on the server.	'Disabled' 'Enabled'
storageMB	Max storage allowed for a server.	int

TrackedResourceTags

Name	Description	Value

Share via

Microsoft.DBForPostgreSql flexibleServers 2020-02-14-preview

Bicep resource definition

Resource format

Property values

Identity

MaintenanceWindow

Microsoft.DBForPostgreSql/flexibleServers

ServerProperties

ServerPropertiesDelegatedSubnetArguments

ServerPropertiesPrivateDnsZoneArguments

ServerPropertiesTags

Sku

StorageProfile

TrackedResourceTags

Quickstart samples

ARM template resource definition

Resource format

Property values

Identity

MaintenanceWindow

Microsoft.DBForPostgreSql/flexibleServers

ServerProperties

ServerPropertiesDelegatedSubnetArguments

ServerPropertiesPrivateDnsZoneArguments

ServerPropertiesTags

Sku

StorageProfile

TrackedResourceTags

Quickstart templates

Terraform (AzAPI provider) resource definition

Resource format

Property values

Identity

MaintenanceWindow

Microsoft.DBForPostgreSql/flexibleServers

ServerProperties

ServerPropertiesDelegatedSubnetArguments

ServerPropertiesPrivateDnsZoneArguments

ServerPropertiesTags

Sku

StorageProfile

TrackedResourceTags

Feedback

Additional resources