Merge branch 'main' into patch-1

MicrosoftDocs · Jan 2, 2025 · 5fb7a9e · 5fb7a9e
2 parents 224a7d2 + d4c02d5
commit 5fb7a9e
Show file tree

Hide file tree

Showing 20 changed files with 1,453 additions and 45 deletions.
diff --git a/.openpublishing.redirection.json b/.openpublishing.redirection.json
@@ -5,21 +5,6 @@
       "redirect_url": "/powershell/module/sharepoint-online",
       "redirect_document_id": false
     },
-    {
-      "source_path": "sharepoint/virtual-folder/sharepoint-online/Export-SPODataAccessGovernanceInsight.md",
-      "redirect_url": "/powershell/module/sharepoint-online",
-      "redirect_document_id": false
-    },
-    {
-      "source_path": "sharepoint/virtual-folder/sharepoint-online/Get-SPODataAccessGovernanceInsight.md",
-      "redirect_url": "/powershell/module/sharepoint-online",
-      "redirect_document_id": false
-    },
-    {
-      "source_path": "sharepoint/virtual-folder/sharepoint-online/Get-SPOSiteReview.md",
-      "redirect_url": "/powershell/module/sharepoint-online",
-      "redirect_document_id": false
-    },
     {
       "source_path": "sharepoint/virtual-folder/sharepoint-online/Get-SPOTenantRestrictedSearchAllowedList.md",
       "redirect_url": "/powershell/module/sharepoint-online",
@@ -30,11 +15,6 @@
       "redirect_url": "/powershell/module/sharepoint-online",
       "redirect_document_id": false
     },
-    {
-      "source_path": "sharepoint/virtual-folder/sharepoint-online/Remove-SPODataAccessGovernanceInsight.md",
-      "redirect_url": "/powershell/module/sharepoint-online",
-      "redirect_document_id": false
-    },
     {
       "source_path": "sharepoint/virtual-folder/sharepoint-online/Remove-SPOTenantRestrictedSearchAllowedList.md",
       "redirect_url": "/powershell/module/sharepoint-online",
@@ -44,16 +24,6 @@
       "source_path": "sharepoint/virtual-folder/sharepoint-online/Set-SPOTenantRestrictedSearchMode.md",
       "redirect_url": "/powershell/module/sharepoint-online",
       "redirect_document_id": false
-    },
-    {
-      "source_path": "sharepoint/virtual-folder/sharepoint-online/Start-SPODataAccessGovernanceInsight.md",
-      "redirect_url": "/powershell/module/sharepoint-online",
-      "redirect_document_id": false
-    },
-    {
-      "source_path": "sharepoint/virtual-folder/sharepoint-online/Start-SPOSiteReview.md",
-      "redirect_url": "/powershell/module/sharepoint-online",
-      "redirect_document_id": false
-    }
+    }    
   ]
 }
diff --git a/...epoint/sharepoint-ps/sharepoint-online/Export-SPODataAccessGovernanceInsight.md b/...epoint/sharepoint-ps/sharepoint-online/Export-SPODataAccessGovernanceInsight.md
@@ -0,0 +1,98 @@
+---
+external help file: sharepointonline.xml
+Module Name: Microsoft.Online.SharePoint.PowerShell
+online version: https://learn.microsoft.com/powershell/module/sharepoint-online/export-spodataaccessgovernanceinsight
+applicable: SharePoint Online
+title: Export-SPODataAccessGovernanceInsight
+schema: 2.0.0
+author: pvrk
+ms.author: pullabhk
+manager: 
+ms.reviewer:
+---
+
+# Export-SPODataAccessGovernanceInsight
+
+## SYNOPSIS
+
+This cmdlet downloads the Data Access Governance (DAG) reports to the specified path. The default is the "Downloads" folder.
+
+## SYNTAX
+
+```
+Export-SPODataAccessGovernanceInsight -ReportID <Guid> [<CommonParameters>]
+```
+
+## DESCRIPTION
+
+This cmdlet exports or downloads the DAG report, specified by the `ReportID`, to the path as specified with `DownloadPath`. If not specified, the commands downloads the report to the "Downloads" folder. The `ReportID` is shown in the output of the [Start-SPODataAccessGovernanceInsight](./Start-SPODataAccessGovernanceInsight.md) command. It can also be fetched from the output of the [Get-SPODataAccessGovernanceInsight](./Get-SPODataAccessGovernanceInsight.md) command.
+
+## EXAMPLES
+
+### Example 1
+
+```powershell
+Export-SPODataAccessGovernanceInsight -ReportID 28f4c550-215a-472b-a123-c11e5fa8804c
+```
+
+The above example downloads the report of the given ID to the current working directory.
+
+## PARAMETERS
+
+### -ReportID
+
+Specifies the ID of the DAG report to be downloaded.
+
+```yaml
+Type: Guid
+Parameter Sets: (All)
+Aliases:
+
+Required: True
+Position: Named
+Default value: None
+Accept pipeline input: False
+Accept wildcard characters: False
+```
+
+### -DownloadPath
+
+Specifies the path to which the report should be downloaded. The default path is the "Downloads" folder.
+
+```yaml
+Type: String
+Parameter Sets: (All)
+Aliases:
+
+Required: False
+Position: Named
+Default value: None
+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](http://go.microsoft.com/fwlink/?LinkID=113216).
+
+## INPUTS
+
+### None
+
+## OUTPUTS
+
+### System.Object
+
+## NOTES
+
+## RELATED LINKS
+
+[Start-SPODataAccessGovernanceInsight](./Start-SPODataAccessGovernanceInsight.md)
+
+[Get-SPODataAccessGovernanceInsight](./Get-SPODataAccessGovernanceInsight.md)
+
+[Remove-SPODataAccessGovernanceInsight](./Remove-SPODataAccessGovernanceInsight.md)
+
+[Start-SPOSiteReview](./Start-SPOSiteReview.md)
+
+[Get-SPOSiteReview](./Get-SPOSiteReview.md)
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.