You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: exchange/exchange-ps/exchange/Get-UserPhoto.md
+3-136Lines changed: 3 additions & 136 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -6,19 +6,9 @@ schema: 2.0.0
6
6
# Get-UserPhoto
7
7
8
8
## SYNOPSIS
9
-
!!! Exchange Server 2013
10
-
11
-
This cmdlet is available in on-premises Exchange and in the cloud-based service. Some parameters and settings may be exclusive to one environment or the other.
12
-
13
-
Use the Get-UserPhoto cmdlet to view information about the user photos feature that allows users to associate a picture with their account. User photos appear in on-premises and cloud-based client applications, such as MicrosoftOutlook Web App, Lync, Skype for Business, and SharePoint.
14
-
15
-
For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://technet.microsoft.com/library/bb123552.aspx).
16
-
17
-
!!! Exchange Server 2016, Exchange Online
18
-
19
9
This cmdlet is available in on-premises Exchange and in the cloud-based service. Some parameters and settings may be exclusive to one environment or the other.
20
10
21
-
Use the Get-UserPhoto cmdlet to view information about the user photos feature that allows users to associate a picture with their account. User photos appear in on-premises and cloud-based client applications, such as Outlook on the web, Lync, Skype for Business, and SharePoint.
11
+
Use the Get-UserPhoto cmdlet to view information about the user photos feature that allows users to associate a picture with their account. User photos appear in on-premises and cloud-based client applications, such as Outlook on the web, Lync, Skype for Business and SharePoint.
22
12
23
13
For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax (https://technet.microsoft.com/library/bb123552.aspx).
In on-premises Exchange, the user photo is stored in the user's Active Directory account. In Exchange Online the user photo is stored in the root directory of the user's mailbox.
47
-
48
-
For Exchange Online mailboxes, you need to manage user photos by using the Set-UserPhoto and Remove-UserPhoto cmdlets, or by accessing the user's Outlook Web App Options page.Outlook. User photos are synchronized from Active Directory to the cloud only once during a mailbox migration. Therefore, even in hybrid environments, don't try to manage user photos in Active Directory.
49
-
50
-
If you use this cmdlet on a user who has never had a user photo configured, you'll get an error message saying the user photo doesn't exist
51
-
52
-
You need to be assigned permissions before you can run this cmdlet. Although all parameters for this cmdlet are listed in this topic, you may not have access to some parameters if they're not included in the permissions assigned to you. To see what permissions you need, see the "Recipient provisioning permissions" section in the Recipients Permissions topic.
53
-
54
-
!!! Exchange Server 2016, Exchange Online
55
-
56
34
The user photos feature allows users to associate a picture with their account. User photos are stored in the user's Active Directory account and in the root directory of the user's Exchange mailbox. The user photo feature must be set for a user before you can run the Get-UserPhoto cmdlet to view information about the user's photo. Otherwise, you get an error message saying the user photo doesn't exist for the specified users. Administrators use the Set-UserPhoto cmdlet or the Exchange admin center (EAC) to configure user photos. Users can upload, preview, and save a user photo to their account by using the Outlook on the web Options page.
57
35
58
36
You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see Find the permissions required to run any Exchange cmdlet (https://technet.microsoft.com/library/mt432940.aspx).
59
37
60
38
## EXAMPLES
61
39
62
-
### Example 1 -------------------------- (Exchange Server 2013)
63
-
```
64
-
Get-UserPhoto "Susan Burk"
65
-
```
66
-
67
-
This example displays information about the user photo configured for Susan Burk.
68
-
69
-
### Example 1 -------------------------- (Exchange Server 2016)
70
-
```
71
-
Get-UserPhoto "Susan Burk"
72
-
```
73
-
74
-
This example displays information about the user photo configured for Susan Burk.
75
-
76
-
### Example 1 -------------------------- (Exchange Online)
40
+
### Example 1
77
41
```
78
42
Get-UserPhoto "Susan Burk"
79
43
```
80
44
81
45
This example displays information about the user photo configured for Susan Burk.
82
46
83
-
### Example 2 -------------------------- (Exchange Server 2013)
84
-
```
85
-
Get-UserPhoto "Pilar Pinilla" -Preview
86
-
```
87
-
88
-
This example displays information about the user photo that was uploaded to Pilar Pinilla's account, but wasn't saved.
89
-
90
-
### Example 2 -------------------------- (Exchange Server 2016)
91
-
```
92
-
Get-UserPhoto "Pilar Pinilla" -Preview
93
-
```
94
-
95
-
This example displays information about the user photo that was uploaded to Pilar Pinilla's account, but wasn't saved.
96
-
97
-
### Example 2 -------------------------- (Exchange Online)
The Credential parameter specifies the account used to read Active Directory.
136
-
137
-
This parameter requires the creation and passing of a credential object. This credential object is created by using the Get-Credential cmdlet. For more information, see Get-Credential (https://go.microsoft.com/fwlink/p/?linkId=142122).
138
-
139
-
140
-
141
-
!!! Exchange Server 2016, Exchange Online
142
-
143
83
The Credential parameter specifies the user name and password that's used to run this command. Typically, you use this parameter in scripts or when you need to provide different credentials that have the required permissions.
144
84
145
85
This parameter requires the creation and passing of a credential object. This credential object is created by using the Get-Credential cmdlet. For more information, see Get-Credential (https://go.microsoft.com/fwlink/p/?linkId=142122).
The Filter parameter indicates the OPath filter used to filter recipients.
184
-
185
-
For more information about the filterable properties, see Filterable properties for the -Filter parameter.
186
-
187
-
188
-
189
-
!!! Exchange Server 2016, Exchange Online
190
-
191
119
The Filter parameter uses OPATH filter syntax to filter the results by the specified properties and values. The search criteria uses the syntax {\<Property\> -\<Comparison operator\> '\<Value\>'}.
192
120
193
121
- \<Property\> is a filterable property.
@@ -198,8 +126,6 @@ The Filter parameter uses OPATH filter syntax to filter the results by the speci
198
126
199
127
You can chain multiple search criteria together using the logical operators -and and -or. For example, {\<Criteria1\>) -and \<Criteria2\>} or {(\<Criteria1\> -and \<Criteria2\>) -or \<Criteria3\>}.
The OrganizationalUnit parameter returns objects only from the specified organizational unit (OU).
308
-
309
-
310
-
311
-
!!! Exchange Server 2016, Exchange Online
312
-
313
205
The OrganizationalUnit parameter filters the results based on the object's location in Active Directory. Only objects that exist in the specified location are returned. Valid input for this parameter is an organizational unit (OU) or domain that's visible using the Get-OrganizationalUnit cmdlet. You can use any value that uniquely identifies the OU or domain. For example:
314
206
315
207
- Name
@@ -320,8 +212,6 @@ The OrganizationalUnit parameter filters the results based on the object's locat
The Preview switch retrieves information about the preview photo for the user account. You don't need to specify a value with this switch.
342
-
343
-
The preview photo is the photo object that was uploaded to the user's account, but wasn't saved, for example, if a user uploads a photo in Outlook Web App Options, but doesn't save it. If you use the Preview parameter after a user photo is saved, this cmdlet returns an error saying the preview photo doesn't exist.
344
-
345
-
346
-
347
-
!!! Exchange Server 2016, Exchange Online
348
-
349
229
The Preview switch filters the results by preview photos. You don't need to specify a value with this switch.
350
230
351
231
A preview photo is a photo that was uploaded to the user's account, but wasn't saved, for example, if a user uploads a photo in Outlook on the web Options, but doesn't save it. If you use the Preview switch after a user photo is saved, this cmdlet returns an error saying the preview photo doesn't exist.
The SortBy parameter specifies the attribute by which to sort the results. You can sort by only one attribute at a time. The results are sorted in ascending order.
406
-
407
-
408
-
409
-
!!! Exchange Server 2016, Exchange Online
410
-
411
281
The SortBy parameter specifies the property to sort the results by. You can sort by only one property at a time. The results are sorted in ascending order.
412
282
413
283
If the default view doesn't include the property you're sorting by, you can append the command with | Format-Table -Auto \<Property1\>,\<Property2\>... to create a new view that contains all of the properties that you want to see. Wildcards (\*) in the property names are supported.
414
284
415
285
You can sort by the Id property.
416
286
417
-
418
-
419
287
```yaml
420
288
Type: String
421
289
Parameter Sets: (All)
@@ -479,4 +347,3 @@ To see the return types, which are also known as output types, that this cmdlet
0 commit comments