Get-MgBetaUserProfileEmail

Module:

Microsoft.Graph.Beta.People Module

Retrieve the properties and relationships of an itemEmail object in a user's profile.

Syntax

List (Default)

Get-MgBetaUserProfileEmail
    -UserId <String>
    [-ExpandProperty <String[]>]
    [-Property <String[]>]
    [-Filter <String>]
    [-Search <String>]
    [-Skip <Int32>]
    [-Sort <String[]>]
    [-Top <Int32>]
    [-ResponseHeadersVariable <String>]
    [-Headers <IDictionary>]
    [-PageSize <Int32>]
    [-All]
    [-CountVariable <String>]
    [<CommonParameters>]

Get

Get-MgBetaUserProfileEmail
    -ItemEmailId <String>
    -UserId <String>
    [-ExpandProperty <String[]>]
    [-Property <String[]>]
    [-ResponseHeadersVariable <String>]
    [-Headers <IDictionary>]
    [<CommonParameters>]

GetViaIdentity

Get-MgBetaUserProfileEmail
    -InputObject <IPeopleIdentity>
    [-ExpandProperty <String[]>]
    [-Property <String[]>]
    [-ResponseHeadersVariable <String>]
    [-Headers <IDictionary>]
    [<CommonParameters>]

Description

Retrieve the properties and relationships of an itemEmail object in a user's profile.

Permissions

Permission type	Permissions (from least to most privileged)
Delegated (work or school account)	User.Read, User.ReadWrite.All, User.ReadWrite, User.ReadBasic.All, User.Read.All,
Delegated (personal Microsoft account)	User.Read, User.ReadWrite,
Application	User.Read.All, User.ReadWrite.All,

Examples

Example 1: Code snippet

Import-Module Microsoft.Graph.Beta.People

Get-MgBetaUserProfileEmail -UserId $userId -ItemEmailId $itemEmailId

This example shows how to use the Get-MgBetaUserProfileEmail Cmdlet.

Parameters

-All

List all pages.

Parameter properties

Type:	SwitchParameter
Default value:	False
Supports wildcards:	False
DontShow:	False

Parameter sets

List

Position:	Named
Mandatory:	False
Value from pipeline:	False
Value from pipeline by property name:	False
Value from remaining arguments:	False

-CountVariable

Specifies a count of the total number of items in a collection. By default, this variable will be set in the global scope.

Parameter properties

Type:	String
Default value:	None
Supports wildcards:	False
DontShow:	False
Aliases:	CV

Parameter sets

List

Position:	Named
Mandatory:	False
Value from pipeline:	False
Value from pipeline by property name:	False
Value from remaining arguments:	False

-ExpandProperty

Expand related entities

Parameter properties

Type:	String[]
Default value:	None
Supports wildcards:	False
DontShow:	False
Aliases:	Expand

Parameter sets

(All)

Position:	Named
Mandatory:	False
Value from pipeline:	False
Value from pipeline by property name:	False
Value from remaining arguments:	False

-Filter

Filter items by property values

Parameter properties

Type:	String
Default value:	None
Supports wildcards:	False
DontShow:	False

Parameter sets

List

Position:	Named
Mandatory:	False
Value from pipeline:	False
Value from pipeline by property name:	False
Value from remaining arguments:	False

-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:	IPeopleIdentity
Default value:	None
Supports wildcards:	False
DontShow:	False

Parameter sets

GetViaIdentity

Position:	Named
Mandatory:	True
Value from pipeline:	True
Value from pipeline by property name:	False
Value from remaining arguments:	False

-ItemEmailId

The unique identifier of itemEmail

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

-PageSize

Sets the page size of results.

Parameter properties

Type:	Int32
Default value:	0
Supports wildcards:	False
DontShow:	False

Parameter sets

List

Position:	Named
Mandatory:	False
Value from pipeline:	False
Value from pipeline by property name:	False
Value from remaining arguments:	False

-Property

Select properties to be returned

Parameter properties

Type:	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

-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

-Search

Search items by search phrases

Parameter properties

Type:	String
Default value:	None
Supports wildcards:	False
DontShow:	False

Parameter sets

List

Position:	Named
Mandatory:	False
Value from pipeline:	False
Value from pipeline by property name:	False
Value from remaining arguments:	False

-Skip

Skip the first n items

Parameter properties

Type:	Int32
Default value:	0
Supports wildcards:	False
DontShow:	False

Parameter sets

List

Position:	Named
Mandatory:	False
Value from pipeline:	False
Value from pipeline by property name:	False
Value from remaining arguments:	False

-Sort

Order items by property values

Parameter properties

Type:	String[]
Default value:	None
Supports wildcards:	False
DontShow:	False
Aliases:	OrderBy

Parameter sets

List

Position:	Named
Mandatory:	False
Value from pipeline:	False
Value from pipeline by property name:	False
Value from remaining arguments:	False

-Top

Show only the first n items

Parameter properties

Type:	Int32
Default value:	0
Supports wildcards:	False
DontShow:	False
Aliases:	Limit

Parameter sets

List

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

List

Position:	Named
Mandatory:	True
Value from pipeline:	False
Value from pipeline by property name:	False
Value from remaining arguments:	False

Get

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.Beta.PowerShell.Models.IPeopleIdentity

System.Collections.IDictionary

Outputs

Microsoft.Graph.Beta.PowerShell.Models.IMicrosoftGraphItemEmail

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 <IPeopleIdentity>: Identity Parameter

• [ActivityStatisticsId <String>]: The unique identifier of activityStatistics
• [EducationalActivityId <String>]: The unique identifier of educationalActivity
• [ItemAddressId <String>]: The unique identifier of itemAddress
• [ItemEmailId <String>]: The unique identifier of itemEmail
• [ItemPatentId <String>]: The unique identifier of itemPatent
• [ItemPhoneId <String>]: The unique identifier of itemPhone
• [ItemPublicationId <String>]: The unique identifier of itemPublication
• [LanguageProficiencyId <String>]: The unique identifier of languageProficiency
• [PersonAnnotationId <String>]: The unique identifier of personAnnotation
• [PersonAnnualEventId <String>]: The unique identifier of personAnnualEvent
• [PersonAwardId <String>]: The unique identifier of personAward
• [PersonCertificationId <String>]: The unique identifier of personCertification
• [PersonId <String>]: The unique identifier of person
• [PersonInterestId <String>]: The unique identifier of personInterest
• [PersonNameId <String>]: The unique identifier of personName
• [PersonWebsiteId <String>]: The unique identifier of personWebsite
• [ProjectParticipationId <String>]: The unique identifier of projectParticipation
• [SkillProficiencyId <String>]: The unique identifier of skillProficiency
• [UserAccountInformationId <String>]: The unique identifier of userAccountInformation
• [UserId <String>]: The unique identifier of user
• [WebAccountId <String>]: The unique identifier of webAccount
• [WorkPositionId <String>]: The unique identifier of workPosition

Related Links

• https://learn.microsoft.com/powershell/module/microsoft.graph.beta.people/get-mgbetauserprofileemail
• https://learn.microsoft.com/graph/api/itememail-get?view=graph-rest-beta