azure.azcollection.azure_rm_postgresqlserver 模块 – 管理 PostgreSQL 服务器实例

注意

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

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

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

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

azure.azcollection 0.1.2 中的新增功能

摘要 

创建、更新和删除 PostgreSQL 服务器实例。

要求 

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

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 授权时使用。
admin_password 字符串	管理员登录密码。提供的密码长度必须在 6-72 个字符之间，并且必须满足以下密码复杂性要求中的至少 3 个。包含大写字符包含小写字符包含数字包含特殊字符不允许使用控制字符
admin_username 字符串	服务器的管理员登录名。只有在创建服务器时才能指定（并且创建时是必需的）。
api_profile 字符串 azure.azcollection 0.0.1 中添加	选择在与 Azure 服务通信时使用的 API 配置文件。对于公共云，`latest` 的默认值是合适的；未来的值将允许与 Azure Stack 一起使用。默认值： `"latest"`
append_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"`
backup_retention_days 整数	备份保留期，介于 7 到 35 天之间。如果未设置，则默认为 7 天
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 字符串	SQL Server 的创建模式。空白（默认）、从地理冗余备份还原 (geo_restore) 或从特定时间点还原 (point_in_time_restore)。选项 `"default"` ← (默认) `"geo_restore"` `"point_in_time_restore"`
disable_instance_discovery 布尔值 azure.azcollection 2.3.0 版本中添加	确定尝试进行身份验证时是否执行实例发现。将其设置为 true 将完全禁用实例发现和权限验证。此功能旨在用于无法访问元数据端点的场景，例如私有云或 Azure Stack。实例发现过程需要从 https://login.microsoft.com/ 获取权限元数据以验证权限。将其设置为 True 将禁用权限验证。因此，务必确保配置的权限主机有效且值得信赖。通过凭据文件配置文件或 `AZURE_DISABLE_INSTANCE_DISCOVERY` 环境变量设置。选项 `false` ← (默认) `true`
enforce_ssl 布尔值	启用 SSL 强制。选项 `false` ← (默认) `true`
geo_redundant_backup 布尔值	选择本地冗余备份（默认）或地理冗余备份。首次部署后无法更新此设置。选项 `false` ← (默认) `true`
location 字符串	资源位置。如果未设置，将使用资源组中的位置作为默认值。
log_mode 字符串	父参数。
log_path 字符串	父参数。
name 字符串 / 必需	服务器名称。
password 字符串	Active Directory 用户密码。使用 Active Directory 用户而不是服务主体进行身份验证时使用。
profile 字符串	在 ~/.azure/credentials 文件中找到的安全配置文件。
resource_group 字符串 / 必需	包含资源的资源组名称。您可以从 Azure 资源管理器 API 或门户获取此值。
restore_point_in_time 字符串	还原点创建时间（ISO8601 格式），指定要从中还原的时间。如果 create_mode=point_in_time_restore，则必需。
secret 字符串	Azure 客户端密钥。使用服务主体进行身份验证时使用。
sku 字典	服务器的 SKU（价格等级）。
capacity 字符串	向上/向外扩展容量，表示服务器的计算单元。
name 字符串	SKU 的名称，通常为层 + 系列 + 内核，例如 `B_Gen4_1`、`GP_Gen5_8`。
size 字符串	大小代码，由资源根据需要进行解释。
tier 字符串	特定 SKU 的层级，例如 `Basic`。选项 `"基本"` `"标准"`
source_server_id 字符串	如果 create_mode=default，则为源服务器的 ID。
state 字符串	断言 PostgreSQL 服务器的状态。使用 `present` 创建或更新服务器，使用 `absent` 删除服务器。选项 `"present"` ← (默认) `"absent"`
storage_autogrow 布尔值	启用存储自动增长。选项 `false` ← (默认) `true`
storage_mb 整数	服务器允许的最大存储量。
subscription_id 字符串	您的 Azure 订阅 ID。
tags 字典	字符串：字符串对的字典，作为元数据分配给对象。对象的元数据标签将使用任何提供的 value 进行更新。要删除标签，请将 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 字符串	服务器版本。选项 `"9.5"` `"9.6"` `"10"` `"11"`
x509_certificate_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 Server
  azure_rm_postgresqlserver:
    resource_group: myResourceGroup
    name: testserver
    sku:
      name: B_Gen5_1
      tier: Basic
    location: eastus
    storage_mb: 1024
    enforce_ssl: true
    storage_autogrow: true
    admin_username: cloudsa
    admin_password: "{{ password }}"

返回值 

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

键	描述
fully_qualified_domain_name 字符串	服务器的完全限定域名。返回：始终示例： `"postgresqlsrv1b6dd89593.postgresql.database.azure.com"`
id 字符串	资源 ID。返回：始终示例： `"/subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/myResourceGroup/providers/Microsoft.DBforPostgreSQL/servers/mysqlsrv1b6dd89593"`
state 字符串	对用户可见的服务器状态。可能的值包括 `Ready`、`Dropping`、`Disabled`。返回：始终示例： `"Ready"`
version 字符串	服务器版本。可能的值包括 `9.5`、`9.6`、`10`、`11`。返回：始终示例： `"9.6"`

作者

Zim Kalinowski (@zikalino)