Skip to content

Commit ae0592e

Browse files
wlibebewlibebe
authored
Merge pull request #692 from Shweta2024/bhagatshweta-appinsights
Add documentation for the Enterprise App Insights Cmdlets
2 parents e61265d + 9fdb9c3 commit ae0592e

File tree

2 files changed

+222
-0
lines changed

2 files changed

+222
-0
lines changed

‎sharepoint/sharepoint-ps/sharepoint-online/Get-SPOEnterpriseAppInsightsReport.md‎

Lines changed: 123 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,123 @@
1+
---
2+
external help file: sharepointonline.xml
3+
Module Name: Microsoft.Online.SharePoint.PowerShell
4+
online version: https://learn.microsoft.com/powershell/module/sharepoint-online/get-spoenterpriseappinsightsreport
5+
applicable: SharePoint Online
6+
title: Get-SPOEnterpriseAppInsightsReport
7+
schema: 2.0.0
8+
author: sumikumar
9+
ms.author: sumikumar
10+
ms.reviewer:
11+
manager: hikakar
12+
---
13+
14+
# Get-SPOEnterpriseAppInsightsReport
15+
16+
## SYNOPSIS
17+
18+
This cmdlet enables the administrator to check status of all active and available reports when no report ID is present and to view or download a report if report ID is present.
19+
20+
## SYNTAX
21+
22+
```powershell
23+
Get-SPOEnterpriseAppInsightsReport [-ReportId <Guid>] [-Action <ActionType>]
24+
```
25+
26+
## DESCRIPTION
27+
28+
If this cmdlet is executed without any parameters, it displays the status of all active and completed reports with the following properties:
29+
30+
| Property | Description |
31+
|:---------------------|:------------------------------------------------------------|
32+
| Id | The unique Id of the report. |
33+
| CreatedDateTimeInUtc | The date and time the report creation was triggered in UTC. |
34+
| Status | The status of the report. |
35+
| ReportPeriodInDays | The report duration in days. |
36+
37+
If this cmdlet is executed with `-ReportId` as parameter, the top 100 records of the report from the last N days will be displayed with the following properties:
38+
39+
| Property | Description |
40+
|:----------------|:---------------------------------------------------------------------------|
41+
| SiteName | The name of the SharePoint site. |
42+
| SiteURL | The URL of the SharePoint site. |
43+
| SiteSensitivity | The sensitivity label of the SharePoint site. |
44+
| AppID | The AppID of the 3P application. |
45+
| AppPermissions | The permissions granted to the 3P application. |
46+
| RequestVoulme | The number of times the 3P application accessed the given SharePoint site. |
47+
48+
If this cmdlet is executed with both the parameters, i.e. `-ReportId` and `-Action`, and if the value of `-Action` is set as `View`, it will display the same result as described above. If the value of `-Action` is set to `Download`, it will download the full report in CSV format to the same path from where the command was run.
49+
50+
> [!NOTE]
51+
> All reports adhere to any retention timeline as per [Data Access Governance](/sharepoint/data-access-governance-reports).
52+
53+
## EXAMPLES
54+
55+
### -----------------------EXAMPLE 1-----------------------------
56+
57+
```powershell
58+
Get-SPOEnterpriseAppInsightsReport
59+
```
60+
61+
Example 1 enables administrator to view the status of all active and completed reports.
62+
63+
### -----------------------EXAMPLE 2-----------------------------
64+
65+
```powershell
66+
Get-SPOEnterpriseAppInsightsReport –ReportId 9d946216-afe7-49f5-8267-7b662435c70b
67+
```
68+
69+
Example 2 enables administrator to view the enterprise application insights report of ReportId: `9d946216-afe7-49f5-8267-7b662435c70b`
70+
71+
### -----------------------EXAMPLE 3-----------------------------
72+
73+
```powershell
74+
Get-SPOEnterpriseAppInsightsReport – ReportId 9d946216-afe7-49f5-8267-7b662435c70b -Action Download
75+
```
76+
77+
Example 3 enables administrator to download the enterprise application insights report of ReportId: `9d946216-afe7-49f5-8267-7b662435c70b` to the same path from where the command was run.
78+
79+
## PARAMETERS
80+
81+
### -ReportId
82+
83+
It is an optional parameter, and it specifies the unique Id of the report to be viewed or downloaded.
84+
85+
```yaml
86+
Type: Guid
87+
Parameter Sets: (All)
88+
Aliases:
89+
Applicable: SharePoint Online
90+
91+
Required: False
92+
Position: Named
93+
Default value: None
94+
Accept pipeline input: False
95+
Accept wildcard characters: False
96+
```
97+
98+
### -Action
99+
100+
It is an optional parameter, and it specifies whether to view or download a specific report.
101+
102+
```yaml
103+
Type: ActionType
104+
Parameter Sets: (All)
105+
Aliases:
106+
Applicable: SharePoint Online
107+
108+
Required: False
109+
Position: Named
110+
Default value: None
111+
Accept pipeline input: False
112+
Accept wildcard characters: False
113+
```
114+
115+
### CommonParameters
116+
117+
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).
118+
119+
## RELATED LINKS
120+
121+
[Getting started with SharePoint Online Management Shell](/powershell/sharepoint/sharepoint-online/connect-sharepoint-online)
122+
123+
[Start-SPOEnterpriseAppInsightsReport](./Start-SPOEnterpriseAppInsightsReport.md)

‎sharepoint/sharepoint-ps/sharepoint-online/Start-SPOEnterpriseAppInsightsReport.md‎

Lines changed: 99 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,99 @@
1+
---
2+
external help file: sharepointonline.xml
3+
Module Name: Microsoft.Online.SharePoint.PowerShell
4+
online version: https://learn.microsoft.com/powershell/module/sharepoint-online/start-spoenterpriseappinsightsreport
5+
applicable: SharePoint Online
6+
title: Start-SPOEnterpriseAppInsightsReport
7+
schema: 2.0.0
8+
author: sumikumar
9+
ms.author: sumikumar
10+
ms.reviewer:
11+
manager: hikakar
12+
---
13+
14+
# Start-SPOEnterpriseAppInsightsReport
15+
16+
## SYNOPSIS
17+
18+
This cmdlet enables administrator to trigger the build of a new enterprise application insights report for the last N days.
19+
20+
## SYNTAX
21+
22+
```powershell
23+
Start-SPOEnterpriseAppInsightsReport [-ReportPeriodInDays <Int>] [-Force <SwitchParameter>]
24+
```
25+
26+
## DESCRIPTION
27+
28+
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:
29+
30+
| Property | Description |
31+
|:---------------------|:------------------------------------------------------------|
32+
| Id | The unique Id of the report. |
33+
| CreatedDateTimeInUtc | The date and time the report creation was triggered in UTC. |
34+
| Status | The status of the report. |
35+
| ReportPeriodInDays | The report duration in days. |
36+
37+
## EXAMPLES
38+
39+
### -----------------------EXAMPLE 1-----------------------------
40+
41+
```powershell
42+
Start-SPOEnterpriseAppInsightsReport
43+
```
44+
45+
Example 1 generates the enterprise application insights report for a default duration of 1 day as the parameter `–ReportPeriodInDays` is not provided.
46+
47+
### -----------------------EXAMPLE 2-----------------------------
48+
49+
```powershell
50+
Start-SPOEnterpriseAppInsightsReport –ReportPeriodInDays 14
51+
```
52+
53+
Example 2 generates the enterprise application insights report for a specified duration of 14 days.
54+
55+
## PARAMETERS
56+
57+
### -ReportPeriodInDays
58+
59+
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.
60+
61+
```yaml
62+
Type: Int
63+
Parameter Sets: (All)
64+
Aliases:
65+
Applicable: SharePoint Online
66+
67+
Required: False
68+
Position: Named
69+
Default value: None
70+
Accept pipeline input: False
71+
Accept wildcard characters: False
72+
```
73+
74+
### -Force
75+
76+
It is an optional parameter which is used to bypass confirmation prompts and execute the command without interruptions.
77+
78+
```yaml
79+
Type: SwitchParameter
80+
Parameter Sets: (All)
81+
Aliases:
82+
Applicable: SharePoint Online
83+
84+
Required: False
85+
Position: Named
86+
Default value: None
87+
Accept pipeline input: False
88+
Accept wildcard characters: False
89+
```
90+
91+
### CommonParameters
92+
93+
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).
94+
95+
## Related Links
96+
97+
[Getting started with SharePoint Online Management Shell](/powershell/sharepoint/sharepoint-online/connect-sharepoint-online)
98+
99+
[Get-SPOEnterpriseAppInsightsReport](./Get-SPOEnterpriseAppInsightsReport.md)

0 commit comments

Comments
 (0)