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 to provide a hostname for a CDN endpoint.

Core GA
az cdn custom-domain delete

Delete the custom domain of a CDN.

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

Lists all of the existing custom domains within an endpoint.

Core GA
az cdn custom-domain show

Show details for the custom domain of a CDN.

Core GA

az cdn custom-domain create

Create a new custom domain to provide a hostname for a CDN endpoint.

Creates a new custom domain which must point to the hostname of the endpoint. For example, the custom domain hostname cdn.contoso.com would need to have a CNAME record pointing to the hostname of the endpoint related to this custom domain.

az cdn custom-domain create --endpoint-name
                            --hostname
                            --name
                            --profile-name
                            --resource-group
                            [--location]
                            [--tags]

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

--endpoint-name

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

--hostname

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

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

Optional Parameters

--location -l

Location. Values from: az account list-locations. You can configure the default location using az configure --defaults location=<location>.

--tags

Space-separated tags: key[=value] [key[=value] ...]. Use "" to clear existing tags.

Global Parameters
--debug

Increase logging verbosity to show all debug logs.

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

--output -o

Output format.

accepted values: json, jsonc, none, table, tsv, yaml, yamlc
default value: json
--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.

az cdn custom-domain delete

Delete the custom domain of a CDN.

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

Examples

Delete a custom domain with resource name customdomain1.

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

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.

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

--output -o

Output format.

accepted values: json, jsonc, none, table, tsv, yaml, yamlc
default value: json
--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.

az cdn custom-domain disable-https

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.

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

--output -o

Output format.

accepted values: json, jsonc, none, table, tsv, yaml, yamlc
default value: json
--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.

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

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

--min-tls-version

The minimum TLS version required for the custom domain.

accepted values: 1.0, 1.2, none
--user-cert-group-name

The resource group of the KeyVault certificate.

--user-cert-protocol-type

The protocol type of the certificate.

accepted values: ip, sni
--user-cert-secret-name

The secret name of the KeyVault certificate.

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

--user-cert-subscription-id

The subscription id of the KeyVault certificate.

--user-cert-vault-name

The vault name of the KeyVault certificate.

Global Parameters
--debug

Increase logging verbosity to show all debug logs.

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

--output -o

Output format.

accepted values: json, jsonc, none, table, tsv, yaml, yamlc
default value: json
--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.

az cdn custom-domain list

Lists all of the existing custom domains within an endpoint.

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

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

Global Parameters
--debug

Increase logging verbosity to show all debug logs.

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

--output -o

Output format.

accepted values: json, jsonc, none, table, tsv, yaml, yamlc
default value: json
--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.

az cdn custom-domain show

Show details for the custom domain of a CDN.

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

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

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.

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

--output -o

Output format.

accepted values: json, jsonc, none, table, tsv, yaml, yamlc
default value: json
--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.