Skip to content

Commit c5768e9

Browse files
MachelleTranMSFTMachelleTranMSFT
authored
Adding 6 new commands for SPO data access gov
1 parent 93b6713 commit c5768e9

File tree

6 files changed

+778
-0
lines changed

6 files changed

+778
-0
lines changed

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

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

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

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

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

Lines changed: 120 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,120 @@
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+
author: MachelleTranMSFT
7+
ms.author: mactra
8+
ms.reviewer: pullabhk
9+
---
10+
11+
# Get-SPOSiteReview
12+
13+
## SYNOPSIS
14+
15+
This command retrieves the site review report.
16+
17+
## SYNTAX
18+
19+
```powershell
20+
Get-SPOSiteReview [-SiteReviewID <Guid>] [-Status <SiteReviewStatus>]
21+
[-ReportEntity <SiteAccessReportEntityEnum>] [-SiteID <Guid>] [<CommonParameters>]
22+
```
23+
24+
## DESCRIPTION
25+
26+
{{ Fill in the Description }}
27+
28+
## EXAMPLES
29+
30+
### Example 1
31+
32+
```powershell
33+
PS C:\> {{ Add example code here }}
34+
```
35+
36+
{{ Add example description here }}
37+
38+
## PARAMETERS
39+
40+
### -ReportEntity
41+
42+
{{ Fill ReportEntity Description }}
43+
44+
```yaml
45+
Type: SiteAccessReportEntityEnum
46+
Parameter Sets: (All)
47+
Aliases:
48+
Accepted values: All, SharingLinks_Anyone, SharingLinks_PeopleInYourOrg, SharingLinks_Guests, SensitivityLabelForFiles, EveryoneExceptExternalUsersAtSite, EveryoneExceptExternalUsersForItems, PermissionedUsers
49+
50+
Required: False
51+
Position: Named
52+
Default value: None
53+
Accept pipeline input: False
54+
Accept wildcard characters: False
55+
```
56+
57+
### -SiteID
58+
59+
{{ Fill SiteID Description }}
60+
61+
```yaml
62+
Type: Guid
63+
Parameter Sets: (All)
64+
Aliases:
65+
66+
Required: False
67+
Position: Named
68+
Default value: None
69+
Accept pipeline input: False
70+
Accept wildcard characters: False
71+
```
72+
73+
### -SiteReviewID
74+
75+
{{ Fill SiteReviewID Description }}
76+
77+
```yaml
78+
Type: Guid
79+
Parameter Sets: (All)
80+
Aliases:
81+
82+
Required: False
83+
Position: Named
84+
Default value: None
85+
Accept pipeline input: False
86+
Accept wildcard characters: False
87+
```
88+
89+
### -Status
90+
91+
{{ Fill Status Description }}
92+
93+
```yaml
94+
Type: SiteReviewStatus
95+
Parameter Sets: (All)
96+
Aliases:
97+
Accepted values: All, Pending, Failed, Completed
98+
99+
Required: False
100+
Position: Named
101+
Default value: None
102+
Accept pipeline input: False
103+
Accept wildcard characters: False
104+
```
105+
106+
### CommonParameters
107+
108+
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).
109+
110+
## INPUTS
111+
112+
### None
113+
114+
## OUTPUTS
115+
116+
### System.Object
117+
118+
## NOTES
119+
120+
## RELATED LINKS

0 commit comments

Comments
 (0)