ansible / ansible.builtin / v2.9.17 / module / azure_rm_virtualnetwork Manage Azure virtual networks | "added in version" 2.1 of ansible.builtin" Authors: Chris Houseknecht (@chouseknecht), Matt Davis (@nitzmahone) preview | supported by communityansible.builtin.azure_rm_virtualnetwork (v2.9.17) — module
pip
Install with pip install ansible==2.9.17
Create, update or delete a virtual networks. Allows setting and updating the available IPv4 address ranges and setting custom DNS servers. Use the M(azure_rm_subnet) module to associate subnets with a virtual network.
- name: Create a virtual network azure_rm_virtualnetwork: resource_group: myResourceGroup name: myVirtualNetwork address_prefixes_cidr: - "10.1.0.0/16" - "172.100.0.0/16" dns_servers: - "127.0.0.1" - "127.0.0.2" tags: testing: testing delete: on-exit
- name: Delete a virtual network azure_rm_virtualnetwork: resource_group: myResourceGroup name: myVirtualNetwork state: absent
name: description: - Name of the virtual network. required: true 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. type: dict state: choices: - absent - present default: present description: - State of the virtual network. Use C(present) to create or update and C(absent) to delete. 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 location: description: - Valid Azure location. Defaults to location of the resource group. 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. type: str 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 dns_servers: description: - Custom list of DNS servers. Maximum length of two. - The first server in the list will be treated as the Primary server. This is an explicit list. - Existing DNS servers will be replaced with the specified list. - Use the I(purge_dns_servers) option to remove all custom DNS servers and revert to default Azure servers. resource_group: description: - Name of resource group. required: true subscription_id: description: - Your Azure subscription Id. 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 purge_dns_servers: default: 'no' description: - Use with I(state=present) to remove existing DNS servers, reverting to default Azure servers. Mutually exclusive with DNS servers. type: bool 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 address_prefixes_cidr: aliases: - address_prefixes description: - List of IPv4 address ranges where each is formatted using CIDR notation. - Required when creating a new virtual network or using I(purge_address_prefixes). purge_address_prefixes: aliases: - purge default: 'no' description: - Use with I(state=present) to remove any existing I(address_prefixes). type: bool
state: contains: address_prefixes: description: - The virtual network IPv4 address ranges. returned: always sample: - 10.1.0.0/16 - 172.100.0.0/16 type: list dns_servers: description: - DNS servers. returned: always sample: - 127.0.0.1 - 127.0.0.3 type: list etag: description: - A unique read-only string that changes whenever the resource is update. returned: always sample: W/"0712e87c-f02f-4bb3-8b9e-2da0390a3886" type: str id: description: - Resource ID. returned: always sample: /subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroup/myResourceGroup/providers/ Microsoft.Network/virtualNetworks/myVirtualNetwork type: str location: description: - The Geo-location where the resource lives. returned: always sample: eastus type: str name: description: - Resource name. returned: always sample: my_test_network type: str provisioning_state: description: - Provisioning state of the virtual network. returned: always sample: Succeeded type: str tags: description: - Resource tags, such as { 'tags1':'value1' } returned: always sample: key1: value1 type: dict type: description: - Resource type. returned: always sample: Microsoft.Network/virtualNetworks type: str description: - Current state of the virtual network. returned: always type: complex