azure.azcollection.azure_rm_afdroute module – Manage an Azure Front Door Route
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_afdroute.
New in azure.azcollection 3.4.0
Synopsis
Create, update and delete an Azure Front Door Route 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 |
|---|---|
Active Directory username. Use when authenticating with an Active Directory user rather than service principal. |
|
Azure AD authority url. Use when authenticating with Username/password, and has your own ADFS authority. |
|
Selects an API profile to use when communicating with Azure services. Default value of Default: |
|
Controls the source of the credentials to use for authentication. Can also be set via the When set to When set to When set to When set to When set to The Choices:
|
|
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 Choices:
|
|
Azure client ID. Use when authenticating with a Service Principal or Managed Identity (msi). Can also be set via the |
|
For cloud environments other than the US public cloud, the environment name (as defined by Azure Python SDK, eg, Default: |
|
The caching configuration/compression settings for this route. List of content types (str) on which compression applies. The value should be a valid MIME type. Required together (is_compression_enabled, content_types_to_compress, query_string_caching_behavior, query_parameters) |
|
Domain names referenced by this endpoint. ID will be looked up based on the name. |
|
To disable cache configuration, set this to true and do not include cache_configuration. This will override any cache_configuration settings you include. Choices:
|
|
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 Choices:
|
|
Whether to enable use of this rule. Permitted values are ‘Enabled’ or ‘Disabled’. Choices:
|
|
Name of the endpoint under the profile which is unique globally. |
|
Protocol this rule will use when forwarding traffic to backends. Choices:
|
|
Whether to automatically redirect HTTP traffic to HTTPS traffic. Choices:
|
|
The caching configuration/compression settings 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. Required together (is_compression_enabled, content_types_to_compress, query_string_caching_behavior, query_parameters) Choices:
|
|
whether this route will be linked to the default endpoint domain. Choices:
|
|
Parent argument. |
|
Parent argument. |
|
Name of the routing rule. |
|
A reference to the origin group. |
|
A directory path on the origin that AzureFrontDoor can use to retrieve content from, e.g. contoso.cloudapp.net/originpath. |
|
Active Directory user password. Use when authenticating with an Active Directory user rather than service principal. |
|
The route patterns of the rule. |
|
Security profile found in ~/.azure/credentials file. |
|
Name of the Azure Front Door Standard or Azure Front Door Premium profile which is unique within the resource group. |
|
The caching configuration for this route. query parameters to include or exclude (comma separated). Required together (is_compression_enabled, content_types_to_compress, query_string_caching_behavior, query_parameters) |
|
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. Required together (is_compression_enabled, content_types_to_compress, query_string_caching_behavior, query_parameters) Choices:
|
|
Name of the Resource group within the Azure subscription. |
|
List of rule set names referenced by this endpoint. |
|
Azure client secret. Use when authenticating with a Service Principal. |
|
Assert the state of the Route. Use Choices:
|
|
Your Azure subscription Id. |
|
List of supported protocols for this route. Choices:
Default: |
|
Azure tenant ID. Use when authenticating with a Service Principal. |
|
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. |
|
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 logincommand.
Examples
- name: Create an AFD Route
azure_rm_afdroute:
name: myRoute
endpoint_name: myEndpoint
origin_group: myOriginGroup
profile_name: myProfile
resource_group_name: myResourceGroup
state: present
route:
enabled_state: Disabled
forwarding_protocol: HttpsOnly
https_redirect: Enabled
patterns_to_match:
- "/*"
rule_sets:
- Security
supported_protocols:
- Https
- Http
link_to_default_domain: Enabled
- name: Delete an AFD Origin
azure_rm_afdroute:
name: myRoute
endpoint_name: myEndpoint
origin_group: myOriginGroup
profile_name: myProfile
resource_group_name: myResourceGroup
state: absent
Return Values
Common return values are documented here, the following are the fields unique to this module:
Key |
Description |
|---|---|
ID of the Route. Returned: always Sample: |