Skip to content

Commit 99bf816

Browse files
garycentricgarycentric
authored
Merge branch 'main' into main
2 parents c44d58f + 6bca9bb commit 99bf816

File tree

4 files changed

+318
-6
lines changed

4 files changed

+318
-6
lines changed

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

Lines changed: 141 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,141 @@
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: starringGTM
9+
ms.author: gchaudhary
10+
ms.reviewer:
11+
---
12+
13+
# Get-SPOM365AgentAccessInsightsReport
14+
15+
## SYNOPSIS
16+
17+
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.
18+
19+
> [!NOTE]
20+
> The feature associated with this cmdlet will be rolling out soon.
21+
22+
## SYNTAX
23+
24+
```
25+
Get-SPOM365AgentAccessInsightsReport [-ReportId <Guid>] [-Action <ActionType>]
26+
[-Content <M365AgentsOnSites>] [<CommonParameters>]
27+
```
28+
29+
## DESCRIPTION
30+
31+
If this cmdlet is executed without any parameters, it displays the status of all active and completed reports.
32+
> [!NOTE]
33+
> All reports adhere to any retention timeline as per [Data Access Governance](/sharepoint/data-access-governance-reports).
34+
35+
## EXAMPLES
36+
37+
### EXAMPLE 1
38+
39+
```powershell
40+
Get-SPOM365AgentAccessInsightsReport
41+
```
42+
43+
Example 1 enables administrator to view the status of all active and completed analytics reports.
44+
45+
### EXAMPLE 2
46+
47+
```powershell
48+
Get-SPOM365AgentAccessInsightsReport –ReportId 9d946216-afe7-49f5-8267-7b662435c70b
49+
```
50+
51+
Example 2 enables administrator to view the Microsoft 365 agent insight report of the given report ID.
52+
53+
### EXAMPLE 3
54+
55+
```powershell
56+
Get-SPOM365AgentAccessInsightsReport – ReportId 9d946216-afe7-49f5-8267-7b662435c70b -Action Download
57+
```
58+
59+
Example 3 enables administrator to download the Microsoft 365 agent insight report of the given report ID to the same path from where the command was run.
60+
61+
## PARAMETERS
62+
63+
### -Action
64+
65+
> Applicable: SharePoint Online
66+
67+
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.
68+
69+
```yaml
70+
Type: ActionType
71+
Parameter Sets: (All)
72+
Aliases:
73+
Accepted values: View, Download
74+
75+
Required: False
76+
Position: Named
77+
Default value: View
78+
Accept pipeline input: False
79+
Accept wildcard characters: False
80+
```
81+
82+
### -Content
83+
84+
> Applicable: SharePoint Online
85+
86+
It specifies the kind of report to view or download.
87+
88+
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.
89+
90+
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.
91+
92+
```yaml
93+
Type: Microsoft.Online.SharePoint.TenantAdministration.SPOM365AgentInsightType
94+
Parameter Sets: (All)
95+
Aliases:
96+
Accepted values: M365AgentsOnSites, SiteDistribution
97+
98+
Required: False
99+
Position: Named
100+
Default value: M365AgentsOnSites
101+
Accept pipeline input: False
102+
Accept wildcard characters: False
103+
```
104+
105+
### -ReportId
106+
107+
> Applicable: SharePoint Online
108+
109+
It specifies the unique ID of the report to be viewed or downloaded.
110+
111+
```yaml
112+
Type: System.Guid
113+
Parameter Sets: (All)
114+
Aliases:
115+
116+
Required: False
117+
Position: Named
118+
Default value: None
119+
Accept pipeline input: False
120+
Accept wildcard characters: False
121+
```
122+
123+
### CommonParameters
124+
125+
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).
126+
127+
## INPUTS
128+
129+
### None
130+
131+
## OUTPUTS
132+
133+
### System.Object
134+
135+
## NOTES
136+
137+
## RELATED LINKS
138+
139+
[Getting started with SharePoint Online Management Shell](/powershell/sharepoint/sharepoint-online/connect-sharepoint-online)
140+
141+
[Start-SPOM365AgentAccessInsightsReport](./Start-SPOM365AgentAccessInsightsReport.md)

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

Lines changed: 32 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -20,7 +20,7 @@ Returns one or more site collections.
2020

2121
### ParamSet1 (Default)
2222
```
23-
Get-SPOSite [[-Identity] <SpoSitePipeBind>] [-Limit <String>] [-Detailed] [<CommonParameters>]
23+
Get-SPOSite [[-Identity] <SpoSitePipeBind>] [-Limit <String>] [-Detailed] [-IsAuthoritative <Boolean>] [<CommonParameters>]
2424
```
2525

2626
### ParamSet3
@@ -111,7 +111,7 @@ This example gets quota details for a Group Site.
111111
Get-SPOSite -Identity https://contoso.sharepoint.com/sites/research | Select InformationSegment
112112
```
113113

114-
This example returns the InformationSegments associated with the site. It is applicable for tenants who have enabled Microsoft 365 Information barriers capability. Read [Learn about information barriers](/microsoft-365/compliance/information-barriers) to understand Information barriers in SharePoint Online.
114+
This example returns the InformationSegment associated with the site. It is applicable for tenants who have enabled Microsoft 365 Information barriers capability. Read [Learn about information barriers](/microsoft-365/compliance/information-barriers) to understand Information barriers in SharePoint Online.
115115

116116
**Note**: This property is available only in SharePoint Online Management Shell Version 16.0.19927.12000 or later.
117117

@@ -125,28 +125,36 @@ This example uses server side filtering to return sites matching 18.
125125

126126
### EXAMPLE 8
127127

128+
```powershell
129+
Get-SPOSite -Filter { IsAuthoritative -eq true }
130+
```
131+
132+
This example uses server side filtering to return Authoritative sites (i.e., sites that have the IsAuthoritative property set to true).
133+
134+
### EXAMPLE 9
135+
128136
```powershell
129137
Get-SPOSite -Limit ALL | ?{$_.IsTeamsConnected -eq $true}
130138
```
131139

132140
This example uses client-side filtering to return a list of sites connected to Microsoft Teams.
133141

134-
### EXAMPLE 9
142+
### EXAMPLE 10
135143

136144
```powershell
137145
Get-SPOSite -Limit ALL | ?{$_.IsTeamsChannelConnected -eq $true}
138146
```
139147

140148
This example uses client-side filtering to return a list of sites connected to a Microsoft Teams Private or Shared channel.
141149

142-
### EXAMPLE 10
150+
### EXAMPLE 11
143151

144152
```powershell
145153
Get-SPOSite -Limit ALL -GroupIdDefined $true
146154
```
147155
This example uses server-side filtering to return all sites that have an associated Microsoft 365 Group.
148156

149-
### EXAMPLE 11
157+
### EXAMPLE 12
150158

151159
```powershell
152160
$userUPN="[email protected]"
@@ -236,7 +244,7 @@ Accept wildcard characters: False
236244
> Applicable: SharePoint Online
237245
238246
Specifies the script block of the server-side filter to apply. The type must be a valid filter name and value must be in the form `{ PropertyName <operator> "filterValue"}`. Valid operators are as follows: -eq, -ne, -like, -notlike.
239-
Currently, you can filter by these properties: Owner, Template (can be used to filter if it is the only property present in the filter), LockState, Url.
247+
Currently, you can filter by these properties: Owner, Template (can be used to filter if it is the only property present in the filter), LockState, Url, IsAuthoritative (only supports comparison operators -eq and -ne).
240248
Using the -or operator to include an additional filter is not supported.
241249

242250
Note: The operator values are case-sensitive.
@@ -311,6 +319,24 @@ Accept pipeline input: False
311319
Accept wildcard characters: False
312320
```
313321

322+
### -IsAuthoritative
323+
324+
> Applicable: SharePoint Online
325+
326+
Filter the list of sites where the IsAuthoritative property is set to true. When IsAuthoritative is true, it signals to Microsoft Search, Copilot (BizChat), and other AI agents that the site's content is official, trusted, and verified.
327+
328+
```yaml
329+
Type: Boolean
330+
Parameter Sets: ParamSet1
331+
Aliases:
332+
333+
Required: False
334+
Position: Named
335+
Default value: None
336+
Accept pipeline input: False
337+
Accept wildcard characters: False
338+
```
339+
314340
### -Limit
315341

316342
> Applicable: SharePoint Online

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

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -240,6 +240,9 @@ Gets the status for a file version expiration report generation job for a docume
240240
### [Get-SPOListVersionPolicy](Get-SPOListVersionPolicy.md)
241241
Gets the version policy setting on the document library.
242242

243+
### [Get-SPOM365AgentAccessInsightsReport](Get-SPOM365AgentAccessInsightsReport.md)
244+
This cmdlet enables the administrator to check status of all active and available Microsoft 365 Agent Insights reports when no report ID is present and to view or download a report if report ID is present. > [!NOTE] > The feature associated with this cmdlet will be rolling out soon.
245+
243246
### [Get-SPOMalwareFile](Get-SPOMalwareFile.md)
244247
Extracts and displays the malware-related information of an infected file stored in SharePoint.
245248

@@ -804,6 +807,9 @@ This cmdlet enables administrator to trigger the build of a new enterprise appli
804807
### [Start-SPOInformationBarriersInsightsReport](Start-SPOInformationBarriersInsightsReport.md)
805808
Generates a new report to identify and discover the usage patterns of Information Barriers (IB) across SharePoint sites and OneDrive accounts in the organization.
806809

810+
### [Start-SPOM365AgentAccessInsightsReport](Start-SPOM365AgentAccessInsightsReport.md)
811+
Using this cmdlet, administrators may trigger the build of a new Microsoft 365 agent insight report for the specified number of days. > [!NOTE] > The feature associated with this cmdlet will be rolling out soon.
812+
807813
### [Start-SPORestrictedAccessForSitesInsights](Start-SPORestrictedAccessForSitesInsights.md)
808814
This cmdlet enables administrator to trigger the build of a new restricted access control insights report for the data from last 28 days.
809815

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

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

0 commit comments

Comments
 (0)