azure_rm_storageaccount – Manage Azure storage accounts¶

Synopsis
Requirements
Parameters
Notes
See Also
Examples
Return Values
Status

Synopsis ¶

Create, update or delete a storage account.

Requirements ¶

The below requirements are needed on the host that executes this module.

python >= 2.7
azure >= 2.0.0

Parameters ¶

Parameter		Choices/Defaults	Comments
access_tier - added in 2.4		Choices: Hot Cool	The access tier for this storage account. Required when kind=BlobStorage.
account_type -		Choices: Premium_LRS Standard_GRS Standard_LRS StandardSSD_LRS Standard_RAGRS Standard_ZRS Premium_ZRS	Type of storage account. Required when creating a storage account. `Standard_ZRS` and `Premium_LRS` accounts cannot be changed to other account types. Other account types cannot be changed to `Standard_ZRS` or `Premium_LRS`. aliases: type
ad_user string			Active Directory username. Use when authenticating with an Active Directory user rather than service principal.
adfs_authority_url string added in 2.6			Azure AD authority url. Use when authenticating with Username/password, and has your own ADFS authority.
api_profile string added in 2.5		Default: "latest"	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.
append_tags boolean		Choices: no yes ←	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.
auth_source string added in 2.5		Choices: auto cli credential_file env msi	Controls the source of the credentials to use for authentication. If not specified, ANSIBLE_AZURE_AUTH_SOURCE environment variable will be used and default to `auto` if variable is not defined. `auto` will follow the default precedence of module parameters -> environment variables -> default profile in credential file `~/.azure/credentials`. When set to `cli`, the credentials will be sources from the default Azure CLI profile. Can also be set via the `ANSIBLE_AZURE_AUTH_SOURCE` environment variable. 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.
blob_cors list added in 2.8			Specifies CORS rules for the Blob service. You can include up to five CorsRule elements in the request. If no blob_cors elements are included in the argument list, nothing about CORS will be changed. If you want to delete all CORS rules and disable CORS for the Blob service, explicitly set blob_cors=[].
	allowed_headers list / required		A list of headers allowed to be part of the cross-origin request.
	allowed_methods list / required		A list of HTTP methods that are allowed to be executed by the origin.
	allowed_origins list / required		A list of origin domains that will be allowed via CORS, or "*" to allow all domains.
	exposed_headers list / required		A list of response headers to expose to CORS clients.
	max_age_in_seconds integer / required		The number of seconds that the client/browser should cache a preflight response.
cert_validation_mode string added in 2.5		Choices: ignore validate	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.
client_id string			Azure client ID. Use when authenticating with a Service Principal.
cloud_environment string added in 2.4		Default: "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.
custom_domain -			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. aliases: custom_dns_domain_suffix
force_delete_nonempty boolean		Choices: no yes	Attempt deletion if resource already exists and cannot be updated. aliases: force
https_only boolean added in 2.8		Choices: no yes	Allows https traffic only to storage service when set to `true`.
kind -		Choices: Storage ← StorageV2 BlobStorage	The kind of storage.
location -			Valid Azure location. Defaults to location of the resource group.
name -			Name of the storage account to update or create.
password string			Active Directory user password. Use when authenticating with an Active Directory user rather than service principal.
profile string			Security profile found in ~/.azure/credentials file.
resource_group - / required			Name of the resource group to use. aliases: resource_group_name
secret string			Azure client secret. Use when authenticating with a Service Principal.
state -		Choices: absent present ←	State of the storage account. Use `present` to create or update a storage account and use `absent` to delete an account.
subscription_id string			Your Azure subscription Id.
tags dictionary			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 string			Azure tenant ID. 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.

Examples ¶

- name: remove account, if it exists
  azure_rm_storageaccount:
    resource_group: myResourceGroup
    name: clh0002
    state: absent

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

- name: create an account with blob CORS
  azure_rm_storageaccount:
    resource_group: myResourceGroup
    name: clh002
    type: Standard_RAGRS
    blob_cors:
        - allowed_origins:
            - http://www.example.com/
          allowed_methods:
            - GET
            - POST
          allowed_headers:
            - x-ms-meta-data*
            - x-ms-meta-target*
            - x-ms-meta-abc
          exposed_headers:
            - x-ms-meta-*
          max_age_in_seconds: 200

Return Values ¶

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

Key			Returned	Description
state complex			always	Current state of the storage account.
	account_type string		always	Type of storage account. Sample: Standard_RAGRS
	custom_domain complex		always	User domain assigned to the storage account.
		name string	always	CNAME source. Sample: testaccount
		use_sub_domain boolean	always	Whether to use sub domain. Sample: True
	id string		always	Resource ID. Sample: /subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/myResourceGroup/providers/Microsoft.Storage/storageAccounts/clh0003
	location string		always	Valid Azure location. Defaults to location of the resource group. Sample: eastus2
	name string		always	Name of the storage account to update or create. Sample: clh0003
	primary_endpoints dictionary		always	The URLs to retrieve the public blob, queue, or table object from the primary location. Sample: {'blob': 'https://clh0003.blob.core.windows.net/', 'queue': 'https://clh0003.queue.core.windows.net/', 'table': 'https://clh0003.table.core.windows.net/'}
	primary_location string		always	The location of the primary data center for the storage account. Sample: eastus2
	provisioning_state string		always	The status of the storage account. Possible values include `Creating`, `ResolvingDNS`, `Succeeded`. Sample: Succeeded
	resource_group string		always	The resource group's name. Sample: Testing
	secondary_endpoints dictionary		always	The URLs to retrieve the public blob, queue, or table object from the secondary location. Sample: {'blob': 'https://clh0003-secondary.blob.core.windows.net/', 'queue': 'https://clh0003-secondary.queue.core.windows.net/', 'table': 'https://clh0003-secondary.table.core.windows.net/'}
	secondary_location string		always	The location of the geo-replicated secondary for the storage account. Sample: centralus
	status_of_primary string		always	The status of the primary location of the storage account; either `available` or `unavailable`. Sample: available
	status_of_secondary string		always	The status of the secondary location of the storage account; either `available` or `unavailable`. Sample: available
	tags dictionary		always	Resource tags. Sample: {'tags1': 'value1'}
	type string		always	The storage account type. Sample: Microsoft.Storage/storageAccounts

Status ¶

This module is not guaranteed to have a backwards compatible interface. [preview]
This module is maintained by the Ansible Community. [community]

Authors¶

Chris Houseknecht (@chouseknecht)
Matt Davis (@nitzmahone)

Hint

If you notice any issues in this documentation, you can edit this document to improve it.