Microsoft.DBforPostgreSQL 彈性伺服器

Bicep 資源定義

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

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

資源格式

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

resource symbolicname 'Microsoft.DBforPostgreSQL/flexibleServers@2023-03-01-preview' = {
  name: 'string'
  location: 'string'
  tags: {
    tagName1: 'tagValue1'
    tagName2: 'tagValue2'
  }
  sku: {
    name: 'string'
    tier: 'string'
  }
  identity: {
    type: 'string'
    userAssignedIdentities: {}
  }
  properties: {
    administratorLogin: 'string'
    administratorLoginPassword: 'string'
    authConfig: {
      activeDirectoryAuth: 'string'
      passwordAuth: 'string'
      tenantId: 'string'
    }
    availabilityZone: 'string'
    backup: {
      backupRetentionDays: int
      geoRedundantBackup: 'string'
    }
    createMode: 'string'
    dataEncryption: {
      geoBackupKeyURI: 'string'
      geoBackupUserAssignedIdentityId: 'string'
      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'
    replicationRole: 'string'
    sourceServerResourceId: 'string'
    storage: {
      autoGrow: 'string'
      storageSizeGB: int
      tier: 'string'
    }
    version: 'string'
  }
}

屬性值

flexibleServers

名稱 描述
NAME 資源名稱 字串 (必要)
location 資源所在的地理位置 字串 (必要)
tags 資源標籤。 標記名稱和值的字典。 請參閱 範本中的標記
sku 伺服器的 SKU (定價層) 。 Sku
身分識別 描述應用程式的身分識別。 UserAssignedIdentity
properties 伺服器的屬性。 ServerProperties

UserAssignedIdentity

名稱 描述
類型 與此資源相關聯的身分識別類型;目前限制為「無」和「UserAssigned」 'None'
'UserAssigned' (必要)
userAssignedIdentities 代表使用者指派的身分識別對應。 物件 (object)

ServerProperties

名稱 描述
administratorLogin 伺服器的系統管理員登入名稱。 只有在建立伺服器 (且建立) 時才能指定。 字串
administratorLoginPassword 伺服器建立) 所需的系統管理員登入密碼 (。 字串
authConfig 伺服器的 AuthConfig 屬性。 AuthConfig
availabilityZone 伺服器的可用性區域資訊。 字串
備份 (backup) 伺服器的備份屬性。 備份
createMode 建立新 PostgreSQL 伺服器的模式。 'Create'
'Default'
'GeoRestore'
'PointInTimeRestore'
'Replica'
'一個'一節
'Update'
dataEncryption 伺服器的數據加密屬性。 DataEncryption
highAvailability 伺服器的高可用性屬性。 HighAvailability
maintenanceWindow 伺服器的維護視窗屬性。 MaintenanceWindow
network 伺服器的網路屬性。 只有在您想要讓伺服器成為私人存取伺服器時,才需要傳遞這個 Network 屬性。 網路
pointInTimeUTC 還原點建立時間 (ISO8601 格式) ,指定要從中還原的時間。 當 'createMode' 是 'PointInTimeRestore' 或 'GeoRestore' 或 'EasingeDropped' 時,這是必要的。 字串
replicationRole 伺服器的復寫角色 'AsyncReplica'
'GeoAsyncReplica'
'None'
'Primary'
sourceServerResourceId 要從中還原的來源伺服器資源標識碼。 當 'createMode' 為 'PointInTimeRestore' 或 'GeoRestore' 或 'ReplicaeDropped' 時,這是必要的。 此屬性只會針對復本伺服器傳回 字串
儲存 伺服器的儲存屬性。 儲存體
version PostgreSQL 伺服器版本。 '11'
'12'
'13'
'14'
'15'

AuthConfig

名稱 描述
activeDirectoryAuth 如果已啟用,則會啟用 Azure Active Directory 驗證。 'Disabled'
'Enabled'
passwordAuth 如果已啟用,則會啟用密碼驗證。 'Disabled'
'Enabled'
tenantId 伺服器的租用戶標識碼。 字串

備份

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

DataEncryption

名稱 描述
geoBackupKeyURI 金鑰保存庫中金鑰的 URI,用於異地備份伺服器的數據加密。 字串
geoBackupUserAssignedIdentityId 要用於伺服器異地備份數據加密之使用者指派身分識別的資源標識碼。 字串
primaryKeyURI 金鑰保存庫中金鑰的 URI,用於主伺服器的數據加密。 字串
primaryUserAssignedIdentityId 要用於主伺服器數據加密之使用者指派身分識別的資源識別碼。 字串
type 數據加密類型,描述其是否為系統管理與 Azure Key Vault。 'AzureKeyVault'
'SystemManaged'

HighAvailability

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

MaintenanceWindow

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

網路

名稱 描述
delegatedSubnetResourceId 委派的子網 arm 資源標識符。這是在建立期間傳遞的必要條件,以防我們想要將伺服器插入 VNET,也就是私人存取伺服器。 在更新期間,只有在我們想要更新 私用 DNS 區域的值時,才傳遞此值。 字串
privateDnsZoneArmResourceId 私人 dns 區域 arm 資源識別碼。這是在建立期間傳遞的必要條件,以防我們想要將伺服器插入 VNET,也就是私人存取伺服器。 在更新期間,只有在我們想要更新 私用 DNS 區域的值時,才傳遞此值。 字串

儲存體

名稱 描述
autoGrow 啟用/停用彈性伺服器的記憶體自動成長旗標。 'Disabled'
'Enabled'
storageSizeGB 伺服器允許的最大記憶體。 int
tier IOPS 的儲存層名稱。 'P1'
'P10'
'P15'
'P2'
'P20'
'P3'
'P30'
'P4'
'P40'
'P50'
'P6'
'P60'
'P70'
'P80'

SKU

名稱 描述
NAME SKU 的名稱,通常是階層 + 系列 + 核心,例如Standard_D4s_v3。 需要字串 ()
tier 特定 SKU 的層級,例如高載。 「高載」
'GeneralPurpose'
需要 'MemoryOptimized' ()

快速入門範本

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

範本 描述
使用 AAD 部署 適用於 PostgreSQL 的 Azure 資料庫 (彈性)

部署至 Azure
此範本提供使用 AAD 整合部署適用於 PostgreSQL 的彈性伺服器 Azure 資料庫的方法。
使用 VNet 部署 適用於 PostgreSQL 的 Azure 資料庫 (彈性)

部署至 Azure
此範本提供使用 VNet 整合部署適用於 PostgreSQL 的彈性伺服器 Azure 資料庫的方法。
搭配 PostgreSQL 和 VNet 整合的 Web 應用程式 SonarQube

部署至 Azure
此範本可讓您使用 PostgreSQL 彈性伺服器、VNet 整合和私人 DNS,輕鬆地將 SonarQube 部署至 Linux 上的 Web 應用程式。

ARM 範本資源定義

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

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

資源格式

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

{
  "type": "Microsoft.DBforPostgreSQL/flexibleServers",
  "apiVersion": "2023-03-01-preview",
  "name": "string",
  "location": "string",
  "tags": {
    "tagName1": "tagValue1",
    "tagName2": "tagValue2"
  },
  "sku": {
    "name": "string",
    "tier": "string"
  },
  "identity": {
    "type": "string",
    "userAssignedIdentities": {}
  },
  "properties": {
    "administratorLogin": "string",
    "administratorLoginPassword": "string",
    "authConfig": {
      "activeDirectoryAuth": "string",
      "passwordAuth": "string",
      "tenantId": "string"
    },
    "availabilityZone": "string",
    "backup": {
      "backupRetentionDays": "int",
      "geoRedundantBackup": "string"
    },
    "createMode": "string",
    "dataEncryption": {
      "geoBackupKeyURI": "string",
      "geoBackupUserAssignedIdentityId": "string",
      "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",
    "replicationRole": "string",
    "sourceServerResourceId": "string",
    "storage": {
      "autoGrow": "string",
      "storageSizeGB": "int",
      "tier": "string"
    },
    "version": "string"
  }
}

屬性值

flexibleServers

名稱 描述
類型 資源類型 'Microsoft.DBforPostgreSQL/flexibleServers'
apiVersion 資源 API 版本 '2023-03-01-preview'
NAME 資源名稱 需要字串 ()
location 資源所在的地理位置 需要字串 ()
tags 資源標籤。 標記名稱和值的字典。 請參閱 範本中的標籤
sku SKU (伺服器) 定價層。 Sku
身分識別 描述應用程式的身分識別。 UserAssignedIdentity
properties 伺服器的屬性。 ServerProperties

UserAssignedIdentity

名稱 描述
類型 與此資源相關聯的身分識別類型;目前限制為「無」和「UserAssigned」 'None'
'UserAssigned' (必要)
userAssignedIdentities 代表使用者指派的身分識別對應。 物件 (object)

ServerProperties

名稱 描述
administratorLogin 伺服器的系統管理員登入名稱。 只有在建立伺服器 (且建立) 時才能指定。 字串
administratorLoginPassword 伺服器建立) 所需的系統管理員登入密碼 (。 字串
authConfig 伺服器的 AuthConfig 屬性。 AuthConfig
availabilityZone 伺服器的可用性區域資訊。 字串
備份 (backup) 伺服器的備份屬性。 備份
createMode 建立新 PostgreSQL 伺服器的模式。 'Create'
'Default'
'GeoRestore'
'PointInTimeRestore'
'Replica'
'一個'一節
'Update'
dataEncryption 伺服器的數據加密屬性。 DataEncryption
highAvailability 伺服器的高可用性屬性。 HighAvailability
maintenanceWindow 伺服器的維護視窗屬性。 MaintenanceWindow
network 伺服器的網路屬性。 只有在您想要讓伺服器成為私人存取伺服器時,才需要傳遞這個 Network 屬性。 網路
pointInTimeUTC 還原點建立時間 (ISO8601 格式) ,指定要從中還原的時間。 當 'createMode' 是 'PointInTimeRestore' 或 'GeoRestore' 或 'EasingeDropped' 時,這是必要的。 字串
replicationRole 伺服器的復寫角色 'AsyncReplica'
'GeoAsyncReplica'
'None'
'Primary'
sourceServerResourceId 要從中還原的來源伺服器資源標識碼。 當 'createMode' 是 'PointInTimeRestore' 或 'GeoRestore' 或 'ReplicaeDropped' 時,就是必要的。 這個屬性只會針對復本伺服器傳回 字串
儲存 伺服器的記憶體屬性。 儲存體
version PostgreSQL Server 版本。 '11'
'12'
'13'
'14'
'15'

AuthConfig

名稱 描述
activeDirectoryAuth 如果已啟用,則會啟用 Azure Active Directory 驗證。 'Disabled'
'Enabled'
passwordAuth 如果已啟用,則會啟用密碼驗證。 'Disabled'
'Enabled'
tenantId 伺服器的租用戶標識碼。 字串

備份

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

DataEncryption

名稱 描述
geoBackupKeyURI Keyvault 中密鑰的 URI,用於異地備份伺服器的數據加密。 字串
geoBackupUserAssignedIdentityId 要用於伺服器異地備份之數據加密之使用者指派身分識別的資源標識碼。 字串
primaryKeyURI 金鑰保存庫中金鑰的 URI,用於主伺服器的數據加密。 字串
primaryUserAssignedIdentityId 要用於主伺服器數據加密之使用者指派身分識別的資源識別碼。 字串
type 要描述其是否為系統管理與 Azure 金鑰保存庫的數據加密類型。 'AzureKeyVault'
'SystemManaged'

HighAvailability

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

MaintenanceWindow

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

網路

名稱 描述
delegatedSubnetResourceId 委派的子網 arm 資源標識符。這是在建立期間必須傳遞的,以防我們想要將伺服器插入 VNET,也就是私人存取伺服器。 在更新期間,只有在我們想要更新 私用 DNS 區域的值時,才傳遞此值。 字串
privateDnsZoneArmResourceId 私人 dns 區域 arm 資源識別碼。這是在建立期間必須傳遞的,以防我們想要將伺服器插入 VNET,也就是私人存取伺服器。 在更新期間,只有在我們想要更新 私用 DNS 區域的值時,才傳遞此值。 字串

儲存體

名稱 描述
autoGrow 啟用/停用彈性伺服器的記憶體自動成長旗標。 'Disabled'
'Enabled'
storageSizeGB 伺服器允許的最大記憶體。 int
tier IOPS 的儲存層名稱。 'P1'
'P10'
'P15'
'P2'
'P20'
'P3'
'P30'
'P4'
'P40'
'P50'
'P6'
'P60'
'P70'
'P80'

SKU

名稱 描述
NAME sku 的名稱,通常是層 + 系列 + 核心,例如Standard_D4s_v3。 字串 (必要)
tier 特定 SKU 的層,例如高載。 「高載」
'GeneralPurpose'
需要 'MemoryOptimized' ()

快速入門範本

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

範本 描述
使用 AAD 部署 適用於 PostgreSQL 的 Azure 資料庫 (彈性)

部署至 Azure
此範本提供使用 AAD 整合部署適用於 PostgreSQL 的彈性伺服器 Azure 資料庫的方法。
使用 VNet 部署 適用於 PostgreSQL 的 Azure 資料庫 (彈性)

部署至 Azure
此範本提供使用 VNet 整合部署適用於 PostgreSQL 的彈性伺服器 Azure 資料庫的方法。
搭配 PostgreSQL 和 VNet 整合的 Web 應用程式 SonarQube

部署至 Azure
此範本可讓您使用 PostgreSQL 彈性伺服器、VNet 整合和私人 DNS,輕鬆地將 SonarQube 部署至 Linux 上的 Web 應用程式。

Terraform (AzAPI 提供者) 資源定義

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

  • 資源群組

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

資源格式

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

resource "azapi_resource" "symbolicname" {
  type = "Microsoft.DBforPostgreSQL/flexibleServers@2023-03-01-preview"
  name = "string"
  location = "string"
  parent_id = "string"
  tags = {
    tagName1 = "tagValue1"
    tagName2 = "tagValue2"
  }
  identity {
    type =  "UserAssigned"
    identity_ids = []
  }
  body = jsonencode({
    properties = {
      administratorLogin = "string"
      administratorLoginPassword = "string"
      authConfig = {
        activeDirectoryAuth = "string"
        passwordAuth = "string"
        tenantId = "string"
      }
      availabilityZone = "string"
      backup = {
        backupRetentionDays = int
        geoRedundantBackup = "string"
      }
      createMode = "string"
      dataEncryption = {
        geoBackupKeyURI = "string"
        geoBackupUserAssignedIdentityId = "string"
        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"
      replicationRole = "string"
      sourceServerResourceId = "string"
      storage = {
        autoGrow = "string"
        storageSizeGB = int
        tier = "string"
      }
      version = "string"
    }
    sku = {
      name = "string"
      tier = "string"
    }
  })
}

屬性值

flexibleServers

名稱 描述
類型 資源類型 “Microsoft.DBforPostgreSQL/flexibleServers@2023-03-01-preview”
NAME 資源名稱 需要字串 ()
location 資源所在的地理位置 需要字串 ()
parent_id 若要部署至資源群組,請使用該資源群組的標識碼。 需要字串 ()
tags 資源標籤。 標記名稱和值的字典。
sku SKU (伺服器) 定價層。 Sku
身分識別 描述應用程式的身分識別。 UserAssignedIdentity
properties 伺服器的屬性。 ServerProperties

UserAssignedIdentity

名稱 描述
類型 與此資源相關聯的身分識別類型;目前限制為「無」和「UserAssigned」 “UserAssigned” (必要)
identity_ids 代表使用者指派的身分識別對應。 使用者身分識別標識碼的陣列。

ServerProperties

名稱 描述
administratorLogin 伺服器的系統管理員登入名稱。 只有在建立伺服器 (且建立) 時,才能指定。 字串
administratorLoginPassword 伺服器建立) 所需的系統管理員登入密碼 (。 字串
authConfig 伺服器的 AuthConfig 屬性。 AuthConfig
availabilityZone 伺服器的可用性區域資訊。 字串
備份 (backup) 伺服器的備份屬性。 備份
createMode 建立新 PostgreSQL 伺服器的模式。 「建立」
“預設值”
“GeoRestore”
“PointInTimeRestore”
“複本”
“一節”
“Update”
dataEncryption 伺服器的數據加密屬性。 DataEncryption
highAvailability 伺服器的高可用性屬性。 HighAvailability
maintenanceWindow 伺服器的維護視窗屬性。 MaintenanceWindow
network 伺服器的網路屬性。 只有在您想要讓伺服器成為私人存取伺服器時,才需要傳遞這個 Network 屬性。 網路
pointInTimeUTC 還原點建立時間 (ISO8601 格式) ,指定要還原的時間。 當 'createMode' 為 'PointInTimeRestore' 或 'GeoRestore' 或 'EasingeDropped' 時,這是必要的。 字串
replicationRole 伺服器的復寫角色 “AsyncReplica”
“GeoAsyncReplica”
"None"
“主要”
sourceServerResourceId 要從中還原的來源伺服器資源標識碼。 當 'createMode' 為 'PointInTimeRestore' 或 'GeoRestore' 或 'ReplicaeDropped' 時,這是必要的。 此屬性只會針對復本伺服器傳回 字串
儲存 伺服器的儲存屬性。 儲存體
version PostgreSQL 伺服器版本。 "11"
"12"
"13"
"14"
"15"

AuthConfig

名稱 描述
activeDirectoryAuth 如果已啟用,則會啟用 Azure Active Directory 驗證。 “Disabled”
“Enabled”
passwordAuth 如果已啟用,則會啟用密碼驗證。 “Disabled”
“Enabled”
tenantId 伺服器的租用戶標識碼。 字串

備份

名稱 描述
backupRetentionDays 伺服器的備份保留天數。 int
geoRedundantBackup 值,指出伺服器上是否啟用 Geo-Redundant 備份。 “Disabled”
“Enabled”

DataEncryption

名稱 描述
geoBackupKeyURI 金鑰保存庫中金鑰的 URI,用於異地備份伺服器的數據加密。 字串
geoBackupUserAssignedIdentityId 要用於伺服器異地備份數據加密之使用者指派身分識別的資源標識碼。 字串
primaryKeyURI 金鑰保存庫中金鑰的 URI,用於主伺服器的數據加密。 字串
primaryUserAssignedIdentityId 要用於主伺服器數據加密之使用者指派身分識別的資源識別碼。 字串
type 數據加密類型,描述其是否為系統管理與 Azure Key Vault。 “AzureKeyVault”
“SystemManaged”

HighAvailability

名稱 描述
mode 伺服器的HA模式。 “Disabled”
“SameZone”
“ZoneRedundant”
standbyAvailabilityZone 待命的可用性區域資訊。 字串

MaintenanceWindow

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

網路

名稱 描述
delegatedSubnetResourceId 委派的子網 arm 資源標識符。這是在建立期間傳遞的必要條件,以防我們想要將伺服器插入 VNET,也就是私人存取伺服器。 在更新期間,只有在我們想要更新 私用 DNS 區域的值時,才傳遞此值。 字串
privateDnsZoneArmResourceId 私人 dns 區域 arm 資源識別碼。這是在建立期間傳遞的必要條件,以防我們想要將伺服器插入 VNET,也就是私人存取伺服器。 在更新期間,只有在我們想要更新 私用 DNS 區域的值時,才傳遞此值。 字串

儲存體

名稱 描述
autoGrow 啟用/停用彈性伺服器的記憶體自動成長旗標。 “Disabled”
“Enabled”
storageSizeGB 伺服器允許的最大記憶體。 int
tier IOPS 的儲存層名稱。 “P1”
“P10”
“P15”
“P2”
“P20”
“P3”
“P30”
“P4”
“P40”
“P50”
“P6”
“P60”
“P70”
“P80”

SKU

名稱 描述
NAME SKU 的名稱,通常是階層 + 系列 + 核心,例如Standard_D4s_v3。 需要字串 ()
tier 特定 SKU 的層級,例如高載。 “高載”
“GeneralPurpose”
“MemoryOptimized” (必要)