Skip to content

Commit 8856e1d

Browse files
ishwaritishwarit
committed
SPORestrictedAccessForSitesInsights cmdlet documentation
1 parent 461afa1 commit 8856e1d

File tree

2 files changed

+363
-0
lines changed

2 files changed

+363
-0
lines changed

‎sharepoint/sharepoint-ps/sharepoint-online/Get-SPORestrictedAccessForSitesInsights‎

Lines changed: 244 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,244 @@
1+
---
2+
external help file: sharepointonline.xml
3+
Module Name: Microsoft.Online.SharePoint.PowerShell
4+
online version: https://learn.microsoft.com/powershell/module/sharepoint-online/get-sporestrictedaccessforsitesinsights
5+
applicable: SharePoint Online
6+
title: Get-SPORestrictedAccessForSitesInsights
7+
schema: 2.0.0
8+
author: itambakhe
9+
ms.author: itambakhe
10+
ms.reviewer:
11+
manager:
12+
---
13+
14+
# Get-SPORestrictedAccessForSitesInsights
15+
16+
## SYNOPSIS
17+
18+
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 policy when no report ID is present and to view or download the report if report ID is present.
19+
20+
## SYNTAX
21+
22+
```powershell
23+
Get-SPORestrictedAccessForSitesInsights -RACProtectedSites [-ReportId <Guid>] [-Action <ActionType>] [-InsightsSummary <Boolean>]
24+
```
25+
26+
```powershell
27+
Get-SPORestrictedAccessForSitesInsights -ActionsBlockedByPolicy [-ReportId <Guid>] [-Content <ContentType>] [-Action <ActionType>]
28+
```
29+
30+
## DESCRIPTION
31+
32+
If this cmdlet is executed with `-RACProtectedSites` as parameter, it displays the status of all active and completed reports with the following properties:
33+
34+
| Property | Description |
35+
|:---------------------|:------------------------------------------------------------|
36+
| Id | The unique Id of the report. |
37+
| CreatedDateTimeInUtc | The date and time the report creation was triggered in UTC. |
38+
| Status | The status of the report. |
39+
40+
If this cmdlet is executed with `-RACProtectedSites` `-ReportId` as parameter, top 100 sites with highest page views that are protected by Restrcited access control will be displayed with the following properties:
41+
42+
| Property | Description |
43+
|:-----------------------------|:--------------------------------------------------------------|
44+
| SiteName | The name of the SharePoint site. |
45+
| SiteType | The type of the SharePoint site. |
46+
| SiteURL | The URL of the SharePoint site. |
47+
| SiteSensitivity | The sensitivity label of the SharePoint site. |
48+
| PrimaryAdmin | Primary admin of the SharePoint Site |
49+
| BlockDownloadPolicy | Boolean status of Block download policy on the site. |
50+
| ConditionalAccessPolicy | Authentication context set for the Conditional access policy |
51+
| RestrictedAccessControlGroups| Entra Groups configured during policy configuration |
52+
53+
If this cmdlet is executed with `-RACProtectedSites` `-ReportId` `-InsightsSummary` as parameter, count of sites protected with restricted access control compared to total number of sites will be displayed.
54+
55+
If this cmdlet is executed with `-ActionsBlockedByPolicy` as parameter, it displays the status of all active and completed reports with the following properties:
56+
57+
| Property | Description |
58+
|:---------------------|:------------------------------------------------------------|
59+
| Id | The unique Id of the report. |
60+
| CreatedDateTimeInUtc | The date and time the report creation was triggered in UTC. |
61+
| Status | The status of the report. |
62+
63+
If this cmdlet is executed with `-ActionsBlockedByPolicy` `-ReportId` `-Content TopSites` as parameter, top 100 sites with highest access denials by Restrcited access control will be displayed with the following properties:
64+
65+
| Property | Description |
66+
|:-----------------------------|:--------------------------------------------------------------|
67+
| SiteName | The name of the SharePoint site. |
68+
| SiteURL | The URL of the SharePoint site. |
69+
| SiteSensitivity | The sensitivity label of the SharePoint site. |
70+
| SiteType | The type of the SharePoint site. |
71+
| AccessDenialsCount | Total number of access denials on the site. |
72+
| UniqueUsersBlocked | Count of Unique users denied access on the site. |
73+
74+
If this cmdlet is executed with `-ActionsBlockedByPolicy` `-ReportId` `-Content TopUsers` as parameter, top 10 users with highest access denials by Restrcited access control will be displayed with the following properties:
75+
76+
| Property | Description |
77+
|:-----------------------------|:--------------------------------------------------------------|
78+
| UserEmail | Email id of the blocked user. |
79+
| AccessDenailsCount | Total number of access denials faced by the user. |
80+
81+
If this cmdlet is executed with `-ActionsBlockedByPolicy` `-ReportId` `-Content AllDenials` as parameter, most recent 100 access denials by Restrcited access control in the last 28 days will be displayed with the following properties:
82+
83+
| Property | Description |
84+
|:-----------------------------|:--------------------------------------------------------------|
85+
| AccessDenialDateTimeInUtc | The timestamp of access denial. |
86+
| SiteName | The name of the SharePoint site. |
87+
| SiteURL | The URL of the SharePoint site. |
88+
| SiteType | The type of the SharePoint site. |
89+
| SiteOwnerName | Primary Owner of the SharePoint site. |
90+
| UserEmail | Email ID of the denied user. |
91+
| RestrictedAccessControlGroups| Entra Groups configured during policy configuration |
92+
| SiteSensitivity | The sensitivity label of the SharePoint site. |
93+
94+
If this cmdlet is executed with `-ActionsBlockedByPolicy` `-ReportId` `-Content SiteDistribution` as parameter, distribution of access denials by Restrcited access control on different site types will be displayed with the following properties:
95+
96+
| Property | Description |
97+
|:-----------------------------|:--------------------------------------------------------------|
98+
| SiteType | The type of the SharePoint site. |
99+
| AccessDenialsCount | Total number of access denials on the site type. |
100+
| UniqueUsersBlockedCount | Count of Unique users denied access on the site type. |
101+
| SiteTypePercentage | Relative percentage of access denials by the site type. |
102+
103+
> [!NOTE]
104+
> All reports adhere to any retention timeline as per [Data Access Governance](/sharepoint/data-access-governance-reports).
105+
106+
## EXAMPLES
107+
108+
### -----------------------EXAMPLE 1-----------------------------
109+
110+
```powershell
111+
Get-SPORestrictedAccessForSitesInsights -RACProtectedSites
112+
```
113+
114+
Example 1 enables administrator to view the status of all active and completed reports on list of sites protected with resticted access control policy.
115+
116+
### -----------------------EXAMPLE 2-----------------------------
117+
118+
```powershell
119+
Get-SPORestrictedAccessForSitesInsights –RACProtectedSites -ReportId 9d946216-afe7-49f5-8267-7b662435c70b
120+
```
121+
122+
Example 2 enables administrator to view the list of sites protected with resticted access control policy report with ReportId: `9d946216-afe7-49f5-8267-7b662435c70b`
123+
124+
### -----------------------EXAMPLE 3-----------------------------
125+
126+
```powershell
127+
Get-SPORestrictedAccessForSitesInsights -ActionsBlockedByPolicy -ReportId 9d946216-afe7-49f5-8267-7b662435c70b -Content TopSites
128+
```
129+
130+
Example 3 enables administrator to view the top sites with access denials due to restriited access control policy report of ReportId: `9d946216-afe7-49f5-8267-7b662435c70b`.
131+
132+
## PARAMETERS
133+
134+
### -RACProtectedSites
135+
136+
It is an optional parameter, and it specifies the type of the report to be viewed or downloaded.
137+
138+
```yaml
139+
Type: SwitchParameter
140+
Parameter Sets: (All)
141+
Aliases:
142+
Applicable: SharePoint Online
143+
144+
Required: False
145+
Position: Named
146+
Default value: None
147+
Accept pipeline input: False
148+
Accept wildcard characters: False
149+
```
150+
151+
### -ActionsBlockedByPolicy
152+
153+
It is an optional parameter, and it specifies the type of the report to be viewed or downloaded.
154+
155+
```yaml
156+
Type: SwitchParameter
157+
Parameter Sets: (All)
158+
Aliases:
159+
Applicable: SharePoint Online
160+
161+
Required: False
162+
Position: Named
163+
Default value: None
164+
Accept pipeline input: False
165+
Accept wildcard characters: False
166+
```
167+
168+
### -ReportId
169+
170+
It is an optional parameter, and it specifies the unique Id of the report to be viewed or downloaded.
171+
172+
```yaml
173+
Type: Guid
174+
Parameter Sets: (All)
175+
Aliases:
176+
Applicable: SharePoint Online
177+
178+
Required: False
179+
Position: Named
180+
Default value: None
181+
Accept pipeline input: False
182+
Accept wildcard characters: False
183+
```
184+
185+
### -InsightsSummary
186+
187+
It is an optional parameter, and it specifies the subtype of the report to be viewed or downloaded.
188+
189+
```yaml
190+
Type: Bool
191+
Parameter Sets: (All)
192+
Aliases:
193+
Applicable: SharePoint Online
194+
195+
Required: False
196+
Position: Named
197+
Default value: True
198+
Accept pipeline input: False
199+
Accept wildcard characters: False
200+
```
201+
202+
### -Content
203+
204+
It is an optional parameter, and it specifies the sub-type of the report to be viewed or downloaded.
205+
206+
```yaml
207+
Type: ContentType
208+
Parameter Sets: (All)
209+
Aliases:
210+
Applicable: SharePoint Online
211+
212+
Required: False
213+
Position: Named
214+
Default value: None
215+
Accept pipeline input: False
216+
Accept wildcard characters: False
217+
```
218+
219+
### -Action
220+
221+
It is an optional parameter, and it specifies whether to view or download a specific report.
222+
223+
```yaml
224+
Type: ActionType
225+
Parameter Sets: (All)
226+
Aliases:
227+
Applicable: SharePoint Online
228+
229+
Required: False
230+
Position: Named
231+
Default value: None
232+
Accept pipeline input: False
233+
Accept wildcard characters: False
234+
```
235+
236+
### CommonParameters
237+
238+
This cmdlet supports the common parameters: `-Debug`, `-ErrorAction`, `-ErrorVariable`, `-InformationAction`, `-InformationVariable`, `-OutVariable`, `-OutBuffer`, `-PipelineVariable`, `-Verbose`, `-WarningAction`, and `-WarningVariable`. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/?LinkID=113216).
239+
240+
## RELATED LINKS
241+
242+
[Getting started with SharePoint Online Management Shell](/powershell/sharepoint/sharepoint-online/connect-sharepoint-online)
243+
244+
[Start-SPORestrictedAccessForSitesInsights](./Start-SPORestrictedAccessForSitesInsights.md)

‎sharepoint/sharepoint-ps/sharepoint-online/Start-SPORestrictedAccessForSitesInsights‎

Lines changed: 119 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,119 @@
1+
---
2+
external help file: sharepointonline.xml
3+
Module Name: Microsoft.Online.SharePoint.PowerShell
4+
online version: https://learn.microsoft.com/powershell/module/sharepoint-online/start-sporestrictedaccessforsitesinsights
5+
applicable: SharePoint Online
6+
title: Start-SPORestrictedAccessForSitesInsights
7+
schema: 2.0.0
8+
author: itambakhe
9+
ms.author: itambakhe
10+
ms.reviewer:
11+
manager:
12+
---
13+
14+
# Start-SPORestrictedAccessForSitesInsights
15+
16+
## SYNOPSIS
17+
18+
This cmdlet enables administrator to trigger the build of a new Restricted Access Control insights report for the data from last 28 days.
19+
20+
## SYNTAX
21+
22+
```powershell
23+
Start-SPORestrictedAccessForSitesInsights -RACProtectedSites [-Force <SwitchParameter>]
24+
```
25+
26+
```powershell
27+
Start-SPORestrictedAccessForSitesInsights -ActionsBlockedByPolicy [-Force <SwitchParameter>]
28+
```
29+
30+
## DESCRIPTION
31+
32+
After this cmdlet is executed, the Restricted Access Control insights report generation request for the requested sub type gets queued in the pipeline and the below metadata is displayed with the following properties:
33+
34+
| Property | Description |
35+
|:---------------------|:------------------------------------------------------------|
36+
| Id | The unique Id of the report. |
37+
| CreatedDateTimeInUtc | The date and time the report creation was triggered in UTC. |
38+
| Status | The status of the report. |
39+
40+
## EXAMPLES
41+
42+
### -----------------------EXAMPLE 1-----------------------------
43+
44+
```powershell
45+
Start-SPORestrictedAccessForSitesInsights -RACProtectedSites
46+
```
47+
48+
Example 1 generates the Restricted access control policy report which contains insights about the list of sites protected with the policy.
49+
50+
### -----------------------EXAMPLE 2-----------------------------
51+
52+
```powershell
53+
Start-SPORestrictedAccessForSitesInsights -ActionsBlockedByPolicy
54+
```
55+
56+
Example 2 generates the Restricted access control policy report which contains insights about access denails by the policy.
57+
58+
## PARAMETERS
59+
60+
### -RACProtectedSites
61+
62+
It is an optional parameter, and it specifies the type of the report generation to be triggered.
63+
64+
```yaml
65+
Type: SwitchParameter
66+
Parameter Sets: (All)
67+
Aliases:
68+
Applicable: SharePoint Online
69+
70+
Required: False
71+
Position: Named
72+
Default value: None
73+
Accept pipeline input: False
74+
Accept wildcard characters: False
75+
```
76+
77+
### -ActionsBlockedByPolicy
78+
79+
It is an optional parameter, and it specifies the type of the report generation to be triggered.
80+
81+
```yaml
82+
Type: SwitchParameter
83+
Parameter Sets: (All)
84+
Aliases:
85+
Applicable: SharePoint Online
86+
87+
Required: False
88+
Position: Named
89+
Default value: None
90+
Accept pipeline input: False
91+
Accept wildcard characters: False
92+
```
93+
94+
### -Force
95+
96+
It is an optional parameter which is used to bypass confirmation prompts and execute the command without interruptions.
97+
98+
```yaml
99+
Type: SwitchParameter
100+
Parameter Sets: (All)
101+
Aliases:
102+
Applicable: SharePoint Online
103+
104+
Required: False
105+
Position: Named
106+
Default value: None
107+
Accept pipeline input: False
108+
Accept wildcard characters: False
109+
```
110+
111+
### CommonParameters
112+
113+
This cmdlet supports the common parameters: `-Debug`, `-ErrorAction`, `-ErrorVariable`, `-InformationAction`, `-InformationVariable`, `-OutVariable`, `-OutBuffer`, `-PipelineVariable`, `-Verbose`, `-WarningAction`, and `-WarningVariable`. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/?LinkID=113216).
114+
115+
## Related Links
116+
117+
[Getting started with SharePoint Online Management Shell](/powershell/sharepoint/sharepoint-online/connect-sharepoint-online)
118+
119+
[Get-SPORestrictedAccessForSitesInsights](./Get-SPORestrictedAccessForSitesInsights.md)

0 commit comments

Comments
 (0)