Test-AzureTrafficManagerDomainName

Reference

Module:: Azure

Checks whether a domain name is available as a Traffic Manager profile.

Note

The cmdlets referenced in this documentation are for managing legacy Azure resources that use Azure Service Manager (ASM) APIs. This legacy PowerShell module isn't recommended when creating new resources since ASM is scheduled for retirement. For more information, see Azure Service Manager retirement.

The Az PowerShell module is the recommended PowerShell module for managing Azure Resource Manager (ARM) resources with PowerShell.

Syntax

Test-AzureTrafficManagerDomainName
    -DomainName <String>
    [-Profile <AzureSMProfile>]
    [<CommonParameters>]

Description

The Test-AzureTrafficManagerDomainName cmdlet checks whether a domain name is available as a Microsoft Azure Traffic Manager profile. If the domain name is available, this cmdlet returns a value of $True.

Examples

Example 1: Check whether a domain name is available

PS C:\>Test-AzureTrafficManagerDomainName -DomainName "ContosoApp.trafficmanager.net"
$True

This command checks whether the domain name ContosoApp.trafficmanager.net is available as a Traffic Manager profile.

Parameters

-DomainName

Specifies the domain name to test. You must include the following string:

.trafficmanager.net

Type:	String
Position:	Named
Default value:	None
Required:	True
Accept pipeline input:	False
Accept wildcard characters:	False

-Profile

Specifies the Azure profile from which this cmdlet reads. If you do not specify a profile, this cmdlet reads from the local default profile.

Type:	AzureSMProfile
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

Outputs

Boolean

This cmdlet generates $True or $False. If the domain name is available, this cmdlet returns a value of $True.

Share via