Note: PowerShell integration requires a ShareGate Migrate Pro or Enterprise subscription. It is not available on the Essentials plan.
Command
Get-SharePointConnection
Description
Gets saved SharePoint connections from the Connection Manager. Use the returned connection with -UseConnection in Connect-Site or Connect-Tenant to connect without re-entering credentials.
Examples
Get all saved SharePoint connections
Get-SharePointConnection
Get saved SharePoint connections for a host
Get-SharePointConnection -SharePointHost sharegate.sharepoint.com
Get a saved SharePoint connection by ID
Get-SharePointConnection -Id 2ff2f1f8-537e-4c1c-90f2-fb94e4596354
Syntax
Get-SharePointConnection
[-UserName <String>]
[-SharePointHost <String>]
Get-SharePointConnection
-Id <Guid>
Parameters
-Id <Guid>
Returns the single connection with the specified ID.
Required? | True |
Default value | None |
Accept pipeline input? | False |
Accept wildcard characters? | False |
Parameter set name | Id |
Aliases | None |
-SharePointHost <String>
Filters connections by SharePoint host domain.
Required? | False |
Default value | None |
Accept pipeline input? | False |
Accept wildcard characters? | False |
Parameter set name | Default |
Aliases | Host |
-UserName <String>
Filters connections by username.
Required? | False |
Default value | None |
Accept pipeline input? | False |
Accept wildcard characters? | False |
Parameter set name | Default |
Aliases | None |