Copy-SPTaxonomyGroups
Copies Managed Metadata Taxonomy Groups from SharePoint on-premises to SharePoint Online.
Syntax
Default (Default)
Copy-SPTaxonomyGroups
[-AssignmentCollection <SPAssignmentCollection>]
[-AuthEndpoint <String>]
-Credential <PSCredential>
[-GraphApiEndpoint <String>]
-GroupNames <String[]>
-LocalSiteUrl <Uri>
-LocalTermStoreName <String>
-RemoteSiteUrl <Uri>
[<CommonParameters>]
Description
Use the Copy-SPTaxonomyGroups cmdlet to copy specified Metadata groups from an on-premises environment to SharePoint Online in a Hybrid SharePoint setup. SharePoint Online becomes the authoritative source for the copied Taxonomy Group. All updates to the Taxonomy Group must be made in SharePoint Online. Once a Taxonomy Group is copied, it cannot be re-copied.
Examples
Example 1
$credential = Get-Credential
Copy-SPTaxonomyGroups -LocalTermStoreName "Managed Metadata Service Application Proxy" -LocalSiteUrl "https://sharepoint" -RemoteSiteUrl "https://contoso.sharepoint.com" -GroupNames "Group1","Group2" -Credential $credential
This example copies two taxonomy groups "Group1" and "Group2" from local Term Store to the remote Term Store in "https://contoso.com". These two sites have been enabled with Hybrid Taxonomy.
Parameters
-AssignmentCollection
Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019
Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. When SPWeb, SPSite, or SPSiteAdministration objects are used, the objects are automatically disposed of if an assignment collection or the Global parameter is not used.
When the Global parameter is used, all objects are contained in the global store. If objects are not immediately used, or disposed of by using the Stop-SPAssignment command, an out-of-memory scenario can occur.
Parameter properties
| Type: | SPAssignmentCollection |
| 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 |
-AuthEndpoint
Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019
Specifies the Azure Active Directory Graph API authentication endpoint. By default, the well-known endpoint will be used.
Parameter properties
| Type: | 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 Server 2013, SharePoint Server 2016, SharePoint Server 2019
Specifies the Taxonomy Term Store administrator credential of remote SharePoint Online Term Store.
Writes data to remote Term Store, so a Term Store Administrator's credential is needed to perform the operations.
Parameter properties
| Type: | PSCredential |
| 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: | True |
| Value from remaining arguments: | False |
-GraphApiEndpoint
Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019
Specifies the Azure Active Directory Graph API endpoint. By default, the well-known endpoint will be used.
Parameter properties
| Type: | 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 |
-GroupNames
Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019
Specifies the name array of Taxonomy groups in local on-premises term store that will be copied to remote SharePoint Online Term store.
Parameter properties
| Type: | String[] |
| 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: | True |
| Value from remaining arguments: | False |
-LocalSiteUrl
Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019
Specifies the Url of local SharePoint on-premises site that contains the local Taxonomy Term Store.
Parameter properties
| Type: | Uri |
| 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: | True |
| Value from remaining arguments: | False |
-LocalTermStoreName
Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019
Specifies the name of local Taxonomy Term Store in the SharePoint on-premises farm.
Parameter properties
| Type: | String |
| 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: | True |
| Value from remaining arguments: | False |
-RemoteSiteUrl
Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019
Specifies the Url of remote SharePoint Online site that contains remote Taxonomy Term Store.
Parameter properties
| Type: | Uri |
| 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: | True |
| 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
System.String
System.Uri System.String[] System.Management.Automation.PSCredential Microsoft.SharePoint.PowerShell.SPAssignmentCollection