你当前正在访问 Microsoft Azure Global Edition 技术文档网站。如果需要访问由世纪互联运营的 Microsoft Azure 中国技术文档网站，请访问 https://docs.azure.cn。

Microsoft.DBforPostgreSQL 服务器

项目
10/26/2024

Bicep 资源定义

可以使用目标操作部署服务器资源类型：

资源组 - 请参阅资源组部署命令

有关每个 API 版本中已更改属性的列表，请参阅更改日志。

资源格式

若要创建 Microsoft.DBforPostgreSQL/servers 资源，请将以下 Bicep 添加到模板。

resource symbolicname 'Microsoft.DBforPostgreSQL/servers@2017-12-01' = {
  identity: {
    type: 'string'
  }
  location: 'string'
  name: 'string'
  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
  }
  sku: {
    capacity: int
    family: 'string'
    name: 'string'
    size: 'string'
    tier: 'string'
  }
  tags: {
    {customized property}: 'string'
  }
}

ServerPropertiesForCreateOrServerProperties 对象

设置 createMode 属性以指定对象的类型。

对于默认，请使用：

{
  administratorLogin: 'string'
  administratorLoginPassword: 'string'
  createMode: 'Default'
}

对于 GeoRestore，请使用：

{
  createMode: 'GeoRestore'
  sourceServerId: 'string'
}

对于 pointInTimeRestore，请使用：

{
  createMode: 'PointInTimeRestore'
  restorePointInTime: 'string'
  sourceServerId: 'string'
}

对于副本，请使用：

{
  createMode: 'Replica'
  sourceServerId: 'string'
}

属性值

Microsoft.DBforPostgreSQL/servers

名字	描述	价值
身份	服务器的 Azure Active Directory 标识。	ResourceIdentity
位置	资源所在的位置。	string （必需）
名字	资源名称	string （必需）
性能	服务器的属性。	ServerPropertiesForCreateOrServerProperties （必需）
sku	服务器的 SKU（定价层）。	Sku
标签	资源标记	标记名称和值的字典。请参阅模板中的标记

ResourceIdentity

名字	描述	价值
类型	标识类型。将此设置为“SystemAssigned”，以便自动为资源创建和分配 Azure Active Directory 主体。	“SystemAssigned”

ServerForCreateTags

名字	描述	价值

ServerPropertiesForCreateOrServerProperties

名字	描述	价值
createMode	对于 ServerPropertiesForDefaultCreate，设置为“Default”。对于 ServerPropertiesForGeoRestore，请设置为“GeoRestore”。对于 ServerPropertiesForRestore，请设置为“PointInTimeRestore”。对于 ServerPropertiesForReplica，请设置为“Replica”。	“Default” “GeoRestore” “PointInTimeRestore” “Replica”（必需）
infrastructureEncryption	显示服务器是否启用基础结构加密的状态。	“Disabled” “Enabled”
minimalTlsVersion	为服务器强制实施最低 Tls 版本。	“TLS1_0” “TLS1_1” “TLS1_2” “TLSEnforcementDisabled”
publicNetworkAccess	是否允许此服务器访问公用网络。值是可选的，但如果传入，则必须为“Enabled”或“Disabled”	“Disabled” “Enabled”
sslEnforcement	在连接到服务器时启用 ssl 强制。	“Disabled” “Enabled”
storageProfile	服务器的存储配置文件。	StorageProfile
版本	服务器版本。	'10' '10.0' '10.2' '11' '9.5' '9.6'

ServerPropertiesForDefaultCreate

名字	描述	价值
administratorLogin	管理员的服务器登录名。只能在创建服务器时指定（并且是创建所必需的）。	string （必需）
administratorLoginPassword	管理员登录名的密码。	字符串约束：敏感值。以安全参数的形式传入。（必需）
createMode	创建新服务器的模式。	“Default”（必需）

ServerPropertiesForGeoRestore

名字	描述	价值
createMode	创建新服务器的模式。	“GeoRestore”（必需）
sourceServerId	要从中还原的源服务器 ID。	string （必需）

ServerPropertiesForReplica

名字	描述	价值
createMode	创建新服务器的模式。	“Replica”（必需）
sourceServerId	要从中创建副本的主服务器 ID。	string （必需）

ServerPropertiesForRestore

名字	描述	价值
createMode	创建新服务器的模式。	“PointInTimeRestore”（必需）
restorePointInTime	还原点创建时间（ISO8601格式），指定要从中还原的时间。	string （必需）
sourceServerId	要从中还原的源服务器 ID。	string （必需）

Sku

名字	描述	价值
能力	纵向扩展/横向扩展容量，表示服务器的计算单位。	int 约束：最小值 = 0
家庭	硬件系列。	字符串
名字	sku 的名称（通常为层 + 系列 + 核心），例如B_Gen4_1，GP_Gen5_8。	string （必需）
大小	要适当地由资源解释的大小代码。	字符串
层	特定 SKU 的层，例如基本层。	“Basic” “GeneralPurpose” “MemoryOptimized”

StorageProfile

名字	描述	价值
backupRetentionDays	服务器的备份保留日。	int
geoRedundantBackup	为服务器备份启用异地冗余或不启用。	“Disabled” “Enabled”
storageAutogrow	启用存储自动增长。	“Disabled” “Enabled”
storageMB	服务器允许的最大存储。	int

快速入门示例

以下快速入门示例部署此资源类型。

Bicep 文件	描述
使用 VNet 部署 Azure Database for PostgreSQL	此模板提供部署 Azure Database for PostgreSQL 与 VNet 集成的方法。
在 Linux 上使用 PostgreSQL Sonarqube Docker Web 应用	此模板提供了使用 Azure Database for PostgreSQL 在 Linux Web 应用上部署 Sonarqube docker 映像（alpine tag）的简单方法（预览版）

ARM 模板资源定义

可以使用目标操作部署服务器资源类型：

资源组 - 请参阅资源组部署命令

有关每个 API 版本中已更改属性的列表，请参阅更改日志。

资源格式

若要创建 Microsoft.DBforPostgreSQL/servers 资源，请将以下 JSON 添加到模板。

{
  "type": "Microsoft.DBforPostgreSQL/servers",
  "apiVersion": "2017-12-01",
  "name": "string",
  "identity": {
    "type": "string"
  },
  "location": "string",
  "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
  },
  "sku": {
    "capacity": "int",
    "family": "string",
    "name": "string",
    "size": "string",
    "tier": "string"
  },
  "tags": {
    "{customized property}": "string"
  }
}

ServerPropertiesForCreateOrServerProperties 对象

设置 createMode 属性以指定对象的类型。

对于默认，请使用：

{
  "administratorLogin": "string",
  "administratorLoginPassword": "string",
  "createMode": "Default"
}

对于 GeoRestore，请使用：

{
  "createMode": "GeoRestore",
  "sourceServerId": "string"
}

对于 pointInTimeRestore，请使用：

{
  "createMode": "PointInTimeRestore",
  "restorePointInTime": "string",
  "sourceServerId": "string"
}

对于副本，请使用：

{
  "createMode": "Replica",
  "sourceServerId": "string"
}

属性值

Microsoft.DBforPostgreSQL/servers

名字	描述	价值
apiVersion	API 版本	'2017-12-01'
身份	服务器的 Azure Active Directory 标识。	ResourceIdentity
位置	资源所在的位置。	string （必需）
名字	资源名称	string （必需）
性能	服务器的属性。	ServerPropertiesForCreateOrServerProperties （必需）
sku	服务器的 SKU（定价层）。	Sku
标签	资源标记	标记名称和值的字典。请参阅模板中的标记
类型	资源类型	“Microsoft.DBforPostgreSQL/servers”

ResourceIdentity

名字	描述	价值
类型	标识类型。将此设置为“SystemAssigned”，以便自动为资源创建和分配 Azure Active Directory 主体。	“SystemAssigned”

ServerForCreateTags

名字	描述	价值

ServerPropertiesForCreateOrServerProperties

名字	描述	价值
createMode	对于 ServerPropertiesForDefaultCreate，设置为“Default”。对于 ServerPropertiesForGeoRestore，请设置为“GeoRestore”。对于 ServerPropertiesForRestore，请设置为“PointInTimeRestore”。对于 ServerPropertiesForReplica，请设置为“Replica”。	“Default” “GeoRestore” “PointInTimeRestore” “Replica”（必需）
infrastructureEncryption	显示服务器是否启用基础结构加密的状态。	“Disabled” “Enabled”
minimalTlsVersion	为服务器强制实施最低 Tls 版本。	“TLS1_0” “TLS1_1” “TLS1_2” “TLSEnforcementDisabled”
publicNetworkAccess	是否允许此服务器访问公用网络。值是可选的，但如果传入，则必须为“Enabled”或“Disabled”	“Disabled” “Enabled”
sslEnforcement	在连接到服务器时启用 ssl 强制。	“Disabled” “Enabled”
storageProfile	服务器的存储配置文件。	StorageProfile
版本	服务器版本。	'10' '10.0' '10.2' '11' '9.5' '9.6'

ServerPropertiesForDefaultCreate

名字	描述	价值
administratorLogin	管理员的服务器登录名。只能在创建服务器时指定（并且是创建所必需的）。	string （必需）
administratorLoginPassword	管理员登录名的密码。	字符串约束：敏感值。以安全参数的形式传入。（必需）
createMode	创建新服务器的模式。	“Default”（必需）

ServerPropertiesForGeoRestore

名字	描述	价值
createMode	创建新服务器的模式。	“GeoRestore”（必需）
sourceServerId	要从中还原的源服务器 ID。	string （必需）

ServerPropertiesForReplica

名字	描述	价值
createMode	创建新服务器的模式。	“Replica”（必需）
sourceServerId	要从中创建副本的主服务器 ID。	string （必需）

ServerPropertiesForRestore

名字	描述	价值
createMode	创建新服务器的模式。	“PointInTimeRestore”（必需）
restorePointInTime	还原点创建时间（ISO8601格式），指定要从中还原的时间。	string （必需）
sourceServerId	要从中还原的源服务器 ID。	string （必需）

Sku

名字	描述	价值
能力	纵向扩展/横向扩展容量，表示服务器的计算单位。	int 约束：最小值 = 0
家庭	硬件系列。	字符串
名字	sku 的名称（通常为层 + 系列 + 核心），例如B_Gen4_1，GP_Gen5_8。	string （必需）
大小	要适当地由资源解释的大小代码。	字符串
层	特定 SKU 的层，例如基本层。	“Basic” “GeneralPurpose” “MemoryOptimized”

StorageProfile

名字	描述	价值
backupRetentionDays	服务器的备份保留日。	int
geoRedundantBackup	为服务器备份启用异地冗余或不启用。	“Disabled” “Enabled”
storageAutogrow	启用存储自动增长。	“Disabled” “Enabled”
storageMB	服务器允许的最大存储。	int

快速入门模板

以下快速入门模板部署此资源类型。

模板	描述
在 Linux 上使用 PostgreSQL Airflow Docker Web 应用	此模板提供了使用 Azure Database for PostgreSQL 在 Linux Web 应用上部署 puckel/docker-airflow 映像（最新标记）的简单方法
在应用服务上使用 PostgreSQL 数据库 Airflow Web 应用	用于在应用服务上使用 PostgreSQL 数据库部署 Airflow Web 应用的模板
布法罗 Web 应用	开始快速且廉价地在 Azure 上运行 Golang Buffalo 应用程序。
使用 VNet 部署 Azure Database for PostgreSQL	此模板提供部署 Azure Database for PostgreSQL 与 VNet 集成的方法。
在 Linux 上使用 PostgreSQL Sonarqube Docker Web 应用	此模板提供了使用 Azure Database for PostgreSQL 在 Linux Web 应用上部署 Sonarqube docker 映像（alpine tag）的简单方法（预览版）
使用 PostgreSQL 在 Linux 上 Web 应用	此模板提供了一种使用 Azure Database for PostgreSQL（预览版）在 Linux 上部署 Web 应用的简单方法。
使用 PostgreSQL 在 Linux 上 Web 应用	此模板提供了一种使用 Azure Database for PostgreSQL 在 Linux 上部署 Web 应用的简单方法。

Terraform （AzAPI 提供程序）资源定义

可以使用目标操作部署服务器资源类型：

资源组

有关每个 API 版本中已更改属性的列表，请参阅更改日志。

资源格式

若要创建 Microsoft.DBforPostgreSQL/servers 资源，请将以下 Terraform 添加到模板。

resource "azapi_resource" "symbolicname" {
  type = "Microsoft.DBforPostgreSQL/servers@2017-12-01"
  name = "string"
  identity = {
    type = "string"
  }
  location = "string"
  body = jsonencode({
    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
    }
  })
  sku = {
    capacity = int
    family = "string"
    name = "string"
    size = "string"
    tier = "string"
  }
  tags = {
    {customized property} = "string"
  }
}

ServerPropertiesForCreateOrServerProperties 对象

设置 createMode 属性以指定对象的类型。

对于默认，请使用：

{
  administratorLogin = "string"
  administratorLoginPassword = "string"
  createMode = "Default"
}

对于 GeoRestore，请使用：

{
  createMode = "GeoRestore"
  sourceServerId = "string"
}

对于 pointInTimeRestore，请使用：

{
  createMode = "PointInTimeRestore"
  restorePointInTime = "string"
  sourceServerId = "string"
}

对于副本，请使用：

{
  createMode = "Replica"
  sourceServerId = "string"
}

属性值

Microsoft.DBforPostgreSQL/servers

名字	描述	价值
身份	服务器的 Azure Active Directory 标识。	ResourceIdentity
位置	资源所在的位置。	string （必需）
名字	资源名称	string （必需）
性能	服务器的属性。	ServerPropertiesForCreateOrServerProperties （必需）
sku	服务器的 SKU（定价层）。	Sku
标签	资源标记	标记名称和值的字典。
类型	资源类型	“Microsoft.DBforPostgreSQL/servers@2017-12-01”

ResourceIdentity

名字	描述	价值
类型	标识类型。将此设置为“SystemAssigned”，以便自动为资源创建和分配 Azure Active Directory 主体。	“SystemAssigned”

ServerForCreateTags

名字	描述	价值

ServerPropertiesForCreateOrServerProperties

名字	描述	价值
createMode	对于 ServerPropertiesForDefaultCreate，设置为“Default”。对于 ServerPropertiesForGeoRestore，请设置为“GeoRestore”。对于 ServerPropertiesForRestore，请设置为“PointInTimeRestore”。对于 ServerPropertiesForReplica，请设置为“Replica”。	“Default” “GeoRestore” “PointInTimeRestore” “Replica”（必需）
infrastructureEncryption	显示服务器是否启用基础结构加密的状态。	“Disabled” “Enabled”
minimalTlsVersion	为服务器强制实施最低 Tls 版本。	“TLS1_0” “TLS1_1” “TLS1_2” “TLSEnforcementDisabled”
publicNetworkAccess	是否允许此服务器访问公用网络。值是可选的，但如果传入，则必须为“Enabled”或“Disabled”	“Disabled” “Enabled”
sslEnforcement	在连接到服务器时启用 ssl 强制。	“Disabled” “Enabled”
storageProfile	服务器的存储配置文件。	StorageProfile
版本	服务器版本。	'10' '10.0' '10.2' '11' '9.5' '9.6'

ServerPropertiesForDefaultCreate

名字	描述	价值
administratorLogin	管理员的服务器登录名。只能在创建服务器时指定（并且是创建所必需的）。	string （必需）
administratorLoginPassword	管理员登录名的密码。	字符串约束：敏感值。以安全参数的形式传入。（必需）
createMode	创建新服务器的模式。	“Default”（必需）

ServerPropertiesForGeoRestore

名字	描述	价值
createMode	创建新服务器的模式。	“GeoRestore”（必需）
sourceServerId	要从中还原的源服务器 ID。	string （必需）

ServerPropertiesForReplica

名字	描述	价值
createMode	创建新服务器的模式。	“Replica”（必需）
sourceServerId	要从中创建副本的主服务器 ID。	string （必需）

ServerPropertiesForRestore

名字	描述	价值
createMode	创建新服务器的模式。	“PointInTimeRestore”（必需）
restorePointInTime	还原点创建时间（ISO8601格式），指定要从中还原的时间。	string （必需）
sourceServerId	要从中还原的源服务器 ID。	string （必需）

Sku

名字	描述	价值
能力	纵向扩展/横向扩展容量，表示服务器的计算单位。	int 约束：最小值 = 0
家庭	硬件系列。	字符串
名字	sku 的名称（通常为层 + 系列 + 核心），例如B_Gen4_1，GP_Gen5_8。	string （必需）
大小	要适当地由资源解释的大小代码。	字符串
层	特定 SKU 的层，例如基本层。	“Basic” “GeneralPurpose” “MemoryOptimized”

StorageProfile

名字	描述	价值
backupRetentionDays	服务器的备份保留日。	int
geoRedundantBackup	为服务器备份启用异地冗余或不启用。	“Disabled” “Enabled”
storageAutogrow	启用存储自动增长。	“Disabled” “Enabled”
storageMB	服务器允许的最大存储。	int

通过

Microsoft.DBforPostgreSQL 服务器

Bicep 资源定义

资源格式

ServerPropertiesForCreateOrServerProperties 对象

属性值

Microsoft.DBforPostgreSQL/servers

ResourceIdentity

ServerForCreateTags

ServerPropertiesForCreateOrServerProperties

ServerPropertiesForDefaultCreate

ServerPropertiesForGeoRestore

ServerPropertiesForReplica

ServerPropertiesForRestore

Sku

StorageProfile

快速入门示例

ARM 模板资源定义

资源格式

ServerPropertiesForCreateOrServerProperties 对象

属性值

Microsoft.DBforPostgreSQL/servers

ResourceIdentity

ServerForCreateTags

ServerPropertiesForCreateOrServerProperties

ServerPropertiesForDefaultCreate

ServerPropertiesForGeoRestore

ServerPropertiesForReplica

ServerPropertiesForRestore

Sku

StorageProfile

快速入门模板

Terraform （AzAPI 提供程序）资源定义

资源格式

ServerPropertiesForCreateOrServerProperties 对象

属性值

Microsoft.DBforPostgreSQL/servers

ResourceIdentity

ServerForCreateTags

ServerPropertiesForCreateOrServerProperties

ServerPropertiesForDefaultCreate

ServerPropertiesForGeoRestore

ServerPropertiesForReplica

ServerPropertiesForRestore

Sku

StorageProfile

反馈

其他资源