Documentation for Opt-in

sharepoint/sharepoint-ps/sharepoint-online/Get-SPOAuditDataCollectionStatusForActivityInsights.md

@@ -0,0 +1,78 @@
+---
+external help file: sharepointonline.xml
+Module Name: Microsoft.Online.SharePoint.PowerShell
+online version: https://learn.microsoft.com/powershell/module/sharepoint-online/get-spoauditdatacollectionstatusforactivityinsights
+applicable: SharePoint Online
+title: Get-SPOAuditDataCollectionStatusForActivityInsights
+schema: 2.0.0
+author: pvrk
+ms.author: pullabhk
+manager: 
+ms.reviewer:
+---
+
+# Get-SPOAuditDataCollectionStatusForActivityInsights
+
+## SYNOPSIS
+
+Lists the current status of audit data collection for reports on activities from the last 28 days in the SharePoint admin center.
+
+## SYNTAX
+
+```
+Get-SPOAuditDataCollectionStatusForActivityInsights [-ReportEntity <OptInReportEntityEnum>]
+ [<CommonParameters>]
+```
+
+## DESCRIPTION
+
+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.
+
+## EXAMPLES
+
+### Example 1
+
+```powershell
+Get-SPOAuditDataCollectionStatusForActivityInsights -ReportEntity SharingLinks_Anyone
+```
+
+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.
+
+## PARAMETERS
+
+### -ReportEntity
+
+Specifies the entity for which the corresponding audit data collection status should be shown.
+
+```yaml
+Type: OptInReportEntityEnum
+Parameter Sets: (All)
+Aliases:
+Accepted values: SharingLinksAnyone, SharingLinksPeopleInYourOrg, SharingLinksGuests, EveryoneExceptExternalUsersAtSite, EveryoneExceptExternalUsersForItems, CopilotAppInsights
+
+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`, `-ProgressAction`, `-Verbose`, `-WarningAction`, and `-WarningVariable`. For more information, see [about_CommonParameters](/powershell/module/microsoft.powershell.core/about/about_commonparameters).
+
+## INPUTS
+
+### None
+
+## OUTPUTS
+
+### System.Object
+
+## NOTES
+
+## RELATED LINKS
+
+[Start-SPOAuditDataCollectionForActivityInsights](./Start-SPOAuditDataCollectionForActivityInsights.md)
+[Stop-SPOAuditDataCollectionForActivityInsights](./Stop-SPOAuditDataCollectionForActivityInsights.md)
+[Start-SPODataAccessGovernanceInsight](./Start-SPODataAccessGovernanceInsight.md)

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

@@ -0,0 +1,81 @@
+---
+external help file: sharepointonline.xml
+Module Name: Microsoft.Online.SharePoint.PowerShell
+online version: https://learn.microsoft.com/powershell/module/sharepoint-online/start-spoauditdatacollectionforactivityinsights
+applicable: SharePoint Online
+title: Start-SPOAuditDataCollectionForActivityInsights
+schema: 2.0.0
+author: pvrk
+ms.author: pullabhk
+manager: 
+ms.reviewer:
+---
+
+# Start-SPOAuditDataCollectionForActivityInsights
+
+## SYNOPSIS
+
+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.
+
+## SYNTAX
+
+```
+Start-SPOAuditDataCollectionForActivityInsights -ReportEntity <OptInReportEntityEnum> [<CommonParameters>]
+```
+
+## DESCRIPTION
+
+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:
+
+- Sharing links created in the last 28 days (Anyone, People in Your Organization, Specific people shared externally).
+- Content shared with Everyone except external users (EEEU) in the last 28 days.
+- Copilot agents created in the last 28 days *(Private Preview)*.
+
+## EXAMPLES
+
+### Example 1
+
+```powershell
+Start-SPOAuditDataCollectionForActivityInsights -ReportEntity SharingLinks_Anyone
+```
+
+This example will start collecting audit data related to the generation of 'Anyone' sharing links from the moment the cmdlet is executed.
+
+## PARAMETERS
+
+### -ReportEntity
+
+Specifies the entity for which the corresponding audit data should be collected.
+
+```yaml
+Type: OptInReportEntityEnum
+Parameter Sets: (All)
+Aliases:
+Accepted values: SharingLinksAnyone, SharingLinksPeopleInYourOrg, SharingLinksGuests, EveryoneExceptExternalUsersAtSite, EveryoneExceptExternalUsersForItems, CopilotAppInsights
+
+Required: True
+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`, `-ProgressAction`, `-Verbose`, `-WarningAction`, and `-WarningVariable`. For more information, see [about_CommonParameters](/powershell/module/microsoft.powershell.core/about/about_commonparameters).
+
+## INPUTS
+
+### None
+
+## OUTPUTS
+
+### System.Object
+
+## NOTES
+
+## RELATED LINKS
+
+[Stop-SPOAuditDataCollectionForActivityInsights](./Stop-SPOAuditDataCollectionForActivityInsights.md)
+[Get-SPOAuditDataCollectionStatusForActivityInsights](./Get-SPOAuditDataCollectionStatusForActivityInsights.md)
+[Start-SPODataAccessGovernanceInsight](./Start-SPODataAccessGovernanceInsight.md)

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

@@ -0,0 +1,80 @@
+---
+external help file: sharepointonline.xml
+Module Name: Microsoft.Online.SharePoint.PowerShell
+online version: https://learn.microsoft.com/powershell/module/sharepoint-online/stop-spoauditdatacollectionforactivityinsights
+applicable: SharePoint Online
+title: Stop-SPOAuditDataCollectionForActivityInsights
+schema: 2.0.0
+author: pvrk
+ms.author: pullabhk
+manager: 
+ms.reviewer:
+---
+
+# Stop-SPOAuditDataCollectionForActivityInsights
+
+## SYNOPSIS
+
+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.
+
+## SYNTAX
+
+```
+Stop-SPOAuditDataCollectionForActivityInsights -ReportEntity <OptInReportEntityEnum> [<CommonParameters>]
+```
+
+## DESCRIPTION
+This cmdlet stops collecting relevant audit data for reports, based on activites related to sharing and access. Reports are available for the following scenarios:
+
+- Sharing links created in the last 28 days (Anyone, People in Your Organization, Specific people shared externally).
+- Content shared with Everyone except external users (EEEU) in the last 28 days.
+- Copilot agents created in the last 28 days *(Private Preview)*.
+
+## EXAMPLES
+
+### Example 1
+
+```powershell
+Stop-SPOAuditDataCollectionForActivityInsights -ReportEntity SharingLinks_Anyone
+```
+
+This example will stop collecting audit data related to the generation of 'Anyone' sharing links from the moment the cmdlet is executed.
+
+## PARAMETERS
+
+### -ReportEntity
+
+Specifies the entity for which the corresponding audit data should not be collected.
+
+```yaml
+Type: OptInReportEntityEnum
+Parameter Sets: (All)
+Aliases:
+Accepted values: SharingLinksAnyone, SharingLinksPeopleInYourOrg, SharingLinksGuests, EveryoneExceptExternalUsersAtSite, EveryoneExceptExternalUsersForItems, CopilotAppInsights
+
+Required: True
+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`, `-ProgressAction`, `-Verbose`, `-WarningAction`, and `-WarningVariable`. For more information, see [about_CommonParameters](/powershell/module/microsoft.powershell.core/about/about_commonparameters).
+
+## INPUTS
+
+### None
+
+## OUTPUTS
+
+### System.Object
+
+## NOTES
+
+## RELATED LINKS
+
+[Start-SPOAuditDataCollectionForActivityInsights](./Start-SPOAuditDataCollectionForActivityInsights.md)
+[Get-SPOAuditDataCollectionStatusForActivityInsights](./Get-SPOAuditDataCollectionStatusForActivityInsights.md)
+[Start-SPODataAccessGovernanceInsight](./Start-SPODataAccessGovernanceInsight.md)

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

@@ -668,6 +668,10 @@ This cmdlet is not currently active in production and may be removed in the futu
 
 {{Manually Enter Set-SPOUser Description Here}}
 
+### [Start-SPOAuditDataCollectionForActivityInsights](Start-SPOAuditDataCollectionForActivityInsights.md)
+
+{{Starts collecting audit data for reports on activities from the last 28 days.}}
+
 ### [Start-SPOCopilotAgentInsightsReport](Start-SPOCopilotAgentInsightsReport.md)
 
 {{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
 
 {{Manually Enter Start-SPOUserAndContentMove Description Here}}
 
+### [Stop-SPOAuditDataCollectionForActivityInsights](Stop-SPOAuditDataCollectionForActivityInsights.md)
+
+{{Stops collecting audit data for reports on activities from the last 28 days.}}
+
 ### [Stop-SPOUserAndContentMove](Stop-SPOUserAndContentMove.md)
 
 {{Manually Enter Stop-SPOUserAndContentMove Description Here}}