azure.azcollection.azure_rm_afdrules module – Manage an Azure Front Door Rules

Note

This module is part of the azure.azcollection collection (version 3.8.0).

You might already have this collection installed if you are using the ansible package. It is not included in ansible-core. To check whether it is installed, run ansible-galaxy collection list.

To install it, use: ansible-galaxy collection install azure.azcollection. You need further requirements to be able to use this module, see Requirements for details.

To use it in a playbook, specify: azure.azcollection.azure_rm_afdrules.

New in azure.azcollection 3.4.0

Synopsis

  • Create, update and delete an Azure Front Door Rules to be used by a Front Door Service Profile created using azure_rm_cdnprofile.

Requirements

The below requirements are needed on the host that executes this module.

  • python >= 2.7

  • The host that executes this module must have the azure.azcollection collection installed via galaxy

  • All python packages listed in collection’s requirements.txt must be installed via pip on the host that executes modules from azure.azcollection

  • Full installation instructions may be found https://galaxy.ansible.com/azure/azcollection

Parameters

Parameter

Comments

actions

list / elements=dictionary

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

cache_behavior

string

Caching behavior for the requests.

Choices:

  • "BypassCache"

  • "Override"

  • "SetIfMissing"

  • "HonorOrigin"

  • "OverrideAlways"

  • "OverrideIfOriginMissing"

cache_duration

string

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

custom_fragment

string

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

custom_hostname

string

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

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.

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.

destination

string

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

destination_protocol

string

Protocol to use for the redirect.

Choices:

  • "Http"

  • "Https"

  • "MatchRequest" ← (default)

forwarding_protocol

string

Protocol this rule will use when forwarding traffic to backends.

Choices:

  • "Http"

  • "Https"

  • "MatchRequest" ← (default)

header_action

string

Action to perform.

Choices:

  • "Append"

  • "Overwrite"

  • "Delete"

header_name

string

Name of the header to modify.

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.

Choices:

  • "Enabled"

  • "Disabled"

name

string / required

The name of the action for the delivery rule.

Choices:

  • "ModifyRequestHeader"

  • "ModifyResponseHeader"

  • "RouteConfigurationOverride"

  • "UrlRedirect"

  • "UrlRewrite"

origin_group

string

defines the OriginGroup that would override the DefaultOriginGroup.

preserve_unmatched_path

boolean

Whether to preserve unmatched path.

Choices:

  • false

  • true ← (default)

query_parameters

string

query parameters to include or exclude (comma separated).

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.

Choices:

  • "IgnoreQueryString"

  • "UseQueryString"

  • "IgnoreSpecifiedQueryStrings"

  • "IncludeSpecifiedQueryStrings"

redirect_type

string

The redirect type the rule will use when redirecting traffic.

Choices:

  • "Moved"

  • "Found"

  • "TemporaryRedirect"

  • "PermanentRedirect"

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.

value

string

Value for the specified action.

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"

conditions

list / elements=dictionary

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

match_values

list / elements=string

The match value for the condition of the delivery rule.

name

string / required

The name of the condition for the delivery rule.

Choices:

  • "ClientPort"

  • "Cookies"

  • "HostName"

  • "HttpVersion"

  • "IsDevice"

  • "PostArgs"

  • "QueryString"

  • "RemoteAddress"

  • "RequestBody"

  • "RequestHeader"

  • "RequestMethod"

  • "RequestScheme"

  • "RequestUri"

  • "ServerPort"

  • "SocketAddr"

  • "SslProtocol"

  • "UrlFileExtension"

  • "UrlFileName"

  • "UrlPath"

negate_condition

boolean

Describes if this is a negate condition or not.

Choices:

  • false

  • true

operator

string / required

Describes operator to be matched.

Choices:

  • "Any"

  • "Equal"

  • "Contains"

  • "BeginsWith"

  • "EndsWith"

  • "LessThan"

  • "LessThanOrEqual"

  • "GreaterThan"

  • "GreaterThanOrEqual"

  • "RegEx"

  • "IPMatch"

  • "GeoMatch"

selector

string

Name of item to be matched.

transforms

list / elements=string

List of transforms.

Choices:

  • "Lowercase"

  • "RemoveNulls"

  • "Trim"

  • "Uppercase"

  • "URLDecode"

  • "URLEncode"

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.

match_processing_behavior

string

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

Choices:

  • "Continue" ← (default)

  • "Stop"

name

string / required

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

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.

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.

state

string

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

Choices:

  • "absent"

  • "present" ← (default)

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.

Notes

Note

  • For authentication with Azure you can pass parameters, set environment variables, use a profile stored in ~/.azure/credentials, or log in before you run your tasks or playbook with az login.

  • Authentication is also possible using a service principal or Active Directory user.

  • To authenticate via service principal, pass subscription_id, client_id, secret and tenant or set environment variables AZURE_SUBSCRIPTION_ID, AZURE_CLIENT_ID, AZURE_SECRET and AZURE_TENANT.

  • To authenticate via Active Directory user, pass ad_user and password, or set AZURE_AD_USER and AZURE_PASSWORD in the environment.

  • Alternatively, credentials can be stored in ~/.azure/credentials. This is an ini file containing a [default] section and the following keys: subscription_id, client_id, secret and tenant or subscription_id, ad_user and password. It is also possible to add additional profiles. Specify the profile by passing profile or setting AZURE_PROFILE in the environment.

See Also

See also

Sign in with Azure CLI

How to authenticate using the az login command.

Examples

- name: Create an AFD Rule with some actions and conditions
  azure_rm_afdrules:
    name: myRule1
    rule_set_name: myRuleset
    profile_name: myProfile
    resource_group: myResourceGroup
    match_processing_behavior: Continue
    order: 1
    action:
      - name: ModifyResponseHeader
        header_action: Append
        header_name: Content-Security-Policy
        value: "frame-ancestors 'response'"
      - name: RouteConfigurationOverride
        origin_group: "myOtherOriginGroup"
    conditions:
      - name: UrlPath
        match_values:
          - ".auth"
        negate_condition: false
        operator: "BeginsWith"
        transforms:
          - LowerCase

Return Values

Common return values are documented here, the following are the fields unique to this module:

Key

Description

id

string

Resource ID.

Returned: always

Authors

  • Jarret Tooley (@jartoo)