azure_rm_virtualnetworkpeering – Manage Azure Virtual Network Peering

New in version 2.8.

Synopsis

  • Create, update and delete Azure Virtual Network Peering.

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
string
Active Directory username. Use when authenticating with an Active Directory user rather than service principal.
adfs_authority_url
string
added in 2.6
Azure AD authority url. Use when authenticating with Username/password, and has your own ADFS authority.
allow_forwarded_traffic
boolean
    Choices:
  • no ←
  • yes
Allows forwarded traffic from the VMs in the remote VNet.
allow_gateway_transit
boolean
    Choices:
  • no ←
  • yes
Allows VNet to use the remote VNet's gateway. Remote VNet gateway must have --allow-gateway-transit enabled for remote peering.
Only 1 peering can have this flag enabled. Cannot be set if the VNet already has a gateway.
allow_virtual_network_access
boolean
    Choices:
  • no ←
  • yes
Allows VMs in the remote VNet to access all VMs in the local VNet.
api_profile
string
added in 2.5
Default:
"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.
auth_source
string
added in 2.5
    Choices:
  • auto
  • cli
  • credential_file
  • env
  • msi
Controls the source of the credentials to use for authentication.
If not specified, ANSIBLE_AZURE_AUTH_SOURCE environment variable will be used and default to auto if variable is not defined.
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.
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.
cert_validation_mode
string
added in 2.5
    Choices:
  • ignore
  • validate
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
string
Azure client ID. Use when authenticating with a Service Principal.
cloud_environment
string
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.
name
- / required
Name of the virtual network peering.
password
-
Active Directory user password. Use when authenticating with an Active Directory user rather than service principal.
profile
string
Security profile found in ~/.azure/credentials file.
remote_virtual_network
-
Remote virtual network to be peered.
It can be name of remote virtual network in same resource group.
It can be remote virtual network resource id.
It can be a dict which contains name and resource_group of remote virtual network.
Required when creating
resource_group
- / required
Name of a resource group where the vnet exists.
secret
string
Azure client secret. Use when authenticating with a Service Principal.
state
-
    Choices:
  • absent
  • present ←
Assert the state of the virtual network peering. Use present to create or update a peering and absent to delete it.
subscription_id
string
Your Azure subscription Id.
tenant
string
Azure tenant ID. Use when authenticating with a Service Principal.
use_remote_gateways
boolean
    Choices:
  • no ←
  • yes
If remote gateways can be used on this virtual network.
virtual_network
- / required
Virtual network to be peered.
It can be name of virtual network.
It can be virtual network resource id.

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 virtual network peering
  azure_rm_virtualnetworkpeering:
    resource_group: myResourceGroup
    virtual_network: myVirtualNetwork
    name: myPeering
    remote_virtual_network:
      resource_group: mySecondResourceGroup
      name: myRemoteVirtualNetwork
    allow_virtual_network_access: false
    allow_forwarded_traffic: true

- name: Delete the virtual network peering
  azure_rm_virtualnetworkpeering:
    resource_group: myResourceGroup
    virtual_network: myVirtualNetwork
    name: myPeering
    state: absent

Return Values

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

Key Returned Description
id
dictionary
always
Id of the Azure virtual network peering



Status

Authors

  • Yunge Zhu (@yungezz)

Hint

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