Skip to content

Latest commit

 

History

History
304 lines (225 loc) · 9.25 KB

File metadata and controls

304 lines (225 loc) · 9.25 KB
external help file Microsoft.Online.SharePoint.PowerShell.dll-Help.xml
Module Name Microsoft.Online.SharePoint.PowerShell
online version https://learn.microsoft.com/powershell/module/microsoft.online.sharepoint.powershell/start-spodataaccessgovernanceinsight
applicable SharePoint Online
title Start-SPODataAccessGovernanceInsight
schema 2.0.0
author pvrk
ms.author pullabhk
manager
ms.reviewer

Start-SPODataAccessGovernanceInsight

SYNOPSIS

This cmdlet generates Data Access Governance (DAG) reports meant to provide insights into potential oversharing of sensitive data in SharePoint and/or OneDrive for Business. SharePoint Advanced Management (SAM) license is required to run these reports.

SYNTAX

EEEUParameterSet

Start-SPODataAccessGovernanceInsight -ReportEntity <ReportEntityEnum> -Workload <WorkloadEnum>
 -ReportType <ReportTypeEnum> -Name <String>
 [-Template <System.Collections.Generic.List`1[Microsoft.Online.SharePoint.TenantAdministration.TemplateEnum]>]
 [-Privacy <PrivacyEnum>] [-SiteSensitivityLabelGUID <System.Collections.Generic.List`1[System.Guid]>]
 [<CommonParameters>]

SharingLinkParameterSet

Start-SPODataAccessGovernanceInsight -ReportEntity <ReportEntityEnum> -Workload <WorkloadEnum>
 -ReportType <ReportTypeEnum> [<CommonParameters>]

LabelParameterSet

Start-SPODataAccessGovernanceInsight -ReportEntity <ReportEntityEnum> -Workload <WorkloadEnum>
 -ReportType <ReportTypeEnum> [-FileSensitivityLabelName <String>] -FileSensitivityLabelGUID <Guid>
 [<CommonParameters>]

SitePermissionsParameterSet

Start-SPODataAccessGovernanceInsight -ReportEntity <ReportEntityEnum> -Workload <WorkloadEnum>
 -ReportType <ReportTypeEnum> -Name <String>
 [-Template <System.Collections.Generic.List`1[Microsoft.Online.SharePoint.TenantAdministration.TemplateEnum]>]
 [-Privacy <PrivacyEnum>] [-SiteSensitivityLabelGUID <System.Collections.Generic.List`1[System.Guid]>]
 -CountOfUsersMoreThan <Int32> [<CommonParameters>]

UserPermissionsParameterSet

Start-SPODataAccessGovernanceInsight -ReportEntity <ReportEntityEnum> -Workload <WorkloadEnum>
 -ReportType <ReportTypeEnum> -Name <String> -UserPrincipalNames <System.Collections.Generic.List`1[System.String]>
 [<CommonParameters>]

DetailedEEEUParameterSet

Start-SPODataAccessGovernanceInsight -ReportEntity <ReportEntityEnum> -ReportType <ReportTypeEnum>
 [<CommonParameters>]

DESCRIPTION

This cmdlet is used to generate DAG reports which deal with potential oversharing of sensitive data. These reports are present in Sharepoint admin center. Reports are currently available for the following scenarios:

  • Sharing links created in last 28 days (Anyone, People-in-your-org, Specific people shared externally).
  • Content shared with Everyone except external users (EEEU) in last 28 days.
  • List of sites having labelled files, as of report generation time.
  • List of sites having 'too-many-users', as of report generation time, to setup an oversharing baseline.
  • List of sites with direct or indirect permissions to given users.

EXAMPLES

Example 1

Start-SPODataAccessGovernanceInsight -ReportEntity PermissionedUsers -Workload SharePoint -ReportType Snapshot -Name "OversharingBaselineReport" -CountOfUsersMoreThan 0

The above cmdlet generates a list of SharePoint sites which can be accessed by more than 1000 users, as of report generation day.

Example 2

Start-SPODataAccessGovernanceInsight -ReportEntity EveryoneExceptExternalUsers -ReportType Snapshot

The above cmdlet generates a detailed report for all content shared with 'Everyone except external users' (Sites, groups and files) across both SharePoint sites and OneDrive accounts, as of report generation time.

PARAMETERS

-CountOfUsersMoreThan

Specifies the threshold of oversharing as defined by the number of users that can access the site. The number of users that can access the site are determined by expanding all users, groups across all permissions (at site level and at the level of any item with unqiue permissions), deduplicate and arrive at a unique number. Minimum value is 0.

Type: System.Int32
Parameter Sets: SitePermissionsParameterSet
Aliases:

Required: True
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-FileSensitivityLabelGUID

Specifies the GUID for the sensitivity label for the file.

Type: System.Guid
Parameter Sets: LabelParameterSet
Aliases:

Required: True
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-FileSensitivityLabelName

Specifies the name of the sensitivity label for the file.

Type: System.String
Parameter Sets: LabelParameterSet
Aliases:

Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-Name

Specifies the name to be given to the generated report.

Type: System.String
Parameter Sets: EEEUParameterSet, SitePermissionsParameterSet, UserPermissionsParameterSet
Aliases:

Required: True
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-Privacy

Specifies the privacy setting of the Microsoft 365 group. Relevant in case of filtering the report for group connected sites.

Type: Microsoft.Online.SharePoint.TenantAdministration.PrivacyEnum
Parameter Sets: EEEUParameterSet, SitePermissionsParameterSet
Aliases:
Accepted values: All, Private, Public

Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-ReportEntity

Specifies the entity that could cause oversharing and hence tracked by these reports.

Type: Microsoft.Online.SharePoint.TenantAdministration.ReportEntityEnum
Parameter Sets: (All)
Aliases:
Accepted values: SharingLinks_Anyone, SharingLinks_PeopleInYourOrg, SharingLinks_Guests, SensitivityLabelForFiles, EveryoneExceptExternalUsersAtSite, EveryoneExceptExternalUsersForItems, PermissionedUsers, PermissionsReport, EveryoneExceptExternalUsers, Everyone

Required: True
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-ReportType

Specifies the time period of data based on which DAG report is generated. A 'Snapshot' report will have the latest data as of the report generation time. A 'RecentActivity' report will be based on data in the last 28 days.

Type: Microsoft.Online.SharePoint.TenantAdministration.ReportTypeEnum
Parameter Sets: (All)
Aliases:
Accepted values: Snapshot, RecentActivity

Required: True
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-SiteSensitivityLabelGUID

Specifies the GUID of the sensitivity label applied to the site.

Type: System.Collections.Generic.List`1[System.Guid]
Parameter Sets: EEEUParameterSet, SitePermissionsParameterSet
Aliases:

Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-Template

Specifies the template of the site. Relevant in case a report should be generated for that particular template.

Type: System.Collections.Generic.List`1[Microsoft.Online.SharePoint.TenantAdministration.TemplateEnum]
Parameter Sets: EEEUParameterSet, SitePermissionsParameterSet
Aliases:
Accepted values: AllSites, ClassicSites, CommunicationSites, TeamSites, OtherSites

Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-UserPrincipalNames

Specifies the user principal names of the users for whom permissions report should be generated.

Type: System.Collections.Generic.List`1[System.String]
Parameter Sets: UserPermissionsParameterSet
Aliases:

Required: True
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-Workload

Specifies whether the report is for SharePoint sites or OneDrive accounts.

Type: Microsoft.Online.SharePoint.TenantAdministration.WorkloadEnum
Parameter Sets: EEEUParameterSet, SharingLinkParameterSet, LabelParameterSet, SitePermissionsParameterSet, UserPermissionsParameterSet
Aliases:
Accepted values: SharePoint, OneDriveForBusiness

Required: True
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

CommonParameters

This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters.

INPUTS

None

OUTPUTS

System.Object

NOTES

RELATED LINKS

Data Access Governance reports (DAG) for SharePoint admins

Site access review for DAG reports

Get-SPODataAccessGovernanceInsight

Export-SPODataAccessGovernanceInsight

Remove-SPODataAccessGovernanceInsight

Start-SPOSiteReview

Get-SPOSiteReview