Connect-SPOService

Connects a SharePoint Online administrator or Global Administrator to a SharePoint Online connection (the SharePoint Online Administration Center). This cmdlet must be run before any other SharePoint Online cmdlets can run.

Syntax

Connect-SPOService
       -AuthenticationUrl <String>
       [-ClientTag <String>]
       [-Credential <CredentialCmdletPipeBind>]
       -Url <UrlCmdletPipeBind>
       [<CommonParameters>]
Connect-SPOService
       [-ClientTag <String>]
       [-Credential <CredentialCmdletPipeBind>]
       [-Region <AADCrossTenantAuthenticationLocation>]
       -Url <UrlCmdletPipeBind>
       [<CommonParameters>]

Description

The Connect-SPOService cmdlet connects a SharePoint Online administrator or Global Administrator to the SharePoint Online Administration Center.

Only a single SharePoint Online service connection is maintained from any single Windows PowerShell session. In other words, this is a per-organization administrator connection. Running the Connect-SPOService cmdlet twice implicitly disconnects the previous connection. The Windows PowerShell session will be set to serve the new SharePoint Online administrator specified.

A delegated partner administrator has to swap connections for different organizations within the same Windows PowerShell session.

You must be a SharePoint Online administrator or Global Administrator to run the cmdlet.

For permissions and the most current information about Windows PowerShell for SharePoint Online, see the online documentation at Intro to SharePoint Online Management Shell.

Examples

-----------------------EXAMPLE 1-----------------------------

Connect-SPOService -Url https://contoso-admin.sharepoint.com -credential admin@contoso.com

Example 1 shows how a SharePoint Online administrator or Global Administrator with credential admin@contoso.com connects to a SharePoint Online Administration Center that has the URL https://contoso-admin.sharepoint.com.

-----------------------EXAMPLE 2-----------------------------

$username = "admin@contoso.sharepoint.com"
$password = "password"
$cred = New-Object -TypeName System.Management.Automation.PSCredential -argumentlist $userName, $(convertto-securestring $Password -asplaintext -force)
Connect-SPOService -Url https://contoso-admin.sharepoint.com -Credential $cred

Example 2 shows how a SharePoint Online administrator or Global Administrator with a username and password connects to a SharePoint Online Administration Center that has the URL https://contoso-admin.sharepoint.com.

-----------------------EXAMPLE 3-----------------------------

Connect-SPOService -Url https://contoso-admin.sharepoint.com

Prompts for credentials. This is required if the account is using multi-factor authentication.

Parameters

-AuthenticationUrl

Location for AAD Cross-Tenant Authentication service. Can be optionally used if non-default Cross-Tenant Authentication Service is used.

Type:String
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:False
Applies to:SharePoint Online
-ClientTag

Permits appending a client tag to existing client tag. Used optionally in the CSOM http traffic to identify used script or solution.

Type:String
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:False
Applies to:SharePoint Online
-Credential

Specifies the credentials to use to connect. If no credentials are presented, a dialog will prompt for the credentials. The credentials must be those of a SharePoint Online administrator or Global Administrator who can access the SharePoint Online Administration Center site.

Type:CredentialCmdletPipeBind
Position:Named
Default value:None
Accept pipeline input:True
Accept wildcard characters:False
Applies to:SharePoint Online
-Region

The valid values are: Default | ITAR | Germany | China

The default value is "default".

Note

The ITAR value is for United States Government cloud tenancies only.

Type:AADCrossTenantAuthenticationLocation
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:False
Applies to:SharePoint Online
-Url

Specifies the URL of the SharePoint Online Administration Center site.

Type:UrlCmdletPipeBind
Position:Named
Default value:None
Accept pipeline input:True
Accept wildcard characters:False
Applies to:SharePoint Online