azure.azcollection.azure_rm_postgresqlfirewallrule_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_postgresqlfirewallrule_info。

azure.azcollection 0.1.2 中的新增功能

概要

  • 获取 Azure PostgreSQL 防火墙规则的事实。

要求

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

  • python >= 2.7

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

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

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

参数

参数

注释

ad_user

string

Active Directory 用户名。 在使用 Active Directory 用户而不是服务主体进行身份验证时使用。

adfs_authority_url

string

在 azure.azcollection 0.0.1 中添加

Azure AD 授权 URL。 在使用用户名/密码进行身份验证并且拥有自己的 ADFS 授权时使用。

api_profile

string

在 azure.azcollection 0.0.1 中添加

选择与 Azure 服务通信时要使用的 API 配置文件。 默认值 latest 适用于公共云；未来的值将允许与 Azure Stack 一起使用。

默认值： "latest"

auth_source

string

在 azure.azcollection 0.0.1 中添加

控制用于身份验证的凭据的来源。

也可以通过 ANSIBLE_AZURE_AUTH_SOURCE 环境变量设置。

当设置为 auto （默认值）时，优先级为模块参数 -> env -> credential_file -> cli。

当设置为 env 时，凭据将从环境变量中读取

当设置为 credential_file 时，它将从 ~/.azure/credentials 读取配置文件。

当设置为 cli 时，凭据将来自 Azure CLI 配置文件。 如果存在多个订阅 ID，则可以使用 subscription_id 或环境变量 AZURE_SUBSCRIPTION_ID 来标识订阅 ID，否则将使用默认的 az cli 订阅。

当设置为 msi 时，主机必须是启用了 MSI 扩展的 Azure 资源。 如果该资源被授予对多个订阅的访问权限，则可以使用 subscription_id 或环境变量 AZURE_SUBSCRIPTION_ID 来标识订阅 ID，否则将选择第一个订阅。

msi 在 Ansible 2.6 中添加。

选项

  • "auto" ←（默认值）

  • "cli"

  • "credential_file"

  • "env"

  • "msi"

cert_validation_mode

string

在 azure.azcollection 0.0.1 中添加

控制 Azure 端点的证书验证行为。 默认情况下，所有模块都会验证服务器证书，但是当使用 HTTPS 代理或针对 Azure Stack 时，可能需要通过传递 ignore 来禁用此行为。 也可以通过凭据文件配置文件或 AZURE_CERT_VALIDATION 环境变量设置。

选项

  • "ignore"

  • "validate"

client_id

string

Azure 客户端 ID。 在使用服务主体或托管标识 (msi) 进行身份验证时使用。

也可以通过 AZURE_CLIENT_ID 环境变量设置。

cloud_environment

string

在 azure.azcollection 0.0.1 中添加

对于美国公共云以外的云环境，环境名称（由 Azure Python SDK 定义，例如， AzureChinaCloud、 AzureUSGovernment）或元数据发现端点 URL（Azure Stack 所必需）。 也可以通过凭据文件配置文件或 AZURE_CLOUD_ENVIRONMENT 环境变量设置。

默认值： "AzureCloud"

disable_instance_discovery

boolean

在 azure.azcollection 2.3.0 中添加

确定在尝试进行身份验证时是否执行实例发现。 将此设置为 true 将完全禁用实例发现和授权验证。 此功能旨在用于无法访问元数据端点的情况，例如在私有云或 Azure Stack 中。 实例发现的过程包括从 https://login.microsoft.com/ 检索授权元数据以验证授权。 通过将此设置为 **True**，将禁用授权验证。 因此，确保配置的授权主机有效且可信至关重要。

通过凭据文件配置文件或 AZURE_DISABLE_INSTANCE_DISCOVERY 环境变量设置。

选项

  • false ← (默认值)

  • true

log_mode

string

父参数。

log_path

string

父参数。

name

string

服务器防火墙规则的名称。

password

string

Active Directory 用户密码。 在使用 Active Directory 用户而不是服务主体进行身份验证时使用。

profile

string

在 ~/.azure/credentials 文件中找到的安全配置文件。

resource_group

字符串 / 必填

资源组的名称。

secret

string

Azure 客户端密钥。使用服务主体进行身份验证时使用。

server_name

字符串 / 必填

服务器的名称。

subscription_id

string

您的 Azure 订阅 ID。

tenant

string

Azure 租户 ID。使用服务主体进行身份验证时使用。

thumbprint

string

在 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 中。这是一个 ini 文件，包含一个 [default] 部分以及以下键：subscription_id、client_id、secret 和 tenant，或者 subscription_id、ad_user 和 password。也可以添加其他配置文件。通过传递 profile 或在环境中设置 AZURE_PROFILE 来指定配置文件。

参见

另请参阅

使用 Azure CLI 登录

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

示例

- name: Get instance of PostgreSQL Firewall Rule
  azure_rm_postgresqlfirewallrule_info:
    resource_group: myResourceGroup
    server_name: server_name
    name: firewall_rule_name

- name: List instances of PostgreSQL Firewall Rule
  azure_rm_postgresqlfirewallrule_info:
    resource_group: myResourceGroup
    server_name: server_name

返回值

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

键

描述

rules

复杂

包含 PostgreSQL 防火墙规则事实的字典列表。

返回： 始终

end_ip_address

string

PostgreSQL 防火墙规则的结束 IP 地址。

返回： 始终

示例： "10.0.0.18"

id

string

资源 ID。

返回： 始终

示例： "/subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/TestGroup/providers/Microsoft.DBforPostgreSQL/servers/testserver/fire wallRules/rule1"

name

string

资源名称。

返回： 始终

示例： "rule1"

server_name

string

服务器的名称。

返回： 始终

示例： "testserver"

start_ip_address

string

PostgreSQL 防火墙规则的起始 IP 地址。

返回： 始终

示例： "10.0.0.16"

作者

  • Zim Kalinowski (@zikalino)