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

Conversation

pvrk
Copy link
Contributor

@pvrk pvrk commented Apr 1, 2025

No description provided.

Copy link
Contributor

Learn Build status updates of commit 48916d9:

✅ Validation status: passed

File Status Preview URL Details
sharepoint/sharepoint-ps/sharepoint-online/Get-SPOAuditDataCollectionStatusForActivityInsights.md ✅Succeeded View (sharepoint-ps)
sharepoint/sharepoint-ps/sharepoint-online/Start-SPOAuditDataCollectionForActivityInsights.md ✅Succeeded View (sharepoint-ps)
sharepoint/sharepoint-ps/sharepoint-online/Stop-SPOAuditDataCollectionForActivityInsights.md ✅Succeeded View (sharepoint-ps)

For more details, please refer to the build report.

For any questions, please:


## DESCRIPTION

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

from Copilot:

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

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Looks like Teams chat Copilot and Work Copilot are giving different strings for the same prompt. I have used Teams chat Copilot earlier. I can see that your suggestions are closer to the responses by Work Copilot. I have replaced the current text with the suggested ones after confirming again with Work Copilot and will use the Work Copilot here onwards.


## SYNOPSIS

Lists the current status of audit data collection for reports based on activities within the last 28 days, from SharePoint Admin Center.
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.

from Copilot:

Lists the current status of audit data collection for reports on activities from the last 28 days in the SharePoint admin center. #Closed


### -ReportEntity

Specifies the entity for which the corresponding audit data collection status should be shown
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.

shown

(here and others)

sentences must end with . #Closed

Type: OptInReportEntityEnum
Parameter Sets: (All)
Aliases:
Accepted values: SharingLinks_Anyone, SharingLinks_PeopleInYourOrg, SharingLinks_Guests, EveryoneExceptExternalUsersAtSite, EveryoneExceptExternalUsersForItems, CopilotAppInsights
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.

SharingLinks_Anyone, SharingLinks_PeopleInYourOrg, SharingLinks_Guests

this is why I want the server code to use PascalCase enums instead of _, since this is now mixed #Closed


### CommonParameters
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).

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

### Example 1

```powershell
PS C:\> Get-SPOAuditDataCollectionStatusForActivityInsights -ReportEntity SharingLinks_Anyone
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.

PS C:>

(here and others)

remove this PS C:\> #Closed


## SYNOPSIS

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

From Copilot:

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


## DESCRIPTION

This cmdlet starts collecting relevant audit data for reports, based on activites related to sharing and access. Reports are available for the following scenarios:
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.

From Copilot:

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: #Closed


This cmdlet starts 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 last 28 days (Anyone, People-in-your-org, Specific people shared externally).
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.

in

in last --> in the last

here and others #Closed


This cmdlet starts 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 last 28 days (Anyone, People-in-your-org, Specific people shared externally).
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.

Anyone, People-in-your-org, Specific people shared externally

are these the "official" names for these -- including casing? #Closed

Copy link
Contributor Author

@pvrk pvrk Apr 3, 2025

Choose a reason for hiding this comment

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

MS public document regarding sharing links

"Anyone"
"People in Your Organization"
"People you choose" - under the heading "Share with specific people" - This product specifically focuses on 'external' people

Copy link
Contributor

Choose a reason for hiding this comment

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

let's use the same wording as them -- eg should be "People in your organization"

@pvrk

This cmdlet starts 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 last 28 days (Anyone, People-in-your-org, Specific people shared externally).
- Content shared with Everyone except external users (EEEU) in last 28 days.
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.

Everyone except external users (EEEU)

what's the official name for this (including casing)? #Closed

Copy link
Contributor Author

Choose a reason for hiding this comment

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

"Everyone except external users" is the official name.

image

PS C:\> Get-SPOAuditDataCollectionStatusForActivityInsights -ReportEntity SharingLinks_Anyone
```

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

command

(here and others)

use "This example" instead of "This cmdlet" #Closed

PS C:\> Start-SPOAuditDataCollectionForActivityInsights -ReportEntity SharingLinks_Anyone
```

This cmdlet will start collecting audit data related to the generation of 'Anyone' sharing links from the moment it is executed.
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.

it

what does "it" refer to here -- the cmdlet or the audit data? Please reword the sentence so its clear #Closed

Copy link
Contributor

Choose a reason for hiding this comment

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

apply to the Stop- cmdlet too


## SYNOPSIS

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

From Copilot:

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


- Sharing links created in last 28 days (Anyone, People-in-your-org, Specific people shared externally).
- Content shared with Everyone except external users (EEEU) in last 28 days.
- Copilot agents created in last 28 days *(Private Preview)*
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.

same comments from Start- cmdlet apply #Closed

Copy link
Contributor

@samkabue samkabue left a comment

Choose a reason for hiding this comment

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

🕐

@samkabue samkabue added the Back to submitter The pull request didn't pass the review criteria and has been returned to the writer for updates label Apr 3, 2025
Copy link
Contributor

Learn Build status updates of commit d646d38:

✅ Validation status: passed

File Status Preview URL Details
sharepoint/sharepoint-ps/sharepoint-online/Get-SPOAuditDataCollectionStatusForActivityInsights.md ✅Succeeded View (sharepoint-ps)
sharepoint/sharepoint-ps/sharepoint-online/Start-SPOAuditDataCollectionForActivityInsights.md ✅Succeeded View (sharepoint-ps)
sharepoint/sharepoint-ps/sharepoint-online/Stop-SPOAuditDataCollectionForActivityInsights.md ✅Succeeded View (sharepoint-ps)

For more details, please refer to the build report.

For any questions, please:

Start-SPOAuditDataCollectionForActivityInsights -ReportEntity SharingLinks_Anyone
```

This example will start collecting audit data related to the generation of 'Anyone' sharing links from the moment the command is executed.
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.

command

cmdlet #Closed

Stop-SPOAuditDataCollectionForActivityInsights -ReportEntity SharingLinks_Anyone
```

This example will stop collecting audit data related to the generation of 'Anyone' sharing links from the moment the command is executed.
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.

command

cmdlet #Closed

@samkabue
Copy link
Contributor

samkabue commented Apr 3, 2025

You also need to update Table of Contents file -- sharepoint-online.md #Closed

@pvrk
Copy link
Contributor Author

pvrk commented Apr 7, 2025

You also need to update Table of Contents file -- sharepoint-online.md

Apologies, but I didn't update the table of contents in the last PR. So, do I have to do that for all new commands by DAG? Please advise.

Copy link
Contributor

Learn Build status updates of commit 7559276:

✅ Validation status: passed

File Status Preview URL Details
sharepoint/sharepoint-ps/sharepoint-online/Get-SPOAuditDataCollectionStatusForActivityInsights.md ✅Succeeded View (sharepoint-ps)
sharepoint/sharepoint-ps/sharepoint-online/Start-SPOAuditDataCollectionForActivityInsights.md ✅Succeeded View (sharepoint-ps)
sharepoint/sharepoint-ps/sharepoint-online/Stop-SPOAuditDataCollectionForActivityInsights.md ✅Succeeded View (sharepoint-ps)

For more details, please refer to the build report.

For any questions, please:

@samkabue
Copy link
Contributor

samkabue commented Apr 7, 2025

Yes, this is a mandatory requirement now. @pvrk -- otherwise they'll send back the PR to you to do that. So you might as well do it now. Note: this only applies to newly added files.


In reply to: 2782912881

Copy link
Contributor

Learn Build status updates of commit 38c8f51:

❌ Validation status: errors

Please follow instructions here which may help to resolve issue.

File Status Preview URL Details
❌Error Details

  • [Error: CannotMergeCommit] Cannot merge commit 38c8f515867d5eb0343ba194b1f66ef78bb272ce in branch pvrk-sharepointps-mar of repository https://github.com/pvrk/OfficeDocs-SharePoint-PowerShell into branch main (commit 997c31340b736a88b240194e18bad9b612257f0b). Please follow this documentation: https://help.github.com/articles/resolving-a-merge-conflict-using-the-command-line/ to use git.exe to resolve you content conflicts locally and then push to remote.

For more details, please refer to the build report.

Note: Your PR may contain errors or warnings or suggestions unrelated to the files you changed. This happens when external dependencies like GitHub alias, Microsoft alias, cross repo links are updated. Please use these instructions to resolve them.

For any questions, please:

Copy link
Contributor

Learn Build status updates of commit 33ac152:

❌ Validation status: errors

Please follow instructions here which may help to resolve issue.

File Status Preview URL Details
❌Error Details

  • [Error: CannotMergeCommit] Cannot merge commit 33ac152b8c99ba416eddca68c584818815cf00d1 in branch pvrk-sharepointps-mar of repository https://github.com/pvrk/OfficeDocs-SharePoint-PowerShell into branch main (commit 997c31340b736a88b240194e18bad9b612257f0b). Please follow this documentation: https://help.github.com/articles/resolving-a-merge-conflict-using-the-command-line/ to use git.exe to resolve you content conflicts locally and then push to remote.

For more details, please refer to the build report.

Note: Your PR may contain errors or warnings or suggestions unrelated to the files you changed. This happens when external dependencies like GitHub alias, Microsoft alias, cross repo links are updated. Please use these instructions to resolve them.

For any questions, please:

Copy link
Contributor

Learn Build status updates of commit 1c98fc8:

✅ Validation status: passed

File Status Preview URL Details
sharepoint/sharepoint-ps/sharepoint-online/Get-SPOAuditDataCollectionStatusForActivityInsights.md ✅Succeeded View (sharepoint-ps)
sharepoint/sharepoint-ps/sharepoint-online/sharepoint-online.md ✅Succeeded View (sharepoint-ps)
sharepoint/sharepoint-ps/sharepoint-online/Start-SPOAuditDataCollectionForActivityInsights.md ✅Succeeded View (sharepoint-ps)
sharepoint/sharepoint-ps/sharepoint-online/Stop-SPOAuditDataCollectionForActivityInsights.md ✅Succeeded View (sharepoint-ps)

For more details, please refer to the build report.

For any questions, please:

@@ -103,6 +103,10 @@ 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.

@@ -652,6 +660,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)

{{Stop collecting audit data for reports on activities from the last 28 days.}}
Copy link
Contributor

@samkabue samkabue Apr 8, 2025

Choose a reason for hiding this comment

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

Stop

Suggested change
{{Stop collecting audit data for reports on activities from the last 28 days.}}
Stops
``` #Closed

Copy link
Contributor

Learn Build status updates of commit 39e043b:

❌ Validation status: errors

Please follow instructions here which may help to resolve issue.

File Status Preview URL Details
❌Error Details

  • [Error: CannotMergeCommit] Cannot merge commit 39e043b5facdf1be597adb980e2f2e075ae6da56 in branch pvrk-sharepointps-mar of repository https://github.com/pvrk/OfficeDocs-SharePoint-PowerShell into branch main (commit 997c31340b736a88b240194e18bad9b612257f0b). Please follow this documentation: https://help.github.com/articles/resolving-a-merge-conflict-using-the-command-line/ to use git.exe to resolve you content conflicts locally and then push to remote.

For more details, please refer to the build report.

Note: Your PR may contain errors or warnings or suggestions unrelated to the files you changed. This happens when external dependencies like GitHub alias, Microsoft alias, cross repo links are updated. Please use these instructions to resolve them.

For any questions, please:

Copy link
Contributor

Learn Build status updates of commit b6b2487:

✅ Validation status: passed

File Status Preview URL Details
sharepoint/sharepoint-ps/sharepoint-online/Get-SPOAuditDataCollectionStatusForActivityInsights.md ✅Succeeded View (sharepoint-ps)
sharepoint/sharepoint-ps/sharepoint-online/sharepoint-online.md ✅Succeeded View (sharepoint-ps)
sharepoint/sharepoint-ps/sharepoint-online/Start-SPOAuditDataCollectionForActivityInsights.md ✅Succeeded View (sharepoint-ps)
sharepoint/sharepoint-ps/sharepoint-online/Stop-SPOAuditDataCollectionForActivityInsights.md ✅Succeeded View (sharepoint-ps)

For more details, please refer to the build report.

For any questions, please:

@pvrk pvrk closed this Apr 14, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Back to submitter The pull request didn't pass the review criteria and has been returned to the writer for updates Microsoft submitter
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants