ad_user

string

Active Directory username. Use when authenticating with an Active Directory user rather than service principal.

adfs_authority_url

string

added in azure.azcollection 0.0.1

Azure AD authority url. Use when authenticating with Username/password, and has your own ADFS authority.

api_profile

string

added in azure.azcollection 0.0.1

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.

Default: "latest"

auth_source

string

added in azure.azcollection 0.0.1

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.

Choices:

• "auto" ← (default)
• "cli"
• "credential_file"
• "env"
• "msi"

cert_validation_mode

string

added in azure.azcollection 0.0.1

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.

Choices:

• "ignore"
• "validate"

client_id

string

Azure client ID. Use when authenticating with a Service Principal or Managed Identity (msi).

Can also be set via the AZURE_CLIENT_ID environment variable.

cloud_environment

string

added in azure.azcollection 0.0.1

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.

Default: "AzureCloud"

disable_instance_discovery

boolean

added in azure.azcollection 2.3.0

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 AZURE_DISABLE_INSTANCE_DISCOVERY environment variable.

Choices:

• false ← (default)
• true

log_mode

string

Parent argument.

log_path

string

Parent argument.

name

string

Name of the delivery rule which is unique within the endpoint.

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 Azure Front Door Standard or Azure Front Door Premium profile which is unique within the resource group

resource_group

string / required

Name of the Resource group within the Azure subscription.

rule_set_name

string / required

Name of the rule set under the profile.

secret

string

Azure client secret. Use when authenticating with a Service Principal.

subscription_id

string

Your Azure subscription Id.

tenant

string

Azure tenant ID. Use when authenticating with a Service Principal.

thumbprint

string

added in azure.azcollection 1.14.0

The thumbprint of the private key specified in x509_certificate_path.

Use when authenticating with a Service Principal.

Required if x509_certificate_path is defined.

x509_certificate_path

path

added in azure.azcollection 1.14.0

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.

afdrules

complex

List of AFD Rules.

Returned: always

actions

list / elements=dictionary

A list of actions that are executed when all the conditions of a rule are satisfied.

Returned: success

cache_behavior

string

Caching behavior for the requests.

Returned: success

cache_duration

string

The duration for which the content needs to be cached. Allowed format is [d.]hh:mm:ss.

Returned: success

custom_fragment

string

Fragment to add to the redirect URL. Fragment is the part of the URL that comes after

Returned: success

custom_hostname

string

Host to redirect. Leave empty to use the incoming host as the destination host.

Returned: success

custom_path

string

The full path to redirect. Path cannot be empty and must start with /. Leave empty to use the incoming path as destination path.

Returned: success

custom_query_string

string

The set of query strings to be placed in the redirect URL.

Setting this value would replace any existing query string; leave empty to preserve the incoming query string.

Query string must be in <key>=:code:<value> format. ? and & will be added automatically so do not include them.

Returned: success

destination

string

Define the relative URL to which the above requests will be rewritten by.

Returned: success

destination_protocol

string

Protocol to use for the redirect.

Returned: success

forwarding_protocol

string

Protocol this rule will use when forwarding traffic to backends.

Returned: success

header_action

string

Action to perform.

Returned: success

header_name

string

Name of the header to modify.

Returned: success

is_compression_enabled

string

The caching configuration for this route. Indicates whether content compression is enabled on AzureFrontDoor.

If compression is enabled, content will be served as compressed if user requests for a compressed version.

Content won’t be compressed on AzureFrontDoor when requested content is smaller than 1 byte or larger than 1 MB.

Returned: success

name

string

The name of the action for the delivery rule.

Returned: success

origin_group

string

defines the OriginGroup that would override the DefaultOriginGroup.

Returned: success

preserve_unmatched_path

boolean

Whether to preserve unmatched path.

Returned: success

query_parameters

string

query parameters to include or exclude (comma separated).

Returned: success

query_string_caching_behavior

string

The caching configuration for this route. Defines how Frontdoor caches requests that include query strings.

You can ignore any query strings when caching, ignore specific query strings, cache every request with a unique URL,

or cache specific query strings.

Returned: success

redirect_type

string

The redirect type the rule will use when redirecting traffic.

Returned: success

source_pattern

string

Define a request URI pattern that identifies the type of requests that may be rewritten.

If value is blank, all strings are matched.

Returned: success

value

string

Value for the specified action.

Returned: success

conditions

list / elements=dictionary

A list of conditions that must be matched for the actions to be executed.

Returned: success

match_values

list / elements=string

The match value for the condition of the delivery rule.

Returned: success

name

string

The name of the condition for the delivery rule.

Returned: success

negate_condition

boolean

Describes if this is a negate condition or not.

Returned: success

operator

string

Describes operator to be matched.

Returned: success

selector

string

Name of item to be matched.

Returned: success

transforms

list / elements=string

List of transforms.

Returned: success

match_processing_behavior

string

If this rule is a match should the rules engine continue running the remaining rules or stop.

Returned: success

name

string

Name of the delivery rule which is unique within the endpoint.

Returned: success

order

integer

The order in which the rules are applied for the endpoint.

A rule with a lesser order will be applied before a rule with a greater order. Rule with order 0 is a special rule.

It does not require any condition and actions listed in it will always be applied.

Returned: success

profile_name

string

Name of the Azure Front Door Standard or Azure Front Door Premium profile which is unique within the resource group.

Returned: success

resource_group

string

Name of the Resource group within the Azure subscription.

Returned: success

rule_set_name

string

Name of the rule set under the profile.

Returned: success

state

string

Assert the state of the CDN profile. Use present to create or update a CDN profile and absent to delete it.

Returned: success

type

string

Resource type.

Returned: success