-
Notifications
You must be signed in to change notification settings - Fork 196
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
Changes from 1 commit
48916d9
d646d38
7559276
38c8f51
33ac152
1c98fc8
39e043b
b6b2487
File filter
Filter by extension
Conversations
Jump to
Diff view
Diff view
There are no files selected for viewing
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,77 @@ | ||
| --- | ||
| 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 based on activities within the last 28 days, from SharePoint Admin Center. | ||
|
|
||
| ## SYNTAX | ||
|
|
||
| ``` | ||
| Get-SPOAuditDataCollectionStatusForActivityInsights [-ReportEntity <OptInReportEntityEnum>] | ||
| [<CommonParameters>] | ||
| ``` | ||
|
|
||
| ## 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. | ||
|
Contributor
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. from Copilot:
Contributor
Author
There was a problem hiding this comment. Choose a reason for hiding this commentThe 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. |
||
|
|
||
| ## EXAMPLES | ||
|
|
||
| ### Example 1 | ||
|
|
||
| ```powershell | ||
| PS C:\> Get-SPOAuditDataCollectionStatusForActivityInsights -ReportEntity SharingLinks_Anyone | ||
|
Contributor
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. |
||
| ``` | ||
|
|
||
| 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. | ||
|
Contributor
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. |
||
|
|
||
| ## PARAMETERS | ||
|
|
||
| ### -ReportEntity | ||
|
|
||
| Specifies the entity for which the corresponding audit data collection status should be shown | ||
|
Contributor
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. |
||
|
|
||
| ```yaml | ||
| Type: OptInReportEntityEnum | ||
| Parameter Sets: (All) | ||
| Aliases: | ||
| Accepted values: SharingLinks_Anyone, SharingLinks_PeopleInYourOrg, SharingLinks_Guests, EveryoneExceptExternalUsersAtSite, EveryoneExceptExternalUsersForItems, CopilotAppInsights | ||
|
Contributor
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. |
||
|
|
||
| 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, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). | ||
|
|
||
|
Contributor
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. (here and others) use this updated version: |
||
| ## 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,79 @@ | ||
| --- | ||
| 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 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. | ||
|
Contributor
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. From Copilot:
|
||
|
|
||
| ## SYNTAX | ||
|
|
||
| ``` | ||
| Start-SPOAuditDataCollectionForActivityInsights -ReportEntity <OptInReportEntityEnum> [<CommonParameters>] | ||
| ``` | ||
|
|
||
| ## 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: | ||
|
Contributor
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. From Copilot:
|
||
|
|
||
| - Sharing links created in last 28 days (Anyone, People-in-your-org, Specific people shared externally). | ||
|
Contributor
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more.
Contributor
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more.
Contributor
Author
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. MS public document regarding sharing links "Anyone"
Contributor
There was a problem hiding this comment. Choose a reason for hiding this commentThe 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" |
||
| - Content shared with Everyone except external users (EEEU) in last 28 days. | ||
|
Contributor
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more.
Contributor
Author
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. |
||
| - Copilot agents created in last 28 days *(Private Preview)* | ||
|
|
||
| ## EXAMPLES | ||
|
|
||
| ### Example 1 | ||
| ```powershell | ||
| 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. | ||
|
Contributor
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more.
Contributor
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. apply to the Stop- cmdlet too |
||
|
|
||
| ## PARAMETERS | ||
|
|
||
| ### -ReportEntity | ||
|
|
||
| Specifies the entity for which the corresponding audit data should be collected. | ||
|
|
||
| ```yaml | ||
| Type: OptInReportEntityEnum | ||
| Parameter Sets: (All) | ||
| Aliases: | ||
| Accepted values: SharingLinks_Anyone, SharingLinks_PeopleInYourOrg, SharingLinks_Guests, 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, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). | ||
|
|
||
| ## 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,78 @@ | ||
| --- | ||
| 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 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. | ||
|
Contributor
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. From Copilot:
|
||
|
|
||
| ## 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 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)* | ||
|
Contributor
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. same comments from |
||
|
|
||
| ## EXAMPLES | ||
|
|
||
| ### Example 1 | ||
| ```powershell | ||
| PS C:\> Stop-SPOAuditDataCollectionForActivityInsights -ReportEntity SharingLinks_Anyone | ||
| ``` | ||
|
|
||
| This cmdlet will stop collecting audit data related to the generation of 'Anyone' sharing links from the moment it 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: SharingLinks_Anyone, SharingLinks_PeopleInYourOrg, SharingLinks_Guests, 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, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). | ||
|
|
||
| ## INPUTS | ||
|
|
||
| ### None | ||
|
|
||
| ## OUTPUTS | ||
|
|
||
| ### System.Object | ||
|
|
||
| ## NOTES | ||
|
|
||
| ## RELATED LINKS | ||
|
|
||
| [Start-SPOAuditDataCollectionForActivityInsights](./Start-SPOAuditDataCollectionForActivityInsights.md) | ||
| [Get-SPOAuditDataCollectionStatusForActivityInsights](./Get-SPOAuditDataCollectionStatusForActivityInsights.md) | ||
| [Start-SPODataAccessGovernanceInsight](./Start-SPODataAccessGovernanceInsight.md) | ||

Uh oh!
There was an error while loading. Please reload this page.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
from Copilot: