Documentation about 2 existing commands by pvrk · Pull Request #913 · MicrosoftDocs/OfficeDocs-SharePoint-PowerShell

pvrk · 2025-06-10T14:41:24Z

No description provided.

learn-build-service-prod · 2025-06-10T14:43:02Z

Learn Build status updates of commit 06f4544:

✅ Validation status: passed

File	Status	Preview URL	Details
sharepoint/sharepoint-ps/sharepoint-online/Get-SPOInformationBarriersInsightsReport.md	✅Succeeded	View (sharepoint-ps)
sharepoint/sharepoint-ps/sharepoint-online/Start-SPOInformationBarriersInsightsReport.md	✅Succeeded	View (sharepoint-ps)

For more details, please refer to the build report.

samkabue · 2025-06-10T17:03:02Z

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

+### Example 1
+
+```powershell
+PS C:\> Get-SPOInformationBarriersInsightsReport -reportId ec65a1cf-9b1a-48c2-a1b4-f923ac4c0776


PS C:>

we don't include this "PS C:>"

here and elsewhere #Closed

applies to the other file as well

samkabue · 2025-06-10T17:03:18Z

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

+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


we don't include example output.

here and elsewhere #Closed

samkabue · 2025-06-10T17:04:31Z

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

+
+### 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, -ProgressAction, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters.

samkabue · 2025-06-10T17:12:02Z

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

+
+## 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.


reports in information barriers

I don't think wording "reports in information barriers" is clear

is it reports "about" information barriers? #Closed

samkabue · 2025-06-10T17:12:58Z

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

+
+## 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.


Information Barriers

use consistent casing throughout the docs -- is it uppercase "I" and "B" or lowercase? #Closed

and actually for this sentence and others coming after this you can just use "IB" since you already defined the acronym IB with the first reference line 18

samkabue · 2025-06-10T17:14:30Z

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

+
+## 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.


This cmdlet generates

"Generates..." (remove "This cmdlet...") #Closed

samkabue · 2025-06-10T17:16:13Z

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

+
+## 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.


would create

use simple present tense instead of conditional tense.

"would create" -> "creates"

other places too #Closed

samkabue · 2025-06-10T17:16:47Z

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

+
+## 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.


modes

what's a "mode"? could you link documentation for it as well? #Closed

samkabue · 2025-06-10T17:17:09Z

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

+### Example 1
+
+```powershell
+PS C:\> Start-SPOInformationBarriersInsightsReport


PS C:>

remove "PS :>" #Closed

samkabue · 2025-06-10T17:18:24Z

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

+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.


This PS command would create Information Barriers

"This cmdlet creates IB reports..." #Closed

samkabue · 2025-06-10T17:19:47Z

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

+
+## PARAMETERS
+
+### -Yes


-Yes

this is an awkwardly named parameter.

so someone uses it like

-Yes $true

or

-Yes $false

?

@pvrk given the updated description of this param, I think "-Yes" param can be removed from the backend code. Instead, add support for ShouldProcess -- this is an inbuilt PowerShell thing, when it's set, it requires user confirmation.

User can bypass confirmation by doing Confirm:$false

https://learn.microsoft.com/en-us/powershell/scripting/learn/deep-dives/everything-about-shouldprocess?view=powershell-5.1

note: this shouldn't block this PR, but should be a follow up fix for the backend PR then docs update

samkabue · 2025-06-10T17:20:23Z

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

+
+### -Yes
+
+This boolean parameter will start generating the IB report.


not clear what this means -- how can a parameter generate a report? #Closed

samkabue · 2025-06-10T17:21:07Z

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

+
+### 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, -ProgressAction, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters.

samkabue · 2025-06-10T17:22:26Z

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

+
+## SYNOPSIS
+
+This cmdlet helps to view the status of the insights on Information Barrier (IB).


this description could be improved. does it get "status" or actual reports? #Closed

samkabue · 2025-06-10T17:23:43Z

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

+
+## DESCRIPTION
+
+This cmdlet helps to view the details of the specific parameters from the insights report.


needs improvement. #Closed

samkabue · 2025-06-10T17:24:48Z

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

+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.


mode

see other file: mode should be documented somewhere #Closed

samkabue · 2025-06-10T17:25:18Z

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

+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.


The above cmdlet

"This example..." #Closed

learn-build-service-prod · 2025-06-13T10:44:09Z

Learn Build status updates of commit f261f86:

✅ Validation status: passed

File	Status	Preview URL	Details
sharepoint/sharepoint-ps/sharepoint-online/Get-SPOInformationBarriersInsightsReport.md	✅Succeeded	View (sharepoint-ps)
sharepoint/sharepoint-ps/sharepoint-online/Start-SPOInformationBarriersInsightsReport.md	✅Succeeded	View (sharepoint-ps)

For more details, please refer to the build report.

samkabue · 2025-06-13T16:58:21Z

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

+
+## SYNOPSIS
+
+Rnables the SharePoint administrator to check status of all active and completed reports of insights on Information Barriers (IB).


Rnables

typo - "Enables" #Closed

samkabue · 2025-06-13T16:58:50Z

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

+
+## SYNOPSIS
+
+Rnables the SharePoint administrator to check status of all active and completed reports of insights on Information Barriers (IB).


administrator

we use official Entra name for this, so uppercase "A" -- "Administrator" #Closed

samkabue · 2025-06-13T16:59:25Z

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

+
+|Property  |Description  |
+|---------|---------|
+|Content     | Display the [modes of IB](/purview/information-barriers-insights-report) for sites present in the report.      |


modes of IB

"IB modes" #Closed

samkabue · 2025-06-13T16:59:58Z

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

+### Example 1
+
+```powershell
+Get-SPOInformationBarriersInsightsReport -reportId ec65a1cf-9b1a-48c2-a1b4-f923ac4c0776


reportId

here and others: use right casing for the param.

ReportId #Closed

samkabue · 2025-06-13T17:03:27Z

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

+### -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.
+


could be improved further. Here's the suggestion I got from Copilot:

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. #Closed

surround View and Download with backticks

`View` `Download`

learn-build-service-prod · 2025-06-16T11:06:46Z

Learn Build status updates of commit e106446:

✅ Validation status: passed

File	Status	Preview URL	Details
sharepoint/sharepoint-ps/sharepoint-online/Get-SPOInformationBarriersInsightsReport.md	✅Succeeded	View (sharepoint-ps)
sharepoint/sharepoint-ps/sharepoint-online/Start-SPOInformationBarriersInsightsReport.md	✅Succeeded	View (sharepoint-ps)

For more details, please refer to the build report.

learn-build-service-prod · 2025-06-16T15:40:34Z

Learn Build status updates of commit 7d48139:

✅ Validation status: passed

File	Status	Preview URL	Details
sharepoint/sharepoint-ps/sharepoint-online/Get-SPOInformationBarriersInsightsReport.md	✅Succeeded	View (sharepoint-ps)
sharepoint/sharepoint-ps/sharepoint-online/Start-SPOInformationBarriersInsightsReport.md	✅Succeeded	View (sharepoint-ps)

For more details, please refer to the build report.

learn-build-service-prod · 2025-06-16T15:44:50Z

Learn Build status updates of commit ae57264:

✅ Validation status: passed

File	Status	Preview URL	Details
sharepoint/sharepoint-ps/sharepoint-online/Get-SPOInformationBarriersInsightsReport.md	✅Succeeded	View (sharepoint-ps)
sharepoint/sharepoint-ps/sharepoint-online/Start-SPOInformationBarriersInsightsReport.md	✅Succeeded	View (sharepoint-ps)

For more details, please refer to the build report.

Documentation about 2 existing commands

06f4544

github-actions bot assigned pvrk Jun 10, 2025

github-actions bot added the Microsoft submitter label Jun 10, 2025

dstrome assigned AdwoodMicrosoft Jun 10, 2025

dstrome added the Triage-InProgress PR is being handled by an existing writer or process. label Jun 10, 2025

samkabue reviewed Jun 10, 2025

View reviewed changes

samkabue added the Back to submitter The pull request didn't pass the review criteria and has been returned to the writer for updates label Jun 11, 2025

Resolving comments

f261f86

samkabue reviewed Jun 13, 2025

View reviewed changes

Updated as per comments

e106446

samkabue added Sign off The pull request is ready to be reviewed and merged by PubOps and removed Back to submitter The pull request didn't pass the review criteria and has been returned to the writer for updates labels Jun 16, 2025

Ruchika-mittal01 self-assigned this Jun 16, 2025

Ruchika-mittal01 added the In review PubOps is reviewing the pull request label Jun 16, 2025

Merge branch 'main' into pvrk-SharePointPS-Apr

7d48139

typo fix

ae57264

Ruchika-mittal01 added the PubOps fixes PubOps has fixed some issues in this PR. label Jun 16, 2025

Ruchika-mittal01 merged commit 74c3e91 into MicrosoftDocs:main Jun 16, 2025
8 checks passed


		### 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).


		## 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.


		## 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.


		### -Yes

		This boolean parameter will start generating the IB report.


		## SYNOPSIS

		This cmdlet helps to view the status of the insights on Information Barrier (IB).


		## DESCRIPTION

		This cmdlet helps to view the details of the specific parameters from the insights report.


		## SYNOPSIS

		Rnables the SharePoint administrator to check status of all active and completed reports of insights on Information Barriers (IB).

		### -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.

Conversation

pvrk commented Jun 10, 2025

Uh oh!

learn-build-service-prod bot commented Jun 10, 2025

✅ Validation status: passed

Uh oh!

samkabue Jun 10, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

samkabue Jun 10, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

samkabue Jun 10, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

samkabue Jun 10, 2025

Choose a reason for hiding this comment

Uh oh!

samkabue Jun 10, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

samkabue Jun 10, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

samkabue Jun 10, 2025

Choose a reason for hiding this comment

Uh oh!

samkabue Jun 10, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

samkabue Jun 10, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

samkabue Jun 10, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

samkabue Jun 10, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

samkabue Jun 10, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

samkabue Jun 10, 2025

Choose a reason for hiding this comment

Uh oh!

samkabue Jun 13, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

samkabue Jun 10, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

samkabue Jun 10, 2025

Choose a reason for hiding this comment

Uh oh!

samkabue Jun 10, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

samkabue Jun 10, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

samkabue Jun 10, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

samkabue Jun 10, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

samkabue Jun 10, 2025 •

edited

Loading

samkabue Jun 10, 2025 •

edited

Loading

samkabue Jun 10, 2025 •

edited

Loading

samkabue Jun 10, 2025 •

edited

Loading

samkabue Jun 10, 2025 •

edited

Loading

samkabue Jun 10, 2025 •

edited

Loading

samkabue Jun 10, 2025 •

edited

Loading

samkabue Jun 10, 2025 •

edited

Loading

samkabue Jun 10, 2025 •

edited

Loading

samkabue Jun 10, 2025 •

edited

Loading

samkabue Jun 13, 2025 •

edited

Loading

samkabue Jun 10, 2025 •

edited

Loading

samkabue Jun 10, 2025 •

edited

Loading

samkabue Jun 10, 2025 •

edited

Loading

samkabue Jun 10, 2025 •

edited

Loading

samkabue Jun 10, 2025 •

edited

Loading

samkabue Jun 13, 2025 •

edited

Loading

samkabue Jun 13, 2025 •

edited

Loading

samkabue Jun 13, 2025 •

edited

Loading

samkabue Jun 13, 2025 •

edited

Loading

samkabue Jun 13, 2025 •

edited

Loading