Skip to content

Commit 5fb7a9e

Browse files
Ruchika-mittal01Ruchika-mittal01
authored
Merge branch 'main' into patch-1
2 parents 224a7d2 + d4c02d5 commit 5fb7a9e

20 files changed

+1453
-45
lines changed

‎.openpublishing.redirection.json‎

Lines changed: 1 addition & 31 deletions
Original file line numberDiff line numberDiff line change
@@ -5,21 +5,6 @@
55
"redirect_url": "/powershell/module/sharepoint-online",
66
"redirect_document_id": false
77
},
8-
{
9-
"source_path": "sharepoint/virtual-folder/sharepoint-online/Export-SPODataAccessGovernanceInsight.md",
10-
"redirect_url": "/powershell/module/sharepoint-online",
11-
"redirect_document_id": false
12-
},
13-
{
14-
"source_path": "sharepoint/virtual-folder/sharepoint-online/Get-SPODataAccessGovernanceInsight.md",
15-
"redirect_url": "/powershell/module/sharepoint-online",
16-
"redirect_document_id": false
17-
},
18-
{
19-
"source_path": "sharepoint/virtual-folder/sharepoint-online/Get-SPOSiteReview.md",
20-
"redirect_url": "/powershell/module/sharepoint-online",
21-
"redirect_document_id": false
22-
},
238
{
249
"source_path": "sharepoint/virtual-folder/sharepoint-online/Get-SPOTenantRestrictedSearchAllowedList.md",
2510
"redirect_url": "/powershell/module/sharepoint-online",
@@ -30,11 +15,6 @@
3015
"redirect_url": "/powershell/module/sharepoint-online",
3116
"redirect_document_id": false
3217
},
33-
{
34-
"source_path": "sharepoint/virtual-folder/sharepoint-online/Remove-SPODataAccessGovernanceInsight.md",
35-
"redirect_url": "/powershell/module/sharepoint-online",
36-
"redirect_document_id": false
37-
},
3818
{
3919
"source_path": "sharepoint/virtual-folder/sharepoint-online/Remove-SPOTenantRestrictedSearchAllowedList.md",
4020
"redirect_url": "/powershell/module/sharepoint-online",
@@ -44,16 +24,6 @@
4424
"source_path": "sharepoint/virtual-folder/sharepoint-online/Set-SPOTenantRestrictedSearchMode.md",
4525
"redirect_url": "/powershell/module/sharepoint-online",
4626
"redirect_document_id": false
47-
},
48-
{
49-
"source_path": "sharepoint/virtual-folder/sharepoint-online/Start-SPODataAccessGovernanceInsight.md",
50-
"redirect_url": "/powershell/module/sharepoint-online",
51-
"redirect_document_id": false
52-
},
53-
{
54-
"source_path": "sharepoint/virtual-folder/sharepoint-online/Start-SPOSiteReview.md",
55-
"redirect_url": "/powershell/module/sharepoint-online",
56-
"redirect_document_id": false
57-
}
27+
}
5828
]
5929
}

‎sharepoint/sharepoint-ps/sharepoint-online/Export-SPODataAccessGovernanceInsight.md‎

Lines changed: 98 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,98 @@
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/export-spodataaccessgovernanceinsight
5+
applicable: SharePoint Online
6+
title: Export-SPODataAccessGovernanceInsight
7+
schema: 2.0.0
8+
author: pvrk
9+
ms.author: pullabhk
10+
manager:
11+
ms.reviewer:
12+
---
13+
14+
# Export-SPODataAccessGovernanceInsight
15+
16+
## SYNOPSIS
17+
18+
This cmdlet downloads the Data Access Governance (DAG) reports to the specified path. The default is the "Downloads" folder.
19+
20+
## SYNTAX
21+
22+
```
23+
Export-SPODataAccessGovernanceInsight -ReportID <Guid> [<CommonParameters>]
24+
```
25+
26+
## DESCRIPTION
27+
28+
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.
29+
30+
## EXAMPLES
31+
32+
### Example 1
33+
34+
```powershell
35+
Export-SPODataAccessGovernanceInsight -ReportID 28f4c550-215a-472b-a123-c11e5fa8804c
36+
```
37+
38+
The above example downloads the report of the given ID to the current working directory.
39+
40+
## PARAMETERS
41+
42+
### -ReportID
43+
44+
Specifies the ID of the DAG report to be downloaded.
45+
46+
```yaml
47+
Type: Guid
48+
Parameter Sets: (All)
49+
Aliases:
50+
51+
Required: True
52+
Position: Named
53+
Default value: None
54+
Accept pipeline input: False
55+
Accept wildcard characters: False
56+
```
57+
58+
### -DownloadPath
59+
60+
Specifies the path to which the report should be downloaded. The default path is the "Downloads" folder.
61+
62+
```yaml
63+
Type: String
64+
Parameter Sets: (All)
65+
Aliases:
66+
67+
Required: False
68+
Position: Named
69+
Default value: None
70+
Accept pipeline input: False
71+
Accept wildcard characters: False
72+
```
73+
74+
### CommonParameters
75+
76+
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).
77+
78+
## INPUTS
79+
80+
### None
81+
82+
## OUTPUTS
83+
84+
### System.Object
85+
86+
## NOTES
87+
88+
## RELATED LINKS
89+
90+
[Start-SPODataAccessGovernanceInsight](./Start-SPODataAccessGovernanceInsight.md)
91+
92+
[Get-SPODataAccessGovernanceInsight](./Get-SPODataAccessGovernanceInsight.md)
93+
94+
[Remove-SPODataAccessGovernanceInsight](./Remove-SPODataAccessGovernanceInsight.md)
95+
96+
[Start-SPOSiteReview](./Start-SPOSiteReview.md)
97+
98+
[Get-SPOSiteReview](./Get-SPOSiteReview.md)

‎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.

0 commit comments

Comments
 (0)