Try SpotterManage a Azure CDN endpoint
| "added in version" 2.8 of ansible.builtin"
Authors: Yunge Zhu (@yungezz)
preview | supported by community
pipInstall with pip install ansible==2.9.17
Create, update, start, stop and delete a Azure CDN endpoint.
- name: Create a Azure CDN endpoint
azure_rm_cdnendpoint:
resource_group: myResourceGroup
profile_name: myProfile
name: myEndpoint
origins:
- name: TestOrig
host_name: "www.example.com"
tags:
testing: testing
delete: on-exit
foo: bar
- name: Delete a Azure CDN endpoint
azure_rm_cdnendpoint:
resource_group: myResourceGroup
profile_name: myProfile
name: myEndpoint
state: absent
name:
description:
- Name of the Azure CDN endpoint.
required: true
tags:
description:
- Dictionary of string:string pairs to assign as metadata to the object.
- Metadata tags on the object will be updated with any provided values.
- To remove tags set append_tags option to false.
type: dict
purge:
default: false
description:
- Use with I(state=present) to purge the endpoint.
type: bool
state:
choices:
- absent
- present
default: present
description:
- Assert the state of the Azure CDN endpoint. Use C(present) to create or update a
Azure CDN endpoint and C(absent) to delete it.
secret:
description:
- Azure client secret. Use when authenticating with a Service Principal.
type: str
tenant:
description:
- Azure tenant ID. Use when authenticating with a Service Principal.
type: str
ad_user:
description:
- Active Directory username. Use when authenticating with an Active Directory user
rather than service principal.
type: str
origins:
description:
- Set of source of the content being delivered via CDN.
required: true
suboptions:
host_name:
description:
- The address of the origin.
- It can be a domain name, IPv4 address, or IPv6 address.
required: true
http_port:
description:
- The value of the HTTP port. Must be between C(1) and C(65535).
type: int
https_port:
description:
- The value of the HTTPS port. Must be between C(1) and C(65535).
type: int
name:
description:
- Origin name.
required: true
profile:
description:
- Security profile found in ~/.azure/credentials file.
type: str
started:
description:
- Use with I(state=present) to start the endpoint.
type: bool
location:
description:
- Valid azure location. Defaults to location of the resource group.
password:
description:
- Active Directory user password. Use when authenticating with an Active Directory
user rather than service principal.
type: str
client_id:
description:
- Azure client ID. Use when authenticating with a Service Principal.
type: str
api_profile:
default: latest
description:
- Selects an API profile to use when communicating with Azure services. Default value
of C(latest) is appropriate for public clouds; future values will allow use with
Azure Stack.
type: str
version_added: 0.0.1
version_added_collection: azure.azcollection
append_tags:
default: true
description:
- Use to control if tags field is canonical or just appends to existing tags.
- When canonical, any tags not found in the tags parameter will be removed from the
object's metadata.
type: bool
auth_source:
choices:
- auto
- cli
- credential_file
- env
- msi
default: auto
description:
- Controls the source of the credentials to use for authentication.
- Can also be set via the C(ANSIBLE_AZURE_AUTH_SOURCE) environment variable.
- When set to C(auto) (the default) the precedence is module parameters -> C(env)
-> C(credential_file) -> C(cli).
- When set to C(env), the credentials will be read from the environment variables
- When set to C(credential_file), it will read the profile from C(~/.azure/credentials).
- When set to C(cli), the credentials will be sources from the Azure CLI profile.
C(subscription_id) or the environment variable C(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 C(msi), the host machine must be an azure resource with an enabled MSI
extension. C(subscription_id) or the environment variable C(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 C(msi) was added in Ansible 2.6.
type: str
version_added: 0.0.1
version_added_collection: azure.azcollection
origin_path:
description:
- A directory path on the origin that CDN can use to retrieve content from.
- E.g. contoso.cloudapp.net/originpath.
type: str
profile_name:
description:
- Name of the CDN profile where the endpoint attached to.
required: true
resource_group:
description:
- Name of a resource group where the Azure CDN endpoint exists or will be created.
required: true
is_http_allowed:
default: true
description:
- Indicates whether HTTP traffic is allowed on the endpoint.
type: bool
subscription_id:
description:
- Your Azure subscription Id.
type: str
is_https_allowed:
default: true
description:
- Indicates whether HTTPS traffic is allowed on the endpoint.
type: bool
cloud_environment:
default: AzureCloud
description:
- For cloud environments other than the US public cloud, the environment name (as
defined by Azure Python SDK, eg, C(AzureChinaCloud), C(AzureUSGovernment)), or a
metadata discovery endpoint URL (required for Azure Stack). Can also be set via
credential file profile or the C(AZURE_CLOUD_ENVIRONMENT) environment variable.
type: str
version_added: 0.0.1
version_added_collection: azure.azcollection
adfs_authority_url:
description:
- Azure AD authority url. Use when authenticating with Username/password, and has
your own ADFS authority.
type: str
version_added: 0.0.1
version_added_collection: azure.azcollection
origin_host_header:
description:
- The host header value sent to the origin with each request.
type: str
purge_content_paths:
default:
- /
description:
- Use with I(state=present) and I(purge=true) to specify content paths to be purged.
type: list
cert_validation_mode:
choices:
- ignore
- validate
description:
- 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
C(ignore). Can also be set via credential file profile or the C(AZURE_CERT_VALIDATION)
environment variable.
type: str
version_added: 0.0.1
version_added_collection: azure.azcollection
is_compression_enabled:
default: false
description:
- Indicates whether content compression is enabled on CDN.
type: bool
content_types_to_compress:
description:
- List of content types on which compression applies.
- This value should be a valid MIME type.
type: list
query_string_caching_behavior:
choices:
- ignore_query_string
- bypass_caching
- use_query_string
- not_set
default: ignore_query_string
description:
- Defines how CDN caches requests that include query strings.
type: str
host_name:
description:
- Host name of the CDN endpoint.
returned: always
sample: myendpoint.azureedge.net
type: str
id:
description:
- Id of the CDN endpoint.
returned: always
sample: /subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourcegroups/myResourceGroup/providers/Microsoft.Cdn/profiles/myProfile/endpoints/
myEndpoint
type: str
state:
description: Current state of the Azure CDN endpoint.
returned: always
type: str