azure.azcollection.azure_rm_privatednsrecordset 模块 – 创建、删除和更新私有 DNS 记录集和记录
注意
此模块是 azure.azcollection 集合（版本 3.1.0）的一部分。
如果您正在使用 ansible 包，您可能已经安装了此集合。它不包含在 ansible-core 中。要检查是否已安装，请运行 ansible-galaxy collection list。
要安装它，请使用：ansible-galaxy collection install azure.azcollection。您需要进一步的要求才能使用此模块，请参阅 要求 了解详细信息。
要在 playbook 中使用它，请指定：azure.azcollection.azure_rm_privatednsrecordset。
azure.azcollection 1.1.0 中的新功能
概要
在现有 Azure 私有 DNS 区域中创建、删除和更新私有 DNS 记录集和记录。
要求
执行此模块的主机需要满足以下要求。
python >= 2.7
执行此模块的主机必须通过 galaxy 安装 azure.azcollection 集合
必须通过 pip 在执行来自 azure.azcollection 模块的主机上安装集合的 requirements.txt 中列出的所有 python 包
完整的安装说明可以在 https://galaxy.ansible.com/azure/azcollection 中找到
参数
参数 |
注释 |
|---|---|
Active Directory 用户名。当使用 Active Directory 用户而不是服务主体进行身份验证时使用。 |
|
Azure AD 授权 URL。当使用用户名/密码进行身份验证，并且具有自己的 ADFS 授权时使用。 |
|
选择与 Azure 服务通信时要使用的 API 配置文件。 默认值： |
|
用于控制 tags 字段是规范的还是仅附加到现有标签。 当为规范时，tags 参数中找不到的任何标签将从对象的元数据中删除。 选项
|
|
控制用于身份验证的凭据来源。 也可以通过 当设置为 当设置为 当设置为 当设置为 当设置为
选项
|
|
控制 Azure 端点的证书验证行为。默认情况下，所有模块都将验证服务器证书，但是当使用 HTTPS 代理或针对 Azure Stack 时，可能需要通过传递 选项
|
|
Azure 客户端 ID。当使用服务主体或托管标识 (msi) 进行身份验证时使用。 也可以通过 |
|
对于美国公共云之外的云环境，环境名称（由 Azure Python SDK 定义，例如， 默认值： |
|
确定在尝试进行身份验证时是否执行实例发现。将其设置为 true 将完全禁用实例发现和权限验证。此功能旨在用于无法访问元数据终结点的情况，例如私有云或 Azure Stack。实例发现的过程包括从 https://login.microsoft.com/ 检索权限元数据以验证权限。通过将此设置为 **True**，将禁用权限验证。因此，确保配置的权限主机有效且可信至关重要。 通过凭据文件配置文件或 选项
|
|
父参数。 |
|
父参数。 |
|
Active Directory 用户密码。当使用 Active Directory 用户而不是服务主体进行身份验证时使用。 |
|
在 ~/.azure/credentials 文件中找到的安全配置文件。 |
|
是否应清除未发送到模块的现有记录值。 选项
|
|
要创建或删除的记录集类型。 选项
|
|
要创建的记录列表，具体取决于记录（集）的类型。 |
|
所有记录类型的主数据值。 |
|
用于创建 |
|
用于创建 |
|
用于创建 |
|
用于创建 |
|
记录集的相对名称。 |
|
资源组的名称。 |
|
Azure 客户端密钥。当使用服务主体进行身份验证时使用。 |
|
断言记录集的状态。使用 选项
|
|
您的 Azure 订阅 ID。 |
|
要作为元数据分配给对象的字符串：字符串对字典。 对象上的元数据标签将使用任何提供的值进行更新。 要删除标签，请将 append_tags 选项设置为 false。 目前，Azure DNS 区域和流量管理器服务也不允许在标签中使用空格。 Azure Front Door 不支持使用 Azure Automation 和 Azure CDN 仅支持资源上的 15 个标签。 |
|
Azure 租户 ID。当使用服务主体进行身份验证时使用。 |
|
x509_certificate_path 中指定的私钥的指纹。 当使用服务主体进行身份验证时使用。 如果定义了 x509_certificate_path，则为必填。 |
|
记录集的存在时间（以秒为单位）。 默认值： |
|
用于创建 PEM 格式服务主体的 X509 证书的路径。 该证书必须附加到私钥。 当使用服务主体进行身份验证时使用。 |
|
要在其中管理记录集的现有专用 DNS 区域的名称。 |
注释
注意
对于 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 和密码，或在环境中设置 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: ensure an "A" record set with multiple records
azure_rm_privatednsrecordset:
resource_group: myResourceGroup
relative_name: www
zone_name: testing.com
record_type: A
records:
- entry: 192.168.100.101
- entry: 192.168.100.102
- entry: 192.168.100.103
- name: delete a record set
azure_rm_privatednsrecordset:
resource_group: myResourceGroup
record_type: A
relative_name: www
zone_name: testing.com
state: absent
- name: create multiple "A" record sets with multiple records
azure_rm_privatednsrecordset:
resource_group: myResourceGroup
zone_name: testing.com
relative_name: "{{ item.name }}"
record_type: "{{ item.type }}"
records: "{{ item.records }}"
with_items:
- {name: 'servera', type: 'A', records: [{ entry: '10.10.10.20'}, {entry: '10.10.10.21'}]}
- {name: 'serverb', type: 'A', records: [{ entry: '10.10.10.30'}, {entry: '10.10.10.41'}]}
- {name: 'serverc', type: 'A', records: [{ entry: '10.10.10.40'}, {entry: '10.10.10.41'}]}
- name: create SRV records in a new record set
azure_rm_privatednsrecordset:
resource_group: myResourceGroup
relative_name: _sip._tcp.testing.com
zone_name: testing.com
time_to_live: 7200
record_type: SRV
records:
- entry: sip.testing.com
priority: 20
weight: 10
port: 5060
- name: create PTR record in a new record set
azure_rm_privatednsrecordset:
resource_group: myResourceGroup
relative_name: 192.168.100.101.in-addr.arpa
zone_name: testing.com
record_type: PTR
records:
- entry: servera.testing.com
- name: create TXT record in a new record set
azure_rm_privatednsrecordset:
resource_group: myResourceGroup
relative_name: mail.testing.com
zone_name: testing.com
record_type: TXT
records:
- entry: 'v=spf1 a -all'
- name: Update SOA record
azure_rm_privatednsrecordset:
resource_group: myResourceGroup
relative_name: "@"
zone_name: testing.com
record_type: SOA
records:
- host: azureprivatedns.net
email: azureprivatedns-host99.example.com
serial_number: 1
refresh_time: 3699
retry_time: 399
expire_time: 2419299
minimum_ttl: 399
返回值
常见返回值记录在此处此处，以下是此模块特有的字段
键 |
描述 |
|---|---|
DNS 记录集的当前状态。 返回： 始终 |
|
记录集中记录的列表。 返回： 始终 示例： |
|
记录集的 etag。 返回： 始终 示例： |
|
记录集的完全限定域名。 返回： 始终 示例： |
|
DNS 记录集 ID。 返回： 始终 示例： |
|
记录集是否通过虚拟网络链接在专用 DNS 区域中自动注册。 返回： 始终 示例： |
|
记录集的关联名称。 返回： 始终 示例： |
|
记录集中记录的 TTL（生存时间）。 返回： 始终 示例： |
|
此记录集中 DNS 记录的类型。 返回： 始终 示例： |