From 06f45440b6bb69d9f4037485484573582dde4f6d Mon Sep 17 00:00:00 2001 From: Kartik P V R Date: Tue, 10 Jun 2025 20:10:46 +0530 Subject: [PATCH 1/4] Documentation about 2 existing commands --- ...et-SPOInformationBarriersInsightsReport.md | 163 ++++++++++++++++++ ...rt-SPOInformationBarriersInsightsReport.md | 107 ++++++++++++ 2 files changed, 270 insertions(+) create mode 100644 sharepoint/sharepoint-ps/sharepoint-online/Get-SPOInformationBarriersInsightsReport.md create mode 100644 sharepoint/sharepoint-ps/sharepoint-online/Start-SPOInformationBarriersInsightsReport.md diff --git a/sharepoint/sharepoint-ps/sharepoint-online/Get-SPOInformationBarriersInsightsReport.md b/sharepoint/sharepoint-ps/sharepoint-online/Get-SPOInformationBarriersInsightsReport.md new file mode 100644 index 000000000..fdb1f6fa7 --- /dev/null +++ b/sharepoint/sharepoint-ps/sharepoint-online/Get-SPOInformationBarriersInsightsReport.md @@ -0,0 +1,163 @@ +--- +external help file: sharepointonline.xml +Module Name: Microsoft.Online.SharePoint.PowerShell +online version: https://learn.microsoft.com/powershell/module/sharepoint-online/get-spoinformationbarriersinsightsreport +applicable: SharePoint Online +title: Get-SPOInformationBarriersInsightsReport +schema: 2.0.0 +author: pvrk +ms.author: pullabhk +manager: +ms.reviewer: +--- + +# Get-SPOInformationBarriersInsightsReport + +## SYNOPSIS + +This cmdlet helps to view the status of the insights on Information Barrier (IB). + +## SYNTAX + +```powershell +Get-SPOInformationBarriersInsightsReport [-ReportId ] [-Section ] [-Action ] [-Service ] [-FullDetails] [] +``` + +## DESCRIPTION + +This cmdlet helps to view the details of the specific parameters from the insights report. + +## EXAMPLES + +### Example 1 + +```powershell +PS C:\> Get-SPOInformationBarriersInsightsReport -reportId ec65a1cf-9b1a-48c2-a1b4-f923ac4c0776 + +Content: Explicit, Implicit, Open, OwnerModerated, ModeDistribution +State: Completed +Id: ec65a1cf-9b1a-48c2-a1b4-f923ac4c0776 +StartTimeInUtc: 4/25/2023 4:10:16 PM +CompleteTimeInUtc: 4/25/2023 4:10:25 PM +QueuedTimeInUtc: 4/25/2023 4:06:47 PM +``` + +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. + +### Example 2 + +```powershell +PS C:\> Get-SPOInformationBarriersInsightsReport -reportId ec65a1cf-9b1a-48c2-a1b4-f923ac4c0776 -service OneDrive + +Content: Explicit, Mixed, Open, OwnerModerated, ModeDistribution +State: Completed +Id: ec65a1cf-9b1a-48c2-a1b4-f923ac4c0776 +StartTimeInUtc: 4/25/2023 4:10:16 PM +CompleteTimeInUtc: 4/25/2023 4:10:25 PM +QueuedTimeInUtc: 4/25/2023 4:06:47 PM +``` + +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. + +## PARAMETERS + +### -Action + +This parameter helps to view or download the results of the insights report. + +```yaml +Type: ActionType +Parameter Sets: (All) +Aliases: +Accepted values: View, Download + +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. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ReportId + +It specifies the unique Id of the report to be viewed or downloaded. + +```yaml +Type: Guid +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Section + +This parameters helps to view the details of the specified mode. + +```yaml +Type: SectionType +Parameter Sets: (All) +Aliases: +Accepted values: Explicit, Implicit, Open, OwnerModerated, ModeDistribution, Mixed + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Service + +This parameter helps to identify the type of service to view the summary of the insight report of that specified service. + +```yaml +Type: ServiceType +Parameter Sets: (All) +Aliases: +Accepted values: OneDrive, SharePoint + +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](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### None + +## OUTPUTS + +### System.Object + +## NOTES + +## RELATED LINKS + +[Start-SPOInformationBarriersInsightsReport](./Start-SPOInformationBarriersInsightsReport.md) diff --git a/sharepoint/sharepoint-ps/sharepoint-online/Start-SPOInformationBarriersInsightsReport.md b/sharepoint/sharepoint-ps/sharepoint-online/Start-SPOInformationBarriersInsightsReport.md new file mode 100644 index 000000000..a016e093c --- /dev/null +++ b/sharepoint/sharepoint-ps/sharepoint-online/Start-SPOInformationBarriersInsightsReport.md @@ -0,0 +1,107 @@ +--- +external help file: sharepointonline.xml +Module Name: Microsoft.Online.SharePoint.PowerShell +online version: https://learn.microsoft.com/powershell/module/sharepoint-online/start-spoinformationbarriersinsightsreport +applicable: SharePoint Online +title: Start-SPOInformationBarriersInsightsReport +schema: 2.0.0 +author: pvrk +ms.author: pullabhk +manager: +ms.reviewer: +--- + +# Start-SPOInformationBarriersInsightsReport + +## SYNOPSIS + +This cmdlet generates reports in information barriers (IB) meant to identify and discover usage patterns across SharePoint sites and OneDrive accounts in the organization. + +## SYNTAX + +```powershell +Start-SPOInformationBarriersInsightsReport [-Yes ] [-WhatIf] [-Confirm] [] +``` + +## DESCRIPTION + +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. + +## EXAMPLES + +### Example 1 + +```powershell +PS C:\> Start-SPOInformationBarriersInsightsReport +``` + +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. + +## PARAMETERS + +### -Yes + +This boolean parameter will start generating the IB report. + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm + +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf + +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: wi + +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](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### None + +## OUTPUTS + +### System.Object + +## NOTES + +## RELATED LINKS + +[Get-SPOInformationBarriersInsightsReport](./Get-SPOInformationBarriersInsightsReport.md) From f261f86066956fc877da4ceac5f110a0d11715d2 Mon Sep 17 00:00:00 2001 From: Kartik P V R Date: Fri, 13 Jun 2025 16:11:57 +0530 Subject: [PATCH 2/4] Resolving comments --- ...et-SPOInformationBarriersInsightsReport.md | 35 ++++++++----------- ...rt-SPOInformationBarriersInsightsReport.md | 8 ++--- 2 files changed, 19 insertions(+), 24 deletions(-) diff --git a/sharepoint/sharepoint-ps/sharepoint-online/Get-SPOInformationBarriersInsightsReport.md b/sharepoint/sharepoint-ps/sharepoint-online/Get-SPOInformationBarriersInsightsReport.md index fdb1f6fa7..89a31fcd2 100644 --- a/sharepoint/sharepoint-ps/sharepoint-online/Get-SPOInformationBarriersInsightsReport.md +++ b/sharepoint/sharepoint-ps/sharepoint-online/Get-SPOInformationBarriersInsightsReport.md @@ -15,7 +15,7 @@ ms.reviewer: ## SYNOPSIS -This cmdlet helps to view the status of the insights on Information Barrier (IB). +Rnables the SharePoint administrator to check status of all active and completed reports of insights on Information Barriers (IB). ## SYNTAX @@ -25,36 +25,31 @@ Get-SPOInformationBarriersInsightsReport [-ReportId ] [-Section Get-SPOInformationBarriersInsightsReport -reportId ec65a1cf-9b1a-48c2-a1b4-f923ac4c0776 - -Content: Explicit, Implicit, Open, OwnerModerated, ModeDistribution -State: Completed -Id: ec65a1cf-9b1a-48c2-a1b4-f923ac4c0776 -StartTimeInUtc: 4/25/2023 4:10:16 PM -CompleteTimeInUtc: 4/25/2023 4:10:25 PM -QueuedTimeInUtc: 4/25/2023 4:06:47 PM +Get-SPOInformationBarriersInsightsReport -reportId ec65a1cf-9b1a-48c2-a1b4-f923ac4c0776 ``` -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. +In the above example, the insights report results are displayed for SharePoint sites included in the organization with given ID. ### Example 2 ```powershell -PS C:\> Get-SPOInformationBarriersInsightsReport -reportId ec65a1cf-9b1a-48c2-a1b4-f923ac4c0776 -service OneDrive - -Content: Explicit, Mixed, Open, OwnerModerated, ModeDistribution -State: Completed -Id: ec65a1cf-9b1a-48c2-a1b4-f923ac4c0776 -StartTimeInUtc: 4/25/2023 4:10:16 PM -CompleteTimeInUtc: 4/25/2023 4:10:25 PM -QueuedTimeInUtc: 4/25/2023 4:06:47 PM +Get-SPOInformationBarriersInsightsReport -reportId ec65a1cf-9b1a-48c2-a1b4-f923ac4c0776 -service OneDrive ``` 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. @@ -63,7 +58,7 @@ The above cmdlet helps to view summary of the modes with results for OneDrive si ### -Action -This parameter helps to view or download the results of the insights report. +It determines whether a report would be viewed or downloaded. If the value of -Action is set as View, it will display the output on the PowerShell screen. Else if the value of -Action is set as Download, it will download the full report in CSV format to the same path from where the command was run. ```yaml Type: ActionType diff --git a/sharepoint/sharepoint-ps/sharepoint-online/Start-SPOInformationBarriersInsightsReport.md b/sharepoint/sharepoint-ps/sharepoint-online/Start-SPOInformationBarriersInsightsReport.md index a016e093c..76ec5e553 100644 --- a/sharepoint/sharepoint-ps/sharepoint-online/Start-SPOInformationBarriersInsightsReport.md +++ b/sharepoint/sharepoint-ps/sharepoint-online/Start-SPOInformationBarriersInsightsReport.md @@ -15,7 +15,7 @@ ms.reviewer: ## SYNOPSIS -This cmdlet generates reports in information barriers (IB) meant to identify and discover usage patterns across SharePoint sites and OneDrive accounts in the organization. +Generates a new report to identify and discover the usage patterns of Information Barriers (IB) across SharePoint sites and OneDrive accounts in the organization. ## SYNTAX @@ -25,17 +25,17 @@ Start-SPOInformationBarriersInsightsReport [-Yes ] [-WhatIf] [-Confirm] ## DESCRIPTION -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. +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. ## EXAMPLES ### Example 1 ```powershell -PS C:\> Start-SPOInformationBarriersInsightsReport +Start-SPOInformationBarriersInsightsReport -Yes ``` -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. +This example generates IB reports without asking for further confirmation. ## PARAMETERS From e106446582eb36749228f480e268075ff9ff476d Mon Sep 17 00:00:00 2001 From: Kartik P V R Date: Mon, 16 Jun 2025 16:35:00 +0530 Subject: [PATCH 3/4] Updated as per comments --- .../Get-SPOInformationBarriersInsightsReport.md | 17 ++++++++++------- ...tart-SPOInformationBarriersInsightsReport.md | 4 ++-- 2 files changed, 12 insertions(+), 9 deletions(-) diff --git a/sharepoint/sharepoint-ps/sharepoint-online/Get-SPOInformationBarriersInsightsReport.md b/sharepoint/sharepoint-ps/sharepoint-online/Get-SPOInformationBarriersInsightsReport.md index 89a31fcd2..dac3c43cb 100644 --- a/sharepoint/sharepoint-ps/sharepoint-online/Get-SPOInformationBarriersInsightsReport.md +++ b/sharepoint/sharepoint-ps/sharepoint-online/Get-SPOInformationBarriersInsightsReport.md @@ -15,7 +15,7 @@ ms.reviewer: ## SYNOPSIS -Rnables the SharePoint administrator to check status of all active and completed reports of insights on Information Barriers (IB). +Enables the SharePoint Administrator to check status of all active and completed reports of insights on Information Barriers (IB). ## SYNTAX @@ -29,7 +29,7 @@ If this cmdlet is executed without any parameters, it displays the status of all |Property |Description | |---------|---------| -|Content | Display the [modes of IB](/purview/information-barriers-insights-report) for sites present in the report. | +|Content | Display the [IB modes](/purview/information-barriers-insights-report) for sites present in the report. | |State | The status of the report. | |Id | The unique Id of the report. | |StartTimeInUtc | The date and time in UTC when the report creation was started. | @@ -41,7 +41,7 @@ If this cmdlet is executed without any parameters, it displays the status of all ### Example 1 ```powershell -Get-SPOInformationBarriersInsightsReport -reportId ec65a1cf-9b1a-48c2-a1b4-f923ac4c0776 +Get-SPOInformationBarriersInsightsReport -ReportId ec65a1cf-9b1a-48c2-a1b4-f923ac4c0776 ``` In the above example, the insights report results are displayed for SharePoint sites included in the organization with given ID. @@ -49,16 +49,19 @@ In the above example, the insights report results are displayed for SharePoint s ### Example 2 ```powershell -Get-SPOInformationBarriersInsightsReport -reportId ec65a1cf-9b1a-48c2-a1b4-f923ac4c0776 -service OneDrive +Get-SPOInformationBarriersInsightsReport -ReportId ec65a1cf-9b1a-48c2-a1b4-f923ac4c0776 -service OneDrive ``` -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. +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. ## PARAMETERS ### -Action -It determines whether a report would be viewed or downloaded. If the value of -Action is set as View, it will display the output on the PowerShell screen. Else if the value of -Action is set as Download, it will download the full report in CSV format to the same path from where the command was run. +Specifies whether the report is displayed in the console or downloaded as a file. + +- If set to `View`, the report is displayed directly in the PowerShell window. +- If set to `Download`, the report is saved as a CSV file in the directory where the command is run. ```yaml Type: ActionType @@ -141,7 +144,7 @@ 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](http://go.microsoft.com/fwlink/?LinkID=113216). +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). ## INPUTS diff --git a/sharepoint/sharepoint-ps/sharepoint-online/Start-SPOInformationBarriersInsightsReport.md b/sharepoint/sharepoint-ps/sharepoint-online/Start-SPOInformationBarriersInsightsReport.md index 76ec5e553..836e6e7c3 100644 --- a/sharepoint/sharepoint-ps/sharepoint-online/Start-SPOInformationBarriersInsightsReport.md +++ b/sharepoint/sharepoint-ps/sharepoint-online/Start-SPOInformationBarriersInsightsReport.md @@ -41,7 +41,7 @@ This example generates IB reports without asking for further confirmation. ### -Yes -This boolean parameter will start generating the IB report. +This parameter provides confirmation to generate the IB report. ```yaml Type: Boolean @@ -90,7 +90,7 @@ 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](http://go.microsoft.com/fwlink/?LinkID=113216). +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). ## INPUTS From ae5726428e1379f7fb7d6565de05d325662710d2 Mon Sep 17 00:00:00 2001 From: Ruchika Mittal Date: Mon, 16 Jun 2025 21:13:27 +0530 Subject: [PATCH 4/4] typo fix --- .../Get-SPOInformationBarriersInsightsReport.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/sharepoint/sharepoint-ps/sharepoint-online/Get-SPOInformationBarriersInsightsReport.md b/sharepoint/sharepoint-ps/sharepoint-online/Get-SPOInformationBarriersInsightsReport.md index dac3c43cb..2b155438d 100644 --- a/sharepoint/sharepoint-ps/sharepoint-online/Get-SPOInformationBarriersInsightsReport.md +++ b/sharepoint/sharepoint-ps/sharepoint-online/Get-SPOInformationBarriersInsightsReport.md @@ -34,7 +34,7 @@ If this cmdlet is executed without any parameters, it displays the status of all |Id | The unique Id of the report. | |StartTimeInUtc | The date and time in UTC when the report creation was started. | |CompleteTimeInUtc | The date and time in UTC when the report creation was completed. | -|QueuedTimeInUtc | TThe date and time in UTC when the report creation was triggered. | +|QueuedTimeInUtc | The date and time in UTC when the report creation was triggered. | ## EXAMPLES