Skip to content

Commit 8a5c973

Browse files
starringGTMstarringGTM
authored
Update Get-SPOM365AgentAccessInsightsReport.md
1 parent 9ef5efc commit 8a5c973

File tree

1 file changed

+9
-46
lines changed

1 file changed

+9
-46
lines changed

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

Lines changed: 9 additions & 46 deletions
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,7 @@ manager: lokeshgoel
1515

1616
## SYNOPSIS
1717

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.
18+
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.
1919

2020
> [!NOTE]
2121
> The feature associated with this cmdlet will be rolling out soon.
@@ -29,15 +29,7 @@ Get-SPOM365AgentAccessInsightsReport [-ReportId <Guid>] [-Action <ActionType>]
2929

3030
## DESCRIPTION
3131

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-
32+
If this cmdlet is executed without any parameters, it displays the status of all active and completed reports.
4133
> [!NOTE]
4234
> All reports adhere to any retention timeline as per [Data Access Governance](/sharepoint/data-access-governance-reports).
4335
@@ -49,23 +41,23 @@ If this cmdlet is executed without any parameters, it displays the status of all
4941
Get-SPOM365AgentAccessInsightsReport
5042
```
5143

52-
Example 1 enables administrator to view the status of all active and completed reports.
44+
Example 1 enables administrator to view the status of all active and completed analytics reports.
5345

5446
### EXAMPLE 2
5547

5648
```powershell
5749
Get-SPOM365AgentAccessInsightsReport –ReportId 9d946216-afe7-49f5-8267-7b662435c70b
5850
```
5951

60-
Example 2 enables administrator to view the M365 agent insight report of ReportId: `9d946216-afe7-49f5-8267-7b662435c70b`.
52+
Example 2 enables administrator to view the M365 agent insight report of the given report id.
6153

6254
### EXAMPLE 3
6355

6456
```powershell
6557
Get-SPOM365AgentAccessInsightsReport – ReportId 9d946216-afe7-49f5-8267-7b662435c70b -Action Download
6658
```
6759

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.
60+
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.
6961

7062
## PARAMETERS
7163

@@ -94,39 +86,9 @@ Accept wildcard characters: False
9486
9587
It specifies the kind of report to view or download. There are 2 kinds of sub-reports: M365AgentsOnSites, SiteDistribution.
9688
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 Microsoft 365 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 Microsoft 365 agents on the SharePoint site corresponding to that particular site template. |
89+
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.
90+
91+
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.
13092

13193
```yaml
13294
Type: Microsoft.Online.SharePoint.TenantAdministration.SPOM365AgentInsightType
@@ -179,3 +141,4 @@ This cmdlet supports the common parameters: `-Debug`, `-ErrorAction`, `-ErrorVar
179141

180142
[Start-SPOM365AgentAccessInsightsReport](./Start-SPOM365AgentAccessInsightsReport.md)
181143

144+

0 commit comments

Comments
 (0)