Skip to content

Commit 06f4544

Browse files
pvrkpvrk
committed
Documentation about 2 existing commands
1 parent f3cc38e commit 06f4544

File tree

2 files changed

+270
-0
lines changed

2 files changed

+270
-0
lines changed

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

Lines changed: 163 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,163 @@
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-spoinformationbarriersinsightsreport
5+
applicable: SharePoint Online
6+
title: Get-SPOInformationBarriersInsightsReport
7+
schema: 2.0.0
8+
author: pvrk
9+
ms.author: pullabhk
10+
manager:
11+
ms.reviewer:
12+
---
13+
14+
# Get-SPOInformationBarriersInsightsReport
15+
16+
## SYNOPSIS
17+
18+
This cmdlet helps to view the status of the insights on Information Barrier (IB).
19+
20+
## SYNTAX
21+
22+
```powershell
23+
Get-SPOInformationBarriersInsightsReport [-ReportId <Guid>] [-Section <SectionType>] [-Action <ActionType>] [-Service <ServiceType>] [-FullDetails] [<CommonParameters>]
24+
```
25+
26+
## DESCRIPTION
27+
28+
This cmdlet helps to view the details of the specific parameters from the insights report.
29+
30+
## EXAMPLES
31+
32+
### Example 1
33+
34+
```powershell
35+
PS C:\> Get-SPOInformationBarriersInsightsReport -reportId ec65a1cf-9b1a-48c2-a1b4-f923ac4c0776
36+
37+
Content: Explicit, Implicit, Open, OwnerModerated, ModeDistribution
38+
State: Completed
39+
Id: ec65a1cf-9b1a-48c2-a1b4-f923ac4c0776
40+
StartTimeInUtc: 4/25/2023 4:10:16 PM
41+
CompleteTimeInUtc: 4/25/2023 4:10:25 PM
42+
QueuedTimeInUtc: 4/25/2023 4:06:47 PM
43+
```
44+
45+
In the above example, the insights report results are displayed for SharePoint sites included in the organization with an ID of ec65a1cf-9b1a-48c2-a1b4-f923ac4c0776. The values in the Content line represent the modes that have results in the report. If a mode (applicable to SharePoint) isn't listed, there aren't any SharePoint sites in the organization with that mode.
46+
47+
### Example 2
48+
49+
```powershell
50+
PS C:\> Get-SPOInformationBarriersInsightsReport -reportId ec65a1cf-9b1a-48c2-a1b4-f923ac4c0776 -service OneDrive
51+
52+
Content: Explicit, Mixed, Open, OwnerModerated, ModeDistribution
53+
State: Completed
54+
Id: ec65a1cf-9b1a-48c2-a1b4-f923ac4c0776
55+
StartTimeInUtc: 4/25/2023 4:10:16 PM
56+
CompleteTimeInUtc: 4/25/2023 4:10:25 PM
57+
QueuedTimeInUtc: 4/25/2023 4:06:47 PM
58+
```
59+
60+
The above cmdlet helps to view summary of the modes with results for OneDrive sites from the generated report ID. In the above example, the insights report results are displayed for OneDrive accounts included in the organization with an ID of ec65a1cf-9b1a-48c2-a1b4-f923ac4c0776. The values in the Content line represent the modes that have results in the report. If a mode (applicable to OneDrive) isn't listed, there aren't any OneDrive accounts in the organization with that mode.
61+
62+
## PARAMETERS
63+
64+
### -Action
65+
66+
This parameter helps to view or download the results of the insights report.
67+
68+
```yaml
69+
Type: ActionType
70+
Parameter Sets: (All)
71+
Aliases:
72+
Accepted values: View, Download
73+
74+
Required: False
75+
Position: Named
76+
Default value: None
77+
Accept pipeline input: False
78+
Accept wildcard characters: False
79+
```
80+
81+
### -FullDetails
82+
83+
It is an optional parameter and allows to download a CSV file containing up to 1 million records.
84+
85+
```yaml
86+
Type: SwitchParameter
87+
Parameter Sets: (All)
88+
Aliases:
89+
90+
Required: False
91+
Position: Named
92+
Default value: None
93+
Accept pipeline input: False
94+
Accept wildcard characters: False
95+
```
96+
97+
### -ReportId
98+
99+
It specifies the unique Id of the report to be viewed or downloaded.
100+
101+
```yaml
102+
Type: Guid
103+
Parameter Sets: (All)
104+
Aliases:
105+
106+
Required: False
107+
Position: Named
108+
Default value: None
109+
Accept pipeline input: False
110+
Accept wildcard characters: False
111+
```
112+
113+
### -Section
114+
115+
This parameters helps to view the details of the specified mode.
116+
117+
```yaml
118+
Type: SectionType
119+
Parameter Sets: (All)
120+
Aliases:
121+
Accepted values: Explicit, Implicit, Open, OwnerModerated, ModeDistribution, Mixed
122+
123+
Required: False
124+
Position: Named
125+
Default value: None
126+
Accept pipeline input: False
127+
Accept wildcard characters: False
128+
```
129+
130+
### -Service
131+
132+
This parameter helps to identify the type of service to view the summary of the insight report of that specified service.
133+
134+
```yaml
135+
Type: ServiceType
136+
Parameter Sets: (All)
137+
Aliases:
138+
Accepted values: OneDrive, SharePoint
139+
140+
Required: False
141+
Position: Named
142+
Default value: None
143+
Accept pipeline input: False
144+
Accept wildcard characters: False
145+
```
146+
147+
### CommonParameters
148+
149+
This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216).
150+
151+
## INPUTS
152+
153+
### None
154+
155+
## OUTPUTS
156+
157+
### System.Object
158+
159+
## NOTES
160+
161+
## RELATED LINKS
162+
163+
[Start-SPOInformationBarriersInsightsReport](./Start-SPOInformationBarriersInsightsReport.md)

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

Lines changed: 107 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,107 @@
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-spoinformationbarriersinsightsreport
5+
applicable: SharePoint Online
6+
title: Start-SPOInformationBarriersInsightsReport
7+
schema: 2.0.0
8+
author: pvrk
9+
ms.author: pullabhk
10+
manager:
11+
ms.reviewer:
12+
---
13+
14+
# Start-SPOInformationBarriersInsightsReport
15+
16+
## SYNOPSIS
17+
18+
This cmdlet generates reports in information barriers (IB) meant to identify and discover usage patterns across SharePoint sites and OneDrive accounts in the organization.
19+
20+
## SYNTAX
21+
22+
```powershell
23+
Start-SPOInformationBarriersInsightsReport [-Yes <Boolean>] [-WhatIf] [-Confirm] [<CommonParameters>]
24+
```
25+
26+
## DESCRIPTION
27+
28+
This cmdlet would create reports in Information Barriers (IB) to identify top sites and their modes to help apply suitable controls for the sites as applicable.
29+
30+
## EXAMPLES
31+
32+
### Example 1
33+
34+
```powershell
35+
PS C:\> Start-SPOInformationBarriersInsightsReport
36+
```
37+
38+
This PS command would create Information Barriers reports to identify top sites and their modes to help apply suitable controls for the sites as applicable.
39+
40+
## PARAMETERS
41+
42+
### -Yes
43+
44+
This boolean parameter will start generating the IB report.
45+
46+
```yaml
47+
Type: Boolean
48+
Parameter Sets: (All)
49+
Aliases:
50+
51+
Required: False
52+
Position: Named
53+
Default value: None
54+
Accept pipeline input: False
55+
Accept wildcard characters: False
56+
```
57+
58+
### -Confirm
59+
60+
Prompts you for confirmation before running the cmdlet.
61+
62+
```yaml
63+
Type: SwitchParameter
64+
Parameter Sets: (All)
65+
Aliases: cf
66+
67+
Required: False
68+
Position: Named
69+
Default value: None
70+
Accept pipeline input: False
71+
Accept wildcard characters: False
72+
```
73+
74+
### -WhatIf
75+
76+
Shows what would happen if the cmdlet runs.
77+
The cmdlet is not run.
78+
79+
```yaml
80+
Type: SwitchParameter
81+
Parameter Sets: (All)
82+
Aliases: wi
83+
84+
Required: False
85+
Position: Named
86+
Default value: None
87+
Accept pipeline input: False
88+
Accept wildcard characters: False
89+
```
90+
91+
### CommonParameters
92+
93+
This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216).
94+
95+
## INPUTS
96+
97+
### None
98+
99+
## OUTPUTS
100+
101+
### System.Object
102+
103+
## NOTES
104+
105+
## RELATED LINKS
106+
107+
[Get-SPOInformationBarriersInsightsReport](./Get-SPOInformationBarriersInsightsReport.md)

0 commit comments

Comments
 (0)