azure.azcollection.azure_rm_postgresqlflexibleserver_info 模块 – 获取 Azure PostgreSQL 灵活服务器事实

注意

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

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

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

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

azure.azcollection 2.2.0 中的新增功能

概要

• 获取 PostgreSQL 灵活服务器的事实。

要求

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

• python >= 2.7

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

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

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

参数

参数	注释
ad_user 字符串	活动目录用户名。当使用活动目录用户而不是服务主体进行身份验证时使用。
adfs_authority_url 字符串 azure.azcollection 0.0.1 中新增	Azure AD 授权 URL。当使用用户名/密码进行身份验证并且拥有自己的 ADFS 授权时使用。
api_profile 字符串 azure.azcollection 0.0.1 中新增	选择与 Azure 服务通信时要使用的 API 配置文件。对于公共云，latest 的默认值是合适的；未来的值将允许与 Azure Stack 一起使用。 默认值： "latest"
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"
cert_validation_mode 字符串 azure.azcollection 0.0.1 中新增	控制 Azure 端点的证书验证行为。默认情况下，所有模块都将验证服务器证书，但在使用 HTTPS 代理或针对 Azure Stack 时，可能需要通过传递 ignore 来禁用此行为。也可以通过凭据文件配置文件或 AZURE_CERT_VALIDATION 环境变量设置。 选项 "ignore" "validate"
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"
disable_instance_discovery 布尔值 azure.azcollection 2.3.0 中新增	确定尝试进行身份验证时是否执行实例发现。将其设置为 true 将完全禁用实例发现和授权验证。此功能旨在用于无法访问元数据端点的场景，例如私有云或 Azure Stack。实例发现过程需要从 https://login.microsoft.com/ 检索授权元数据以验证授权。通过将其设置为 **True**，授权验证将被禁用。因此，必须确保配置的授权主机有效且值得信赖。 通过凭据文件配置文件或 AZURE_DISABLE_INSTANCE_DISCOVERY 环境变量设置。 选项 false ← (默认) true
log_mode 字符串	父参数。
日志路径 字符串	父参数。
名称 字符串	服务器名称。
密码 字符串	Active Directory 用户密码。使用 Active Directory 用户进行身份验证时使用，而不是服务主体。
配置文件 字符串	在 ~/.azure/credentials 文件中找到的安全配置文件。
资源组 字符串	包含资源的资源组名称。您可以从 Azure 资源管理器 API 或门户获取此值。
密钥 字符串	Azure 客户端密钥。使用服务主体进行身份验证时使用。
订阅 ID 字符串	您的 Azure 订阅 ID。
标签 列表 / 元素=字符串	通过提供标签列表来限制结果。标签格式为“键”或“键:值”。
租户 字符串	Azure 租户 ID。使用服务主体进行身份验证时使用。
指纹 字符串 新增于 azure.azcollection 1.14.0	在 *x509_certificate_path* 中指定的私钥的指纹。 使用服务主体进行身份验证时使用。 如果定义了 *x509_certificate_path*，则为必填项。
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: Get instance of PostgreSQL Flexible Server
  azure_rm_postgresqlflexibleserver_info:
    resource_group: myResourceGroup
    name: server_name

- name: List instances of PostgreSQL Flexible Server
  azure_rm_postgresqlflexibleserver_info:
    resource_group: myResourceGroup
    tags:
      - key

返回值

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

键	描述
服务器 复杂类型	包含 PostgreSQL Flexible Server 事实的字典列表。 返回值：始终
管理员登录名 字符串	服务器的管理员登录名。 返回值：始终 示例： "azureuser"
可用区 字符串	服务器的可用区信息。 返回值：始终 示例： "1"
备份 复杂类型	服务器的备份属性。 返回值：始终
备份保留天数 整数	服务器的备份保留天数。 返回值：始终 示例： 7
地理冗余备份 字符串	指示是否在服务器上启用地理冗余备份的值。 返回值：始终 示例： "Disabled"
完全限定域名 字符串	灵活服务器的完全限定域名。 返回值：始终 示例： "postflexiblefredpgsqlflexible.postgres.database.azure.com"
高可用性 复杂类型	服务器的高可用性属性。 返回值：始终
模式 字符串	服务器的 HA 模式。 返回值：始终 示例： "Disabled"
备用可用区 字符串	备用服务器的可用区信息。 返回值：始终
ID 字符串	PostgreSQL 灵活服务器的资源 ID。 返回值：始终 示例： "/subscriptions/xxx/resourceGroups/myResourceGroup/providers/Microsoft.DBforPostgreSQL/flexibleservers/postgresql3"
标识 复杂类型	服务器的标识。 返回值：如有可用
类型 字符串	托管标识的类型 返回值：始终 示例： "UserAssigned"
用户分配的标识 复杂类型	用户分配的托管标识及其选项 返回值：始终
ID 字典	与资源关联的用户分配的标识 ID 字典 返回值：始终
位置 字符串	资源所在的位置。 返回值：始终 示例： "eastus"
维护窗口 复杂类型	服务器的维护窗口属性。 返回值：始终
自定义窗口 字符串	指示是否启用或禁用自定义窗口。 返回值：始终 示例： "Enabled"
星期几 整数	维护窗口的星期几。 返回值：始终 示例： 0
开始小时 整数	维护窗口的开始小时。 返回值：始终 示例： 8
开始分钟 整数	维护窗口的开始分钟。 返回值：始终 示例： 0
名称 字符串	资源名称。 返回值：始终 示例： "postgreabdud1223"
网络 复杂类型	服务器的网络属性。 返回值：始终
委派子网资源 ID 字符串	委派子网 ARM 资源 ID。 返回值：始终
专用 DNS 区域 ARM 资源 ID 字符串	专用 DNS 区域 ARM 资源 ID。 返回值：始终
公网访问 字符串	是否启用公网访问。 返回值：始终 示例： "Enabled"
特定时间点（UTC） 字符串	还原点创建时间（ISO8601 格式）。 返回值：始终
资源组 字符串	资源组名称。 返回值：始终 示例： "myResourceGroup"
SKU 复杂类型	服务器的 SKU。 返回值：始终
名称 字符串	SKU 的名称。 返回值：始终 示例： "Standard_B1ms"
层级 字符串	特定 SKU 的层级。 返回值：始终 示例： "Burstable"
源服务器资源 ID 字符串	要从中还原的源服务器资源 ID。 返回值：始终
存储 复杂类型	服务器允许的最大存储量。 返回值：始终
存储大小（GB） 整数	服务器允许的最大存储量。 返回值：始终 示例： 128
系统数据 复杂类型	与该资源相关的系统元数据。 返回值：始终
创建时间 字符串	资源创建时间戳（UTC）。 返回值：始终
创建者 字符串	创建资源的标识。 返回值：始终
创建者类型 字符串	创建资源的标识类型。 返回值：始终
上次修改时间 字符串	资源上次修改时间戳（UTC）。 返回值：始终
上次修改者 字符串	上次修改资源的标识。 返回值：始终
上次修改者类型 字符串	上次修改资源的标识类型。 返回值：始终
标签 字典	分配给资源的标签。字符串:字符串对的字典。 返回值：始终 示例： {"tag1": "abc"}
版本 字符串	灵活服务器版本。 返回值：始终 示例： "12"

作者

• xuzhang3 (@xuzhang3)

• Fred-sun (@Fred-sun)

集合链接

• 问题跟踪器
• 主页
• 代码库（源代码）