azure_rm_storageblob

Manage blob containers and blob objects

Collection: azure.azcollection

Full Name: azure.azcollection.azure_rm_storageblob

Synopsis

Manage blob containers and blob objects

Parameters

Name	Type	Required	Default	Description
ad_user	string			Active Directory username. Use when authenticating with an Active Directory user rather than service principal.
adfs_authority_url	string			Azure AD authority url. Use when authenticating with Username/password, and has your own ADFS authority.
api_profile	string		`latest`	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.
append_tags	bool		`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.
auth_mode	string		`key`	The mode in which to run the command. C(login) mode will directly use your login credentials for the authentication.
The legacy C(key) mode will attempt to query for an account key if no authentication parameters for the account are provided.
Can also be set via the environment variable C(AZURE_STORAGE_AUTH_MODE).
auth_source	string		`auto`	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.
batch_upload_dst	string			Base directory in container when upload batch of files.
batch_upload_src	string			Batch upload source directory. Use with state C(present) to upload batch of files under the directory.
blob	string			Name of a blob object within the container.
blob_type	string		`block`	Type of blob object.
cache_control	string			Set the blob cache-control header.
cert_validation_mode	string			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.
client_id	string			Azure client ID. Use when authenticating with a Service Principal or Managed Identity (msi).
Can also be set via the C(AZURE_CLIENT_ID) environment variable.
cloud_environment	string		`AzureCloud`	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.
container	string	yes		Name of a blob container within the storage account.
content_disposition	string			Set the blob content-disposition header.
content_encoding	string			Set the blob encoding header.
content_language	string			Set the blob content-language header.
content_md5	string			Set the blob md5 hash value.
content_type	string			Set the blob content-type header. For example C(image/png).
dest	string			Destination file path. Use with state C(present) to download a blob.
disable_instance_discovery	bool		`false`	Determines whether or not instance discovery is performed when attempting to authenticate. Setting this to true will completely disable both instance discovery and authority validation. This functionality is intended for use in scenarios where the metadata endpoint cannot be reached such as in private clouds or Azure Stack. The process of instance discovery entails retrieving authority metadata from https://login.microsoft.com/ to validate the authority. By setting this to True, the validation of the authority is disabled. As a result, it is crucial to ensure that the configured authority host is valid and trustworthy.
Set via credential file profile or the C(AZURE_DISABLE_INSTANCE_DISCOVERY) environment variable.
force	bool		`false`	Overwrite existing blob or file when uploading or downloading. Force deletion of a container that contains blobs.
log_mode	string			Parent argument.
log_path	string			Parent argument.
oidc_token	string			Direct OpenID Connect (OIDC) token (JWT) used for workload identity authentication.
This token is exchanged with Azure AD using OIDC federated identity.
Useful in CI systems (for example GitHub Actions, Azure DevOps) where an OIDC token is provided directly by the platform.
Can also be set via the C(AZURE_FEDERATED_TOKEN) environment variable.
oidc_token_file_path	string			Path to a file containing an OpenID Connect (OIDC) token (JWT) used for workload identity authentication.
The file must contain only raw token.
This method is commonly used in platforms that materialize OIDC tokens as files
Can also be set via the C(AZURE_FEDERATED_TOKEN_FILE) environment variable.
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.
public_access	string			A container’s level of public access. By default containers are private.
Can only be set at time of container creation.
The I(public_access) parameter should not be set for private access.
If I(public_access) is not configured, access level is by default private. It can not be set explicitely to private.
resource_group	string	yes		Name of the resource group to use.
secret	string			Azure client secret. Use when authenticating with a Service Principal.
source_url	string			HTTP/HTTPS URL of the source file to copy directly into the blob.
The source must be publicly accessible, or authenticated via a shared access signature (SAS) appended to the URL, or via bearer token on supported Azure sources.
Only supported for block blobs.
src	string			Source file path. Use with state C(present) to upload a blob.
standard_blob_tier	string			Specifies the blob tier to set the blob to.
This is only applicable for block blobs on standard storage accounts.
state	string		`present`	State of a container or blob.
Use state C(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 I(force) option to override, deleting the container and all associated blobs.
Use state C(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 I(force=true).
storage_account_name	string	yes		Name of the storage account to use.
subscription_id	string			Your Azure subscription Id.
tags	dict			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.
thumbprint	string			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.
x509_certificate_path	string			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.

Example

yaml

- name: Remove container foo
  azure.azcollection.azure_rm_storageblob:
    resource_group: myResourceGroup
    storage_account_name: clh0002
    container: foo
    state: absent

- name: Create container foo and upload a file
  azure.azcollection.azure_rm_storageblob:
    resource_group: myResourceGroup
    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.azcollection.azure_rm_storageblob:
    resource_group: myResourceGroup
    storage_account_name: clh0002
    container: foo
    blob: graylog.png
    dest: ~/tmp/images/graylog.png

- name: Upload a blob directly from a web URL asynchronously (public HTTP/HTTPS)
  azure.azcollection.azure_rm_storageblob:
    resource_group: myResourceGroup
    storage_account_name: clh0002
    container: images
    blob: graylog.png
    source_url: https://example.com/path/to/graylog.png
    content_type: image/png
    cache_control: 'public, max-age=3600'
    standard_blob_tier: Hot
    state: present
  async: 1800
  poll: 0

- name: Upload a blob directly from a web URL (public HTTP/HTTPS)
  azure.azcollection.azure_rm_storageblob:
    resource_group: myResourceGroup
    storage_account_name: clh0002
    container: images
    blob: graylog.png
    source_url: https://example.com/path/to/graylog.png
    content_type: image/png
    cache_control: 'public, max-age=3600'
    standard_blob_tier: Hot
    state: present