Try SpotterCreate, delete and update Virtual network link for Private DNS zone
| "added in version" 1.6.0 of azure.azcollection"
Authors: Aparna Patil (@techcon65)
Install with ansible-galaxy collection install azure.azcollection:==2.3.0
collections:
- name: azure.azcollection
version: 2.3.0Creates, deletes, and updates Virtual network links for an existing Azure Private DNS Zone.
- name: Create a virtual network link
azure_rm_privatednszonelink:
resource_group: myResourceGroup
name: vnetlink1
zone_name: privatezone.com
virtual_network: MyAzureVNet
state: present
- name: Update virtual network link
azure_rm_privatednszonelink:
resource_group: myResourceGroup
name: vnetlink1
zone_name: privatezone.com
virtual_network: MyAzureVNet
registration_enabled: true
state: present
tags:
key1: "value1"
- name: Delete a virtual network link
azure_rm_privatednszonelink:
resource_group: myResourceGroup
name: vnetlink1
zone_name: privatezone.com
state: absent
name:
description:
- The name of the virtual network link.
required: true
type: str
tags:
description:
- 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.
- Currently, Azure DNS zones and Traffic Manager services also don't allow the use
of spaces in the tag.
- Azure Front Door doesn't support the use of
- Azure Automation and Azure CDN only support 15 tags on resources.
type: dict
state:
choices:
- absent
- present
default: present
description:
- Assert the state of the virtual network link. 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
zone_name:
description:
- The name of the Private DNS zone.
required: true
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
append_tags:
default: true
description:
- 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.
type: bool
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:
- Name of resource group.
required: true
type: str
subscription_id:
description:
- Your Azure subscription Id.
type: str
virtual_network:
description:
- The reference of the virtual network.
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
registration_enabled:
default: false
description:
- Is auto-registration of virtual machine records in the virtual network in the Private
DNS zone enabled
type: bool
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
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:
etag:
description:
- The etag of the virtual network link.
returned: always
sample: 692c3e92-a618-46fc-aecd-8f888807cd6c
type: str
id:
description:
- The Virtual network link ID.
returned: always
sample: /subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/myResourceGroup/providers/
Microsoft.Network/privateDnsZones/privatezone.com/virtualNetworkLinks/vnetlink1
type: str
location:
description:
- The Azure Region where the resource lives.
returned: always
sample: global
type: str
name:
description:
- Virtual network link name.
returned: always
sample: vnetlink1
type: str
provisioning_state:
description:
- The provisioning state of the resource.
returned: always
sample: Succeeded
type: str
registration_enabled:
description:
- The status of auto-registration of virtual machine records in the virtual
network in private DNS zone.
returned: always
sample: true
type: bool
tags:
description:
- Resource tags.
returned: always
sample:
- key1: value1
type: list
virtual_network:
description:
- Reference to virtual network.
returned: always
sample:
id: /subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/myResourceGroup/
providers/Microsoft.Network/virtualNetworks/MyAzureVNet
type: dict
virtual_network_link_state:
description:
- The status of the virtual network link.
returned: always
sample: Completed
type: str
description:
- Current state of the Virtual network link.
returned: always
type: complex