-
Notifications
You must be signed in to change notification settings - Fork 187
Added docs for M365 Agent Insights cmdlets. #975
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
Merged
Ruchika-mittal01
merged 9 commits into
MicrosoftDocs:main
from
starringGTM:gautam/UpdateDocumentation
Sep 5, 2025
Merged
Changes from all commits
Commits
Show all changes
9 commits
Select commit
Hold shift + click to select a range
3355b2c
Added docs for M365 Agent Insights cmdlets.
starringGTM 9ef5efc
Update Get-SPOM365AgentAccessInsightsReport.md
starringGTM 8a5c973
Update Get-SPOM365AgentAccessInsightsReport.md
starringGTM 558b915
Update Start-SPOM365AgentAccessInsightsReport.md
starringGTM a731608
Revise Get-SPOM365AgentAccessInsightsReport.md
starringGTM f13a0cb
Revise author and cmdlet details in documentation
starringGTM 3915c8f
Add documentation for new M365 Agent Insights cmdlets
starringGTM a7647d9
Update Start-SPOM365AgentAccessInsightsReport.md
starringGTM 9ddf536
Merge branch 'main' into gautam/UpdateDocumentation
Ruchika-mittal01 File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
141 changes: 141 additions & 0 deletions
141
.../Microsoft.Online.SharePoint.PowerShell/Get-SPOM365AgentAccessInsightsReport.md
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,141 @@ | ||
| --- | ||
| external help file: Microsoft.Online.SharePoint.PowerShell.dll-Help.xml | ||
| Module Name: Microsoft.Online.SharePoint.PowerShell | ||
| online version: https://learn.microsoft.com/powershell/module/sharepoint-online/get-SPOM365AgentAccessInsightsReport | ||
| applicable: SharePoint Online | ||
| title: Get-SPOM365AgentAccessInsightsReport | ||
| schema: 2.0.0 | ||
| author: starringGTM | ||
| ms.author: gchaudhary | ||
| ms.reviewer: | ||
| --- | ||
|
|
||
| # Get-SPOM365AgentAccessInsightsReport | ||
starringGTM marked this conversation as resolved.
Show resolved
Hide resolved
|
||
|
|
||
| ## SYNOPSIS | ||
|
|
||
| This cmdlet enables the administrator to check status of all active and available analytics reports when no report ID is present and to view or download a report if report ID is present. | ||
|
|
||
| > [!NOTE] | ||
| > The feature associated with this cmdlet will be rolling out soon. | ||
|
|
||
| ## SYNTAX | ||
|
|
||
| ``` | ||
| Get-SPOM365AgentAccessInsightsReport [-ReportId <Guid>] [-Action <ActionType>] | ||
| [-Content <M365AgentsOnSites>] [<CommonParameters>] | ||
| ``` | ||
|
|
||
| ## DESCRIPTION | ||
|
|
||
| If this cmdlet is executed without any parameters, it displays the status of all active and completed reports. | ||
| > [!NOTE] | ||
| > All reports adhere to any retention timeline as per [Data Access Governance](/sharepoint/data-access-governance-reports). | ||
|
|
||
| ## EXAMPLES | ||
|
|
||
| ### EXAMPLE 1 | ||
|
|
||
| ```powershell | ||
| Get-SPOM365AgentAccessInsightsReport | ||
| ``` | ||
|
|
||
| Example 1 enables administrator to view the status of all active and completed analytics reports. | ||
|
|
||
| ### EXAMPLE 2 | ||
|
|
||
| ```powershell | ||
| Get-SPOM365AgentAccessInsightsReport –ReportId 9d946216-afe7-49f5-8267-7b662435c70b | ||
| ``` | ||
|
|
||
| Example 2 enables administrator to view the Microsoft 365 agent insight report of the given report ID. | ||
|
|
||
| ### EXAMPLE 3 | ||
|
|
||
| ```powershell | ||
| Get-SPOM365AgentAccessInsightsReport – ReportId 9d946216-afe7-49f5-8267-7b662435c70b -Action Download | ||
| ``` | ||
|
|
||
| Example 3 enables administrator to download the Microsoft 365 agent insight report of the given report ID to the same path from where the command was run. | ||
|
|
||
| ## PARAMETERS | ||
|
|
||
| ### -Action | ||
|
|
||
| > Applicable: SharePoint Online | ||
|
|
||
| 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. | ||
|
|
||
| ```yaml | ||
| Type: ActionType | ||
| Parameter Sets: (All) | ||
| Aliases: | ||
| Accepted values: View, Download | ||
|
|
||
| Required: False | ||
| Position: Named | ||
| Default value: View | ||
| Accept pipeline input: False | ||
| Accept wildcard characters: False | ||
| ``` | ||
|
|
||
| ### -Content | ||
|
|
||
| > Applicable: SharePoint Online | ||
|
|
||
| It specifies the kind of report to view or download. | ||
|
|
||
| If this cmdlet is executed with `-Content` as `M365AgentsOnSites`, a report with list of all sites on which a agent is created along with the names of the agent created in the specified number of days will be displayed. | ||
|
|
||
| If this cmdlet is executed with `-ReportId` as parameter and `-Content` as `SiteDistribution`, a report showing Microsoft 365 agents distribution across sites in the specified number of days will be displayed. | ||
|
|
||
| ```yaml | ||
| Type: Microsoft.Online.SharePoint.TenantAdministration.SPOM365AgentInsightType | ||
| Parameter Sets: (All) | ||
| Aliases: | ||
| Accepted values: M365AgentsOnSites, SiteDistribution | ||
|
|
||
| Required: False | ||
| Position: Named | ||
| Default value: M365AgentsOnSites | ||
| Accept pipeline input: False | ||
| Accept wildcard characters: False | ||
| ``` | ||
|
|
||
| ### -ReportId | ||
|
|
||
| > Applicable: SharePoint Online | ||
|
|
||
| It specifies the unique ID of the report to be viewed or downloaded. | ||
|
|
||
| ```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`, `-Verbose`, `-WarningAction`, and `-WarningVariable`. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/?LinkID=113216). | ||
|
|
||
| ## INPUTS | ||
|
|
||
| ### None | ||
|
|
||
| ## OUTPUTS | ||
|
|
||
| ### System.Object | ||
|
|
||
| ## NOTES | ||
|
|
||
| ## RELATED LINKS | ||
|
|
||
| [Getting started with SharePoint Online Management Shell](/powershell/sharepoint/sharepoint-online/connect-sharepoint-online) | ||
|
|
||
| [Start-SPOM365AgentAccessInsightsReport](./Start-SPOM365AgentAccessInsightsReport.md) | ||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
139 changes: 139 additions & 0 deletions
139
...icrosoft.Online.SharePoint.PowerShell/Start-SPOM365AgentAccessInsightsReport.md
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,139 @@ | ||
| --- | ||
| external help file: Microsoft.Online.SharePoint.PowerShell.dll-Help.xml | ||
| Module Name: Microsoft.Online.SharePoint.PowerShell | ||
| online version: https://learn.microsoft.com/powershell/module/sharepoint-online/start-spom365agentaccessinsightsreport | ||
| applicable: SharePoint Online | ||
| title: Start-SPOM365AgentAccessInsightsReport | ||
| schema: 2.0.0 | ||
| author: starringGTM | ||
| ms.author: gchaudhary | ||
| ms.reviewer: | ||
| --- | ||
|
|
||
| # Start-SPOM365AgentAccessInsightsReport | ||
|
|
||
| ## SYNOPSIS | ||
|
|
||
| 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. | ||
|
|
||
| ## SYNTAX | ||
|
|
||
| ``` | ||
| Start-SPOM365AgentAccessInsightsReport [-Force] [-ReportPeriodInDays <Int32>] [-WhatIf] [-Confirm] | ||
| [<CommonParameters>] | ||
| ``` | ||
|
|
||
| ## DESCRIPTION | ||
|
|
||
| After executing this cmdlet, the Microsoft 365 agent insight report generation request for the specified number of days is added to the pipeline queue. | ||
|
|
||
| ## EXAMPLES | ||
|
|
||
| ### EXAMPLE 1 | ||
|
|
||
| ```powershell | ||
| Start-SPOM365AgentAccessInsightsReport | ||
| ``` | ||
|
|
||
| Example 1 generates the Microsoft 365 agent insight report for a default duration of 1 day since the parameter `–ReportPeriodInDays` is not provided. | ||
|
|
||
| ### EXAMPLE 2 | ||
|
|
||
| ```powershell | ||
| Start-SPOM365AgentAccessInsightsReport –ReportPeriodInDays 14 | ||
| ``` | ||
|
|
||
| Example 2 generates the Copilot agent insight report for a specified duration of 14 days. | ||
|
|
||
| ## PARAMETERS | ||
|
|
||
| ### -Force | ||
|
|
||
| > Applicable: SharePoint Online | ||
|
|
||
| It is an optional parameter which is used to bypass confirmation prompts and execute the command without interruptions. | ||
|
|
||
| ```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 | ||
| ``` | ||
|
|
||
| ### -ReportPeriodInDays | ||
|
|
||
| > Applicable: SharePoint Online | ||
|
|
||
| It specifies the duration of the M365 agent insight report in days. The possible values of ReportPeriodInDays are: 1, 7, 14, 28. If this parameter is not provided, it generates the report for a default duration of 1 day. | ||
|
|
||
| ```yaml | ||
| Type: System.Int32 | ||
| 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, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/?LinkID=113216). | ||
|
|
||
| ## INPUTS | ||
|
|
||
| ### None | ||
|
|
||
| ## OUTPUTS | ||
|
|
||
| ### System.Object | ||
|
|
||
| ## NOTES | ||
|
|
||
| ## RELATED LINKS | ||
|
|
||
| [Getting started with SharePoint Online Management Shell](/powershell/sharepoint/sharepoint-online/connect-sharepoint-online) | ||
|
|
||
|
|
||
| [Get-SPOM365AgentAccessInsightsReport](./Get-SPOM365AgentAccessInsightsReport.md) | ||
|
|
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.