Get-EntraUserThumbnailPhoto
Retrieve the thumbnail photo of a user.
Syntax
Default (Default)
Get-EntraUserThumbnailPhoto
-UserId <String>
[-FileName <String>]
[-FilePath <String>]
[-View <Boolean>]
[-Property <String[]>]
[<CommonParameters>]
Description
Retrieve the thumbnail photo of a user.
Examples
Example 1: Retrieve thumbnail photo by Id
Connect-Entra -Scopes 'User.Read','User.Read.All'
Get-EntraUserThumbnailPhoto -UserId 'SawyerM@contoso.com'
Id Height Width
-- ------ -----
default 292 278
This example shows how to retrieve the thumbnail photo of a user that is specified through the value of the UserId parameter.
-UserIdparameter specifies the user for which the thumbnail photo is retrieved.
Parameters
-FileName
Specifies the file name to save the retrieved thumbnail photo.
Parameter properties
| Type: | System.String |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
| Aliases: | None |
Parameter sets
(All)
| Position: | Named |
| Mandatory: | False |
| Value from pipeline: | True |
| Value from pipeline by property name: | True |
| Value from remaining arguments: | False |
-FilePath
Specifies the file path or location where the thumbnail photo will be saved.
Parameter properties
| Type: | System.String |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
| Aliases: | None |
Parameter sets
(All)
| Position: | Named |
| Mandatory: | False |
| Value from pipeline: | True |
| Value from pipeline by property name: | True |
| Value from remaining arguments: | False |
-Property
Specifies properties to be returned
Parameter properties
| Type: | System.String[] |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
| Aliases: | Select |
Parameter sets
(All)
| Position: | Named |
| Mandatory: | False |
| Value from pipeline: | False |
| Value from pipeline by property name: | False |
| Value from remaining arguments: | False |
-UserId
The object ID of the user for which the thumbnail photo is retrieved.
Parameter properties
| Type: | System.String |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
| Aliases: | ObjectId, UPN, Identity, UserPrincipalName |
Parameter sets
(All)
| Position: | Named |
| Mandatory: | True |
| Value from pipeline: | True |
| Value from pipeline by property name: | True |
| Value from remaining arguments: | False |
-View
Specifies whether to view the thumbnail photo immediately after retrieval.
Parameter properties
| Type: | System.Boolean |
| Default value: | False |
| Supports wildcards: | False |
| DontShow: | False |
| Aliases: | None |
Parameter sets
(All)
| Position: | Named |
| Mandatory: | False |
| Value from pipeline: | True |
| Value from pipeline by property name: | True |
| Value from remaining arguments: | False |
CommonParameters
This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutBuffer, -OutVariable, -PipelineVariable, -ProgressAction, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters.
Inputs
System.String
System.Boolean