Merge branch 'main' into pvrk-sharepointps-oct

MicrosoftDocs · Dec 27, 2024 · 08f3059 · 08f3059
2 parents d922368 + 732046c
commit 08f3059
Show file tree

Hide file tree

Showing 13 changed files with 583 additions and 14 deletions.
diff --git a/sharepoint/sharepoint-ps/sharepoint-online/Get-SPOCopilotAgentInsightsReport.md b/sharepoint/sharepoint-ps/sharepoint-online/Get-SPOCopilotAgentInsightsReport.md
@@ -0,0 +1,163 @@
+---
+external help file: sharepointonline.xml
+Module Name: Microsoft.Online.SharePoint.PowerShell
+online version: https://learn.microsoft.com/powershell/module/sharepoint-online/get-spocopilotagentinsightsreport
+applicable: SharePoint Online
+title: Get-SPOCopilotAgentInsightsReport
+schema: 2.0.0
+author: bhagatshweta
+ms.author: bhagatshweta
+ms.reviewer:
+manager: hikakar
+---
+
+# Get-SPOCopilotAgentInsightsReport
+
+## SYNOPSIS
+
+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.
+
+## SYNTAX
+
+```powershell
+Get-SPOCopilotAgentInsightsReport [-ReportId <Guid>] [-Content <SPOCopilotAgentInsightType>] [-Action <ActionType>]
+```
+
+## DESCRIPTION
+
+If this cmdlet is executed without any parameters, it displays the status of all active and completed reports with the following properties:
+
+| Property             | Description                                                      |
+|:---------------------|:-----------------------------------------------------------------|
+| Id                   | The unique Id of the report.                                     |
+| CreatedDateTimeInUtc | The date and time in UTC when the report creation was triggered. |
+| Status               | The status of the report.                                        |
+| ReportPeriodInDays   | The report duration in days.                                     |
+
+> [!NOTE]
+> All reports adhere to any retention timeline as per [Data Access Governance](/sharepoint/data-access-governance-reports).
+
+## EXAMPLES
+
+### -----------------------EXAMPLE 1-----------------------------
+
+```powershell
+Get-SPOCopilotAgentInsightsReport
+```
+
+Example 1 enables administrator to view the status of all active and completed reports.
+
+### -----------------------EXAMPLE 2-----------------------------
+
+```powershell
+Get-SPOCopilotAgentInsightsReport –ReportId 9d946216-afe7-49f5-8267-7b662435c70b
+```
+
+Example 2 enables administrator to view the Copilot agent insight report of ReportId: `9d946216-afe7-49f5-8267-7b662435c70b`.
+
+### -----------------------EXAMPLE 3-----------------------------
+
+```powershell
+Get-SPOCopilotAgentInsightsReport – ReportId 9d946216-afe7-49f5-8267-7b662435c70b -Action Download
+```
+
+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.
+
+## PARAMETERS
+
+### -ReportId
+
+It specifies the unique Id of the report to be viewed or downloaded.
+
+```yaml
+Type: Guid
+Parameter Sets: (All)
+Aliases:
+Applicable: SharePoint Online
+
+Required: False
+Position: Named
+Default value: None
+Accept pipeline input: False
+Accept wildcard characters: False
+```
+
+### -Content
+
+It specifies the kind of report to view or download. There are 3 kinds of sub-reports: CopilotAgentsOnSites, TopSites, SiteDistribution.
+
+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:
+
+| Property                        | Description                                                     |
+|:--------------------------------|:----------------------------------------------------------------|
+| Site name                       | The name of the SharePoint site.                                |
+| URL                             | The URL of the SharePoint site.                                 |
+| Template                        | The Site template of the SharePoint site.                       |
+| Site owner                      | Name of the owner of the SharePoint site.                       |
+| Copilot name                    | Name of Copilot agent on the SharePoint site.                   |
+| Sensitivity                     | The sensitivity label of the SharePoint site.                   |
+| Restrict site access enabled    | Restrict site access status (Yes/No) of the SharePoint site.    |
+| Restrict site discovery enabled | Restrict site discovery status (Yes/No) of the SharePoint site. |
+| External sharing                | External Sharing status (Yes/No) of the SharePoint site.        |
+
+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:
+
+| Property                        | Description                                                     |
+|:--------------------------------|:----------------------------------------------------------------|
+| Site name                       | The name of the SharePoint site.                                |
+| URL                             | The URL of the SharePoint site.                                 |
+| Template                        | The Site template of the SharePoint site.                       |
+| Site owner                      | Name of the owner of the SharePoint site.                       |
+| Copilot agents                  | Number of Copilot agents on the SharePoint site.                |
+| Sensitivity                     | The sensitivity label of the SharePoint site.                   |
+| Restrict site access enabled    | Restrict site access status (Yes/No) of the SharePoint site.    |
+| Restrict site discovery enabled | Restrict site discovery status (Yes/No) of the SharePoint site. |
+| External sharing                | External Sharing status (Yes/No) of the SharePoint site.        |
+
+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:
+
+| Property       | Description                                                                                  |
+|:---------------|:---------------------------------------------------------------------------------------------|
+| Site template  | The Site template of the SharePoint site.                                                    |
+| Sites          | Number of sites corresponding to that particular site template.                              |
+| Copilot agents | Number of Copilot agents on the SharePoint site corresponding to that particular site template. |
+
+```yaml
+Type: SPOCopilotAgentInsightType
+Parameter Sets: (All)
+Aliases:
+Applicable: SharePoint Online
+
+Required: False
+Position: Named 
+Default value: CopilotAgentsOnSites
+Accept pipeline input: False
+Accept wildcard characters: False
+```
+
+### -Action
+
+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.
+
+```yaml
+Type: ActionType
+Parameter Sets: (All)
+Aliases:
+Applicable: SharePoint Online
+ 
+Required: False
+Position: Named
+Default value: View
+Accept pipeline input: False
+Accept wildcard characters: False
+```
+
+### CommonParameters
+
+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).
+
+## RELATED LINKS
+
+[Getting started with SharePoint Online Management Shell](/powershell/sharepoint/sharepoint-online/connect-sharepoint-online)
+
+[Start-SPOCopilotAgentInsightsReport](./Start-SPOCopilotAgentInsightsReport.md)
diff --git a/sharepoint/sharepoint-ps/sharepoint-online/Get-SPOCopilotPromoOptInStatus.md b/sharepoint/sharepoint-ps/sharepoint-online/Get-SPOCopilotPromoOptInStatus.md
@@ -31,7 +31,7 @@ If the promo status is enabled, the return value is `True`, otherwise the return
 ### Example 1
 
 ```powershell
-Get-SPOCopilotPromoOptInStatusEnabled
+Get-SPOCopilotPromoOptInStatus
 ```
 
 Example 1 returns the value of the Opt-In promo status.

diff --git a/sharepoint/sharepoint-ps/sharepoint-online/Get-SPORestrictedSiteCreation.md b/sharepoint/sharepoint-ps/sharepoint-online/Get-SPORestrictedSiteCreation.md
@@ -0,0 +1,77 @@
+---
+external help file: sharepointonline.xml
+Module Name: Microsoft.Online.SharePoint.PowerShell
+online version: https://learn.microsoft.com/powershell/module/sharepoint-online/get-sporestrictedsitecreation
+applicable: SharePoint Online
+title: Get-SPORestrictedSiteCreation
+schema: 2.0.0
+author: vgaddam-pm
+ms.author: vgaddam
+ms.reviewer:
+---
+
+# Get-SPORestrictedSiteCreation
+
+## SYNOPSIS
+
+This cmdlet allows SharePoint administrators to check the current configuration of the restricted site creation feature.
+
+## SYNTAX
+
+```powershell
+Get-SPORestrictedSiteCreation [-SiteType <RestrictedSiteCreationSiteType>]
+```
+
+## DESCRIPTION
+
+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.
+
+> [!Important]
+>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.
+
+## EXAMPLES
+
+### Example 1
+
+```powershell
+Get-SPORestrictedSiteCreation
+```
+
+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.
+
+### Example 2
+
+```powershell
+Get-SPORestrictedSiteCreation –SiteType Communication
+```
+
+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.
+
+## PARAMETERS
+
+### -SiteType
+When provided, only return the Microsoft Entra security groups configured for the specified site type.
+
+PARAMVALUE: All | SharePoint | OneDrive | Team | Communication
+•	All - OneDrive and all SharePoint sites 
+•	SharePoint - All SharePoint sites (but not OneDrive) 
+•	OneDrive - Only OneDrive 
+•	Team - Only SharePoint team sites (group-connected and classic) 
+•	Communication - Only SharePoint communication sites
+
+```yaml
+Type: RestrictedSiteCreationSiteType
+Parameter Sets: (All)
+Applicable: SharePoint Online
+Required: False
+Position: Named
+Default value: None
+Accept pipeline input: False
+Accept wildcard characters: False
+```
+
+## RELATED LINKS
+
+[Getting started with SharePoint Online Management Shell](/powershell/sharepoint/sharepoint-online/connect-sharepoint-online)
+
+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).
diff --git a/sharepoint/sharepoint-ps/sharepoint-online/Get-SPOUnifiedGroupMoveState.md b/sharepoint/sharepoint-ps/sharepoint-online/Get-SPOUnifiedGroupMoveState.md
@@ -103,11 +103,13 @@ The move status for the Office 365 Group. Possible values are:
 * 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).
 * Success: The move has completed successfully.
 * Failed: The move failed.
+* Stopped: The move was canceled by an administrator while it was still queued.
+* NotSupported: The move could not be processed because the Preferred Data Location was invalid.
+* Rescheduled: The move did not succeed and is being scheduled again for another attempt.
 
-## NOTES
-
-You can also apply the `-Verbose` option to see additional information about the move.
+> [!NOTE]
+> You can also apply the `-Verbose` option to see additional information about the move.
 
 ## RELATED LINKS
 
-[Move a SharePoint site to a different geo location](https://learn.microsoft.com/office365/enterprise/move-sharepoint-between-geo-locations)
+[Move a SharePoint site to a different geo location](/microsoft-365/enterprise/m365-dr-workload-spo)
diff --git a/sharepoint/sharepoint-ps/sharepoint-online/Get-SPOUserAndContentMoveState.md b/sharepoint/sharepoint-ps/sharepoint-online/Get-SPOUserAndContentMoveState.md
@@ -50,6 +50,9 @@ The following are the available move states:
 |InProgress| The move is in progress in one of the following states: Validation, Backup, Restore, Cleanup.|
 |Success| The move has completed successfully.|
 |Failed|The move failed.|
+|Stopped|The move was canceled by an administrator while it was still queued.|
+|NotSupported|The move could not be processed because the Preferred Data Location was invalid.|
+|Rescheduled|The move did not succeed and is being scheduled again for another attempt.|
 
 ## EXAMPLES
 

diff --git a/sharepoint/sharepoint-ps/sharepoint-online/Revoke-SPOUserSession.md b/sharepoint/sharepoint-ps/sharepoint-online/Revoke-SPOUserSession.md
@@ -39,9 +39,9 @@ Possible results for this cmdlet are:
 Result |                                                                                             Reason
 --- | ---
 Warning : We couldn't find the user@contoso.com. Check for typos and try again. |                    Invalid input for -User parameter.
-We successfully signed out <user> from all devices. |                                                Successful instantaneous revocation.
-It can take up to an hour to sign out <user> from all devices. |                                     Successful non-instantaneous revocation.
-Sorry, something went wrong and we couldn't sign out <user> from any device. |                       The cmdlet did not successfully execute.
+We successfully signed out \<user\> from all devices. |                                                Successful instantaneous revocation.
+It can take up to an hour to sign out \<user\> from all devices. |                                     Successful non-instantaneous revocation.
+Sorry, something went wrong and we couldn't sign out \<user\> from any device. |                       The cmdlet did not successfully execute.
 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.
 
 ## EXAMPLES

diff --git a/sharepoint/sharepoint-ps/sharepoint-online/Set-SPOCopilotPromoOptInStatus.md b/sharepoint/sharepoint-ps/sharepoint-online/Set-SPOCopilotPromoOptInStatus.md
@@ -29,12 +29,12 @@ This cmdlet sets the Opt-In Copilot promo status for the tenant to `True` or `Fa
 ### Example 1
 
 ```powershell
-Set-SPOCopilotPromoOptInStatusSetSuccessfully -SPOCopilotPromoOptInStatusEnabled $true
+Set-SPOCopilotPromoOptInStatus -IsCopilotPromoStatusEnabled $true
 ```
 
 Example 1 sets the Opt-In Copilot promo status for the tenant to `True`.
 
-### Parameter:
+## PARAMETERS
 
 ### -IsCopilotPromoStatusEnabled
 

diff --git a/sharepoint/sharepoint-ps/sharepoint-online/Set-SPOMigrationPackageAzureSource.md b/sharepoint/sharepoint-ps/sharepoint-online/Set-SPOMigrationPackageAzureSource.md
@@ -164,7 +164,7 @@ Accept wildcard characters: False
 
 ### -FileContainerName
 
-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.
+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.
 
 ```yaml
 Type: String
@@ -274,7 +274,7 @@ Accept wildcard characters: False
 
 ### -PackageContainerName
 
-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.
+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.
 
 ```yaml
 Type: String