Get-PnPIsSiteAliasAvailable

Tip

We encourage you to make improvements to this documentation. Please navigate to https://github.com/pnp/powershell/blob/dev/documentation/Get-PnPIsSiteAliasAvailable.md to change this file.

Validates if a certain alias is still available to be used to create a new site collection for. If it is not, it will propose an alternative alias and URL which is still available.

Syntax

Get-PnPIsSiteAliasAvailable
   [-Identity <String>]
   [-Connection <PnPConnection>]
   [<CommonParameters>]

Examples

EXAMPLE 1

Get-PnPIsSiteAliasAvailable -Identity "HR"

Validates if the alias "HR" is still available to be used

Parameters

-Connection

Optional connection to be used by the cmdlet. Retrieve the value for this parameter by either specifying -ReturnConnection on Connect-PnPOnline or by executing Get-PnPConnection.

Type:PnPConnection
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:False
-Identity

Alias you want to check for if it is still available to create a new site collection for

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