Get-SPOM365AgentAccessInsightsReport
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
Default (Default)
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.
Examples
EXAMPLE 1
Get-SPOM365AgentAccessInsightsReport
Example 1 enables administrator to view the status of all active and completed analytics reports.
EXAMPLE 2
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
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.
Parameter properties
| Type: | ActionType |
| Default value: | View |
| Accepted values: | View, Download |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
(All)
| Position: | Named |
| Mandatory: | False |
| Value from pipeline: | False |
| Value from pipeline by property name: | False |
| Value from remaining arguments: | 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.
Parameter properties
| Type: | Microsoft.Online.SharePoint.TenantAdministration.SPOM365AgentInsightType |
| Default value: | M365AgentsOnSites |
| Accepted values: | M365AgentsOnSites, SiteDistribution |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
(All)
| Position: | Named |
| Mandatory: | False |
| Value from pipeline: | False |
| Value from pipeline by property name: | False |
| Value from remaining arguments: | False |
-ReportId
Applicable: SharePoint Online
It specifies the unique ID of the report to be viewed or downloaded.
Parameter properties
| Type: | System.Guid |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
(All)
| Position: | Named |
| Mandatory: | False |
| Value from pipeline: | False |
| Value from pipeline by property name: | False |
| Value from remaining arguments: | False |
CommonParameters
This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutBuffer, -OutVariable, -PipelineVariable, -ProgressAction, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters.