In this article, we will explore the usage of the Test-AzFrontDoorCdnProfileHostNameAvailability cmdlet in PowerShell. This cmdlet is part of the Azure PowerShell module and is used to check the availability of a custom domain name for use with Azure Front Door CDN profiles. It is important for readers who work with Windows environments to understand how to use this cmdlet effectively.

Azure Front Door is a global, scalable, and secure entry point for fast delivery of your global applications. It provides a range of features, including content delivery network (CDN) capabilities. When configuring a Front Door CDN profile, you can add custom domain names to improve branding and make it easier for users to access your content. However, before adding a custom domain name, it is essential to check its availability to avoid conflicts with existing resources.

The Test-AzFrontDoorCdnProfileHostNameAvailability cmdlet allows you to verify the availability of a custom domain name. It performs a DNS lookup to determine if the domain name is already in use. By using this cmdlet, you can ensure that the custom domain name you want to add to your Front Door CDN profile is unique and available for use.

Examples:

1. Check the availability of a custom domain name:

$domainName = "www.example.com"
$profileName = "myFrontDoorProfile"

$result = Test-AzFrontDoorCdnProfileHostNameAvailability -HostName $domainName -ProfileName $profileName

if ($result.Available) {
    Write-Host "The domain name is available for use."
} else {
    Write-Host "The domain name is already in use."
}

2. Check the availability of multiple domain names:

$domainNames = @("www.example1.com", "www.example2.com")
$profileName = "myFrontDoorProfile"

foreach ($domainName in $domainNames) {
    $result = Test-AzFrontDoorCdnProfileHostNameAvailability -HostName $domainName -ProfileName $profileName

    if ($result.Available) {
        Write-Host "The domain name $domainName is available for use."
    } else {
        Write-Host "The domain name $domainName is already in use."
    }
}