Microsoft.DBforPostgreSQL/flexibleServers 2022-03-08-preview - Bicep, ARM template & Terraform AzAPI reference

Bicep 資源定義

彈性伺服器資源類型可以使用目標作業來部署：

資源群組 - 請參閱資源群組部署命令

如需每個 API 版本中已變更屬性的清單，請參閱變更記錄檔。

資源格式

若要建立 Microsoft.DBforPostgreSQL/flexibleServers 資源，請將下列 Bicep 新增至範本。

resource symbolicname 'Microsoft.DBforPostgreSQL/flexibleServers@2022-03-08-preview' = {
  identity: {
    type: 'string'
    userAssignedIdentities: {
      {customized property}: {
        clientId: 'string'
        principalId: 'string'
      }
    }
  }
  location: 'string'
  name: 'string'
  properties: {
    administratorLogin: 'string'
    administratorLoginPassword: 'string'
    authConfig: {
      activeDirectoryAuthEnabled: bool
      passwordAuthEnabled: bool
      tenantId: 'string'
    }
    availabilityZone: 'string'
    backup: {
      backupRetentionDays: int
      geoRedundantBackup: 'string'
    }
    createMode: 'string'
    dataEncryption: {
      primaryKeyURI: 'string'
      primaryUserAssignedIdentityId: 'string'
      type: 'string'
    }
    highAvailability: {
      mode: 'string'
      standbyAvailabilityZone: 'string'
    }
    maintenanceWindow: {
      customWindow: 'string'
      dayOfWeek: int
      startHour: int
      startMinute: int
    }
    network: {
      delegatedSubnetResourceId: 'string'
      privateDnsZoneArmResourceId: 'string'
    }
    pointInTimeUTC: 'string'
    replicaCapacity: int
    replicationRole: 'string'
    sourceServerResourceId: 'string'
    storage: {
      storageSizeGB: int
    }
    version: 'string'
  }
  sku: {
    name: 'string'
    tier: 'string'
  }
  tags: {
    {customized property}: 'string'
  }
}

屬性值

AuthConfig

名字	描述	價值
activeDirectoryAuthEnabled	如果為 true，則會啟用 Azure Active Directory 驗證。	bool
passwordAuthEnabled	如果為 true，則會啟用密碼驗證。	bool
tenantId	伺服器的租用戶標識碼。	字串

備份

名字	描述	價值
backupRetentionDays	伺服器的備份保留天數。	int
geoRedundantBackup	值，指出伺服器上是否啟用 Geo-Redundant 備份。	'Disabled' 'Enabled'

DataEncryption

名字	描述	價值
primaryKeyURI	主伺服器數據加密金鑰的 URI。	字串
primaryUserAssignedIdentityId	要用於主伺服器數據加密之使用者指派身分識別的資源識別碼。	字串
類型	描述是否為系統指派與 Azure Key Vault 的數據加密類型。	'AzureKeyVault' 'SystemAssigned'

HighAvailability

名字	描述	價值
模式	伺服器的HA模式。	'Disabled' 'SameZone' 'ZoneRedundant'
standbyAvailabilityZone	待命的可用性區域資訊。	字串

MaintenanceWindow

名字	描述	價值
customWindow	指出是否啟用或停用自定義視窗	字串
dayOfWeek	維護時段的星期數	int
startHour	維護時段的開始時間	int
startMinute	維護時段的開始分鐘	int

Microsoft.DBforPostgreSQL/flexibleServers

名字	描述	價值
身份	描述應用程式的身分識別。	UserAssignedIdentity
位置	資源所在的地理位置	字串（必要）
名字	資源名稱	字串約束：最小長度 = 3 最大長度 = 3 模式 = `^[a-zA-Z0-9]+(-[a-zA-Z0-9]+)*` （必要）
性能	伺服器的屬性。	ServerProperties
sku	伺服器的 SKU（定價層）。	Sku
標籤	資源標籤	標記名稱和值的字典。請參閱範本中的標籤

網路

名字	描述	價值
delegatedSubnetResourceId	委派的子網 arm 資源標識符。	字串
privateDnsZoneArmResourceId	私人 dns 區域 arm 資源識別碼。	字串

ServerProperties

名字	描述	價值
administratorLogin	系統管理員的伺服器登入名稱。只有在建立伺服器時才能指定（而且是建立的必要專案）。	字串
administratorLoginPassword	系統管理員登入密碼（伺服器建立所需的密碼）。	字串約束：敏感性值。以安全參數的形式傳入。
authConfig	伺服器的 AuthConfig 屬性。	AuthConfig
availabilityZone	伺服器的可用性區域資訊。	字串
備份	伺服器的備份屬性。	備份
createMode	建立新 PostgreSQL 伺服器的模式。	'Create' 'Default' 'GeoRestore' 'PointInTimeRestore' 'Replica' 'Update'
dataEncryption	伺服器的數據加密屬性。	DataEncryption
highAvailability	伺服器的高可用性屬性。	HighAvailability
maintenanceWindow	伺服器的維護時段屬性。	MaintenanceWindow
網路	伺服器的網路屬性。	Network
pointInTimeUTC	還原點建立時間（ISO8601格式），指定要還原的時間。當 'createMode' 是 'PointInTimeRestore' 或 'GeoRestore' 時，這是必要的。	字串
replicaCapacity	伺服器允許的複本。	int
replicationRole	伺服器的復寫角色	'AsyncReplica' 'GeoAsyncReplica' 'None' 'Primary'
sourceServerResourceId	要從中還原的來源伺服器資源標識碼。當 'createMode' 是 'PointInTimeRestore' 或 'GeoRestore' 或 'Replica' 時，這是必要的。	字串
存儲	伺服器的儲存屬性。	Storage
版本	PostgreSQL Server 版本。	'11' '12' '13' '14'

Sku

名字	描述	價值
名字	sku 的名稱，通常是階層 + 系列 + 核心，例如Standard_D4s_v3。	字串（必要）
層	特定 SKU 的層級，例如高載。	「高載」 'GeneralPurpose' 'MemoryOptimized' （必要）

存儲

名字	描述	價值
storageSizeGB	伺服器允許的最大記憶體。	int

TrackedResourceTags

名字	描述	價值

UserAssignedIdentity

名字	描述	價值
類型	與此資源相關聯的身分識別類型;目前僅限於 'SystemAssigned 和 UserAssigned'	'None' 'SystemAssigned' 'UserAssigned' （必要）
userAssignedIdentities	代表使用者指派的身分識別對應。	UserAssignedIdentityMap

UserAssignedIdentityMap

名字	描述	價值

UserIdentity

名字	描述	價值
clientId	此身分識別所代表之服務主體的用戶端標識碼。	字串
principalId	此身分識別所代表之服務主體的物件標識碼。	字串

快速入門範例

下列快速入門範例會部署此資源類型。

Bicep 檔案	描述
建立 PgFlex 伺服器 & 透過 Backup Vault 啟用保護	建立PostgreSQL彈性伺服器的範本，並透過備份保存庫啟用保護
使用 AAD 部署適用於 PostgreSQL 的 Azure 資料庫（彈性）	此範本提供一種方式來部署彈性伺服器適用於 PostgreSQL 的 Azure 資料庫與 AAD 整合。
使用 VNet 部署適用於 PostgreSQL 的 Azure 資料庫（彈性）	此範本提供一種方式來部署彈性伺服器適用於 PostgreSQL 的 Azure 資料庫與 VNet 整合。
具有 PostgreSQL 和 VNet 整合的 Web 應用程式上的 SonarQube	此範本可讓您使用 PostgreSQL 彈性伺服器、VNet 整合和私人 DNS，輕鬆地將 SonarQube 部署至 Linux 上的 Web 應用程式。

ARM 樣本資源定義

彈性伺服器資源類型可以使用目標作業來部署：

資源群組 - 請參閱資源群組部署命令

如需每個 API 版本中已變更屬性的清單，請參閱變更記錄檔。

資源格式

若要建立 Microsoft.DBforPostgreSQL/flexibleServers 資源，請將下列 JSON 新增至範本。

{
  "type": "Microsoft.DBforPostgreSQL/flexibleServers",
  "apiVersion": "2022-03-08-preview",
  "name": "string",
  "identity": {
    "type": "string",
    "userAssignedIdentities": {
      "{customized property}": {
        "clientId": "string",
        "principalId": "string"
      }
    }
  },
  "location": "string",
  "properties": {
    "administratorLogin": "string",
    "administratorLoginPassword": "string",
    "authConfig": {
      "activeDirectoryAuthEnabled": "bool",
      "passwordAuthEnabled": "bool",
      "tenantId": "string"
    },
    "availabilityZone": "string",
    "backup": {
      "backupRetentionDays": "int",
      "geoRedundantBackup": "string"
    },
    "createMode": "string",
    "dataEncryption": {
      "primaryKeyURI": "string",
      "primaryUserAssignedIdentityId": "string",
      "type": "string"
    },
    "highAvailability": {
      "mode": "string",
      "standbyAvailabilityZone": "string"
    },
    "maintenanceWindow": {
      "customWindow": "string",
      "dayOfWeek": "int",
      "startHour": "int",
      "startMinute": "int"
    },
    "network": {
      "delegatedSubnetResourceId": "string",
      "privateDnsZoneArmResourceId": "string"
    },
    "pointInTimeUTC": "string",
    "replicaCapacity": "int",
    "replicationRole": "string",
    "sourceServerResourceId": "string",
    "storage": {
      "storageSizeGB": "int"
    },
    "version": "string"
  },
  "sku": {
    "name": "string",
    "tier": "string"
  },
  "tags": {
    "{customized property}": "string"
  }
}

屬性值

AuthConfig

名字	描述	價值
activeDirectoryAuthEnabled	如果為 true，則會啟用 Azure Active Directory 驗證。	bool
passwordAuthEnabled	如果為 true，則會啟用密碼驗證。	bool
tenantId	伺服器的租用戶標識碼。	字串

備份

名字	描述	價值
backupRetentionDays	伺服器的備份保留天數。	int
geoRedundantBackup	值，指出伺服器上是否啟用 Geo-Redundant 備份。	'Disabled' 'Enabled'

DataEncryption

名字	描述	價值
primaryKeyURI	主伺服器數據加密金鑰的 URI。	字串
primaryUserAssignedIdentityId	要用於主伺服器數據加密之使用者指派身分識別的資源識別碼。	字串
類型	描述是否為系統指派與 Azure Key Vault 的數據加密類型。	'AzureKeyVault' 'SystemAssigned'

HighAvailability

名字	描述	價值
模式	伺服器的HA模式。	'Disabled' 'SameZone' 'ZoneRedundant'
standbyAvailabilityZone	待命的可用性區域資訊。	字串

MaintenanceWindow

名字	描述	價值
customWindow	指出是否啟用或停用自定義視窗	字串
dayOfWeek	維護時段的星期數	int
startHour	維護時段的開始時間	int
startMinute	維護時段的開始分鐘	int

Microsoft.DBforPostgreSQL/flexibleServers

名字	描述	價值
apiVersion	API 版本	'2022-03-08-preview'
身份	描述應用程式的身分識別。	UserAssignedIdentity
位置	資源所在的地理位置	字串（必要）
名字	資源名稱	字串約束：最小長度 = 3 最大長度 = 3 模式 = `^[a-zA-Z0-9]+(-[a-zA-Z0-9]+)*` （必要）
性能	伺服器的屬性。	ServerProperties
sku	伺服器的 SKU（定價層）。	Sku
標籤	資源標籤	標記名稱和值的字典。請參閱範本中的標籤
類型	資源類型	'Microsoft.DBforPostgreSQL/flexibleServers'

網路

名字	描述	價值
delegatedSubnetResourceId	委派的子網 arm 資源標識符。	字串
privateDnsZoneArmResourceId	私人 dns 區域 arm 資源識別碼。	字串

ServerProperties

名字	描述	價值
administratorLogin	系統管理員的伺服器登入名稱。只有在建立伺服器時才能指定（而且是建立的必要專案）。	字串
administratorLoginPassword	系統管理員登入密碼（伺服器建立所需的密碼）。	字串約束：敏感性值。以安全參數的形式傳入。
authConfig	伺服器的 AuthConfig 屬性。	AuthConfig
availabilityZone	伺服器的可用性區域資訊。	字串
備份	伺服器的備份屬性。	備份
createMode	建立新 PostgreSQL 伺服器的模式。	'Create' 'Default' 'GeoRestore' 'PointInTimeRestore' 'Replica' 'Update'
dataEncryption	伺服器的數據加密屬性。	DataEncryption
highAvailability	伺服器的高可用性屬性。	HighAvailability
maintenanceWindow	伺服器的維護時段屬性。	MaintenanceWindow
網路	伺服器的網路屬性。	Network
pointInTimeUTC	還原點建立時間（ISO8601格式），指定要還原的時間。當 'createMode' 是 'PointInTimeRestore' 或 'GeoRestore' 時，這是必要的。	字串
replicaCapacity	伺服器允許的複本。	int
replicationRole	伺服器的復寫角色	'AsyncReplica' 'GeoAsyncReplica' 'None' 'Primary'
sourceServerResourceId	要從中還原的來源伺服器資源標識碼。當 'createMode' 是 'PointInTimeRestore' 或 'GeoRestore' 或 'Replica' 時，這是必要的。	字串
存儲	伺服器的儲存屬性。	Storage
版本	PostgreSQL Server 版本。	'11' '12' '13' '14'

Sku

名字	描述	價值
名字	sku 的名稱，通常是階層 + 系列 + 核心，例如Standard_D4s_v3。	字串（必要）
層	特定 SKU 的層級，例如高載。	「高載」 'GeneralPurpose' 'MemoryOptimized' （必要）

存儲

名字	描述	價值
storageSizeGB	伺服器允許的最大記憶體。	int

TrackedResourceTags

名字	描述	價值

UserAssignedIdentity

名字	描述	價值
類型	與此資源相關聯的身分識別類型;目前僅限於 'SystemAssigned 和 UserAssigned'	'None' 'SystemAssigned' 'UserAssigned' （必要）
userAssignedIdentities	代表使用者指派的身分識別對應。	UserAssignedIdentityMap

UserAssignedIdentityMap

名字	描述	價值

UserIdentity

名字	描述	價值
clientId	此身分識別所代表之服務主體的用戶端標識碼。	字串
principalId	此身分識別所代表之服務主體的物件標識碼。	字串

快速入門範本

下列快速入門範本會部署此資源類型。

範本	描述
建立 PgFlex 伺服器 & 透過 Backup Vault 啟用保護	建立PostgreSQL彈性伺服器的範本，並透過備份保存庫啟用保護
使用 AAD 部署適用於 PostgreSQL 的 Azure 資料庫（彈性）	此範本提供一種方式來部署彈性伺服器適用於 PostgreSQL 的 Azure 資料庫與 AAD 整合。
使用 VNet 部署適用於 PostgreSQL 的 Azure 資料庫（彈性）	此範本提供一種方式來部署彈性伺服器適用於 PostgreSQL 的 Azure 資料庫與 VNet 整合。
具有 PostgreSQL 和 VNet 整合的 Web 應用程式上的 SonarQube	此範本可讓您使用 PostgreSQL 彈性伺服器、VNet 整合和私人 DNS，輕鬆地將 SonarQube 部署至 Linux 上的 Web 應用程式。

Terraform （AzAPI 提供者）資源定義

彈性伺服器資源類型可以使用目標作業來部署：

資源群組

如需每個 API 版本中已變更屬性的清單，請參閱變更記錄檔。

資源格式

若要建立 Microsoft.DBforPostgreSQL/flexibleServers 資源，請將下列 Terraform 新增至範本。

resource "azapi_resource" "symbolicname" {
  type = "Microsoft.DBforPostgreSQL/flexibleServers@2022-03-08-preview"
  name = "string"
  identity = {
    type = "string"
    userAssignedIdentities = {
      {customized property} = {
        clientId = "string"
        principalId = "string"
      }
    }
  }
  location = "string"
  sku = {
    name = "string"
    tier = "string"
  }
  tags = {
    {customized property} = "string"
  }
  body = jsonencode({
    properties = {
      administratorLogin = "string"
      administratorLoginPassword = "string"
      authConfig = {
        activeDirectoryAuthEnabled = bool
        passwordAuthEnabled = bool
        tenantId = "string"
      }
      availabilityZone = "string"
      backup = {
        backupRetentionDays = int
        geoRedundantBackup = "string"
      }
      createMode = "string"
      dataEncryption = {
        primaryKeyURI = "string"
        primaryUserAssignedIdentityId = "string"
        type = "string"
      }
      highAvailability = {
        mode = "string"
        standbyAvailabilityZone = "string"
      }
      maintenanceWindow = {
        customWindow = "string"
        dayOfWeek = int
        startHour = int
        startMinute = int
      }
      network = {
        delegatedSubnetResourceId = "string"
        privateDnsZoneArmResourceId = "string"
      }
      pointInTimeUTC = "string"
      replicaCapacity = int
      replicationRole = "string"
      sourceServerResourceId = "string"
      storage = {
        storageSizeGB = int
      }
      version = "string"
    }
  })
}

屬性值

AuthConfig

名字	描述	價值
activeDirectoryAuthEnabled	如果為 true，則會啟用 Azure Active Directory 驗證。	bool
passwordAuthEnabled	如果為 true，則會啟用密碼驗證。	bool
tenantId	伺服器的租用戶標識碼。	字串

備份

名字	描述	價值
backupRetentionDays	伺服器的備份保留天數。	int
geoRedundantBackup	值，指出伺服器上是否啟用 Geo-Redundant 備份。	'Disabled' 'Enabled'

DataEncryption

名字	描述	價值
primaryKeyURI	主伺服器數據加密金鑰的 URI。	字串
primaryUserAssignedIdentityId	要用於主伺服器數據加密之使用者指派身分識別的資源識別碼。	字串
類型	描述是否為系統指派與 Azure Key Vault 的數據加密類型。	'AzureKeyVault' 'SystemAssigned'

HighAvailability

名字	描述	價值
模式	伺服器的HA模式。	'Disabled' 'SameZone' 'ZoneRedundant'
standbyAvailabilityZone	待命的可用性區域資訊。	字串

MaintenanceWindow

名字	描述	價值
customWindow	指出是否啟用或停用自定義視窗	字串
dayOfWeek	維護時段的星期數	int
startHour	維護時段的開始時間	int
startMinute	維護時段的開始分鐘	int

Microsoft.DBforPostgreSQL/flexibleServers

名字	描述	價值
身份	描述應用程式的身分識別。	UserAssignedIdentity
位置	資源所在的地理位置	字串（必要）
名字	資源名稱	字串約束：最小長度 = 3 最大長度 = 3 模式 = `^[a-zA-Z0-9]+(-[a-zA-Z0-9]+)*` （必要）
性能	伺服器的屬性。	ServerProperties
sku	伺服器的 SKU（定價層）。	Sku
標籤	資源標籤	標記名稱和值的字典。
類型	資源類型	“Microsoft.DBforPostgreSQL/flexibleServers@2022-03-08-preview”

網路

名字	描述	價值
delegatedSubnetResourceId	委派的子網 arm 資源標識符。	字串
privateDnsZoneArmResourceId	私人 dns 區域 arm 資源識別碼。	字串

ServerProperties

名字	描述	價值
administratorLogin	系統管理員的伺服器登入名稱。只有在建立伺服器時才能指定（而且是建立的必要專案）。	字串
administratorLoginPassword	系統管理員登入密碼（伺服器建立所需的密碼）。	字串約束：敏感性值。以安全參數的形式傳入。
authConfig	伺服器的 AuthConfig 屬性。	AuthConfig
availabilityZone	伺服器的可用性區域資訊。	字串
備份	伺服器的備份屬性。	備份
createMode	建立新 PostgreSQL 伺服器的模式。	'Create' 'Default' 'GeoRestore' 'PointInTimeRestore' 'Replica' 'Update'
dataEncryption	伺服器的數據加密屬性。	DataEncryption
highAvailability	伺服器的高可用性屬性。	HighAvailability
maintenanceWindow	伺服器的維護時段屬性。	MaintenanceWindow
網路	伺服器的網路屬性。	Network
pointInTimeUTC	還原點建立時間（ISO8601格式），指定要還原的時間。當 'createMode' 是 'PointInTimeRestore' 或 'GeoRestore' 時，這是必要的。	字串
replicaCapacity	伺服器允許的複本。	int
replicationRole	伺服器的復寫角色	'AsyncReplica' 'GeoAsyncReplica' 'None' 'Primary'
sourceServerResourceId	要從中還原的來源伺服器資源標識碼。當 'createMode' 是 'PointInTimeRestore' 或 'GeoRestore' 或 'Replica' 時，這是必要的。	字串
存儲	伺服器的儲存屬性。	Storage
版本	PostgreSQL Server 版本。	'11' '12' '13' '14'

Sku

名字	描述	價值
名字	sku 的名稱，通常是階層 + 系列 + 核心，例如Standard_D4s_v3。	字串（必要）
層	特定 SKU 的層級，例如高載。	「高載」 'GeneralPurpose' 'MemoryOptimized' （必要）

存儲

名字	描述	價值
storageSizeGB	伺服器允許的最大記憶體。	int

TrackedResourceTags

名字	描述	價值

UserAssignedIdentity

名字	描述	價值
類型	與此資源相關聯的身分識別類型;目前僅限於 'SystemAssigned 和 UserAssigned'	'None' 'SystemAssigned' 'UserAssigned' （必要）
userAssignedIdentities	代表使用者指派的身分識別對應。	UserAssignedIdentityMap

UserAssignedIdentityMap

名字	描述	價值

UserIdentity

名字	描述	價值
clientId	此身分識別所代表之服務主體的用戶端標識碼。	字串
principalId	此身分識別所代表之服務主體的物件標識碼。	字串

共用方式為

Microsoft.DBforPostgreSQL 彈性Servers 2022-03-08-preview

Bicep 資源定義

資源格式

屬性值

AuthConfig

備份

DataEncryption

HighAvailability

MaintenanceWindow

Microsoft.DBforPostgreSQL/flexibleServers

網路

ServerProperties

Sku

存儲

TrackedResourceTags

UserAssignedIdentity

UserAssignedIdentityMap

UserIdentity

快速入門範例

ARM 樣本資源定義

資源格式

屬性值

AuthConfig

備份

DataEncryption

HighAvailability

MaintenanceWindow

Microsoft.DBforPostgreSQL/flexibleServers

網路

ServerProperties

Sku

存儲

TrackedResourceTags

UserAssignedIdentity

UserAssignedIdentityMap

UserIdentity

快速入門範本

Terraform （AzAPI 提供者） 資源定義

資源格式

屬性值

AuthConfig

備份

DataEncryption

HighAvailability

MaintenanceWindow

Microsoft.DBforPostgreSQL/flexibleServers

網路

ServerProperties

Sku

存儲

TrackedResourceTags

UserAssignedIdentity

UserAssignedIdentityMap

UserIdentity

意見反應

其他資源

Terraform （AzAPI 提供者）資源定義