azure.azcollection.azure_rm_storageaccount_info – Get storage account facts

Note

This plugin is part of the azure.azcollection collection.

To install it use: ansible-galaxy collection install azure.azcollection.

To use it in a playbook, specify: azure.azcollection.azure_rm_storageaccount_info.

New in version 0.1.2: of azure.azcollection

Synopsis

  • Get facts for one storage account or all storage accounts within a resource group.

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
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.
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.
auth_source
string
added in 0.0.1 of azure.azcollection
    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.
cert_validation_mode
string
added in 0.0.1 of azure.azcollection
    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 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.
name
string
Only show results for a specific account.
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
Limit results to a resource group. Required when filtering by name.

aliases: resource_group_name
secret
string
Azure client secret. Use when authenticating with a Service Principal.
show_blob_cors
boolean
    Choices:
  • no
  • yes
Show the blob CORS settings for each blob related to the storage account.
Querying all storage accounts will take a long time.
show_connection_string
boolean
    Choices:
  • no
  • yes
Show the connection string for each of the storageaccount's endpoints.
For convenient usage, show_connection_string will also show the access keys for each of the storageaccount's endpoints.
Note that it will cost a lot of time when list all storageaccount rather than query a single one.
subscription_id
string
Your Azure subscription Id.
tags
string
Limit results by providing a list of tags. Format tags as 'key' or 'key:value'.
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

See also

Sign in with Azure CLI

How to authenticate using the az login command.

Examples

- name: Get facts for one account
  azure_rm_storageaccount_info:
    resource_group: myResourceGroup
    name: clh0002

- name: Get facts for all accounts in a resource group
  azure_rm_storageaccount_info:
    resource_group: myResourceGroup

- name: Get facts for all accounts by tags
  azure_rm_storageaccount_info:
    tags:
      - testing
      - foo:bar

Return Values

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

Key Returned Description
azure_storageaccounts
list / elements=string
always
List of storage account dicts.

Sample:
[{'id': '/subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/myResourceGroups/testing/providers/Microsoft.Storage/storageAccounts/testaccount001', 'location': 'eastus2', 'name': 'testaccount001', 'properties': {'accountType': 'Standard_LRS', 'creationTime': '2016-03-28T02:46:58.290113Z', 'primaryEndpoints': {'blob': 'https://testaccount001.blob.core.windows.net/', 'file': 'https://testaccount001.file.core.windows.net/', 'queue': 'https://testaccount001.queue.core.windows.net/', 'table': 'https://testaccount001.table.core.windows.net/'}, 'primaryLocation': 'eastus2', 'provisioningState': 'Succeeded', 'statusOfPrimary': 'Available'}, 'tags': {}, 'type': 'Microsoft.Storage/storageAccounts'}]
storageaccounts
complex
always
List of storage account dicts in resource module's parameter format.

 
access_tier
string
always
The access tier for this storage account.

Sample:
Hot
 
account_type
string
always
Type of 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.

Sample:
Standard_ZRS
 
custom_domain
complex
always
User domain assigned to the storage account.
Must be a dictionary with name and use_sub_domain keys where name is the CNAME source.

   
name
string
always
CNAME source.

Sample:
testaccount
   
use_sub_domain
boolean
always
Whether to use sub domain.

Sample:
True
 
https_only
boolean
always
Allows https traffic only to storage service when set to true.

 
id
string
always
Resource ID.

Sample:
/subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/myResourceGroup/providers/Microsoft.Storage/storageAccounts/t estaccount001
 
kind
string
always
The kind of storage.

Sample:
Storage
 
location
string
always
Valid Azure location. Defaults to location of the resource group.

Sample:
eastus
 
name
string
always
Name of the storage account to update or create.

Sample:
testaccount001
 
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
complex
always
URLs to retrieve a public blob, file, queue, or table object.
Note that Standard_ZRS and Premium_LRS accounts only return the blob endpoint.

   
blob
complex
always
The primary blob endpoint and connection string.

     
connectionstring
string
always
Connectionstring of the blob endpoint.

Sample:
DefaultEndpointsProtocol=https;EndpointSuffix=core.windows.net;AccountName=X;AccountKey=X;BlobEndpoint=X
     
endpoint
string
always
The primary blob endpoint.

Sample:
https://testaccount001.blob.core.windows.net/
   
file
complex
always
The primary file endpoint and connection string.

     
connectionstring
string
always
Connectionstring of the file endpoint.

Sample:
DefaultEndpointsProtocol=https;EndpointSuffix=core.windows.net;AccountName=X;AccountKey=X;FileEndpoint=X
     
endpoint
string
always
The primary file endpoint.

Sample:
https://testaccount001.file.core.windows.net/
   
key
string
always
The account key for the primary_endpoints

Sample:
xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx
   
queue
complex
always
The primary queue endpoint and connection string.

     
connectionstring
string
always
Connectionstring of the queue endpoint.

Sample:
DefaultEndpointsProtocol=https;EndpointSuffix=core.windows.net;AccountName=X;AccountKey=X;QueueEndpoint=X
     
endpoint
string
always
The primary queue endpoint.

Sample:
https://testaccount001.queue.core.windows.net/
   
table
complex
always
The primary table endpoint and connection string.

     
connectionstring
string
always
Connectionstring of the table endpoint.

Sample:
DefaultEndpointsProtocol=https;EndpointSuffix=core.windows.net;AccountName=X;AccountKey=X;TableEndpoint=X
     
endpoint
string
always
The primary table endpoint.

Sample:
https://testaccount001.table.core.windows.net/
 
primary_location
string
always
The location of the primary data center for the storage account.

Sample:
eastus
 
provisioning_state
string
always
The status of the storage account at the time the operation was called.
Possible values include Creating, ResolvingDNS, Succeeded.

Sample:
Succeeded
 
secondary_endpoints
complex
always
The URLs to retrieve a public blob, file, queue, or table object from the secondary location.
Only available if the SKU name=Standard_RAGRS.

   
blob
complex
always
The secondary blob endpoint and connection string.

     
connectionstring
string
always
Connectionstring of the blob endpoint.

Sample:
DefaultEndpointsProtocol=https;EndpointSuffix=core.windows.net;AccountName=X;AccountKey=X;BlobEndpoint=X
     
endpoint
string
always
The secondary blob endpoint.

Sample:
https://testaccount001.blob.core.windows.net/
   
file
complex
always
The secondary file endpoint and connection string.

     
connectionstring
string
always
Connectionstring of the file endpoint.

Sample:
DefaultEndpointsProtocol=https;EndpointSuffix=core.windows.net;AccountName=X;AccountKey=X;FileEndpoint=X
     
endpoint
string
always
The secondary file endpoint.

Sample:
https://testaccount001.file.core.windows.net/
   
key
string
success
The account key for the secondary_endpoints

Sample:
xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx
   
queue
complex
always
The secondary queue endpoint and connection string.

     
connectionstring
string
always
Connectionstring of the queue endpoint.

Sample:
DefaultEndpointsProtocol=https;EndpointSuffix=core.windows.net;AccountName=X;AccountKey=X;QueueEndpoint=X
     
endpoint
string
always
The secondary queue endpoint.

Sample:
https://testaccount001.queue.core.windows.net/
   
table
complex
always
The secondary table endpoint and connection string.

     
connectionstring
string
always
Connectionstring of the table endpoint.

Sample:
DefaultEndpointsProtocol=https;EndpointSuffix=core.windows.net;AccountName=X;AccountKey=X;TableEndpoint=X
     
endpoint
string
always
The secondary table endpoint.

Sample:
https://testaccount001.table.core.windows.net/
 
secondary_location
string
always
The location of the geo-replicated secondary for the storage account.
Only available if the account_type=Standard_GRS or account_type=Standard_RAGRS.

Sample:
westus
 
status_of_primary
string
always
Status of the primary location of the storage account; either available or unavailable.

Sample:
available
 
status_of_secondary
string
always
Status of the secondary location of the storage account; either available or unavailable.

Sample:
available
 
tags
dictionary
always
Resource tags.

Sample:
{'tag1': 'abc'}


Authors

  • Chris Houseknecht (@chouseknecht)

  • Matt Davis (@nitzmahone)