W3cubDocs

/Ansible

azure_rm_storageaccount - Manage Azure storage accounts.

New in version 2.1.

Synopsis
Requirements (on host that executes module)
Options
Examples
Return Values
Notes
This is a Core Module

Synopsis

Create, update or delete a storage account.

Requirements (on host that executes module)

python >= 2.7
azure == 2.0.0rc5

Options

parameter	required	default	choices	comments
account_type	no		Premium_LRS Standard_GRS Standard_LRS Standard_RAGRS Standard_ZRS	Type of storage account. Required when creating a storage account. NOTE: Standard_ZRS and Premium_LRS accounts cannot be changed to other account types, and other account types cannot be changed to Standard_ZRS or Premium_LRS. aliases: type
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.
custom_domain	no			User domain assigned to the storage account. Must be a dictionary with 'name' and 'use_sub_domain' keys where 'name' is the CNAME source. Only one custom domain is supported per storage account at this time. To clear the existing custom domain, use an empty string for the custom domain name property. Can be added to an existing storage account. Will be ignored during storage account creation.
kind (added in 2.2)	no	Storage	Storage StorageBlob	The 'kind' of storage.
location	no	resource_group location		Valid azure location. Defaults to location of the resource group.
name	no			Name of the storage account to update or create.
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 the resource group to use.
secret	no			Azure client secret. Use when authenticating with a Service Principal.
state	no	present	absent present	Assert the state of the storage account. Use 'present' to create or update a storage account and 'absent' to delete an account.
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: remove account, if it exists
  azure_rm_storageaccount:
    resource_group: Testing
    name: clh0002
    state: absent

- name: create an account
  azure_rm_storageaccount:
    resource_group: Testing
    name: clh0002
    type: Standard_RAGRS
    tags:
      - testing: testing
      - delete: on-exit

Return Values

Common return values are documented here Common Return Values, the following are the fields unique to this module:

name	description	returned	type	sample
state	Current state of the storage account.	always	dict	{'secondary_location': 'centralus', 'account_type': 'Standard_RAGRS', 'custom_domain': None, 'resource_group': 'Testing', 'tags': None, 'primary_location': 'eastus2', 'secondary_endpoints': {'queue': 'https://clh0003-secondary.queue.core.windows.net/', 'table': 'https://clh0003-secondary.table.core.windows.net/', 'blob': 'https://clh0003-secondary.blob.core.windows.net/'}, 'provisioning_state': 'Succeeded', 'primary_endpoints': {'queue': 'https://clh0003.queue.core.windows.net/', 'table': 'https://clh0003.table.core.windows.net/', 'blob': 'https://clh0003.blob.core.windows.net/'}, 'location': 'eastus2', 'status_of_primary': 'Available', 'status_of_secondary': 'Available', 'type': 'Microsoft.Storage/storageAccounts', 'id': '/subscriptions/XXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXX/resourceGroups/testing/providers/Microsoft.Storage/storageAccounts/clh0003', 'name': 'clh0003'}

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 set environment variables AZURE_SUBSCRIPTION_ID, AZURE_CLIENT_ID, AZURE_SECRET and AZURE_TENANT.

Note

To Authentication via Active Directory user pass ad_user and password, or set AZURE_AD_USER and AZURE_PASSWORD in the environment.

Note

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.

This is a Core Module

For more information on what this means please read Core Modules

For help in developing on modules, should you be so inclined, please read Community Information & Contributing, developing_test_pr and Developing Modules.

© 2012–2016 Michael DeHaan
© 2016 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/azure_rm_storageaccount_module.html