Microsoft.DBforPostgreSQL flexibleServers 2022-01-20-preview

Bicep resource definition

The flexibleServers resource type can be deployed to:

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@2022-01-20-preview' = {
  name: 'string'
  location: 'string'
  tags: {
    tagName1: 'tagValue1'
    tagName2: 'tagValue2'
  }
  sku: {
    name: 'string'
    tier: 'string'
  }
  properties: {
    administratorLogin: 'string'
    administratorLoginPassword: 'string'
    availabilityZone: 'string'
    backup: {
      backupRetentionDays: int
      geoRedundantBackup: 'string'
    }
    createMode: 'string'
    highAvailability: {
      mode: 'string'
      standbyAvailabilityZone: 'string'
    }
    maintenanceWindow: {
      customWindow: 'string'
      dayOfWeek: int
      startHour: int
      startMinute: int
    }
    network: {
      delegatedSubnetResourceId: 'string'
      privateDnsZoneArmResourceId: 'string'
    }
    pointInTimeUTC: 'string'
    sourceServerResourceId: 'string'
    storage: {
      storageSizeGB: int
    }
    version: 'string'
  }
}

Property values

flexibleServers

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

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
availabilityZone availability zone information of the server. string
backup Backup properties of a server. Backup
createMode The mode to create a new PostgreSQL server. 'Create'
'Default'
'PointInTimeRestore'
'Update'
highAvailability High availability properties of a server. HighAvailability
maintenanceWindow Maintenance window properties of a server. MaintenanceWindow
network Network properties of a server. Network
pointInTimeUTC Restore point creation time (ISO8601 format), specifying the time to restore from. It's required when 'createMode' is 'PointInTimeRestore'. string
sourceServerResourceId The source server resource ID to restore from. It's required when 'createMode' is 'PointInTimeRestore'. string
storage Storage properties of a server. Storage
version PostgreSQL Server version. '11'
'12'
'13'
'14'

Backup

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'

HighAvailability

Name Description Value
mode The HA mode for the server. 'Disabled'
'SameZone'
'ZoneRedundant'
standbyAvailabilityZone availability zone information of the standby. string

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

Network

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

Storage

Name Description Value
storageSizeGB Max storage allowed for a server. int

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)

Quickstart templates

The following quickstart templates deploy this resource type.

Template Description
SonarQube on Web App with PostgreSQL and VNet integration

Deploy to Azure
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 to:

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": "2022-01-20-preview",
  "name": "string",
  "location": "string",
  "tags": {
    "tagName1": "tagValue1",
    "tagName2": "tagValue2"
  },
  "sku": {
    "name": "string",
    "tier": "string"
  },
  "properties": {
    "administratorLogin": "string",
    "administratorLoginPassword": "string",
    "availabilityZone": "string",
    "backup": {
      "backupRetentionDays": "int",
      "geoRedundantBackup": "string"
    },
    "createMode": "string",
    "highAvailability": {
      "mode": "string",
      "standbyAvailabilityZone": "string"
    },
    "maintenanceWindow": {
      "customWindow": "string",
      "dayOfWeek": "int",
      "startHour": "int",
      "startMinute": "int"
    },
    "network": {
      "delegatedSubnetResourceId": "string",
      "privateDnsZoneArmResourceId": "string"
    },
    "pointInTimeUTC": "string",
    "sourceServerResourceId": "string",
    "storage": {
      "storageSizeGB": "int"
    },
    "version": "string"
  }
}

Property values

flexibleServers

Name Description Value
type The resource type 'Microsoft.DBforPostgreSQL/flexibleServers'
apiVersion The resource api version '2022-01-20-preview'
name The resource name string (required)
location The geo-location where the resource lives string (required)
tags Resource tags. Dictionary of tag names and values. See Tags in templates
sku The SKU (pricing tier) of the server. Sku
properties Properties of the server. ServerProperties

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
availabilityZone availability zone information of the server. string
backup Backup properties of a server. Backup
createMode The mode to create a new PostgreSQL server. 'Create'
'Default'
'PointInTimeRestore'
'Update'
highAvailability High availability properties of a server. HighAvailability
maintenanceWindow Maintenance window properties of a server. MaintenanceWindow
network Network properties of a server. Network
pointInTimeUTC Restore point creation time (ISO8601 format), specifying the time to restore from. It's required when 'createMode' is 'PointInTimeRestore'. string
sourceServerResourceId The source server resource ID to restore from. It's required when 'createMode' is 'PointInTimeRestore'. string
storage Storage properties of a server. Storage
version PostgreSQL Server version. '11'
'12'
'13'
'14'

Backup

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'

HighAvailability

Name Description Value
mode The HA mode for the server. 'Disabled'
'SameZone'
'ZoneRedundant'
standbyAvailabilityZone availability zone information of the standby. string

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

Network

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

Storage

Name Description Value
storageSizeGB Max storage allowed for a server. int

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)

Quickstart templates

The following quickstart templates deploy this resource type.

Template Description
SonarQube on Web App with PostgreSQL and VNet integration

Deploy to Azure
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 to:

  • 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@2022-01-20-preview"
  name = "string"
  location = "string"
  parent_id = "string"
  tags = {
    tagName1 = "tagValue1"
    tagName2 = "tagValue2"
  }
  body = jsonencode({
    properties = {
      administratorLogin = "string"
      administratorLoginPassword = "string"
      availabilityZone = "string"
      backup = {
        backupRetentionDays = int
        geoRedundantBackup = "string"
      }
      createMode = "string"
      highAvailability = {
        mode = "string"
        standbyAvailabilityZone = "string"
      }
      maintenanceWindow = {
        customWindow = "string"
        dayOfWeek = int
        startHour = int
        startMinute = int
      }
      network = {
        delegatedSubnetResourceId = "string"
        privateDnsZoneArmResourceId = "string"
      }
      pointInTimeUTC = "string"
      sourceServerResourceId = "string"
      storage = {
        storageSizeGB = int
      }
      version = "string"
    }
    sku = {
      name = "string"
      tier = "string"
    }
  })
}

Property values

flexibleServers

Name Description Value
type The resource type "Microsoft.DBforPostgreSQL/flexibleServers@2022-01-20-preview"
name The resource name string (required)
location The geo-location where the resource lives string (required)
parent_id To deploy to a resource group, use the ID of that resource group. string (required)
tags Resource tags. Dictionary of tag names and values.
sku The SKU (pricing tier) of the server. Sku
properties Properties of the server. ServerProperties

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
availabilityZone availability zone information of the server. string
backup Backup properties of a server. Backup
createMode The mode to create a new PostgreSQL server. "Create"
"Default"
"PointInTimeRestore"
"Update"
highAvailability High availability properties of a server. HighAvailability
maintenanceWindow Maintenance window properties of a server. MaintenanceWindow
network Network properties of a server. Network
pointInTimeUTC Restore point creation time (ISO8601 format), specifying the time to restore from. It's required when 'createMode' is 'PointInTimeRestore'. string
sourceServerResourceId The source server resource ID to restore from. It's required when 'createMode' is 'PointInTimeRestore'. string
storage Storage properties of a server. Storage
version PostgreSQL Server version. "11"
"12"
"13"
"14"

Backup

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"

HighAvailability

Name Description Value
mode The HA mode for the server. "Disabled"
"SameZone"
"ZoneRedundant"
standbyAvailabilityZone availability zone information of the standby. string

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

Network

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

Storage

Name Description Value
storageSizeGB Max storage allowed for a server. int

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)