community.azure.azure_rm_virtualnetworkpeering_info – Get facts of Azure Virtual Network Peering
Note
This plugin is part of the community.azure collection (version 1.1.0).
You might already have this collection installed if you are using the ansible
package.
It is not included in ansible-core
.
To check whether it is installed, run ansible-galaxy collection list
.
To install it, use: ansible-galaxy collection install community.azure
.
To use it in a playbook, specify: community.azure.azure_rm_virtualnetworkpeering_info
.
DEPRECATED
- Removed in
version 2.0.0
- Why
The Ansible collection community.azure is deprecated. Use azure.azcollection instead.
- Alternative
Use azure.azcollection.azure_rm_virtualnetworkpeering_info instead.
Requirements
The below requirements are needed on the host that executes this module.
python >= 2.7
The host that executes this module must have the azure.azcollection collection installed via galaxy
All python packages listed in collection’s requirements-azure.txt must be installed via pip on the host that executes modules from azure.azcollection
Full installation instructions may be found https://galaxy.ansible.com/azure/azcollection
Parameters
Parameter |
Comments |
---|---|
Active Directory username. Use when authenticating with an Active Directory user rather than service principal. |
|
Azure AD authority url. Use when authenticating with Username/password, and has your own ADFS authority. |
|
Selects an API profile to use when communicating with Azure services. Default value of Default: “latest” |
|
Controls the source of the credentials to use for authentication. Can also be set via the When set to When set to When set to When set to When set to The Choices:
|
|
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 Choices:
|
|
Azure client ID. Use when authenticating with a Service Principal. |
|
For cloud environments other than the US public cloud, the environment name (as defined by Azure Python SDK, eg, Default: “AzureCloud” |
|
Parent argument. |
|
Parent argument. |
|
Name of the virtual network peering. |
|
Active Directory user password. Use when authenticating with an Active Directory user rather than service principal. |
|
Security profile found in ~/.azure/credentials file. |
|
Name of a resource group where the vnet exists. |
|
Azure client secret. Use when authenticating with a Service Principal. |
|
Your Azure subscription Id. |
|
Azure tenant ID. Use when authenticating with a Service Principal. |
|
Name or resource ID of a virtual network. |
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: Get virtual network peering by name
community.azure.azure_rm_virtualnetworkpeering_info:
resource_group: myResourceGroup
virtual_network: myVnet1
name: myVnetPeer
- name: List virtual network peering of virtual network
azure_rm_virtualnetworkpeering:
resource_group: myResourceGroup
virtual_network: myVnet1
Return Values
Common return values are documented here, the following are the fields unique to this module:
Key |
Description |
---|---|
A list of Virtual Network Peering facts. Returned: always |
|
Whether forwarded traffic from the VMs in the remote Virtual Network will be allowed/disallowed. Returned: always Sample: false |
|
Whether gateway links can be used in remote Virtual Networking to link to this Virtual Network. Returned: always Sample: false |
|
Whether the VMs in the linked Virtual Network space can access all the VMs in local Virtual Network space. Returned: always Sample: false |
|
ID of current Virtual Network peering. Returned: always Sample: “/subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/myResourceGroup/providers/Microsoft.Network/virtualNetworks/myVnet/virtualNetworkPeerings/peer1” |
|
Name of Virtual Network peering. Returned: always Sample: “myPeering” |
|
The state of the virtual network peering. Returned: always Sample: “Connected” |
|
The provisioning state of the resource. Returned: always Sample: “Succeeded” |
|
The reference of the remote Virtual Network address space. Returned: always |
|
A list of address blocks reserved for this Virtual Network in CIDR notation. Returned: always Sample: “10.1.0.0/16” |
|
ID of remote Virtual Network to be peered to. Returned: always Sample: “/subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/myResourceGroup/providers/Microsoft.Network/virtualNetworks/myVnet2” |
|
Whether remote gateways can be used on this Virtual Network. Returned: always Sample: false |
Status
This module will be removed in version 2.0.0. [deprecated]
For more information see DEPRECATED.
Authors
Yunge Zhu (@yungezz)