-
Notifications
You must be signed in to change notification settings - Fork 195
Documentation about 2 existing commands #913
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Changes from 2 commits
File filter
Filter by extension
Conversations
Jump to
Diff view
Diff view
There are no files selected for viewing
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,158 @@ | ||
| --- | ||
| 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 | ||
|
|
||
| Rnables the SharePoint administrator to check status of all active and completed reports of insights on Information Barriers (IB). | ||
|
||
|
|
||
| ## SYNTAX | ||
|
|
||
| ```powershell | ||
| Get-SPOInformationBarriersInsightsReport [-ReportId <Guid>] [-Section <SectionType>] [-Action <ActionType>] [-Service <ServiceType>] [-FullDetails] [<CommonParameters>] | ||
| ``` | ||
|
|
||
| ## DESCRIPTION | ||
|
|
||
| If this cmdlet is executed without any parameters, it displays the status of all active and completed reports with the following properties: | ||
|
|
||
| |Property |Description | | ||
| |---------|---------| | ||
| |Content | Display the [modes of IB](/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. | | ||
| |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. | | ||
|
|
||
| ## EXAMPLES | ||
|
|
||
| ### Example 1 | ||
|
|
||
| ```powershell | ||
| 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. | ||
|
|
||
| ### Example 2 | ||
|
|
||
| ```powershell | ||
| 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. | ||
|
||
|
|
||
| ## 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. | ||
|
|
||
|
Contributor
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. could be improved further. Here's the suggestion I got from Copilot:
Contributor
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. surround View and Download with backticks |
||
| ```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) | ||
| 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 | ||
|
|
||
| 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 | ||
|
|
||
| ```powershell | ||
| Start-SPOInformationBarriersInsightsReport [-Yes <Boolean>] [-WhatIf] [-Confirm] [<CommonParameters>] | ||
| ``` | ||
|
|
||
| ## DESCRIPTION | ||
|
|
||
| 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 | ||
| Start-SPOInformationBarriersInsightsReport -Yes | ||
| ``` | ||
|
|
||
| This example generates IB reports without asking for further confirmation. | ||
|
|
||
| ## PARAMETERS | ||
|
|
||
| ### -Yes | ||
|
Contributor
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more.
Contributor
There was a problem hiding this comment. Choose a reason for hiding this commentThe 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 User can bypass confirmation by doing 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. | ||
|
||
|
|
||
| ```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) | ||
Uh oh!
There was an error while loading. Please reload this page.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
typo - "Enables" #Closed