azure_rm_virtualnetwork - Manage Azure virtual networks.

New in version 2.1.

Synopsis
- Requirements
Parameters
Notes
Examples
Return Values
Status
- Author

Synopsis

Create, update or delete a virtual networks. Allows setting and updating the available IPv4 address ranges and setting custom DNS servers. Use the azure_rm_subnet module to associate subnets with a virtual network.

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	Default: None	Active Directory username. Use when authenticating with an Active Directory user rather than service principal.
address_prefixes_cidr	Default: None	List of IPv4 address ranges where each is formatted using CIDR notation. Required when creating a new virtual network or using purge_address_prefixes. aliases: address_prefixes
api_profile (added in 2.5)	Choices: latest ←	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.
append_tags	Default: yes	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 (added in 2.5)	Choices: auto ← cli credential_file env	Controls the source of the credentials to use for authentication. `auto` will follow the default precedence of module parameters -> environment variables -> default profile in credential file `~/.azure/credentials`. When set to `cli`, the credentials will be sources from the default Azure CLI profile. Can also be set via the `ANSIBLE_AZURE_AUTH_SOURCE` environment variable.
cert_validation_mode (added in 2.5)	Choices: validate ignore Default: None	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.
client_id	Default: None	Azure client ID. Use when authenticating with a Service Principal.
cloud_environment (added in 2.4)	Default: AzureCloud	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.
dns_servers	Default: None	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 purge_dns_servers option to remove all custom DNS servers and revert to default Azure servers.
location	Default: resource_group location	Valid azure location. Defaults to location of the resource group.
name required		name of the virtual network.
password	Default: None	Active Directory user password. Use when authenticating with an Active Directory user rather than service principal.
profile	Default: None	Security profile found in ~/.azure/credentials file.
purge_address_prefixes	Default: no	Use with state present to remove any existing address_prefixes.
purge_dns_servers	Default: no	Use with state present to remove existing DNS servers, reverting to default Azure servers. Mutually exclusive with dns_servers.
resource_group required		name of resource group.
secret	Default: None	Azure client secret. Use when authenticating with a Service Principal.
state	Choices: absent present ←	Assert the state of the virtual network. Use 'present' to create or update and 'absent' to delete.
subscription_id	Default: None	Your Azure subscription Id.
tags	Default: None	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.
tenant	Default: None	Azure tenant ID. Use when authenticating with a Service Principal.

Notes

Note

For authentication with Azure you can pass parameters, set environment variables or use a profile stored in ~/.azure/credentials. Authentication is 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.

Examples

- name: Create a virtual network
  azure_rm_virtualnetwork:
    name: foobar
    resource_group: Testing
    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:
    name: foobar
    resource_group: Testing
    state: absent

Return Values

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

Key	Returned	Description
state dict	always	Current state of the virtual network. Sample: {'dns_servers': ['127.0.0.1', '127.0.0.3'], 'name': 'my_test_network', 'tags': None, 'provisioning_state': 'Succeeded', 'etag': 'W/"0712e87c-f02f-4bb3-8b9e-2da0390a3886"', 'location': 'eastus', 'type': 'Microsoft.Network/virtualNetworks', 'id': '/subscriptions/XXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXX/resourceGroups/Testing/providers/Microsoft.Network/virtualNetworks/my_test_network', 'address_prefixes': ['10.1.0.0/16', '172.100.0.0/16']}

Status

This module is flagged as preview which means that it is not guaranteed to have a backwards compatible interface.

Author

Chris Houseknecht (@chouseknecht)
Matt Davis (@nitzmahone)

Hint

If you notice any issues in this documentation you can edit this document to improve it.

© 2012–2018 Michael DeHaan
© 2018–2019 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.5/modules/azure_rm_virtualnetwork_module.html