Skip to content

Commit 4e4c330

Browse files
rjagiewichrjagiewich
authored
Merge pull request #715 from ishwarit/SharePoint-POwerShell-Working-branch
SPORestrictedAccessForSitesInsights cmdlet documentation
2 parents d0d807a + 2f8e450 commit 4e4c330

File tree

2 files changed

+302
-0
lines changed

2 files changed

+302
-0
lines changed

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

Lines changed: 189 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,189 @@
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: ishwarit
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.
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 the active and completed reports.
33+
34+
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.
35+
36+
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.
37+
38+
If this cmdlet is executed with `-ActionsBlockedByPolicy` as parameter, it displays the status of all active and completed reports.
39+
40+
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.
41+
42+
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.
43+
44+
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.
45+
46+
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.
47+
48+
> [!NOTE]
49+
> All reports adhere to any retention timeline as per [Data Access Governance](/sharepoint/data-access-governance-reports).
50+
51+
## EXAMPLES
52+
53+
### -----------------------EXAMPLE 1-----------------------------
54+
55+
```powershell
56+
Get-SPORestrictedAccessForSitesInsights -RACProtectedSites
57+
```
58+
59+
Example 1 enables administrator to view the status of all active and completed reports on list of sites protected with restricted access control.
60+
61+
### -----------------------EXAMPLE 2-----------------------------
62+
63+
```powershell
64+
Get-SPORestrictedAccessForSitesInsights –RACProtectedSites -ReportId 9d946216-afe7-49f5-8267-7b662435c70b
65+
```
66+
67+
Example 2 enables administrator to view the report containing list of sites protected with restricted access control with ReportId: `9d946216-afe7-49f5-8267-7b662435c70b`
68+
69+
### -----------------------EXAMPLE 3-----------------------------
70+
71+
```powershell
72+
Get-SPORestrictedAccessForSitesInsights -ActionsBlockedByPolicy -ReportId 9d946216-afe7-49f5-8267-7b662435c70b -Content TopSites
73+
```
74+
75+
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`.
76+
77+
## PARAMETERS
78+
79+
### -RACProtectedSites
80+
81+
It is an optional parameter, and it specifies the type of report to be viewed or downloaded.
82+
83+
```yaml
84+
Type: SwitchParameter
85+
Parameter Sets: (All)
86+
Aliases:
87+
Applicable: SharePoint Online
88+
89+
Required: False
90+
Position: Named
91+
Default value: None
92+
Accept pipeline input: False
93+
Accept wildcard characters: False
94+
```
95+
96+
### -ActionsBlockedByPolicy
97+
98+
It is an optional parameter, and it specifies the type of report to be viewed or downloaded.
99+
100+
```yaml
101+
Type: SwitchParameter
102+
Parameter Sets: (All)
103+
Aliases:
104+
Applicable: SharePoint Online
105+
106+
Required: False
107+
Position: Named
108+
Default value: None
109+
Accept pipeline input: False
110+
Accept wildcard characters: False
111+
```
112+
113+
### -ReportId
114+
115+
It is an optional parameter, and it specifies the unique Id of the report to be viewed or downloaded.
116+
117+
```yaml
118+
Type: Guid
119+
Parameter Sets: (All)
120+
Aliases:
121+
Applicable: SharePoint Online
122+
123+
Required: False
124+
Position: Named
125+
Default value: None
126+
Accept pipeline input: False
127+
Accept wildcard characters: False
128+
```
129+
130+
### -InsightsSummary
131+
132+
It is an optional parameter, and it specifies the subtype of the report to be viewed or downloaded.
133+
134+
```yaml
135+
Type: Bool
136+
Parameter Sets: (All)
137+
Aliases:
138+
Applicable: SharePoint Online
139+
140+
Required: False
141+
Position: Named
142+
Default value: True
143+
Accept pipeline input: False
144+
Accept wildcard characters: False
145+
```
146+
147+
### -Content
148+
149+
It is an optional parameter, and it specifies the subtype of the report to be viewed or downloaded.
150+
151+
```yaml
152+
Type: ContentType
153+
Parameter Sets: (All)
154+
Aliases:
155+
Applicable: SharePoint Online
156+
157+
Required: False
158+
Position: Named
159+
Default value: None
160+
Accept pipeline input: False
161+
Accept wildcard characters: False
162+
```
163+
164+
### -Action
165+
166+
It is an optional parameter, and it specifies whether to view or download a specific report.
167+
168+
```yaml
169+
Type: ActionType
170+
Parameter Sets: (All)
171+
Aliases:
172+
Applicable: SharePoint Online
173+
174+
Required: False
175+
Position: Named
176+
Default value: None
177+
Accept pipeline input: False
178+
Accept wildcard characters: False
179+
```
180+
181+
### CommonParameters
182+
183+
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).
184+
185+
## RELATED LINKS
186+
187+
[Getting started with SharePoint Online Management Shell](/powershell/sharepoint/sharepoint-online/connect-sharepoint-online)
188+
189+
[Start-SPORestrictedAccessForSitesInsights](./Start-SPORestrictedAccessForSitesInsights.md)

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

Lines changed: 113 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,113 @@
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: ishwarit
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 is initiated for the requested report subtype. |
33+
34+
## EXAMPLES
35+
36+
### -----------------------EXAMPLE 1-----------------------------
37+
38+
```powershell
39+
Start-SPORestrictedAccessForSitesInsights -RACProtectedSites
40+
```
41+
42+
Example 1 generates the restricted access control report which contains insights about the list of sites protected with the policy.
43+
44+
### -----------------------EXAMPLE 2-----------------------------
45+
46+
```powershell
47+
Start-SPORestrictedAccessForSitesInsights -ActionsBlockedByPolicy
48+
```
49+
50+
Example 2 generates the restricted access control report which contains insights about access denials by the policy.
51+
52+
## PARAMETERS
53+
54+
### -RACProtectedSites
55+
56+
It is an optional parameter, and it specifies the type of report generation to be triggered.
57+
58+
```yaml
59+
Type: SwitchParameter
60+
Parameter Sets: (All)
61+
Aliases:
62+
Applicable: SharePoint Online
63+
64+
Required: False
65+
Position: Named
66+
Default value: None
67+
Accept pipeline input: False
68+
Accept wildcard characters: False
69+
```
70+
71+
### -ActionsBlockedByPolicy
72+
73+
It is an optional parameter, and it specifies the type of report generation to be triggered.
74+
75+
```yaml
76+
Type: SwitchParameter
77+
Parameter Sets: (All)
78+
Aliases:
79+
Applicable: SharePoint Online
80+
81+
Required: False
82+
Position: Named
83+
Default value: None
84+
Accept pipeline input: False
85+
Accept wildcard characters: False
86+
```
87+
88+
### -Force
89+
90+
It is an optional parameter which is used to bypass confirmation prompts and execute the command without interruptions.
91+
92+
```yaml
93+
Type: SwitchParameter
94+
Parameter Sets: (All)
95+
Aliases:
96+
Applicable: SharePoint Online
97+
98+
Required: False
99+
Position: Named
100+
Default value: None
101+
Accept pipeline input: False
102+
Accept wildcard characters: False
103+
```
104+
105+
### CommonParameters
106+
107+
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).
108+
109+
## Related Links
110+
111+
[Getting started with SharePoint Online Management Shell](/powershell/sharepoint/sharepoint-online/connect-sharepoint-online)
112+
113+
[Get-SPORestrictedAccessForSitesInsights](./Get-SPORestrictedAccessForSitesInsights.md)

0 commit comments

Comments
 (0)