community.azure.azure_rm_cdnendpoint_info module – Get Azure CDN endpoint facts

Note

This module is part of the community.azure collection (version 1.1.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 community.azure.

To use it in a playbook, specify: community.azure.azure_rm_cdnendpoint_info.

DEPRECATED

Removed in

version 2.0.0

Why

The Ansible collection community.azure is deprecated. Use azure.azcollection instead.

Alternative

Use azure.azcollection.azure_rm_cdnendpoint_info instead.

Synopsis

  • Get facts for a specific Azure CDN endpoint or all Azure CDN endpoints.

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

ad_user

string

Active Directory username. Use when authenticating with an Active Directory user rather than service principal.

adfs_authority_url

string

added in 0.0.1 of azure.azcollection

Azure AD authority url. Use when authenticating with Username/password, and has your own ADFS authority.

api_profile

string

added in 0.0.1 of azure.azcollection

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 0.0.1 of azure.azcollection

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 0.0.1 of azure.azcollection

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.

cloud_environment

string

added in 0.0.1 of azure.azcollection

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”

log_mode

string

Parent argument.

log_path

string

Parent argument.

name

string

Limit results to a specific Azure CDN endpoint.

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 CDN profile.

resource_group

string / required

Name of resource group where this CDN profile belongs to.

secret

string

Azure client secret. Use when authenticating with a Service Principal.

subscription_id

string

Your Azure subscription Id.

tags

string

Limit results by providing a list of tags. Format tags as ‘key’ or ‘key:value’.

tenant

string

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
  community.azure.azure_rm_cdnendpoint_info:
    resource_group: myResourceGroup
    profile_name: myCDNProfile

- name: Get facts of specific CDN endpoint
  community.azure.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

cdnendpoints

complex

List of Azure CDN endpoints.

Returned: always

content_types_to_compress

list / elements=string

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

string

ID of the Azure CDN endpoint.

Returned: success

Sample: “/subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourcegroups/myCDN/providers/Microsoft.Cdn/profiles/myProfile/endpoints/myEndpoint1”

is_compression_enabled

boolean

Indicates whether content compression is enabled on CDN.

Returned: success

Sample: true

is_http_allowed

boolean

Indicates whether HTTP traffic is allowed on the endpoint.

Returned: success

Sample: true

is_https_allowed

boolean

Indicates whether HTTPS traffic is allowed on the endpoint.

Returned: success

Sample: true

location

string

Location of the Azure CDN endpoint.

Returned: success

Sample: “WestUS”

name

string

Name of the Azure CDN endpoint.

Returned: always

Sample: “myEndpoint”

origin_host_header

string

The host header value sent to the origin with each request.

Returned: success

Sample: “xxxxxxxx.blob.core.windows.net”

origin_path

string

A directory path on the origin that CDN can use to retrieve content from.

Returned: success

Sample: “/pic/”

origins

string

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”}

profile_name

string

Name of the Azure CDN profile that this endpoint is attached to.

Returned: always

Sample: “myProfile”

provisioning_state

string

Provisioning status of the Azure CDN endpoint.

Returned: success

Sample: “Succeeded”

query_string_caching_behavior

string

Defines how CDN caches requests that include query strings.

Returned: success

Sample: “IgnoreQueryString”

resource_group

string

Name of a resource group where the Azure CDN endpoint exists.

Returned: always

Sample: “myResourceGroup”

resource_state

string

Resource status of the profile.

Returned: success

Sample: “Running”

tags

list / elements=string

The tags of the Azure CDN endpoint.

Returned: success

Sample: “foo”

Status

  • This module will be removed in version 2.0.0. [deprecated]

  • For more information see DEPRECATED.

Authors

  • Hai Cao (@caohai)

  • Yunge zhu (@yungezz)