New in version 2.1.
- python >= 2.7
- azure == 2.0.0rc5
parameter | required | default | choices | comments |
---|---|---|---|---|
ad_user |
no | Active Directory username. Use when authenticating with an Active Directory user rather than service principal. | ||
address_prefix_cidr |
yes | CIDR defining the IPv4 address space of the subnet. Must be valid within the context of the virtual network.
aliases: address_prefix | ||
client_id |
no | Azure client ID. Use when authenticating with a Service Principal. | ||
name |
yes | Name of the subnet. | ||
password |
no | Active Directory user password. Use when authenticating with an Active Directory user rather than service principal. | ||
profile |
no | Security profile found in ~/.azure/credentials file. | ||
resource_group |
yes | Name of resource group. | ||
secret |
no | Azure client secret. Use when authenticating with a Service Principal. | ||
security_group_name |
no | Name of an existing security group with which to associate the subnet.
aliases: security_group | ||
state |
yes | present |
|
Assert the state of the subnet. Use 'present' to create or update a subnet and 'absent' to delete a subnet. |
subscription_id |
no | Your Azure subscription Id. | ||
tenant |
no | Azure tenant ID. Use when authenticating with a Service Principal. | ||
virtual_network_name |
yes | Name of an existing virtual network with which the subnet is or will be associated.
aliases: virtual_network |
- 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
Common return values are documented here Return Values, the following are the fields unique to this module:
name | description | returned | type | sample |
---|---|---|---|---|
state | Current state of the subnet. | success | complex |
Note
This module is flagged as preview which means that it is not guaranteed to have a backwards compatible interface.
This module is supported mainly by the community and is curated by core committers.
For more information on what this means please read Module Support
For help in developing on modules, should you be so inclined, please read Community Information & Contributing, Helping Testing PRs and Developing Modules.