Get-MgUserPhotoContent
The user's profile photo. Read-only.
Note
To view the beta release of this cmdlet, view Get-MgBetaUserPhotoContent
Syntax
Get (Default)
Get-MgUserPhotoContent
-UserId <String>
-OutFile <String>
[-ResponseHeadersVariable <String>]
[-Headers <IDictionary>]
[-PassThru]
[<CommonParameters>]
Get1
Get-MgUserPhotoContent
-UserId <String>
-ProfilePhotoId <String>
-OutFile <String>
[-ResponseHeadersVariable <String>]
[-Headers <IDictionary>]
[-PassThru]
[<CommonParameters>]
GetViaIdentity1
Get-MgUserPhotoContent
-InputObject <IUsersIdentity>
-OutFile <String>
[-ResponseHeadersVariable <String>]
[-Headers <IDictionary>]
[-PassThru]
[<CommonParameters>]
GetViaIdentity
Get-MgUserPhotoContent
-InputObject <IUsersIdentity>
-OutFile <String>
[-ResponseHeadersVariable <String>]
[-Headers <IDictionary>]
[-PassThru]
[<CommonParameters>]
Description
The user's profile photo. Read-only.
Permissions
| Permission type | Permissions (from least to most privileged) |
|---|---|
| Delegated (work or school account) | User.Read, User.ReadBasic.All, ProfilePhoto.ReadWrite.All, ProfilePhoto.Read.All, |
| Delegated (personal Microsoft account) | Not supported |
| Application | ProfilePhoto.Read.All, User.ReadBasic.All, User.Read.All, ProfilePhoto.ReadWrite.All, |
Examples
Example 1: Code snippet
Import-Module Microsoft.Graph.Users
# A UPN can also be used as -UserId.
Get-MgUserPhotoContent -UserId $userId -OutFile $outFileId
This example shows how to use the Get-MgUserPhotoContent Cmdlet.
Parameters
-Headers
Optional headers that will be added to the request.
Parameter properties
| Type: | IDictionary |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
(All)
| Position: | Named |
| Mandatory: | False |
| Value from pipeline: | True |
| Value from pipeline by property name: | False |
| Value from remaining arguments: | False |
-InputObject
Identity Parameter To construct, see NOTES section for INPUTOBJECT properties and create a hash table.
Parameter properties
| Type: | IUsersIdentity |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
GetViaIdentity1
| Position: | Named |
| Mandatory: | True |
| Value from pipeline: | True |
| Value from pipeline by property name: | False |
| Value from remaining arguments: | False |
GetViaIdentity
| Position: | Named |
| Mandatory: | True |
| Value from pipeline: | True |
| Value from pipeline by property name: | False |
| Value from remaining arguments: | False |
-OutFile
Path to write output file to
Parameter properties
| Type: | String |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
(All)
| Position: | Named |
| Mandatory: | True |
| Value from pipeline: | False |
| Value from pipeline by property name: | False |
| Value from remaining arguments: | False |
-PassThru
Returns true when the command succeeds
Parameter properties
| Type: | SwitchParameter |
| Default value: | False |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
(All)
| Position: | Named |
| Mandatory: | False |
| Value from pipeline: | False |
| Value from pipeline by property name: | False |
| Value from remaining arguments: | False |
-ProfilePhotoId
The unique identifier of profilePhoto
Parameter properties
| Type: | String |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
Get1
| Position: | Named |
| Mandatory: | True |
| Value from pipeline: | False |
| Value from pipeline by property name: | False |
| Value from remaining arguments: | False |
-ResponseHeadersVariable
Optional Response Headers Variable.
Parameter properties
| Type: | String |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
| Aliases: | RHV |
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 unique identifier of user
Parameter properties
| Type: | String |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
Get
| Position: | Named |
| Mandatory: | True |
| Value from pipeline: | False |
| Value from pipeline by property name: | False |
| Value from remaining arguments: | False |
Get1
| Position: | Named |
| Mandatory: | True |
| Value from pipeline: | False |
| Value from pipeline by property name: | False |
| 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
Microsoft.Graph.PowerShell.Models.IUsersIdentity
System.Collections.IDictionary
Outputs
System.Boolean
Notes
COMPLEX PARAMETER PROPERTIES
To create the parameters described below, construct a hash table containing the appropriate properties. For information on hash tables, run Get-Help about_Hash_Tables.
INPUTOBJECT <IUsersIdentity>: Identity Parameter
[AttachmentBaseId <String>]: The unique identifier of attachmentBase[AttachmentSessionId <String>]: The unique identifier of attachmentSession[ChecklistItemId <String>]: The unique identifier of checklistItem[DirectoryObjectId <String>]: The unique identifier of directoryObject[ExtensionId <String>]: The unique identifier of extension[LicenseDetailsId <String>]: The unique identifier of licenseDetails[LinkedResourceId <String>]: The unique identifier of linkedResource[OAuth2PermissionGrantId <String>]: The unique identifier of oAuth2PermissionGrant[OutlookCategoryId <String>]: The unique identifier of outlookCategory[ProfilePhotoId <String>]: The unique identifier of profilePhoto[ServiceStorageQuotaBreakdownId <String>]: The unique identifier of serviceStorageQuotaBreakdown[SharedInsightId <String>]: The unique identifier of sharedInsight[TimeZoneStandard <String>]: Usage: TimeZoneStandard='{TimeZoneStandard}'[TodoTaskId <String>]: The unique identifier of todoTask[TodoTaskListId <String>]: The unique identifier of todoTaskList[TrendingId <String>]: The unique identifier of trending[UsedInsightId <String>]: The unique identifier of usedInsight[UserId <String>]: The unique identifier of user[UserPrincipalName <String>]: Alternate key of user[WindowsSettingId <String>]: The unique identifier of windowsSetting[WindowsSettingInstanceId <String>]: The unique identifier of windowsSettingInstance