Test-AzureRmDnsAvailability

  • Reference
Module:
AzureRM.Network

Checks whether a domain name in the cloudapp.azure.com zone is available for use.

Warning

The AzureRM PowerShell module has been officially deprecated as of February 29, 2024. Users are advised to migrate from AzureRM to the Az PowerShell module to ensure continued support and updates.

Although the AzureRM module may still function, it's no longer maintained or supported, placing any continued use at the user's discretion and risk. Please refer to our migration resources for guidance on transitioning to the Az module.

Syntax

Test-AzureRmDnsAvailability
    -DomainNameLabel <String>
    -Location <String>
    [-DefaultProfile <IAzureContextContainer>]
    [<CommonParameters>]

Description

Checks whether a domain name in the cloudapp.azure.com zone is available for use.

Examples

Example 1: Check if contoso.cloudapp.azure.com is available for use.

Test-AzureRmDnsAvailability -DomainNameLabel contoso -Location westus

Parameters

-DefaultProfile

The credentials, account, tenant, and subscription used for communication with azure.

Type:IAzureContextContainer
Aliases:AzureRmContext, AzureCredential
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-DomainNameLabel

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

-Location

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

Inputs

None

Outputs

Boolean