W3cubDocs

/Ansible

azure.azcollection.azure_rm_afdorigin_info module – Get Azure Front Door Origin facts to be used with Standard or Premium Frontdoor Service

Note

This module is part of the azure.azcollection collection (version 3.7.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_afdorigin_info.

New in azure.azcollection 3.4.0

Synopsis
Requirements
Parameters
Notes
See Also
Examples
Return Values

Synopsis

Get facts for a specific Azure Front Door (AFD) Origin or all AFD Origins.
This differs from the Front Door classic service and only is intended to be used by the Standard or Premium service offering.

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
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	Limit results to a specific AFD Origin.
origin_group_name string / required	Name of the origin group which is unique within the profile.
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 AFD profile.
resource_group string / required	Name of the resource group where this AFD Profile belongs.
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.

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.

Examples

- name: Get facts for all Origins in AFD Profile
  azure_rm_afdorigin_info:
    resource_group: myResourceGroup
    profile_name: myCDNProfile

- name: Get facts of specific AFD Origin
  azure_rm_afdorigin_info:
    name: myOrigin1
    profile_name: myCDNProfile
    resource_group: myResourceGroup

Return Values

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

Key	Description
afdorigins complex	List of AFD Origins. Returned: always
azure_origin string	Resource reference to the AFD origin resource. Returned: success
deployment_status string	Current state of the resource. Returned: success Sample: `"NotStarted"`
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. Returned: success Sample: `"Enabled"`
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. Returned: success
http_port integer	The value of the HTTP port. Must be between 1 and 65535. Returned: success Sample: `80`
https_port integer	The value of the HTTPS port. Must be between 1 and 65535. Returned: success Sample: `443`
id string	ID of the AFD Origin. Returned: success Sample: `"/subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxx/resourcegroups/myRG/providers/Microsoft.Cdn/profiles/myProf/origingroups/myOG/origins/myO"`
name string	Name of the AFD Origin. Returned: success
origin_group_name string	Name of the origin group which is unique within the profile. Returned: success
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. Returned: success
priority integer	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. Returned: success
profile_name string	Name of the AFD Profile where the Origin will be added. Returned: success
provisioning_state string	Provisioning status of the AFD Origin. Returned: success Sample: `"Succeeded"`
resource_group string	Name of a resource group where the AFD Origin exists or will be created. Returned: success
shared_private_link_resource dictionary	The properties of the private link resource for private origin. Returned: success
group_id string	The group id from the provider of resource the shared private link resource is for. Returned: success
private_link string	The resource id of the resource the shared private link resource is for. Returned: success
private_link_location string	The location of the shared private link resource. Returned: success
request_message string	The request message for requesting approval of the shared private link resource. Returned: success
status string	Status of the shared private link resource. Can be Pending, Approved, Rejected, Disconnected, or Timeout. Returned: success Sample: `"Approved"`
type string	Resource type. Returned: success Sample: `"Microsoft.Cdn/profiles/origingroups/origins"`
weight integer	Weight of the origin in given origin group for load balancing. Must be between 1 and 1000. Returned: success

Authors

Jarret Tooley (@jartoo)

Collection links

© 2012–2018 Michael DeHaan
© 2018–2025 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/latest/collections/azure/azcollection/azure_rm_afdorigin_info_module.html