Skip to content

Commit 08f3059

Browse files
aditisrivastava07aditisrivastava07
authored
Merge branch 'main' into pvrk-sharepointps-oct
2 parents d922368 + 732046c commit 08f3059

13 files changed

+583
-14
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/Get-SPOCopilotPromoOptInStatus.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -31,7 +31,7 @@ If the promo status is enabled, the return value is `True`, otherwise the return
3131
### Example 1
3232

3333
```powershell
34-
Get-SPOCopilotPromoOptInStatusEnabled
34+
Get-SPOCopilotPromoOptInStatus
3535
```
3636

3737
Example 1 returns the value of the Opt-In promo status.

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

Lines changed: 77 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,77 @@
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-sporestrictedsitecreation
5+
applicable: SharePoint Online
6+
title: Get-SPORestrictedSiteCreation
7+
schema: 2.0.0
8+
author: vgaddam-pm
9+
ms.author: vgaddam
10+
ms.reviewer:
11+
---
12+
13+
# Get-SPORestrictedSiteCreation
14+
15+
## SYNOPSIS
16+
17+
This cmdlet allows SharePoint administrators to check the current configuration of the restricted site creation feature.
18+
19+
## SYNTAX
20+
21+
```powershell
22+
Get-SPORestrictedSiteCreation [-SiteType <RestrictedSiteCreationSiteType>]
23+
```
24+
25+
## DESCRIPTION
26+
27+
This cmdlet obtains the current configuration information for the restricted site creation feature, including whether it is enabled, the current mode, and the current policies.
28+
29+
> [!Important]
30+
>You must use version 16.0.25513.12000 (published November 2024) or later of the [SharePoint Online Management Shell](/powershell/sharepoint/sharepoint-online/connect-sharepoint-online) for these commands to function properly. Earlier versions do not have the current list of site types and will not operate correctly.
31+
32+
## EXAMPLES
33+
34+
### Example 1
35+
36+
```powershell
37+
Get-SPORestrictedSiteCreation
38+
```
39+
40+
Example 1 returns all configuration information for the restricted site creation feature. This includes whether the feature is enabled, the current mode (deny or allow), and the Microsoft Entra security groups configured for each site type.
41+
42+
### Example 2
43+
44+
```powershell
45+
Get-SPORestrictedSiteCreation –SiteType Communication
46+
```
47+
48+
Example 2 returns a comma-separated list of the IDs of the Microsoft Entra security groups configured for the `Communication` site type. Depending on whether restricted site creation is in allow or deny mode, members of these groups are either allowed or denied from creating SharePoint communication sites.
49+
50+
## PARAMETERS
51+
52+
### -SiteType
53+
When provided, only return the Microsoft Entra security groups configured for the specified site type.
54+
55+
PARAMVALUE: All | SharePoint | OneDrive | Team | Communication
56+
• All - OneDrive and all SharePoint sites
57+
• SharePoint - All SharePoint sites (but not OneDrive)
58+
• OneDrive - Only OneDrive
59+
• Team - Only SharePoint team sites (group-connected and classic)
60+
• Communication - Only SharePoint communication sites
61+
62+
```yaml
63+
Type: RestrictedSiteCreationSiteType
64+
Parameter Sets: (All)
65+
Applicable: SharePoint Online
66+
Required: False
67+
Position: Named
68+
Default value: None
69+
Accept pipeline input: False
70+
Accept wildcard characters: False
71+
```
72+
73+
## RELATED LINKS
74+
75+
[Getting started with SharePoint Online Management Shell](/powershell/sharepoint/sharepoint-online/connect-sharepoint-online)
76+
77+
For permissions and the most current information about Windows PowerShell for SharePoint Online, see the online documentation at [Intro to SharePoint Online Management Shell](/powershell/sharepoint/sharepoint-online/introduction-sharepoint-online-management-shell).

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

Lines changed: 6 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -103,11 +103,13 @@ The move status for the Office 365 Group. Possible values are:
103103
* InProgress (n/4): The move is in progress in one of the following states: Validation (1/4), Backup (2/4), Restore (3/4), Cleanup (4/4).
104104
* Success: The move has completed successfully.
105105
* Failed: The move failed.
106+
* Stopped: The move was canceled by an administrator while it was still queued.
107+
* NotSupported: The move could not be processed because the Preferred Data Location was invalid.
108+
* Rescheduled: The move did not succeed and is being scheduled again for another attempt.
106109

107-
## NOTES
108-
109-
You can also apply the `-Verbose` option to see additional information about the move.
110+
> [!NOTE]
111+
> You can also apply the `-Verbose` option to see additional information about the move.
110112

111113
## RELATED LINKS
112114

113-
[Move a SharePoint site to a different geo location](https://learn.microsoft.com/office365/enterprise/move-sharepoint-between-geo-locations)
115+
[Move a SharePoint site to a different geo location](/microsoft-365/enterprise/m365-dr-workload-spo)

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

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -50,6 +50,9 @@ The following are the available move states:
5050
|InProgress| The move is in progress in one of the following states: Validation, Backup, Restore, Cleanup.|
5151
|Success| The move has completed successfully.|
5252
|Failed|The move failed.|
53+
|Stopped|The move was canceled by an administrator while it was still queued.|
54+
|NotSupported|The move could not be processed because the Preferred Data Location was invalid.|
55+
|Rescheduled|The move did not succeed and is being scheduled again for another attempt.|
5356

5457
## EXAMPLES
5558

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

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -39,9 +39,9 @@ Possible results for this cmdlet are:
3939
Result | Reason
4040
--- | ---
4141
Warning : We couldn't find the [email protected]. Check for typos and try again. | Invalid input for -User parameter.
42-
We successfully signed out <user> from all devices. | Successful instantaneous revocation.
43-
It can take up to an hour to sign out <user> from all devices. | Successful non-instantaneous revocation.
44-
Sorry, something went wrong and we couldn't sign out <user> from any device. | The cmdlet did not successfully execute.
42+
We successfully signed out \<user\> from all devices. | Successful instantaneous revocation.
43+
It can take up to an hour to sign out \<user\> from all devices. | Successful non-instantaneous revocation.
44+
Sorry, something went wrong and we couldn't sign out \<user\> from any device. | The cmdlet did not successfully execute.
4545
The cmdlet will be available in the future, but it isn't ready for use in your organization yet. | The cmdlet has been disabled for the tenant.
4646

4747
## EXAMPLES

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

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -29,12 +29,12 @@ This cmdlet sets the Opt-In Copilot promo status for the tenant to `True` or `Fa
2929
### Example 1
3030

3131
```powershell
32-
Set-SPOCopilotPromoOptInStatusSetSuccessfully -SPOCopilotPromoOptInStatusEnabled $true
32+
Set-SPOCopilotPromoOptInStatus -IsCopilotPromoStatusEnabled $true
3333
```
3434

3535
Example 1 sets the Opt-In Copilot promo status for the tenant to `True`.
3636

37-
### Parameter:
37+
## PARAMETERS
3838

3939
### -IsCopilotPromoStatusEnabled
4040

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

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -164,7 +164,7 @@ Accept wildcard characters: False
164164
165165
### -FileContainerName
166166
167-
The optional name of the Azure Blob Storage container that will be created if it does not currently exist. It will hold the uploaded package content files. The value must be in lower case and conform to Azure's container naming rules. If this not supplied a name will be generated using the format <GUID>-files.
167+
The optional name of the Azure Blob Storage container that will be created if it does not currently exist. It will hold the uploaded package content files. The value must be in lower case and conform to Azure's container naming rules. If this not supplied a name will be generated using the format \<GUID\>-files.
168168
169169
```yaml
170170
Type: String
@@ -274,7 +274,7 @@ Accept wildcard characters: False
274274

275275
### -PackageContainerName
276276

277-
The optional name of the Azure Blob Storage container that will be created if it does not currently exist. It will hold the uploaded package metadata files. The value must be in lower case and conform to Azure's container naming rules. If this not supplied a name will be generated using the format <GUID>-package.
277+
The optional name of the Azure Blob Storage container that will be created if it does not currently exist. It will hold the uploaded package metadata files. The value must be in lower case and conform to Azure's container naming rules. If this not supplied a name will be generated using the format \<GUID\>-package.
278278

279279
```yaml
280280
Type: String

0 commit comments

Comments
 (0)