azure_rm_resourcegroup - Manage Azure resource groups.
New in version 2.1.
Synopsis
- Create, update and delete a resource group.
Requirements (on host that executes module)
- python >= 2.7
- azure >= 2.0.0
Options
| 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.
|
||
| cloud_environment |
no | 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.
|
|
| 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.
|
Examples
- 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
Return Values
Common return values are documented here Return Values, the following are the fields unique to this module:
| name | description | returned | type | sample |
|---|---|---|---|---|
| contains_resources |
Whether or not the resource group contains associated resources.
|
always | bool | True |
| 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'}} |
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.
Status
This module is flagged as preview which means that it is not guaranteed to have a backwards compatible interface.
For help in developing on modules, should you be so inclined, please read Community Information & Contributing, Testing Ansible and Developing Modules.
© 2012–2018 Michael DeHaan
© 2018–2019 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.4/azure_rm_resourcegroup_module.html
