Skip to content

Commit 4c9f02e

Browse files
pvrkpvrk
committed
Documentation for Opt-in
1 parent 997c313 commit 4c9f02e

File tree

4 files changed

+247
-0
lines changed

4 files changed

+247
-0
lines changed

‎sharepoint/sharepoint-ps/sharepoint-online/Get-SPOAuditDataCollectionStatusForActivityInsights.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/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 on activities from the last 28 days in the 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 on activities from the last 28 days, such as sharing link reports and content shared with everyone except external users, from the SharePoint admin center. These reports need audit data, which must be collected after approval by the SharePoint Administrator. This cmdlet shows the current status of the audit data collection.
30+
31+
## EXAMPLES
32+
33+
### Example 1
34+
35+
```powershell
36+
Get-SPOAuditDataCollectionStatusForActivityInsights -ReportEntity SharingLinks_Anyone
37+
```
38+
39+
This example 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: SharingLinksAnyone, SharingLinksPeopleInYourOrg, SharingLinksGuests, 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+
62+
This cmdlet supports the common parameters: `-Debug`, `-ErrorAction`, `-ErrorVariable`, `-InformationAction`, `-InformationVariable`, `-OutVariable`, `-OutBuffer`, `-PipelineVariable`, `-ProgressAction`, `-Verbose`, `-WarningAction`, and `-WarningVariable`. For more information, see [about_CommonParameters](/powershell/module/microsoft.powershell.core/about/about_commonparameters).
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+
[Stop-SPOAuditDataCollectionForActivityInsights](./Stop-SPOAuditDataCollectionForActivityInsights.md)
78+
[Start-SPODataAccessGovernanceInsight](./Start-SPODataAccessGovernanceInsight.md)

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

Lines changed: 81 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,81 @@
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 audit data for reports on activities from the last 28 days, such as sharing link reports and content shared with everyone except external users, from the SharePoint admin center.
19+
20+
## SYNTAX
21+
22+
```
23+
Start-SPOAuditDataCollectionForActivityInsights -ReportEntity <OptInReportEntityEnum> [<CommonParameters>]
24+
```
25+
26+
## DESCRIPTION
27+
28+
This cmdlet starts collecting audit data for reports on sharing and access activities from the last 28 days. Reports are available for the following scenarios:
29+
30+
- Sharing links created in the last 28 days (Anyone, People in Your Organization, Specific people shared externally).
31+
- Content shared with Everyone except external users (EEEU) in the last 28 days.
32+
- Copilot agents created in the last 28 days *(Private Preview)*.
33+
34+
## EXAMPLES
35+
36+
### Example 1
37+
38+
```powershell
39+
Start-SPOAuditDataCollectionForActivityInsights -ReportEntity SharingLinks_Anyone
40+
```
41+
42+
This example will start collecting audit data related to the generation of 'Anyone' sharing links from the moment the cmdlet is executed.
43+
44+
## PARAMETERS
45+
46+
### -ReportEntity
47+
48+
Specifies the entity for which the corresponding audit data should be collected.
49+
50+
```yaml
51+
Type: OptInReportEntityEnum
52+
Parameter Sets: (All)
53+
Aliases:
54+
Accepted values: SharingLinksAnyone, SharingLinksPeopleInYourOrg, SharingLinksGuests, EveryoneExceptExternalUsersAtSite, EveryoneExceptExternalUsersForItems, CopilotAppInsights
55+
56+
Required: True
57+
Position: Named
58+
Default value: None
59+
Accept pipeline input: False
60+
Accept wildcard characters: False
61+
```
62+
63+
### CommonParameters
64+
65+
This cmdlet supports the common parameters: `-Debug`, `-ErrorAction`, `-ErrorVariable`, `-InformationAction`, `-InformationVariable`, `-OutVariable`, `-OutBuffer`, `-PipelineVariable`, `-ProgressAction`, `-Verbose`, `-WarningAction`, and `-WarningVariable`. For more information, see [about_CommonParameters](/powershell/module/microsoft.powershell.core/about/about_commonparameters).
66+
67+
## INPUTS
68+
69+
### None
70+
71+
## OUTPUTS
72+
73+
### System.Object
74+
75+
## NOTES
76+
77+
## RELATED LINKS
78+
79+
[Stop-SPOAuditDataCollectionForActivityInsights](./Stop-SPOAuditDataCollectionForActivityInsights.md)
80+
[Get-SPOAuditDataCollectionStatusForActivityInsights](./Get-SPOAuditDataCollectionStatusForActivityInsights.md)
81+
[Start-SPODataAccessGovernanceInsight](./Start-SPODataAccessGovernanceInsight.md)

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

Lines changed: 80 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,80 @@
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 audit data for reports on activities from the last 28 days, such as sharing link reports and content shared with everyone except external users, from the 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 the last 28 days (Anyone, People in Your Organization, Specific people shared externally).
30+
- Content shared with Everyone except external users (EEEU) in the last 28 days.
31+
- Copilot agents created in the last 28 days *(Private Preview)*.
32+
33+
## EXAMPLES
34+
35+
### Example 1
36+
37+
```powershell
38+
Stop-SPOAuditDataCollectionForActivityInsights -ReportEntity SharingLinks_Anyone
39+
```
40+
41+
This example will stop collecting audit data related to the generation of 'Anyone' sharing links from the moment the cmdlet is executed.
42+
43+
## PARAMETERS
44+
45+
### -ReportEntity
46+
47+
Specifies the entity for which the corresponding audit data should not be collected.
48+
49+
```yaml
50+
Type: OptInReportEntityEnum
51+
Parameter Sets: (All)
52+
Aliases:
53+
Accepted values: SharingLinksAnyone, SharingLinksPeopleInYourOrg, SharingLinksGuests, 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+
64+
This cmdlet supports the common parameters: `-Debug`, `-ErrorAction`, `-ErrorVariable`, `-InformationAction`, `-InformationVariable`, `-OutVariable`, `-OutBuffer`, `-PipelineVariable`, `-ProgressAction`, `-Verbose`, `-WarningAction`, and `-WarningVariable`. For more information, see [about_CommonParameters](/powershell/module/microsoft.powershell.core/about/about_commonparameters).
65+
66+
## INPUTS
67+
68+
### None
69+
70+
## OUTPUTS
71+
72+
### System.Object
73+
74+
## NOTES
75+
76+
## RELATED LINKS
77+
78+
[Start-SPOAuditDataCollectionForActivityInsights](./Start-SPOAuditDataCollectionForActivityInsights.md)
79+
[Get-SPOAuditDataCollectionStatusForActivityInsights](./Get-SPOAuditDataCollectionStatusForActivityInsights.md)
80+
[Start-SPODataAccessGovernanceInsight](./Start-SPODataAccessGovernanceInsight.md)

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

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -668,6 +668,10 @@ This cmdlet is not currently active in production and may be removed in the futu
668668

669669
{{Manually Enter Set-SPOUser Description Here}}
670670

671+
### [Start-SPOAuditDataCollectionForActivityInsights](Start-SPOAuditDataCollectionForActivityInsights.md)
672+
673+
{{Starts collecting audit data for reports on activities from the last 28 days.}}
674+
671675
### [Start-SPOCopilotAgentInsightsReport](Start-SPOCopilotAgentInsightsReport.md)
672676

673677
{{Triggers the build of a new Copilot agent insight report for the specified number of days.}}
@@ -684,6 +688,10 @@ This cmdlet is not currently active in production and may be removed in the futu
684688

685689
{{Manually Enter Start-SPOUserAndContentMove Description Here}}
686690

691+
### [Stop-SPOAuditDataCollectionForActivityInsights](Stop-SPOAuditDataCollectionForActivityInsights.md)
692+
693+
{{Stops collecting audit data for reports on activities from the last 28 days.}}
694+
687695
### [Stop-SPOUserAndContentMove](Stop-SPOUserAndContentMove.md)
688696

689697
{{Manually Enter Stop-SPOUserAndContentMove Description Here}}

0 commit comments

Comments
 (0)