From ec78d611c13a7f5bafaad390ba838044aca17c82 Mon Sep 17 00:00:00 2001 From: Shweta Bhagat Date: Tue, 10 Dec 2024 18:07:23 +0530 Subject: [PATCH 1/6] add documentation for Copilot Insights Cmdlets Add public documentation for Copilot Insights Cmdlets --- .../Get-SPOCopilotAgentInsightsReport.md | 165 ++++++++++++++++++ .../Start-SPOCopilotAgentInsightsReport.md | 99 +++++++++++ 2 files changed, 264 insertions(+) create mode 100644 sharepoint/sharepoint-ps/sharepoint-online/Get-SPOCopilotAgentInsightsReport.md create mode 100644 sharepoint/sharepoint-ps/sharepoint-online/Start-SPOCopilotAgentInsightsReport.md diff --git a/sharepoint/sharepoint-ps/sharepoint-online/Get-SPOCopilotAgentInsightsReport.md b/sharepoint/sharepoint-ps/sharepoint-online/Get-SPOCopilotAgentInsightsReport.md new file mode 100644 index 000000000..4c9c279e7 --- /dev/null +++ b/sharepoint/sharepoint-ps/sharepoint-online/Get-SPOCopilotAgentInsightsReport.md @@ -0,0 +1,165 @@ +--- +external help file: sharepointonline.xml +Module Name: Microsoft.Online.SharePoint.PowerShell +online version: https://learn.microsoft.com/powershell/module/sharepoint-online/get-spocopilotagentinsightsreport +applicable: SharePoint Online +title: Get-SPOCopilotAgentInsightsReport +schema: 2.0.0 +author: bhagatshweta +ms.author: bhagatshweta +ms.reviewer: +manager: hikakar +--- + +# Get-SPOCopilotAgentInsightsReport + +## SYNOPSIS + + + +## SYNTAX + +```powershell +Get-SPOCopilotAgentInsightsReport [-ReportId ] [-Content ] [-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 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 and `-Content` as `CopilotAgentsOnSites`, a report with list of all sites on which a Copilot agent is created along with the names of the Copilot agent created in last N days will be displayed with the following properties: + +| Property | Description | +|:------------------------|:---------------------------------------------------------| +| Site name | The name of the SharePoint site. | +| URL | The URL of the SharePoint site. | +| Template | The Site template of the SharePoint site. | +| Site owner | Name of the owner of the SharePoint site. | +| Copilot name | Name of Copilot agent on the SharePoint site. | +| Sensitivity | The sensitivity label of the SharePoint site. | +| Restrict site access | RAC status (Yes/No) of the SharePoint site. | +| Restrict site discovery | RCD status (Yes/No) of the SharePoint site. | +| External sharing | External Sharing status (Yes/No) of the SharePoint site. | + +If this cmdlet is executed with `-ReportId` as parameter and `-Content` as `TopSites`, the top 100 records summarizing the number of Copilot Agents on sites created in last N days will be displayed with the following properties: + +| Property | Description | +|:------------------------|:---------------------------------------------------------| +| Site name | The name of the SharePoint site. | +| URL | The URL of the SharePoint site. | +| Template | The Site template of the SharePoint site. | +| Site owner | Name of the owner of the SharePoint site. | +| Copilot agents | Number of Copilot agents on the SharePoint site. | +| Sensitivity | The sensitivity label of the SharePoint site. | +| Restrict site access | RAC status (Yes/No) of the SharePoint site. | +| Restrict site discovery | RCD status (Yes/No) of the SharePoint site. | +| External sharing | External Sharing status (Yes/No) of the SharePoint site. | + +If this cmdlet is executed with `-ReportId` as parameter and `-Content` as `SiteDistribution`, a report showing Copilot distribution across sites in last N 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. | +| Copilot agents | Name of Copilot agent on the SharePoint site corresponding to that particular site template. | + +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. + +> [!NOTE] +> All reports adhere to any retention timeline as per [Data Access Governance](/sharepoint/data-access-governance-reports). + +## EXAMPLES + +### -----------------------EXAMPLE 1----------------------------- + +```powershell +Get-SPOCopilotAgentInsightsReport +``` + +Example 1 enables administrator to view the status of all active and completed reports. + +### -----------------------EXAMPLE 2----------------------------- + +```powershell +Get-SPOCopilotAgentInsightsReport –ReportId 9d946216-afe7-49f5-8267-7b662435c70b +``` + +Example 2 enables administrator to view the Copilot agent insights report of ReportId: `9d946216-afe7-49f5-8267-7b662435c70b`. + +### -----------------------EXAMPLE 3----------------------------- + +```powershell +Get-SPOCopilotAgentInsightsReport – ReportId 9d946216-afe7-49f5-8267-7b662435c70b -Action Download +``` + +Example 3 enables administrator to download the Copilot agent insights report of ReportId: `9d946216-afe7-49f5-8267-7b662435c70b` to the same path from where the command was run. + +## PARAMETERS + +### -ReportId + +It is an optional parameter, and it specifies the unique Id of the report to be viewed or downloaded. + +```yaml +Type: Guid +Parameter Sets: (All) +Aliases: +Applicable: SharePoint Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Content + +It is an optional parameter, and it specifies the kind of report to view or download. There are 3 kinds of sub-reports: CopilotAgentsOnSites, TopSites, SiteDistribution. + +```yaml +Type: SPOCopilotAgentInsightType +Parameter Sets: (All) +Aliases: +Applicable: SharePoint Online + +Required: False +Position: Named +Default value: CopilotAgentsOnSites +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Action + +It is an optional parameter, and it specifies whether to view or download a specific report. + +```yaml +Type: ActionType +Parameter Sets: (All) +Aliases: +Applicable: SharePoint Online + +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). + +## RELATED LINKS + +[Getting started with SharePoint Online Management Shell](/powershell/sharepoint/sharepoint-online/connect-sharepoint-online) + +[Start-SPOCopilotAgentInsightsReport](./Start-SPOCopilotAgentInsightsReport.md) \ No newline at end of file diff --git a/sharepoint/sharepoint-ps/sharepoint-online/Start-SPOCopilotAgentInsightsReport.md b/sharepoint/sharepoint-ps/sharepoint-online/Start-SPOCopilotAgentInsightsReport.md new file mode 100644 index 000000000..8ddee7526 --- /dev/null +++ b/sharepoint/sharepoint-ps/sharepoint-online/Start-SPOCopilotAgentInsightsReport.md @@ -0,0 +1,99 @@ +--- +external help file: sharepointonline.xml +Module Name: Microsoft.Online.SharePoint.PowerShell +online version: https://learn.microsoft.com/powershell/module/sharepoint-online/start-spocopilotagentinsightsreport +applicable: SharePoint Online +title: Start-SPOCopilotAgentInsightsReport +schema: 2.0.0 +author: bhagatshweta +ms.author: bhagatshweta +ms.reviewer: +manager: hikakar +--- + +# Start-SPOCopilotAgentInsightsReport + +## SYNOPSIS + +This cmdlet enables administrator to trigger the build of a new Copilot Agent Insight report for the last N days. + +## SYNTAX + +```powershell +Start-SPOCopilotAgentInsightsReport [-ReportPeriodInDays ] [-Force ] +``` + +## DESCRIPTION + +After this cmdlet is executed, the Copilot Agent Insight 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. | +| CreatedDateTimeInUtc | The date and time the report creation was triggered in UTC. | +| Status | The status of the report. | +| ReportPeriodInDays | The report duration in days. | + +## EXAMPLES + +### -----------------------EXAMPLE 1----------------------------- + +```powershell +Start-SPOCopilotAgentInsightsReport +``` + +Example 1 generates the Copilot agent insights report for a default duration of 1 day as the parameter `–ReportPeriodInDays` is not provided. + +### -----------------------EXAMPLE 2----------------------------- + +```powershell +Start-SPOCopilotAgentInsightsReport –ReportPeriodInDays 14 +``` + +Example 2 generates the Copilot Agent insights report for a specified duration of 14 days. + +## PARAMETERS + +### -ReportPeriodInDays + +It is an optional parameter, and it specifies the duration of the Copilot Agent 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 +Type: Int +Parameter Sets: (All) +Aliases: +Applicable: SharePoint Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -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: +Applicable: SharePoint Online + +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). + +## Related Links + +[Getting started with SharePoint Online Management Shell](/powershell/sharepoint/sharepoint-online/connect-sharepoint-online) + +[Get-SPOCopilotAgentInsightsReport](./Get-SPOCopilotAgentInsightsReport.md) \ No newline at end of file From d68ffa857f40fe72058d09fb57a0584e08a171bc Mon Sep 17 00:00:00 2001 From: Shweta Bhagat Date: Wed, 11 Dec 2024 10:38:09 +0530 Subject: [PATCH 2/6] resolve comments --- .../Get-SPOCopilotAgentInsightsReport.md | 86 +++++++++---------- .../Start-SPOCopilotAgentInsightsReport.md | 22 ++--- 2 files changed, 53 insertions(+), 55 deletions(-) diff --git a/sharepoint/sharepoint-ps/sharepoint-online/Get-SPOCopilotAgentInsightsReport.md b/sharepoint/sharepoint-ps/sharepoint-online/Get-SPOCopilotAgentInsightsReport.md index 4c9c279e7..e227d04a3 100644 --- a/sharepoint/sharepoint-ps/sharepoint-online/Get-SPOCopilotAgentInsightsReport.md +++ b/sharepoint/sharepoint-ps/sharepoint-online/Get-SPOCopilotAgentInsightsReport.md @@ -15,7 +15,7 @@ manager: hikakar ## 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. ## SYNTAX @@ -34,44 +34,6 @@ If this cmdlet is executed without any parameters, it displays the status of all | Status | The status of the report. | | ReportPeriodInDays | The report duration in days. | -If this cmdlet is executed with `-ReportId` as parameter and `-Content` as `CopilotAgentsOnSites`, a report with list of all sites on which a Copilot agent is created along with the names of the Copilot agent created in last N days will be displayed with the following properties: - -| Property | Description | -|:------------------------|:---------------------------------------------------------| -| Site name | The name of the SharePoint site. | -| URL | The URL of the SharePoint site. | -| Template | The Site template of the SharePoint site. | -| Site owner | Name of the owner of the SharePoint site. | -| Copilot name | Name of Copilot agent on the SharePoint site. | -| Sensitivity | The sensitivity label of the SharePoint site. | -| Restrict site access | RAC status (Yes/No) of the SharePoint site. | -| Restrict site discovery | RCD status (Yes/No) of the SharePoint site. | -| External sharing | External Sharing status (Yes/No) of the SharePoint site. | - -If this cmdlet is executed with `-ReportId` as parameter and `-Content` as `TopSites`, the top 100 records summarizing the number of Copilot Agents on sites created in last N days will be displayed with the following properties: - -| Property | Description | -|:------------------------|:---------------------------------------------------------| -| Site name | The name of the SharePoint site. | -| URL | The URL of the SharePoint site. | -| Template | The Site template of the SharePoint site. | -| Site owner | Name of the owner of the SharePoint site. | -| Copilot agents | Number of Copilot agents on the SharePoint site. | -| Sensitivity | The sensitivity label of the SharePoint site. | -| Restrict site access | RAC status (Yes/No) of the SharePoint site. | -| Restrict site discovery | RCD status (Yes/No) of the SharePoint site. | -| External sharing | External Sharing status (Yes/No) of the SharePoint site. | - -If this cmdlet is executed with `-ReportId` as parameter and `-Content` as `SiteDistribution`, a report showing Copilot distribution across sites in last N 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. | -| Copilot agents | Name of Copilot agent on the SharePoint site corresponding to that particular site template. | - -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. - > [!NOTE] > All reports adhere to any retention timeline as per [Data Access Governance](/sharepoint/data-access-governance-reports). @@ -91,7 +53,7 @@ Example 1 enables administrator to view the status of all active and completed r Get-SPOCopilotAgentInsightsReport –ReportId 9d946216-afe7-49f5-8267-7b662435c70b ``` -Example 2 enables administrator to view the Copilot agent insights report of ReportId: `9d946216-afe7-49f5-8267-7b662435c70b`. +Example 2 enables administrator to view the Copilot agent insight report of ReportId: `9d946216-afe7-49f5-8267-7b662435c70b`. ### -----------------------EXAMPLE 3----------------------------- @@ -99,13 +61,13 @@ Example 2 enables administrator to view the Copilot agent insights report of Rep Get-SPOCopilotAgentInsightsReport – ReportId 9d946216-afe7-49f5-8267-7b662435c70b -Action Download ``` -Example 3 enables administrator to download the Copilot agent insights 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 Copilot agent insight report of ReportId: `9d946216-afe7-49f5-8267-7b662435c70b` to the same path from where the command was run. ## PARAMETERS ### -ReportId -It is an optional parameter, and 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: Guid @@ -122,7 +84,43 @@ Accept wildcard characters: False ### -Content -It is an optional parameter, and it specifies the kind of report to view or download. There are 3 kinds of sub-reports: CopilotAgentsOnSites, TopSites, SiteDistribution. +It specifies the kind of report to view or download. There are 3 kinds of sub-reports: CopilotAgentsOnSites, TopSites, SiteDistribution. + +If this cmdlet is executed with `-Content` as `CopilotAgentsOnSites`, a report with list of all sites on which a Copilot agent is created along with the names of the Copilot agent created in the specified number of days will be displayed with the following properties: + +| Property | Description | +|:------------------------|:---------------------------------------------------------| +| Site name | The name of the SharePoint site. | +| URL | The URL of the SharePoint site. | +| Template | The Site template of the SharePoint site. | +| Site owner | Name of the owner of the SharePoint site. | +| Copilot name | Name of Copilot agent on the SharePoint site. | +| Sensitivity | The sensitivity label of the SharePoint site. | +| Restrict site access | RAC status (Yes/No) of the SharePoint site. | +| Restrict site discovery | RCD status (Yes/No) of the SharePoint site. | +| External sharing | External Sharing status (Yes/No) of the SharePoint site. | + +If this cmdlet is executed with `-ReportId` as parameter and `-Content` as `TopSites`, the top 100 records summarizing the number of Copilot Agents on sites created in the specified number of days will be displayed with the following properties: + +| Property | Description | +|:------------------------|:---------------------------------------------------------| +| Site name | The name of the SharePoint site. | +| URL | The URL of the SharePoint site. | +| Template | The Site template of the SharePoint site. | +| Site owner | Name of the owner of the SharePoint site. | +| Copilot agents | Number of Copilot agents on the SharePoint site. | +| Sensitivity | The sensitivity label of the SharePoint site. | +| Restrict site access | RAC status (Yes/No) of the SharePoint site. | +| Restrict site discovery | RCD status (Yes/No) of the SharePoint site. | +| External sharing | External Sharing status (Yes/No) of the SharePoint site. | + +If this cmdlet is executed with `-ReportId` as parameter and `-Content` as `SiteDistribution`, a report showing Copilot 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. | +| Copilot agents | Name of Copilot agent on the SharePoint site corresponding to that particular site template. | ```yaml Type: SPOCopilotAgentInsightType @@ -139,7 +137,7 @@ Accept wildcard characters: False ### -Action -It is an optional parameter, and it specifies whether to view or download a specific report. +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 diff --git a/sharepoint/sharepoint-ps/sharepoint-online/Start-SPOCopilotAgentInsightsReport.md b/sharepoint/sharepoint-ps/sharepoint-online/Start-SPOCopilotAgentInsightsReport.md index 8ddee7526..e52ca3cec 100644 --- a/sharepoint/sharepoint-ps/sharepoint-online/Start-SPOCopilotAgentInsightsReport.md +++ b/sharepoint/sharepoint-ps/sharepoint-online/Start-SPOCopilotAgentInsightsReport.md @@ -15,7 +15,7 @@ manager: hikakar ## SYNOPSIS -This cmdlet enables administrator to trigger the build of a new Copilot Agent Insight report for the last N days. +Using this commandlet, SPO Administrators may trigger the build of a new Copilot agent insight report for the specified number of days. ## SYNTAX @@ -25,14 +25,14 @@ Start-SPOCopilotAgentInsightsReport [-ReportPeriodInDays ] [-Force Date: Wed, 11 Dec 2024 12:00:11 +0530 Subject: [PATCH 3/6] update description of CreatedDateTimeInUtc --- .../Get-SPOCopilotAgentInsightsReport.md | 12 ++++++------ 1 file changed, 6 insertions(+), 6 deletions(-) diff --git a/sharepoint/sharepoint-ps/sharepoint-online/Get-SPOCopilotAgentInsightsReport.md b/sharepoint/sharepoint-ps/sharepoint-online/Get-SPOCopilotAgentInsightsReport.md index e227d04a3..8bc061803 100644 --- a/sharepoint/sharepoint-ps/sharepoint-online/Get-SPOCopilotAgentInsightsReport.md +++ b/sharepoint/sharepoint-ps/sharepoint-online/Get-SPOCopilotAgentInsightsReport.md @@ -27,12 +27,12 @@ Get-SPOCopilotAgentInsightsReport [-ReportId ] [-Content [!NOTE] > All reports adhere to any retention timeline as per [Data Access Governance](/sharepoint/data-access-governance-reports). From bc5b1ff13706f0e483b85dab9733e2f2121d089c Mon Sep 17 00:00:00 2001 From: Shweta Bhagat Date: Wed, 11 Dec 2024 12:12:57 +0530 Subject: [PATCH 4/6] update default values --- .../Get-SPOCopilotAgentInsightsReport.md | 46 +++++++++---------- .../Start-SPOCopilotAgentInsightsReport.md | 4 +- 2 files changed, 25 insertions(+), 25 deletions(-) diff --git a/sharepoint/sharepoint-ps/sharepoint-online/Get-SPOCopilotAgentInsightsReport.md b/sharepoint/sharepoint-ps/sharepoint-online/Get-SPOCopilotAgentInsightsReport.md index 8bc061803..d860f595b 100644 --- a/sharepoint/sharepoint-ps/sharepoint-online/Get-SPOCopilotAgentInsightsReport.md +++ b/sharepoint/sharepoint-ps/sharepoint-online/Get-SPOCopilotAgentInsightsReport.md @@ -88,31 +88,31 @@ It specifies the kind of report to view or download. There are 3 kinds of sub-re If this cmdlet is executed with `-Content` as `CopilotAgentsOnSites`, a report with list of all sites on which a Copilot agent is created along with the names of the Copilot agent created in the specified number of days will be displayed with the following properties: -| Property | Description | -|:------------------------|:---------------------------------------------------------| -| Site name | The name of the SharePoint site. | -| URL | The URL of the SharePoint site. | -| Template | The Site template of the SharePoint site. | -| Site owner | Name of the owner of the SharePoint site. | -| Copilot name | Name of Copilot agent on the SharePoint site. | -| Sensitivity | The sensitivity label of the SharePoint site. | -| Restrict site access | RAC status (Yes/No) of the SharePoint site. | -| Restrict site discovery | RCD status (Yes/No) of the SharePoint site. | -| External sharing | External Sharing status (Yes/No) of the SharePoint site. | +| Property | Description | +|:--------------------------------|:---------------------------------------------------------| +| Site name | The name of the SharePoint site. | +| URL | The URL of the SharePoint site. | +| Template | The Site template of the SharePoint site. | +| Site owner | Name of the owner of the SharePoint site. | +| Copilot name | Name of Copilot agent on the SharePoint site. | +| Sensitivity | The sensitivity label of the SharePoint site. | +| Restrict site access enabled | RAC status (Yes/No) of the SharePoint site. | +| Restrict site discovery enabled | RCD status (Yes/No) of the SharePoint site. | +| External sharing | External Sharing status (Yes/No) of the SharePoint site. | If this cmdlet is executed with `-ReportId` as parameter and `-Content` as `TopSites`, the top 100 records summarizing the number of Copilot Agents on sites created in the specified number of days will be displayed with the following properties: -| Property | Description | -|:------------------------|:---------------------------------------------------------| -| Site name | The name of the SharePoint site. | -| URL | The URL of the SharePoint site. | -| Template | The Site template of the SharePoint site. | -| Site owner | Name of the owner of the SharePoint site. | -| Copilot agents | Number of Copilot agents on the SharePoint site. | -| Sensitivity | The sensitivity label of the SharePoint site. | -| Restrict site access | RAC status (Yes/No) of the SharePoint site. | -| Restrict site discovery | RCD status (Yes/No) of the SharePoint site. | -| External sharing | External Sharing status (Yes/No) of the SharePoint site. | +| Property | Description | +|:--------------------------------|:---------------------------------------------------------| +| Site name | The name of the SharePoint site. | +| URL | The URL of the SharePoint site. | +| Template | The Site template of the SharePoint site. | +| Site owner | Name of the owner of the SharePoint site. | +| Copilot agents | Number of Copilot agents on the SharePoint site. | +| Sensitivity | The sensitivity label of the SharePoint site. | +| Restrict site access enabled | RAC status (Yes/No) of the SharePoint site. | +| Restrict site discovery enabled | RCD status (Yes/No) of the SharePoint site. | +| External sharing | External Sharing status (Yes/No) of the SharePoint site. | If this cmdlet is executed with `-ReportId` as parameter and `-Content` as `SiteDistribution`, a report showing Copilot distribution across sites in the specified number of days will be displayed with the following properties: @@ -147,7 +147,7 @@ Applicable: SharePoint Online Required: False Position: Named -Default value: None +Default value: View Accept pipeline input: False Accept wildcard characters: False ``` diff --git a/sharepoint/sharepoint-ps/sharepoint-online/Start-SPOCopilotAgentInsightsReport.md b/sharepoint/sharepoint-ps/sharepoint-online/Start-SPOCopilotAgentInsightsReport.md index e52ca3cec..dcff9067b 100644 --- a/sharepoint/sharepoint-ps/sharepoint-online/Start-SPOCopilotAgentInsightsReport.md +++ b/sharepoint/sharepoint-ps/sharepoint-online/Start-SPOCopilotAgentInsightsReport.md @@ -42,7 +42,7 @@ After this cmdlet is executed, the Copilot agent insight report generation reque Start-SPOCopilotAgentInsightsReport ``` -Example 1 generates the Copilot agent insight report for a default duration of 1 day as the parameter `–ReportPeriodInDays` is not provided. +Example 1 generates the Copilot agent insight report for a default duration of 1 day since the parameter `–ReportPeriodInDays` is not provided. ### -----------------------EXAMPLE 2----------------------------- @@ -66,7 +66,7 @@ Applicable: SharePoint Online Required: False Position: Named -Default value: None +Default value: 1 Accept pipeline input: False Accept wildcard characters: False ``` From c15bb3addc4e508ceec070eea43ffaed6c00111f Mon Sep 17 00:00:00 2001 From: Shweta Bhagat Date: Thu, 12 Dec 2024 06:31:58 +0530 Subject: [PATCH 5/6] add cmdlets to TOC --- .../Get-SPOCopilotAgentInsightsReport.md | 52 +++++++++---------- .../Start-SPOCopilotAgentInsightsReport.md | 2 +- .../sharepoint-online/sharepoint-online.md | 8 +++ 3 files changed, 35 insertions(+), 27 deletions(-) diff --git a/sharepoint/sharepoint-ps/sharepoint-online/Get-SPOCopilotAgentInsightsReport.md b/sharepoint/sharepoint-ps/sharepoint-online/Get-SPOCopilotAgentInsightsReport.md index d860f595b..a959bfa09 100644 --- a/sharepoint/sharepoint-ps/sharepoint-online/Get-SPOCopilotAgentInsightsReport.md +++ b/sharepoint/sharepoint-ps/sharepoint-online/Get-SPOCopilotAgentInsightsReport.md @@ -88,31 +88,31 @@ It specifies the kind of report to view or download. There are 3 kinds of sub-re If this cmdlet is executed with `-Content` as `CopilotAgentsOnSites`, a report with list of all sites on which a Copilot agent is created along with the names of the Copilot agent created in the specified number of days will be displayed with the following properties: -| Property | Description | -|:--------------------------------|:---------------------------------------------------------| -| Site name | The name of the SharePoint site. | -| URL | The URL of the SharePoint site. | -| Template | The Site template of the SharePoint site. | -| Site owner | Name of the owner of the SharePoint site. | -| Copilot name | Name of Copilot agent on the SharePoint site. | -| Sensitivity | The sensitivity label of the SharePoint site. | -| Restrict site access enabled | RAC status (Yes/No) of the SharePoint site. | -| Restrict site discovery enabled | RCD status (Yes/No) of the SharePoint site. | -| External sharing | External Sharing status (Yes/No) of the SharePoint site. | - -If this cmdlet is executed with `-ReportId` as parameter and `-Content` as `TopSites`, the top 100 records summarizing the number of Copilot Agents on sites created in the specified number of days will be displayed with the following properties: - -| Property | Description | -|:--------------------------------|:---------------------------------------------------------| -| Site name | The name of the SharePoint site. | -| URL | The URL of the SharePoint site. | -| Template | The Site template of the SharePoint site. | -| Site owner | Name of the owner of the SharePoint site. | -| Copilot agents | Number of Copilot agents on the SharePoint site. | -| Sensitivity | The sensitivity label of the SharePoint site. | -| Restrict site access enabled | RAC status (Yes/No) of the SharePoint site. | -| Restrict site discovery enabled | RCD status (Yes/No) of the SharePoint site. | -| External sharing | External Sharing status (Yes/No) of the SharePoint site. | +| Property | Description | +|:--------------------------------|:----------------------------------------------------------------| +| Site name | The name of the SharePoint site. | +| URL | The URL of the SharePoint site. | +| Template | The Site template of the SharePoint site. | +| Site owner | Name of the owner of the SharePoint site. | +| Copilot name | Name of Copilot agent on the SharePoint site. | +| Sensitivity | The sensitivity label of the SharePoint 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. | + +If this cmdlet is executed with `-ReportId` as parameter and `-Content` as `TopSites`, the top 100 records summarizing the number of Copilot agents on sites created in the specified number of days will be displayed with the following properties: + +| Property | Description | +|:--------------------------------|:----------------------------------------------------------------| +| Site name | The name of the SharePoint site. | +| URL | The URL of the SharePoint site. | +| Template | The Site template of the SharePoint site. | +| Site owner | Name of the owner of the SharePoint site. | +| Copilot agents | Number of Copilot agents on the SharePoint site. | +| Sensitivity | The sensitivity label of the SharePoint 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. | If this cmdlet is executed with `-ReportId` as parameter and `-Content` as `SiteDistribution`, a report showing Copilot distribution across sites in the specified number of days will be displayed with the following properties: @@ -120,7 +120,7 @@ If this cmdlet is executed with `-ReportId` as parameter and `-Content` as ` |:---------------|:---------------------------------------------------------------------------------------------| | Site template | The Site template of the SharePoint site. | | Sites | Number of sites corresponding to that particular site template. | -| Copilot agents | Name of Copilot agent on the SharePoint site corresponding to that particular site template. | +| Copilot agents | Number of Copilot agent on the SharePoint site corresponding to that particular site template. | ```yaml Type: SPOCopilotAgentInsightType diff --git a/sharepoint/sharepoint-ps/sharepoint-online/Start-SPOCopilotAgentInsightsReport.md b/sharepoint/sharepoint-ps/sharepoint-online/Start-SPOCopilotAgentInsightsReport.md index dcff9067b..928e5b8cf 100644 --- a/sharepoint/sharepoint-ps/sharepoint-online/Start-SPOCopilotAgentInsightsReport.md +++ b/sharepoint/sharepoint-ps/sharepoint-online/Start-SPOCopilotAgentInsightsReport.md @@ -15,7 +15,7 @@ manager: hikakar ## SYNOPSIS -Using this commandlet, SPO Administrators may trigger the build of a new Copilot agent insight report for the specified number of days. +Using this cmdlet, administrators may trigger the build of a new Copilot agent insight report for the specified number of days. ## SYNTAX diff --git a/sharepoint/sharepoint-ps/sharepoint-online/sharepoint-online.md b/sharepoint/sharepoint-ps/sharepoint-online/sharepoint-online.md index 3d29c0623..a635b89d3 100644 --- a/sharepoint/sharepoint-ps/sharepoint-online/sharepoint-online.md +++ b/sharepoint/sharepoint-ps/sharepoint-online/sharepoint-online.md @@ -99,6 +99,10 @@ The following cmdlet references are for SharePoint Online. {{Manually Enter Get-SPOAppInfo Description Here}} +### [Get-SPOCopilotAgentInsightsReport](Get-SPOCopilotAgentInsightsReport.md) + +{{Gets the status of all active and available reports when no report ID is present, and allows to view or download a report if report ID is present.}} + ### [Get-SPOCrossGeoMovedUsers](Get-SPOCrossGeoMovedUsers.md) {{Manually Enter Get-SPOCrossGeoMovedUsers Description Here}} @@ -608,6 +612,10 @@ This cmdlet is not currently active in production and may be removed in the futu {{Manually Enter Set-SPOUser Description Here}} +### [Start-SPOCopilotAgentInsightsReport](Start-SPOCopilotAgentInsightsReport.md) + +{{Triggers the build of a new Copilot agent insight report for the specified number of days.}} + ### [Start-SPOSiteContentMove](Start-SPOSiteContentMove.md) {{Manually Enter Start-SPOSiteContentMove Description Here}} From c2ae728762db20bbadbcea84dde9744b2f3521fa Mon Sep 17 00:00:00 2001 From: Shweta Bhagat Date: Thu, 12 Dec 2024 09:13:21 +0530 Subject: [PATCH 6/6] minor fix --- .../sharepoint-online/Get-SPOCopilotAgentInsightsReport.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/sharepoint/sharepoint-ps/sharepoint-online/Get-SPOCopilotAgentInsightsReport.md b/sharepoint/sharepoint-ps/sharepoint-online/Get-SPOCopilotAgentInsightsReport.md index a959bfa09..7e37aca69 100644 --- a/sharepoint/sharepoint-ps/sharepoint-online/Get-SPOCopilotAgentInsightsReport.md +++ b/sharepoint/sharepoint-ps/sharepoint-online/Get-SPOCopilotAgentInsightsReport.md @@ -120,7 +120,7 @@ If this cmdlet is executed with `-ReportId` as parameter and `-Content` as ` |:---------------|:---------------------------------------------------------------------------------------------| | Site template | The Site template of the SharePoint site. | | Sites | Number of sites corresponding to that particular site template. | -| Copilot agents | Number of Copilot agent on the SharePoint site corresponding to that particular site template. | +| Copilot agents | Number of Copilot agents on the SharePoint site corresponding to that particular site template. | ```yaml Type: SPOCopilotAgentInsightType