Try SpotterManage Azure Virtual Network Peering
| "added in version" 2.8 of ansible.builtin"
Authors: Yunge Zhu (@yungezz)
preview | supported by community
pipInstall with pip install ansible==2.9.17
Create, update and delete Azure Virtual Network Peering.
- 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
name:
description:
- Name of the virtual network peering.
required: true
state:
choices:
- absent
- present
default: present
description:
- State of the virtual network peering. Use C(present) to create or update a peering
and C(absent) to delete it.
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
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
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 a resource group where the vnet exists.
required: true
subscription_id:
description:
- Your Azure subscription Id.
type: str
virtual_network:
description:
- Name or resource ID of the virtual network to be peered.
required: true
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
use_remote_gateways:
default: false
description:
- If remote gateways can be used on this virtual network.
type: bool
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
allow_gateway_transit:
default: false
description:
- 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.
type: bool
remote_virtual_network:
description:
- 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 I(name) and I(resource_group) of remote virtual
network.
- Required when creating.
allow_forwarded_traffic:
default: false
description:
- Allows forwarded traffic from the VMs in the remote VNet.
type: bool
allow_virtual_network_access:
default: false
description:
- Allows VMs in the remote VNet to access all VMs in the local VNet.
type: bool
id:
description:
- ID of the Azure virtual network peering.
returned: always
sample: /subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/myResourceGroup/providers/Microsoft.Network/virtualNetworks/myVirtualN
etwork/virtualNetworkPeerings/myPeering
type: str