azure.azcollection.azure_rm_afdendpoint_info module – Get Azure Front Door Endpoint facts to be used with Standard or Premium Frontdoor Service
Note
This module is part of the azure.azcollection collection (version 2.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_afdendpoint_info
.
New in azure.azcollection 2.4.0
Synopsis
Get facts for a specific Azure Front Door (AFD) Endpoint or all AFD Endpoints.
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 |
---|---|
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: |
|
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:
|
|
Parent argument. |
|
Parent argument. |
|
Limit results to a specific AFD Endpoint. |
|
Active Directory user password. Use when authenticating with an Active Directory user rather than service principal. |
|
Security profile found in ~/.azure/credentials file. |
|
Name of the AFD profile. |
|
Name of the resource group where this AFD Profile belongs. |
|
Azure client secret. Use when authenticating with a Service Principal. |
|
Your Azure subscription Id. |
|
Limit results by providing a list of tags. Format tags as ‘key’ or ‘key:value’. |
|
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 login
command.
Examples
- name: Get facts for all Endpoints in AFD Profile
azure_rm_afdendpoint_info:
resource_group: myResourceGroup
profile_name: myCDNProfile
tags:
- key
- key:value
- name: Get facts of specific AFD Endpoint
azure_rm_afdendpoint_info:
resource_group: myResourceGroup
profile_name: myCDNProfile
name: myEndpoint1
Return Values
Common return values are documented here, the following are the fields unique to this module:
Key |
Description |
---|---|
List of AFD Endpoints. Returned: always |
|
Indicates the endpoint name reuse scope. Returned: success Sample: |
|
Current state of the resource. Returned: success Sample: |
|
Whether to enable use of this rule. Returned: success Sample: |
|
The host name of the AFD Endpoint structured as endpointName.DNSZone. Returned: success Sample: |
|
ID of the AFD Endpoint. Returned: success Sample: |
|
Location of the AFD Endpoint. Returned: success Sample: |
|
Name of the AFD Endpoint. Returned: always Sample: |
|
Name of the AFD Profile which holds the Endpoint. Returned: always Sample: |
|
Provisioning status of the AFD Endpoint. Returned: success Sample: |
|
Name of a resource group where the AFD Endpoint exists. Returned: always Sample: |
|
The tags of the AFD Endpoint. Returned: success Sample: |
|
Resource type. Returned: success Sample: |
Authors
Jarret Tooley (@jartoo)