azure.azcollection.azure_rm_subnet module – Manage Azure subnets
Note
This module is part of the azure.azcollection collection (version 2.7.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
.
New in azure.azcollection 0.1.0
Synopsis
Create, update or delete a subnet within a given virtual network.
Allows setting and updating the address prefix CIDR, which must be valid within the context of the virtual network.
Use the azure.azcollection.azure_rm_networkinterface module to associate interfaces with the subnet and assign specific IP addresses.
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.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. |
|
CIDR defining the IPv4 address space of the subnet. Must be valid within the context of the virtual network. |
|
CIDR defining the IPv4 and IPv6 address space of the subnet. Must be valid within the context of the virtual network. If set address_prefix, It will not set. |
|
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 or Managed Identity (msi). Can also be set via the |
|
For cloud environments other than the US public cloud, the environment name (as defined by Azure Python SDK, eg, Default: |
|
An array of delegations. |
|
A list of actions. Default: |
|
The name of delegation. |
|
The type of the endpoint service. Choices:
|
|
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 Choices:
|
|
Parent argument. |
|
Parent argument. |
|
Name of the subnet. |
|
Existing NAT Gateway with which to associate the subnet. It can be the NAT Gateway name which is in the same resource group. Can be the resource ID of the NAT Gateway. Can be a dict containing the name and resource_group of the NAT Gateway. |
|
Active Directory user password. Use when authenticating with an Active Directory user rather than service principal. |
|
Choices:
|
|
Choices:
|
|
Security profile found in ~/.azure/credentials file. |
|
Name of resource group. |
|
The reference of the RouteTable resource. Can be the name or resource ID of the route table. Can be a dict containing the name and resource_group of the route table. Without this configuration, the associated route table will be dissociate. If there is no associated route table, it has no impact. |
|
Azure client secret. Use when authenticating with a Service Principal. |
|
Existing security group with which to associate the subnet. It can be the security group name which is in the same resource group. Can be the resource ID of the security group. Can be a dict containing the name and resource_group of the security group. |
|
An array of service endpoints. |
|
A list of locations. |
|
The type of the endpoint service. |
|
Assert the state of the subnet. Use Choices:
|
|
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. |
|
Name of an existing virtual network with which the subnet is or will be associated. |
|
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 login
command.
Examples
- name: Create a subnet
azure_rm_subnet:
resource_group: myResourceGroup
virtual_network_name: myVirtualNetwork
name: mySubnet
address_prefix_cidr: "10.1.0.0/24"
- name: Create a subnet refer nsg from other resource group
azure_rm_subnet:
resource_group: myResourceGroup
virtual_network_name: myVirtualNetwork
name: mySubnet
address_prefix_cidr: "10.1.0.0/16"
security_group:
name: secgroupfoo
resource_group: mySecondResourceGroup
route_table: route
- name: Create a subnet with service endpoint
azure_rm_subnet:
resource_group: myResourceGroup
virtual_network_name: myVirtualNetwork
name: mySubnet
address_prefix_cidr: "10.1.0.0/16"
service_endpoints:
- service: "Microsoft.Sql"
locations:
- "eastus"
- name: Create a subnet with delegations
azure_rm_subnet:
resource_group: myResourceGroup
virtual_network_name: myVirtualNetwork
name: mySubnet
address_prefix_cidr: "10.1.0.0/16"
delegations:
- name: 'mydeleg'
serviceName: 'Microsoft.ContainerInstance/containerGroups'
- name: Create a subnet with an associated NAT Gateway
azure_rm_subnet:
resource_group: myResourceGroup
virtual_network_name: myVirtualNetwork
name: mySubnet
address_prefix_cidr: "10.1.0.0/16"
nat_gateway: myNatGateway
- name: Delete a subnet
azure_rm_subnet:
resource_group: myResourceGroup
virtual_network_name: myVirtualNetwork
name: mySubnet
state: absent
Return Values
Common return values are documented here, the following are the fields unique to this module:
Key |
Description |
---|---|
Current state of the subnet. Returned: success |
|
IP address CIDR. Returned: always Sample: |
|
IP address for IPv4 and IPv6 CIDR. 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: |
|
service associated to delegation Returned: when delegation is present Sample: |
|
Subnet resource path. Returned: always Sample: |
|
Subnet name. Returned: always Sample: |
|
Associated network security group of subnets. Returned: always |
|
Security group resource identifier. Returned: always Sample: |
|
Name of the security group. Returned: always Sample: |
|
Returned: always Sample: |
|
Returned: always Sample: |
|
Success or failure of the provisioning event. Returned: always Sample: |