azure.azcollection.azure_rm_cdnendpoint_info – Get Azure CDN endpoint facts
azure.azcollection.azure_rm_cdnendpoint_info – Get Azure CDN endpoint facts
Note
This plugin is part of the azure.azcollection collection (version 1.4.0).
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
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 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 |
Default: "latest" |
Selects an API profile to use when communicating with Azure services. Default value of |
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 When set to When set to When set to When set to When set to The |
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 |
client_id string |
Azure client ID. Use when authenticating with a Service Principal. | |
cloud_environment string added in 0.0.1 of azure.azcollection |
Default: "AzureCloud" |
For cloud environments other than the US public cloud, the environment name (as defined by Azure Python SDK, eg, |
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
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 | Returned | Description | |
---|---|---|---|
cdnendpoints complex |
always |
List of Azure CDN endpoints.
| |
content_types_to_compress list / elements=string |
success |
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 |
success |
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 |
success |
Indicates whether content compression is enabled on CDN.
Sample: True | |
is_http_allowed boolean |
success |
Indicates whether HTTP traffic is allowed on the endpoint.
Sample: True | |
is_https_allowed boolean |
success |
Indicates whether HTTPS traffic is allowed on the endpoint.
Sample: True | |
location string |
success |
Location of the Azure CDN endpoint.
Sample: WestUS | |
name string |
always |
Name of the Azure CDN endpoint.
Sample: myEndpoint | |
origin_host_header string |
success |
The host header value sent to the origin with each request.
Sample: xxxxxxxx.blob.core.windows.net | |
origin_path string |
success |
A directory path on the origin that CDN can use to retrieve content from.
Sample: /pic/ | |
origins string |
success |
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 |
success |
Provisioning status of the Azure CDN endpoint.
Sample: Succeeded | |
query_string_caching_behavior string |
success |
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 |
success |
Resource status of the profile.
Sample: Running | |
tags list / elements=string |
success |
The tags of the Azure CDN endpoint.
Sample: foo |
Authors
- Hai Cao (@caohai)
- Yunge zhu (@yungezz)
© 2012–2018 Michael DeHaan
© 2018–2021 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.11/collections/azure/azcollection/azure_rm_cdnendpoint_info_module.html