Start-SPOSiteReview
SharePoint Administrators can delegate access governance of sites to corresponding site owners or site collection administrators through 'site access review'. The 'access review' is under the context of oversharing as specified in the Data Access Governance (DAG) reports. Read all about site access review here.
Syntax
Default (Default)
Start-SPOSiteReview
-ReportID <Guid>
-SiteID <Guid>
[-Comment <String>]
[-DeliveryMode <SiteReviewEmailDeliveryMode>]
[-RecipientRole <SiteReviewRecipientRoleParameter>]
[<CommonParameters>]
Description
Initiates a 'site access review' request under the context of the DAG report. By default, the request is sent via email to all site owners. Use -RecipientRole to send the request to site owners, site collection administrators, or both. Comments provided by the SharePoint Administrator are included with the request.
Examples
Example 1
PS C:\> Start-SPOSiteReview -ReportID 03327d1c-38c5-4c32-9dad-85753a682d65 -SiteID a10f1997-71f2-4ef2-825e-2439400fc601 -comment "check for EEEU access"
The above cmdlet initiates site access review for the given site as per oversharing criteria mentioned in the given DAG report.
Example 2
PS C:\> Start-SPOSiteReview -ReportID 03327d1c-38c5-4c32-9dad-85753a682d65 -SiteID a10f1997-71f2-4ef2-825e-2439400fc601 -DeliveryMode SingleEmail
The above cmdlet initiates site access review and notifies the reviewers with a single grouped email instead of one email per reviewer. Reviewers are grouped by their notification language, so one email is sent for each language used by the reviewers.
Example 3
PS C:\> Start-SPOSiteReview -ReportID 03327d1c-38c5-4c32-9dad-85753a682d65 -SiteID a10f1997-71f2-4ef2-825e-2439400fc601 -RecipientRole All
The above cmdlet initiates site access review and sends the request to both the site owners and site collection administrators. A person who belongs to both groups is included only once.
Parameters
-Comment
SharePoint Administrator to add comments to provide more context to the reviewers regarding the purpose of the review.
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 |
-DeliveryMode
Specifies how the reviewers are notified for this site access review.
The acceptable values for this parameter are:
- Individual: Each reviewer receives a separate email. This is the behavior when the parameter is omitted.
- SingleEmail: The reviewers receive a single grouped email instead of one email each. Reviewers are grouped by their notification language, so one email is sent for each language used by the reviewers.
If a custom email template is configured for site access reviews in your organization, the grouping setting on that template determines how the reviewers are notified, and it takes precedence over this parameter.
Parameter properties
| Type: | Microsoft.Online.SharePoint.PowerShell.SiteReviewEmailDeliveryMode |
| Default value: | None |
| Accepted values: | Individual, SingleEmail |
| 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 |
-RecipientRole
Specifies who receives the site access review request.
The acceptable values for this parameter are:
- SiteOwners: Sends the request to members of the site's owner group. This is the default behavior when the parameter is omitted and no recipient role is configured on the email template.
- SiteAdmins: Sends the request to the site collection administrators.
- All: Sends the request to both the site owners and site collection administrators. A person who is both an owner and an administrator is included only once.
If a custom email template is configured for site access reviews in your organization, the recipient role on that template determines who receives the request and takes precedence over this parameter.
Parameter properties
| Type: | Microsoft.Online.SharePoint.PowerShell.SiteReviewRecipientRoleParameter |
| Default value: | None |
| Accepted values: | SiteOwners, SiteAdmins, All |
| 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 |
-ReportID
Specifies the ID of the particular report which contains sites for which site access review should be initiated.
Parameter properties
| Type: | System.Guid |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
(All)
| Position: | Named |
| Mandatory: | True |
| Value from pipeline: | False |
| Value from pipeline by property name: | False |
| Value from remaining arguments: | False |
-SiteID
Specifies the ID of the site for which site access review should be initiated.
Parameter properties
| Type: | System.Guid |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
(All)
| Position: | Named |
| 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.