Share via


Test-PartnerDomainAvailability

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

Syntax

Default (Default)

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.

Parameter properties

Type:String
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

(All)
Position:0
Mandatory:True
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

CommonParameters

This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutBuffer, -OutVariable, -PipelineVariable, -ProgressAction, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters.

Inputs

None

Outputs

System.Boolean