Skip to content

Commit 732046c

Browse files
Ruchika-mittal01Ruchika-mittal01
authored
Merge pull request #774 from Shweta2024/bhagatshweta-copilotinsights
Add documentation for the Copilot Insights Cmdlets
2 parents d787d19 + d50a7b4 commit 732046c

File tree

3 files changed

+270
-0
lines changed

3 files changed

+270
-0
lines changed

‎sharepoint/sharepoint-ps/sharepoint-online/Get-SPOCopilotAgentInsightsReport.md‎

Lines changed: 163 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,163 @@
1+
---
2+
external help file: sharepointonline.xml
3+
Module Name: Microsoft.Online.SharePoint.PowerShell
4+
online version: https://learn.microsoft.com/powershell/module/sharepoint-online/get-spocopilotagentinsightsreport
5+
applicable: SharePoint Online
6+
title: Get-SPOCopilotAgentInsightsReport
7+
schema: 2.0.0
8+
author: bhagatshweta
9+
ms.author: bhagatshweta
10+
ms.reviewer:
11+
manager: hikakar
12+
---
13+
14+
# Get-SPOCopilotAgentInsightsReport
15+
16+
## SYNOPSIS
17+
18+
This cmdlet enables the administrator to check status of all active and available reports when no report ID is present and to view or download a report if report ID is present.
19+
20+
## SYNTAX
21+
22+
```powershell
23+
Get-SPOCopilotAgentInsightsReport [-ReportId <Guid>] [-Content <SPOCopilotAgentInsightType>] [-Action <ActionType>]
24+
```
25+
26+
## DESCRIPTION
27+
28+
If this cmdlet is executed without any parameters, it displays the status of all active and completed reports with the following properties:
29+
30+
| Property | Description |
31+
|:---------------------|:-----------------------------------------------------------------|
32+
| Id | The unique Id of the report. |
33+
| CreatedDateTimeInUtc | The date and time in UTC when the report creation was triggered. |
34+
| Status | The status of the report. |
35+
| ReportPeriodInDays | The report duration in days. |
36+
37+
> [!NOTE]
38+
> All reports adhere to any retention timeline as per [Data Access Governance](/sharepoint/data-access-governance-reports).
39+
40+
## EXAMPLES
41+
42+
### -----------------------EXAMPLE 1-----------------------------
43+
44+
```powershell
45+
Get-SPOCopilotAgentInsightsReport
46+
```
47+
48+
Example 1 enables administrator to view the status of all active and completed reports.
49+
50+
### -----------------------EXAMPLE 2-----------------------------
51+
52+
```powershell
53+
Get-SPOCopilotAgentInsightsReport –ReportId 9d946216-afe7-49f5-8267-7b662435c70b
54+
```
55+
56+
Example 2 enables administrator to view the Copilot agent insight report of ReportId: `9d946216-afe7-49f5-8267-7b662435c70b`.
57+
58+
### -----------------------EXAMPLE 3-----------------------------
59+
60+
```powershell
61+
Get-SPOCopilotAgentInsightsReport – ReportId 9d946216-afe7-49f5-8267-7b662435c70b -Action Download
62+
```
63+
64+
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.
65+
66+
## PARAMETERS
67+
68+
### -ReportId
69+
70+
It specifies the unique Id of the report to be viewed or downloaded.
71+
72+
```yaml
73+
Type: Guid
74+
Parameter Sets: (All)
75+
Aliases:
76+
Applicable: SharePoint Online
77+
78+
Required: False
79+
Position: Named
80+
Default value: None
81+
Accept pipeline input: False
82+
Accept wildcard characters: False
83+
```
84+
85+
### -Content
86+
87+
It specifies the kind of report to view or download. There are 3 kinds of sub-reports: CopilotAgentsOnSites, TopSites, SiteDistribution.
88+
89+
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:
90+
91+
| Property | Description |
92+
|:--------------------------------|:----------------------------------------------------------------|
93+
| Site name | The name of the SharePoint site. |
94+
| URL | The URL of the SharePoint site. |
95+
| Template | The Site template of the SharePoint site. |
96+
| Site owner | Name of the owner of the SharePoint site. |
97+
| Copilot name | Name of Copilot agent on the SharePoint site. |
98+
| Sensitivity | The sensitivity label of the SharePoint site. |
99+
| Restrict site access enabled | Restrict site access status (Yes/No) of the SharePoint site. |
100+
| Restrict site discovery enabled | Restrict site discovery status (Yes/No) of the SharePoint site. |
101+
| External sharing | External Sharing status (Yes/No) of the SharePoint site. |
102+
103+
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:
104+
105+
| Property | Description |
106+
|:--------------------------------|:----------------------------------------------------------------|
107+
| Site name | The name of the SharePoint site. |
108+
| URL | The URL of the SharePoint site. |
109+
| Template | The Site template of the SharePoint site. |
110+
| Site owner | Name of the owner of the SharePoint site. |
111+
| Copilot agents | Number of Copilot agents on the SharePoint site. |
112+
| Sensitivity | The sensitivity label of the SharePoint site. |
113+
| Restrict site access enabled | Restrict site access status (Yes/No) of the SharePoint site. |
114+
| Restrict site discovery enabled | Restrict site discovery status (Yes/No) of the SharePoint site. |
115+
| External sharing | External Sharing status (Yes/No) of the SharePoint site. |
116+
117+
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:
118+
119+
| Property | Description |
120+
|:---------------|:---------------------------------------------------------------------------------------------|
121+
| Site template | The Site template of the SharePoint site. |
122+
| Sites | Number of sites corresponding to that particular site template. |
123+
| Copilot agents | Number of Copilot agents on the SharePoint site corresponding to that particular site template. |
124+
125+
```yaml
126+
Type: SPOCopilotAgentInsightType
127+
Parameter Sets: (All)
128+
Aliases:
129+
Applicable: SharePoint Online
130+
131+
Required: False
132+
Position: Named
133+
Default value: CopilotAgentsOnSites
134+
Accept pipeline input: False
135+
Accept wildcard characters: False
136+
```
137+
138+
### -Action
139+
140+
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.
141+
142+
```yaml
143+
Type: ActionType
144+
Parameter Sets: (All)
145+
Aliases:
146+
Applicable: SharePoint Online
147+
148+
Required: False
149+
Position: Named
150+
Default value: View
151+
Accept pipeline input: False
152+
Accept wildcard characters: False
153+
```
154+
155+
### CommonParameters
156+
157+
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).
158+
159+
## RELATED LINKS
160+
161+
[Getting started with SharePoint Online Management Shell](/powershell/sharepoint/sharepoint-online/connect-sharepoint-online)
162+
163+
[Start-SPOCopilotAgentInsightsReport](./Start-SPOCopilotAgentInsightsReport.md)

‎sharepoint/sharepoint-ps/sharepoint-online/Start-SPOCopilotAgentInsightsReport.md‎

Lines changed: 99 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,99 @@
1+
---
2+
external help file: sharepointonline.xml
3+
Module Name: Microsoft.Online.SharePoint.PowerShell
4+
online version: https://learn.microsoft.com/powershell/module/sharepoint-online/start-spocopilotagentinsightsreport
5+
applicable: SharePoint Online
6+
title: Start-SPOCopilotAgentInsightsReport
7+
schema: 2.0.0
8+
author: bhagatshweta
9+
ms.author: bhagatshweta
10+
ms.reviewer:
11+
manager: hikakar
12+
---
13+
14+
# Start-SPOCopilotAgentInsightsReport
15+
16+
## SYNOPSIS
17+
18+
Using this cmdlet, administrators may trigger the build of a new Copilot agent insight report for the specified number of days.
19+
20+
## SYNTAX
21+
22+
```powershell
23+
Start-SPOCopilotAgentInsightsReport [-ReportPeriodInDays <Int>] [-Force <SwitchParameter>]
24+
```
25+
26+
## DESCRIPTION
27+
28+
After this cmdlet is executed, the Copilot 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:
29+
30+
| Property | Description |
31+
|:---------------------|:-----------------------------------------------------------------|
32+
| Id | The unique Id of the report. |
33+
| CreatedDateTimeInUtc | The date and time in UTC when the report creation was triggered. |
34+
| Status | The status of the report. |
35+
| ReportPeriodInDays | The report duration in days. |
36+
37+
## EXAMPLES
38+
39+
### -----------------------EXAMPLE 1-----------------------------
40+
41+
```powershell
42+
Start-SPOCopilotAgentInsightsReport
43+
```
44+
45+
Example 1 generates the Copilot agent insight report for a default duration of 1 day since the parameter `–ReportPeriodInDays` is not provided.
46+
47+
### -----------------------EXAMPLE 2-----------------------------
48+
49+
```powershell
50+
Start-SPOCopilotAgentInsightsReport –ReportPeriodInDays 14
51+
```
52+
53+
Example 2 generates the Copilot agent insight report for a specified duration of 14 days.
54+
55+
## PARAMETERS
56+
57+
### -ReportPeriodInDays
58+
59+
It specifies the duration of the Copilot 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.
60+
61+
```yaml
62+
Type: Int
63+
Parameter Sets: (All)
64+
Aliases:
65+
Applicable: SharePoint Online
66+
67+
Required: False
68+
Position: Named
69+
Default value: 1
70+
Accept pipeline input: False
71+
Accept wildcard characters: False
72+
```
73+
74+
### -Force
75+
76+
It is an optional parameter which is used to bypass confirmation prompts and execute the command without interruptions.
77+
78+
```yaml
79+
Type: SwitchParameter
80+
Parameter Sets: (All)
81+
Aliases:
82+
Applicable: SharePoint Online
83+
84+
Required: False
85+
Position: Named
86+
Default value: None
87+
Accept pipeline input: False
88+
Accept wildcard characters: False
89+
```
90+
91+
### CommonParameters
92+
93+
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).
94+
95+
## Related Links
96+
97+
[Getting started with SharePoint Online Management Shell](/powershell/sharepoint/sharepoint-online/connect-sharepoint-online)
98+
99+
[Get-SPOCopilotAgentInsightsReport](./Get-SPOCopilotAgentInsightsReport.md)

‎sharepoint/sharepoint-ps/sharepoint-online/sharepoint-online.md‎

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -99,6 +99,10 @@ The following cmdlet references are for SharePoint Online.
9999

100100
{{Manually Enter Get-SPOAppInfo Description Here}}
101101

102+
### [Get-SPOCopilotAgentInsightsReport](Get-SPOCopilotAgentInsightsReport.md)
103+
104+
{{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.}}
105+
102106
### [Get-SPOCrossGeoMovedUsers](Get-SPOCrossGeoMovedUsers.md)
103107

104108
{{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
608612

609613
{{Manually Enter Set-SPOUser Description Here}}
610614

615+
### [Start-SPOCopilotAgentInsightsReport](Start-SPOCopilotAgentInsightsReport.md)
616+
617+
{{Triggers the build of a new Copilot agent insight report for the specified number of days.}}
618+
611619
### [Start-SPOSiteContentMove](Start-SPOSiteContentMove.md)
612620

613621
{{Manually Enter Start-SPOSiteContentMove Description Here}}

0 commit comments

Comments
 (0)