Skip to content

Latest commit

 

History

History
142 lines (101 loc) · 3.93 KB

File metadata and controls

142 lines (101 loc) · 3.93 KB
external help file Microsoft.Online.SharePoint.PowerShell.dll-Help.xml
Module Name Microsoft.Online.SharePoint.PowerShell
online version https://learn.microsoft.com/powershell/module/microsoft.online.sharepoint.powershell/start-spoenterpriseappinsightsreport
applicable SharePoint Online
title Start-SPOEnterpriseAppInsightsReport
schema 2.0.0
author sumikumar
ms.author sumikumar
ms.reviewer
manager hikakar

Start-SPOEnterpriseAppInsightsReport

SYNOPSIS

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

SYNTAX

Start-SPOEnterpriseAppInsightsReport [-Force] [-ReportPeriodInDays <Int32>] [-WhatIf] [-Confirm]
 [<CommonParameters>]

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

Applicable: SharePoint Online

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

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 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: 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.

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.

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.

INPUTS

None

OUTPUTS

System.Object

NOTES

RELATED LINKS

Getting started with SharePoint Online Management Shell

Get-SPOEnterpriseAppInsightsReport