azure.azcollection.azure_rm_subnet_info module – Get Azure Subnet facts
Note
This module is part of the azure.azcollection collection (version 1.19.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 azure.azcollection.
You need further requirements to be able to use this module,
see Requirements for details.
To use it in a playbook, specify: azure.azcollection.azure_rm_subnet_info.
New in azure.azcollection 0.1.2
Synopsis
Get facts of Azure Subnet.
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: |
|
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: |
|
Parent argument. |
|
Parent argument. |
|
The name of the subnet. |
|
Active Directory user password. Use when authenticating with an Active Directory user rather than service principal. |
|
Security profile found in ~/.azure/credentials file. |
|
The name of the resource group. |
|
Azure client secret. Use when authenticating with a Service Principal. |
|
Your Azure subscription Id. |
|
Azure tenant ID. Use when authenticating with a Service Principal. |
|
The thumbprint of the private key specified in x509_certificate_path. Use when authenticating with a Service Principal. Required if x509_certificate_path is defined. |
|
The name of the virtual network. |
|
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. |
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 logincommand.
Examples
- name: Get facts of specific subnet
azure_rm_subnet_info:
resource_group: myResourceGroup
virtual_network_name: myVirtualNetwork
name: mySubnet
- name: List facts for all subnets in virtual network
azure_rm_subnet_info:
resource_group: myResourceGroup
virtual_network_name: myVirtualNetwork
name: mySubnet
Return Values
Common return values are documented here, the following are the fields unique to this module:
Key |
Description |
|---|---|
A list of dictionaries containing facts for subnet. Returned: always |
|
CIDR defining the IPv4 address space of the subnet. Returned: always Sample: |
|
CIDR defining the IPv4 and IPv6 address space of the subnet. Returned: always Sample: |
|
Associated delegation of subnets Returned: always |
|
list of actions associated with service of delegation Returned: when delegation is present Sample: |
|
name of delegation Returned: when delegation is present Sample: |
|
Provisioning state of delegation. Returned: when delegation is present Sample: |
|
service associated to delegation Returned: when delegation is present Sample: |
|
Subnet resource ID. Returned: always Sample: |
|
Name of the subnet. Returned: always Sample: |
|
ID of the associated NAT Gateway. Returned: when available Sample: |
|
Returned: always Sample: |
|
Returned: always Sample: |
|
Provisioning state. Returned: always Sample: |
|
Name of resource group. Returned: always Sample: |
|
Associated route table ID. Returned: always Sample: |
|
Associated security group ID. Returned: always Sample: |
|
List of service endpoints. Returned: when available |
|
A list of location names. Returned: always Sample: |
|
Provisioning state. Returned: always Sample: |
|
The type of the endpoint service. Returned: always Sample: |
|
Name of the containing virtual network. Returned: always Sample: |