azure_rm_storageblob - Manage blob containers and blob objects.

New in version 2.1.

Synopsis

  • Create, update and delete blob containers and blob objects. Use to upload a file and store it as a blob object, or download a blob object to a file.

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 Default:
None
Active Directory username. Use when authenticating with an Active Directory user rather than service principal.
api_profile
(added in 2.5)
    Choices:
  • 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 Default:
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
(added in 2.5)
    Choices:
  • auto ←
  • cli
  • credential_file
  • env
Controls the source of the credentials to use for authentication.
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.
blob Default:
None
Name of a blob object within the container.

aliases: blob_name
blob_type
(added in 2.5)
    Choices:
  • block ←
  • page
Type of Blob Object.
cache_control Default:
None
Set the blob cache-control header.
cert_validation_mode
(added in 2.5)
    Choices:
  • validate
  • ignore
Default:
None
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 Default:
None
Azure client ID. Use when authenticating with a Service Principal.
cloud_environment
(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.
container
required
Name of a blob container within the storage account.

aliases: container_name
content_disposition Default:
None
Set the blob content-disposition header.
content_encoding Default:
None
Set the blob encoding header.
content_language Default:
None
Set the blob content-language header.
content_md5 Default:
None
Set the blob md5 hash value.
content_type Default:
None
Set the blob content-type header. For example, 'image/png'.
dest Default:
None
Destination file path. Use with state 'present' to download a blob.

aliases: destination
force Default:
no
Overwrite existing blob or file when uploading or downloading. Force deletion of a container that contains blobs.
password Default:
None
Active Directory user password. Use when authenticating with an Active Directory user rather than service principal.
profile Default:
None
Security profile found in ~/.azure/credentials file.
public_access
    Choices:
  • container
  • blob
Default:
None
Determine a container's level of public access. By default containers are private. Can only be set at time of container creation.
resource_group
required
Name of the resource group to use.

aliases: resource_group_name
secret Default:
None
Azure client secret. Use when authenticating with a Service Principal.
src Default:
None
Source file path. Use with state 'present' to upload a blob.

aliases: source
state
    Choices:
  • absent
  • present ←
Assert the state of a container or blob.
Use state 'absent' with a container value only to delete a container. Include a blob value to remove a specific blob. A container will not be deleted, if it contains blobs. Use the force option to override, deleting the container and all associated blobs.
Use state 'present' to create or update a container and upload or download a blob. If the container does not exist, it will be created. If it exists, it will be updated with configuration options. Provide a blob name and either src or dest to upload or download. Provide a src path to upload and a dest path to download. If a blob (uploading) or a file (downloading) already exists, it will not be overwritten unless the force parameter is true.
storage_account_name
required
Name of the storage account to use.

aliases: account_name, storage_account
subscription_id Default:
None
Your Azure subscription Id.
tags Default:
None
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 Default:
None
Azure tenant ID. Use when authenticating with a Service Principal.

Notes

Note

  • For authentication with Azure you can pass parameters, set environment variables or use a profile stored in ~/.azure/credentials. Authentication is 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 container foo
  azure_rm_storageblob:
    resource_group: testing
    storage_account_name: clh0002
    container: foo
    state: absent

- name: Create container foo and upload a file
  azure_rm_storageblob:
    resource_group: Testing
    storage_account_name: clh0002
    container: foo
    blob: graylog.png
    src: ./files/graylog.png
    public_access: container
    content_type: 'application/image'

- name: Download the file
  azure_rm_storageblob:
    resource_group: Testing
    storage_account_name: clh0002
    container: foo
    blob: graylog.png
    dest: ~/tmp/images/graylog.png

Return Values

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

Key Returned Description
blob
dict
 when a blob is operated on
Facts about the current state of the blob.

Sample:
{'content_length': 136532, 'last_modified': '09-Mar-2016 22:08:25 +0000', 'name': 'graylog.png', 'tags': {}, 'content_settings': {'content_language': None, 'content_encoding': None, 'content_type': 'application/image', 'content_md5': None, 'content_disposition': None, 'cache_control': None}, 'type': 'BlockBlob'}
container
dict
 always
Facts about the current state of the selected container.

Sample:
{'last_mdoified': '09-Mar-2016 19:28:26 +0000', 'name': 'foo', 'tags': {}}


Status

This module is flagged as preview which means that it is not guaranteed to have a backwards compatible interface.

Author

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

Hint

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

© 2012–2018 Michael DeHaan
© 2018–2019 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.5/modules/azure_rm_storageblob_module.html