Added docs for M365 Agent Insights cmdlets.

sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Get-SPOM365AgentAccessInsightsReport.md

@@ -0,0 +1,181 @@
+---
+external help file: Microsoft.Online.SharePoint.PowerShell.dll-Help.xml
+Module Name: Microsoft.Online.SharePoint.PowerShell
+online version: https://learn.microsoft.com/powershell/module/sharepoint-online/get-SPOM365AgentAccessInsightsReport 
+applicable: SharePoint Online
+title: Get-SPOM365AgentAccessInsightsReport
+schema: 2.0.0
+author: gchaudhary
+ms.author: gchaudhary
+ms.reviewer:
+manager: lokeshgoel
+---
+
+# Get-SPOM365AgentAccessInsightsReport
+
+## SYNOPSIS
+
+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.
+
+> [!NOTE]
+> The feature associated with this cmdlet will be rolling out soon.
+
+## SYNTAX
+
+```
+Get-SPOM365AgentAccessInsightsReport [-ReportId <Guid>] [-Action <ActionType>]
+ [-Content <M365AgentsOnSites>] [<CommonParameters>]
+```
+
+## DESCRIPTION
+
+If this cmdlet is executed without any parameters, it displays the status of all active and completed reports with the following properties:
+
+| Property             | Description                                                      |
+|:---------------------|:-----------------------------------------------------------------|
+| Id                   | The unique Id of the report.                                     |
+| CreatedDateTimeInUtc | The date and time in UTC when the report creation was triggered. |
+| Status               | The status of the report.                                        |
+| ReportPeriodInDays   | The report duration in days.                                     |
+
+> [!NOTE]
+> All reports adhere to any retention timeline as per [Data Access Governance](/sharepoint/data-access-governance-reports).
+
+## EXAMPLES
+
+### EXAMPLE 1
+
+```powershell
+Get-SPOM365AgentAccessInsightsReport
+```
+
+Example 1 enables administrator to view the status of all active and completed reports.
+
+### EXAMPLE 2
+
+```powershell
+Get-SPOM365AgentAccessInsightsReport –ReportId 9d946216-afe7-49f5-8267-7b662435c70b
+```
+
+Example 2 enables administrator to view the M365 agent insight report of ReportId: `9d946216-afe7-49f5-8267-7b662435c70b`.
+
+### EXAMPLE 3
+
+```powershell
+Get-SPOM365AgentAccessInsightsReport – ReportId 9d946216-afe7-49f5-8267-7b662435c70b -Action Download
+```
+
+Example 3 enables administrator to download the M365 agent insight report of ReportId: `9d946216-afe7-49f5-8267-7b662435c70b` to the same path from where the command was run.
+
+## PARAMETERS
+
+### -Action
+
+> Applicable: SharePoint Online
+
+It determines whether a report would be viewed or downloaded. If the value of `-Action` is set as `View`, it will display the output on the PowerShell screen. Else if the value of `-Action` is set as `Download`, it will download the full report in CSV format to the same path from where the command was run.
+
+```yaml
+Type: ActionType
+Parameter Sets: (All)
+Aliases:
+Accepted values: View, Download
+
+Required: False
+Position: Named
+Default value: View
+Accept pipeline input: False
+Accept wildcard characters: False
+```
+
+### -Content
+
+> Applicable: SharePoint Online
+
+It specifies the kind of report to view or download. There are 2 kinds of sub-reports: M365AgentsOnSites, SiteDistribution.
+
+If this cmdlet is executed with `-Content` as `M365AgentsOnSites`, a report with list of all sites on which a agent is created along with the names of the agent created in the specified number of days will be displayed with the following properties:
+
+| Property                        | Description                                                     |
+|:--------------------------------|:----------------------------------------------------------------|
+| Site ID                         | The unique identifier (GUID) of the SharePoint site.            |
+| Site name                       | The name of the SharePoint site.                                |
+| URL                             | The URL of the SharePoint site.                                 |
+| Type                            | The type of the SharePoint site.                                |
+| Site owner                      | Name of the owner of the SharePoint site.                       |
+| Request Volume                  | Total requests made by agents to the site.                      |
+| Agents Found                    | Total agents found accessing the site.                          |
+| Restrict site access enabled    | Restrict site access status (Yes/No) of the SharePoint site.    |
+| Restrict site discovery enabled | Restrict site discovery status (Yes/No) of the SharePoint site. |
+| External sharing                | External Sharing status (Yes/No) of the SharePoint site.        |
+| Sensitivity                     | The sensitivity label of the SharePoint site.                   |
+| Agents Details                  | The list of agent details.                                      |
+
+The list of Agent Details would have follwing properties for each agent. This list would have a cap of 20 agents per site.
+
+| Property                        | Description                                                     |
+|:--------------------------------|:----------------------------------------------------------------|
+| Agent ID                        | The unique identifier of the agent.                             |
+| Agent Name                      | The name of the agent.                                          |
+| Agent Type                      | The type of the agent (e.g., Declarative, Custom, etc.)         |
+| Request Volume                  | Total requests made by this agent to the site.                  |
+
+If this cmdlet is executed with `-ReportId` as parameter and `-Content` as `SiteDistribution`, a report showing Microsoft 365 agents distribution across sites in the specified number of days will be displayed with the following properties:
+
+| Property       | Description                                                                                           |
+|:---------------|:------------------------------------------------------------------------------------------------------|
+| Site template  | The Site template of the SharePoint site.                                                             |
+| Sites          | Number of sites corresponding to that particular site template.                                       |
+| M365 agents    | Number of Microsoft 365 agents on the SharePoint site corresponding to that particular site template. |
+
+```yaml
+Type: Microsoft.Online.SharePoint.TenantAdministration.SPOM365AgentInsightType
+Parameter Sets: (All)
+Aliases:
+Accepted values: M365AgentsOnSites, SiteDistribution
+
+Required: False
+Position: Named
+Default value: M365AgentsOnSites
+Accept pipeline input: False
+Accept wildcard characters: False
+```
+
+### -ReportId
+
+> Applicable: SharePoint Online
+
+It specifies the unique Id of the report to be viewed or downloaded.
+
+```yaml
+Type: System.Guid
+Parameter Sets: (All)
+Aliases:
+
+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](https://go.microsoft.com/fwlink/?LinkID=113216).
+
+## INPUTS
+
+### None
+
+## OUTPUTS
+
+### System.Object
+
+## NOTES
+
+## RELATED LINKS
+
+[Getting started with SharePoint Online Management Shell](/powershell/sharepoint/sharepoint-online/connect-sharepoint-online)
+
+[Start-SPOM365AgentAccessInsightsReport](./Start-SPOM365AgentAccessInsightsReport.md)
+

sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Start-SPOM365AgentAccessInsightsReport.md

@@ -0,0 +1,145 @@
+---
+external help file: Microsoft.Online.SharePoint.PowerShell.dll-Help.xml
+Module Name: Microsoft.Online.SharePoint.PowerShell
+online version: https://learn.microsoft.com/powershell/module/sharepoint-online/start-spom365agentaccessinsightsreport
+applicable: SharePoint Online
+title: Start-SPOM365AgentAccessInsightsReport
+schema: 2.0.0
+author: gchaudhary
+ms.author: gchaudhary
+ms.reviewer:
+manager: lokeshgoel
+---
+
+ # Start-SPOM365AgentAccessInsightsReport
+
+## SYNOPSIS
+
+Using this cmdlet, administrators may trigger the build of a new M365 agent insight report for the specified number of days.
+
+> [!NOTE]
+> The feature associated with this cmdlet will be rolling out soon.
+
+## SYNTAX
+
+```
+Start-SPOM365AgentAccessInsightsReport [-Force] [-ReportPeriodInDays <Int32>] [-WhatIf] [-Confirm]
+ [<CommonParameters>]
+```
+
+## DESCRIPTION
+
+After this cmdlet is executed, the M365 agent insight report generation request for the specified number of 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 in UTC when the report creation was triggered. |
+| Status               | The status of the report.                                        |
+| ReportPeriodInDays   | The report duration in days.                                     |
+
+## EXAMPLES
+
+### EXAMPLE 1
+
+```powershell
+Start-SPOM365AgentAccessInsightsReport
+```
+
+Example 1 generates the M365 agent insight report for a default duration of 1 day since the parameter `–ReportPeriodInDays` is not provided.
+
+### EXAMPLE 2
+
+```powershell
+Start-SPOM365AgentAccessInsightsReport –ReportPeriodInDays 14
+```
+
+Example 2 generates the Copilot agent insight 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.
+
+```yaml
+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 specifies the duration of the M365 agent insight 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
+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.
+
+```yaml
+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.
+
+```yaml
+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](https://go.microsoft.com/fwlink/?LinkID=113216).
+
+## INPUTS
+
+### None
+
+## OUTPUTS
+
+### System.Object
+
+## NOTES
+
+## RELATED LINKS
+
+[Getting started with SharePoint Online Management Shell](/powershell/sharepoint/sharepoint-online/connect-sharepoint-online)
+
+[Get-SPOM365AgentAccessInsightsReport](./Get-SPOM365AgentAccessInsightsReport)