Parameter |
Choices/Defaults |
Comments |
ad_user
string
|
|
Active Directory username. Use when authenticating with an Active Directory user rather than service principal.
|
adfs_authority_url
string
added in 2.6 |
|
Azure AD authority url. Use when authenticating with Username/password, and has your own ADFS authority.
|
api_profile
string
added in 2.5 |
Default:
"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
boolean
|
|
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
string
added in 2.5 |
Choices:
- auto
- cli
- credential_file
- env
- msi
|
Controls the source of the credentials to use for authentication.
If not specified, ANSIBLE_AZURE_AUTH_SOURCE environment variable will be used and default to auto if variable is not defined.
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.
When set to msi , the host machine must be an azure resource with an enabled MSI extension. subscription_id or the environment variable 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 msi was added in Ansible 2.6.
|
blob
-
|
|
Name of a blob object within the container.
aliases: blob_name
|
blob_type
-
added in 2.5 |
|
Type of blob object.
|
cache_control
-
|
|
Set the blob cache-control header.
|
cert_validation_mode
string
added in 2.5 |
|
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
string
|
|
Azure client ID. Use when authenticating with a Service Principal.
|
cloud_environment
string
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
-
|
|
Set the blob content-disposition header.
|
content_encoding
-
|
|
Set the blob encoding header.
|
content_language
-
|
|
Set the blob content-language header.
|
content_md5
-
|
|
Set the blob md5 hash value.
|
content_type
-
|
|
Set the blob content-type header. For example image/png .
|
dest
-
|
|
Destination file path. Use with state present to download a blob.
aliases: destination
|
force
boolean
|
|
Overwrite existing blob or file when uploading or downloading. Force deletion of a container that contains blobs.
|
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
-
|
|
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
string
|
|
Azure client secret. Use when authenticating with a Service Principal.
|
src
-
|
|
Source file path. Use with state present to upload a blob.
aliases: source
|
state
-
|
Choices:
- absent
present ←
|
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 force=true.
|
storage_account_name
-
/ required
|
|
Name of the storage account to use.
aliases: account_name, storage_account
|
subscription_id
string
|
|
Your Azure subscription Id.
|
tags
dictionary
|
|
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
string
|
|
Azure tenant ID. Use when authenticating with a Service Principal.
|