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 (on host that executes module)
- python >= 2.7
- azure >= 2.0.0
Options
| parameter | required | default | choices | comments |
|---|---|---|---|---|
| ad_user | no | Active Directory username. Use when authenticating with an Active Directory user rather than service principal. | ||
| append_tags | no | True | 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. | |
| blob | no | Name of a blob object within the container. aliases: blob_name | ||
| cache_control | no | Set the blob cache-control header. | ||
| client_id | no | Azure client ID. Use when authenticating with a Service Principal. | ||
| cloud_environment | no | 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 | yes | Name of a blob container within the storage account. aliases: container_name | ||
| content_disposition | no | Set the blob content-disposition header. | ||
| content_encoding | no | Set the blob encoding header. | ||
| content_language | no | Set the blob content-language header. | ||
| content_md5 | no | Set the blob md5 hash value. | ||
| content_type | no | Set the blob content-type header. For example, 'image/png'. | ||
| dest | no | Destination file path. Use with state 'present' to download a blob. aliases: destination | ||
| force | no | Overwrite existing blob or file when uploading or downloading. Force deletion of a container that contains blobs. | ||
| password | no | Active Directory user password. Use when authenticating with an Active Directory user rather than service principal. | ||
| profile | no | Security profile found in ~/.azure/credentials file. | ||
| public_access | no |
| Determine a container's level of public access. By default containers are private. Can only be set at time of container creation. | |
| resource_group | yes | Name of the resource group to use. aliases: resource_group_name | ||
| secret | no | Azure client secret. Use when authenticating with a Service Principal. | ||
| src | no | Source file path. Use with state 'present' to upload a blob. aliases: source | ||
| state | no | 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 | yes | Name of the storage account to use. aliases: account_name, storage_account | ||
| subscription_id | no | Your Azure subscription Id. | ||
| tags | no | 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 | no | Azure tenant ID. Use when authenticating with a Service Principal. |
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 Return Values, the following are the fields unique to this module:
| name | description | returned | type | sample |
|---|---|---|---|---|
| blob | Facts about the current state of the blob. | when a blob is operated on | dict | {'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 | Facts about the current state of the selected container. | always | dict | {'last_mdoified': '09-Mar-2016 19:28:26 +0000', 'name': 'foo', 'tags': {}} |
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.
Status
This module is flagged as preview which means that it is not guaranteed to have a backwards compatible interface.
For help in developing on modules, should you be so inclined, please read Community Information & Contributing, Testing Ansible and Developing Modules.
© 2012–2018 Michael DeHaan
© 2018–2019 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.4/azure_rm_storageblob_module.html