az cdn custom-domain

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

Commands

az cdn custom-domain create

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

az cdn custom-domain delete

Delete the custom domain of a CDN.

az cdn custom-domain disable-https

Disable https delivery of the custom domain.

az cdn custom-domain enable-https

Enable HTTPS delivery of the custom domain.

az cdn custom-domain list

Lists all of the existing custom domains within an endpoint.

az cdn custom-domain show

Show details for the custom domain of a CDN.

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]
                            [--subscription]
                            [--tags]

Examples

Create a custom domain within an endpoint and profile.

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

Enable custom https with a minimum

az cdn custom-domain create -g group --endpoint-name endpoint --profile-name profile -n domain-name --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

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

--subscription

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

--tags

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

az cdn custom-domain delete

Delete the custom domain of a CDN.

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

Examples

Delete a custom domain.

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

Required Parameters

--endpoint-name

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

--name -n

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

--subscription

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

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
                                   [--subscription]

Required Parameters

--endpoint-name

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

--name -n

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

--subscription

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

az cdn custom-domain enable-https

Enable HTTPS delivery of the custom domain.

az cdn custom-domain enable-https --endpoint-name
                                  --name
                                  --profile-name
                                  --resource-group
                                  [--min-tls-version {1.0, 1.2, none}]
                                  [--subscription]
                                  [--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 using a CDN-managed certificate

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

Enable HTTPS using a CDN-managed certificate and a minimum TLS version of 1.2

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

Required Parameters

--endpoint-name

Name of the parent endpoint.

--name -n

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

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

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

--user-cert-subscription-id

The subscription id of the KeyVault certificate.

--user-cert-vault-name

The vault name of the KeyVault certificate.

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
                          [--query-examples]
                          [--subscription]

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

--query-examples

Recommend JMESPath string for you. You can copy one of the query and paste it after --query parameter within double quotation marks to see the results. You can add one or more positional keywords so that we can give suggestions based on these key words.

--subscription

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

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
                          [--query-examples]
                          [--subscription]

Examples

Get the details of a custom domain.

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

Required Parameters

--endpoint-name

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

--name -n

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

--query-examples

Recommend JMESPath string for you. You can copy one of the query and paste it after --query parameter within double quotation marks to see the results. You can add one or more positional keywords so that we can give suggestions based on these key words.

--subscription

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