W3cubDocs

/Ansible

azure.azcollection.azure_rm_subnet_info – Get Azure Subnet facts

Note

This plugin is part of the azure.azcollection collection (version 1.10.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.

To use it in a playbook, specify: azure.azcollection.azure_rm_subnet_info.

New in version 0.1.2: of azure.azcollection

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 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 0.0.1 of azure.azcollection
Azure AD authority url. Use when authenticating with Username/password, and has your own ADFS authority.
api_profile
string
added in 0.0.1 of azure.azcollection
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 0.0.1 of azure.azcollection
    Choices:
  • auto ←
  • cli
  • credential_file
  • env
  • msi
Controls the source of the credentials to use for authentication.
Can also be set via the ANSIBLE_AZURE_AUTH_SOURCE environment variable.
When set to auto (the default) the precedence is module parameters -> env -> credential_file -> cli.
When set to env, the credentials will be read from the environment variables
When set to credential_file, it will read the profile from ~/.azure/credentials.
When set to cli, the credentials will be sources from the Azure CLI profile. subscription_id or the environment variable 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 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 0.0.1 of azure.azcollection
    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 0.0.1 of azure.azcollection
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.
log_mode
string
Parent argument.
log_path
string
Parent argument.
name
string
The name of the subnet.
password
string
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.
resource_group
string / required
The name of the resource group.
secret
string
Azure client secret. Use when authenticating with a Service Principal.
subscription_id
string
Your Azure subscription Id.
tenant
string
Azure tenant ID. Use when authenticating with a Service Principal.
virtual_network_name
string / required
The name of the 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 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 Returned Description
subnets
complex
always
A list of dictionaries containing facts for subnet.
address_prefix_cidr
string
always
CIDR defining the IPv4 address space of the subnet.

Sample:
10.1.0.0/16
address_prefixes_cidr
list / elements=string
always
CIDR defining the IPv4 and IPv6 address space of the subnet.

Sample:
['10.2.0.0/24', 'fdda:e69b:1587:495e::/64']
delegations
list / elements=string
always
Associated delegation of subnets
actions
list / elements=string
when delegation is present
list of actions associated with service of delegation

Sample:
['Microsoft.Network/virtualNetworks/subnets/action']
name
string
when delegation is present
name of delegation

Sample:
delegationname
provisioning_state
string
when delegation is present
Provisioning state of delegation.

Sample:
Succeeded
serviceName
string
when delegation is present
service associated to delegation

Sample:
Microsoft.ContainerInstance/containerGroups
id
string
always
Subnet resource ID.

Sample:
/subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/myResourceGroup/providers/Microsoft.Network/virtualNetworks/my VirtualNetwork/subnets/mySubnet
name
string
always
Name of the subnet.

Sample:
mySubnet
private_endpoint_network_policies
string
always
Enabled or Disabled apply network policies on private endpoints in the subnet.

Sample:
Enabled
private_link_service_network_policies
string
always
Enabled or Disabled apply network policies on private link service in the subnet.

Sample:
Disabled
provisioning_state
string
always
Provisioning state.

Sample:
Succeeded
resource_group
string
always
Name of resource group.

Sample:
myResourceGroup
route_table
string
always
Associated route table ID.

Sample:
/subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/myResourceGroup/providers/Microsoft.Network/routeTables/myRouteTable
security_group
string
always
Associated security group ID.

Sample:
/subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/myResourceGroup/providers/Microsoft.Network/networkSecurityGr oups/myNsg
service_endpoints
list / elements=string
when available
List of service endpoints.
locations
list / elements=string
always
A list of location names.

Sample:
['eastus', 'westus']
provisioning_state
string
always
Provisioning state.

Sample:
Succeeded
service
string
always
The type of the endpoint service.

Sample:
Microsoft.Sql
virtual_network_name
string
always
Name of the containing virtual network.

Sample:
myVirtualNetwork


Authors

  • Zim Kalinowski (@zikalino)

© 2012–2018 Michael DeHaan
© 2018–2021 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/latest/collections/azure/azcollection/azure_rm_subnet_info_module.html