New in version 2.4.
The below requirements are needed on the host that executes this module.
| Parameter | Choices/Defaults | Comments | |
|---|---|---|---|
| ad_user string | Active Directory username. Use when authenticating with an Active Directory user rather than service principal. | ||
| adfs_authority_url string added in 2.6 | Azure AD authority url. Use when authenticating with Username/password, and has your own ADFS authority. | ||
| api_profile string added in 2.5 | Default: "latest" | Selects an API profile to use when communicating with Azure services. Default value of latest is appropriate for public clouds; future values will allow use with Azure Stack. | |
| append_tags boolean |
| Use to control if tags field is canonical or just appends to existing tags. When canonical, any tags not found in the tags parameter will be removed from the object's metadata. | |
| auth_source string added in 2.5 |
| Controls the source of the credentials to use for authentication. If not specified, ANSIBLE_AZURE_AUTH_SOURCE environment variable will be used and default to auto if variable is not defined.auto will follow the default precedence of module parameters -> environment variables -> default profile in credential file ~/.azure/credentials.When set to cli, the credentials will be sources from the default Azure CLI profile.Can also be set via the ANSIBLE_AZURE_AUTH_SOURCE environment variable.When set to msi, the host machine must be an azure resource with an enabled MSI extension. subscription_id or the environment variable AZURE_SUBSCRIPTION_ID can be used to identify the subscription ID if the resource is granted access to more than one subscription, otherwise the first subscription is chosen.The msi was added in Ansible 2.6. | |
| cert_validation_mode string added in 2.5 |
| Controls the certificate validation behavior for Azure endpoints. By default, all modules will validate the server certificate, but when an HTTPS proxy is in use, or against Azure Stack, it may be necessary to disable this behavior by passing ignore. Can also be set via credential file profile or the AZURE_CERT_VALIDATION environment variable. | |
| client_id string | Azure client ID. Use when authenticating with a Service Principal. | ||
| cloud_environment string added in 2.4 | Default: "AzureCloud" | For cloud environments other than the US public cloud, the environment name (as defined by Azure Python SDK, eg, AzureChinaCloud, AzureUSGovernment), or a metadata discovery endpoint URL (required for Azure Stack). Can also be set via credential file profile or the AZURE_CLOUD_ENVIRONMENT environment variable. | |
| password string | Active Directory user password. Use when authenticating with an Active Directory user rather than service principal. | ||
| profile string | Security profile found in ~/.azure/credentials file. | ||
| record_mode - |
| Whether existing record values not sent to the module should be purged. | |
| record_type - / required |
| The type of record set to create or delete. | |
| records - | List of records to be created depending on the type of record (set). | ||
| entry - | Primary data value for all record types. | ||
| port - | Used for creating an SRV record set/records. | ||
| preference - | Used for creating an MX record set/records. | ||
| priority - | Used for creating an SRV record set/records. | ||
| weight - | Used for creating an SRV record set/records. | ||
| relative_name - / required | Relative name of the record set. | ||
| resource_group - / required | Name of resource group. | ||
| secret string | Azure client secret. Use when authenticating with a Service Principal. | ||
| state - |
| Assert the state of the record set. Use present to create or update and absent to delete. | |
| subscription_id string | Your Azure subscription Id. | ||
| tags dictionary | Dictionary of string:string pairs to assign as metadata to the object. Metadata tags on the object will be updated with any provided values. To remove tags set append_tags option to false. | ||
| tenant string | Azure tenant ID. Use when authenticating with a Service Principal. | ||
| time_to_live - | Default: 3600 | Time to live of the record set in seconds. | |
| zone_name - / required | Name of the existing DNS zone in which to manage the record set. | ||
Note
az login.See also
az login command.- name: ensure an "A" record set with multiple records
azure_rm_dnsrecordset:
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_dnsrecordset:
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_dnsrecordset:
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_dnsrecordset:
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
preference: 10
priority: 20
weight: 10
port: 5060
- name: create PTR record in a new record set
azure_rm_dnsrecordset:
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_dnsrecordset:
resource_group: myResourceGroup
relative_name: mail.testing.com
zone_name: testing.com
record_type: TXT
records:
- entry: 'v=spf1 a -all'
Common return values are documented here, the following are the fields unique to this module:
| Key | Returned | Description | |
|---|---|---|---|
| state complex | always | Current state of the DNS record set. | |
| arecords list | always | A list of records in the record set. Sample: [{'ipv4_address': '192.0.2.2'}, {'ipv4_address': '192.0.2.4'}, {'ipv4_address': '192.0.2.8'}] | |
| etag string | always | The etag of the record set. Sample: 692c3e92-a618-46fc-aecd-8f888807cd6c | |
| fqdn string | always | Fully qualified domain name of the record set. Sample: www.b57dc95985712e4523282.com | |
| id string | always | The DNS record set ID. Sample: /subscriptions/xxxx......xxx/resourceGroups/v-xisuRG/providers/Microsoft.Network/dnszones/b57dc95985712e4523282.com/A/www | |
| name string | always | Relate name of the record set. Sample: www | |
| provisioning_state string | always | The DNS record set state. Sample: Succeeded | |
| target_resource dictionary | always | The target resource of the record set. | |
| ttl integer | always | The TTL(time-to-live) of the records in the records set. Sample: 3600 | |
| type string | always | The type of DNS record in this record set. Sample: A | |
Hint
If you notice any issues in this documentation, you can edit this document to improve it.
© 2012–2018 Michael DeHaan
© 2018–2019 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.9/modules/azure_rm_dnsrecordset_module.html