From 0ac3d6c3b0f19bc400274b15712cb143067a10d8 Mon Sep 17 00:00:00 2001 From: Kiran Muppana <291152376+srmuppana@users.noreply.github.com> Date: Thu, 24 Sep 2026 11:32:43 -0700 Subject: [PATCH] Add Information Barriers policy compliance cmdlet help docs (#1222) * Add Information Barriers policy compliance cmdlet help docs * Address cmdlet help review feedback Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com> Copilot-Session: 0e2137dc-af03-423f-87f0-42a0cc88106f --------- Co-authored-by: Kiran Muppana Co-authored-by: Shipra Choudhary Copilot-Session: 0e2137dc-af03-423f-87f0-42a0cc88106f --- ...formationBarriersPolicyComplianceReport.md | 93 ++++++++++++ .../Microsoft.Online.SharePoint.PowerShell.md | 6 + ...formationBarriersPolicyComplianceReport.md | 142 ++++++++++++++++++ 3 files changed, 241 insertions(+) create mode 100644 sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Get-SPOInformationBarriersPolicyComplianceReport.md create mode 100644 sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Start-SPOInformationBarriersPolicyComplianceReport.md diff --git a/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Get-SPOInformationBarriersPolicyComplianceReport.md b/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Get-SPOInformationBarriersPolicyComplianceReport.md new file mode 100644 index 000000000..6f75f95e3 --- /dev/null +++ b/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Get-SPOInformationBarriersPolicyComplianceReport.md @@ -0,0 +1,93 @@ +--- +external help file: Microsoft.Online.SharePoint.PowerShell.dll-Help.xml +Module Name: Microsoft.Online.SharePoint.PowerShell +online version: https://learn.microsoft.com/powershell/module/microsoft.online.sharepoint.powershell/get-spoinformationbarrierspolicycompliancereport +applicable: SharePoint Online +title: Get-SPOInformationBarriersPolicyComplianceReport +schema: 2.0.0 +author: srmuppana +ms.author: srmuppana +manager: dbolick +ms.reviewer: nibandyo +--- + +# Get-SPOInformationBarriersPolicyComplianceReport + +## SYNOPSIS + +Gets the status and results of Information Barriers policy compliance reports. + +## SYNTAX + +``` +Get-SPOInformationBarriersPolicyComplianceReport [-ReportID ] [] +``` + +## DESCRIPTION + +When you run this cmdlet without parameters, it returns the status and metadata of all Information Barriers policy compliance reports. + +When you specify `-ReportID`, the cmdlet returns the metadata and content of that report. The content identifies SharePoint sites, OneDrive accounts, and user-owned SharePoint Embedded containers that are noncompliant with current Information Barriers policies. + +## EXAMPLES + +### Example 1 + +```powershell +Get-SPOInformationBarriersPolicyComplianceReport +``` + +This example gets the status and metadata of all Information Barriers policy compliance reports. + +### Example 2 + +```powershell +Get-SPOInformationBarriersPolicyComplianceReport -ReportID beedfc3e-850c-4ca2-9ae0-7eacbe529d77 +``` + +This example gets the metadata and noncompliant content of the specified report. + +### Example 3 + +```powershell +$report = Get-SPOInformationBarriersPolicyComplianceReport -ReportID beedfc3e-850c-4ca2-9ae0-7eacbe529d77 +$report.Content +``` + +This example gets a specific report and displays the compliance details for each noncompliant SharePoint site, OneDrive account, or user-owned SharePoint Embedded container. + +## PARAMETERS + +### -ReportID + +Specifies the unique identifier of a report. If you don't specify this parameter, the cmdlet returns the status and metadata of all reports. + +```yaml +Type: System.Guid +Parameter Sets: (All) +Aliases: + +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`, `-ProgressAction`, `-Verbose`, `-WarningAction`, and `-WarningVariable`. For more information, see [about_CommonParameters](/powershell/module/microsoft.powershell.core/about/about_commonparameters). + +## INPUTS + +### None + +## OUTPUTS + +### System.Object + +## RELATED LINKS + +[Start-SPOInformationBarriersPolicyComplianceReport](./Start-SPOInformationBarriersPolicyComplianceReport.md) + +[Create an Information Barriers policy compliance report](/purview/information-barriers-sharepoint-report) diff --git a/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Microsoft.Online.SharePoint.PowerShell.md b/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Microsoft.Online.SharePoint.PowerShell.md index 947ad8d21..2a35cd2ab 100644 --- a/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Microsoft.Online.SharePoint.PowerShell.md +++ b/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Microsoft.Online.SharePoint.PowerShell.md @@ -254,6 +254,9 @@ Lists hub sites or hub site information. ### [Get-SPOInformationBarriersInsightsReport](Get-SPOInformationBarriersInsightsReport.md) Enables the SharePoint Administrator to check status of all active and completed reports of insights on Information Barriers (IB). +### [Get-SPOInformationBarriersPolicyComplianceReport](Get-SPOInformationBarriersPolicyComplianceReport.md) +Gets the status and results of Information Barriers policy compliance reports. + ### [Get-SPOListDesign](Get-SPOListDesign.md) Gets details about list designs that are on the SharePoint tenant. You can specify an ID of a specific list design to retrieve. If there are no parameters listed, details about all list designs are listed. @@ -887,6 +890,9 @@ This cmdlet enables administrator to trigger the build of a new enterprise appli ### [Start-SPOInformationBarriersInsightsReport](Start-SPOInformationBarriersInsightsReport.md) Generates a new report to identify and discover the usage patterns of Information Barriers (IB) across SharePoint sites and OneDrive accounts in the organization. +### [Start-SPOInformationBarriersPolicyComplianceReport](Start-SPOInformationBarriersPolicyComplianceReport.md) +Generates an Information Barriers policy compliance report for SharePoint sites, OneDrive accounts, and user-owned SharePoint Embedded containers in the organization. + ### [Start-SPOM365AgentAccessInsightsReport](Start-SPOM365AgentAccessInsightsReport.md) Using this cmdlet, administrators may trigger the build of a new Microsoft 365 agent insight report for the specified number of days. > [!NOTE] > The feature associated with this cmdlet will be rolling out soon. diff --git a/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Start-SPOInformationBarriersPolicyComplianceReport.md b/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Start-SPOInformationBarriersPolicyComplianceReport.md new file mode 100644 index 000000000..edef186ee --- /dev/null +++ b/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Start-SPOInformationBarriersPolicyComplianceReport.md @@ -0,0 +1,142 @@ +--- +external help file: Microsoft.Online.SharePoint.PowerShell.dll-Help.xml +Module Name: Microsoft.Online.SharePoint.PowerShell +online version: https://learn.microsoft.com/powershell/module/microsoft.online.sharepoint.powershell/start-spoinformationbarrierspolicycompliancereport +applicable: SharePoint Online +title: Start-SPOInformationBarriersPolicyComplianceReport +schema: 2.0.0 +author: srmuppana +ms.author: srmuppana +manager: dbolick +ms.reviewer: nibandyo +--- + +# Start-SPOInformationBarriersPolicyComplianceReport + +## SYNOPSIS + +Generates an Information Barriers policy compliance report for SharePoint sites, OneDrive accounts, and user-owned SharePoint Embedded containers in the organization. + +## SYNTAX + +``` +Start-SPOInformationBarriersPolicyComplianceReport [-UpdateOneDriveSegments] + [-UpdateUserOwnedContainerSegments] [-WhatIf] [-Confirm] [] +``` + +## DESCRIPTION + +This cmdlet generates an Information Barriers policy compliance report that identifies SharePoint sites, OneDrive accounts, and user-owned SharePoint Embedded containers that are noncompliant with current Information Barriers policies. + +Use the optional update parameters to automatically update segments for noncompliant OneDrive accounts or user-owned SharePoint Embedded containers while the report is being generated. Report generation can take a long time, depending on the number of sites, accounts, and containers in the organization. To check the report status, run `Get-SPOInformationBarriersPolicyComplianceReport` without any parameters. + +## EXAMPLES + +### Example 1 + +```powershell +Start-SPOInformationBarriersPolicyComplianceReport +``` + +This example generates an Information Barriers policy compliance report without automatically updating segments. + +### Example 2 + +```powershell +Start-SPOInformationBarriersPolicyComplianceReport -UpdateUserOwnedContainerSegments +``` + +This example generates the report and automatically updates segments for noncompliant user-owned SharePoint Embedded containers. + +### Example 3 + +```powershell +Start-SPOInformationBarriersPolicyComplianceReport -UpdateOneDriveSegments -UpdateUserOwnedContainerSegments +``` + +This example generates the report and automatically updates segments for noncompliant OneDrive accounts and user-owned SharePoint Embedded containers. + +## PARAMETERS + +### -UpdateOneDriveSegments + +Automatically updates segments for noncompliant OneDrive accounts during report generation. + +```yaml +Type: System.Management.Automation.SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -UpdateUserOwnedContainerSegments + +Automatically updates segments for noncompliant user-owned SharePoint Embedded containers during report generation. + +```yaml +Type: System.Management.Automation.SwitchParameter +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: System.Management.Automation.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: System.Management.Automation.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`, `-ProgressAction`, `-Verbose`, `-WarningAction`, and `-WarningVariable`. For more information, see [about_CommonParameters](/powershell/module/microsoft.powershell.core/about/about_commonparameters). + +## INPUTS + +### None + +## OUTPUTS + +### System.Object + +## RELATED LINKS + +[Get-SPOInformationBarriersPolicyComplianceReport](./Get-SPOInformationBarriersPolicyComplianceReport.md) + +[Create an Information Barriers policy compliance report](/purview/information-barriers-sharepoint-report)