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

Azure Database for PostgreSQL 灵活服务器的 REST API 发行说明

本文提供有关要使用的推荐 API 版本的最新新闻和更新。 此处未列出的 API 版本可能受支持,但很快就会停用。 此处提供了最新预览版和稳定版 API 的相关文档。

API 发布

本部分汇总了每个Azure Database for PostgreSQL API 版本的功能更改。

注释

API 版本通常建立在早期版本之上,但预览功能可能会发生变化或被删除。 “发行说明”列列出了每个版本的更改。

API 版本 稳定版/预览版 发布说明
2026-10-01 稳定(正式发布) 包括以前稳定 API 版本中的所有功能,并添加了以下新增功能:

维护管理: 支持重新安排计划内维护、按需应用可用维护更新、查看即将进行的维护以及检索维护历史记录。

网络: 支持将服务器从虚拟网络(VNet)集成迁移到公共访问和支持专用终结点的网络。

FIPS 合规性: 支持创建启用了 FIPS 的服务器,以及在现有服务器上启用或禁用 FIPS。

不可变备份: 支持创建启用了不可变备份的服务器。

主要版本升级: 支持在启动 PostgreSQL 主版本升级之前运行升级前验证检查。

自动调优: 添加 vacuumTable 作为受支持的自动调优选项。

跨租户客户管理的密钥(CMK): 支持使用客户管理的密钥配置跨租户加密,无论是否启用异地冗余备份。

PostgreSQL 版本灵活性: 删除 PostgreSQL 版本枚举约束,允许服务器创建和主要版本升级来支持新发布的 PostgreSQL 版本,而无需 API 架构更新。
2026-07-01-preview Preview 包括以前 API 版本中的所有功能,并添加了以下新增功能:

PostgreSQL 19: 将 PostgreSQL 版本 19 添加到支持的 PostgresMajorVersion 枚举。

数据库代理(DBAgent): 引入了新的 DBAgent 资源和关联的管理操作。

存储管理: 添加新的存储属性以支持高级 SSD v2 和存储自动增长配置。
2026-04-01-preview Preview 包括以前 API 版本中的所有功能,并添加了以下新增功能:

维护管理: 引入包含操作的 MaintenanceEvent API 来检索维护事件详细信息、按服务器列出维护事件、重新计划计划内维护,并按需应用可用的维护更新。

主要版本升级预检查:引入包含按服务器获取和按服务器列出操作的 MajorVersionUpgradePrecheck API,以及服务器 API 上的新 MajorVersionUpgradePrecheck 操作,以启动升级前验证检查。

跨租户客户管理的密钥(CMK): 向服务器 API 添加 primaryFederatedIdentityClientId 和 geoBackupFederatedIdentityClientId 属性,以支持使用客户管理的密钥进行跨租户数据加密。
2026-01-01-preview Preview 包括以前 API 版本中的所有功能,并添加以下功能:

网络: 支持将服务器从虚拟网络(VNet)集成迁移到公共访问和支持专用终结点的网络。
2025-08-01 稳定(正式发布) 早期 GA 功能 +
对 PG 18 的支持
对 PG 17 的支持
添加了对在弹性群集中指定默认数据库名称的支持
添加了对表建议的支持
更正了 HTTP 响应代码以反映每个 API 可以返回的内容
添加了基于 CMK 并自动更新密钥版本的数据加密示例
添加了在 Microsoft 拥有的虚拟网络中创建服务器的示例
重命名了文件以更好地反映其内容
重命名操作 ID 以提高组织、清晰度和导航
改进了本地定义的元数据
改进描述以保持一致性
2025-06-01-preview Preview 重命名了文件以更好地反映其内容
重命名操作以改善组织、清晰度和导航
添加了基于 CMK 并自动更新密钥版本的数据加密示例
添加了在 Microsoft 拥有的虚拟网络中创建服务器的示例
添加了对表建议的支持
添加了对在弹性群集中指定默认数据库名称的支持
删除对参数优化功能的支持
改进了说明
改进了本地定义的元数据
更正了 HTTP 响应代码以反映每个 API 可以返回的内容
2025-01-01-preview Preview 添加对参数优化功能的支持
2024-11-01-preview Preview 索引优化
添加了用于迁移的源类型
PG 17 支持
UltraSSD_LRS 存储类型支持
灵活服务器实例上的弹性群集
2024-08-01 稳定(正式发布) 早期 GA 功能 +
地理 + CMK - 恢复已删除
存储自动扩展
IOPS 缩放
新位置功能 API
长期保留备份
服务器日志
Migrations
迁移预验证
只读副本 - 切换(站点交换)
只读副本 - 虚拟终结点
专用终结点
Azure Defender /威胁防护 API
PG 16 支持
PremiumV2_LRS 存储类型支持
SSDv2 的位置功能更改
迁移角色
迁移实例资源 ID 以支持专用终结点迁移
按需备份
系统分配的托管标识
2023-06-01-preview Preview 早期 GA 功能 +
迁移预验证
只读副本 - 切换(站点交换)
只读副本 - 虚拟终结点
专用终结点
Azure Defender\威胁防护 APIs
PG 16 支持
PremiumV2_LRS 存储类型支持
SSDv2 的位置功能更改
配额使用情况 API
2023-03-01-preview Preview 新的 GA 版本功能 (2022-12-01) +
异地 + CMK
存储自动扩展
IOPS 缩放
新位置功能 API
Azure Defender
服务器日志
Migrations
2022-12-01 稳定(正式发布) 早期 GA 功能 +
EntraID
CMK
Backups
Administrators
Replicas
GeoRestore
MVU
2022-05-01-preview Preview CheckMigrationNameAvailability
Migrations
2021-06-01 稳定(正式发布) 早期 GA 功能 +
服务器 CRUD
CheckNameAvailability
配置(参数)
数据库
防火墙规则
私密
DNS 区域后缀
PITR
服务器重启
服务器启动
服务器停止
维护时段
虚拟网络子网使用情况

稳定 API 操作列表

下表列出了每个支持的稳定 API 操作及其详细信息。

功能/操作 详细信息
Administrators 管理 Microsoft Entra ID 服务器管理员
高级威胁防护 管理高级威胁防护设置
备份和还原 管理自动和按需服务器备份
Capabilities 按位置和服务器列出可用的服务器能力
配置 查看和管理 PostgreSQL 服务器参数
Databases 创建、读取、更新、删除和列出数据库
数据加密 配置客户管理的密钥(CMK),包括跨租户加密
防火墙规则 创建、读取、更新、删除和列出防火墙规则
长期保留 管理长期保留备份操作
维护事件 按需列出、检索、重新安排和应用维护事件
主版本升级预检查 启动升级前验证检查并检索验证结果
Migrations 创建和管理数据库迁移操作
名称可用性 检查服务器和虚拟终结点名称可用性
网络模式迁移 将服务器从 VNet 集成迁移到支持专用链接的网络配置
Operations 列出可用的资源提供程序管理操作
性能调优 检索调优选项和数据库优化建议
专用 DNS 区域后缀 检索专用 DNS 区域后缀
专用终结点 管理专用终结点连接
专用链接 资源 列出专用链接资源
配额使用情况 检索区域服务器配额和使用情况信息
只读副本 创建和管理只读副本,包括提升和切换
Servers 创建、读取、更新、删除、列出、启动、停止和重启服务器
虚拟端点 创建和管理虚拟终结点
虚拟网络子网使用情况 检索虚拟网络子网使用情况信息

预览 API 操作列表

下表列出了每个支持的预览 API 操作及其详细信息。

功能/操作 详细信息
Administrators 创建、检索、列出和删除Microsoft Entra ID服务器管理员
高级威胁防护 检索、列出和更新高级威胁防护设置
备份和还原 创建、检索、列出和删除按需备份;列出可用的自动备份
Capabilities 按位置和服务器列出可用的服务器能力
捕获的日志 列出可供下载的捕获的服务器日志
配置 检索、列出和更新 PostgreSQL 服务器参数
数据库代理 列出、检索、启用和禁用数据库代理配置
Databases 创建、检索、列出和删除数据库
数据加密 配置客户管理的密钥(CMK),包括跨租户加密
防火墙规则 创建、检索、更新、列出和删除防火墙规则
长期保留 验证备份先决条件,启动长期保留备份,并检索备份操作结果
维护事件 检索和列出维护事件、按即将或过去的状态进行筛选、重新计划维护和立即应用维护
主版本升级预检查 启动升级前验证检查并检索或列出验证结果
Migrations 创建、检索、列出、更新和取消数据库迁移;验证迁移名称可用性
名称可用性 全局或按位置检查服务器和虚拟终结点名称可用性
网络模式迁移 将服务器从 VNet 集成迁移到支持专用链接的网络模型
Operations 列出可用的资源提供程序管理操作
性能调优 检索调优选项以及索引或表优化建议
专用 DNS 区域后缀 检索专用 DNS 区域后缀
专用终结点 检索、列出、批准、拒绝和删除专用终结点连接
专用链接 资源 检索和列出专用链接资源
配额使用情况 检索灵活服务器的区域配额使用情况
只读副本 创建、列出和管理只读副本,包括提升为主实例和切换
Servers 创建、检索、更新、删除和列出服务器;启动、停止和重启服务器
存储管理 通过服务器存储属性配置 Premium SSD v2 和存储自动增长
虚拟端点 创建、检索、更新、列出和删除虚拟终结点
虚拟网络 子网使用 检索虚拟网络子网使用情况信息

使用 Terraform 中的 API 预览版

Terraform 是由 HashiCorp 创建的基础结构即代码 (IaC) 软件工具。 用户可使用称为 HashiCorp Configuration Language (HCL) 的声明性配置语言或可选的 JSON 来定义和提供数据中心基础结构。 Terraform 是对基于 GA Azure RM API 的 Azure Database for PostgreSQL 执行 IaC 管理的常用方法,此外还可使用 Azure 资源管理器 (ARM) 模板 Terraform 社区发布的基于 Azure 资源管理器 API 版本正式发布版 (GA) 的 Azure 资源管理器 (AzureRM) Terraform 提供程序的定期更新。

如果特定功能当前处于预览 API 中,并且尚未纳入 GA API 和 AzureRM Terraform 提供程序,请使用 AzAPI Terraform 提供程序 直接从 Terraform 调用预览 API。 AzAPI 提供程序是 Azure 资源管理器 REST API 之上的一个薄层。 使用 AzAPI 提供程序,可以使用任何 API 版本管理任何Azure资源类型。 AzAPI 提供程序是 Azure ARM REST API 之上的一个薄层。 通过使用 AzAPI 提供程序,可以使用任何 API 版本管理任何Azure资源类型。 此提供程序通过实现对新的 Azure 资源和属性(包括个人预览版)的管理来补充 AzureRM 提供程序。

AzAPI 提供程序具有以下优势:

  • 支持所有 Azure 服务:
  • 个人预览版服务和功能
  • 公共预览版服务和功能
  • 所有 API 版本
  • 完整 Terraform 状态文件保真度
  • 属性和值保存到状态
  • 不依赖于 Swagger
  • 常见且一致的 Azure 身份验证

AzAPI2AzureRM 是一种开源工具,旨在帮助从 AzAPI 提供程序迁移到 AzureRM 提供程序。

联系人

有关 Azure Database for PostgreSQL 上可能存在的任何问题或建议,请向 Azure Database for PostgreSQL 团队(@Ask Azure Database for PostgreSQL)发送电子邮件。 请注意,此电子邮件地址不是技术支持团队的别名。

另外,请酌情考虑以下联系点: