az cdn endpoint

Manage Azure CDN Endpoints which define the hostname and endpoints.

Commands

az cdn endpoint create CDN endpoint is the entity within a CDN profile containing configuration information such as origin, protocol, content caching and delivery behavior.
az cdn endpoint delete Deletes an existing CDN endpoint with the specified endpoint name under the specified subscription, resource group and profile.
az cdn endpoint list Lists existing CDN endpoints.
az cdn endpoint load Pre-loads a content to CDN.
az cdn endpoint purge Removes a content from CDN.
az cdn endpoint show Gets an existing CDN endpoint with the specified endpoint name under the specified subscription, resource group and profile.
az cdn endpoint start Starts an existing CDN endpoint that is on a stopped state.
az cdn endpoint stop Stops an existing running CDN endpoint.
az cdn endpoint update Update a CDN endpoint to manage how content is delivered.
az cdn endpoint validate-custom-domain Validates the custom domain mapping to ensure it maps to the correct CDN endpoint in DNS.

az cdn endpoint create

CDN endpoint is the entity within a CDN profile containing configuration information such as origin, protocol, content caching and delivery behavior.

az cdn endpoint create --name
--origin
--profile-name
--resource-group
[--content-types-to-compress]
[--enable-compression {false, true}]
[--location]
[--no-http {false, true}]
[--no-https {false, true}]
[--origin-host-header]
[--origin-path]
[--query-string-caching {BypassCaching, IgnoreQueryString, NotSet, UseQueryString}]
[--tags]

Examples

Create an endpoint to service content for hostname over http or https

az cdn endpoint create -g group -n endpoint --profile-name profile     --origin www.example.com

Create an endpoint with a custom domain origin with HTTP and HTTPS ports

az cdn endpoint create -g group -n endpoint --profile-name profile     --origin www.example.com 88 4444

Create an endpoint with a custom domain with compression and only HTTPS

az cdn endpoint create -g group -n endpoint --profile-name profile     --origin www.example.com --no-http --enable-compression

Required Parameters

--name -n

Name of the CDN endpoint.

--origin

Endpoint origin specified by the following space delimited 3 tuple: www.example.com http_port https_port. The HTTP and HTTPsports are optional and will default to 80 and 443 respectively.

--profile-name
--resource-group -g

Name of resource group. You can configure the default group using az configure --defaults group=.

Optional Parameters

--content-types-to-compress

List of content types on which compression applies. The value should be a valid MIME type.

--enable-compression

If compression is enabled, content will be served as compressed if user requests for a compressed version. Content won't be compressed on CDN when requested content is smaller than 1 byte or larger than 1 MB.

accepted values: false, true
--location -l

Location. You can configure the default location using az configure --defaults location=.

--no-http

Indicates whether HTTP traffic is not allowed on the endpoint. Default is to allow HTTP traffic.

accepted values: false, true
--no-https

Indicates whether HTTPS traffic is not allowed on the endpoint. Default is to allow HTTPS traffic.

accepted values: false, true
--origin-host-header

The host header CDN sends along with content requests to origin. The default value is the host name of the origin.

--origin-path

The path used when CDN sends request to origin.

--query-string-caching

Defines the query string caching behavior.

accepted values: BypassCaching, IgnoreQueryString, NotSet, UseQueryString
default value: IgnoreQueryString
--tags

Space separated tags in 'key[=value]' format. Use "" to clear existing tags.

az cdn endpoint delete

Deletes an existing CDN endpoint with the specified endpoint name under the specified subscription, resource group and profile.

az cdn endpoint delete --name
--profile-name
--resource-group

Examples

Delete a CDN endpoint

az cdn endpoint delete -g group -n endpoint --profile-name profile-name

Required Parameters

--name -n

Name of the CDN endpoint.

--profile-name

Name of the CDN profile which is unique within the resource group.

--resource-group -g

Name of resource group. You can configure the default group using az configure --defaults group=.

az cdn endpoint list

Lists existing CDN endpoints.

az cdn endpoint list --profile-name
--resource-group

Examples

List all endpoints within a given CDN profile

az cdn endpoint list -g group --profile-name profile-name

Required Parameters

--profile-name

Name of the CDN profile which is unique within the resource group.

--resource-group -g

Name of resource group. You can configure the default group using az configure --defaults group=.

az cdn endpoint load

Pre-loads a content to CDN.

az cdn endpoint load --content-paths
--name
--profile-name
--resource-group

Examples

Pre-load content for Javascript and CSS styles

az cdn endpoint load -g group -n endpoint --profile-name profile-name --content-paths     '/scripts/app.js' '/styles/main.css'

Required Parameters

--content-paths

The path to the content to be loaded. Path should be a relative file URL of the origin.

--name -n

Name of the CDN endpoint.

--profile-name

Name of the CDN profile which is unique within the resource group.

--resource-group -g

Name of resource group. You can configure the default group using az configure --defaults group=.

az cdn endpoint purge

Removes a content from CDN.

az cdn endpoint purge --content-paths
--name
--profile-name
--resource-group

Examples

Purge content for Javascript and CSS styles

az cdn endpoint purge -g group -n endpoint --profile-name profile-name --content-paths     '/scripts/app.js' '/styles/*'

Required Parameters

--content-paths

The path to the content to be purged. Can describe a file path or a wild card directory.

--name -n

Name of the CDN endpoint.

--profile-name

Name of the CDN profile which is unique within the resource group.

--resource-group -g

Name of resource group. You can configure the default group using az configure --defaults group=.

az cdn endpoint show

Gets an existing CDN endpoint with the specified endpoint name under the specified subscription, resource group and profile.

az cdn endpoint show --name
--profile-name
--resource-group

Required Parameters

--name -n

Name of the CDN endpoint.

--profile-name

Name of the CDN profile which is unique within the resource group.

--resource-group -g

Name of resource group. You can configure the default group using az configure --defaults group=.

az cdn endpoint start

Starts an existing CDN endpoint that is on a stopped state.

az cdn endpoint start --name
--profile-name
--resource-group

Examples

Start a CDN endpoint

az cdn endpoint start -g group -n endpoint --profile-name profile-name

Required Parameters

--name -n

Name of the CDN endpoint.

--profile-name

Name of the CDN profile which is unique within the resource group.

--resource-group -g

Name of resource group. You can configure the default group using az configure --defaults group=.

az cdn endpoint stop

Stops an existing running CDN endpoint.

az cdn endpoint stop --name
--profile-name
--resource-group

Examples

Stop a CDN endpoint

az cdn endpoint stop -g group -n endpoint --profile-name profile-name

Required Parameters

--name -n

Name of the CDN endpoint.

--profile-name

Name of the CDN profile which is unique within the resource group.

--resource-group -g

Name of resource group. You can configure the default group using az configure --defaults group=.

az cdn endpoint update

Update a CDN endpoint to manage how content is delivered.

az cdn endpoint update --name
--profile-name
--resource-group
[--add]
[--content-types-to-compress]
[--enable-compression {false, true}]
[--no-http {false, true}]
[--no-https {false, true}]
[--origin-host-header]
[--origin-path]
[--query-string-caching {BypassCaching, IgnoreQueryString, NotSet, UseQueryString}]
[--remove]
[--set]
[--tags]

Examples

Turn off HTTP traffic for the endpoint

az cdn endpoint update -g group -n endpoint --profile-name profile --no-http

Enable content compression for the endpoint

az cdn endpoint update -g group -n endpoint --profile-name profile     --enable-compression

Required Parameters

--name -n

Name of the CDN endpoint.

--profile-name

Name of the CDN profile which is unique within the resource group.

--resource-group -g

Name of resource group. You can configure the default group using az configure --defaults group=.

Optional Parameters

--add

Add an object to a list of objects by specifying a path and key value pairs. Example: --add property.listProperty .

--content-types-to-compress

List of content types on which compression applies. The value should be a valid MIME type.

--enable-compression

If compression is enabled, content will be served as compressed if user requests for a compressed version. Content won't be compressed on CDN when requested content is smaller than 1 byte or larger than 1 MB.

accepted values: false, true
--no-http

Indicates whether HTTP traffic is not allowed on the endpoint. Default is to allow HTTP traffic.

accepted values: false, true
--no-https

Indicates whether HTTPS traffic is not allowed on the endpoint. Default is to allow HTTPS traffic.

accepted values: false, true
--origin-host-header

The host header CDN sends along with content requests to origin. The default value is the host name of the origin.

--origin-path

The path used when CDN sends request to origin.

--query-string-caching

Defines the query string caching behavior.

accepted values: BypassCaching, IgnoreQueryString, NotSet, UseQueryString
--remove

Remove a property or an element from a list. Example: --remove property.list OR --remove propertyToRemove.

--set

Update an object by specifying a property path and value to set. Example: --set property1.property2=.

--tags

Space separated tags in 'key[=value]' format. Use "" to clear existing tags.

az cdn endpoint validate-custom-domain

Validates the custom domain mapping to ensure it maps to the correct CDN endpoint in DNS.

az cdn endpoint validate-custom-domain --host-name
--name
--profile-name
--resource-group

Required Parameters

--host-name

The host name of the custom domain. Must be a domain name.

--name -n

Name of the CDN endpoint.

--profile-name

Name of the CDN profile which is unique within the resource group.

--resource-group -g

Name of resource group. You can configure the default group using az configure --defaults group=.