azure.azcollection.azure_rm_cdnendpoint_info – Get Azure CDN endpoint facts
Note
This plugin is part of the azure.azcollection collection (version 1.10.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
.
To use it in a playbook, specify: azure.azcollection.azure_rm_cdnendpoint_info
.
New in version 0.1.2: of azure.azcollection
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-azure.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: “latest” |
|
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. |
|
For cloud environments other than the US public cloud, the environment name (as defined by Azure Python SDK, eg, Default: “AzureCloud” |
|
Parent argument. |
|
Parent argument. |
|
Limit results to a specific Azure CDN 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 CDN profile. |
|
Name of resource group where this CDN profile belongs to. |
|
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. |
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 CDN profile
azure_rm_cdnendpoint_info:
resource_group: myResourceGroup
profile_name: myCDNProfile
- name: Get facts of specific CDN endpoint
azure_rm_cdnendpoint_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 Azure CDN endpoints. Returned: always |
|
List of content types on which compression applies. Returned: success Sample: [“text/plain”, “text/html”, “text/css”, “text/javascript”, “application/x-javascript”, “application/javascript”, “application/json”, “application/xml”] |
|
ID of the Azure CDN endpoint. Returned: success Sample: “/subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourcegroups/myCDN/providers/Microsoft.Cdn/profiles/myProfile/endpoints/myEndpoint1” |
|
Indicates whether content compression is enabled on CDN. Returned: success Sample: true |
|
Indicates whether HTTP traffic is allowed on the endpoint. Returned: success Sample: true |
|
Indicates whether HTTPS traffic is allowed on the endpoint. Returned: success Sample: true |
|
Location of the Azure CDN endpoint. Returned: success Sample: “WestUS” |
|
Name of the Azure CDN endpoint. Returned: always Sample: “myEndpoint” |
|
The host header value sent to the origin with each request. Returned: success Sample: “xxxxxxxx.blob.core.windows.net” |
|
A directory path on the origin that CDN can use to retrieve content from. Returned: success Sample: “/pic/” |
|
The source of the content being delivered via CDN. Returned: success Sample: {“host_name”: “xxxxxxxx.blob.core.windows.net”, “http_port”: null, “https_port”: null, “name”: “xxxxxxxx-blob-core-windows-net”} |
|
Name of the Azure CDN profile that this endpoint is attached to. Returned: always Sample: “myProfile” |
|
Provisioning status of the Azure CDN endpoint. Returned: success Sample: “Succeeded” |
|
Defines how CDN caches requests that include query strings. Returned: success Sample: “IgnoreQueryString” |
|
Name of a resource group where the Azure CDN endpoint exists. Returned: always Sample: “myResourceGroup” |
|
Resource status of the profile. Returned: success Sample: “Running” |
|
The tags of the Azure CDN endpoint. Returned: success Sample: “foo” |
Authors
Hai Cao (@caohai)
Yunge zhu (@yungezz)