azure_rm_dnszone_facts - Get DNS zone facts.
New in version 2.4.
Synopsis
- Get facts for a specific DNS zone or all DNS zones within a resource group.
Requirements (on host that executes module)
- python >= 2.7
- azure >= 2.0.0
Options
| parameter | required | default | choices | comments |
|---|---|---|---|---|
| ad_user | no | Active Directory username. Use when authenticating with an Active Directory user rather than service principal. | ||
| append_tags | no | True | 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. | |
| client_id | no | Azure client ID. Use when authenticating with a Service Principal. | ||
| cloud_environment | no | 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 | no | Only show results for a specific zone. | ||
| password | no | Active Directory user password. Use when authenticating with an Active Directory user rather than service principal. | ||
| profile | no | Security profile found in ~/.azure/credentials file. | ||
| resource_group | no | Limit results by resource group. Required when filtering by name. | ||
| secret | no | Azure client secret. Use when authenticating with a Service Principal. | ||
| subscription_id | no | Your Azure subscription Id. | ||
| tags | no | Limit results by providing a list of tags. Format tags as 'key' or 'key:value'. | ||
| tenant | no | Azure tenant ID. Use when authenticating with a Service Principal. |
Examples
- name: Get facts for one zone
azure_rm_dnszone_facts:
resource_group: Testing
name: foobar22
- name: Get facts for all zones in a resource group
azure_rm_dnszone_facts:
resource_group: Testing
- name: Get facts by tags
azure_rm_dnszone_facts:
tags:
- testing
Return Values
Common return values are documented here Return Values, the following are the fields unique to this module:
| name | description | returned | type | sample |
|---|---|---|---|---|
| azure_dnszones | List of zone dicts. | always | list |
Notes
Note
- For authentication with Azure you can pass parameters, set environment variables or use a profile stored in ~/.azure/credentials. Authentication is possible using a service principal or Active Directory user. To authenticate via service principal, pass subscription_id, client_id, secret and tenant or set environment variables AZURE_SUBSCRIPTION_ID, AZURE_CLIENT_ID, AZURE_SECRET and AZURE_TENANT.
- To authenticate via Active Directory user, pass ad_user and password, or set AZURE_AD_USER and AZURE_PASSWORD in the environment.
- Alternatively, credentials can be stored in ~/.azure/credentials. This is an ini file containing a [default] section and the following keys: subscription_id, client_id, secret and tenant or subscription_id, ad_user and password. It is also possible to add additional profiles. Specify the profile by passing profile or setting AZURE_PROFILE in the environment.
Status
This module is flagged as preview which means that it is not guaranteed to have a backwards compatible interface.
For help in developing on modules, should you be so inclined, please read Community Information & Contributing, Testing Ansible and Developing Modules.
© 2012–2018 Michael DeHaan
© 2018–2019 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.4/azure_rm_dnszone_facts_module.html