az cdn endpoint

Manage CDN endpoints.

Commands

Name	Description	Type	Status
az cdn endpoint create	Create a new CDN endpoint with the specified endpoint name under the specified subscription, resource group and profile.	Core	GA
az cdn endpoint delete	Delete an existing CDN endpoint with the specified endpoint name under the specified subscription, resource group and profile.	Core	GA
az cdn endpoint list	List existing CDN endpoints.	Core	GA
az cdn endpoint load	Pre-loads a content to CDN. Available for Verizon Profiles.	Core	GA
az cdn endpoint name-exists	Check the availability of a resource name. This is needed for resources where name is globally unique, such as a CDN endpoint.	Core	GA
az cdn endpoint purge	Removes a content from CDN.	Core	GA
az cdn endpoint rule	Manage delivery rules for an endpoint.	Core	Preview
az cdn endpoint rule action	Manage delivery rule actions for an endpoint.	Core	Preview
az cdn endpoint rule action add	Add an action to a delivery rule.	Core	Preview
az cdn endpoint rule action remove	Remove an action from a delivery rule.	Core	Preview
az cdn endpoint rule action show	Show delivery rules asscociate with the endpoint.	Core	Preview
az cdn endpoint rule add	Add a delivery rule to a CDN endpoint.	Core	Preview
az cdn endpoint rule condition	Manage delivery rule conditions for an endpoint.	Core	Preview
az cdn endpoint rule condition add	Add a condition to a delivery rule.	Core	Preview
az cdn endpoint rule condition remove	Remove a condition from a delivery rule.	Core	Preview
az cdn endpoint rule condition show	Show delivery rules associate with the endpoint.	Core	Preview
az cdn endpoint rule remove	Remove a delivery rule from an endpoint.	Core	Preview
az cdn endpoint rule show	Show delivery rules associate with the endpoint.	Core	Preview
az cdn endpoint show	Get an existing CDN endpoint with the specified endpoint name under the specified subscription, resource group and profile.	Core	GA
az cdn endpoint start	Starts an existing CDN endpoint that is on a stopped state.	Core	GA
az cdn endpoint stop	Stops an existing running CDN endpoint.	Core	GA
az cdn endpoint update	Update an existing CDN endpoint with the specified endpoint name under the specified subscription, resource group and profile. Only tags can be updated after creating an endpoint. To update origins, use the Update Origin operation. To update origin groups, use the Update Origin group operation. To update custom domains, use the Update Custom Domain operation.	Core	GA
az cdn endpoint validate-custom-domain	Validates the custom domain mapping to ensure it maps to the correct CDN endpoint in DNS.	Core	GA
az cdn endpoint wait	Place the CLI in a waiting state until a condition is met.	Core	GA

az cdn endpoint create

Create a new CDN endpoint with the specified endpoint name under the specified subscription, resource group and profile.

az cdn endpoint create --endpoint-name --name
                       --origin
                       --profile-name
                       --resource-group
                       [--content-types-to-compress]
                       [--default-origin-group]
                       [--delivery-policy]
                       [--enable-compression {0, 1, f, false, n, no, t, true, y, yes}]
                       [--geo-filters]
                       [--location]
                       [--no-http {0, 1, f, false, n, no, t, true, y, yes}]
                       [--no-https {0, 1, f, false, n, no, t, true, y, yes}]
                       [--no-wait {0, 1, f, false, n, no, t, true, y, yes}]
                       [--optimization-type {DynamicSiteAcceleration, GeneralMediaStreaming, GeneralWebDelivery, LargeFileDownload, VideoOnDemandMediaStreaming}]
                       [--origin-groups]
                       [--origin-host-header]
                       [--origin-path]
                       [--probe-path]
                       [--query-string-caching-behavior {BypassCaching, IgnoreQueryString, NotSet, UseQueryString}]
                       [--tags]
                       [--url-signing-keys]
                       [--web-application-firewall-policy-link]

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 origin with private link enabled.

az cdn endpoint create -g group -n endpoint --profile-name profile --origin www.example.com 80 443 /subscriptions/subid/resourcegroups/rg1/providers/Microsoft.Network/privateLinkServices/pls1 eastus "Please approve this request"

Create an https-only endpoint with a custom domain origin and support compression for Azure CDN's default compression MIME types.

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

Create an endpoint with a custom domain origin and support compression for specific MIME types.

az cdn endpoint create -g group -n endpoint --profile-name profile --origin www.example.com --enable-compression --content-types-to-compress text/plain text/html

Required Parameters

--endpoint-name --name -n

Name of the endpoint under the profile which is unique globally.

--origin

Endpoint origin specified by the following space-delimited 7 tuple: www.example.com http_port https_port private_link_resource_id private_link_location private_link_approval_message origin_name. The HTTP and HTTPS ports and the private link resource ID and location are optional. The HTTP and HTTPS ports default to 80 and 443, respectively. Private link fields are only valid for the sku Standard_Microsoft, and private_link_location is required if private_link_resource_id is set. the origin name is optional and defaults to origin. Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.

--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=<name>.

Optional Parameters

The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.

--content-types-to-compress

List of content types on which compression applies. The value should be a valid MIME type. Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.

Property	Value
Parameter group:	Properties Arguments

--default-origin-group

The origin group to use for origins not explicitly included in an origin group. Can be specified as a resource ID or the name of an origin group of this endpoint.

Property	Value
Parameter group:	DefaultOriginGroup Arguments

--delivery-policy

A policy that specifies the delivery rules to be used for an endpoint. Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.

Property	Value
Parameter group:	Properties Arguments

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

Property	Value
Accepted values:	0, 1, f, false, n, no, t, true, y, yes

--geo-filters

List of rules defining the user's geo access within a CDN endpoint. Each geo filter defines an access rule to a specified path or content, e.g. block APAC for path /pictures/ Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.

Property	Value
Parameter group:	Properties Arguments

--location -l

Resource location. When not specified, the location of the resource group will be used.

Property	Value
Parameter group:	Endpoint Arguments

--no-http

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

Property	Value
Accepted values:	0, 1, f, false, n, no, t, true, y, yes

--no-https

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

Property	Value
Accepted values:	0, 1, f, false, n, no, t, true, y, yes

--no-wait

Do not wait for the long-running operation to finish.

Property	Value
Accepted values:	0, 1, f, false, n, no, t, true, y, yes

--optimization-type

Specifies what scenario the customer wants this CDN endpoint to optimize for, e.g. Download, Media services. With this information, CDN can apply scenario driven optimization.

Property	Value
Parameter group:	Properties Arguments
Accepted values:	DynamicSiteAcceleration, GeneralMediaStreaming, GeneralWebDelivery, LargeFileDownload, VideoOnDemandMediaStreaming

--origin-groups

The origin groups comprising of origins that are used for load balancing the traffic based on availability. Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.

Property	Value
Parameter group:	Properties Arguments

--origin-host-header

The host header value sent to the origin with each request. This property at Endpoint is only allowed when endpoint uses single origin and can be overridden by the same property specified at origin.If you leave this blank, the request hostname determines this value. Azure CDN origins, such as Web Apps, Blob Storage, and Cloud Services require this host header value to match the origin hostname by default.

Property	Value
Parameter group:	Properties Arguments

--origin-path

A directory path on the origin that CDN can use to retrieve content from, e.g. contoso.cloudapp.net/originpath.

Property	Value
Parameter group:	Properties Arguments

--probe-path

Path to a file hosted on the origin which helps accelerate delivery of the dynamic content and calculate the most optimal routes for the CDN. This is relative to the origin path. This property is only relevant when using a single origin.

Property	Value
Parameter group:	Properties Arguments

--query-string-caching-behavior

Defines how CDN caches requests that include query strings. You can ignore any query strings when caching, bypass caching to prevent requests that contain query strings from being cached, or cache every request with a unique URL.

Property	Value
Parameter group:	Properties Arguments
Default value:	NotSet
Accepted values:	BypassCaching, IgnoreQueryString, NotSet, UseQueryString

--tags

Resource tags. Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.

Property	Value
Parameter group:	Endpoint Arguments

--url-signing-keys

List of keys used to validate the signed URL hashes. Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.

Property	Value
Parameter group:	Properties Arguments

--web-application-firewall-policy-link

Defines the Web Application Firewall policy for the endpoint (if applicable) Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.

Property	Value
Parameter group:	Properties Arguments

Global Parameters

--debug

Increase logging verbosity to show all debug logs.

Property	Value
Default value:	False

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

Property	Value
Default value:	False

--output -o

Output format.

Property	Value
Default value:	json
Accepted values:	json, jsonc, none, table, tsv, yaml, yamlc

--query

JMESPath query string. See http://jmespath.org/ for more information and examples.

--subscription

Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.

--verbose

Increase logging verbosity. Use --debug for full debug logs.

Property	Value
Default value:	False

az cdn endpoint delete

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

az cdn endpoint delete [--endpoint-name --name]
                       [--ids]
                       [--no-wait {0, 1, f, false, n, no, t, true, y, yes}]
                       [--profile-name]
                       [--resource-group]
                       [--subscription]

Examples

Delete a CDN endpoint.

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

Optional Parameters

The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.

--endpoint-name --name -n

Name of the endpoint under the profile which is unique globally.

Property	Value
Parameter group:	Resource Id Arguments

--ids

One or more resource IDs (space-delimited). It should be a complete resource ID containing all information of 'Resource Id' arguments. You should provide either --ids or other 'Resource Id' arguments.

Property	Value
Parameter group:	Resource Id Arguments

--no-wait

Do not wait for the long-running operation to finish.

Property	Value
Accepted values:	0, 1, f, false, n, no, t, true, y, yes

--profile-name

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

Property	Value
Parameter group:	Resource Id Arguments

--resource-group -g

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

Property	Value
Parameter group:	Resource Id Arguments

--subscription

Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.

Property	Value
Parameter group:	Resource Id Arguments

Global Parameters

--debug

Increase logging verbosity to show all debug logs.

Property	Value
Default value:	False

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

Property	Value
Default value:	False

--output -o

Output format.

Property	Value
Default value:	json
Accepted values:	json, jsonc, none, table, tsv, yaml, yamlc

--query

JMESPath query string. See http://jmespath.org/ for more information and examples.

--verbose

Increase logging verbosity. Use --debug for full debug logs.

Property	Value
Default value:	False

az cdn endpoint list

List existing CDN endpoints.

az cdn endpoint list --profile-name
                     --resource-group
                     [--max-items]
                     [--next-token]

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=<name>.

Optional Parameters

The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.

--max-items

Total number of items to return in the command's output. If the total number of items available is more than the value specified, a token is provided in the command's output. To resume pagination, provide the token value in --next-token argument of a subsequent command.

Property	Value
Parameter group:	Pagination Arguments

--next-token

Token to specify where to start paginating. This is the token value from a previously truncated response.

Property	Value
Parameter group:	Pagination Arguments

Global Parameters

--debug

Increase logging verbosity to show all debug logs.

Property	Value
Default value:	False

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

Property	Value
Default value:	False

--output -o

Output format.

Property	Value
Default value:	json
Accepted values:	json, jsonc, none, table, tsv, yaml, yamlc

--query

JMESPath query string. See http://jmespath.org/ for more information and examples.

--subscription

Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.

--verbose

Increase logging verbosity. Use --debug for full debug logs.

Property	Value
Default value:	False

az cdn endpoint load

Pre-loads a content to CDN. Available for Verizon Profiles.

az cdn endpoint load --content-paths
                     [--endpoint-name --name]
                     [--ids]
                     [--no-wait {0, 1, f, false, n, no, t, true, y, yes}]
                     [--profile-name]
                     [--resource-group]
                     [--subscription]

Examples

Pre-load Javascript and CSS content for an endpoint.

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. Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.

Property	Value
Parameter group:	ContentFilePaths Arguments

Optional Parameters

The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.

--endpoint-name --name -n

Name of the endpoint under the profile which is unique globally.

Property	Value
Parameter group:	Resource Id Arguments

--ids

One or more resource IDs (space-delimited). It should be a complete resource ID containing all information of 'Resource Id' arguments. You should provide either --ids or other 'Resource Id' arguments.

Property	Value
Parameter group:	Resource Id Arguments

--no-wait

Do not wait for the long-running operation to finish.

Property	Value
Accepted values:	0, 1, f, false, n, no, t, true, y, yes

--profile-name

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

Property	Value
Parameter group:	Resource Id Arguments

--resource-group -g

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

Property	Value
Parameter group:	Resource Id Arguments

--subscription

Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.

Property	Value
Parameter group:	Resource Id Arguments

Global Parameters

--debug

Increase logging verbosity to show all debug logs.

Property	Value
Default value:	False

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

Property	Value
Default value:	False

--output -o

Output format.

Property	Value
Default value:	json
Accepted values:	json, jsonc, none, table, tsv, yaml, yamlc

--query

JMESPath query string. See http://jmespath.org/ for more information and examples.

--verbose

Increase logging verbosity. Use --debug for full debug logs.

Property	Value
Default value:	False

az cdn endpoint name-exists

Check the availability of a resource name. This is needed for resources where name is globally unique, such as a CDN endpoint.

az cdn endpoint name-exists --name
                            [--type {Microsoft.Cdn/Profiles/AfdEndpoints, Microsoft.Cdn/Profiles/Endpoints}]

Examples

Check whether the resource name contoso is available or not.

az cdn name-exists --name contoso

Required Parameters

--name

The resource name to validate.

Property	Value
Parameter group:	CheckNameAvailabilityInput Arguments

Optional Parameters

The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.

--type

The type of the resource whose name is to be validated.

Property	Value
Parameter group:	CheckNameAvailabilityInput Arguments
Default value:	Microsoft.Cdn/Profiles/Endpoints
Accepted values:	Microsoft.Cdn/Profiles/AfdEndpoints, Microsoft.Cdn/Profiles/Endpoints

Global Parameters

--debug

Increase logging verbosity to show all debug logs.

Property	Value
Default value:	False

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

Property	Value
Default value:	False

--output -o

Output format.

Property	Value
Default value:	json
Accepted values:	json, jsonc, none, table, tsv, yaml, yamlc

--query

JMESPath query string. See http://jmespath.org/ for more information and examples.

--subscription

Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.

--verbose

Increase logging verbosity. Use --debug for full debug logs.

Property	Value
Default value:	False

az cdn endpoint purge

Removes a content from CDN.

az cdn endpoint purge --content-paths
                      [--endpoint-name --name]
                      [--ids]
                      [--no-wait {0, 1, f, false, n, no, t, true, y, yes}]
                      [--profile-name]
                      [--resource-group]
                      [--subscription]

Examples

Purge pre-loaded Javascript and CSS content.

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. Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.

Property	Value
Parameter group:	ContentFilePaths Arguments

Optional Parameters

The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.

--endpoint-name --name -n

Name of the endpoint under the profile which is unique globally.

Property	Value
Parameter group:	Resource Id Arguments

--ids

One or more resource IDs (space-delimited). It should be a complete resource ID containing all information of 'Resource Id' arguments. You should provide either --ids or other 'Resource Id' arguments.

Property	Value
Parameter group:	Resource Id Arguments

--no-wait

Do not wait for the long-running operation to finish.

Property	Value
Accepted values:	0, 1, f, false, n, no, t, true, y, yes

--profile-name

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

Property	Value
Parameter group:	Resource Id Arguments

--resource-group -g

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

Property	Value
Parameter group:	Resource Id Arguments

--subscription

Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.

Property	Value
Parameter group:	Resource Id Arguments

Global Parameters

--debug

Increase logging verbosity to show all debug logs.

Property	Value
Default value:	False

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

Property	Value
Default value:	False

--output -o

Output format.

Property	Value
Default value:	json
Accepted values:	json, jsonc, none, table, tsv, yaml, yamlc

--query

JMESPath query string. See http://jmespath.org/ for more information and examples.

--verbose

Increase logging verbosity. Use --debug for full debug logs.

Property	Value
Default value:	False

az cdn endpoint show

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

az cdn endpoint show [--endpoint-name --name]
                     [--ids]
                     [--profile-name]
                     [--resource-group]
                     [--subscription]

Optional Parameters

The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.

--endpoint-name --name -n

Name of the endpoint under the profile which is unique globally.

Property	Value
Parameter group:	Resource Id Arguments

--ids

One or more resource IDs (space-delimited). It should be a complete resource ID containing all information of 'Resource Id' arguments. You should provide either --ids or other 'Resource Id' arguments.

Property	Value
Parameter group:	Resource Id Arguments

--profile-name

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

Property	Value
Parameter group:	Resource Id Arguments

--resource-group -g

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

Property	Value
Parameter group:	Resource Id Arguments

--subscription

Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.

Property	Value
Parameter group:	Resource Id Arguments

Global Parameters

--debug

Increase logging verbosity to show all debug logs.

Property	Value
Default value:	False

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

Property	Value
Default value:	False

--output -o

Output format.

Property	Value
Default value:	json
Accepted values:	json, jsonc, none, table, tsv, yaml, yamlc

--query

JMESPath query string. See http://jmespath.org/ for more information and examples.

--verbose

Increase logging verbosity. Use --debug for full debug logs.

Property	Value
Default value:	False

az cdn endpoint start

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

az cdn endpoint start [--endpoint-nameendpoint-name --name]
                      [--ids]
                      [--no-wait {0, 1, f, false, n, no, t, true, y, yes}]
                      [--profile-name]
                      [--resource-group]
                      [--subscription]

Examples

Start a CDN endpoint.

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

Optional Parameters

The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.

--endpoint-nameendpoint-name --name -n

Name of the endpoint under the profile which is unique globally.

Property	Value
Parameter group:	Resource Id Arguments

--ids

One or more resource IDs (space-delimited). It should be a complete resource ID containing all information of 'Resource Id' arguments. You should provide either --ids or other 'Resource Id' arguments.

Property	Value
Parameter group:	Resource Id Arguments

--no-wait

Do not wait for the long-running operation to finish.

Property	Value
Accepted values:	0, 1, f, false, n, no, t, true, y, yes

--profile-name

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

Property	Value
Parameter group:	Resource Id Arguments

--resource-group -g

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

Property	Value
Parameter group:	Resource Id Arguments

--subscription

Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.

Property	Value
Parameter group:	Resource Id Arguments

Global Parameters

--debug

Increase logging verbosity to show all debug logs.

Property	Value
Default value:	False

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

Property	Value
Default value:	False

--output -o

Output format.

Property	Value
Default value:	json
Accepted values:	json, jsonc, none, table, tsv, yaml, yamlc

--query

JMESPath query string. See http://jmespath.org/ for more information and examples.

--verbose

Increase logging verbosity. Use --debug for full debug logs.

Property	Value
Default value:	False

az cdn endpoint stop

Stops an existing running CDN endpoint.

az cdn endpoint stop [--endpoint-name --name]
                     [--ids]
                     [--no-wait {0, 1, f, false, n, no, t, true, y, yes}]
                     [--profile-name]
                     [--resource-group]
                     [--subscription]

Examples

Stop a CDN endpoint.

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

Optional Parameters

The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.

--endpoint-name --name -n

Name of the endpoint under the profile which is unique globally.

Property	Value
Parameter group:	Resource Id Arguments

--ids

One or more resource IDs (space-delimited). It should be a complete resource ID containing all information of 'Resource Id' arguments. You should provide either --ids or other 'Resource Id' arguments.

Property	Value
Parameter group:	Resource Id Arguments

--no-wait

Do not wait for the long-running operation to finish.

Property	Value
Accepted values:	0, 1, f, false, n, no, t, true, y, yes

--profile-name

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

Property	Value
Parameter group:	Resource Id Arguments

--resource-group -g

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

Property	Value
Parameter group:	Resource Id Arguments

--subscription

Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.

Property	Value
Parameter group:	Resource Id Arguments

Global Parameters

--debug

Increase logging verbosity to show all debug logs.

Property	Value
Default value:	False

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

Property	Value
Default value:	False

--output -o

Output format.

Property	Value
Default value:	json
Accepted values:	json, jsonc, none, table, tsv, yaml, yamlc

--query

JMESPath query string. See http://jmespath.org/ for more information and examples.

--verbose

Increase logging verbosity. Use --debug for full debug logs.

Property	Value
Default value:	False

az cdn endpoint update

Update an existing CDN endpoint with the specified endpoint name under the specified subscription, resource group and profile. Only tags can be updated after creating an endpoint. To update origins, use the Update Origin operation. To update origin groups, use the Update Origin group operation. To update custom domains, use the Update Custom Domain operation.

az cdn endpoint update [--content-types-to-compress]
                       [--default-origin-group]
                       [--delivery-policy]
                       [--enable-compression {0, 1, f, false, n, no, t, true, y, yes}]
                       [--endpoint-name --name]
                       [--geo-filters]
                       [--ids]
                       [--no-http {0, 1, f, false, n, no, t, true, y, yes}]
                       [--no-https {0, 1, f, false, n, no, t, true, y, yes}]
                       [--no-wait {0, 1, f, false, n, no, t, true, y, yes}]
                       [--optimization-type {DynamicSiteAcceleration, GeneralMediaStreaming, GeneralWebDelivery, LargeFileDownload, VideoOnDemandMediaStreaming}]
                       [--origin-host-header]
                       [--origin-path]
                       [--probe-path]
                       [--profile-name]
                       [--query-string-caching-behavior {BypassCaching, IgnoreQueryString, NotSet, UseQueryString}]
                       [--resource-group]
                       [--subscription]
                       [--tags]
                       [--url-signing-keys]
                       [--web-application-firewall-policy-link]

Examples

Turn off HTTP traffic for an endpoint.

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

Enable content compression for an endpoint.

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

Optional Parameters

The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.

--content-types-to-compress

List of content types on which compression applies. The value should be a valid MIME type. Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.

Property	Value
Parameter group:	Properties Arguments

--default-origin-group

The origin group to use for origins not explicitly included in an origin group. Can be specified as a resource ID or the name of an origin group of this endpoint.

Property	Value
Parameter group:	DefaultOriginGroup Arguments

--delivery-policy

A policy that specifies the delivery rules to be used for an endpoint. Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.

Property	Value
Parameter group:	Properties Arguments

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

Property	Value
Accepted values:	0, 1, f, false, n, no, t, true, y, yes

--endpoint-name --name -n

Name of the endpoint under the profile which is unique globally.

Property	Value
Parameter group:	Resource Id Arguments

--geo-filters

List of rules defining the user's geo access within a CDN endpoint. Each geo filter defines an access rule to a specified path or content, e.g. block APAC for path /pictures/ Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.

Property	Value
Parameter group:	Properties Arguments

--ids

One or more resource IDs (space-delimited). It should be a complete resource ID containing all information of 'Resource Id' arguments. You should provide either --ids or other 'Resource Id' arguments.

Property	Value
Parameter group:	Resource Id Arguments

--no-http

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

Property	Value
Accepted values:	0, 1, f, false, n, no, t, true, y, yes

--no-https

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

Property	Value
Accepted values:	0, 1, f, false, n, no, t, true, y, yes

--no-wait

Do not wait for the long-running operation to finish.

Property	Value
Accepted values:	0, 1, f, false, n, no, t, true, y, yes

--optimization-type

Specifies what scenario the customer wants this CDN endpoint to optimize for, e.g. Download, Media services. With this information, CDN can apply scenario driven optimization.

Property	Value
Parameter group:	Properties Arguments
Accepted values:	DynamicSiteAcceleration, GeneralMediaStreaming, GeneralWebDelivery, LargeFileDownload, VideoOnDemandMediaStreaming

--origin-host-header

The host header value sent to the origin with each request. This property at Endpoint is only allowed when endpoint uses single origin and can be overridden by the same property specified at origin.If you leave this blank, the request hostname determines this value. Azure CDN origins, such as Web Apps, Blob Storage, and Cloud Services require this host header value to match the origin hostname by default.

Property	Value
Parameter group:	Properties Arguments

--origin-path

A directory path on the origin that CDN can use to retrieve content from, e.g. contoso.cloudapp.net/originpath.

Property	Value
Parameter group:	Properties Arguments

--probe-path

Path to a file hosted on the origin which helps accelerate delivery of the dynamic content and calculate the most optimal routes for the CDN. This is relative to the origin path. This property is only relevant when using a single origin.

Property	Value
Parameter group:	Properties Arguments

--profile-name

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

Property	Value
Parameter group:	Resource Id Arguments

--query-string-caching-behavior

Defines how CDN caches requests that include query strings. You can ignore any query strings when caching, bypass caching to prevent requests that contain query strings from being cached, or cache every request with a unique URL.

Property	Value
Parameter group:	Properties Arguments
Accepted values:	BypassCaching, IgnoreQueryString, NotSet, UseQueryString

--resource-group -g

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

Property	Value
Parameter group:	Resource Id Arguments

--subscription

Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.

Property	Value
Parameter group:	Resource Id Arguments

--tags

Endpoint tags. Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.

Property	Value
Parameter group:	EndpointUpdateProperties Arguments

--url-signing-keys

List of keys used to validate the signed URL hashes. Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.

Property	Value
Parameter group:	Properties Arguments

--web-application-firewall-policy-link

Defines the Web Application Firewall policy for the endpoint (if applicable) Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.

Property	Value
Parameter group:	Properties Arguments

Global Parameters

--debug

Increase logging verbosity to show all debug logs.

Property	Value
Default value:	False

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

Property	Value
Default value:	False

--output -o

Output format.

Property	Value
Default value:	json
Accepted values:	json, jsonc, none, table, tsv, yaml, yamlc

--query

JMESPath query string. See http://jmespath.org/ for more information and examples.

--verbose

Increase logging verbosity. Use --debug for full debug logs.

Property	Value
Default value:	False

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
                                       [--endpoint-name --name]
                                       [--ids]
                                       [--profile-name]
                                       [--resource-group]
                                       [--subscription]

Examples

Validate domain www.contoso.com to see whether it maps to the correct CDN endpoint in DNS.

az cdn endpoint validate-custom-domain -g group -n endpoint --profile-name profile-name --host-name www.contoso.com

Required Parameters

--host-name

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

Property	Value
Parameter group:	CustomDomainProperties Arguments

Optional Parameters

The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.

--endpoint-name --name -n

Name of the endpoint under the profile which is unique globally.

Property	Value
Parameter group:	Resource Id Arguments

--ids

One or more resource IDs (space-delimited). It should be a complete resource ID containing all information of 'Resource Id' arguments. You should provide either --ids or other 'Resource Id' arguments.

Property	Value
Parameter group:	Resource Id Arguments

--profile-name

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

Property	Value
Parameter group:	Resource Id Arguments

--resource-group -g

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

Property	Value
Parameter group:	Resource Id Arguments

--subscription

Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.

Property	Value
Parameter group:	Resource Id Arguments

Global Parameters

--debug

Increase logging verbosity to show all debug logs.

Property	Value
Default value:	False

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

Property	Value
Default value:	False

--output -o

Output format.

Property	Value
Default value:	json
Accepted values:	json, jsonc, none, table, tsv, yaml, yamlc

--query

JMESPath query string. See http://jmespath.org/ for more information and examples.

--verbose

Increase logging verbosity. Use --debug for full debug logs.

Property	Value
Default value:	False

az cdn endpoint wait

Place the CLI in a waiting state until a condition is met.

az cdn endpoint wait [--created]
                     [--custom]
                     [--deleted]
                     [--endpoint-name --name]
                     [--exists]
                     [--ids]
                     [--interval]
                     [--profile-name]
                     [--resource-group]
                     [--subscription]
                     [--timeout]
                     [--updated]

Optional Parameters

The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.

--created

Wait until created with 'provisioningState' at 'Succeeded'.

Property	Value
Parameter group:	Wait Condition Arguments
Default value:	False

--custom

Wait until the condition satisfies a custom JMESPath query. E.g. provisioningState!='InProgress', instanceView.statuses[?code=='PowerState/running'].

Property	Value
Parameter group:	Wait Condition Arguments

--deleted

Wait until deleted.

Property	Value
Parameter group:	Wait Condition Arguments
Default value:	False

--endpoint-name --name -n

Name of the endpoint under the profile which is unique globally.

Property	Value
Parameter group:	Resource Id Arguments

--exists

Wait until the resource exists.

Property	Value
Parameter group:	Wait Condition Arguments
Default value:	False

--ids

One or more resource IDs (space-delimited). It should be a complete resource ID containing all information of 'Resource Id' arguments. You should provide either --ids or other 'Resource Id' arguments.

Property	Value
Parameter group:	Resource Id Arguments

--interval

Polling interval in seconds.

Property	Value
Parameter group:	Wait Condition Arguments
Default value:	30

--profile-name

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

Property	Value
Parameter group:	Resource Id Arguments

--resource-group -g

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

Property	Value
Parameter group:	Resource Id Arguments

--subscription

Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.

Property	Value
Parameter group:	Resource Id Arguments

--timeout

Maximum wait in seconds.

Property	Value
Parameter group:	Wait Condition Arguments
Default value:	3600

--updated

Wait until updated with provisioningState at 'Succeeded'.

Property	Value
Parameter group:	Wait Condition Arguments
Default value:	False

Global Parameters

--debug

Increase logging verbosity to show all debug logs.

Property	Value
Default value:	False

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

Property	Value
Default value:	False

--output -o

Output format.

Property	Value
Default value:	json
Accepted values:	json, jsonc, none, table, tsv, yaml, yamlc

--query

JMESPath query string. See http://jmespath.org/ for more information and examples.

--verbose

Increase logging verbosity. Use --debug for full debug logs.

Property	Value
Default value:	False