Skip to content

Commit ec78d61

Browse files
Shweta2024Shweta2024
committed
add documentation for Copilot Insights Cmdlets
Add public documentation for Copilot Insights Cmdlets
1 parent 7c83bc0 commit ec78d61

File tree

2 files changed

+264
-0
lines changed

2 files changed

+264
-0
lines changed

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

Lines changed: 165 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,165 @@
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+
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 the report creation was triggered in UTC. |
34+
| Status | The status of the report. |
35+
| ReportPeriodInDays | The report duration in days. |
36+
37+
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:
38+
39+
| Property | Description |
40+
|:------------------------|:---------------------------------------------------------|
41+
| Site name | The name of the SharePoint site. |
42+
| URL | The URL of the SharePoint site. |
43+
| Template | The Site template of the SharePoint site. |
44+
| Site owner | Name of the owner of the SharePoint site. |
45+
| Copilot name | Name of Copilot agent on the SharePoint site. |
46+
| Sensitivity | The sensitivity label of the SharePoint site. |
47+
| Restrict site access | RAC status (Yes/No) of the SharePoint site. |
48+
| Restrict site discovery | RCD status (Yes/No) of the SharePoint site. |
49+
| External sharing | External Sharing status (Yes/No) of the SharePoint site. |
50+
51+
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:
52+
53+
| Property | Description |
54+
|:------------------------|:---------------------------------------------------------|
55+
| Site name | The name of the SharePoint site. |
56+
| URL | The URL of the SharePoint site. |
57+
| Template | The Site template of the SharePoint site. |
58+
| Site owner | Name of the owner of the SharePoint site. |
59+
| Copilot agents | Number of Copilot agents on the SharePoint site. |
60+
| Sensitivity | The sensitivity label of the SharePoint site. |
61+
| Restrict site access | RAC status (Yes/No) of the SharePoint site. |
62+
| Restrict site discovery | RCD status (Yes/No) of the SharePoint site. |
63+
| External sharing | External Sharing status (Yes/No) of the SharePoint site. |
64+
65+
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:
66+
67+
| Property | Description |
68+
|:---------------|:---------------------------------------------------------------------------------------------|
69+
| Site template | The Site template of the SharePoint site. |
70+
| Sites | Number of sites corresponding to that particular site template. |
71+
| Copilot agents | Name of Copilot agent on the SharePoint site corresponding to that particular site template. |
72+
73+
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.
74+
75+
> [!NOTE]
76+
> All reports adhere to any retention timeline as per [Data Access Governance](/sharepoint/data-access-governance-reports).
77+
78+
## EXAMPLES
79+
80+
### -----------------------EXAMPLE 1-----------------------------
81+
82+
```powershell
83+
Get-SPOCopilotAgentInsightsReport
84+
```
85+
86+
Example 1 enables administrator to view the status of all active and completed reports.
87+
88+
### -----------------------EXAMPLE 2-----------------------------
89+
90+
```powershell
91+
Get-SPOCopilotAgentInsightsReport –ReportId 9d946216-afe7-49f5-8267-7b662435c70b
92+
```
93+
94+
Example 2 enables administrator to view the Copilot agent insights report of ReportId: `9d946216-afe7-49f5-8267-7b662435c70b`.
95+
96+
### -----------------------EXAMPLE 3-----------------------------
97+
98+
```powershell
99+
Get-SPOCopilotAgentInsightsReport – ReportId 9d946216-afe7-49f5-8267-7b662435c70b -Action Download
100+
```
101+
102+
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.
103+
104+
## PARAMETERS
105+
106+
### -ReportId
107+
108+
It is an optional parameter, and it specifies the unique Id of the report to be viewed or downloaded.
109+
110+
```yaml
111+
Type: Guid
112+
Parameter Sets: (All)
113+
Aliases:
114+
Applicable: SharePoint Online
115+
116+
Required: False
117+
Position: Named
118+
Default value: None
119+
Accept pipeline input: False
120+
Accept wildcard characters: False
121+
```
122+
123+
### -Content
124+
125+
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.
126+
127+
```yaml
128+
Type: SPOCopilotAgentInsightType
129+
Parameter Sets: (All)
130+
Aliases:
131+
Applicable: SharePoint Online
132+
133+
Required: False
134+
Position: Named
135+
Default value: CopilotAgentsOnSites
136+
Accept pipeline input: False
137+
Accept wildcard characters: False
138+
```
139+
140+
### -Action
141+
142+
It is an optional parameter, and it specifies whether to view or download a specific report.
143+
144+
```yaml
145+
Type: ActionType
146+
Parameter Sets: (All)
147+
Aliases:
148+
Applicable: SharePoint Online
149+
150+
Required: False
151+
Position: Named
152+
Default value: None
153+
Accept pipeline input: False
154+
Accept wildcard characters: False
155+
```
156+
157+
### CommonParameters
158+
159+
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).
160+
161+
## RELATED LINKS
162+
163+
[Getting started with SharePoint Online Management Shell](/powershell/sharepoint/sharepoint-online/connect-sharepoint-online)
164+
165+
[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+
This cmdlet enables administrator to trigger the build of a new Copilot Agent Insight report for the last N 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 last N 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 the report creation was triggered in UTC. |
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 insights report for a default duration of 1 day as 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 insights report for a specified duration of 14 days.
54+
55+
## PARAMETERS
56+
57+
### -ReportPeriodInDays
58+
59+
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.
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: None
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)

0 commit comments

Comments
 (0)