azure_rm_cdnendpoint_facts – Get Azure CDN endpoint facts

New in version 2.8.

Synopsis
Requirements
Parameters
Notes
See Also
Examples
Return Values
Status

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
azure >= 2.0.0

Parameters

Parameter	Choices/Defaults	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 2.6		Azure AD authority url. Use when authenticating with Username/password, and has your own ADFS authority.
api_profile string added in 2.5	Default: "latest"	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.
auth_source string added in 2.5	auto cli credential_file env msi	Controls the source of the credentials to use for authentication. If not specified, ANSIBLE_AZURE_AUTH_SOURCE environment variable will be used and default to `auto` if variable is not defined. `auto` will follow the default precedence of module parameters -> environment variables -> default profile in credential file `~/.azure/credentials`. When set to `cli`, the credentials will be sources from the default Azure CLI profile. Can also be set via the `ANSIBLE_AZURE_AUTH_SOURCE` environment variable. 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.
cert_validation_mode string added in 2.5	ignore validate	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.
client_id string		Azure client ID. Use when authenticating with a Service Principal.
cloud_environment string added in 2.4	Default: "AzureCloud"	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.
name -		Limit results to a specific Azure CDN endpoint.
password -		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 - / required		Name of CDN profile.
resource_group - / 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 -		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.

Examples

- name: Get facts for all endpoints in CDN profile
  azure_rm_cdnendpoint_facts:
    resource_group: myResourceGroup
    profile_name: myCDNProfile

- name: Get facts of specific CDN endpoint
  azure_rm_cdnendpoint_facts:
    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		Returned	Description
cdnendpoints complex		always	List of Azure CDN endpoints.
	content_types_to_compress list		List of content types on which compression applies. 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. 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. Sample: True
	is_http_allowed boolean		Indicates whether HTTP traffic is allowed on the endpoint. Sample: True
	is_https_allowed boolean		Indicates whether HTTPS traffic is allowed on the endpoint. Sample: True
	location string		Location of the Azure CDN endpoint. Sample: WestUS
	name string	always	Name of the Azure CDN endpoint. Sample: myEndpoint
	origin_host_header string		The host header value sent to the origin with each request. Sample: xxxxxxxx.blob.core.windows.net
	origin_path string		A directory path on the origin that CDN can use to retreive content from. Sample: /pic/
	origins -		The source of the content being delivered via CDN. Sample: {'host_name': 'xxxxxxxx.blob.core.windows.net', 'http_port': None, 'https_port': None, 'name': 'xxxxxxxx-blob-core-windows-net'}
	profile_name string	always	Name of the Azure CDN profile that this endpoint is attached to. Sample: myProfile
	provisioning_state string		Provisioning status of the Azure CDN endpoint. Sample: Succeeded
	query_string_caching_behavior string		Defines how CDN caches requests that include query strings. Sample: IgnoreQueryString
	resource_group string	always	Name of a resource group where the Azure CDN endpoint exists. Sample: myResourceGroup
	resource_state string		Resource status of the profile. Sample: Running
	tags list		The tags of the Azure CDN endpoint. Sample: foo

Status

This module is not guaranteed to have a backwards compatible interface. [preview]
This module is maintained by the Ansible Community. [community]

Authors

Hai Cao (@caohai)
Yunge zhu (@yungezz)

Hint

If you notice any issues in this documentation you can edit this document to improve it.

© 2012–2018 Michael DeHaan
© 2018–2019 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.8/modules/azure_rm_cdnendpoint_facts_module.html

azure_rm_cdnendpoint_facts – Get Azure CDN endpoint facts

azure_rm_cdnendpoint_facts – Get Azure CDN endpoint facts

Synopsis

Requirements

Parameters

Notes

See Also

Examples

Return Values

Status

Authors