Skip to content

Commit 7788713

Browse files
VesaJuvonenVesaJuvonen
committed
Adding docs for Export-SPOUserInfo, Export-SPOUserProfiel, Remove-SPOUserInfo and Remove-SPOUserProfile
1 parent d8d0e8f commit 7788713

File tree

4 files changed

+330
-0
lines changed

4 files changed

+330
-0
lines changed

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

Lines changed: 116 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,116 @@
1+
---
2+
external help file:
3+
applicable: SharePoint Online
4+
title: Export-SPOUserInfo
5+
schema: 2.0.0
6+
---
7+
8+
# Export-SPOUserInfo
9+
10+
## SYNOPSIS
11+
Export user information from site user information list.
12+
13+
## SYNTAX
14+
15+
```
16+
Export-SPOUserInfo -LoginName <String> -Site <SpoSitePipeBind> -OutputFolder <String> [<CommonParameters>]
17+
```
18+
19+
## DESCRIPTION
20+
Export user information from site user information list.
21+
22+
For permissions and the most current information about Windows PowerShell for SharePoint Online, see the online documentation at http://go.microsoft.com/fwlink/p/?LinkId=251832 (http://go.microsoft.com/fwlink/p/?LinkId=251832).
23+
24+
## EXAMPLES
25+
26+
### ------------ Example 1 --------------------
27+
```
28+
Export-SPOUserInfo -LoginName [email protected] -site https://contoso.sharepoint.com/sites/sc1 -OutputFolder "C:\users\admin\exportfolder"
29+
```
30+
Example 1 exports a user data who has the e-mail address [email protected] from the site collection https://contoso.sharepoint.com/sites/sc1 to folder C:\users\admin\exportfolder.
31+
32+
33+
### ------------ Example 2 --------------------
34+
```
35+
$sites = Get-SPOSite -IncludePersonalSite $true
36+
$user = "[email protected]"
37+
foreach ($site in $sites)
38+
{
39+
Export-SPOUserInfo -LoginName $user -site $site.Url -OutputFolder
40+
"C:\users\admin\exportfolder"
41+
}
42+
```
43+
Example 2 exports user data who has email address [email protected] from all site collections to folder C:\users\admin\exportfolder.
44+
45+
## PARAMETERS
46+
47+
### -LoginName
48+
Specifies the login name of the user to export.
49+
50+
```yaml
51+
Type: String
52+
Parameter Sets: (All)
53+
Aliases:
54+
Applicable: SharePoint Online
55+
56+
Required: True
57+
Position: Named
58+
Default value: None
59+
Accept pipeline input: False
60+
Accept wildcard characters: False
61+
```
62+
63+
### -Site
64+
Specifies the URL of the site collection to which you want to export the user.
65+
66+
```yaml
67+
Type: SpoSitePipeBind
68+
Parameter Sets: (All)
69+
Aliases:
70+
Applicable: SharePoint Online
71+
72+
Required: True
73+
Position: Named
74+
Default value: None
75+
Accept pipeline input: False
76+
Accept wildcard characters: False
77+
```
78+
79+
### -OutputFolder
80+
Target folder where teh CSV file is generated.
81+
82+
```yaml
83+
Type: String
84+
Parameter Sets: (All)
85+
Aliases:
86+
Applicable: SharePoint Online
87+
88+
Required: True
89+
Position: Named
90+
Default value: None
91+
Accept pipeline input: False
92+
Accept wildcard characters: False
93+
```
94+
95+
### CommonParameters
96+
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).
97+
98+
## INPUTS
99+
100+
## OUTPUTS
101+
102+
## NOTES
103+
104+
## RELATED LINKS
105+
106+
[Introduction to the SharePoint Online management shell]()
107+
108+
[Set up the SharePoint Online Management Shell Windows PowerShell environment]()
109+
110+
[New-SPOSiteGroup](New-SPOSiteGroup.md)
111+
112+
[Get-SPOUser](Get-SPOUser.md)
113+
114+
[Set-SPOUser](Set-SPOUser.md)
115+
116+
[Remove-SPOUser](Remove-SPOUser.md)

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

Lines changed: 77 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,77 @@
1+
---
2+
external help file:
3+
applicable: SharePoint Online
4+
title: Export-SPOUserProfile
5+
schema: 2.0.0
6+
---
7+
8+
# Export-SPOUserProfile
9+
10+
## SYNOPSIS
11+
Export user profile data to csv file.
12+
13+
## SYNTAX
14+
15+
```
16+
Export-SPOUserProfile -LoginName <String> -OutputFolder <String> [<CommonParameters>]
17+
```
18+
19+
## DESCRIPTION
20+
Export user profile data to csv file.
21+
22+
For permissions and the most current information about Windows PowerShell for SharePoint Online, see the online documentation at http://go.microsoft.com/fwlink/p/?LinkId=251832 (http://go.microsoft.com/fwlink/p/?LinkId=251832).
23+
24+
## EXAMPLES
25+
26+
### ------------ Example 1 --------------------
27+
```
28+
Export-SPOUserProfile -LoginName [email protected] -OutputFolder "C:\users\admin\exportfolder"
29+
```
30+
Example 1 exports user data who has the e-mail address [email protected] to a folder "C:\users\admin\exportfolder".
31+
32+
## PARAMETERS
33+
34+
### -LoginName
35+
Specifies the login name of the user who's data is exported.
36+
37+
```yaml
38+
Type: String
39+
Parameter Sets: (All)
40+
Aliases:
41+
Applicable: SharePoint Online
42+
43+
Required: True
44+
Position: Named
45+
Default value: None
46+
Accept pipeline input: False
47+
Accept wildcard characters: False
48+
```
49+
50+
### -OutputFolder
51+
Specifies the output folder location where the CSV file is created.
52+
53+
```yaml
54+
Type: String
55+
Parameter Sets: (All)
56+
Aliases:
57+
Applicable: SharePoint Online
58+
59+
Required: True
60+
Position: Named
61+
Default value: None
62+
Accept pipeline input: False
63+
Accept wildcard characters: False
64+
```
65+
66+
### CommonParameters
67+
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).
68+
69+
## INPUTS
70+
71+
## OUTPUTS
72+
73+
## NOTES
74+
75+
## RELATED LINKS
76+
77+
[Export-SPOUserInfo](Export-SPOUserInfo.md)

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

Lines changed: 77 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,77 @@
1+
---
2+
external help file:
3+
applicable: SharePoint Online
4+
title: Remove-SPOUserInfo
5+
schema: 2.0.0
6+
---
7+
8+
# Remove-SPOUserInfo
9+
10+
## SYNOPSIS
11+
Removes user from user information list of specific site collection.
12+
13+
## SYNTAX
14+
15+
```
16+
Remove-SPOUserInfo -LoginName <String> -Site <SpoSitePipeBind> [<CommonParameters>]
17+
```
18+
19+
## DESCRIPTION
20+
Can be used to remove user from user information lists of the specific site collections.
21+
22+
For permissions and the most current information about Windows PowerShell for SharePoint Online, see the online documentation at http://go.microsoft.com/fwlink/p/?LinkId=251832 (http://go.microsoft.com/fwlink/p/?LinkId=251832).
23+
24+
## EXAMPLES
25+
26+
### ------------ Example 1 --------------------
27+
```
28+
Remove-SPOUserInfo -LoginName [email protected] -Site https://contoso.sharepoint.com/sites/sc1
29+
```
30+
Example 1 removes a user who has the e-mail address [email protected] from the user ifnoramtion list of https://contoso.sharepoint.com/sites/sc1 site collection.
31+
32+
## PARAMETERS
33+
34+
### -LoginName
35+
Specifies the login name of the user to removed from user information list.
36+
37+
```yaml
38+
Type: String
39+
Parameter Sets: (All)
40+
Aliases:
41+
Applicable: SharePoint Online
42+
43+
Required: True
44+
Position: Named
45+
Default value: None
46+
Accept pipeline input: False
47+
Accept wildcard characters: False
48+
```
49+
50+
### -Site
51+
Specifies the URL of the site collection.
52+
53+
```yaml
54+
Type: SpoSitePipeBind
55+
Parameter Sets: (All)
56+
Aliases:
57+
Applicable: SharePoint Online
58+
59+
Required: True
60+
Position: Named
61+
Default value: None
62+
Accept pipeline input: False
63+
Accept wildcard characters: False
64+
```
65+
66+
### CommonParameters
67+
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).
68+
69+
## INPUTS
70+
71+
## OUTPUTS
72+
73+
## NOTES
74+
75+
## RELATED LINKS
76+
77+
[Remove-SPOUserProfile](Remove-SPOUserProfile.md)

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

Lines changed: 60 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,60 @@
1+
---
2+
external help file:
3+
applicable: SharePoint Online
4+
title: Remove-SPOUserProfile
5+
schema: 2.0.0
6+
---
7+
8+
# Remove-SPOUserProfile
9+
10+
## SYNOPSIS
11+
Remove user profile from the tenant.
12+
13+
## SYNTAX
14+
15+
```
16+
Remove-SPOUserProfile -LoginName <String> [<CommonParameters>]
17+
```
18+
19+
## DESCRIPTION
20+
Can be used to remove the SharePoint user profile from the tenant.
21+
22+
## EXAMPLES
23+
24+
### ------------ Example 1 --------------------
25+
```
26+
Remove-SPOUserProfile -LoginName [email protected]
27+
```
28+
Example 1 removes a user who has the e-mail address [email protected] from the SharePoint Online User Profiles of the particular tenant.
29+
30+
31+
## PARAMETERS
32+
33+
### -LoginName
34+
Specifies the login name of the user which user profile is deleted.
35+
36+
```yaml
37+
Type: String
38+
Parameter Sets: (All)
39+
Aliases:
40+
Applicable: SharePoint Online
41+
42+
Required: True
43+
Position: Named
44+
Default value: None
45+
Accept pipeline input: False
46+
Accept wildcard characters: False
47+
```
48+
49+
### CommonParameters
50+
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).
51+
52+
## INPUTS
53+
54+
## OUTPUTS
55+
56+
## NOTES
57+
58+
## RELATED LINKS
59+
60+
[Remove-SPOUserInfo](Remove-SPOUserInfo.md)

0 commit comments

Comments
 (0)