azure_rm_cdnendpoint – Manage a Azure CDN endpoint

From Get docs
Ansible/docs/2.8/modules/azure rm cdnendpoint module


azure_rm_cdnendpoint – Manage a Azure CDN endpoint

New in version 2.8.


Synopsis

  • Create, update, start, stop and delete a Azure CDN endpoint.

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.

append_tags

boolean

  • no
  • yes

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.

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.

content_types_to_compress

list

List of content types on which compression applies.

is_compression_enabled

boolean

  • no

  • yes

Indicates whether content compression is enabled on CDN.

is_http_allowed

boolean

  • no
  • yes

Indicates whether HTTP traffic is allowed on the endpoint.

is_https_allowed

boolean

  • no
  • yes

Indicates whether HTTPS traffic is allowed on the endpoint.

location

-

Valid azure location. Defaults to location of the resource group.

name

- / required

Name of the Azure CDN endpoint.

origin_host_header

string

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

origin_path

string

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

origins

- / required

Set of source of the content being delivered via CDN.

host_name

- / required

The address of the origin. It can be a domain name, IPv4 address, or IPv6 address.

http_port

-

The value of the HTTP port. Must be between 1 and 65535

https_port

-

The value of the HTTPS port. Must be between 1 and 65535

name

- / required

Origin name

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 the CDN profile where the endpoint attached to.

purge

boolean

  • no

  • yes

Use with state present to purge the endpoint. Set to true to have the endpoint be purged.

purge_content_paths

list

Default:

["/"]

Use with state present and purge true to specify content paths to be purged.

query_string_caching_behavior

string

  • ignore_query_string

  • bypass_caching
  • use_query_string
  • not_set

Defines how CDN caches requests that include query strings

resource_group

- / required

Name of a resource group where the Azure CDN endpoint exists or will be created.

secret

string

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

started

boolean

  • no
  • yes

Use with state present to start the endpoint. Set to false to stop the endpoint. Set to true to start the endpoint.

state

-

  • absent
  • present

Assert the state of the Azure CDN endpoint. Use present to create or update a Azure CDN endpoint and absent to delete it.

subscription_id

string

Your Azure subscription Id.

tags

dictionary

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.

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: 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

Return Values

Common return values are documented here, the following are the fields unique to this module:

Key Returned Description

host_name

string

always

Host name of the CDN endpoint.


Sample:

myendpoint.azureedge.net

id

string

always

Id of the CDN endpoint.


Sample:

/subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourcegroups/myResourceGroup/providers/Microsoft.Cdn/profiles/myProfile/endpoints/ myEndpoint

state

string

always

Current state of the Azure CDN endpoint





Status

Authors

  • 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_module.html