Microsoft.DBForPostgreSql flexibleServers 2020-02-14-preview

Bicep resource definition

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

resource symbolicname 'Microsoft.DBForPostgreSql/flexibleServers@2020-02-14-preview' = {
  scope: resourceSymbolicName or scope
  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

Microsoft.DBForPostgreSql/flexibleServers

Identity

MaintenanceWindow

ServerProperties

ServerPropertiesDelegatedSubnetArguments

ServerPropertiesPrivateDnsZoneArguments

ServerPropertiesTags

Sku

StorageProfile

TrackedResourceTags

Usage Examples

Azure Verified Modules

The following Azure Verified Modules can be used to deploy this resource type.

Azure Quickstart Samples

The following Azure Quickstart templates contain Bicep samples for deploying this resource type.

ARM template resource definition

The flexibleServers 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/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

Microsoft.DBForPostgreSql/flexibleServers

Identity

MaintenanceWindow

ServerProperties

ServerPropertiesDelegatedSubnetArguments

ServerPropertiesPrivateDnsZoneArguments

ServerPropertiesTags

Sku

StorageProfile

TrackedResourceTags

Usage Examples

Azure Quickstart Templates

The following Azure 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:

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"
  parent_id = "string"
  identity {
    type = "string"
    identity_ids = [
      "string"
    ]
  }
  location = "string"
  tags = {
    {customized property} = "string"
  }
  body = {
    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"
    }
  }
}

Property Values

Microsoft.DBForPostgreSql/flexibleServers

Identity

MaintenanceWindow

ServerProperties

ServerPropertiesDelegatedSubnetArguments

ServerPropertiesPrivateDnsZoneArguments

ServerPropertiesTags

Sku

StorageProfile

TrackedResourceTags

Usage Examples

Terraform Samples

A basic example of deploying PostgreSQL Flexible Server.

terraform {
  required_providers {
    azapi = {
      source = "Azure/azapi"
    }
    azurerm = {
      source = "hashicorp/azurerm"
    }
  }
}

provider "azurerm" {
  features {
  }
}

provider "azapi" {
  skip_provider_registration = false
}

variable "resource_name" {
  type    = string
  default = "acctest0001"
}

variable "location" {
  type    = string
  default = "eastus"
}

variable "administrator_login" {
  type        = string
  description = "The administrator login name for the PostgreSQL flexible server"
}

variable "administrator_login_password" {
  type        = string
  description = "The administrator login password for the PostgreSQL flexible server"
  sensitive   = true
}

resource "azapi_resource" "resourceGroup" {
  type     = "Microsoft.Resources/resourceGroups@2020-06-01"
  name     = var.resource_name
  location = var.location
}

resource "azapi_resource" "flexibleServer" {
  type      = "Microsoft.DBforPostgreSQL/flexibleServers@2023-06-01-preview"
  parent_id = azapi_resource.resourceGroup.id
  name      = var.resource_name
  location  = var.location
  body = {
    identity = {
      type                   = "None",
      userAssignedIdentities = null
    },
    properties = {
      administratorLogin         = var.administrator_login
      administratorLoginPassword = var.administrator_login_password
      availabilityZone           = "2"
      backup = {
        geoRedundantBackup = "Disabled"
      }
      highAvailability = {
        mode = "Disabled"
      }
      network = {
      }
      storage = {
        storageSizeGB = 32
      }
      version = "12"
    }
    sku = {
      name = "Standard_D2s_v3"
      tier = "GeneralPurpose"
    }
  }
  schema_validation_enabled = false
  response_export_values    = ["*"]
}

Azure Verified Modules

The following Azure Verified Modules can be used to deploy this resource type.