Skip to content

Commit 3355b2c

Browse files
starringGTMstarringGTM
authored
Added docs for M365 Agent Insights cmdlets.
1 parent b98fff4 commit 3355b2c

File tree

2 files changed

+325
-0
lines changed

2 files changed

+325
-0
lines changed

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

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

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

Lines changed: 145 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,145 @@
1+
---
2+
external help file: Microsoft.Online.SharePoint.PowerShell.dll-Help.xml
3+
Module Name: Microsoft.Online.SharePoint.PowerShell
4+
online version: https://learn.microsoft.com/powershell/module/sharepoint-online/start-spom365agentaccessinsightsreport
5+
applicable: SharePoint Online
6+
title: Start-SPOM365AgentAccessInsightsReport
7+
schema: 2.0.0
8+
author: gchaudhary
9+
ms.author: gchaudhary
10+
ms.reviewer:
11+
manager: lokeshgoel
12+
---
13+
14+
# Start-SPOM365AgentAccessInsightsReport
15+
16+
## SYNOPSIS
17+
18+
Using this cmdlet, administrators may trigger the build of a new M365 agent insight report for the specified number of days.
19+
20+
> [!NOTE]
21+
> The feature associated with this cmdlet will be rolling out soon.
22+
23+
## SYNTAX
24+
25+
```
26+
Start-SPOM365AgentAccessInsightsReport [-Force] [-ReportPeriodInDays <Int32>] [-WhatIf] [-Confirm]
27+
[<CommonParameters>]
28+
```
29+
30+
## DESCRIPTION
31+
32+
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:
33+
34+
| Property | Description |
35+
|:---------------------|:-----------------------------------------------------------------|
36+
| Id | The unique Id of the report. |
37+
| CreatedDateTimeInUtc | The date and time in UTC when the report creation was triggered. |
38+
| Status | The status of the report. |
39+
| ReportPeriodInDays | The report duration in days. |
40+
41+
## EXAMPLES
42+
43+
### EXAMPLE 1
44+
45+
```powershell
46+
Start-SPOM365AgentAccessInsightsReport
47+
```
48+
49+
Example 1 generates the M365 agent insight report for a default duration of 1 day since the parameter `–ReportPeriodInDays` is not provided.
50+
51+
### EXAMPLE 2
52+
53+
```powershell
54+
Start-SPOM365AgentAccessInsightsReport –ReportPeriodInDays 14
55+
```
56+
57+
Example 2 generates the Copilot agent insight report for a specified duration of 14 days.
58+
59+
## PARAMETERS
60+
61+
### -Force
62+
63+
> Applicable: SharePoint Online
64+
65+
It is an optional parameter which is used to bypass confirmation prompts and execute the command without interruptions.
66+
67+
```yaml
68+
Type: System.Management.Automation.SwitchParameter
69+
Parameter Sets: (All)
70+
Aliases:
71+
72+
Required: False
73+
Position: Named
74+
Default value: None
75+
Accept pipeline input: False
76+
Accept wildcard characters: False
77+
```
78+
79+
### -ReportPeriodInDays
80+
81+
> Applicable: SharePoint Online
82+
83+
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.
84+
85+
```yaml
86+
Type: System.Int32
87+
Parameter Sets: (All)
88+
Aliases:
89+
90+
Required: False
91+
Position: Named
92+
Default value: None
93+
Accept pipeline input: False
94+
Accept wildcard characters: False
95+
```
96+
97+
### -Confirm
98+
Prompts you for confirmation before running the cmdlet.
99+
100+
```yaml
101+
Type: System.Management.Automation.SwitchParameter
102+
Parameter Sets: (All)
103+
Aliases: cf
104+
105+
Required: False
106+
Position: Named
107+
Default value: None
108+
Accept pipeline input: False
109+
Accept wildcard characters: False
110+
```
111+
112+
### -WhatIf
113+
Shows what would happen if the cmdlet runs.
114+
The cmdlet is not run.
115+
116+
```yaml
117+
Type: System.Management.Automation.SwitchParameter
118+
Parameter Sets: (All)
119+
Aliases: wi
120+
121+
Required: False
122+
Position: Named
123+
Default value: None
124+
Accept pipeline input: False
125+
Accept wildcard characters: False
126+
```
127+
128+
### CommonParameters
129+
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).
130+
131+
## INPUTS
132+
133+
### None
134+
135+
## OUTPUTS
136+
137+
### System.Object
138+
139+
## NOTES
140+
141+
## RELATED LINKS
142+
143+
[Getting started with SharePoint Online Management Shell](/powershell/sharepoint/sharepoint-online/connect-sharepoint-online)
144+
145+
[Get-SPOM365AgentAccessInsightsReport](./Get-SPOM365AgentAccessInsightsReport)

0 commit comments

Comments
 (0)