Connect-SPOService
Connects the SharePoint Online Administrator or the SharePoint Embedded 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
AuthenticationLocation
Connect-SPOService
-Url <UrlCmdletPipeBind>
[-Credential <CredentialCmdletPipeBind>]
[-ClientTag <String>]
[-Region <AADCrossTenantAuthenticationLocation>]
[-ModernAuth <Boolean>]
[-UseSystemBrowser <Boolean>]
[<CommonParameters>]
AuthenticationUrl
Connect-SPOService
-Url <UrlCmdletPipeBind>
-AuthenticationUrl <String>
[-Credential <CredentialCmdletPipeBind>]
[-ClientTag <String>]
[-ModernAuth <Boolean>]
[-UseSystemBrowser <Boolean>]
[<CommonParameters>]
Description
The Connect-SPOService cmdlet connects the SharePoint Online Administrator or the SharePoint Embedded 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-geo within an 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 a SharePoint Embedded 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 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 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.
EXAMPLE 4
Connect-SPOService -Url https://contoso-admin.sharepoint.com -Region ITAR
Connects to a SharePoint Online Administration Center specifying the region.
EXAMPLE 5
Connect-SPOService -Credential $creds -Url https://tenant-admin.sharepoint.com -ModernAuth $true -AuthenticationUrl https://login.microsoftonline.com/organizations
Connecting to SPO Service with ModernAuth Flag.
EXAMPLE 6
Connect-SPOService -Url https://contoso-admin.sharepoint.com -UseSystemBrowser $true
Authenticates using the Microsoft Authentication Library (MSAL) and connects to the SharePoint Online Administration Center on successful authentication.
Parameters
-AuthenticationUrl
Applicable: SharePoint Online
Location for Microsoft Entra Cross-Tenant Authentication service. Can be optionally used if non-default Cross-Tenant Authentication Service is used.
Parameter properties
| Type: | System.String |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
AuthenticationUrl
| Position: | Named |
| Mandatory: | True |
| Value from pipeline: | False |
| Value from pipeline by property name: | False |
| Value from remaining arguments: | False |
-ClientTag
Applicable: SharePoint Online
Permits appending a client tag to existing client tag. Used optionally in the CSOM http traffic to identify used script or solution.
Parameter properties
| Type: | System.String |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
(All)
| Position: | Named |
| Mandatory: | False |
| Value from pipeline: | False |
| Value from pipeline by property name: | False |
| Value from remaining arguments: | False |
-Credential
Applicable: SharePoint Online
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 who can access the SharePoint Online Administration Center site.
Parameter properties
| Type: | Microsoft.Online.SharePoint.PowerShell.CredentialCmdletPipeBind |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
(All)
| Position: | Named |
| Mandatory: | False |
| Value from pipeline: | True |
| Value from pipeline by property name: | False |
| Value from remaining arguments: | False |
-ModernAuth
Applicable: SharePoint Online
Ensures that SharePoint Online tenant administration cmdlets can connect to the service using modern TLS protocols.
To use it you also need to provide the AuthenticationUrl parameter.
Parameter properties
| Type: | System.Boolean |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
(All)
| Position: | Named |
| Mandatory: | False |
| Value from pipeline: | False |
| Value from pipeline by property name: | False |
| Value from remaining arguments: | False |
-Region
Applicable: SharePoint Online
The valid values are: Default | ITAR | Germany | China
The default value is "default".
Note: The ITAR value is for GCC High and DoD tenancies only.
Parameter properties
| Type: | Microsoft.Online.SharePoint.PowerShell.AADCrossTenantAuthenticationLocation |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
AuthenticationLocation
| Position: | Named |
| Mandatory: | False |
| Value from pipeline: | False |
| Value from pipeline by property name: | False |
| Value from remaining arguments: | False |
-Url
Applicable: SharePoint Online
Specifies the URL of the SharePoint Online Administration Center site.
Parameter properties
| Type: | Microsoft.Online.SharePoint.PowerShell.UrlCmdletPipeBind |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
(All)
| Position: | Named |
| Mandatory: | True |
| Value from pipeline: | True |
| Value from pipeline by property name: | False |
| Value from remaining arguments: | False |
-UseSystemBrowser
Applicable: SharePoint Online
Used to authenticate the user using the Microsoft Authentication Library (MSAL).
Parameter properties
| Type: | System.Boolean |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
(All)
| Position: | Named |
| Mandatory: | False |
| 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.