| external help file | sharepointonline.xml |
|---|---|
| Module Name | Microsoft.Online.SharePoint.PowerShell |
| online version | https://learn.microsoft.com/powershell/module/sharepoint-online/connect-sposervice |
| applicable | SharePoint Online |
| title | Connect-SPOService |
| schema | 2.0.0 |
| author | trent-green |
| ms.author | trgreen |
| ms.reviewer |
Connects a SharePoint Online administrator to a SharePoint Online connection (the SharePoint Online Administration Center). This cmdlet must be run before any other SharePoint Online cmdlets can run.
Connect-SPOService -AuthenticationUrl <String> [-ClientTag <String>] [-Credential <CredentialCmdletPipeBind>]
-Url <UrlCmdletPipeBind> -ModernAuth <Boolean> [<CommonParameters>] Connect-SPOService [-ClientTag <String>] [-Credential <CredentialCmdletPipeBind>]
[-Region <AADCrossTenantAuthenticationLocation>] -Url <UrlCmdletPipeBind> [<CommonParameters>]The Connect-SPOService cmdlet connects a SharePoint Online 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 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.
Connect-SPOService -Url https://contoso-admin.sharepoint.com -credential admin@contoso.comExample 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.>
$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 $credExample 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.>
Connect-SPOService -Url https://contoso-admin.sharepoint.comPrompts for credentials. This is required if the account is using multi-factor authentication.
Connect-SPOService -Url https://contoso-admin.sharepoint.com -Region ITARConnects to a SharePoint Online Administration Center specifying the region.
Connect-SPOService -Credential $creds -Url https://tenant-admin.sharepoint.com -ModernAuth $true -AuthenticationUrl https://login.microsoftonline.com/organizationsConnecting to SPO Service with ModernAuth Flag.
Location for Microsoft Entra Cross-Tenant Authentication service. Can be optionally used if non-default Cross-Tenant Authentication Service is used.
Type: String
Parameter Sets: AuthenticationUrl
Aliases:
Applicable: SharePoint Online
Required: True
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: FalsePermits appending a client tag to existing client tag. Used optionally in the CSOM http traffic to identify used script or solution.
Type: String
Parameter Sets: (All)
Aliases:
Applicable: SharePoint Online
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: FalseSpecifies 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.
Type: CredentialCmdletPipeBind
Parameter Sets: (All)
Aliases:
Applicable: SharePoint Online
Required: False
Position: Named
Default value: None
Accept pipeline input: True (ByValue)
Accept wildcard characters: FalseThe valid values are: Default | ITAR | Germany | China
The default value is "default".
Note: The ITAR value is for GCC High and DoD tenancies only.
Type: AADCrossTenantAuthenticationLocation
Parameter Sets: AuthenticationLocation
Aliases:
Applicable: SharePoint Online
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: FalseSpecifies the URL of the SharePoint Online Administration Center site.
Type: UrlCmdletPipeBind
Parameter Sets: (All)
Aliases:
Applicable: SharePoint Online
Required: True
Position: Named
Default value: None
Accept pipeline input: True (ByValue)
Accept wildcard characters: FalseEnsures 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.
Type: Boolean
Parameter Sets: (All)
Aliases:
Applicable: SharePoint Online
Required: False
Position: Named
Default value: False
Accept pipeline input: False
Accept wildcard characters: FalseThis cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters.
Introduction to the SharePoint Online management shell