Try SpotterManage blob containers and blob objects
| "added in version" 0.0.1 of azure.azcollection"
Authors: Chris Houseknecht (@chouseknecht), Matt Davis (@nitzmahone)
Install with ansible-galaxy collection install azure.azcollection:==2.3.0
collections:
- name: azure.azcollection
version: 2.3.0Create, 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(upload and download mode)
Use to upload a batch of files under a given directory(batch upload mode)
In the batch upload mode, the existing blob object will be overwritten if a blob object with the same name is to be created.
the module can work exclusively in three modes, when C(batch_upload_src) is set, it is working in batch upload mode; when C(src) is set, it is working in upload mode and when C(dst) is set, it is working in dowload mode.
- name: Remove container foo
azure_rm_storageblob:
resource_group: myResourceGroup
storage_account_name: clh0002
container: foo
state: absent
- name: Create container foo and upload a file
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_rm_storageblob:
resource_group: myResourceGroup
storage_account_name: clh0002
container: foo
blob: graylog.png
dest: ~/tmp/images/graylog.png
src:
aliases:
- source
description:
- Source file path. Use with state C(present) to upload a blob.
type: str
blob:
aliases:
- blob_name
description:
- Name of a blob object within the container.
type: str
dest:
aliases:
- destination
description:
- Destination file path. Use with state C(present) to download a blob.
type: path
tags:
description:
- 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.
type: dict
force:
default: false
description:
- Overwrite existing blob or file when uploading or downloading. Force deletion of
a container that contains blobs.
type: bool
state:
choices:
- absent
- present
default: present
description:
- 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).
type: str
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
auth_mode:
choices:
- key
- login
default: key
description:
- 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).
type: str
version_added: 1.19.0
version_added_collection: azure.azcollection
blob_type:
choices:
- block
- page
default: block
description:
- Type of blob object.
type: str
version_added: 0.0.1
version_added_collection: azure.azcollection
client_id:
description:
- 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.
type: str
container:
aliases:
- container_name
description:
- Name of a blob container within the storage account.
required: true
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
append_tags:
default: true
description:
- 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.
type: bool
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
content_md5:
description:
- Set the blob md5 hash value.
type: str
content_type:
description:
- Set the blob content-type header. For example C(image/png).
type: str
cache_control:
description:
- Set the blob cache-control header.
type: str
public_access:
choices:
- container
- blob
description:
- A container's level of public access. By default containers are private.
- Can only be set at time of container creation.
type: str
resource_group:
aliases:
- resource_group_name
description:
- Name of the resource group to use.
required: true
type: str
subscription_id:
description:
- Your Azure subscription Id.
type: str
batch_upload_dst:
description:
- Base directory in container when upload batch of files.
type: path
batch_upload_src:
description:
- Batch upload source directory. Use with state C(present) to upload batch of files
under the directory.
type: path
content_encoding:
description:
- Set the blob encoding header.
type: str
content_language:
description:
- Set the blob content-language header.
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
content_disposition:
description:
- Set the blob content-disposition header.
type: str
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
storage_account_name:
aliases:
- account_name
- storage_account
description:
- Name of the storage account to use.
required: true
type: str
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
disable_instance_discovery:
default: false
description:
- 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.
type: bool
version_added: 2.3.0
version_added_collection: azure.azcollection
blob:
description:
- Facts about the current state of the blob.
returned: when a blob is operated on
sample:
content_length: 136532
content_settings:
cache_control: null
content_disposition: null
content_encoding: null
content_language: null
content_md5: null
content_type: application/image
last_modified: 09-Mar-2016 22:08:25 +0000
name: graylog.png
tags: {}
type: BlockBlob
type: dict
container:
description:
- Facts about the current state of the selected container.
returned: always
sample:
last_modified: 09-Mar-2016 19:28:26 +0000
name: foo
tags: {}
type: dict