Skip to content

New PS commands for Opt-in feature #854

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
wants to merge 8 commits into from
Closed
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Original file line number Diff line number Diff line change
@@ -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).

Copy link
Contributor

@samkabue samkabue Apr 3, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

(here and others)

use this updated version:

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).
``` #Closed

## INPUTS

### None

## OUTPUTS

### System.Object

## NOTES

## RELATED LINKS

[Start-SPOAuditDataCollectionForActivityInsights](./Start-SPOAuditDataCollectionForActivityInsights.md)
[Stop-SPOAuditDataCollectionForActivityInsights](./Stop-SPOAuditDataCollectionForActivityInsights.md)
[Start-SPODataAccessGovernanceInsight](./Start-SPODataAccessGovernanceInsight.md)
Original file line number Diff line number Diff line change
@@ -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)
Original file line number Diff line number Diff line change
@@ -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)
16 changes: 16 additions & 0 deletions sharepoint/sharepoint-ps/sharepoint-online/sharepoint-online.md
Original file line number Diff line number Diff line change
@@ -103,10 +103,18 @@ The following cmdlet references are for SharePoint Online.

{{Manually Enter Get-SPOAppInfo Description Here}}

### [Get-SPOAppPrioritizationPolicies](Get-SPOAppPrioritizationPolicies.md)

{{Gets all existing SPO app prioritization policies of your tenancy}}
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

of your tenancy

Suggested change
{{Gets all existing SPO app prioritization policies of your tenancy}}
in the tenant.

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@pvrk please fix. be sure to add . at the end as well.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Not our command, Sam. Modifying any text here or nearby is leading to a merge conflict error.


### [Get-SPOBuiltInFontPackageSettings](Get-SPOBuiltInFontPackageSettings.md)

{{Gets settings of built-in font packages.}}

### [Get-SPOAuditDataCollectionStatusForActivityInsights](Get-SPOAuditDataCollectionStatusForActivityInsights.md)

{{Gets the current status of audit data collection for reports on activities from the last 28 days.}}

### [Get-SPOCopilotAgentInsightsReport](Get-SPOCopilotAgentInsightsReport.md)

{{Gets the status of all active and available reports when no report ID is present, and allows to view or download a report if report ID is present.}}
@@ -640,6 +648,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.}}
@@ -652,6 +664,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}}