Try SpotterGet facts of Azure Virtual Network Peering
| "added in version" 0.0.1 of azure.azcollection"
Authors: Yunge Zhu (@yungezz)
Install with ansible-galaxy collection install azure.azcollection:==2.3.0
collections:
- name: azure.azcollection
version: 2.3.0Get facts of Azure Virtual Network Peering.
- name: Get virtual network peering by name
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
name:
description:
- Name of the virtual network peering.
type: str
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
log_mode:
description:
- Parent argument.
type: str
log_path:
description:
- Parent argument.
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 or Managed Identity
(msi).
- Can also be set via the C(AZURE_CLIENT_ID) environment variable.
type: str
thumbprint:
description:
- The thumbprint of the private key specified in I(x509_certificate_path).
- Use when authenticating with a Service Principal.
- Required if I(x509_certificate_path) is defined.
type: str
version_added: 1.14.0
version_added_collection: azure.azcollection
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
type: str
subscription_id:
description:
- Your Azure subscription Id.
type: str
virtual_network:
description:
- Name or resource ID of a virtual network.
required: true
type: raw
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
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
x509_certificate_path:
description:
- Path to the X509 certificate used to create the service principal in PEM format.
- The certificate must be appended to the private key.
- Use when authenticating with a Service Principal.
type: path
version_added: 1.14.0
version_added_collection: azure.azcollection
disable_instance_discovery:
default: false
description:
- Determines whether or not instance discovery is performed when attempting to authenticate.
Setting this to true will completely disable both instance discovery and authority
validation. This functionality is intended for use in scenarios where the metadata
endpoint cannot be reached such as in private clouds or Azure Stack. The process
of instance discovery entails retrieving authority metadata from https://login.microsoft.com/
to validate the authority. By setting this to **True**, the validation of the authority
is disabled. As a result, it is crucial to ensure that the configured authority
host is valid and trustworthy.
- Set via credential file profile or the C(AZURE_DISABLE_INSTANCE_DISCOVERY) environment
variable.
type: bool
version_added: 2.3.0
version_added_collection: azure.azcollection
vnetpeerings:
contains:
allow_forwarded_traffic:
description:
- Whether forwarded traffic from the VMs in the remote Virtual Network will
be allowed/disallowed.
returned: always
sample: false
type: bool
allow_gateway_transit:
description:
- Whether gateway links can be used in remote Virtual Networking to link to
this Virtual Network.
returned: always
sample: false
type: bool
allow_virtual_network_access:
description:
- Whether the VMs in the linked Virtual Network space can access all the VMs
in local Virtual Network space.
returned: always
sample: false
type: bool
id:
description: ID of current Virtual Network peering.
returned: always
sample: /subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/myResourceGroup/providers/Microsoft.Network/virtualNetworks/myVnet/virtualNetworkPeerings/peer1
type: str
name:
description:
- Name of Virtual Network peering.
returned: always
sample: myPeering
type: str
peering_state:
description:
- The state of the virtual network peering.
returned: always
sample: Connected
type: str
peering_sync_level:
description:
- The Sync Level of the Peering
returned: always
sample: FullyInSync
type: str
provisioning_state:
description:
- The provisioning state of the resource.
returned: always
sample: Succeeded
type: str
remote_address_space:
contains:
address_prefixes:
description:
- A list of address blocks reserved for this Virtual Network in CIDR notation.
returned: always
sample: 10.1.0.0/16
type: list
description:
- The reference of the remote Virtual Network address space.
returned: always
type: complex
remote_virtual_network:
description:
- 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
type: str
use_remote_gateways:
description:
- Whether remote gateways can be used on this Virtual Network.
returned: always
sample: false
type: bool
description:
- A list of Virtual Network Peering facts.
returned: always
type: complex