Note
This plugin is part of the azure.azcollection collection (version 1.10.0).
You might already have this collection installed if you are using the ansible
package. It is not included in ansible-core
. To check whether it is installed, run ansible-galaxy collection list
.
To install it, use: ansible-galaxy collection install azure.azcollection
.
To use it in a playbook, specify: azure.azcollection.azure_rm_storageaccount
.
New in version 0.1.0: of azure.azcollection
The below requirements are needed on the host that executes this module.
Parameter | Choices/Defaults | Comments | ||
---|---|---|---|---|
access_tier string |
| The access tier for this storage account. Required when kind=BlobStorage. | ||
account_type string |
| 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 0.0.1 of azure.azcollection | Azure AD authority url. Use when authenticating with Username/password, and has your own ADFS authority. | |||
allow_blob_public_access boolean added in 1.1.0 of azure.azcollection |
| Allows blob containers in account to be set for anonymous public access. If set to false, no containers in this account will be able to allow anonymous public access. If omitted, new account creation will default to null which is currently interpreted to True. Existing accounts will not be modified. | ||
api_profile string added in 0.0.1 of azure.azcollection | 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 |
| 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 0.0.1 of azure.azcollection |
| Controls the source of the credentials to use for authentication. Can also be set via the ANSIBLE_AZURE_AUTH_SOURCE environment variable.When set to auto (the default) the precedence is module parameters -> env -> credential_file -> cli .When set to env , the credentials will be read from the environment variablesWhen set to credential_file , it will read the profile from ~/.azure/credentials .When set to cli , the credentials will be sources from the Azure CLI profile. subscription_id or the environment variable AZURE_SUBSCRIPTION_ID can be used to identify the subscription ID if more than one is present otherwise the default az cli subscription is used.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 / elements=string | 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 / elements=string / required | A list of headers allowed to be part of the cross-origin request. | |||
allowed_methods list / elements=string / required | A list of HTTP methods that are allowed to be executed by the origin. | |||
allowed_origins list / elements=string / required | A list of origin domains that will be allowed via CORS, or "*" to allow all domains. | |||
exposed_headers list / elements=string / 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 0.0.1 of azure.azcollection |
| 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 0.0.1 of azure.azcollection | 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 string | 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 |
| Attempt deletion if resource already exists and cannot be updated. aliases: force | ||
https_only boolean |
| Allows https traffic only to storage service when set to True .If omitted, new account creation will default to True, while existing accounts will not be change. | ||
kind string |
| The kind of storage. The FileStorage and (BlockBlobStorage) only used when account_type=Premium_LRS or account_type=Premium_ZRS. | ||
location string | Valid Azure location. Defaults to location of the resource group. | |||
log_mode string | Parent argument. | |||
log_path string | Parent argument. | |||
minimum_tls_version string added in 1.0.0 of azure.azcollection |
| The minimum required version of Transport Layer Security (TLS) for requests to a storage account. If omitted, new account creation will default to null which is currently interpreted to TLS1_0. Existing accounts will not be modified. | ||
name string | Name of the storage account to update or create. | |||
network_acls dictionary | Manages the Firewall and virtual networks settings of the storage account. | |||
bypass string | Default: "AzureServices" | When default_action=Deny this controls which Azure components can still reach the Storage Account. The list is comma separated. It can be any combination of the example AzureServices , Logging , Metrics .If no Azure components are allowed, explicitly set bypass="". | ||
default_action string |
| Default firewall traffic rule. If default_action=Allow no other settings have effect. | ||
ip_rules string | A list of IP addresses or ranges in CIDR format. | |||
action string | Default: "Allow" | The only logical action=Allow because this setting is only accessible when default_action=Deny. | ||
value string | The IP address or range. | |||
virtual_network_rules string | A list of subnets and their actions. | |||
action string | Default: "Allow" | The only logical action=Allow because this setting is only accessible when default_action=Deny. | ||
id string | The complete path to the subnet. | |||
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 string / 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 string |
| 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. Currently, Azure DNS zones and Traffic Manager services also don't allow the use of spaces in the tag. Azure Front Door doesn't support the use of Azure Automation and Azure CDN only support 15 tags on resources. | |||
tenant string | Azure tenant ID. Use when authenticating with a Service Principal. |
Note
az login
.See also
How to authenticate using the az login
command.
- 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 kind of FileStorage azure_rm_storageaccount: resource_group: myResourceGroup name: c1h0002 type: Premium_LRS kind: FileStorage tags: testing: testing - name: configure firewall and virtual networks azure_rm_storageaccount: resource_group: myResourceGroup name: clh0002 type: Standard_RAGRS network_acls: bypass: AzureServices,Metrics default_action: Deny virtual_network_rules: - id: /subscriptions/mySubscriptionId/resourceGroups/myResourceGroup/providers/Microsoft.Network/virtualNetworks/myVnet/subnets/mySubnet action: Allow ip_rules: - value: 1.2.3.4 action: Allow - value: 123.234.123.0/24 action: Allow - 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
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 | ||
network_acls dictionary | always | A set of firewall and virtual network rules Sample: {'bypass': 'AzureServices', 'default_action': 'Deny', 'ip_rules': [{'action': 'Allow', 'value': '1.2.3.4'}, {'action': 'Allow', 'value': '123.234.123.0/24'}], 'virtual_network_rules': [{'action': 'Allow', 'id': '/subscriptions/mySubscriptionId/resourceGroups/myResourceGroup/ providers/Microsoft.Network/virtualNetworks/myVnet/subnets/mySubnet'}]} | ||
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 |
© 2012–2018 Michael DeHaan
© 2018–2021 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/latest/collections/azure/azcollection/azure_rm_storageaccount_module.html