azure_rm_afdorigin

Manage an Azure Front Door Origin to be used with Standard or Premium Frontdoor

Collection: azure.azcollection

Full Name: azure.azcollection.azure_rm_afdorigin

Synopsis

Manage an Azure Front Door Origin to be used with Standard or Premium Frontdoor

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.
azure_origin	string			Resource reference to the AFD origin resource.
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.
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 health probes to be made against backends defined under backend pools.
Health probes can only be disabled if there is a single enabled backend in single enabled backend pool.
host_name	string			The address of the origin. Domain names, IPv4 addresses, and IPv6 addresses are supported.
This should be unique across all origins in an endpoint.
http_port	int		`80`	The value of the HTTP port. Must be between 1 and 65535.
https_port	int		`443`	The value of the HTTPS port. Must be between 1 and 65535.
log_mode	string			Parent argument.
log_path	string			Parent argument.
name	string	yes		Name of the origin that is unique within the AFD Profile.
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_name	string	yes		Name of the origin group which is unique within the profile.
origin_host_header	string			The host header value sent to the origin with each request. If you leave this blank, the request hostname determines this value.
Azure Front Door origins, such as Web Apps, Blob Storage,
and Cloud Services require this host header value to match the origin hostname by default.
This overrides the host header defined at the AFD Endpoint.
password	string			Active Directory user password. Use when authenticating with an Active Directory user rather than service principal.
priority	int			Priority of origin in given origin group for load balancing.
Higher priorities will not be used for load balancing if any lower priority origin is healthy. Must be between 1 and 5.
profile	string			Security profile found in ~/.azure/credentials file.
profile_name	string	yes		Name of the AFD Profile.
resource_group	string	yes		Name of a resource group where the AFD Origin exists or will be created.
secret	string			Azure client secret. Use when authenticating with a Service Principal.
shared_private_link_resource	dict			The properties of the private link resource for private origin.
state	string		`present`	Assert the state of the AFD Profile. Use C(present) to create or update an AFD profile and C(absent) to delete it.
subscription_id	string			Your Azure subscription Id.
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.
weight	int			Weight of the origin in given origin group for load balancing. Must be between 1 and 1000.
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 Origin
  azure.azcollection.azure_rm_afdorigin:
    name: myOrigin
    origin_group_name: myOriginGroup
    profile_name: myProfile
    resource_group: myResourceGroup
    state: present
    host_name: "10.0.0.1"
    origin_host_header: "10.0.0.1"
    http_port: 80
    https_port: 443
    priority: 1
    weight: 1000

- name: Delete an AFD Origin
  azure.azcollection.azure_rm_afdorigin:
    name: myOrigin
    origin_group_name: myOriginGroup
    profile_name: myProfile
    resource_group: myResourceGroup
    state: absent