community.azure.azure_rm_dnszone_info – Get DNS zone facts
community.azure.azure_rm_dnszone_info – Get DNS zone facts
Note
This plugin is part of the community.azure collection (version 1.0.0).
To install it use: ansible-galaxy collection install community.azure
.
To use it in a playbook, specify: community.azure.azure_rm_dnszone_info
.
Synopsis
- Get facts for a specific DNS zone or all DNS zones within a resource group.
Requirements
The below requirements are needed on the host that executes this module.
- python >= 2.7
- azure >= 2.0.0
Parameters
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 0.0.1 of azure.azcollection |
Azure AD authority url. Use when authenticating with Username/password, and has your own ADFS authority. | |
api_profile string added in 0.0.1 of azure.azcollection |
Default: "latest" |
Selects an API profile to use when communicating with Azure services. Default value of |
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 0.0.1 of azure.azcollection |
|
Controls the source of the credentials to use for authentication. Can also be set via the When set to When set to When set to When set to When set to The |
cert_validation_mode string added in 0.0.1 of azure.azcollection |
|
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 |
client_id string |
Azure client ID. Use when authenticating with a Service Principal. | |
cloud_environment string added in 0.0.1 of azure.azcollection |
Default: "AzureCloud" |
For cloud environments other than the US public cloud, the environment name (as defined by Azure Python SDK, eg, |
name string |
Only show results for a specific zone. | |
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. | |
resource_group string |
Limit results by resource group. Required when filtering by name. | |
secret string |
Azure client secret. Use when authenticating with a Service Principal. | |
subscription_id string |
Your Azure subscription Id. | |
tags dictionary |
Limit results by providing a list of tags. Format tags as 'key' or 'key:value'. | |
tenant string |
Azure tenant ID. Use when authenticating with a Service Principal. |
Notes
Note
- For authentication with Azure you can pass parameters, set environment variables, use a profile stored in ~/.azure/credentials, or log in before you run your tasks or playbook with
az login
. - Authentication is also 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.
See Also
Examples
- name: Get facts for one zone
community.azure.azure_rm_dnszone_info:
resource_group: myResourceGroup
name: foobar22
- name: Get facts for all zones in a resource group
community.azure.azure_rm_dnszone_info:
resource_group: myResourceGroup
- name: Get facts by tags
community.azure.azure_rm_dnszone_info:
tags:
- testing
Return Values
Common return values are documented here, the following are the fields unique to this module:
Key | Returned | Description | |
---|---|---|---|
azure_dnszones list / elements=string |
always |
List of zone dicts.
Sample: [{'etag': '00000002-0000-0000-0dcb-df5776efd201', 'location': 'global', 'properties': {'maxNumberOfRecordSets': 5000, 'numberOfRecordSets': 15}, 'tags': {}}] | |
dnszones list / elements=string |
always |
List of zone dicts, which share the same layout as azure_rm_dnszone module parameter.
| |
id string |
success |
id of the DNS Zone.
Sample: /subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/myResourceGroup/providers/Microsoft.Network/dnszones/azure.com | |
max_number_of_record_sets integer |
success |
The maximum number of record sets that can be created in this DNS zone.
Sample: 5000 | |
name string |
success |
name of the DNS zone.
Sample: azure.com | |
name_servers list / elements=string |
success |
The name servers for this DNS zone.
Sample: ['ns1-03.azure-dns.com.', 'ns2-03.azure-dns.net.', 'ns3-03.azure-dns.org.', 'ns4-03.azure-dns.info.'] | |
number_of_record_sets integer |
success |
The current number of record sets in this DNS zone.
Sample: 2 | |
registration_virtual_networks list / elements=string |
success |
A list of references to virtual networks that register hostnames in this DNS zone.
Sample: ['/subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/myResourceGroup/providers/Microsoft.Network/virtualNetworks/bar'] | |
resolution_virtual_networks list / elements=string |
success |
A list of references to virtual networks that resolve records in this DNS zone.
Sample: ['/subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/myResourceGroup/providers/Microsoft.Network/virtualNetworks/deadbeef'] | |
type string |
success |
The type of this DNS zone (
Sample: private |
Authors
- Obezimnaka Boms (@ozboms)
© 2012–2018 Michael DeHaan
© 2018–2019 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.10/collections/community/azure/azure_rm_dnszone_info_module.html