-
Notifications
You must be signed in to change notification settings - Fork 197
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 1 commit
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,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 <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. | ||
|
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. needs improvement. #Closed |
||
|
|
||
| ## EXAMPLES | ||
|
|
||
| ### Example 1 | ||
|
|
||
| ```powershell | ||
| PS C:\> Get-SPOInformationBarriersInsightsReport -reportId ec65a1cf-9b1a-48c2-a1b4-f923ac4c0776 | ||
|
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. 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 | ||
|
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. 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. | ||
|
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. |
||
|
|
||
| ### 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. | ||
|
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. |
||
|
|
||
| ## PARAMETERS | ||
|
|
||
| ### -Action | ||
|
|
||
| This parameter helps to view or download the results of the insights report. | ||
|
|
||
|
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). | ||
|
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.
|
||
|
|
||
| ## 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. | ||
|
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. |
||
|
|
||
| ## 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. | ||
|
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. 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
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. |
||
|
|
||
| ## EXAMPLES | ||
|
|
||
| ### Example 1 | ||
|
|
||
| ```powershell | ||
| PS C:\> Start-SPOInformationBarriersInsightsReport | ||
|
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. |
||
| ``` | ||
|
|
||
| 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. | ||
|
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. |
||
|
|
||
| ## 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. | ||
|
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. 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). | ||
|
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.
|
||
|
|
||
| ## 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.
this description could be improved. does it get "status" or actual reports? #Closed