From 3355b2c4c915655b926781db32b751944b4512a4 Mon Sep 17 00:00:00 2001 From: Gautam Chaudhary <224857719+starringGTM@users.noreply.github.com> Date: Wed, 6 Aug 2025 20:14:20 -0700 Subject: [PATCH 01/13] Added docs for M365 Agent Insights cmdlets. --- .../Get-SPOM365AgentAccessInsightsReport.md | 180 ++++++++++++++++++ .../Start-SPOM365AgentAccessInsightsReport.md | 145 ++++++++++++++ 2 files changed, 325 insertions(+) create mode 100644 sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Get-SPOM365AgentAccessInsightsReport.md create mode 100644 sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Start-SPOM365AgentAccessInsightsReport.md diff --git a/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Get-SPOM365AgentAccessInsightsReport.md b/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Get-SPOM365AgentAccessInsightsReport.md new file mode 100644 index 000000000..3042bb98f --- /dev/null +++ b/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Get-SPOM365AgentAccessInsightsReport.md @@ -0,0 +1,180 @@ +--- +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 ] [-Action ] + [-Content ] [] +``` + +## 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 M365 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 M365 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) diff --git a/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Start-SPOM365AgentAccessInsightsReport.md b/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Start-SPOM365AgentAccessInsightsReport.md new file mode 100644 index 000000000..6e5f90627 --- /dev/null +++ b/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 ] [-WhatIf] [-Confirm] + [] +``` + +## 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) \ No newline at end of file From 9ef5efc06bf9401a94256f1db767f71e1975d78a Mon Sep 17 00:00:00 2001 From: Gautam Chaudhary <224857719+starringGTM@users.noreply.github.com> Date: Wed, 6 Aug 2025 20:25:23 -0700 Subject: [PATCH 02/13] Update Get-SPOM365AgentAccessInsightsReport.md --- .../Get-SPOM365AgentAccessInsightsReport.md | 15 ++++++++------- 1 file changed, 8 insertions(+), 7 deletions(-) diff --git a/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Get-SPOM365AgentAccessInsightsReport.md b/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Get-SPOM365AgentAccessInsightsReport.md index 3042bb98f..8580a1de8 100644 --- a/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Get-SPOM365AgentAccessInsightsReport.md +++ b/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Get-SPOM365AgentAccessInsightsReport.md @@ -24,7 +24,7 @@ This cmdlet enables the administrator to check status of all active and availabl ``` Get-SPOM365AgentAccessInsightsReport [-ReportId ] [-Action ] - [-Content ] [] + [-Content ] [] ``` ## DESCRIPTION @@ -120,13 +120,13 @@ The list of Agent Details would have follwing properties for each agent. This li | 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 M365 agents distribution across sites in the specified number of days will be displayed with the following properties: +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 M365 agents on the SharePoint site corresponding to that particular site template. | +| 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 @@ -178,3 +178,4 @@ This cmdlet supports the common parameters: `-Debug`, `-ErrorAction`, `-ErrorVar [Getting started with SharePoint Online Management Shell](/powershell/sharepoint/sharepoint-online/connect-sharepoint-online) [Start-SPOM365AgentAccessInsightsReport](./Start-SPOM365AgentAccessInsightsReport.md) + From 8a5c973bf40e3f14919ce61d878fa68daecec58b Mon Sep 17 00:00:00 2001 From: Gautam Chaudhary <224857719+starringGTM@users.noreply.github.com> Date: Mon, 18 Aug 2025 12:00:50 +0530 Subject: [PATCH 03/13] Update Get-SPOM365AgentAccessInsightsReport.md --- .../Get-SPOM365AgentAccessInsightsReport.md | 55 +++---------------- 1 file changed, 9 insertions(+), 46 deletions(-) diff --git a/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Get-SPOM365AgentAccessInsightsReport.md b/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Get-SPOM365AgentAccessInsightsReport.md index 8580a1de8..dc083d868 100644 --- a/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Get-SPOM365AgentAccessInsightsReport.md +++ b/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Get-SPOM365AgentAccessInsightsReport.md @@ -15,7 +15,7 @@ manager: lokeshgoel ## 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. +This cmdlet enables the administrator to check status of all active and available analytics 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. @@ -29,15 +29,7 @@ Get-SPOM365AgentAccessInsightsReport [-ReportId ] [-Action ] ## 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. | - +If this cmdlet is executed without any parameters, it displays the status of all active and completed reports. > [!NOTE] > All reports adhere to any retention timeline as per [Data Access Governance](/sharepoint/data-access-governance-reports). @@ -49,7 +41,7 @@ If this cmdlet is executed without any parameters, it displays the status of all Get-SPOM365AgentAccessInsightsReport ``` -Example 1 enables administrator to view the status of all active and completed reports. +Example 1 enables administrator to view the status of all active and completed analytics reports. ### EXAMPLE 2 @@ -57,7 +49,7 @@ Example 1 enables administrator to view the status of all active and completed r 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 2 enables administrator to view the M365 agent insight report of the given report id. ### EXAMPLE 3 @@ -65,7 +57,7 @@ Example 2 enables administrator to view the M365 agent insight report of ReportI 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. +Example 3 enables administrator to download the M365 agent insight report of the given report id to the same path from where the command was run. ## PARAMETERS @@ -94,39 +86,9 @@ Accept wildcard characters: False 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. | +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. + +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. ```yaml Type: Microsoft.Online.SharePoint.TenantAdministration.SPOM365AgentInsightType @@ -179,3 +141,4 @@ This cmdlet supports the common parameters: `-Debug`, `-ErrorAction`, `-ErrorVar [Start-SPOM365AgentAccessInsightsReport](./Start-SPOM365AgentAccessInsightsReport.md) + From 558b915904fe3c02d5fd9746040f5b66eaa0ac8e Mon Sep 17 00:00:00 2001 From: Gautam Chaudhary <224857719+starringGTM@users.noreply.github.com> Date: Mon, 18 Aug 2025 12:07:07 +0530 Subject: [PATCH 04/13] Update Start-SPOM365AgentAccessInsightsReport.md --- .../Start-SPOM365AgentAccessInsightsReport.md | 12 +++--------- 1 file changed, 3 insertions(+), 9 deletions(-) diff --git a/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Start-SPOM365AgentAccessInsightsReport.md b/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Start-SPOM365AgentAccessInsightsReport.md index 6e5f90627..d7026e971 100644 --- a/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Start-SPOM365AgentAccessInsightsReport.md +++ b/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Start-SPOM365AgentAccessInsightsReport.md @@ -29,14 +29,7 @@ Start-SPOM365AgentAccessInsightsReport [-Force] [-ReportPeriodInDays ] [- ## 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. | +After executing this cmdlet, the M365 agent insight report generation request for the specified number of days is added to the pipeline queue. ## EXAMPLES @@ -142,4 +135,5 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable [Getting started with SharePoint Online Management Shell](/powershell/sharepoint/sharepoint-online/connect-sharepoint-online) -[Get-SPOM365AgentAccessInsightsReport](./Get-SPOM365AgentAccessInsightsReport) \ No newline at end of file + +[Get-SPOM365AgentAccessInsightsReport](./Get-SPOM365AgentAccessInsightsReport) From a731608fc6331cc4439271307f71171186d112a5 Mon Sep 17 00:00:00 2001 From: Gautam Chaudhary <224857719+starringGTM@users.noreply.github.com> Date: Fri, 22 Aug 2025 17:47:30 +0530 Subject: [PATCH 05/13] Revise Get-SPOM365AgentAccessInsightsReport.md --- .../Get-SPOM365AgentAccessInsightsReport.md | 13 +++++-------- 1 file changed, 5 insertions(+), 8 deletions(-) diff --git a/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Get-SPOM365AgentAccessInsightsReport.md b/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Get-SPOM365AgentAccessInsightsReport.md index dc083d868..8010f5931 100644 --- a/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Get-SPOM365AgentAccessInsightsReport.md +++ b/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Get-SPOM365AgentAccessInsightsReport.md @@ -5,10 +5,9 @@ online version: https://learn.microsoft.com/powershell/module/sharepoint-online/ applicable: SharePoint Online title: Get-SPOM365AgentAccessInsightsReport schema: 2.0.0 -author: gchaudhary +author: starringGTM ms.author: gchaudhary ms.reviewer: -manager: lokeshgoel --- # Get-SPOM365AgentAccessInsightsReport @@ -49,7 +48,7 @@ Example 1 enables administrator to view the status of all active and completed a Get-SPOM365AgentAccessInsightsReport –ReportId 9d946216-afe7-49f5-8267-7b662435c70b ``` -Example 2 enables administrator to view the M365 agent insight report of the given report id. +Example 2 enables administrator to view the Microsoft 365 agent insight report of the given report ID. ### EXAMPLE 3 @@ -57,7 +56,7 @@ Example 2 enables administrator to view the M365 agent insight report of the giv Get-SPOM365AgentAccessInsightsReport – ReportId 9d946216-afe7-49f5-8267-7b662435c70b -Action Download ``` -Example 3 enables administrator to download the M365 agent insight report of the given report id to the same path from where the command was run. +Example 3 enables administrator to download the Microsoft 365 agent insight report of the given report ID to the same path from where the command was run. ## PARAMETERS @@ -84,7 +83,7 @@ Accept wildcard characters: False > Applicable: SharePoint Online -It specifies the kind of report to view or download. There are 2 kinds of sub-reports: M365AgentsOnSites, SiteDistribution. +It specifies the kind of report to view or download. 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. @@ -107,7 +106,7 @@ Accept wildcard characters: False > Applicable: SharePoint Online -It specifies the unique Id of the report to be viewed or downloaded. +It specifies the unique ID of the report to be viewed or downloaded. ```yaml Type: System.Guid @@ -140,5 +139,3 @@ This cmdlet supports the common parameters: `-Debug`, `-ErrorAction`, `-ErrorVar [Getting started with SharePoint Online Management Shell](/powershell/sharepoint/sharepoint-online/connect-sharepoint-online) [Start-SPOM365AgentAccessInsightsReport](./Start-SPOM365AgentAccessInsightsReport.md) - - From f13a0cb8e7f41e5d5546ad667cf36f6c4a5759c7 Mon Sep 17 00:00:00 2001 From: Gautam Chaudhary <224857719+starringGTM@users.noreply.github.com> Date: Fri, 22 Aug 2025 17:48:19 +0530 Subject: [PATCH 06/13] Revise author and cmdlet details in documentation Updated author information and corrected cmdlet description. --- .../Start-SPOM365AgentAccessInsightsReport.md | 9 ++++----- 1 file changed, 4 insertions(+), 5 deletions(-) diff --git a/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Start-SPOM365AgentAccessInsightsReport.md b/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Start-SPOM365AgentAccessInsightsReport.md index d7026e971..b4aa588ff 100644 --- a/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Start-SPOM365AgentAccessInsightsReport.md +++ b/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Start-SPOM365AgentAccessInsightsReport.md @@ -5,17 +5,16 @@ online version: https://learn.microsoft.com/powershell/module/sharepoint-online/ applicable: SharePoint Online title: Start-SPOM365AgentAccessInsightsReport schema: 2.0.0 -author: gchaudhary +author: starringGTM 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. +Using this cmdlet, administrators may trigger the build of a new Microsoft 365 agent insight report for the specified number of days. > [!NOTE] > The feature associated with this cmdlet will be rolling out soon. @@ -29,7 +28,7 @@ Start-SPOM365AgentAccessInsightsReport [-Force] [-ReportPeriodInDays ] [- ## DESCRIPTION -After executing this cmdlet, the M365 agent insight report generation request for the specified number of days is added to the pipeline queue. +After executing this cmdlet, the Microsoft 365 agent insight report generation request for the specified number of days is added to the pipeline queue. ## EXAMPLES @@ -39,7 +38,7 @@ After executing this cmdlet, the M365 agent insight report generation request fo 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 1 generates the Microsoft 365 agent insight report for a default duration of 1 day since the parameter `–ReportPeriodInDays` is not provided. ### EXAMPLE 2 From 3915c8fce933fe47229a48ec8133be05cc16ffc7 Mon Sep 17 00:00:00 2001 From: Gautam Chaudhary <224857719+starringGTM@users.noreply.github.com> Date: Mon, 25 Aug 2025 02:25:45 -0700 Subject: [PATCH 07/13] Add documentation for new M365 Agent Insights cmdlets --- .../Microsoft.Online.SharePoint.PowerShell.md | 6 ++++++ 1 file changed, 6 insertions(+) diff --git a/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Microsoft.Online.SharePoint.PowerShell.md b/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Microsoft.Online.SharePoint.PowerShell.md index fe2ee5d96..f1daa175a 100644 --- a/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Microsoft.Online.SharePoint.PowerShell.md +++ b/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Microsoft.Online.SharePoint.PowerShell.md @@ -231,6 +231,9 @@ Gets the status for a file version expiration report generation job for a docume ### [Get-SPOListVersionPolicy](Get-SPOListVersionPolicy.md) Gets the version policy setting on the document library. +### [Get-SPOM365AgentAccessInsightsReport](Get-SPOM365AgentAccessInsightsReport.md) +This cmdlet enables the administrator to check status of all active and available Microsoft 365 Agent Insights 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. + ### [Get-SPOMalwareFile](Get-SPOMalwareFile.md) Extracts and displays the malware-related information of an infected file stored in SharePoint. @@ -774,6 +777,9 @@ This cmdlet enables administrator to trigger the build of a new enterprise appli ### [Start-SPOInformationBarriersInsightsReport](Start-SPOInformationBarriersInsightsReport.md) Generates a new report to identify and discover the usage patterns of Information Barriers (IB) across SharePoint sites and OneDrive accounts in the organization. +### [Start-SPOM365AgentAccessInsightsReport](Start-SPOM365AgentAccessInsightsReport.md) +Using this cmdlet, administrators may trigger the build of a new Microsoft 365 agent insight report for the specified number of days. > [!NOTE] > The feature associated with this cmdlet will be rolling out soon. + ### [Start-SPORestrictedAccessForSitesInsights](Start-SPORestrictedAccessForSitesInsights.md) This cmdlet enables administrator to trigger the build of a new restricted access control insights report for the data from last 28 days. From 4d555c406535e16a40b86afc2f8da22e7896cfa8 Mon Sep 17 00:00:00 2001 From: bishalgautam-microsoft Date: Thu, 4 Sep 2025 14:27:13 +0100 Subject: [PATCH 08/13] Add documentation for IsAuthoritative site property filter --- .../Get-SPOSite.md | 20 ++++++++++++++++++- 1 file changed, 19 insertions(+), 1 deletion(-) diff --git a/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Get-SPOSite.md b/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Get-SPOSite.md index e7e61be79..734b47dcf 100644 --- a/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Get-SPOSite.md +++ b/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Get-SPOSite.md @@ -236,7 +236,7 @@ Accept wildcard characters: False > Applicable: SharePoint Online Specifies the script block of the server-side filter to apply. The type must be a valid filter name and value must be in the form `{ PropertyName "filterValue"}`. Valid operators are as follows: -eq, -ne, -like, -notlike. - Currently, you can filter by these properties: Owner, Template (can be used to filter if it is the only property present in the filter), LockState, Url. + Currently, you can filter by these properties: Owner, Template (can be used to filter if it is the only property present in the filter), LockState, Url, IsAuthoritative (It only supports comparision operators -eq and -ne. For eg: `{IsAuthoritative -eq true}`). Using the -or operator to include an additional filter is not supported. Note: The operator values are case-sensitive. @@ -311,6 +311,24 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -IsAuthoritative + +> Applicable: SharePoint Online + +Displays sites which are have true value for IsAuthoritative site property when value is set to $true. The 'IsAuthoritaive' site property signals to Microsoft Search, Copilot(BizChat), and other AI agents that the site's content is official, trusted, and verified. This designation enhances content discoverability and increases user confidence in AI-generated responses. + +```yaml +Type: Boolean +Parameter Sets: ParamSet1 +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -Limit > Applicable: SharePoint Online From ff413d8b6ccc67854b4a71445826f9e1bc4c8bd8 Mon Sep 17 00:00:00 2001 From: bishalgautam-microsoft Date: Thu, 4 Sep 2025 15:05:34 +0100 Subject: [PATCH 09/13] updated description of the filter --- .../Microsoft.Online.SharePoint.PowerShell/Get-SPOSite.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Get-SPOSite.md b/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Get-SPOSite.md index 734b47dcf..a351c7c35 100644 --- a/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Get-SPOSite.md +++ b/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Get-SPOSite.md @@ -315,7 +315,7 @@ Accept wildcard characters: False > Applicable: SharePoint Online -Displays sites which are have true value for IsAuthoritative site property when value is set to $true. The 'IsAuthoritaive' site property signals to Microsoft Search, Copilot(BizChat), and other AI agents that the site's content is official, trusted, and verified. This designation enhances content discoverability and increases user confidence in AI-generated responses. +Filter the list of sites where the IsAuthoritative property is set to true. When IsAuthoritative is true, it signals to Microsoft Search, Copilot (BizChat), and other AI agents that the site's content is official, trusted, and verified. ```yaml Type: Boolean From a7647d98a818b73ec1403421705af050f01184cb Mon Sep 17 00:00:00 2001 From: Gautam Chaudhary <224857719+starringGTM@users.noreply.github.com> Date: Fri, 5 Sep 2025 02:23:28 +0530 Subject: [PATCH 10/13] Update Start-SPOM365AgentAccessInsightsReport.md --- .../Start-SPOM365AgentAccessInsightsReport.md | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Start-SPOM365AgentAccessInsightsReport.md b/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Start-SPOM365AgentAccessInsightsReport.md index b4aa588ff..ad6ad8249 100644 --- a/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Start-SPOM365AgentAccessInsightsReport.md +++ b/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Start-SPOM365AgentAccessInsightsReport.md @@ -135,4 +135,5 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable [Getting started with SharePoint Online Management Shell](/powershell/sharepoint/sharepoint-online/connect-sharepoint-online) -[Get-SPOM365AgentAccessInsightsReport](./Get-SPOM365AgentAccessInsightsReport) +[Get-SPOM365AgentAccessInsightsReport](./Get-SPOM365AgentAccessInsightsReport.md) + From 4bd74eee9e89cfadbecb4929710c9f0a6b525677 Mon Sep 17 00:00:00 2001 From: bishalgautam-microsoft Date: Fri, 5 Sep 2025 15:05:08 +0100 Subject: [PATCH 11/13] Example added and PR reviews addressed --- .../Get-SPOSite.md | 16 ++++++++++++---- 1 file changed, 12 insertions(+), 4 deletions(-) diff --git a/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Get-SPOSite.md b/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Get-SPOSite.md index a351c7c35..fd5511a7f 100644 --- a/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Get-SPOSite.md +++ b/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Get-SPOSite.md @@ -125,13 +125,21 @@ This example uses server side filtering to return sites matching 18. ### EXAMPLE 8 +```powershell +Get-SPOSite -Filter { IsAuthoritative -eq true } +``` + +This example uses server side filtering to return Authoritative sites (i.e., sites that have the IsAuthoritative property set to true). + +### EXAMPLE 9 + ```powershell Get-SPOSite -Limit ALL | ?{$_.IsTeamsConnected -eq $true} ``` This example uses client-side filtering to return a list of sites connected to Microsoft Teams. -### EXAMPLE 9 +### EXAMPLE 10 ```powershell Get-SPOSite -Limit ALL | ?{$_.IsTeamsChannelConnected -eq $true} @@ -139,14 +147,14 @@ Get-SPOSite -Limit ALL | ?{$_.IsTeamsChannelConnected -eq $true} This example uses client-side filtering to return a list of sites connected to a Microsoft Teams Private or Shared channel. -### EXAMPLE 10 +### EXAMPLE 11 ```powershell Get-SPOSite -Limit ALL -GroupIdDefined $true ``` This example uses server-side filtering to return all sites that have an associated Microsoft 365 Group. -### EXAMPLE 11 +### EXAMPLE 12 ```powershell $userUPN="joe.healy@contoso.com" @@ -236,7 +244,7 @@ Accept wildcard characters: False > Applicable: SharePoint Online Specifies the script block of the server-side filter to apply. The type must be a valid filter name and value must be in the form `{ PropertyName "filterValue"}`. Valid operators are as follows: -eq, -ne, -like, -notlike. - Currently, you can filter by these properties: Owner, Template (can be used to filter if it is the only property present in the filter), LockState, Url, IsAuthoritative (It only supports comparision operators -eq and -ne. For eg: `{IsAuthoritative -eq true}`). + Currently, you can filter by these properties: Owner, Template (can be used to filter if it is the only property present in the filter), LockState, Url, IsAuthoritative (only supports comparison operators -eq and -ne). Using the -or operator to include an additional filter is not supported. Note: The operator values are case-sensitive. From 396b3d5b1d1c63544ab19ab5e7ddc41d97ebf5fe Mon Sep 17 00:00:00 2001 From: bishalgautam-microsoft Date: Fri, 5 Sep 2025 15:23:51 +0100 Subject: [PATCH 12/13] Updated ParamSet1 as generated by New-MarkdownHelp command --- .../Microsoft.Online.SharePoint.PowerShell/Get-SPOSite.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Get-SPOSite.md b/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Get-SPOSite.md index fd5511a7f..71f9d4f1f 100644 --- a/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Get-SPOSite.md +++ b/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Get-SPOSite.md @@ -20,7 +20,7 @@ Returns one or more site collections. ### ParamSet1 (Default) ``` -Get-SPOSite [[-Identity] ] [-Limit ] [-Detailed] [] +Get-SPOSite [[-Identity] ] [-Limit ] [-Detailed] [-IsAuthoritative ] [] ``` ### ParamSet3 From ec8e73e0209861b088b0e607cafb4a67bbab2337 Mon Sep 17 00:00:00 2001 From: Ruchika Mittal Date: Fri, 5 Sep 2025 22:46:35 +0530 Subject: [PATCH 13/13] typo fix --- .../Microsoft.Online.SharePoint.PowerShell/Get-SPOSite.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Get-SPOSite.md b/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Get-SPOSite.md index 71f9d4f1f..4ac69b88e 100644 --- a/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Get-SPOSite.md +++ b/sharepoint/sharepoint-ps/Microsoft.Online.SharePoint.PowerShell/Get-SPOSite.md @@ -111,7 +111,7 @@ This example gets quota details for a Group Site. Get-SPOSite -Identity https://contoso.sharepoint.com/sites/research | Select InformationSegment ``` -This example returns the InformationSegments associated with the site. It is applicable for tenants who have enabled Microsoft 365 Information barriers capability. Read [Learn about information barriers](/microsoft-365/compliance/information-barriers) to understand Information barriers in SharePoint Online. +This example returns the InformationSegment associated with the site. It is applicable for tenants who have enabled Microsoft 365 Information barriers capability. Read [Learn about information barriers](/microsoft-365/compliance/information-barriers) to understand Information barriers in SharePoint Online. **Note**: This property is available only in SharePoint Online Management Shell Version 16.0.19927.12000 or later.