ansible / ansible.builtin / v2.8.19 / module / azure_rm_storageaccount_facts Get storage account facts. | "added in version" 2.1 of ansible.builtin" Authors: Chris Houseknecht (@chouseknecht), Matt Davis (@nitzmahone) preview | supported by communityansible.builtin.azure_rm_storageaccount_facts (v2.8.19) — module
pip
Install with pip install ansible==2.8.19
Get facts for one storage account or all storage accounts within a resource group.
- name: Get facts for one account azure_rm_storageaccount_facts: resource_group: myResourceGroup name: clh0002
- name: Get facts for all accounts in a resource group azure_rm_storageaccount_facts: resource_group: myResourceGroup
- name: Get facts for all accounts by tags azure_rm_storageaccount_facts: tags: - testing - foo:bar
name: description: - Only show results for a specific account. tags: description: - Limit results by providing a list of tags. Format tags as 'key' or 'key:value'. secret: description: - Azure client secret. Use when authenticating with a Service Principal. type: str tenant: description: - Azure tenant ID. Use when authenticating with a Service Principal. type: str ad_user: description: - Active Directory username. Use when authenticating with an Active Directory user rather than service principal. type: str profile: description: - Security profile found in ~/.azure/credentials file. type: str log_mode: description: - Parent argument. type: str log_path: description: - Parent argument. type: str password: description: - Active Directory user password. Use when authenticating with an Active Directory user rather than service principal. type: str client_id: description: - Azure client ID. Use when authenticating with a Service Principal. type: str thumbprint: description: - The thumbprint of the private key specified in I(x509_certificate_path). - Use when authenticating with a Service Principal. - Required if I(x509_certificate_path) is defined. type: str version_added: 1.14.0 version_added_collection: azure.azcollection api_profile: default: latest description: - Selects an API profile to use when communicating with Azure services. Default value of C(latest) is appropriate for public clouds; future values will allow use with Azure Stack. type: str version_added: 0.0.1 version_added_collection: azure.azcollection auth_source: choices: - auto - cli - credential_file - env - msi default: auto description: - Controls the source of the credentials to use for authentication. - Can also be set via the C(ANSIBLE_AZURE_AUTH_SOURCE) environment variable. - When set to C(auto) (the default) the precedence is module parameters -> C(env) -> C(credential_file) -> C(cli). - When set to C(env), the credentials will be read from the environment variables - When set to C(credential_file), it will read the profile from C(~/.azure/credentials). - When set to C(cli), the credentials will be sources from the Azure CLI profile. C(subscription_id) or the environment variable C(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 C(msi), the host machine must be an azure resource with an enabled MSI extension. C(subscription_id) or the environment variable C(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 C(msi) was added in Ansible 2.6. type: str version_added: 0.0.1 version_added_collection: azure.azcollection resource_group: aliases: - resource_group_name description: - Limit results to a resource group. Required when filtering by name. show_blob_cors: description: - Show the blob CORS settings for each of the storageaccount's blob. - Note that it will cost a lot time when list all storageaccount rather than querry a single one. type: bool version_added: '2.8' version_added_collection: ansible.builtin subscription_id: description: - Your Azure subscription Id. type: str cloud_environment: default: AzureCloud description: - For cloud environments other than the US public cloud, the environment name (as defined by Azure Python SDK, eg, C(AzureChinaCloud), C(AzureUSGovernment)), or a metadata discovery endpoint URL (required for Azure Stack). Can also be set via credential file profile or the C(AZURE_CLOUD_ENVIRONMENT) environment variable. type: str version_added: 0.0.1 version_added_collection: azure.azcollection adfs_authority_url: description: - Azure AD authority url. Use when authenticating with Username/password, and has your own ADFS authority. type: str version_added: 0.0.1 version_added_collection: azure.azcollection cert_validation_mode: choices: - ignore - validate description: - 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 C(ignore). Can also be set via credential file profile or the C(AZURE_CERT_VALIDATION) environment variable. type: str version_added: 0.0.1 version_added_collection: azure.azcollection x509_certificate_path: description: - Path to the X509 certificate used to create the service principal in PEM format. - The certificate must be appended to the private key. - Use when authenticating with a Service Principal. type: path version_added: 1.14.0 version_added_collection: azure.azcollection show_connection_string: description: - Show the connection string 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. type: bool version_added: '2.8' version_added_collection: ansible.builtin
azure_storageaccounts: description: List of storage account dicts. example: - 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 returned: always type: list storageaccounts: contains: access_tier: description: - The access tier for this storage account. sample: Hot account_type: description: - Type of storage account. - 'NOTE: 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 blob_cors: description: - Blob CORS of blob. type: list custom_domain: contains: name: description: - CNAME source. sample: testaccount use_sub_domain: description: - whether to use sub domain. sample: true description: - User domain assigned to the storage account. - Must be a dictionary with 'name' and 'use_sub_domain' keys where 'name' is the CNAME source. type: complex https_only: description: - Allows https traffic only to storage service if sets to true. sample: false id: description: - Resource ID. sample: /subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/myResourceGroup/providers/Microsoft.Storage/storageAccounts/t estaccount001 kind: description: - The 'kind' of storage. sample: Storage location: description: - Valid azure location. Defaults to location of the resource group. sample: eastus name: description: - Name of the storage account to update or create. sample: testaccount001 primary_endpoints: contains: blob: contains: connectionstring: description: - Connectionstring of the blob endpoint sample: DefaultEndpointsProtocol=https;EndpointSuffix=core.windows.net;AccountName=X;AccountKey=X;BlobEndpoint=X endpoint: description: - Gets the primary blob endpoint. sample: https://testaccount001.blob.core.windows.net/ description: - Gets the primary blob endpoint and connection string. type: complex queue: contains: connectionstring: description: - Connectionstring of the queue endpoint sample: DefaultEndpointsProtocol=https;EndpointSuffix=core.windows.net;AccountName=X;AccountKey=X;QueueEndpoint=X endpoint: description: - Gets the primary queue endpoint. sample: https://testaccount001.queue.core.windows.net/ description: - Gets the primary queue endpoint and connection string. type: complex table: contains: connectionstring: description: - Connectionstring of the table endpoint sample: DefaultEndpointsProtocol=https;EndpointSuffix=core.windows.net;AccountName=X;AccountKey=X;TableEndpoint=X endpoint: description: - Gets the primary table endpoint. sample: https://testaccount001.table.core.windows.net/ description: - Gets the primary table endpoint and connection string. type: complex description: - Gets the URLs that are used to perform a retrieval of a public blob, queue, or table object. - Note that Standard_ZRS and Premium_LRS accounts only return the blob endpoint. type: complex primary_location: description: - Gets the location of the primary data center for the storage account. sample: eastus provisioning_state: description: - Gets the status of the storage account at the time the operation was called. - Possible values include 'Creating', 'ResolvingDNS', 'Succeeded'. sample: Succeeded secondary_endpoints: contains: blob: contains: connectionstring: description: - Connectionstring of the blob endpoint sample: DefaultEndpointsProtocol=https;EndpointSuffix=core.windows.net;AccountName=X;AccountKey=X;BlobEndpoint=X endpoint: description: - Gets the secondary blob endpoint. sample: https://testaccount001.blob.core.windows.net/ description: - Gets the secondary blob endpoint and connection string. type: complex queue: contains: connectionstring: description: - Connectionstring of the queue endpoint sample: DefaultEndpointsProtocol=https;EndpointSuffix=core.windows.net;AccountName=X;AccountKey=X;QueueEndpoint=X endpoint: description: - Gets the secondary queue endpoint. sample: https://testaccount001.queue.core.windows.net/ description: - Gets the secondary queue endpoint and connection string. type: complex table: contains: connectionstring: description: - Connectionstring of the table endpoint sample: DefaultEndpointsProtocol=https;EndpointSuffix=core.windows.net;AccountName=X;AccountKey=X;TableEndpoint=X endpoint: description: - Gets the secondary table endpoint. sample: https://testaccount001.table.core.windows.net/ description: - Gets the secondary table endpoint and connection string. type: complex description: - Gets the URLs that are used to perform a retrieval of a public blob, queue, or table object from the secondary location. - Only available if the SKU name is Standard_RAGRS. type: complex secondary_location: description: - Gets the location of the geo-replicated secondary for the storage account. - Only available if the accountType is Standard_GRS or Standard_RAGRS. sample: westus status_of_primary: description: - Gets the status indicating whether the primary location of the storage account is available or unavailable. sample: available status_of_secondary: description: - Gets the status indicating whether the secondary location of the storage account is available or unavailable. sample: available tags: description: - Resource tags. sample: tag1: abc type: dict description: List of storage account dicts in resource module's parameter format. returned: always type: complex