Skip to content

Commit 46d371e

Browse files
committed
Address PR comments: fix casing, links, table alignment, and minor details.
Address PR comments: fix casing, links, table alignment, and minor details.
2 parents e1b46e5 + 4773a07 commit 46d371e

File tree

2 files changed

+59
-53
lines changed

2 files changed

+59
-53
lines changed
Lines changed: 34 additions & 29 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
---
22
external help file: sharepointonline.xml
33
Module Name: Microsoft.Online.SharePoint.PowerShell
4-
online version:
4+
online version: https://learn.microsoft.com/powershell/module/sharepoint-online/get-spoenterpriseappinsightsreport
55
applicable: SharePoint Online
66
title: Get-SPOEnterpriseAppInsightsReport
77
schema: 2.0.0
@@ -15,36 +15,41 @@ manager: hikakar
1515

1616
## SYNOPSIS
1717

18-
This cmdlet enables the admin to check status of all active and available reports when no report ID is present and to View/Download a Report if report ID is present.
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.
1919

2020
## SYNTAX
2121

2222
```powershell
23-
Get-SPOEnterpriseAppInsightsReport [-ReportId <Guid>] [-Action <enum>]
23+
Get-SPOEnterpriseAppInsightsReport [-ReportId <Guid>] [-Action <ActionType>]
2424
```
2525

2626
## DESCRIPTION
2727

28-
If this cmdlet is executed without any parameters, it displays the status of all active and completed reports (adhering to any retention timeline as per DAG) with the following properties:
29-
| Property | Description |
30-
| :------------------- | :--------------------------------------- |
31-
| Id | The unique Id of the report. |
32-
| CreatedDateTimeInUtc | The Date and Time the report creation was triggered in UTC. |
33-
| Status | The Status of the report. |
34-
| ReportPeriodInDays | The report duration in days. |
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. |
3536

3637
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:
37-
| Property | Description |
38-
| :------------------- | :--------------------------------------- |
39-
| SiteName | The name of the SharePoint Site. |
40-
| SiteURL | The URL of the SharePoint Site. |
41-
| SiteSensitivity | The Sensitivity Label of the SharePoint Site. |
42-
| AppID | The AppID of the 3P App. |
43-
| AppPermissions| The Permissions granted to the 3P App. |
44-
| RequestVoulme | The number of times the 3P accessed the given SharePoint Site. |
45-
46-
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.
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 `C:\Users\vmadministrator` directory.
4749

50+
> [!NOTE]
51+
> All reports adhere to any retention timeline as per Data Access Governance.
52+
4853
## EXAMPLES
4954

5055
### -----------------------EXAMPLE 1-----------------------------
@@ -53,29 +58,29 @@ If this cmdlet is executed with both the parameters, i.e. `-ReportId` and `-Acti
5358
Get-SPOEnterpriseAppInsightsReport
5459
```
5560

56-
Example 1 enables admin to view the status of all active and completed reports (adhering to any retention timeline as per DAG).
61+
Example 1 enables administrator to view the status of all active and completed reports.
5762

5863
### -----------------------EXAMPLE 2-----------------------------
5964

6065
```powershell
6166
Get-SPOEnterpriseAppInsightsReport –ReportId 9d946216-afe7-49f5-8267-7b662435c70b
6267
```
6368

64-
Example 2 enables admin to view the Enterprise Application Insights report of ReportId: `9d946216-afe7-49f5-8267-7b662435c70b`
69+
Example 2 enables administrator to view the enterprise application insights report of ReportId: `9d946216-afe7-49f5-8267-7b662435c70b`
6570

6671
### -----------------------EXAMPLE 3-----------------------------
6772

6873
```powershell
6974
Get-SPOEnterpriseAppInsightsReport – ReportId 9d946216-afe7-49f5-8267-7b662435c70b -Action Download
7075
```
7176

72-
Example 3 enables admin to download the Enterprise Application Insights report of ReportId: `9d946216-afe7-49f5-8267-7b662435c70b`.
77+
Example 3 enables administrator to download the enterprise application insights report of ReportId: `9d946216-afe7-49f5-8267-7b662435c70b` to `C:\Users\vmadministrator` directory.
7378

7479
## PARAMETERS
7580

7681
### -ReportId
7782

78-
It is an optional parameter, and it specifies the unique Id of the report to be viewed/downloaded.
83+
It is an optional parameter, and it specifies the unique Id of the report to be viewed or downloaded.
7984

8085
```yaml
8186
Type: Guid
@@ -95,7 +100,7 @@ Accept wildcard characters: False
95100
It is an optional parameter, and it specifies whether to view or download a specific report.
96101
97102
```yaml
98-
Type: enum
103+
Type: ActionType
99104
Parameter Sets: (All)
100105
Aliases:
101106
Applicable: SharePoint Online
@@ -107,12 +112,12 @@ Accept pipeline input: False
107112
Accept wildcard characters: False
108113
```
109114
110-
## CommonParameters
115+
### CommonParameters
111116
112117
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).
113118

114-
## Related Links
119+
## RELATED LINKS
115120

116-
[Get started with SharePoint Online Management Shell](https://learn.microsoft.com/en-us/powershell/sharepoint/sharepoint-online/connect-sharepoint-online)
121+
[Getting started with SharePoint Online Management Shell](/powershell/sharepoint/sharepoint-online/connect-sharepoint-online)
117122

118-
[Start-SPOEnterpriseAppInsightsReport](./Get-SPOEnterpriseAppInsightsReport.md)
123+
[Start-SPOEnterpriseAppInsightsReport](./Start-SPOEnterpriseAppInsightsReport.md)
Lines changed: 25 additions & 24 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
---
22
external help file: sharepointonline.xml
33
Module Name: Microsoft.Online.SharePoint.PowerShell
4-
online version:
4+
online version: https://learn.microsoft.com/powershell/module/sharepoint-online/start-spoenterpriseappinsightsreport
55
applicable: SharePoint Online
66
title: Start-SPOEnterpriseAppInsightsReport
77
schema: 2.0.0
@@ -15,23 +15,24 @@ manager: hikakar
1515

1616
## SYNOPSIS
1717

18-
This cmdlet enables admin to trigger the build of a new Enterprise Application Insights report for the last N days.
18+
This cmdlet enables administrator to trigger the build of a new enterprise application insights report for the last N days.
1919

2020
## SYNTAX
2121

2222
```powershell
23-
Start-SPOEnterpriseAppInsightsReport [-Force <SwitchParameter>] [-ReportPeriodInDays <Int>]
23+
Start-SPOEnterpriseAppInsightsReport [-ReportPeriodInDays <Int>] [-Force <SwitchParameter>]
2424
```
2525

2626
## DESCRIPTION
2727

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-
| Property | Description |
30-
| :------------------- | :--------------------------------------- |
31-
| Id | The unique Id of the report. |
32-
| CreatedDateTimeInUtc | The Date and Time the report creation was triggered in UTC. |
33-
| Status | The Status of the report. |
34-
| ReportPeriodInDays | The report duration in days. |
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. |
3536

3637
## EXAMPLES
3738

@@ -41,43 +42,43 @@ After this cmdlet is executed, the Enterprise Application Insights report genera
4142
Start-SPOEnterpriseAppInsightsReport
4243
```
4344

44-
Example 1 generates the Enterprise Application Insights report for a default duration of 1 day as the parameter `–ReportPeriodInDays` is not provided.
45+
Example 1 generates the enterprise application insights report for a default duration of 1 day as the parameter `–ReportPeriodInDays` is not provided.
4546

4647
### -----------------------EXAMPLE 2-----------------------------
4748

4849
```powershell
4950
Start-SPOEnterpriseAppInsightsReport –ReportPeriodInDays 14
5051
```
5152

52-
Example 2 generates the Enterprise Application Insights report for a specified duration of 14 days.
53+
Example 2 generates the enterprise application insights report for a specified duration of 14 days.
5354

5455
## PARAMETERS
5556

56-
### -Force
57+
### -ReportPeriodInDays
5758

58-
It is an optional parameter which is used to bypass confirmation prompts and execute the command without interruptions.
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.
5960

6061
```yaml
61-
Type: SwitchParameter
62+
Type: Int
6263
Parameter Sets: (All)
63-
Aliases:
64+
Aliases:
6465
Applicable: SharePoint Online
6566

6667
Required: False
6768
Position: Named
6869
Default value: None
6970
Accept pipeline input: False
70-
Accept wildcard characters: False
71+
Accept wildcard characters: False
7172
```
7273
73-
### -ReportPeriodInDays
74+
### -Force
7475
75-
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.
76+
It is an optional parameter which is used to bypass confirmation prompts and execute the command without interruptions.
7677
7778
```yaml
78-
Type: Int
79+
Type: SwitchParameter
7980
Parameter Sets: (All)
80-
Aliases:
81+
Aliases:
8182
Applicable: SharePoint Online
8283

8384
Required: False
@@ -87,12 +88,12 @@ Accept pipeline input: False
8788
Accept wildcard characters: False
8889
```
8990
90-
## CommonParameters
91+
### CommonParameters
9192
9293
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).
9394

9495
## Related Links
9596

96-
[Get started with SharePoint Online Management Shell](https://learn.microsoft.com/en-us/powershell/sharepoint/sharepoint-online/connect-sharepoint-online)
97+
[Getting started with SharePoint Online Management Shell](/powershell/sharepoint/sharepoint-online/connect-sharepoint-online)
9798

98-
[Get-SPOEnterpriseAppInsightsReport](./Start-SPOEnterpriseAppInsightsReport.md)
99+
[Get-SPOEnterpriseAppInsightsReport](./Get-SPOEnterpriseAppInsightsReport.md)

0 commit comments

Comments
 (0)