Skip to content

Commit 74c3e91

Browse files
Ruchika-mittal01Ruchika-mittal01
authored
Merge pull request #913 from pvrk/pvrk-SharePointPS-Apr
Documentation about 2 existing commands
2 parents 6d065c1 + ae57264 commit 74c3e91

File tree

2 files changed

+268
-0
lines changed

2 files changed

+268
-0
lines changed

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

Lines changed: 161 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,161 @@
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+
Enables the SharePoint Administrator to check status of all active and completed reports of insights on Information Barriers (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+
If this cmdlet is executed without any parameters, it displays the status of all active and completed reports with the following properties:
29+
30+
|Property |Description |
31+
|---------|---------|
32+
|Content | Display the [IB modes](/purview/information-barriers-insights-report) for sites present in the report. |
33+
|State | The status of the report. |
34+
|Id | The unique Id of the report. |
35+
|StartTimeInUtc | The date and time in UTC when the report creation was started. |
36+
|CompleteTimeInUtc | The date and time in UTC when the report creation was completed. |
37+
|QueuedTimeInUtc | The date and time in UTC when the report creation was triggered. |
38+
39+
## EXAMPLES
40+
41+
### Example 1
42+
43+
```powershell
44+
Get-SPOInformationBarriersInsightsReport -ReportId ec65a1cf-9b1a-48c2-a1b4-f923ac4c0776
45+
```
46+
47+
In the above example, the insights report results are displayed for SharePoint sites included in the organization with given ID.
48+
49+
### Example 2
50+
51+
```powershell
52+
Get-SPOInformationBarriersInsightsReport -ReportId ec65a1cf-9b1a-48c2-a1b4-f923ac4c0776 -service OneDrive
53+
```
54+
55+
This example 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.
56+
57+
## PARAMETERS
58+
59+
### -Action
60+
61+
Specifies whether the report is displayed in the console or downloaded as a file.
62+
63+
- If set to `View`, the report is displayed directly in the PowerShell window.
64+
- If set to `Download`, the report is saved as a CSV file in the directory where the command is run.
65+
66+
```yaml
67+
Type: ActionType
68+
Parameter Sets: (All)
69+
Aliases:
70+
Accepted values: View, Download
71+
72+
Required: False
73+
Position: Named
74+
Default value: None
75+
Accept pipeline input: False
76+
Accept wildcard characters: False
77+
```
78+
79+
### -FullDetails
80+
81+
It is an optional parameter and allows to download a CSV file containing up to 1 million records.
82+
83+
```yaml
84+
Type: SwitchParameter
85+
Parameter Sets: (All)
86+
Aliases:
87+
88+
Required: False
89+
Position: Named
90+
Default value: None
91+
Accept pipeline input: False
92+
Accept wildcard characters: False
93+
```
94+
95+
### -ReportId
96+
97+
It specifies the unique Id of the report to be viewed or downloaded.
98+
99+
```yaml
100+
Type: Guid
101+
Parameter Sets: (All)
102+
Aliases:
103+
104+
Required: False
105+
Position: Named
106+
Default value: None
107+
Accept pipeline input: False
108+
Accept wildcard characters: False
109+
```
110+
111+
### -Section
112+
113+
This parameters helps to view the details of the specified mode.
114+
115+
```yaml
116+
Type: SectionType
117+
Parameter Sets: (All)
118+
Aliases:
119+
Accepted values: Explicit, Implicit, Open, OwnerModerated, ModeDistribution, Mixed
120+
121+
Required: False
122+
Position: Named
123+
Default value: None
124+
Accept pipeline input: False
125+
Accept wildcard characters: False
126+
```
127+
128+
### -Service
129+
130+
This parameter helps to identify the type of service to view the summary of the insight report of that specified service.
131+
132+
```yaml
133+
Type: ServiceType
134+
Parameter Sets: (All)
135+
Aliases:
136+
Accepted values: OneDrive, SharePoint
137+
138+
Required: False
139+
Position: Named
140+
Default value: None
141+
Accept pipeline input: False
142+
Accept wildcard characters: False
143+
```
144+
145+
### CommonParameters
146+
147+
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).
148+
149+
## INPUTS
150+
151+
### None
152+
153+
## OUTPUTS
154+
155+
### System.Object
156+
157+
## NOTES
158+
159+
## RELATED LINKS
160+
161+
[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+
Generates a new report to identify and discover the usage patterns of Information Barriers (IB) 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 creates reports to identify [top sites and their IB modes](/purview/information-barriers-insights-report) to help apply suitable controls for the sites as applicable.
29+
30+
## EXAMPLES
31+
32+
### Example 1
33+
34+
```powershell
35+
Start-SPOInformationBarriersInsightsReport -Yes
36+
```
37+
38+
This example generates IB reports without asking for further confirmation.
39+
40+
## PARAMETERS
41+
42+
### -Yes
43+
44+
This parameter provides confirmation to generate 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)