Skip to content

Commit 4d110f7

Browse files
pvrkpvrk
committed
New PS commands for DAG
1 parent 36f68e8 commit 4d110f7

File tree

6 files changed

+727
-0
lines changed

6 files changed

+727
-0
lines changed

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

Lines changed: 64 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,64 @@
1+
---
2+
external help file: Microsoft.Online.SharePoint.PowerShell.dll-Help.xml
3+
Module Name: Microsoft.Online.SharePoint.PowerShell
4+
online version:
5+
schema: 2.0.0
6+
---
7+
8+
# Export-SPODataAccessGovernanceInsight
9+
10+
## SYNOPSIS
11+
12+
This commands exports/downloads the DAG report to the default path "C:\WINDOWS\system32\"
13+
14+
## SYNTAX
15+
16+
```
17+
Export-SPODataAccessGovernanceInsight -ReportID <Guid> [<CommonParameters>]
18+
```
19+
20+
## DESCRIPTION
21+
22+
This commands exports/downloads the DAG report, specified by the ReportID, to the default path "C:\WINDOWS\system32\". The ReportID is shown in the output of the 'Start-SPODataAccessGovernanceInsight' command. It can also be fetched from the output of the 'Get-SPODataAccessGovernanceInsight' command.
23+
24+
## EXAMPLES
25+
26+
### Example 1
27+
28+
```powershell
29+
PS C:\> Export-SPODataAccessGovernanceInsight -ReportID 28f4c550-215a-472b-a123-c11e5fa8804c
30+
```
31+
32+
This command downloads the report of the given ID to the default path "C:\WINDOWS\system32\"
33+
34+
## PARAMETERS
35+
36+
### -ReportID
37+
38+
Specifies the ID of the DAG report to be downloaded.
39+
40+
```yaml
41+
Type: Guid
42+
Parameter Sets: (All)
43+
Aliases:
44+
45+
Required: True
46+
Position: Named
47+
Default value: None
48+
Accept pipeline input: False
49+
Accept wildcard characters: False
50+
```
51+
52+
### CommonParameters
53+
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).
54+
55+
## INPUTS
56+
57+
### None
58+
59+
## OUTPUTS
60+
61+
### System.Object
62+
## NOTES
63+
64+
## RELATED LINKS

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

Lines changed: 122 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,122 @@
1+
---
2+
external help file: Microsoft.Online.SharePoint.PowerShell.dll-Help.xml
3+
Module Name: Microsoft.Online.SharePoint.PowerShell
4+
online version:
5+
schema: 2.0.0
6+
---
7+
8+
# Get-SPODataAccessGovernanceInsight
9+
10+
## SYNOPSIS
11+
12+
Lists various reports available in 'Data Access Governance' module (DAG) in SharePoint Admin Center.
13+
14+
## SYNTAX
15+
16+
### GetAllReportsParameterSet
17+
```
18+
Get-SPODataAccessGovernanceInsight -ReportEntity <ReportEntityEnum> [-WorkLoad <WorkloadEnum>]
19+
[-ReportType <ReportTypeEnum>] [<CommonParameters>]
20+
```
21+
22+
### GetReportParameterSet
23+
```
24+
Get-SPODataAccessGovernanceInsight -ReportID <Guid> [<CommonParameters>]
25+
```
26+
27+
## DESCRIPTION
28+
29+
Fetch details of various reports available in 'Data Access Governance' module (DAG) in SharePoint Admin Center
30+
31+
## EXAMPLES
32+
33+
### Example 1
34+
35+
```powershell
36+
PS C:\> Get-SPODataAccessGovernanceInsight -ReportEntity EveryoneExceptExternalUsersForItems
37+
```
38+
39+
This command fetches all DAG reports about 'Everyone except external users' attached to a item i.e., file/folder/list. The output consists of important parameters such as Status, ReportID, number of sites in the report and other user provided values during report generation.
40+
41+
## PARAMETERS
42+
43+
### -ReportEntity
44+
45+
Specifies the 'potential oversharing' scenario as captured by DAG report given during the report creation.
46+
47+
```yaml
48+
Type: ReportEntityEnum
49+
Parameter Sets: GetAllReportsParameterSet
50+
Aliases:
51+
Accepted values: SharingLinks_Anyone, SharingLinks_PeopleInYourOrg, SharingLinks_Guests, SensitivityLabelForFiles, EveryoneExceptExternalUsersAtSite, EveryoneExceptExternalUsersForItems, PermissionedUsers
52+
53+
Required: True
54+
Position: Named
55+
Default value: None
56+
Accept pipeline input: False
57+
Accept wildcard characters: False
58+
```
59+
60+
### -ReportID
61+
62+
Specifies the ID of the particular report to be fetched.
63+
64+
```yaml
65+
Type: Guid
66+
Parameter Sets: GetReportParameterSet
67+
Aliases:
68+
69+
Required: True
70+
Position: Named
71+
Default value: None
72+
Accept pipeline input: False
73+
Accept wildcard characters: False
74+
```
75+
76+
### -ReportType
77+
78+
Specifies the time period of data of the reports to be fetched i.e., fetch 'Snapshot' reports or 'RecentActivity' reports
79+
80+
```yaml
81+
Type: ReportTypeEnum
82+
Parameter Sets: GetAllReportsParameterSet
83+
Aliases:
84+
Accepted values: Snapshot, RecentActivity
85+
86+
Required: False
87+
Position: Named
88+
Default value: None
89+
Accept pipeline input: False
90+
Accept wildcard characters: False
91+
```
92+
93+
### -WorkLoad
94+
95+
Specifies the datasource of the reports to be fetched i.e., reports for SharePoint sites or for OneDrive accounts.
96+
97+
```yaml
98+
Type: WorkloadEnum
99+
Parameter Sets: GetAllReportsParameterSet
100+
Aliases:
101+
Accepted values: SharePoint, OneDriveForBusiness
102+
103+
Required: False
104+
Position: Named
105+
Default value: None
106+
Accept pipeline input: False
107+
Accept wildcard characters: False
108+
```
109+
110+
### CommonParameters
111+
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).
112+
113+
## INPUTS
114+
115+
### None
116+
117+
## OUTPUTS
118+
119+
### System.Object
120+
## NOTES
121+
122+
## RELATED LINKS

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

Lines changed: 108 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,108 @@
1+
---
2+
external help file: Microsoft.Online.SharePoint.PowerShell.dll-Help.xml
3+
Module Name: Microsoft.Online.SharePoint.PowerShell
4+
online version:
5+
schema: 2.0.0
6+
---
7+
8+
# Get-SPOSiteReview
9+
10+
## SYNOPSIS
11+
Track all site access reviews initiated by all SharePoint admins
12+
13+
## SYNTAX
14+
15+
```
16+
Get-SPOSiteReview [-SiteReviewID <Guid>] [-Status <SiteReviewStatus>]
17+
[-ReportEntity <SiteAccessReportEntityEnum>] [-SiteID <Guid>] [<CommonParameters>]
18+
```
19+
20+
## DESCRIPTION
21+
This command fetches details of a particular access review or a group of access reviews as per the filtering criteria.
22+
23+
## EXAMPLES
24+
25+
### Example 1
26+
```powershell
27+
PS C:\> Get-SPOSiteReview -ReportEntity PermissionedUsers
28+
```
29+
30+
The above command retrieves all site access reviews raised under all permissioned user reports.
31+
32+
## PARAMETERS
33+
34+
### -ReportEntity
35+
Specifies the 'potential oversharing' scenario that should be captured by the DAG report.
36+
37+
```yaml
38+
Type: SiteAccessReportEntityEnum
39+
Parameter Sets: (All)
40+
Aliases:
41+
Accepted values: All, SharingLinks_Anyone, SharingLinks_PeopleInYourOrg, SharingLinks_Guests, SensitivityLabelForFiles, EveryoneExceptExternalUsersAtSite, EveryoneExceptExternalUsersForItems, PermissionedUsers
42+
43+
Required: False
44+
Position: Named
45+
Default value: None
46+
Accept pipeline input: False
47+
Accept wildcard characters: False
48+
```
49+
50+
### -SiteID
51+
Specifies the ID of the site for which access reviews were initiated.
52+
53+
```yaml
54+
Type: Guid
55+
Parameter Sets: (All)
56+
Aliases:
57+
58+
Required: False
59+
Position: Named
60+
Default value: None
61+
Accept pipeline input: False
62+
Accept wildcard characters: False
63+
```
64+
65+
### -SiteReviewID
66+
Specifies the ID of the particular access review
67+
68+
```yaml
69+
Type: Guid
70+
Parameter Sets: (All)
71+
Aliases:
72+
73+
Required: False
74+
Position: Named
75+
Default value: None
76+
Accept pipeline input: False
77+
Accept wildcard characters: False
78+
```
79+
80+
### -Status
81+
Specifies the current status of the site access review
82+
83+
```yaml
84+
Type: SiteReviewStatus
85+
Parameter Sets: (All)
86+
Aliases:
87+
Accepted values: All, Pending, Failed, Completed
88+
89+
Required: False
90+
Position: Named
91+
Default value: None
92+
Accept pipeline input: False
93+
Accept wildcard characters: False
94+
```
95+
96+
### CommonParameters
97+
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).
98+
99+
## INPUTS
100+
101+
### None
102+
103+
## OUTPUTS
104+
105+
### System.Object
106+
## NOTES
107+
108+
## RELATED LINKS

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

Lines changed: 95 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,95 @@
1+
---
2+
external help file: Microsoft.Online.SharePoint.PowerShell.dll-Help.xml
3+
Module Name: Microsoft.Online.SharePoint.PowerShell
4+
online version:
5+
schema: 2.0.0
6+
---
7+
8+
# Remove-SPODataAccessGovernanceInsight
9+
10+
## SYNOPSIS
11+
12+
This command deletes the given DAG report
13+
14+
## SYNTAX
15+
16+
```
17+
Remove-SPODataAccessGovernanceInsight -ReportID <Guid> [-WhatIf] [-Confirm] [<CommonParameters>]
18+
```
19+
20+
## DESCRIPTION
21+
22+
This command deletes the DAG report, specified by the given ReportID. The ReportID is shown in the output of the 'Start-SPODataAccessGovernanceInsight' command. It can also be fetched from the output of the 'Get-SPODataAccessGovernanceInsight' command.
23+
24+
## EXAMPLES
25+
26+
### Example 1
27+
28+
```powershell
29+
PS C:\> Remove-SPODataAccessGovernanceInsight -ReportID 28f4c550-215a-472b-a123-c11e5fa8804c
30+
```
31+
32+
This command deletes the report of the given ID "28f4c550-215a-472b-a123-c11e5fa8804c"
33+
34+
## PARAMETERS
35+
36+
### -Confirm
37+
Prompts you for confirmation before running the cmdlet.
38+
39+
```yaml
40+
Type: SwitchParameter
41+
Parameter Sets: (All)
42+
Aliases: cf
43+
44+
Required: False
45+
Position: Named
46+
Default value: None
47+
Accept pipeline input: False
48+
Accept wildcard characters: False
49+
```
50+
51+
### -ReportID
52+
53+
Specifies the ID of the DAG report to be removed/deleted.
54+
55+
```yaml
56+
Type: Guid
57+
Parameter Sets: (All)
58+
Aliases:
59+
60+
Required: True
61+
Position: Named
62+
Default value: None
63+
Accept pipeline input: False
64+
Accept wildcard characters: False
65+
```
66+
67+
### -WhatIf
68+
Shows what would happen if the cmdlet runs.
69+
The cmdlet is not run.
70+
71+
```yaml
72+
Type: SwitchParameter
73+
Parameter Sets: (All)
74+
Aliases: wi
75+
76+
Required: False
77+
Position: Named
78+
Default value: None
79+
Accept pipeline input: False
80+
Accept wildcard characters: False
81+
```
82+
83+
### CommonParameters
84+
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).
85+
86+
## INPUTS
87+
88+
### None
89+
90+
## OUTPUTS
91+
92+
### System.Object
93+
## NOTES
94+
95+
## RELATED LINKS

0 commit comments

Comments
 (0)