add Related Links and CommonParameters

add Related Links and CommonParameters to the cmdlet docs.

Author: Shweta2024

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

@@ -3,8 +3,8 @@ external help file: sharepointonline.xml
 Module Name: Microsoft.Online.SharePoint.PowerShell
 online version: 
 applicable: SharePoint Online
-title: Start-SPOEnterpriseAppInsightsReport
-schema: 
+title: Get-SPOEnterpriseAppInsightsReport
+schema: 2.0.0
 author: sumikumar
 ms.author: sumikumar
 ms.reviewer:
@@ -15,17 +15,25 @@ manager: hikakar
 
 ## SYNOPSIS
 
-This cmdlet enables the admin to check status of all active & available reports when no report ID is present and to View a Report if report ID is present.
+This cmdlet enables the admin to check status of all active and available reports when no report ID is present and to View a Report if report ID is present.
 
 ## SYNTAX
 
 ```powershell
-Get-SPOEnterpriseAppInsightsReport [-ReportId<Guid>] [-Action<enum>]
+Get-SPOEnterpriseAppInsightsReport [-ReportId <Guid>] [-Action <enum>]
 ```
 
 ## Description
 
-After this cmdlet is executed, the report of last N days will be displayed with the following properties:
+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:
+| 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.       |
+
+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:
 | Property             | Description                              |
 | :------------------- | :--------------------------------------- |
 | SiteName | The name of the SharePoint Site.                    |
@@ -34,6 +42,8 @@ After this cmdlet is executed, the report of last N days will be displayed with
 | AppID | The AppID of the 3P App.       |
 | AppPermissions| The Permissions granted to the 3P App. |
 | RequestVoulme | The number of times the 3P accessed the given SharePoint Site.          |
+
+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.
 
 ## Example
 
@@ -43,23 +53,23 @@ After this cmdlet is executed, the report of last N days will be displayed with
 Get-SPOEnterpriseAppInsightsReport
 ```
 
-Example 1 enables admin to view latest reportID and corresponding status for each duration and adhering to any retention timeline as per DAG.
+Example 1 enables admin to view the status of all active and completed reports (adhering to any retention timeline as per DAG).
 
 ### -----------------------EXAMPLE 2-----------------------------
 
 ```powershell
-Get-SPOEnterpriseAppInsightsReport – ReportId 9d946216-afe7-49f5-8267-7b662435c70b
+Get-SPOEnterpriseAppInsightsReport –ReportId 9d946216-afe7-49f5-8267-7b662435c70b
 ```
 
-Example 2 enables admin to view the app insights report of ReportId: 9d946216-afe7-49f5-8267-7b662435c70b
+Example 2 enables admin to view the Enterprise Application Insights report of ReportId: `9d946216-afe7-49f5-8267-7b662435c70b`
 
 ### -----------------------EXAMPLE 3-----------------------------
 
 ```powershell
 Get-SPOEnterpriseAppInsightsReport – ReportId 9d946216-afe7-49f5-8267-7b662435c70b -Action Download
 ```
 
-Example 3 enables admin to download the app insights report of ReportId: 9d946216-afe7-49f5-8267-7b662435c70b
+Example 3 enables admin to download the Enterprise Application Insights report of ReportId: `9d946216-afe7-49f5-8267-7b662435c70b`.
 
 ## PARAMETERS
 
@@ -73,7 +83,7 @@ Parameter Sets: (All)
 Aliases:
 Applicable: SharePoint Online
 
-Required: True
+Required: False
 Position: Named
 Default value: None
 Accept pipeline input: False
@@ -90,7 +100,7 @@ Parameter Sets: (All)
 Aliases:
 Applicable: SharePoint Online
 
-Required: True
+Required: False
 Position: Named
 Default value: None
 Accept pipeline input: False
@@ -99,4 +109,10 @@ 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](https://go.microsoft.com/fwlink/?LinkID=113216).
+
 ## Related Links
+
+[Get started with SharePoint Online Management Shell](https://learn.microsoft.com/en-us/powershell/sharepoint/sharepoint-online/connect-sharepoint-online)
+
+[Start-SPOEnterpriseAppInsightsReport](https://learn.microsoft.com/en-us/powershell/sharepoint/sharepoint-online/start-spoenterpriseappinsightsreport)

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

@@ -4,7 +4,7 @@ Module Name: Microsoft.Online.SharePoint.PowerShell
 online version: 
 applicable: SharePoint Online
 title: Start-SPOEnterpriseAppInsightsReport
-schema: 
+schema: 2.0.0
 author: sumikumar
 ms.author: sumikumar
 ms.reviewer:
@@ -15,17 +15,17 @@ manager: hikakar
 
 ## SYNOPSIS
 
-This cmdlet enables admin to trigger the build of a new third party application insights report for the last N days.
+This cmdlet enables admin to trigger the build of a new Enterprise Application Insights report for the last N days.
 
 ## SYNTAX
 
 ```powershell
-Start-SPOEnterpriseAppInsightsReport [-Force<SwitchParameter>] [-ReportPeriodInDays <Int>] 
+Start-SPOEnterpriseAppInsightsReport [-Force <SwitchParameter>] [-ReportPeriodInDays <Int>] 
 ```
 
 ## Description
 
-After this cmdlet is executed, the report generation request for the last N days gets queued in the pipeline and the below metadata is displayed with the following properties:
+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.                    |
@@ -41,26 +41,28 @@ After this cmdlet is executed, the report generation request for the last N days
 Start-SPOEnterpriseAppInsightsReport
 ```
 
-Example 1 generates the report for a default duration of 1 day as the parameter ```–ReportPeriodInDays``` is not provided.
+Example 1 generates the Enterprise Application Insights report for a default duration of 1 day as the parameter `–ReportPeriodInDays` is not provided.
 
 ### -----------------------EXAMPLE 2-----------------------------
 
 ```powershell
 Start-SPOEnterpriseAppInsightsReport –ReportPeriodInDays 14
 ```
-Example 2 generates the report for a specified duration of 14 days.
+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.
+
 ```yaml
 Type: SwitchParameter
 Parameter Sets: (All)
-Aliases:
+Aliases: 
 Applicable: SharePoint Online
 
-Required: True
+Required: False
 Position: Named
 Default value: None
 Accept pipeline input: False
@@ -69,16 +71,15 @@ Accept wildcard characters: False
 
 ### -ReportPeriodInDays
 
-It is an optional parameter, and it specifies the duration of the report in days.
-The possible values of ReportPeriodInDays are: 1,7, 14, 28.
+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.
 
- ```yaml
+```yaml
 Type: Int
 Parameter Sets: (All)
 Aliases:
 Applicable: SharePoint Online
 
-Required: True
+Required: False
 Position: Named
 Default value: None
 Accept pipeline input: False
@@ -87,4 +88,10 @@ 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](https://go.microsoft.com/fwlink/?LinkID=113216).
+
 ## Related Links
+
+[Get started with SharePoint Online Management Shell](https://learn.microsoft.com/en-us/powershell/sharepoint/sharepoint-online/connect-sharepoint-online)
+
+[Get-SPOEnterpriseAppInsightsReport](https://learn.microsoft.com/en-us/powershell/sharepoint/sharepoint-online/get-spoenterpriseappinsightsreport)