azure.azcollection.azure_rm_subnet – Manage Azure subnets

Note

This plugin is part of the azure.azcollection collection (version 1.5.0).

To install it use: ansible-galaxy collection install azure.azcollection.

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

New in version 0.1.0: of azure.azcollection

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
string
Active Directory username. Use when authenticating with an Active Directory user rather than service principal.
address_prefix_cidr
string
CIDR defining the IPv4 address space of the subnet. Must be valid within the context of the virtual network.

aliases: address_prefix
address_prefixes_cidr
list / elements=string
added in 1.0.0 of azure.azcollection
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.

aliases: address_prefixes
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.
delegations
list / elements=string
An array of delegations.
actions
list / elements=string
A list of actions.
name
string / required
The name of delegation.
serviceName
string / required
    Choices:
  • Microsoft.Web/serverFarms
  • Microsoft.ContainerInstance/containerGroups
  • Microsoft.Netapp/volumes
  • Microsoft.HardwareSecurityModules/dedicatedHSMs
  • Microsoft.ServiceFabricMesh/networks
  • Microsoft.Logic/integrationServiceEnvironments
  • Microsoft.Batch/batchAccounts
  • Microsoft.Sql/managedInstances
  • Microsoft.Web/hostingEnvironments
  • Microsoft.BareMetal/CrayServers
  • Microsoft.BareMetal/MonitoringServers
  • Microsoft.Databricks/workspaces
  • Microsoft.BareMetal/AzureHostedService
  • Microsoft.BareMetal/AzureVMware
  • Microsoft.BareMetal/AzureHPC
  • Microsoft.BareMetal/AzurePaymentHSM
  • Microsoft.StreamAnalytics/streamingJobs
  • Microsoft.DBforPostgreSQL/serversv2
  • Microsoft.AzureCosmosDB/clusters
  • Microsoft.MachineLearningServices/workspaces
  • Microsoft.DBforPostgreSQL/singleServers
  • Microsoft.DBforPostgreSQL/flexibleServers
  • Microsoft.DBforMySQL/serversv2
  • Microsoft.DBforMySQL/flexibleServers
  • Microsoft.ApiManagement/service
  • Microsoft.Synapse/workspaces
  • Microsoft.PowerPlatform/vnetaccesslinks
  • Microsoft.Network/managedResolvers
  • Microsoft.Kusto/clusters
The type of the endpoint service.
name
string / required
Name of the subnet.
password
string
Active Directory user password. Use when authenticating with an Active Directory user rather than service principal.
private_endpoint_network_policies
string
    Choices:
  • Enabled ←
  • Disabled
Enabled or Disabled apply network policies on private endpoints in the subnet.
private_link_service_network_policies
string
    Choices:
  • Enabled ←
  • Disabled
Enabled or Disabled apply network policies on private link service in the subnet.
profile
string
Security profile found in ~/.azure/credentials file.
resource_group
string / required
Name of resource group.
route_table
string
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.
secret
string
Azure client secret. Use when authenticating with a Service Principal.
security_group
string
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.

aliases: security_group_name
service_endpoints
list / elements=string
An array of service endpoints.
locations
list / elements=string
A list of locations.
service
string / required
The type of the endpoint service.
state
string
    Choices:
  • absent
  • present ←
Assert the state of the subnet. Use present to create or update a subnet and use absent to delete a subnet.
subscription_id
string
Your Azure subscription Id.
tenant
string
Azure tenant ID. Use when authenticating with a Service Principal.
virtual_network_name
string / 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, 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: 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 Returned Description
state
complex
success
Current state of the subnet.
 
address_prefix
string
always
IP address CIDR.

Sample:
10.1.0.0/16
 
address_prefixes
list / elements=string
always
IP address for IPv4 and IPv6 CIDR.

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
   
serviceName
string
when delegation is present
service associated to delegation

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

Sample:
/subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroup/myResourceGroup/providers/Microsoft.Network/virtualNetworks/myVirtualNetwork/subnets/mySubnet
 
name
string
always
Subnet name.

Sample:
foobar
 
network_security_group
complex
always
Associated network security group of subnets.
   
id
string
always
Security group resource identifier.

Sample:
/subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroup/myResourceGroup/providers/Microsoft.Network/networkSecurityGroups/secgroupfoo
   
name
string
always
Name of the security group.

Sample:
secgroupfoo
 
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
Success or failure of the provisioning event.

Sample:
Succeeded


Authors

  • Chris Houseknecht (@chouseknecht)

  • Matt Davis (@nitzmahone)