azure_rm_subnet - Manage Azure subnets.¶

New in version 2.1.

Synopsis
- Requirements
Parameters
Notes
Examples
Return Values
Status
- Author

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_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
azure >= 2.0.0

Parameters ¶

Parameter	Choices/Defaults	Comments
ad_user		Active Directory username. Use when authenticating with an Active Directory user rather than service principal.
address_prefix_cidr required		CIDR defining the IPv4 address space of the subnet. Must be valid within the context of the virtual network. aliases: address_prefix
api_profile (added in 2.5)	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 (added in 2.5)	Choices: auto ← cli credential_file env msi	Controls the source of the credentials to use for authentication. `auto` will follow the default precedence of module parameters -> environment variables -> default profile in credential file `~/.azure/credentials`. When set to `cli`, the credentials will be sources from the default Azure CLI profile. Can also be set via the `ANSIBLE_AZURE_AUTH_SOURCE` environment variable. 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 (added in 2.5)	Choices: validate ignore	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		Azure client ID. Use when authenticating with a Service Principal.
cloud_environment (added in 2.4)	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.
name required		Name of the subnet.
password		Active Directory user password. Use when authenticating with an Active Directory user rather than service principal.
profile		Security profile found in ~/.azure/credentials file.
resource_group required		Name of resource group.
secret		Azure client secret. Use when authenticating with a Service Principal.
security_group_name		Name of an existing security group with which to associate the subnet. aliases: security_group
state	Choices: absent present ←	Assert the state of the subnet. Use 'present' to create or update a subnet and 'absent' to delete a subnet.
subscription_id		Your Azure subscription Id.
tenant		Azure tenant ID. Use when authenticating with a Service Principal.
virtual_network_name required		Name of an existing virtual network with which the subnet is or will be associated. aliases: virtual_network

Notes ¶

Note

For authentication with Azure you can pass parameters, set environment variables or use a profile stored in ~/.azure/credentials. Authentication is 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.

Examples ¶

- name: Create a subnet
  azure_rm_subnet:
    name: foobar
    virtual_network_name: My_Virtual_Network
    resource_group: Testing
    address_prefix_cidr: "10.1.0.0/24"

- name: Delete a subnet
  azure_rm_subnet:
    name: foobar
    virtual_network_name: My_Virtual_Network
    resource_group: Testing
    state: absent

Return Values ¶

Common return values are documented here, the following are the fields unique to this module:

Key			Returned	Description
state complex			success	Current state of the subnet.
	id str			Subnet resource path.
	address_prefix str			IP address CIDR.
	network_security_group complex
		id str		Security group resource identifier.
		name str		Name of the security group.
	name str			Subnet name.
	provisioning_state str			Success or failure of the provisioning event.

Status ¶

This module is flagged as preview which means that it is not guaranteed to have a backwards compatible interface.

Author ¶

Chris Houseknecht (@chouseknecht)
Matt Davis (@nitzmahone)

Hint

If you notice any issues in this documentation you can edit this document to improve it.