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 0.0.1 of azure.azcollection
|
|
Azure AD authority url. Use when authenticating with Username/password, and has your own ADFS authority.
|
api_profile
string
added in 0.0.1 of azure.azcollection
|
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 0.0.1 of azure.azcollection
|
Choices:
auto ←
- cli
- credential_file
- env
- msi
|
Controls the source of the credentials to use for authentication.
Can also be set via the ANSIBLE_AZURE_AUTH_SOURCE environment variable.
When set to auto (the default) the precedence is module parameters -> env -> credential_file -> cli .
When set to env , the credentials will be read from the environment variables
When set to credential_file , it will read the profile from ~/.azure/credentials .
When set to cli , the credentials will be sources from the Azure CLI profile. subscription_id or the environment variable 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 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.
|
cert_validation_mode
string
added in 0.0.1 of azure.azcollection
|
|
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 0.0.1 of azure.azcollection
|
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.
|
content_types_to_compress
list
/ elements=string
|
|
List of content types on which compression applies.
This value should be a valid MIME type.
|
is_compression_enabled
boolean
|
|
Indicates whether content compression is enabled on CDN.
|
is_http_allowed
boolean
|
|
Indicates whether HTTP traffic is allowed on the endpoint.
|
is_https_allowed
boolean
|
|
Indicates whether HTTPS traffic is allowed on the endpoint.
|
location
string
|
|
Valid azure location. Defaults to location of the resource group.
|
name
string
/ required
|
|
Name of the Azure CDN endpoint.
|
origin_host_header
string
|
|
The host header value sent to the origin with each request.
|
origin_path
string
|
|
A directory path on the origin that CDN can use to retrieve content from.
E.g. contoso.cloudapp.net/originpath.
|
origins
string
/ required
|
|
Set of source of the content being delivered via CDN.
|
|
host_name
string
/ required
|
|
The address of the origin.
It can be a domain name, IPv4 address, or IPv6 address.
|
|
http_port
integer
|
|
The value of the HTTP port. Must be between 1 and 65535 .
|
|
https_port
integer
|
|
The value of the HTTPS port. Must be between 1 and 65535 .
|
|
name
string
/ required
|
|
Origin name.
|
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.
|
profile_name
string
/ required
|
|
Name of the CDN profile where the endpoint attached to.
|
purge
boolean
|
|
Use with state=present to purge the endpoint.
|
purge_content_paths
list
/ elements=string
|
Default:
["/"]
|
Use with state=present and purge=true to specify content paths to be purged.
|
query_string_caching_behavior
string
|
Choices:
ignore_query_string ←
- bypass_caching
- use_query_string
- not_set
|
Defines how CDN caches requests that include query strings.
|
resource_group
string
/ required
|
|
Name of a resource group where the Azure CDN endpoint exists or will be created.
|
secret
string
|
|
Azure client secret. Use when authenticating with a Service Principal.
|
started
boolean
|
|
Use with state=present to start the endpoint.
|
state
string
|
Choices:
- absent
present ←
|
Assert the state of the Azure CDN endpoint. Use present to create or update a Azure CDN endpoint and absent to delete it.
|
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.
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.
|