Share via

az cdn custom-domain

Manage Azure CDN Custom Domains to provide custom host names for endpoints.

Commands

Name Description Type Status
az cdn custom-domain create

Create a new custom domain within an endpoint.

 Core GA
az cdn custom-domain delete

Delete an existing custom domain within an endpoint.

 Core GA
az cdn custom-domain disable-https

Disable https delivery of the custom domain.

 Core GA
az cdn custom-domain enable-https

Enable HTTPS for a custom domain. The resource name of the custom domain could be obtained using "az cdn custom-domain list".

 Core GA
az cdn custom-domain list

List all of the existing custom domains within an endpoint.

 Core GA
az cdn custom-domain show

Get an existing custom domain within an endpoint.

 Core GA
az cdn custom-domain update

Update a new custom domain within an endpoint.

 Core GA
az cdn custom-domain wait

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

 Core GA

az cdn custom-domain create

Edit

Create a new custom domain within an endpoint.

az cdn custom-domain create --custom-domain-name --name
                            --endpoint-name
                            --profile-name
                            --resource-group
                            [--hostname]
                            [--no-wait {0, 1, f, false, n, no, t, true, y, yes}]

Examples

Create a custom domain with resource name customdomain1 within an endpoint and profile.

az cdn custom-domain create -g group --endpoint-name endpoint --profile-name profile -n customdomain1 --hostname www.example.com

Required Parameters

--custom-domain-name --name -n

Name of the custom domain within an endpoint.

--endpoint-name

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

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

--hostname

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

Property Value
Parameter group: Properties 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
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 custom-domain delete

Edit

Delete an existing custom domain within an endpoint.

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

Examples

Delete the custom domain of a CDN.

az cdn custom-domain delete -g group --endpoint-name endpoint --profile-name profile -n customdomain1

Optional Parameters

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

--custom-domain-name --name -n

Name of the custom domain within an endpoint.

Property Value
Parameter group: Resource Id Arguments
--endpoint-name

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 custom-domain disable-https

Edit

Disable https delivery of the custom domain.

az cdn custom-domain disable-https --endpoint-name
                                   --name
                                   --profile-name
                                   --resource-group

Required Parameters

--endpoint-name

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

--name -n

Resource name of the custom domain.

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

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 custom-domain enable-https

Edit

Enable HTTPS for a custom domain. The resource name of the custom domain could be obtained using "az cdn custom-domain list".

az cdn custom-domain enable-https --endpoint-name
                                  --name
                                  --profile-name
                                  --resource-group
                                  [--min-tls-version {1.0, 1.2, none}]
                                  [--user-cert-group-name]
                                  [--user-cert-protocol-type {ip, sni}]
                                  [--user-cert-secret-name]
                                  [--user-cert-secret-version]
                                  [--user-cert-subscription-id]
                                  [--user-cert-vault-name]

Examples

Enable HTTPS for custom domain with resource name customdomain1 using a CDN-managed certificate

az cdn custom-domain enable-https -g group --profile-name profile --endpoint-name endpoint -n customdomain1

Enable HTTPS for custom domain with resource name customdomain1 using a CDN-managed certificate and set the minimum TLS version to 1.2

az cdn custom-domain enable-https -g group --profile-name profile --endpoint-name endpoint -n customdomain1 --min-tls-version 1.2

Required Parameters

--endpoint-name

Name of the parent endpoint.

--name -n

Resource name of the custom domain.

--profile-name

Name of the parent profile.

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

--min-tls-version

The minimum TLS version required for the custom domain.

Property Value
Accepted values: 1.0, 1.2, none
--user-cert-group-name

The resource group of the KeyVault certificate.

Property Value
Parameter group: Bring Your Own Certificate Arguments
--user-cert-protocol-type

The protocol type of the certificate.

Property Value
Parameter group: Bring Your Own Certificate Arguments
Accepted values: ip, sni
--user-cert-secret-name

The secret name of the KeyVault certificate.

Property Value
Parameter group: Bring Your Own Certificate Arguments
--user-cert-secret-version

The secret version of the KeyVault certificate, If not specified, the "Latest" version will always been used and the deployed certificate will be automatically rotated to the latest version when a newer version of the certificate is available.

Property Value
Parameter group: Bring Your Own Certificate Arguments
--user-cert-subscription-id

The subscription id of the KeyVault certificate.

Property Value
Parameter group: Bring Your Own Certificate Arguments
--user-cert-vault-name

The vault name of the KeyVault certificate.

Property Value
Parameter group: Bring Your Own Certificate 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 custom-domain list

Edit

List all of the existing custom domains within an endpoint.

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

Required Parameters

--endpoint-name

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

--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 custom-domain show

Edit

Get an existing custom domain within an endpoint.

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

Examples

Get the details of a custom domain with resource name customdomain1.

az cdn custom-domain show -g group --endpoint-name endpoint --profile-name profile -n customdomain1

Optional Parameters

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

--custom-domain-name --name -n

Name of the custom domain within an endpoint.

Property Value
Parameter group: Resource Id Arguments
--endpoint-name

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 custom-domain update

Edit

Update a new custom domain within an endpoint.

az cdn custom-domain update [--add]
                            [--custom-domain-name --name]
                            [--endpoint-name]
                            [--force-string {0, 1, f, false, n, no, t, true, y, yes}]
                            [--hostname]
                            [--ids]
                            [--no-wait {0, 1, f, false, n, no, t, true, y, yes}]
                            [--profile-name]
                            [--remove]
                            [--resource-group]
                            [--set]
                            [--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.

--add

Add an object to a list of objects by specifying a path and key value pairs. Example: --add property.listProperty <key=value, string or JSON string>.

Property Value
Parameter group: Generic Update Arguments
--custom-domain-name --name -n

Name of the custom domain within an endpoint.

Property Value
Parameter group: Resource Id Arguments
--endpoint-name

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

Property Value
Parameter group: Resource Id Arguments
--force-string

When using 'set' or 'add', preserve string literals instead of attempting to convert to JSON.

Property Value
Parameter group: Generic Update Arguments
Accepted values: 0, 1, f, false, n, no, t, true, y, yes
--hostname

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

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

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

Property Value
Parameter group: Generic Update 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
--set

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

Property Value
Parameter group: Generic Update 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 custom-domain wait

Edit

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

az cdn custom-domain wait [--created]
                          [--custom]
                          [--custom-domain-name --name]
                          [--deleted]
                          [--endpoint-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
--custom-domain-name --name -n

Name of the custom domain within an endpoint.

Property Value
Parameter group: Resource Id Arguments
--deleted

Wait until deleted.

Property Value
Parameter group: Wait Condition Arguments
Default value: False
--endpoint-name

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