azure.azcollection.azure_rm_postgresqlflexibleserver 模块 – 管理 PostgreSQL Flexible Server 实例

注意

此模块是 azure.azcollection 集合 (版本 3.1.0) 的一部分。

如果您使用的是 ansible 包，则可能已安装此集合。它不包含在 ansible-core 中。要检查是否已安装，请运行 ansible-galaxy collection list。

要安装它，请使用：ansible-galaxy collection install azure.azcollection。您需要其他要求才能使用此模块，有关详细信息，请参阅 要求。

要在 playbook 中使用它，请指定：azure.azcollection.azure_rm_postgresqlflexibleserver。

azure.azcollection 2.2.0 中的新增功能

概要

• 创建、更新和删除 PostgreSQL Flexible Server 实例。

要求

执行此模块的主机需要以下要求。

• python >= 2.7

• 执行此模块的主机必须通过 galaxy 安装 azure.azcollection 集合

• 集合的 requirements.txt 中列出的所有 python 包必须通过 pip 安装在执行 azure.azcollection 中模块的主机上

• 完整的安装说明可在 https://galaxy.ansible.com/azure/azcollection 找到

参数

参数	注释
ad_user 字符串	Active Directory 用户名。当使用 Active Directory 用户而不是服务主体进行身份验证时使用。
adfs_authority_url 字符串 azure.azcollection 0.0.1 中新增	Azure AD 授权 URL。当使用用户名/密码进行身份验证并且拥有自己的 ADFS 授权时使用。
administrator_login 字符串	服务器的管理员登录名。 只有在创建服务器时才能指定（并且创建时是必需的）。
administrator_login_password 字符串	管理员登录密码（创建服务器时需要）。
api_profile 字符串 azure.azcollection 0.0.1 中新增	选择在与 Azure 服务通信时使用的 API 配置文件。 latest 的默认值适用于公共云；未来的值将允许与 Azure Stack 一起使用。 默认值： "latest"
append_tags 布尔值	用于控制标签字段是规范的还是仅附加到现有标签。 当规范时，在 tags 参数中找不到的任何标签都将从对象的元数据中删除。 选项 false true ← (默认)
auth_source 字符串 azure.azcollection 0.0.1 中新增	控制用于身份验证的凭据来源。 也可以通过 ANSIBLE_AZURE_AUTH_SOURCE 环境变量设置。 当设置为 auto（默认值）时，优先级是模块参数 -> env -> credential_file -> cli。 当设置为 env 时，凭据将从环境变量中读取。 当设置为 credential_file 时，它将从 ~/.azure/credentials 读取配置文件。 当设置为 cli 时，凭据将来自 Azure CLI 配置文件。 subscription_id 或环境变量 AZURE_SUBSCRIPTION_ID 可用于标识订阅 ID（如果存在多个），否则使用默认的 az cli 订阅。 当设置为 msi 时，主机必须是启用了 MSI 扩展的 Azure 资源。 subscription_id 或环境变量 AZURE_SUBSCRIPTION_ID 可用于标识订阅 ID（如果资源被授予对多个订阅的访问权限），否则选择第一个订阅。 Ansible 2.6 中添加了 msi。 选项 "auto" ← (默认) "cli" "credential_file" "env" "msi"
availability_zone 字符串	服务器的可用区信息
backup 字典	服务器的备份属性。
backup_retention_days 整数	服务器的备份保留天数。
geo_redundant_backup 字符串	指示服务器上是否启用了地理冗余备份的值。 选项 “已启用” “已禁用”
cert_validation_mode 字符串 azure.azcollection 0.0.1 中新增	控制 Azure 端点的证书验证行为。默认情况下，所有模块都将验证服务器证书，但在使用 HTTPS 代理或针对 Azure Stack 时，可能需要通过传递 ignore 来禁用此行为。也可以通过凭据文件配置文件或 AZURE_CERT_VALIDATION 环境变量设置。 选项 “忽略” “验证”
client_id 字符串	Azure 客户端 ID。使用服务主体或托管标识 (msi) 进行身份验证时使用。 也可以通过 AZURE_CLIENT_ID 环境变量设置。
cloud_environment 字符串 azure.azcollection 0.0.1 中新增	对于美国公共云以外的云环境，环境名称（由 Azure Python SDK 定义，例如 AzureChinaCloud、AzureUSGovernment）或元数据发现端点 URL（Azure Stack 要求）。也可以通过凭据文件配置文件或 AZURE_CLOUD_ENVIRONMENT 环境变量设置。 默认值： "AzureCloud"
create_mode 字符串	创建新的 PostgreSQL 服务器的模式。 选项 “默认” “创建” “更新” “PointInTimeRestore”（指定时间点恢复）
disable_instance_discovery 布尔值 在 azure.azcollection 2.3.0 中添加	确定尝试进行身份验证时是否执行实例发现。将其设置为 true 将完全禁用实例发现和权限验证。此功能旨在用于无法访问元数据端点的场景，例如私有云或 Azure Stack。实例发现过程需要从 https://login.microsoft.com/ 检索权限元数据以验证权限。将其设置为 **True** 将禁用权限验证。因此，务必确保配置的权限主机有效且值得信赖。 通过凭据文件配置文件或 AZURE_DISABLE_INSTANCE_DISCOVERY 环境变量设置。 选项 false ← (默认) true
fully_qualified_domain_name 字符串	服务器的完全限定域名。
high_availability 字典	服务器的高可用性属性。
mode 字符串	服务器的 HA 模式。 选项 “已禁用” “ZoneRedundant”（区域冗余）
standby_availability_zone 字符串	备用服务器的可用性区域信息。
identity 字典 在 azure.azcollection 2.4.0 中添加	服务器的标识。
type 字符串	托管标识的类型 选项 “UserAssigned”（用户分配） "None" ← (默认)
user_assigned_identities 字典	用户分配的托管标识及其选项 默认值： {}
append 布尔值	标识列表是否要追加到当前标识（true）还是替换当前标识（false）。 选项 false true ← (默认)
id 列表 / 元素=字符串	与虚拟机关联的用户分配的标识 ID 列表。 默认值： []
is_restart 布尔值	是否重新启动 Post gresql 服务器。 选项 false ← (默认) true
is_start 布尔值	是否启动 Post gresql 服务器。 选项 false ← (默认) true
is_stop 布尔值	是否停止 Post gresql 服务器。 选项 false ← (默认) true
location 字符串	资源位置。如果未设置，则使用资源组中的位置作为默认值。
log_mode 字符串	父参数。
log_path 字符串	父参数。
maintenance_window 字典	服务器的维护窗口属性。
custom_window 字符串	指示是否启用或禁用自定义窗口。
day_of_week 整数	维护窗口的星期几。
start_hour 整数	维护窗口的开始小时。
start_minute 整数	维护窗口的开始分钟。
name 字符串 / 必需	灵活服务器的名称。
network 字典	服务器的网络属性。
delegated_subnet_resource_id 字符串	委派子网 ARM 资源 ID。
private_dns_zone_arm_resource_id 字符串	专用 DNS 区域 ARM 资源 ID。
public_network_access 字符串	是否启用公共网络访问。 选项 “已启用” “已禁用”
password 字符串	Active Directory 用户密码。使用 Active Directory 用户而不是服务主体进行身份验证时使用。
point_in_time_utc 字符串	还原点创建时间（ISO8601 格式），指定要从中还原的时间。 当 create_mode=PointInTimeRestore 时必需。
profile 字符串	在 ~/.azure/credentials 文件中找到的安全配置文件。
resource_group 字符串 / 必需	包含资源的资源组的名称。 您可以从 Azure 资源管理器 API 或门户获取此值。
secret 字符串	Azure 客户端密钥。使用服务主体进行身份验证时使用。
sku 字典	服务器的 SKU（定价层）。
name 字符串 / 必需	sku 的名称，通常为层 + 系列 + 内核，例如 Standard_D4s_v3。
tier 字符串 / 必需	特定 SKU 的层。 选项 “Burstable”（突发型） “GeneralPurpose”（通用型） “MemoryOptimized”（内存优化型）
source_server_resource_id 字符串	要从中还原的源服务器资源 ID。 当 create_mode=PointInTimeRestore 时必需。
state 字符串	声明 PostgreSQL 灵活服务器的状态。 使用 present 创建或更新服务器，使用 absent 删除服务器。 选项 "present" ← (默认) “absent”（不存在）
storage 字典	服务器的存储属性。
storage_size_gb 整数	服务器的存储大小。
subscription_id 字符串	您的 Azure 订阅 ID。
tags 字典	要作为元数据分配给对象的字符串：字符串对的字典。 对象上的元数据标签将使用任何提供的数值进行更新。 要移除标签，请将 append_tags 选项设置为 false。 目前，Azure DNS 区域和流量管理器服务也不允许在标签中使用空格。 Azure 前端门户不支持使用 Azure 自动化和 Azure CDN 仅支持资源上的 15 个标签。
tenant 字符串	Azure 租户 ID。使用服务主体进行身份验证时使用。
thumbprint 字符串 在 azure.azcollection 1.14.0 中添加	在 x509_certificate_path 中指定的私钥的指纹。 使用服务主体进行身份验证时使用。 如果定义了 x509_certificate_path，则为必需。
version 字符串	PostgreSQL 服务器版本。 选项 "11" "12" "13" "14" "15" "16"
x509_certificate_path path 在 azure.azcollection 1.14.0 中添加	用于以 PEM 格式创建服务主体的 X509 证书的路径。 证书必须附加到私钥。 使用服务主体进行身份验证时使用。

注释

注意

• 对于使用 Azure 进行身份验证，您可以传递参数、设置环境变量、使用存储在 ~/.azure/credentials 中的配置文件，或者在运行任务或剧本之前使用 az login 登录。

• 也可以使用服务主体或 Active Directory 用户进行身份验证。

• 要通过服务主体进行身份验证，请传递 subscription_id、client_id、secret 和 tenant，或设置环境变量 AZURE_SUBSCRIPTION_ID、AZURE_CLIENT_ID、AZURE_SECRET 和 AZURE_TENANT。

• 要通过 Active Directory 用户进行身份验证，请传递 ad_user 和 password，或在环境中设置 AZURE_AD_USER 和 AZURE_PASSWORD。

• 或者，凭据可以存储在 ~/.azure/credentials 中。这是一个包含 [default] 部分和以下键的 ini 文件：subscription_id、client_id、secret 和 tenant 或 subscription_id、ad_user 和 password。也可以添加其他配置文件。通过传递 profile 或在环境中设置 AZURE_PROFILE 来指定配置文件。

另请参阅

另请参阅

使用 Azure CLI 登录

如何使用 az login 命令进行身份验证。

示例

- name: Create (or update) PostgreSQL Flexible Server
  azure_rm_postgresqlflexibleserver:
    resource_group: myResourceGroup
    name: testserver
    sku:
      name: Standard_B1ms
      tier: Burstable
    administrator_login: azureuser
    administrator_login_password: "{{ password }}"
    version: 12
    storage:
      storage_size_gb: 128
    fully_qualified_domain_name: st-private-dns-zone.postgres.database.azure.com
    backup:
      backup_retention_days: 7
      geo_redundant_backup: Disabled
    maintenance_window:
      custom_window: Enabled
      start_hour: 8
      start_minute: 0
      day_of_week: 0
    point_in_time_utc: 2023-05-31T00:28:17.7279547+00:00
    availability_zone: 1
    create_mode: Default

- name: Delete PostgreSQL Flexible Server
  azure_rm_postgresqlflexibleserver:
    resource_group: myResourceGroup
    name: testserver
    state: absent

返回值

常用返回值已在 此处 记录，以下是此模块特有的字段

键	描述
servers 复杂	包含 PostgreSQL 灵活服务器事实的字典列表。 返回： 始终
administrator_login 字符串	服务器的管理员登录名。 返回： 始终 示例： "azureuser"
availability_zone 字符串	服务器的可用性区域信息。 返回： 始终 示例： "1"
backup 复杂	服务器的备份属性。 返回： 始终
backup_retention_days 整数	服务器的备份保留天数。 返回： 始终 示例： 7
geo_redundant_backup 字符串	指示服务器上是否启用了地理冗余备份的值。 返回： 始终 示例： "Disabled"
fully_qualified_domain_name 字符串	灵活服务器的完全限定域名。 返回： 始终 示例： "postflexiblefredpgsqlflexible.postgres.database.azure.com"
high_availability 复杂	服务器的高可用性属性。 返回： 始终
mode 字符串	服务器的 HA 模式。 返回： 始终 示例： "Disabled"
standby_availability_zone 字符串	备用服务器的可用性区域信息。 返回： 始终
id 字符串	PostgreSQL 灵活服务器的资源 ID。 返回： 始终 示例： "/subscriptions/xxx/resourceGroups/myResourceGroup/providers/Microsoft.DBforPostgreSQL/flexibleservers/postgresql3"
location 字符串	资源所在的地理位置。 返回： 始终 示例： "eastus"
maintenance_window 复杂	服务器的维护窗口属性。 返回： 始终
custom_window 字符串	指示是否启用或禁用自定义窗口。 返回： 始终 示例： "Enabled"
day_of_week 整数	维护窗口的星期几。 返回： 始终 示例： 0
start_hour 整数	维护窗口的开始小时。 返回： 始终 示例： 8
start_minute 整数	维护窗口的开始分钟。 返回： 始终 示例： 0
name 字符串	资源名称。 返回： 始终 示例： "postgreabdud1223"
network 复杂	服务器的网络属性。 返回： 始终
delegated_subnet_resource_id 字符串	委派子网 ARM 资源 ID。 返回： 始终
private_dns_zone_arm_resource_id 字符串	专用 DNS 区域 ARM 资源 ID。 返回： 始终
public_network_access 字符串	是否启用公共网络访问。 返回： 始终 示例： "Enabled"
point_in_time_utc 字符串	还原点创建时间（ISO8601 格式）。 返回： 始终
resource_group 字符串	资源组名称。 返回： 始终 示例： "myResourceGroup"
sku 复杂	服务器的 SKU。 返回： 始终
name 字符串	SKU 的名称。 返回： 始终 示例： "Standard_B1ms"
tier 字符串	特定 SKU 的层。 返回： 始终 示例： "Burstable"
source_server_resource_id 字符串	要从中还原的源服务器资源 ID。 返回： 始终
storage 复杂	服务器允许的最大存储量。 返回： 始终
storage_size_gb 整数	服务器允许的最大存储量。 返回： 始终 示例： 128
system_data 复杂	与该资源相关的系统元数据。 返回： 始终
created_at 字符串	资源创建的时间戳（UTC）。 返回： 始终
created_by 字符串	创建资源的标识。 返回： 始终
created_by_type 字符串	创建资源的标识类型。 返回： 始终
last_modified_at 字符串	资源上次修改的时间戳（UTC）。 返回： 始终
last_modified_by 字符串	上次修改资源的标识。 返回： 始终
last_modified_by_type 字符串	上次修改资源的标识类型。 返回： 始终
tags 字典	分配给资源的标签。字符串：字符串对的字典。 返回： 始终 示例： {"tag1": "abc"}
version 字符串	灵活服务器版本。 返回： 始终 只能返回 "11" "12" "13" 示例： "12"

作者

• xuzhang3 (@xuzhang3)

• Fred-sun (@Fred-sun)

资源链接

• 问题追踪器
• 主页
• 代码仓库