azure_rm_storageaccount – Manage Azure storage accounts
azure_rm_storageaccount – Manage Azure storage accounts
New in version 2.1.
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 |
|
The access tier for this storage account. Required for a storage account of kind 'BlobStorage'. | |
account_type - |
|
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.
| |
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 | |
append_tags boolean |
|
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 |
|
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
When set to Can also be set via the When set to The | |
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 |
|
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 | |
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, | |
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.
| ||
force_delete_nonempty boolean |
|
Attempt deletion if resource already exists and cannot be updated
| |
https_only boolean added in 2.8 |
|
Allows https traffic only to storage service if sets to true. | |
kind - added in 2.2 |
|
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 - |
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.
| ||
secret string |
Azure client secret. Use when authenticating with a Service Principal. | ||
state - |
|
Assert the state of the storage account. Use | |
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.
See Also
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 dictionary |
always |
Current state of the storage account.
Sample: {'account_type': 'Standard_RAGRS', 'custom_domain': None, 'id': '/subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/myResourceGroup/providers/Microsoft.Storage/storageAccounts/clh0003', 'location': 'eastus2', 'name': 'clh0003', 'primary_endpoints': {'blob': 'https://clh0003.blob.core.windows.net/', 'queue': 'https://clh0003.queue.core.windows.net/', 'table': 'https://clh0003.table.core.windows.net/'}, 'primary_location': 'eastus2', 'provisioning_state': 'Succeeded', 'resource_group': 'Testing', 'secondary_endpoints': {'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': 'centralus', 'status_of_primary': 'Available', 'status_of_secondary': 'Available', 'tags': None, 'type': '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)
© 2012–2018 Michael DeHaan
© 2018–2019 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.8/modules/azure_rm_storageaccount_module.html