New in version 2.4.
The below requirements are needed on the host that executes this module.
| Parameter | Choices/Defaults | Comments |
|---|---|---|
| ad_user |
Active Directory username. Use when authenticating with an Active Directory user rather than service principal.
|
|
|
api_profile
(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 |
|
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
(added in 2.5) |
|
Controls the source of the credentials to use for authentication.
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
(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 |
Azure client ID. Use when authenticating with a Service Principal.
|
|
|
cloud_environment
(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. |
|
name
required |
name of the DNS Zone.
|
|
| password |
Active Directory user password. Use when authenticating with an Active Directory user rather than service principal.
|
|
| profile |
Security profile found in ~/.azure/credentials file.
|
|
|
resource_group
required |
name of resource group.
|
|
| secret |
Azure client secret. Use when authenticating with a Service Principal.
|
|
| state |
|
Assert the state of the zone. Use 'present' to create or update and 'absent' to delete.
|
| subscription_id |
Your Azure subscription Id.
|
|
| tags |
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 |
Azure tenant ID. Use when authenticating with a Service Principal.
|
Note
- name: Create a DNS zone
azure_rm_dnszone:
resource_group: Testing
name: example.com
state: present
- name: Delete a DNS zone
azure_rm_dnszone:
resource_group: Testing
name: example.com
state: absent
Common return values are documented here, the following are the fields unique to this module:
| Key | Returned | Description |
|---|---|---|
|
state
dict
|
always |
Current state of the zone.
Sample:
{'name_servers': ['ns1-07.azure-dns.com.', 'ns2-07.azure-dns.net.', 'ns3-07.azure-dns.org.', 'ns4-07.azure-dns.info.'], 'location': 'global', 'number_of_record_sets': 2, 'id': '/subscriptions/XXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXX/resourceGroups/Testing', 'name': 'Testing'}
|
This module is flagged as preview which means that it is not guaranteed to have a backwards compatible interface.
Hint
If you notice any issues in this documentation you can edit this document to improve it.