You are reading an unmaintained version of the Ansible documentation. Unmaintained Ansible versions can contain unfixed security vulnerabilities (CVE). Please upgrade to a maintained version. See the latest Ansible documentation.

azure.azcollection.azure_rm_privateendpointdnszonegroup module – Create, update, or manage private endpoint DNS zone groups.

Note

This module is part of the azure.azcollection collection (version 1.13.0).

You might already have this collection installed if you are using the ansible package. It is not included in ansible-core. To check whether it is installed, run ansible-galaxy collection list.

To install it, use: ansible-galaxy collection install azure.azcollection.

To use it in a playbook, specify: azure.azcollection.azure_rm_privateendpointdnszonegroup.

New in version 1.10.0: of azure.azcollection

Synopsis

• Create, update, or manage private endpoint DNS zone groups.

Requirements

The below requirements are needed on the host that executes this module.

• python >= 2.7

• The host that executes this module must have the azure.azcollection collection installed via galaxy

• All python packages listed in collection’s requirements-azure.txt must be installed via pip on the host that executes modules from azure.azcollection

• Full installation instructions may be found https://galaxy.ansible.com/azure/azcollection

Parameters

Parameter	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	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. Default: “latest”
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 ANSIBLE_AZURE_AUTH_SOURCE environment variable. When set to auto (the default) the precedence is module parameters -> env -> credential_file -> cli. When set to env, the credentials will be read from the environment variables When set to credential_file, it will read the profile from ~/.azure/credentials. When set to cli, the credentials will be sources from the Azure CLI profile. subscription_id or the environment variable AZURE_SUBSCRIPTION_ID can be used to identify the subscription ID if more than one is present otherwise the default az cli subscription is used. 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. Choices: auto ← (default) cli credential_file env msi
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 ignore. Can also be set via credential file profile or the AZURE_CERT_VALIDATION environment variable. Choices: ignore validate
client_id string	Azure client ID. Use when authenticating with a Service Principal.
cloud_environment string added in 0.0.1 of azure.azcollection	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. Default: “AzureCloud”
log_mode string	Parent argument.
log_path string	Parent argument.
name string / required	The name of the private endpoint DNS zone group.
password string	Active Directory user password. Use when authenticating with an Active Directory user rather than service principal.
private_dns_zone_configs list / elements=dictionary	The Private DNS zones configurations.
name string	The name of the private dns zone configs.
private_dns_zone string	The name of the Private DNS zone. If set, the Private DNS Zone under the current resource group is obtained.
private_dns_zone_id string	The ID of the private dns zone. If set, gets the value of the specified connection Private DNS Zone.
private_endpoint string / required	Name of private endpoint.
profile string	Security profile found in ~/.azure/credentials file.
resource_group string / required	Resource group of the private endpoint.
secret string	Azure client secret. Use when authenticating with a Service Principal.
state string	State of the private endpoint DNS zone group. Use present to create or update and absent to delete. Choices: absent present ← (default)
subscription_id string	Your Azure subscription Id.
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

See also

Sign in with Azure CLI

How to authenticate using the az login command.

Examples

- name: Create zone group for private endpoint
  azure_rm_privateendpointdnszonegroup:
    name: "my-zone-group"
    private_endpoint: "my-private-endpoint"
    resource_group: "my-resource-group"
    private_dns_zone_configs:
      - name: "default"
        private_dns_zone: "privatelink.postgres.database.azure.com"

- name: Create zone group for private endpoint
  azure_rm_privateendpointdnszonegroup:
    name: "my-zone-group"
    private_endpoint: "my-private-endpoint"
    resource_group: "my-resource-group"
    state: "absent"

Return Values

Common return values are documented here, the following are the fields unique to this module:

Key	Description
state complex	Current state of the private endpoint zone group. Returned: always
id string	Resource ID of the private endpoint zone group. Returned: always Sample: “/subscriptions/xxx/resourceGroups/myResourceGroup/providers/Microsoft.Network/privateEndpoints/ myPrivateEndpoint/privateDnsZoneGroups/myZoneGroup”
name string	Name of the private endpoint zone group. Returned: always Sample: “myZoneGroup”
private_dns_zone_configs list / elements=string	List of zone configuration within the zone group. Returned: always
name string	Name of the zone config. Returned: always Sample: “default”
private_dns_zone_id string	ID of the private DNS zone. Returned: always Sample: “/subscriptions/xxx/resourceGroups/myResourceGroup/providers/Microsoft.Network/ privateDnsZones/privatelink.postgres.database.azure.com”
record_sets list / elements=string	List of DNS records for zone. Returned: always
fqdn string	Fully qualified domain name of the record. Returned: always Sample: “myPostgreSqlSrv-123.privatelink.postgres.database.azure.com”
ip_addresses list / elements=string	IP addresses for the record. Returned: always Sample: [“10.1.0.4”]
provisioning_state string	Provisioning state of the resource. Returned: always Sample: “Succeeded”
record_set_name string	Name of the record. Returned: always Sample: “myPostgreSqlSrv-123”
record_type string	Type of record. Returned: always Sample: “A”
ttl integer	Time to live value of the record. Returned: always Sample: 10
provisioning_state string	Provisioning state of the resource. Returned: always Sample: “Succeeded”

Authors

• Ross Bender (@l3ender)

Collection links

Issue Tracker Homepage Repository (Sources)