Skip to content
Merged
Show file tree
Hide file tree
Changes from 1 commit
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Original file line number Diff line number Diff line change
@@ -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).
Copy link
Copy Markdown
Contributor

@samkabue samkabue Jun 10, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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


## SYNTAX

```powershell
Get-SPOInformationBarriersInsightsReport [-ReportId <Guid>] [-Section <SectionType>] [-Action <ActionType>] [-Service <ServiceType>] [-FullDetails] [<CommonParameters>]
```

## DESCRIPTION

This cmdlet helps to view the details of the specific parameters from the insights report.
Copy link
Copy Markdown
Contributor

@samkabue samkabue Jun 10, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

needs improvement. #Closed


## EXAMPLES

### Example 1

```powershell
PS C:\> Get-SPOInformationBarriersInsightsReport -reportId ec65a1cf-9b1a-48c2-a1b4-f923ac4c0776
Copy link
Copy Markdown
Contributor

@samkabue samkabue Jun 10, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

PS C:>

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

here and elsewhere #Closed

Copy link
Copy Markdown
Contributor

@samkabue samkabue Jun 10, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

applies to the other file as well


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
Copy link
Copy Markdown
Contributor

@samkabue samkabue Jun 10, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

we don't include example output.

here and elsewhere #Closed

```

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.
Copy link
Copy Markdown
Contributor

@samkabue samkabue Jun 10, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

mode

see other file: mode should be documented somewhere #Closed


### 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.
Copy link
Copy Markdown
Contributor

@samkabue samkabue Jun 10, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The above cmdlet

"This example..." #Closed


## PARAMETERS

### -Action

This parameter helps to view or download the results of the insights report.

Copy link
Copy Markdown
Contributor

@samkabue samkabue Jun 13, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

surround View and Download with backticks

`View`
`Download`

```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).
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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.


## INPUTS

### None

## OUTPUTS

### System.Object

## NOTES

## RELATED LINKS

[Start-SPOInformationBarriersInsightsReport](./Start-SPOInformationBarriersInsightsReport.md)
Original file line number Diff line number Diff line change
@@ -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.
Copy link
Copy Markdown
Contributor

@samkabue samkabue Jun 10, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

reports in information barriers

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

is it reports "about" information barriers? #Closed

Copy link
Copy Markdown
Contributor

@samkabue samkabue Jun 10, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This cmdlet generates

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


## SYNTAX

```powershell
Start-SPOInformationBarriersInsightsReport [-Yes <Boolean>] [-WhatIf] [-Confirm] [<CommonParameters>]
```

## 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.
Copy link
Copy Markdown
Contributor

@samkabue samkabue Jun 10, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Information Barriers

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

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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

Copy link
Copy Markdown
Contributor

@samkabue samkabue Jun 10, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

would create

use simple present tense instead of conditional tense.

"would create" -> "creates"

other places too #Closed

Copy link
Copy Markdown
Contributor

@samkabue samkabue Jun 10, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

modes

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


## EXAMPLES

### Example 1

```powershell
PS C:\> Start-SPOInformationBarriersInsightsReport
Copy link
Copy Markdown
Contributor

@samkabue samkabue Jun 10, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

PS C:>

remove "PS :>" #Closed

```

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.
Copy link
Copy Markdown
Contributor

@samkabue samkabue Jun 10, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This PS command would create Information Barriers

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


## PARAMETERS

### -Yes
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

-Yes

this is an awkwardly named parameter.

so someone uses it like

-Yes $true

or

-Yes $false

?

Copy link
Copy Markdown
Contributor

@samkabue samkabue Jun 13, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@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


This boolean parameter will start generating the IB report.
Copy link
Copy Markdown
Contributor

@samkabue samkabue Jun 10, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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


```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).
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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.


## INPUTS

### None

## OUTPUTS

### System.Object

## NOTES

## RELATED LINKS

[Get-SPOInformationBarriersInsightsReport](./Get-SPOInformationBarriersInsightsReport.md)