Sync-SPProjectPermissions
Manually synchronizes permissions between a Project Web App instance and its associated project sites.
Syntax
PSMode
Sync-SPProjectPermissions
[-Url] <Uri>
[-SyncPWASite]
[-SyncProjectSites]
[-Async]
[-AssignmentCollection <SPAssignmentCollection>]
[<CommonParameters>]
SPMode
Sync-SPProjectPermissions
[-Url] <Uri>
[[-Type] <SharePointPermissionModeSyncType>]
[-AssignmentCollection <SPAssignmentCollection>]
[<CommonParameters>]
Description
The Sync-SPProjectPermissions cmdlet causes permissions to be synchronized to the project sites associated with projects in a Project Web App instance and the permissions set on those projects in Project Server.
This cmdlet works with both SharePoint permission mode and Project Server permission mode.
For permissions and the most current information about Windows PowerShell for Project Server, see the online documentation at https://go.microsoft.com/fwlink/p/?LinkId=251833 (https://go.microsoft.com/fwlink/p/?LinkId=251833).
Examples
EXAMPLE
Sync-SPProjectPermissions -Url https://pwa_site -Type Full
Performs a full sync against the PWA site https://pwa_site.
Parameters
-AssignmentCollection
Applicable: Project Server 2013, Project Server 2016, Project 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 |
-Async
Applicable: Project Server 2013, Project Server 2016, Project Server 2019
Specifies that the synchronization is placed in the Project Server queue. Omitting this flag causes the synchronization to occur immediately within the Windows PowerShell console.
This parameter is used with Project Server permission mode.
Parameter properties
| Type: | SwitchParameter |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
PSMode
| Position: | 4 |
| Mandatory: | False |
| Value from pipeline: | False |
| Value from pipeline by property name: | False |
| Value from remaining arguments: | False |
-SyncProjectSites
Applicable: Project Server 2013, Project Server 2016, Project Server 2019
Triggers a synchronization of Project Server permissions to the project sites.
This parameter is used with Project Server permission mode.
Parameter properties
| Type: | SwitchParameter |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
PSMode
| Position: | 3 |
| Mandatory: | False |
| Value from pipeline: | False |
| Value from pipeline by property name: | False |
| Value from remaining arguments: | False |
-SyncPWASite
Applicable: Project Server 2013, Project Server 2016, Project Server 2019
Triggers a synchronization of Project Server permissions to the PWA site.
This parameter is used with Project Server permission mode.
Parameter properties
| Type: | SwitchParameter |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
PSMode
| Position: | 2 |
| Mandatory: | False |
| Value from pipeline: | False |
| Value from pipeline by property name: | False |
| Value from remaining arguments: | False |
-Type
Applicable: Project Server 2013, Project Server 2016, Project Server 2019
Specifies the type of sync to perform: full or incremental.
This parameter is used with SharePoint permission mode.
Valid values are:
Full, Incremental, AllGroups
Parameter properties
| Type: | SharePointPermissionModeSyncType |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
SPMode
| Position: | 2 |
| Mandatory: | False |
| Value from pipeline: | False |
| Value from pipeline by property name: | False |
| Value from remaining arguments: | False |
-Url
Applicable: Project Server 2013, Project Server 2016, Project Server 2019
Specifies the URL of the Project Web App instance for which you want to synch permissions.
The type must be a valid URL, in the form https://pwa_site.
Parameter properties
| Type: | Uri |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
(All)
| Position: | 1 |
| Mandatory: | True |
| 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.