Edit

Share via


Add-SPOGeoAdministrator

Adds a new SharePoint user or security group as GeoAdministrator to a multi-geo tenant.

Syntax

User (Default)

Add-SPOGeoAdministrator
    [-UserPrincipalName] <String>
    [<CommonParameters>]

Group

Add-SPOGeoAdministrator
    [-GroupAlias] <String>
    [<CommonParameters>]

ObjectId

Add-SPOGeoAdministrator
    [-ObjectId] <Guid>
    [<CommonParameters>]

Description

This cmdlet requires a connection to a multi-geo tenant to run correctly. You must be a SharePoint Online administrator to run this cmdlet.

Examples

EXAMPLE 1

Add-SPOGeoAdministrator -UserPrincipalName admin@contoso.onmicrosoft.com

Adds the user admin@contoso.onmicrosoft.com as administrator to the SharePoint Online multi-geo tenant.

Parameters

-GroupAlias

Applicable: SharePoint Online

Use this parameter to add a security group or a mail-enabled security group as a geo admin. (Distribution groups and Microsoft 365 Groups are not supported).

Parameter properties

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

Parameter sets

Group
Position:0
Mandatory:True
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-ObjectId

Applicable: SharePoint Online

Not all security groups have a group alias. If you want to add a security group that does not have an alias, run Get-MsolGroup to retrieve a list of groups, find your security group's ObjectID, and then use this parameter. For more information, see Add or remove a geo administrator in Microsoft 365 Multi-Geo.

Parameter properties

Type:System.Guid
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

ObjectId
Position:0
Mandatory:True
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-UserPrincipalName

Applicable: SharePoint Online

UserPrincipalName or UPN defined for the specific user on the SharePoint Online tenant.

Parameter properties

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

Parameter sets

User
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.Object