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. | ||
append_tags |
no | True | Use to control if tags field is canonical or just appends to existing tags. When canonical, any tags not found in the tags parameter will be removed from the object's metadata. | |
client_id |
no | Azure client ID. Use when authenticating with a Service Principal. | ||
force |
no | Remove a resource group and all associated resources. Use with state 'absent' to delete a resource group that contains resources. | ||
location |
no | Azure location for the resource group. Required when creating a new resource group. Cannot be changed once resource group is created. | ||
name |
yes | Name of the resource group. | ||
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. | ||
secret |
no | Azure client secret. Use when authenticating with a Service Principal. | ||
state |
no | present |
|
Assert the state of the resource group. Use 'present' to create or update and 'absent' to delete. When 'absent' a resource group containing resources will not be removed unless the force option is used. |
subscription_id |
no | Your Azure subscription Id. | ||
tags |
no | Dictionary of string:string pairs to assign as metadata to the object. Metadata tags on the object will be updated with any provided values. To remove tags set append_tags option to false.
| ||
tenant |
no | Azure tenant ID. Use when authenticating with a Service Principal. |
- name: Create a resource group azure_rm_resourcegroup: name: Testing location: westus tags: testing: testing delete: never - name: Delete a resource group azure_rm_resourcegroup: name: 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 resource group. | always | dict | {'location': 'westus', 'provisioning_state': 'Succeeded', 'id': '/subscriptions/XXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXX/resourceGroups/Testing', 'name': 'Testing', 'tags': {'testing': 'no', 'delete': 'on-exit'}} |
contains_resources | Whether or not the resource group contains associated resources. | bool | True |
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.