Start-SPOEnterpriseAppInsightsReport

  • Reference
Module:
Microsoft.Online.SharePoint.PowerShell
Applies to:
SharePoint Online

This cmdlet enables administrator to trigger the build of a new enterprise application insights report for the last N days.

Syntax

Start-SPOEnterpriseAppInsightsReport
     [-ReportPeriodInDays <Int>]
     [-Force <SwitchParameter>]

Description

After this cmdlet is executed, the enterprise application insights report generation request for the last N 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 the report creation was triggered in UTC.
Status The status of the report.
ReportPeriodInDays The report duration in days.

Examples

-----------------------EXAMPLE 1-----------------------------

Start-SPOEnterpriseAppInsightsReport

Example 1 generates the enterprise application insights report for a default duration of 1 day as the parameter -ReportPeriodInDays is not provided.

-----------------------EXAMPLE 2-----------------------------

Start-SPOEnterpriseAppInsightsReport -ReportPeriodInDays 14

Example 2 generates the enterprise application insights report for a specified duration of 14 days.

Parameters

-Force

It is an optional parameter which is used to bypass confirmation prompts and execute the command without interruptions.

Type:SwitchParameter
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False
Applies to:SharePoint Online

-ReportPeriodInDays

It is an optional parameter, and it specifies the duration of the enterprise application insights 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.

Type:Int
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False
Applies to:SharePoint Online