Microsoft.DBforPostgreSQL servers

  • Artikel
  • 4 menit untuk membaca

The servers resource type can be deployed to: Resource groups.

To learn about resource group deployments, see Bicep or ARM template.

For a list of changed properties in each API version, see change log.

Template format

To create a Microsoft.DBforPostgreSQL/servers resource, add the following Bicep or JSON to your template.

resource symbolicname 'Microsoft.DBforPostgreSQL/servers@2017-12-01' = {
  name: 'string'
  location: 'string'
  tags: {
    tagName1: 'tagValue1'
    tagName2: 'tagValue2'
  }
  sku: {
    capacity: int
    family: 'string'
    name: 'string'
    size: 'string'
    tier: 'string'
  }
  identity: {
    type: 'SystemAssigned'
  }
  properties: {
    infrastructureEncryption: 'string'
    minimalTlsVersion: 'string'
    publicNetworkAccess: 'string'
    sslEnforcement: 'string'
    storageProfile: {
      backupRetentionDays: int
      geoRedundantBackup: 'string'
      storageAutogrow: 'string'
      storageMB: int
    }
    version: 'string'
    createMode: 'string'
    // For remaining properties, see ServerPropertiesForCreateOrServerProperties objects
  }
}

ServerPropertiesForCreateOrServerProperties objects

Set the createMode property to specify the type of object.

For Default, use:

  createMode: 'Default'
  administratorLogin: 'string'
  administratorLoginPassword: 'string'

For GeoRestore, use:

  createMode: 'GeoRestore'
  sourceServerId: 'string'

For PointInTimeRestore, use:

  createMode: 'PointInTimeRestore'
  restorePointInTime: 'string'
  sourceServerId: 'string'

For Replica, use:

  createMode: 'Replica'
  sourceServerId: 'string'

Property values

servers

Name Description Value
type The resource type

For Bicep, set this value in the resource declaration.		 'Microsoft.DBforPostgreSQL/servers'
apiVersion The resource api version

For Bicep, set this value in the resource declaration.		 '2017-12-01'
name The resource name string (required)

Character limit: 3-63

Valid characters:
Lowercase letters, hyphens and numbers.

Can't start or end with hyphen.

Resource name must be unique across Azure.
location The location the resource resides in. string (required)
tags Application-specific metadata in the form of key-value pairs. Dictionary of tag names and values. See Tags in templates
sku The SKU (pricing tier) of the server. Sku
identity The Azure Active Directory identity of the server. ResourceIdentity
properties Properties of the server. ServerPropertiesForCreateOrServerProperties (required)

ResourceIdentity

Name Description Value
type The identity type. Set this to 'SystemAssigned' in order to automatically create and assign an Azure Active Directory principal for the resource. 'SystemAssigned'

ServerPropertiesForCreateOrServerProperties

Name Description Value
infrastructureEncryption Status showing whether the server enabled infrastructure encryption. 'Disabled'
'Enabled'
minimalTlsVersion Enforce a minimal Tls version for the server. 'TLS1_0'
'TLS1_1'
'TLS1_2'
'TLSEnforcementDisabled'
publicNetworkAccess Whether or not public network access is allowed for this server. Value is optional but if passed in, must be 'Enabled' or 'Disabled' 'Disabled'
'Enabled'
sslEnforcement Enable ssl enforcement or not when connect to server. 'Disabled'
'Enabled'
storageProfile Storage profile of a server. StorageProfile
version Server version. '10'
'10.0'
'10.2'
'11'
'9.5'
'9.6'
createMode Set the object type Default
GeoRestore
PointInTimeRestore
Replica

StorageProfile

Name Description Value
backupRetentionDays Backup retention days for the server. int
geoRedundantBackup Enable Geo-redundant or not for server backup. 'Disabled'
'Enabled'
storageAutogrow Enable Storage Auto Grow. 'Disabled'
'Enabled'
storageMB Max storage allowed for a server. int

ServerPropertiesForDefaultCreate

Name Description Value
createMode The mode to create a new server. 'Default'
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 (required)
administratorLoginPassword The password of the administrator login. string (required)

ServerPropertiesForGeoRestore

Name Description Value
createMode The mode to create a new server. 'GeoRestore'
sourceServerId The source server id to restore from. string (required)

ServerPropertiesForRestore

Name Description Value
createMode The mode to create a new server. 'PointInTimeRestore'
restorePointInTime Restore point creation time (ISO8601 format), specifying the time to restore from. string (required)
sourceServerId The source server id to restore from. string (required)

ServerPropertiesForReplica

Name Description Value
createMode The mode to create a new server. 'Replica'
sourceServerId The primary server id to create replica from. string (required)

Sku

Name Description Value
capacity The scale up/out capacity, representing server's compute units. int
family The family of hardware. string
name The name of the sku, typically, tier + family + cores, e.g. B_Gen4_1, GP_Gen5_8. string (required)
size The size code, to be interpreted by resource as appropriate. string
tier The tier of the particular SKU, e.g. Basic. 'Basic'
'GeneralPurpose'
'MemoryOptimized'

Quickstart templates

The following quickstart templates deploy this resource type.

Template Description
Airflow Web App with PostgreSQL database on App Services

Deploy to Azure		 A template for deploying Airflow Web App with PostgreSQL database on App Services
Buffalo Web App

Deploy to Azure		 Start running your Golang Buffalo Application on Azure quickly and cheaply.
Deploy Azure Database for PostgreSQL with VNet

Deploy to Azure		 This template provides a way to deploy an Azure database for PostgreSQL with VNet integration.
Airflow Docker Web App on Linux with PostgreSQL

Deploy to Azure		 This template provides a easy way to deploy a puckel/docker-airflow image (latest tag) on a Linux Web App with Azure database for PostgreSQL
Web App on Linux with PostgreSQL

Deploy to Azure		 This template provides a easy way to deploy Web App on Linux with Azure database for PostgreSQL(Preview).
Sonarqube Docker Web App on Linux with PostgreSQL

Deploy to Azure		 This template provides a easy way to deploy a Sonarqube docker image (alpine tag) on a Linux Web App with Azure database for PostgreSQL(Preview)
Web App on Linux with PostgreSQL

Deploy to Azure		 This template provides a easy way to deploy Web App on Linux with Azure database for PostgreSQL.