Skip to content

Commit 48916d9

Browse files
pvrkpvrk
committed
New PS commands for Opt-in feature
1 parent 8a5eae8 commit 48916d9

File tree

3 files changed

+234
-0
lines changed

3 files changed

+234
-0
lines changed

‎sharepoint/sharepoint-ps/sharepoint-online/Get-SPOAuditDataCollectionStatusForActivityInsights.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-spoauditdatacollectionstatusforactivityinsights
5+
applicable: SharePoint Online
6+
title: Get-SPOAuditDataCollectionStatusForActivityInsights
7+
schema: 2.0.0
8+
author: pvrk
9+
ms.author: pullabhk
10+
manager:
11+
ms.reviewer:
12+
---
13+
14+
# Get-SPOAuditDataCollectionStatusForActivityInsights
15+
16+
## SYNOPSIS
17+
18+
Lists the current status of audit data collection for reports based on activities within the last 28 days, from SharePoint Admin Center.
19+
20+
## SYNTAX
21+
22+
```
23+
Get-SPOAuditDataCollectionStatusForActivityInsights [-ReportEntity <OptInReportEntityEnum>]
24+
[<CommonParameters>]
25+
```
26+
27+
## DESCRIPTION
28+
29+
SharePoint administrators can generate reports based on activities within the last 28 days such as Sharing link reports, content shared with Everyone except external users etc from SharePoint admin center. These reports require audit data to be collected after approved by SharePoint admin. This command gives the current status of the relevant audit data collection.
30+
31+
## EXAMPLES
32+
33+
### Example 1
34+
35+
```powershell
36+
PS C:\> Get-SPOAuditDataCollectionStatusForActivityInsights -ReportEntity SharingLinks_Anyone
37+
```
38+
39+
This command fetches the current status of audit data collection for the report on sites with most number of "Anyone" sharing links generated in the last 28 days.
40+
41+
## PARAMETERS
42+
43+
### -ReportEntity
44+
45+
Specifies the entity for which the corresponding audit data collection status should be shown
46+
47+
```yaml
48+
Type: OptInReportEntityEnum
49+
Parameter Sets: (All)
50+
Aliases:
51+
Accepted values: SharingLinks_Anyone, SharingLinks_PeopleInYourOrg, SharingLinks_Guests, EveryoneExceptExternalUsersAtSite, EveryoneExceptExternalUsersForItems, CopilotAppInsights
52+
53+
Required: False
54+
Position: Named
55+
Default value: None
56+
Accept pipeline input: False
57+
Accept wildcard characters: False
58+
```
59+
60+
### CommonParameters
61+
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).
62+
63+
## INPUTS
64+
65+
### None
66+
67+
## OUTPUTS
68+
69+
### System.Object
70+
71+
## NOTES
72+
73+
## RELATED LINKS
74+
75+
[Start-SPOAuditDataCollectionForActivityInsights](./Start-SPOAuditDataCollectionForActivityInsights.md)
76+
[Stop-SPOAuditDataCollectionForActivityInsights](./Stop-SPOAuditDataCollectionForActivityInsights.md)
77+
[Start-SPODataAccessGovernanceInsight](./Start-SPODataAccessGovernanceInsight.md)

‎sharepoint/sharepoint-ps/sharepoint-online/Start-SPOAuditDataCollectionForActivityInsights.md‎

Lines changed: 79 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,79 @@
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/start-spoauditdatacollectionforactivityinsights
5+
applicable: SharePoint Online
6+
title: Start-SPOAuditDataCollectionForActivityInsights
7+
schema: 2.0.0
8+
author: pvrk
9+
ms.author: pullabhk
10+
manager:
11+
ms.reviewer:
12+
---
13+
14+
# Start-SPOAuditDataCollectionForActivityInsights
15+
16+
## SYNOPSIS
17+
18+
This cmdlet starts collecting relevant audit data for reports, based on activities within the last 28 days, such as Sharing link reports, content shared with Everyone except external users etc from SharePoint admin center.
19+
20+
## SYNTAX
21+
22+
```
23+
Start-SPOAuditDataCollectionForActivityInsights -ReportEntity <OptInReportEntityEnum> [<CommonParameters>]
24+
```
25+
26+
## DESCRIPTION
27+
28+
This cmdlet starts collecting relevant audit data for reports, based on activites related to sharing and access. Reports are available for the following scenarios:
29+
30+
- Sharing links created in last 28 days (Anyone, People-in-your-org, Specific people shared externally).
31+
- Content shared with Everyone except external users (EEEU) in last 28 days.
32+
- Copilot agents created in last 28 days *(Private Preview)*
33+
34+
## EXAMPLES
35+
36+
### Example 1
37+
```powershell
38+
PS C:\> Start-SPOAuditDataCollectionForActivityInsights -ReportEntity SharingLinks_Anyone
39+
```
40+
41+
This cmdlet will start collecting audit data related to the generation of 'Anyone' sharing links from the moment it is executed.
42+
43+
## PARAMETERS
44+
45+
### -ReportEntity
46+
47+
Specifies the entity for which the corresponding audit data should be collected.
48+
49+
```yaml
50+
Type: OptInReportEntityEnum
51+
Parameter Sets: (All)
52+
Aliases:
53+
Accepted values: SharingLinks_Anyone, SharingLinks_PeopleInYourOrg, SharingLinks_Guests, EveryoneExceptExternalUsersAtSite, EveryoneExceptExternalUsersForItems, CopilotAppInsights
54+
55+
Required: True
56+
Position: Named
57+
Default value: None
58+
Accept pipeline input: False
59+
Accept wildcard characters: False
60+
```
61+
62+
### CommonParameters
63+
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).
64+
65+
## INPUTS
66+
67+
### None
68+
69+
## OUTPUTS
70+
71+
### System.Object
72+
73+
## NOTES
74+
75+
## RELATED LINKS
76+
77+
[Stop-SPOAuditDataCollectionForActivityInsights](./Stop-SPOAuditDataCollectionForActivityInsights.md)
78+
[Get-SPOAuditDataCollectionStatusForActivityInsights](./Get-SPOAuditDataCollectionStatusForActivityInsights.md)
79+
[Start-SPODataAccessGovernanceInsight](./Start-SPODataAccessGovernanceInsight.md)

‎sharepoint/sharepoint-ps/sharepoint-online/Stop-SPOAuditDataCollectionForActivityInsights.md‎

Lines changed: 78 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,78 @@
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/stop-spoauditdatacollectionforactivityinsights
5+
applicable: SharePoint Online
6+
title: Stop-SPOAuditDataCollectionForActivityInsights
7+
schema: 2.0.0
8+
author: pvrk
9+
ms.author: pullabhk
10+
manager:
11+
ms.reviewer:
12+
---
13+
14+
# Stop-SPOAuditDataCollectionForActivityInsights
15+
16+
## SYNOPSIS
17+
18+
This cmdlet stops collecting relevant audit data for reports, based on activities within the last 28 days, such as Sharing link reports, content shared with Everyone except external users etc from SharePoint admin center.
19+
20+
## SYNTAX
21+
22+
```
23+
Stop-SPOAuditDataCollectionForActivityInsights -ReportEntity <OptInReportEntityEnum> [<CommonParameters>]
24+
```
25+
26+
## DESCRIPTION
27+
This cmdlet stops collecting relevant audit data for reports, based on activites related to sharing and access. Reports are available for the following scenarios:
28+
29+
- Sharing links created in last 28 days (Anyone, People-in-your-org, Specific people shared externally).
30+
- Content shared with Everyone except external users (EEEU) in last 28 days.
31+
- Copilot agents created in last 28 days *(Private Preview)*
32+
33+
## EXAMPLES
34+
35+
### Example 1
36+
```powershell
37+
PS C:\> Stop-SPOAuditDataCollectionForActivityInsights -ReportEntity SharingLinks_Anyone
38+
```
39+
40+
This cmdlet will stop collecting audit data related to the generation of 'Anyone' sharing links from the moment it is executed.
41+
42+
## PARAMETERS
43+
44+
### -ReportEntity
45+
46+
Specifies the entity for which the corresponding audit data should not be collected.
47+
48+
```yaml
49+
Type: OptInReportEntityEnum
50+
Parameter Sets: (All)
51+
Aliases:
52+
Accepted values: SharingLinks_Anyone, SharingLinks_PeopleInYourOrg, SharingLinks_Guests, EveryoneExceptExternalUsersAtSite, EveryoneExceptExternalUsersForItems, CopilotAppInsights
53+
54+
Required: True
55+
Position: Named
56+
Default value: None
57+
Accept pipeline input: False
58+
Accept wildcard characters: False
59+
```
60+
61+
### CommonParameters
62+
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).
63+
64+
## INPUTS
65+
66+
### None
67+
68+
## OUTPUTS
69+
70+
### System.Object
71+
72+
## NOTES
73+
74+
## RELATED LINKS
75+
76+
[Start-SPOAuditDataCollectionForActivityInsights](./Start-SPOAuditDataCollectionForActivityInsights.md)
77+
[Get-SPOAuditDataCollectionStatusForActivityInsights](./Get-SPOAuditDataCollectionStatusForActivityInsights.md)
78+
[Start-SPODataAccessGovernanceInsight](./Start-SPODataAccessGovernanceInsight.md)

0 commit comments

Comments
 (0)