Share via


Test-PartnerDomainAvailability

Tests if the specified domain name is available for creating a new tenant.

Syntax

Test-PartnerDomainAvailability
    [-Domain] <String>
    [<CommonParameters>]

Description

The Test-PartnerDomainAvailability cmdlet tests to see if the specified domain name is available for creating a new tenant.

Examples

Example 1

PS C:\> Test-PartnerDomainAvailability -Domain 'contoso.onmicrosoft.com'

Tests if the domain contoso.onmicrosoft.com is available. Returns true if yes, false otherwise.

Parameters

-Domain

A string that identifies the domain to check, e.g. "contoso.onmicrosoft.com". The domain prefix cannot be longer than 27 characters.

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

Inputs

None

Outputs

System.Boolean