Skip to content

Latest commit

 

History

History
210 lines (146 loc) · 6.61 KB

File metadata and controls

210 lines (146 loc) · 6.61 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/get-sporestrictedaccessforsitesinsights
applicable SharePoint Online
title Get-SPORestrictedAccessForSitesInsights
schema 2.0.0
author ishwarit
ms.author itambakhe
ms.reviewer
manager

Get-SPORestrictedAccessForSitesInsights

SYNOPSIS

This cmdlet enables the administrator to check status of all active and available reports about insights on sites protected and access denials by restricted access control.

SYNTAX

Get-SPORestrictedAccessForSitesInsights [-RACProtectedSites] [-ActionsBlockedByPolicy] [-ReportId <Guid>]
 [-Action <ActionType>] [-InsightsSummary] [-FullDetails] [-Content <SPOActionsBlockedByRACPolicyInsightType>]
 [<CommonParameters>]

DESCRIPTION

If this cmdlet is executed with -RACProtectedSites as parameter, it displays the status of all the active and completed reports.

If this cmdlet is executed with -RACProtectedSites -ReportId as parameter, top 100 sites with the highest page views that are protected by restricted access control will be displayed.

If this cmdlet is executed with -RACProtectedSites -ReportId -FullDetails -Action Download, a CSV file containing list of up to 1 million sites protected by restricted access control will be downloaded.

If this cmdlet is executed with -RACProtectedSites -ReportId -InsightsSummary as parameter, the count of sites protected with restricted access control compared to total number of sites will be displayed.

If this cmdlet is executed with -ActionsBlockedByPolicy as parameter, it displays the status of all active and completed reports.

If this cmdlet is executed with -ActionsBlockedByPolicy -ReportId -Content TopSites as parameter, top 100 sites with the highest access denials by restricted access control will be displayed.

If this cmdlet is executed with -ActionsBlockedByPolicy -ReportId -Content TopUsers as parameter, top 10 users with the highest access denials by restricted access control will be displayed.

If this cmdlet is executed with -ActionsBlockedByPolicy -ReportId -Content AllDenials as parameter, most recent 100 access denials by restricted access control in the last 28 days will be displayed.

If this cmdlet is executed with -ActionsBlockedByPolicy -ReportId -Content SiteDistribution as parameter, distribution of access denials by restricted access control on different site types will be displayed.

Note

All reports adhere to any retention timeline as per Data Access Governance.

EXAMPLES

EXAMPLE 1

Get-SPORestrictedAccessForSitesInsights -RACProtectedSites

Example 1 enables administrator to view the status of all active and completed reports on list of sites protected with restricted access control.

EXAMPLE 2

Get-SPORestrictedAccessForSitesInsights –RACProtectedSites -ReportId 9d946216-afe7-49f5-8267-7b662435c70b

Example 2 enables administrator to view the report containing list of sites protected with restricted access control with ReportId: 9d946216-afe7-49f5-8267-7b662435c70b

EXAMPLE 3

Get-SPORestrictedAccessForSitesInsights -ActionsBlockedByPolicy -ReportId 9d946216-afe7-49f5-8267-7b662435c70b -Content TopSites

Example 3 enables administrator to view the report containing top sites with access denials due to restricted access control with ReportId: 9d946216-afe7-49f5-8267-7b662435c70b.

PARAMETERS

-Action

It is an optional parameter, and it specifies whether to view or download a specific report.

Type: Microsoft.Online.SharePoint.PowerShell.GetSPORestrictedAccessForSitesInsightsReport+ActionType
Parameter Sets: (All)
Aliases:
Accepted values: View, Download

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

-ActionsBlockedByPolicy

It is an optional parameter, and it specifies the type of report to be viewed or downloaded.

Type: System.Management.Automation.SwitchParameter
Parameter Sets: (All)
Aliases:

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

-Content

It is an optional parameter, and it specifies the subtype of the report to be viewed or downloaded.

Type: Microsoft.Online.SharePoint.PowerShell.SPOActionsBlockedByRACPolicyInsightType
Parameter Sets: (All)
Aliases:
Accepted values: AllDenials, TopSites, TopUsers, SiteDistribution

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

-FullDetails

It is an optional parameter and allows to download a CSV file containing up to 1 million records.

Type: System.Management.Automation.SwitchParameter
Parameter Sets: (All)
Aliases:

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

-InsightsSummary

It is an optional parameter, and it specifies the subtype of the report to be viewed or downloaded.

Type: System.Management.Automation.SwitchParameter
Parameter Sets: (All)
Aliases:

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

-RACProtectedSites

It is an optional parameter, and it specifies the type of report to be viewed or downloaded.

Type: System.Management.Automation.SwitchParameter
Parameter Sets: (All)
Aliases:

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

-ReportId

It is an optional parameter, and it specifies the unique Id of the report to be viewed or downloaded.

Type: System.Guid
Parameter Sets: (All)
Aliases:

Required: False
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

Getting started with SharePoint Online Management Shell

Start-SPORestrictedAccessForSitesInsights