Skip to content

Files

Latest commit

duongauduongau
fix link reference - line 157
Mar 1, 2022
024f117 · Mar 1, 2022

History

History
296 lines (188 loc) · 14.1 KB

cdn-map-content-to-custom-domain.md

File metadata and controls

296 lines (188 loc) · 14.1 KB
title titleSuffix description services author manager ms.service ms.topic ms.date ms.author ms.custom
Tutorial: Add a custom domain to your endpoint
Azure Content Delivery Network
Use this tutorial to add a custom domain to an Azure Content Delivery Network endpoint so that your domain name is visible in your URL.
cdn
jessie-jyy
KumudD
azure-cdn
tutorial
04/12/2021
yuajia
mvc, devx-track-azurepowershell

Tutorial: Add a custom domain to your endpoint

This tutorial shows how to add a custom domain to an Azure Content Delivery Network (CDN) endpoint.

The endpoint name in your CDN profile is a subdomain of azureedge.net. By default when delivering content, the CDN profile domain is included within the URL.

For example, https://contoso.azureedge.net/photo.png.

Azure CDN provides the option of associating a custom domain with a CDN endpoint. This option delivers content with a custom domain in your URL instead of the default domain.

In this tutorial, you learn how to:

[!div class="checklist"]

  • Create a CNAME DNS record.
  • Add a custom domain with your CDN endpoint.
  • Verify the custom domain.

[!INCLUDE quickstarts-free-trial-note]

Prerequisites

Create a CNAME DNS record

Before you can use a custom domain with an Azure CDN endpoint, you must first create a canonical name (CNAME) record with Azure DNS or your DNS provider to point to your CDN endpoint.

A CNAME record is a DNS record that maps a source domain name to a destination domain name.

For Azure CDN, the source domain name is your custom domain name and the destination domain name is your CDN endpoint hostname.

Azure CDN routes traffic addressed to the source custom domain to the destination CDN endpoint hostname after it verifies the CNAME record.

A custom domain and its subdomain can be added to only a single endpoint at a time.

Use multiple CNAME records for different subdomains from the same custom domain for different Azure services.

You can map a custom domain with different subdomains to the same CDN endpoint.

Note

  • This tutorial uses the CNAME record type for multiple purposes:
    • Traffic routing can be accomplished with a CNAME record as well as A or AAAA record types in Azure DNS. To apply, follow the steps below and replace the CNAME record with the record type of your choice.
    • A CNAME record is required for custom domain ownership validation and must be available when adding the custom domain to a CDN Endpoint. More details below.

Azure DNS

Azure DNS uses alias records for Azure resources within the same subscription.

To add an alias record for your Azure CDN endpoint:

  1. Sign in to the Azure portal.

  2. In the left-hand menu, select All resources then the Azure DNS zone for your custom domain.

  3. In the DNS zone for your custom domain, select + Record set.

  4. In Add record set enter or select the following information:

    Setting Value
    Name Enter alias you want to use for your CDN endpoint. For example, www.
    Type Select CNAME.
    Alias record set Select Yes.
    Alias type Select Azure resource.
    Choose a subscription Select your subscription.
    Azure resource Select your Azure CDN endpoint.

  5. Change the TTL for the record to your value.

  6. Select OK.

DNS Provider

Map the temporary cdnverify subdomain

When you map an existing domain that is in production, there are special considerations.

A brief period of downtime for the domain can occur when registering your custom domain in the Azure portal.

To avoid interruption of web traffic, map your custom domain to your CDN endpoint hostname with the Azure cdnverify subdomain. This process creates a temporary CNAME mapping.

With this method, users can access your domain without interruption while the DNS mapping occurs.

If production downtime considerations aren't a concern, you can directly map your custom domain to your CDN endpoint. Continue to Map the permanent custom domain.

To create a CNAME record with the cdnverify subdomain:

  1. Sign in to the web site of the DNS provider for your custom domain.

  2. Create a CNAME record entry for your custom domain and complete the fields as shown in the following table (field names may vary):

    Source Type Destination
    cdnverify.www.contoso.com CNAME cdnverify.contoso.azureedge.net

    • Source: Enter your custom domain name, including the cdnverify subdomain, in the following format: cdnverify.<custom-domain-name>

    • Type: Enter or select CNAME.

    • Destination: Enter your CDN endpoint hostname, including the cdnverify subdomain, in the following format: cdnverify.<endpoint-name>.azureedge.net.

      • For example: cdnverify.contoso.azureedge.net

  3. Save your changes.

Map the permanent custom domain

In this section, you map the permanent custom domain to the CDN endpoint.

To create a CNAME record for your custom domain:

  1. Sign in to the web site of the domain provider for your custom domain.

  2. Create a CNAME record entry for your custom domain and complete the fields as shown in the following table (field names may vary):

    Source Type Destination
    www.contoso.com CNAME contoso.azureedge.net

    • Source: Enter your custom domain name.

    • Type: Enter or select CNAME.

    • Destination: Enter your CDN endpoint hostname in the following format: <endpoint-name>.azureedge.net.

      • For example: contoso.azureedge.net

  3. Save your changes.

  4. If you're previously created a temporary cdnverify subdomain CNAME record, delete it.

  5. If you're using this custom domain in production for the first time, follow the steps for Add the custom domain with your CDN endpoint and Verify the custom domain.

Add a custom domain to your CDN endpoint

After you've registered your custom domain, you can then add it to your CDN endpoint.

Azure portal

  1. Sign in to the Azure portal and browse to the CDN profile containing the endpoint that you want to map to a custom domain.

  2. On the CDN profile page, select the CDN endpoint to add the custom domain.

    :::image type="content" source="media/cdn-map-content-to-custom-domain/cdn-endpoint-selection.png" alt-text="CDN endpoint selection" border="true":::

  3. Select + Custom domain.

    :::image type="content" source="media/cdn-map-content-to-custom-domain/cdn-custom-domain-button.png" alt-text="Add custom domain button" border="true":::

  4. In Add a custom domain, Endpoint hostname, is pre-filled and is derived from your CDN endpoint URL: <endpoint-hostname>.azureedge.net. It cannot be changed.

  5. For Custom hostname, enter your custom domain, including the subdomain, to use as the source domain of your CNAME record.

    1. For example, www.contoso.com or cdn.contoso.com. Don't use the cdnverify subdomain name.

    :::image type="content" source="media/cdn-map-content-to-custom-domain/cdn-add-custom-domain.png" alt-text="Add custom domain" border="true":::

  6. Select Add.

    Azure verifies that the CNAME record exists for the custom domain name you entered. If the CNAME is correct, your custom domain will be validated.

    It can take some time for the new custom domain settings to propagate to all CDN edge nodes:

    • For Azure CDN Standard from Microsoft profiles, propagation usually completes in 10 minutes.
    • For Azure CDN Standard from Akamai profiles, propagation usually completes within one minute.
    • For Azure CDN Standard from Verizon and Azure CDN Premium from Verizon profiles, propagation usually completes in 10 minutes.

PowerShell

  1. Sign in to Azure PowerShell:
    Connect-AzAccount

  1. Use New-AzCdnCustomDomain to map the custom domain to your CDN endpoint.

    • Replace myendpoint8675.azureedge.net with your endpoint url.
    • Replace myendpoint8675 with your CDN endpoint name.
    • Replace www.contoso.com with your custom domain name.
    • Replace myCDN with your CDN profile name.
    • Replace myResourceGroupCDN with your resource group name.
    $parameters = @{
        Hostname = 'myendpoint8675.azureedge.net'
        EndPointName = 'myendpoint8675'
        CustomDomainName = 'www.contoso.com'
        ProfileName = 'myCDN'
        ResourceGroupName = 'myResourceGroupCDN'
    }
    New-AzCdnCustomDomain @parameters

Azure verifies that the CNAME record exists for the custom domain name you entered. If the CNAME is correct, your custom domain will be validated.

It can take some time for the new custom domain settings to propagate to all CDN edge nodes:

  • For Azure CDN Standard from Microsoft profiles, propagation usually completes in 10 minutes.
  • For Azure CDN Standard from Akamai profiles, propagation usually completes within one minute.
  • For Azure CDN Standard from Verizon and Azure CDN Premium from Verizon profiles, propagation usually completes in 10 minutes.

Verify the custom domain

After you've completed the registration of your custom domain, verify that the custom domain references your CDN endpoint.

  1. Ensure that you have public content that is cached at the endpoint. For example, if your CDN endpoint is associated with a storage account, Azure CDN will cache the content in a public container. Set your container to allow public access and it contains at least one file to test the custom domain.

  2. In your browser, navigate to the address of the file by using the custom domain. For example, if your custom domain is www.contoso.com, the URL to the cached file should be similar to the following URL: http://www.contoso.com/my-public-container/my-file.jpg. Verify that the result is that same as when you access the CDN endpoint directly at <endpoint-hostname>.azureedge.net.

Clean up resources

Azure portal

If you no longer want to associate your endpoint with a custom domain, remove the custom domain by doing the following steps:

  1. Go to your DNS provider, delete the CNAME record for the custom domain, or update the CNAME record for the custom domain to a non-Azure CDN endpoint.

    [!Important] To prevent dangling DNS entries and the security risks they create, starting from April 9th 2021, Azure CDN requires removal of the CNAME records to Azure CDN endpoints before the resources can be deleted. Resources include Azure CDN custom domains, Azure CDN profiles/endpoints or Azure resource groups that has Azure CDN custom domain(s) enabled.

  2. In your CDN profile, select the endpoint with the custom domain that you want to remove.

  3. From the Endpoint page, under Custom domains, right-click the custom domain that you want to remove, then select Delete from the context menu. Select Yes.

    The custom domain is removed from your endpoint.

PowerShell

If you no longer want your endpoint to have a custom domain, remove the custom domain by doing the following steps:

  1. Go to your DNS provider, delete the CNAME record for the custom domain, or update the CNAME record for the custom domain to a non-Azure CDN endpoint.

    [!Important] To prevent dangling DNS entries and the security risks they create, starting from April 9th 2021, Azure CDN requires removal of the CNAME records to Azure CDN endpoints before the resources can be deleted. Resources include Azure CDN custom domains, Azure CDN profiles/endpoints or Azure resource groups that has Azure CDN custom domain(s) enabled.

  2. Use Remove-AzCdnCustomDomain to remove the custom domain from the endpoint:

    • Replace myendpoint8675 with your CDN endpoint name.
    • Replace www.contoso.com with your custom domain name.
    • Replace myCDN with your CDN profile name.
    • Replace myResourceGroupCDN with your resource group name.
        $parameters = @{
        CustomDomainName = 'www.contoso.com'
        EndPointName = 'myendpoint8675'
        ProfileName = 'myCDN'
        ResourceGroupName = 'myResourceGroupCDN'
    }
    Remove-AzCdnCustomDomain @parameters

Next steps

In this tutorial, you learned how to:

[!div class="checklist"]

  • Create a CNAME DNS record.
  • Add a custom domain with your CDN endpoint.
  • Verify the custom domain.

Advance to the next tutorial to learn how to configure HTTPS on an Azure CDN custom domain.

[!div class="nextstepaction"] Tutorial: Configure HTTPS on an Azure CDN custom domain