azure.azcollection.azure_rm_subnet module – Manage Azure subnets

Note

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

ad_user

string

Active Directory username. Use when authenticating with an Active Directory user rather than service principal.

address_prefix_cidr

aliases: address_prefix

string

CIDR defining the IPv4 address space of the subnet. Must be valid within the context of the virtual network.

address_prefixes_cidr

aliases: address_prefixes

list / elements=string

added in azure.azcollection 1.0.0

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.

adfs_authority_url

string

added in azure.azcollection 0.0.1

Azure AD authority url. Use when authenticating with Username/password, and has your own ADFS authority.

api_profile

string

added in azure.azcollection 0.0.1

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.

Default: "latest"

auth_source

string

added in azure.azcollection 0.0.1

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.

Choices:

  • "auto" ← (default)

  • "cli"

  • "credential_file"

  • "env"

  • "msi"

cert_validation_mode

string

added in azure.azcollection 0.0.1

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.

Choices:

  • "ignore"

  • "validate"

client_id

string

Azure client ID. Use when authenticating with a Service Principal or Managed Identity (msi).

Can also be set via the AZURE_CLIENT_ID environment variable.

cloud_environment

string

added in azure.azcollection 0.0.1

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.

Default: "AzureCloud"

delegations

list / elements=dictionary

An array of delegations.

actions

list / elements=string

A list of actions.

Default: []

name

string / required

The name of delegation.

serviceName

string / required

The type of the endpoint service.

Choices:

  • "Microsoft.ContainerService/managedClusters"

  • "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"

disable_instance_discovery

boolean

added in azure.azcollection 2.3.0

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 AZURE_DISABLE_INSTANCE_DISCOVERY environment variable.

Choices:

  • false ← (default)

  • true

log_mode

string

Parent argument.

log_path

string

Parent argument.

name

string / required

Name of the subnet.

nat_gateway

string

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.

password

string

Active Directory user password. Use when authenticating with an Active Directory user rather than service principal.

private_endpoint_network_policies

string

Enabled or Disabled apply network policies on private endpoints in the subnet.

Choices:

  • "Enabled" ← (default)

  • "Disabled"

string

Enabled or Disabled apply network policies on private link service in the subnet.

Choices:

  • "Enabled" ← (default)

  • "Disabled"

profile

string

Security profile found in ~/.azure/credentials file.

resource_group

string / required

Name of resource group.

route_table

any

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.

secret

string

Azure client secret. Use when authenticating with a Service Principal.

security_group

aliases: security_group_name

any

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.

service_endpoints

list / elements=dictionary

An array of service endpoints.

locations

list / elements=string

A list of locations.

service

string / required

The type of the endpoint service.

state

string

Assert the state of the subnet. Use present to create or update a subnet and use absent to delete a subnet.

Choices:

  • "absent"

  • "present" ← (default)

subscription_id

string

Your Azure subscription Id.

tenant

string

Azure tenant ID. Use when authenticating with a Service Principal.

thumbprint

string

added in azure.azcollection 1.14.0

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.

virtual_network_name

aliases: virtual_network

string / required

Name of an existing virtual network with which the subnet is or will be associated.

x509_certificate_path

path

added in azure.azcollection 1.14.0

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

state

complex

Current state of the subnet.

Returned: success

address_prefix

string

IP address CIDR.

Returned: always

Sample: "10.1.0.0/16"

address_prefixes

list / elements=string

IP address for IPv4 and IPv6 CIDR.

Returned: always

Sample: ["10.2.0.0/24", "fdda:e69b:1587:495e::/64"]

delegations

list / elements=string

Associated delegation of subnets

Returned: always

actions

list / elements=string

list of actions associated with service of delegation

Returned: when delegation is present

Sample: ["Microsoft.Network/virtualNetworks/subnets/action"]

name

string

name of delegation

Returned: when delegation is present

Sample: "delegationname"

serviceName

string

service associated to delegation

Returned: when delegation is present

Sample: "Microsoft.ContainerInstance/containerGroups"

id

string

Subnet resource path.

Returned: always

Sample: "/subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroup/myResourceGroup/providers/Microsoft.Network/virtualNetworks/myVirtualNetwork/subnets/mySubnet"

name

string

Subnet name.

Returned: always

Sample: "foobar"

network_security_group

complex

Associated network security group of subnets.

Returned: always

id

string

Security group resource identifier.

Returned: always

Sample: "/subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroup/myResourceGroup/providers/Microsoft.Network/networkSecurityGroups/secgroupfoo"

name

string

Name of the security group.

Returned: always

Sample: "secgroupfoo"

private_endpoint_network_policies

string

Enabled or Disabled apply network policies on private endpoints in the subnet.

Returned: always

Sample: "Enabled"

string

Enabled or Disabled apply network policies on private link service in the subnet.

Returned: always

Sample: "Disabled"

provisioning_state

string

Success or failure of the provisioning event.

Returned: always

Sample: "Succeeded"

Authors

  • Chris Houseknecht (@chouseknecht)

  • Matt Davis (@nitzmahone)