azure_rm_afdroute

Manage an Azure Front Door Route

Collection: azure.azcollection

Full Name: azure.azcollection.azure_rm_afdroute

Synopsis

Manage an Azure Front Door Route

Parameters

Name	Type	Required	Default	Description
ad_user	string			Active Directory username. Use when authenticating with an Active Directory user rather than service principal.
adfs_authority_url	string			Azure AD authority url. Use when authenticating with Username/password, and has your own ADFS authority.
api_profile	string		`latest`	Selects an API profile to use when communicating with Azure services. Default value of C(latest) is appropriate for public clouds; future values will allow use with Azure Stack.
auth_source	string		`auto`	Controls the source of the credentials to use for authentication.
Can also be set via the C(ANSIBLE_AZURE_AUTH_SOURCE) environment variable.
When set to C(auto) (the default) the precedence is module parameters -> C(env) -> C(credential_file) -> C(cli).
When set to C(env), the credentials will be read from the environment variables.
When set to C(credential_file), it will read the profile from C(~/.azure/credentials).
When set to C(cli), the credentials will be sources from the Azure CLI profile. C(subscription_id) or the environment variable C(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 C(msi), the host machine must be an azure resource with an enabled MSI extension. C(subscription_id) or the environment variable C(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 C(msi) was added in Ansible 2.6.
cert_validation_mode	string			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 C(ignore). Can also be set via credential file profile or the C(AZURE_CERT_VALIDATION) environment variable.
client_id	string			Azure client ID. Use when authenticating with a Service Principal or Managed Identity (msi).
Can also be set via the C(AZURE_CLIENT_ID) environment variable.
cloud_environment	string		`AzureCloud`	For cloud environments other than the US public cloud, the environment name (as defined by Azure Python SDK, eg, C(AzureChinaCloud), C(AzureUSGovernment)), or a metadata discovery endpoint URL (required for Azure Stack). Can also be set via credential file profile or the C(AZURE_CLOUD_ENVIRONMENT) environment variable.
content_types_to_compress	list			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)
custom_domains	list			Domain names referenced by this endpoint. ID will be looked up based on the name.
disable_cache_configuration	bool		`false`	To disable cache configuration, set this to true and do not include cache_configuration.
This will override any cache_configuration settings you include.
disable_instance_discovery	bool		`false`	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 C(AZURE_DISABLE_INSTANCE_DISCOVERY) environment variable.
enabled_state	string			Whether to enable use of this rule. Permitted values are ‘Enabled’ or ‘Disabled’.
endpoint_name	string	yes		Name of the endpoint under the profile which is unique globally.
forwarding_protocol	string			Protocol this rule will use when forwarding traffic to backends.
https_redirect	string		`Disabled`	Whether to automatically redirect HTTP traffic to HTTPS traffic.
is_compression_enabled	bool			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)
link_to_default_domain	string		`Disabled`	whether this route will be linked to the default endpoint domain.
log_mode	string			Parent argument.
log_path	string			Parent argument.
name	string	yes		Name of the routing rule.
oidc_token	string			Direct OpenID Connect (OIDC) token (JWT) used for workload identity authentication.
This token is exchanged with Azure AD using OIDC federated identity.
Useful in CI systems (for example GitHub Actions, Azure DevOps) where an OIDC token is provided directly by the platform.
Can also be set via the C(AZURE_FEDERATED_TOKEN) environment variable.
oidc_token_file_path	string			Path to a file containing an OpenID Connect (OIDC) token (JWT) used for workload identity authentication.
The file must contain only raw token.
This method is commonly used in platforms that materialize OIDC tokens as files
Can also be set via the C(AZURE_FEDERATED_TOKEN_FILE) environment variable.
origin_group	string			A reference to the origin group.
origin_path	string			A directory path on the origin that AzureFrontDoor can use to retrieve content from, e.g. contoso.cloudapp.net/originpath.
password	string			Active Directory user password. Use when authenticating with an Active Directory user rather than service principal.
patterns_to_match	list			The route patterns of the rule.
profile	string			Security profile found in ~/.azure/credentials file.
profile_name	string	yes		Name of the Azure Front Door Standard or Azure Front Door Premium profile which is unique within the resource group.
query_parameters	string			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)
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.
Required together (is_compression_enabled, content_types_to_compress, query_string_caching_behavior, query_parameters)
resource_group	string	yes		Name of the Resource group within the Azure subscription.
rule_sets	list			List of rule set names referenced by this endpoint.
secret	string			Azure client secret. Use when authenticating with a Service Principal.
state	string		`present`	Assert the state of the Route. Use C(present) to create or update a CDN profile and C(absent) to delete it.
subscription_id	string			Your Azure subscription Id.
supported_protocols	list		`[Http Https]`	List of supported protocols for this route.
tenant	string			Azure tenant ID. Use when authenticating with a Service Principal.
thumbprint	string			The thumbprint of the private key specified in I(x509_certificate_path).
Use when authenticating with a Service Principal.
Required if I(x509_certificate_path) is defined.
x509_certificate_path	string			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.

Example

yaml

- name: Create an AFD Route
  azure.azcollection.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.azcollection.azure_rm_afdroute:
    name: myRoute
    endpoint_name: myEndpoint
    origin_group: myOriginGroup
    profile_name: myProfile
    resource_group_name: myResourceGroup
    state: absent