Start-SPOCopilotAgentInsightsReport
Using this cmdlet, administrators may trigger the build of a new Copilot agent insight report for the specified number of days.
Note
The feature associated with this cmdlet will be rolling out soon.
Syntax
Default (Default)
Start-SPOCopilotAgentInsightsReport
[-Force]
[-ReportPeriodInDays <Int32>]
[-WhatIf]
[-Confirm]
[<CommonParameters>]
Description
After this cmdlet is executed, the Copilot agent insight report generation request for the specified number of days gets queued in the pipeline and the below metadata is displayed with the following properties:
| Property | Description |
|---|---|
| Id | The unique Id of the report. |
| CreatedDateTimeInUtc | The date and time in UTC when the report creation was triggered. |
| Status | The status of the report. |
| ReportPeriodInDays | The report duration in days. |
Examples
EXAMPLE 1
Start-SPOCopilotAgentInsightsReport
Example 1 generates the Copilot agent insight report for a default duration of 1 day since the parameter –ReportPeriodInDays is not provided.
EXAMPLE 2
Start-SPOCopilotAgentInsightsReport –ReportPeriodInDays 14
Example 2 generates the Copilot agent insight report for a specified duration of 14 days.
Parameters
-Confirm
Prompts you for confirmation before running the cmdlet.
Parameter properties
| Type: | System.Management.Automation.SwitchParameter |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
| Aliases: | cf |
Parameter sets
(All)
| Position: | Named |
| Mandatory: | False |
| Value from pipeline: | False |
| Value from pipeline by property name: | False |
| Value from remaining arguments: | False |
-Force
Applicable: SharePoint Online
It is an optional parameter which is used to bypass confirmation prompts and execute the command without interruptions.
Parameter properties
| Type: | System.Management.Automation.SwitchParameter |
| 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 |
-ReportPeriodInDays
Applicable: SharePoint Online
It specifies the duration of the Copilot 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.
Parameter properties
| Type: | System.Int32 |
| 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 |
-WhatIf
Shows what would happen if the cmdlet runs. The cmdlet is not run.
Parameter properties
| Type: | System.Management.Automation.SwitchParameter |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
| Aliases: | wi |
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.