你当前正在访问 Microsoft Azure Global Edition 技术文档网站。 如果需要访问由世纪互联运营的 Microsoft Azure 中国技术文档网站,请访问 https://docs.azure.cn。
Bicep 资源定义
可以使用目标操作部署 flexibleServers 资源类型:
- 资源组 - 请参阅 资源组部署命令
有关每个 API 版本中已更改属性的列表,请参阅 更改日志。
资源格式
若要创建 Microsoft.DBforPostgreSQL/flexibleServers 资源,请将以下 Bicep 添加到模板。
resource symbolicname 'Microsoft.DBforPostgreSQL/flexibleServers@2025-01-01-preview' = {
identity: {
principalId: 'string'
type: 'string'
userAssignedIdentities: {
{customized property}: {
clientId: 'string'
principalId: 'string'
}
}
}
___location: 'string'
name: 'string'
properties: {
administratorLogin: 'string'
administratorLoginPassword: 'string'
authConfig: {
activeDirectoryAuth: 'string'
passwordAuth: 'string'
tenantId: 'string'
}
availabilityZone: 'string'
backup: {
backupRetentionDays: int
geoRedundantBackup: 'string'
}
cluster: {
clusterSize: int
}
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'
publicNetworkAccess: 'string'
}
pointInTimeUTC: 'string'
replica: {
promoteMode: 'string'
promoteOption: 'string'
role: 'string'
}
replicationRole: 'string'
sourceServerResourceId: 'string'
storage: {
autoGrow: 'string'
iops: int
storageSizeGB: int
throughput: int
tier: 'string'
type: 'string'
}
version: 'string'
}
sku: {
name: 'string'
tier: 'string'
}
tags: {
{customized property}: 'string'
}
}
属性值
身份验证配置
名字 | 描述 | 价值 |
---|---|---|
activeDirectoryAuth 的 | 指示服务器是否支持 Microsoft Entra 身份验证。 | “Disabled” “Enabled” |
passwordAuth | 指示服务器是否支持基于密码的身份验证。 | “Disabled” “Enabled” |
租户ID | 委托资源的租户的标识符。 | 字符串 |
备份
名字 | 描述 | 价值 |
---|---|---|
backupRetentionDays 备份 | 灵活服务器的备份保留天数。 | 整数 (int) |
geoRedundantBackup | 指示是否将 服务器配置为创建地理位置冗余的备份。 | “Disabled” “Enabled” |
群集
名字 | 描述 | 价值 |
---|---|---|
集群大小 | 分配给 Elastic Cluster 的节点数。 | 整数 (int) |
数据加密
名字 | 描述 | 价值 |
---|---|---|
geoBackupKeyURI 的 | 用户分配的托管标识的标识符,用于访问 Azure Key Vault 中的密钥,以便对与配置为支持地理冗余备份的灵活服务器关联的地理冗余存储进行数据加密。 | 字符串 |
geoBackupUserAssignedIdentityId | 用户分配的托管标识的标识符,用于访问 Azure Key Vault 中的密钥,以便对与配置为支持地理冗余备份的灵活服务器关联的地理冗余存储进行数据加密。 | 字符串 |
primaryKeyURI 的 | Azure Key Vault 中密钥的 URI,用于对与灵活服务器关联的主存储进行数据加密。 | 字符串 |
primaryUserAssignedIdentityId | 用户分配的托管标识的标识符,用于访问 Azure Key Vault 中的密钥,以便对与灵活服务器关联的主存储进行数据加密。 | 字符串 |
类型 | 灵活服务器使用的数据加密类型。 | “AzureKeyVault” “SystemManaged” |
高可用性
名字 | 描述 | 价值 |
---|---|---|
模式 | 灵活服务器的高可用性模式。 | “Disabled” “SameZone” “ZoneRedundant” |
standbyAvailabilityZone | 与高可用性设置为 SameZone 或 ZoneRedundant 时创建的备用服务器关联的可用区。 | 字符串 |
MaintenanceWindow (维护窗口)
名字 | 描述 | 价值 |
---|---|---|
自定义窗口 | 指示自定义窗口是启用还是禁用。 | 字符串 |
dayOfWeek (周) | 用于维护时段的星期几。 | 整数 (int) |
startHour (开始小时) | 用于维护时段的开始时间。 | 整数 (int) |
startMinute (开始分钟) | 用于维护时段的开始分钟。 | 整数 (int) |
Microsoft.DBforPostgreSQL/flexibleServers
名字 | 描述 | 价值 |
---|---|---|
身份 | 用户分配的托管标识分配给灵活服务器。 | UserAssignedIdentity |
位置 | 资源所在的地理位置 | string (必需) |
名字 | 资源名称 | 字符串 约束: 最小长度 = 3 最大长度 = 63 模式 = ^[a-zA-Z0-9]+(-[a-zA-Z0-9]+)* (必需) |
性能 | 灵活服务器的属性。 | ServerProperties |
SKU | 灵活服务器的计算层和大小。 | Sku |
标签 | 资源标记 | 标记名称和值的字典。 请参阅模板 中的 |
网络
名字 | 描述 | 价值 |
---|---|---|
delegatedSubnetResourceId | 委托子网的资源标识符。 在创建新服务器期间是必需的,以防您希望将服务器集成到您自己的虚拟网络中。 对于更新作,如果要更改为私有 DNS 区域分配的值,则只需提供此属性。 | 字符串 |
privateDnsZoneArmResourceId | 私有 DNS 区域的标识符。 在创建新服务器期间是必需的,以防您希望将服务器集成到您自己的虚拟网络中。 对于更新作,如果要更改为私有 DNS 区域分配的值,则只需提供此属性。 | 字符串 |
publicNetworkAccess | 指示是否启用公共网络访问。 | “Disabled” “Enabled” |
复制品
名字 | 描述 | 价值 |
---|---|---|
promoteMode | 要应用于只读副本的作类型。 此属性是 write only。 Standalone 意味着只读副本将被提升为独立服务器,并将成为完全独立于复制集的实体。 切换意味着只读副本将与主服务器一起扮演角色。 | “独立” “switchover” |
promote选项 | 处理 promoteMode 属性中指定的作时使用的数据同步选项 此属性为“只写”。 Planned 表示作将等待只读副本中的数据与其源服务器完全同步,然后再启动作。 Forced 表示作在启动作之前不会等待只读副本中的数据与其源服务器同步。 | “forced” “计划” |
角色 | 服务器在复制集中的角色。 | “AsyncReplica” “GeoAsyncReplica” “None” “Primary” |
ServerProperties
名字 | 描述 | 价值 |
---|---|---|
管理员登录 | 指定为分配给 PostgreSQL 实例的第一个基于密码的管理员的登录名。 首次在服务器上启用基于密码的身份验证时,必须指定此参数。 一旦设置为给定值,则在服务器的其余生命周期内无法更改。 如果在启用了基于密码的身份验证的服务器上禁用基于密码的身份验证,则不会删除此基于密码的角色。 | 字符串 |
administratorLoginPassword | 分配给管理员登录名的密码。 只要启用了密码身份验证,就可以随时更改此密码。 | 字符串 约束: 敏感值。 以安全参数的形式传入。 |
authConfig 认证 | 灵活服务器的身份验证配置属性。 | 身份验证配置 |
可用性区域 | 灵活服务器的可用性区域。 | 字符串 |
备份 | 灵活服务器的备份属性。 | 备份 |
簇 | 灵活服务器的群集属性。 | 群集 |
createMode | 新灵活服务器的创建模式。 | “Create” “Default” “GeoRestore” “PointInTimeRestore” “Replica” “ReviveDropped” “Update” |
数据加密 | 灵活服务器的数据加密属性。 | 数据加密 |
高可用性 | 灵活服务器的高可用性属性。 | 高可用性 |
维护窗口 | 灵活服务器的维护时段属性。 | MaintenanceWindow (维护窗口) |
网络 | 灵活服务器的网络属性。 仅当您希望将服务器集成到客户提供的虚拟网络中时,才需要。 | 网络 |
pointInTimeUTC | 要在新灵活服务器中还原的备份的创建时间(ISO8601格式)。 当 'createMode' 为 'PointInTimeRestore'、'GeoRestore' 或 'ReviveDropped' 时,它是必需的。 | 字符串 |
复制品 | 灵活服务器的只读副本属性。 仅在您想要升级服务器时才需要。 | 副本 |
replicationRole | 服务器在复制集中的角色。 | “AsyncReplica” “GeoAsyncReplica” “None” “Primary” |
sourceServerResourceId | 要用作新灵活服务器源的灵活服务器的标识符。 当 'createMode' 为 'PointInTimeRestore'、'GeoRestore'、'Replica' 或 'ReviveDropped' 时是必需的。 仅当目标灵活服务器是只读副本时,才会返回此属性。 | 字符串 |
存储 | 灵活服务器的存储属性。 | 存储 |
版本 | PostgreSQL 数据库引擎的主要版本。 | '11' '12' '13' '14' '15' '16' '17' |
SKU
名字 | 描述 | 价值 |
---|---|---|
名字 | 名称 ,用于已知分配给灵活服务器的给定计算大小。 | string (必需) |
层 | 分配给灵活服务器的计算层。 | “可突发” “GeneralPurpose” “MemoryOptimized”(必需) |
存储
名字 | 描述 | 价值 |
---|---|---|
自动增长 | 当可用空间接近零且条件允许自动增加存储大小时,启用或禁用灵活服务器的存储大小的自动增长的标志。 | “Disabled” “Enabled” |
IOPS (国际速率) | 存储支持的最大 IOPS。 当存储类型为 PremiumV2_LRS 或 UltraSSD_LRS 时是必需的。 | 整数 (int) |
存储大小GB | 分配给灵活服务器的存储大小。 | 整数 (int) |
吞吐量 | 存储支持的最大吞吐量。 当存储类型为 PremiumV2_LRS 或 UltraSSD_LRS 时是必需的。 | 整数 (int) |
层 | 灵活服务器的存储层。 | “P1” “P10” “P15” “P2” “P20” “P3” “P30” “P4” “P40” “P50” “P6” “P60” “P70” “P80” |
类型 | 分配给灵活服务器的存储类型。 允许的值为 Premium_LRS、PremiumV2_LRS 或 UltraSSD_LRS。 如果未指定,则默认为 Premium_LRS。 | “PremiumV2_LRS” “Premium_LRS” “UltraSSD_LRS” |
TrackedResourceTags
名字 | 描述 | 价值 |
---|
UserAssignedIdentity
名字 | 描述 | 价值 |
---|---|---|
principalId (主体ID) | 与用户分配的托管标识关联的服务主体的对象的标识符。 | 字符串 |
类型 | 与灵活服务器关联的身份类型。 | “None” “SystemAssigned” “SystemAssigned,UserAssigned” “UserAssigned”(必需) |
用户分配的标识 | 用户分配的托管标识的映射。 | UserAssignedIdentityMap |
UserAssignedIdentityMap
名字 | 描述 | 价值 |
---|
用户身份
名字 | 描述 | 价值 |
---|---|---|
clientId | 与用户分配的托管标识关联的服务主体的客户端的标识符。 | 字符串 |
principalId (主体ID) | 与用户分配的托管标识关联的服务主体的对象的标识符。 | 字符串 |
用法示例
Azure 验证模块
以下 Azure 验证模块 可用于部署此资源类型。
模块 | 描述 |
---|---|
DB for Postgre SQL 灵活服务器 | 用于 Postgre SQL 灵活服务器的 DB 的 AVM 资源模块 |
Azure 快速入门示例
以下 Azure 快速入门模板 包含用于部署此资源类型的 Bicep 示例。
Bicep 文件 | 描述 |
---|---|
创建 PgFlex 服务器 & 通过备份保管库 启用保护 | 创建 PostgreSQL 灵活服务器的模板,并通过备份保管库启用保护 |
使用 AAD 部署 Azure Database for PostgreSQL(灵活) |
此模板提供了部署灵活服务器 Azure Database for PostgreSQL 和 AAD 集成的方法。 |
使用 VNet 部署 Azure Database for PostgreSQL (灵活) | 此模板提供了部署灵活服务器 Azure Database for PostgreSQL 和 VNet 集成的方法。 |
使用 PostgreSQL 和 VNet 集成的 Web 应用 SonarQube | 此模板提供使用 PostgreSQL 灵活服务器、VNet 集成和专用 DNS 轻松将 SonarQube 部署到 Linux 上的 Web 应用。 |
ARM 模板资源定义
可以使用目标操作部署 flexibleServers 资源类型:
- 资源组 - 请参阅 资源组部署命令
有关每个 API 版本中已更改属性的列表,请参阅 更改日志。
资源格式
若要创建 Microsoft.DBforPostgreSQL/flexibleServers 资源,请将以下 JSON 添加到模板。
{
"type": "Microsoft.DBforPostgreSQL/flexibleServers",
"apiVersion": "2025-01-01-preview",
"name": "string",
"identity": {
"principalId": "string",
"type": "string",
"userAssignedIdentities": {
"{customized property}": {
"clientId": "string",
"principalId": "string"
}
}
},
"___location": "string",
"properties": {
"administratorLogin": "string",
"administratorLoginPassword": "string",
"authConfig": {
"activeDirectoryAuth": "string",
"passwordAuth": "string",
"tenantId": "string"
},
"availabilityZone": "string",
"backup": {
"backupRetentionDays": "int",
"geoRedundantBackup": "string"
},
"cluster": {
"clusterSize": "int"
},
"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",
"publicNetworkAccess": "string"
},
"pointInTimeUTC": "string",
"replica": {
"promoteMode": "string",
"promoteOption": "string",
"role": "string"
},
"replicationRole": "string",
"sourceServerResourceId": "string",
"storage": {
"autoGrow": "string",
"iops": "int",
"storageSizeGB": "int",
"throughput": "int",
"tier": "string",
"type": "string"
},
"version": "string"
},
"sku": {
"name": "string",
"tier": "string"
},
"tags": {
"{customized property}": "string"
}
}
属性值
身份验证配置
名字 | 描述 | 价值 |
---|---|---|
activeDirectoryAuth 的 | 指示服务器是否支持 Microsoft Entra 身份验证。 | “Disabled” “Enabled” |
passwordAuth | 指示服务器是否支持基于密码的身份验证。 | “Disabled” “Enabled” |
租户ID | 委托资源的租户的标识符。 | 字符串 |
备份
名字 | 描述 | 价值 |
---|---|---|
backupRetentionDays 备份 | 灵活服务器的备份保留天数。 | 整数 (int) |
geoRedundantBackup | 指示是否将 服务器配置为创建地理位置冗余的备份。 | “Disabled” “Enabled” |
群集
名字 | 描述 | 价值 |
---|---|---|
集群大小 | 分配给 Elastic Cluster 的节点数。 | 整数 (int) |
数据加密
名字 | 描述 | 价值 |
---|---|---|
geoBackupKeyURI 的 | 用户分配的托管标识的标识符,用于访问 Azure Key Vault 中的密钥,以便对与配置为支持地理冗余备份的灵活服务器关联的地理冗余存储进行数据加密。 | 字符串 |
geoBackupUserAssignedIdentityId | 用户分配的托管标识的标识符,用于访问 Azure Key Vault 中的密钥,以便对与配置为支持地理冗余备份的灵活服务器关联的地理冗余存储进行数据加密。 | 字符串 |
primaryKeyURI 的 | Azure Key Vault 中密钥的 URI,用于对与灵活服务器关联的主存储进行数据加密。 | 字符串 |
primaryUserAssignedIdentityId | 用户分配的托管标识的标识符,用于访问 Azure Key Vault 中的密钥,以便对与灵活服务器关联的主存储进行数据加密。 | 字符串 |
类型 | 灵活服务器使用的数据加密类型。 | “AzureKeyVault” “SystemManaged” |
高可用性
名字 | 描述 | 价值 |
---|---|---|
模式 | 灵活服务器的高可用性模式。 | “Disabled” “SameZone” “ZoneRedundant” |
standbyAvailabilityZone | 与高可用性设置为 SameZone 或 ZoneRedundant 时创建的备用服务器关联的可用区。 | 字符串 |
MaintenanceWindow (维护窗口)
名字 | 描述 | 价值 |
---|---|---|
自定义窗口 | 指示自定义窗口是启用还是禁用。 | 字符串 |
dayOfWeek (周) | 用于维护时段的星期几。 | 整数 (int) |
startHour (开始小时) | 用于维护时段的开始时间。 | 整数 (int) |
startMinute (开始分钟) | 用于维护时段的开始分钟。 | 整数 (int) |
Microsoft.DBforPostgreSQL/flexibleServers
名字 | 描述 | 价值 |
---|---|---|
apiVersion | API 版本 | “2025-01-01-预览” |
身份 | 用户分配的托管标识分配给灵活服务器。 | UserAssignedIdentity |
位置 | 资源所在的地理位置 | string (必需) |
名字 | 资源名称 | 字符串 约束: 最小长度 = 3 最大长度 = 63 模式 = ^[a-zA-Z0-9]+(-[a-zA-Z0-9]+)* (必需) |
性能 | 灵活服务器的属性。 | ServerProperties |
SKU | 灵活服务器的计算层和大小。 | Sku |
标签 | 资源标记 | 标记名称和值的字典。 请参阅模板 中的 |
类型 | 资源类型 | “Microsoft.DBforPostgreSQL/flexibleServers” |
网络
名字 | 描述 | 价值 |
---|---|---|
delegatedSubnetResourceId | 委托子网的资源标识符。 在创建新服务器期间是必需的,以防您希望将服务器集成到您自己的虚拟网络中。 对于更新作,如果要更改为私有 DNS 区域分配的值,则只需提供此属性。 | 字符串 |
privateDnsZoneArmResourceId | 私有 DNS 区域的标识符。 在创建新服务器期间是必需的,以防您希望将服务器集成到您自己的虚拟网络中。 对于更新作,如果要更改为私有 DNS 区域分配的值,则只需提供此属性。 | 字符串 |
publicNetworkAccess | 指示是否启用公共网络访问。 | “Disabled” “Enabled” |
复制品
名字 | 描述 | 价值 |
---|---|---|
promoteMode | 要应用于只读副本的作类型。 此属性是 write only。 Standalone 意味着只读副本将被提升为独立服务器,并将成为完全独立于复制集的实体。 切换意味着只读副本将与主服务器一起扮演角色。 | “独立” “switchover” |
promote选项 | 处理 promoteMode 属性中指定的作时使用的数据同步选项 此属性为“只写”。 Planned 表示作将等待只读副本中的数据与其源服务器完全同步,然后再启动作。 Forced 表示作在启动作之前不会等待只读副本中的数据与其源服务器同步。 | “forced” “计划” |
角色 | 服务器在复制集中的角色。 | “AsyncReplica” “GeoAsyncReplica” “None” “Primary” |
ServerProperties
名字 | 描述 | 价值 |
---|---|---|
管理员登录 | 指定为分配给 PostgreSQL 实例的第一个基于密码的管理员的登录名。 首次在服务器上启用基于密码的身份验证时,必须指定此参数。 一旦设置为给定值,则在服务器的其余生命周期内无法更改。 如果在启用了基于密码的身份验证的服务器上禁用基于密码的身份验证,则不会删除此基于密码的角色。 | 字符串 |
administratorLoginPassword | 分配给管理员登录名的密码。 只要启用了密码身份验证,就可以随时更改此密码。 | 字符串 约束: 敏感值。 以安全参数的形式传入。 |
authConfig 认证 | 灵活服务器的身份验证配置属性。 | 身份验证配置 |
可用性区域 | 灵活服务器的可用性区域。 | 字符串 |
备份 | 灵活服务器的备份属性。 | 备份 |
簇 | 灵活服务器的群集属性。 | 群集 |
createMode | 新灵活服务器的创建模式。 | “Create” “Default” “GeoRestore” “PointInTimeRestore” “Replica” “ReviveDropped” “Update” |
数据加密 | 灵活服务器的数据加密属性。 | 数据加密 |
高可用性 | 灵活服务器的高可用性属性。 | 高可用性 |
维护窗口 | 灵活服务器的维护时段属性。 | MaintenanceWindow (维护窗口) |
网络 | 灵活服务器的网络属性。 仅当您希望将服务器集成到客户提供的虚拟网络中时,才需要。 | 网络 |
pointInTimeUTC | 要在新灵活服务器中还原的备份的创建时间(ISO8601格式)。 当 'createMode' 为 'PointInTimeRestore'、'GeoRestore' 或 'ReviveDropped' 时,它是必需的。 | 字符串 |
复制品 | 灵活服务器的只读副本属性。 仅在您想要升级服务器时才需要。 | 副本 |
replicationRole | 服务器在复制集中的角色。 | “AsyncReplica” “GeoAsyncReplica” “None” “Primary” |
sourceServerResourceId | 要用作新灵活服务器源的灵活服务器的标识符。 当 'createMode' 为 'PointInTimeRestore'、'GeoRestore'、'Replica' 或 'ReviveDropped' 时是必需的。 仅当目标灵活服务器是只读副本时,才会返回此属性。 | 字符串 |
存储 | 灵活服务器的存储属性。 | 存储 |
版本 | PostgreSQL 数据库引擎的主要版本。 | '11' '12' '13' '14' '15' '16' '17' |
SKU
名字 | 描述 | 价值 |
---|---|---|
名字 | 名称 ,用于已知分配给灵活服务器的给定计算大小。 | string (必需) |
层 | 分配给灵活服务器的计算层。 | “可突发” “GeneralPurpose” “MemoryOptimized”(必需) |
存储
名字 | 描述 | 价值 |
---|---|---|
自动增长 | 当可用空间接近零且条件允许自动增加存储大小时,启用或禁用灵活服务器的存储大小的自动增长的标志。 | “Disabled” “Enabled” |
IOPS (国际速率) | 存储支持的最大 IOPS。 当存储类型为 PremiumV2_LRS 或 UltraSSD_LRS 时是必需的。 | 整数 (int) |
存储大小GB | 分配给灵活服务器的存储大小。 | 整数 (int) |
吞吐量 | 存储支持的最大吞吐量。 当存储类型为 PremiumV2_LRS 或 UltraSSD_LRS 时是必需的。 | 整数 (int) |
层 | 灵活服务器的存储层。 | “P1” “P10” “P15” “P2” “P20” “P3” “P30” “P4” “P40” “P50” “P6” “P60” “P70” “P80” |
类型 | 分配给灵活服务器的存储类型。 允许的值为 Premium_LRS、PremiumV2_LRS 或 UltraSSD_LRS。 如果未指定,则默认为 Premium_LRS。 | “PremiumV2_LRS” “Premium_LRS” “UltraSSD_LRS” |
TrackedResourceTags
名字 | 描述 | 价值 |
---|
UserAssignedIdentity
名字 | 描述 | 价值 |
---|---|---|
principalId (主体ID) | 与用户分配的托管标识关联的服务主体的对象的标识符。 | 字符串 |
类型 | 与灵活服务器关联的身份类型。 | “None” “SystemAssigned” “SystemAssigned,UserAssigned” “UserAssigned”(必需) |
用户分配的标识 | 用户分配的托管标识的映射。 | UserAssignedIdentityMap |
UserAssignedIdentityMap
名字 | 描述 | 价值 |
---|
用户身份
名字 | 描述 | 价值 |
---|---|---|
clientId | 与用户分配的托管标识关联的服务主体的客户端的标识符。 | 字符串 |
principalId (主体ID) | 与用户分配的托管标识关联的服务主体的对象的标识符。 | 字符串 |
用法示例
Azure 快速入门模板
以下 Azure 快速入门模板 部署此资源类型。
模板 | 描述 |
---|---|
创建 PgFlex 服务器 & 通过备份保管库 启用保护 |
创建 PostgreSQL 灵活服务器的模板,并通过备份保管库启用保护 |
使用 AAD 部署 Azure Database for PostgreSQL(灵活) |
此模板提供了部署灵活服务器 Azure Database for PostgreSQL 和 AAD 集成的方法。 |
使用 VNet 部署 Azure Database for PostgreSQL (灵活) |
此模板提供了部署灵活服务器 Azure Database for PostgreSQL 和 VNet 集成的方法。 |
使用 PostgreSQL 和 VNet 集成的 Web 应用 SonarQube |
此模板提供使用 PostgreSQL 灵活服务器、VNet 集成和专用 DNS 轻松将 SonarQube 部署到 Linux 上的 Web 应用。 |
Terraform (AzAPI 提供程序)资源定义
可以使用目标操作部署 flexibleServers 资源类型:
- 资源组
有关每个 API 版本中已更改属性的列表,请参阅 更改日志。
资源格式
若要创建 Microsoft.DBforPostgreSQL/flexibleServers 资源,请将以下 Terraform 添加到模板。
resource "azapi_resource" "symbolicname" {
type = "Microsoft.DBforPostgreSQL/flexibleServers@2025-01-01-preview"
name = "string"
parent_id = "string"
identity {
type = "string"
identity_ids = [
"string"
]
}
___location = "string"
tags = {
{customized property} = "string"
}
body = {
properties = {
administratorLogin = "string"
administratorLoginPassword = "string"
authConfig = {
activeDirectoryAuth = "string"
passwordAuth = "string"
tenantId = "string"
}
availabilityZone = "string"
backup = {
backupRetentionDays = int
geoRedundantBackup = "string"
}
cluster = {
clusterSize = int
}
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"
publicNetworkAccess = "string"
}
pointInTimeUTC = "string"
replica = {
promoteMode = "string"
promoteOption = "string"
role = "string"
}
replicationRole = "string"
sourceServerResourceId = "string"
storage = {
autoGrow = "string"
iops = int
storageSizeGB = int
throughput = int
tier = "string"
type = "string"
}
version = "string"
}
sku = {
name = "string"
tier = "string"
}
}
}
属性值
身份验证配置
名字 | 描述 | 价值 |
---|---|---|
activeDirectoryAuth 的 | 指示服务器是否支持 Microsoft Entra 身份验证。 | “Disabled” “Enabled” |
passwordAuth | 指示服务器是否支持基于密码的身份验证。 | “Disabled” “Enabled” |
租户ID | 委托资源的租户的标识符。 | 字符串 |
备份
名字 | 描述 | 价值 |
---|---|---|
backupRetentionDays 备份 | 灵活服务器的备份保留天数。 | 整数 (int) |
geoRedundantBackup | 指示是否将 服务器配置为创建地理位置冗余的备份。 | “Disabled” “Enabled” |
群集
名字 | 描述 | 价值 |
---|---|---|
集群大小 | 分配给 Elastic Cluster 的节点数。 | 整数 (int) |
数据加密
名字 | 描述 | 价值 |
---|---|---|
geoBackupKeyURI 的 | 用户分配的托管标识的标识符,用于访问 Azure Key Vault 中的密钥,以便对与配置为支持地理冗余备份的灵活服务器关联的地理冗余存储进行数据加密。 | 字符串 |
geoBackupUserAssignedIdentityId | 用户分配的托管标识的标识符,用于访问 Azure Key Vault 中的密钥,以便对与配置为支持地理冗余备份的灵活服务器关联的地理冗余存储进行数据加密。 | 字符串 |
primaryKeyURI 的 | Azure Key Vault 中密钥的 URI,用于对与灵活服务器关联的主存储进行数据加密。 | 字符串 |
primaryUserAssignedIdentityId | 用户分配的托管标识的标识符,用于访问 Azure Key Vault 中的密钥,以便对与灵活服务器关联的主存储进行数据加密。 | 字符串 |
类型 | 灵活服务器使用的数据加密类型。 | “AzureKeyVault” “SystemManaged” |
高可用性
名字 | 描述 | 价值 |
---|---|---|
模式 | 灵活服务器的高可用性模式。 | “Disabled” “SameZone” “ZoneRedundant” |
standbyAvailabilityZone | 与高可用性设置为 SameZone 或 ZoneRedundant 时创建的备用服务器关联的可用区。 | 字符串 |
MaintenanceWindow (维护窗口)
名字 | 描述 | 价值 |
---|---|---|
自定义窗口 | 指示自定义窗口是启用还是禁用。 | 字符串 |
dayOfWeek (周) | 用于维护时段的星期几。 | 整数 (int) |
startHour (开始小时) | 用于维护时段的开始时间。 | 整数 (int) |
startMinute (开始分钟) | 用于维护时段的开始分钟。 | 整数 (int) |
Microsoft.DBforPostgreSQL/flexibleServers
名字 | 描述 | 价值 |
---|---|---|
身份 | 用户分配的托管标识分配给灵活服务器。 | UserAssignedIdentity |
位置 | 资源所在的地理位置 | string (必需) |
名字 | 资源名称 | 字符串 约束: 最小长度 = 3 最大长度 = 63 模式 = ^[a-zA-Z0-9]+(-[a-zA-Z0-9]+)* (必需) |
性能 | 灵活服务器的属性。 | ServerProperties |
SKU | 灵活服务器的计算层和大小。 | Sku |
标签 | 资源标记 | 标记名称和值的字典。 |
类型 | 资源类型 | “Microsoft.DBforPostgreSQL/flexibleServers@2025-01-01-preview” |
网络
名字 | 描述 | 价值 |
---|---|---|
delegatedSubnetResourceId | 委托子网的资源标识符。 在创建新服务器期间是必需的,以防您希望将服务器集成到您自己的虚拟网络中。 对于更新作,如果要更改为私有 DNS 区域分配的值,则只需提供此属性。 | 字符串 |
privateDnsZoneArmResourceId | 私有 DNS 区域的标识符。 在创建新服务器期间是必需的,以防您希望将服务器集成到您自己的虚拟网络中。 对于更新作,如果要更改为私有 DNS 区域分配的值,则只需提供此属性。 | 字符串 |
publicNetworkAccess | 指示是否启用公共网络访问。 | “Disabled” “Enabled” |
复制品
名字 | 描述 | 价值 |
---|---|---|
promoteMode | 要应用于只读副本的作类型。 此属性是 write only。 Standalone 意味着只读副本将被提升为独立服务器,并将成为完全独立于复制集的实体。 切换意味着只读副本将与主服务器一起扮演角色。 | “独立” “switchover” |
promote选项 | 处理 promoteMode 属性中指定的作时使用的数据同步选项 此属性为“只写”。 Planned 表示作将等待只读副本中的数据与其源服务器完全同步,然后再启动作。 Forced 表示作在启动作之前不会等待只读副本中的数据与其源服务器同步。 | “forced” “计划” |
角色 | 服务器在复制集中的角色。 | “AsyncReplica” “GeoAsyncReplica” “None” “Primary” |
ServerProperties
名字 | 描述 | 价值 |
---|---|---|
管理员登录 | 指定为分配给 PostgreSQL 实例的第一个基于密码的管理员的登录名。 首次在服务器上启用基于密码的身份验证时,必须指定此参数。 一旦设置为给定值,则在服务器的其余生命周期内无法更改。 如果在启用了基于密码的身份验证的服务器上禁用基于密码的身份验证,则不会删除此基于密码的角色。 | 字符串 |
administratorLoginPassword | 分配给管理员登录名的密码。 只要启用了密码身份验证,就可以随时更改此密码。 | 字符串 约束: 敏感值。 以安全参数的形式传入。 |
authConfig 认证 | 灵活服务器的身份验证配置属性。 | 身份验证配置 |
可用性区域 | 灵活服务器的可用性区域。 | 字符串 |
备份 | 灵活服务器的备份属性。 | 备份 |
簇 | 灵活服务器的群集属性。 | 群集 |
createMode | 新灵活服务器的创建模式。 | “Create” “Default” “GeoRestore” “PointInTimeRestore” “Replica” “ReviveDropped” “Update” |
数据加密 | 灵活服务器的数据加密属性。 | 数据加密 |
高可用性 | 灵活服务器的高可用性属性。 | 高可用性 |
维护窗口 | 灵活服务器的维护时段属性。 | MaintenanceWindow (维护窗口) |
网络 | 灵活服务器的网络属性。 仅当您希望将服务器集成到客户提供的虚拟网络中时,才需要。 | 网络 |
pointInTimeUTC | 要在新灵活服务器中还原的备份的创建时间(ISO8601格式)。 当 'createMode' 为 'PointInTimeRestore'、'GeoRestore' 或 'ReviveDropped' 时,它是必需的。 | 字符串 |
复制品 | 灵活服务器的只读副本属性。 仅在您想要升级服务器时才需要。 | 副本 |
replicationRole | 服务器在复制集中的角色。 | “AsyncReplica” “GeoAsyncReplica” “None” “Primary” |
sourceServerResourceId | 要用作新灵活服务器源的灵活服务器的标识符。 当 'createMode' 为 'PointInTimeRestore'、'GeoRestore'、'Replica' 或 'ReviveDropped' 时是必需的。 仅当目标灵活服务器是只读副本时,才会返回此属性。 | 字符串 |
存储 | 灵活服务器的存储属性。 | 存储 |
版本 | PostgreSQL 数据库引擎的主要版本。 | '11' '12' '13' '14' '15' '16' '17' |
SKU
名字 | 描述 | 价值 |
---|---|---|
名字 | 名称 ,用于已知分配给灵活服务器的给定计算大小。 | string (必需) |
层 | 分配给灵活服务器的计算层。 | “可突发” “GeneralPurpose” “MemoryOptimized”(必需) |
存储
名字 | 描述 | 价值 |
---|---|---|
自动增长 | 当可用空间接近零且条件允许自动增加存储大小时,启用或禁用灵活服务器的存储大小的自动增长的标志。 | “Disabled” “Enabled” |
IOPS (国际速率) | 存储支持的最大 IOPS。 当存储类型为 PremiumV2_LRS 或 UltraSSD_LRS 时是必需的。 | 整数 (int) |
存储大小GB | 分配给灵活服务器的存储大小。 | 整数 (int) |
吞吐量 | 存储支持的最大吞吐量。 当存储类型为 PremiumV2_LRS 或 UltraSSD_LRS 时是必需的。 | 整数 (int) |
层 | 灵活服务器的存储层。 | “P1” “P10” “P15” “P2” “P20” “P3” “P30” “P4” “P40” “P50” “P6” “P60” “P70” “P80” |
类型 | 分配给灵活服务器的存储类型。 允许的值为 Premium_LRS、PremiumV2_LRS 或 UltraSSD_LRS。 如果未指定,则默认为 Premium_LRS。 | “PremiumV2_LRS” “Premium_LRS” “UltraSSD_LRS” |
TrackedResourceTags
名字 | 描述 | 价值 |
---|
UserAssignedIdentity
名字 | 描述 | 价值 |
---|---|---|
principalId (主体ID) | 与用户分配的托管标识关联的服务主体的对象的标识符。 | 字符串 |
类型 | 与灵活服务器关联的身份类型。 | “None” “SystemAssigned” “SystemAssigned,UserAssigned” “UserAssigned”(必需) |
用户分配的标识 | 用户分配的托管标识的映射。 | UserAssignedIdentityMap |
UserAssignedIdentityMap
名字 | 描述 | 价值 |
---|
用户身份
名字 | 描述 | 价值 |
---|---|---|
clientId | 与用户分配的托管标识关联的服务主体的客户端的标识符。 | 字符串 |
principalId (主体ID) | 与用户分配的托管标识关联的服务主体的对象的标识符。 | 字符串 |
用法示例
Azure 验证模块
以下 Azure 验证模块 可用于部署此资源类型。
模块 | 描述 |
---|---|
DB for Postgre SQL 灵活服务器 | 用于 Postgre SQL 灵活服务器的 DB 的 AVM 资源模块 |