azure / azure.azcollection / 2.3.0 / module / azure_rm_privateendpointdnszonegroup Create, update, or manage private endpoint DNS zone groups. | "added in version" 1.10.0 of azure.azcollection" Authors: Ross Bender (@l3ender)azure.azcollection.azure_rm_privateendpointdnszonegroup (2.3.0) — module
Install with ansible-galaxy collection install azure.azcollection:==2.3.0
collections: - name: azure.azcollection version: 2.3.0
Create, update, or manage private endpoint DNS zone groups.
- 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"
name: description: - The name of the private endpoint DNS zone group. required: true type: str state: choices: - absent - present default: present description: - State of the private endpoint DNS zone group. Use C(present) to create or update and C(absent) to delete. type: str secret: description: - Azure client secret. Use when authenticating with a Service Principal. type: str tenant: description: - Azure tenant ID. Use when authenticating with a Service Principal. type: str ad_user: description: - Active Directory username. Use when authenticating with an Active Directory user rather than service principal. type: str profile: description: - Security profile found in ~/.azure/credentials file. type: str log_mode: description: - Parent argument. type: str log_path: description: - Parent argument. type: str password: description: - Active Directory user password. Use when authenticating with an Active Directory user rather than service principal. type: str client_id: description: - Azure client ID. Use when authenticating with a Service Principal or Managed Identity (msi). - Can also be set via the C(AZURE_CLIENT_ID) environment variable. type: str thumbprint: description: - The thumbprint of the private key specified in I(x509_certificate_path). - Use when authenticating with a Service Principal. - Required if I(x509_certificate_path) is defined. type: str version_added: 1.14.0 version_added_collection: azure.azcollection api_profile: default: latest description: - Selects an API profile to use when communicating with Azure services. Default value of C(latest) is appropriate for public clouds; future values will allow use with Azure Stack. type: str version_added: 0.0.1 version_added_collection: azure.azcollection auth_source: choices: - auto - cli - credential_file - env - msi default: auto description: - Controls the source of the credentials to use for authentication. - Can also be set via the C(ANSIBLE_AZURE_AUTH_SOURCE) environment variable. - When set to C(auto) (the default) the precedence is module parameters -> C(env) -> C(credential_file) -> C(cli). - When set to C(env), the credentials will be read from the environment variables - When set to C(credential_file), it will read the profile from C(~/.azure/credentials). - When set to C(cli), the credentials will be sources from the Azure CLI profile. C(subscription_id) or the environment variable C(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 C(msi), the host machine must be an azure resource with an enabled MSI extension. C(subscription_id) or the environment variable C(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 C(msi) was added in Ansible 2.6. type: str version_added: 0.0.1 version_added_collection: azure.azcollection resource_group: description: - Resource group of the private endpoint. required: true type: str subscription_id: description: - Your Azure subscription Id. type: str private_endpoint: description: - Name of private endpoint. required: true type: str cloud_environment: default: AzureCloud description: - For cloud environments other than the US public cloud, the environment name (as defined by Azure Python SDK, eg, C(AzureChinaCloud), C(AzureUSGovernment)), or a metadata discovery endpoint URL (required for Azure Stack). Can also be set via credential file profile or the C(AZURE_CLOUD_ENVIRONMENT) environment variable. type: str version_added: 0.0.1 version_added_collection: azure.azcollection adfs_authority_url: description: - Azure AD authority url. Use when authenticating with Username/password, and has your own ADFS authority. type: str version_added: 0.0.1 version_added_collection: azure.azcollection cert_validation_mode: choices: - ignore - validate description: - 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 C(ignore). Can also be set via credential file profile or the C(AZURE_CERT_VALIDATION) environment variable. type: str version_added: 0.0.1 version_added_collection: azure.azcollection x509_certificate_path: description: - Path to the X509 certificate used to create the service principal in PEM format. - The certificate must be appended to the private key. - Use when authenticating with a Service Principal. type: path version_added: 1.14.0 version_added_collection: azure.azcollection private_dns_zone_configs: description: - The Private DNS zones configurations. elements: dict suboptions: name: description: - The name of the private dns zone configs. type: str private_dns_zone: description: - The name of the Private DNS zone. - If set, the Private DNS Zone under the current resource group is obtained. type: str private_dns_zone_id: description: - The ID of the private dns zone. - If set, gets the value of the specified connection Private DNS Zone. type: str type: list disable_instance_discovery: default: false description: - Determines whether or not instance discovery is performed when attempting to authenticate. Setting this to true will completely disable both instance discovery and authority validation. This functionality is intended for use in scenarios where the metadata endpoint cannot be reached such as in private clouds or Azure Stack. The process of instance discovery entails retrieving authority metadata from https://login.microsoft.com/ to validate the authority. By setting this to **True**, the validation of the authority is disabled. As a result, it is crucial to ensure that the configured authority host is valid and trustworthy. - Set via credential file profile or the C(AZURE_DISABLE_INSTANCE_DISCOVERY) environment variable. type: bool version_added: 2.3.0 version_added_collection: azure.azcollection
state: contains: id: description: - Resource ID of the private endpoint zone group. returned: always sample: /subscriptions/xxx/resourceGroups/myResourceGroup/providers/Microsoft.Network/privateEndpoints/ myPrivateEndpoint/privateDnsZoneGroups/myZoneGroup type: str name: description: - Name of the private endpoint zone group. returned: always sample: myZoneGroup type: str private_dns_zone_configs: contains: name: description: - Name of the zone config. returned: always sample: default type: str private_dns_zone_id: description: - ID of the private DNS zone. returned: always sample: /subscriptions/xxx/resourceGroups/myResourceGroup/providers/Microsoft.Network/ privateDnsZones/privatelink.postgres.database.azure.com type: str record_sets: contains: fqdn: description: - Fully qualified domain name of the record. returned: always sample: myPostgreSqlSrv-123.privatelink.postgres.database.azure.com type: str ip_addresses: description: - IP addresses for the record. returned: always sample: - 10.1.0.4 type: list provisioning_state: description: - Provisioning state of the resource. returned: always sample: Succeeded type: str record_set_name: description: - Name of the record. returned: always sample: myPostgreSqlSrv-123 type: str record_type: description: - Type of record. returned: always sample: A type: str ttl: description: - Time to live value of the record. returned: always sample: 10 type: int description: - List of DNS records for zone. returned: always type: list description: - List of zone configuration within the zone group. returned: always type: list provisioning_state: description: - Provisioning state of the resource. returned: always sample: Succeeded type: str description: - Current state of the private endpoint zone group. returned: always type: complex