Share via

Update-MgBetaUserProfileEmail

Module:
Microsoft.Graph.Beta.People

Update the properties of an itemEmail object in a user's profile.

Syntax

Update-MgBetaUserProfileEmail
      -ItemEmailId <String>
      -UserId <String>
      [-ResponseHeadersVariable <String>]
      [-AdditionalProperties <Hashtable>]
      [-Address <String>]
      [-AllowedAudiences <String>]
      [-CreatedBy <IMicrosoftGraphIdentitySet>]
      [-CreatedDateTime <DateTime>]
      [-DisplayName <String>]
      [-Id <String>]
      [-Inference <IMicrosoftGraphInferenceData>]
      [-IsSearchable]
      [-LastModifiedBy <IMicrosoftGraphIdentitySet>]
      [-LastModifiedDateTime <DateTime>]
      [-Source <IMicrosoftGraphPersonDataSources>]
      [-Sources <IMicrosoftGraphProfileSourceAnnotation[]>]
      [-Type <String>]
      [-Headers <IDictionary>]
      [-ProgressAction <ActionPreference>]
      [-WhatIf]
      [-Confirm]
      [<CommonParameters>]
Update-MgBetaUserProfileEmail
      -ItemEmailId <String>
      -UserId <String>
      -BodyParameter <IMicrosoftGraphItemEmail>
      [-ResponseHeadersVariable <String>]
      [-Headers <IDictionary>]
      [-ProgressAction <ActionPreference>]
      [-WhatIf]
      [-Confirm]
      [<CommonParameters>]
Update-MgBetaUserProfileEmail
      -InputObject <IPeopleIdentity>
      [-ResponseHeadersVariable <String>]
      [-AdditionalProperties <Hashtable>]
      [-Address <String>]
      [-AllowedAudiences <String>]
      [-CreatedBy <IMicrosoftGraphIdentitySet>]
      [-CreatedDateTime <DateTime>]
      [-DisplayName <String>]
      [-Id <String>]
      [-Inference <IMicrosoftGraphInferenceData>]
      [-IsSearchable]
      [-LastModifiedBy <IMicrosoftGraphIdentitySet>]
      [-LastModifiedDateTime <DateTime>]
      [-Source <IMicrosoftGraphPersonDataSources>]
      [-Sources <IMicrosoftGraphProfileSourceAnnotation[]>]
      [-Type <String>]
      [-Headers <IDictionary>]
      [-ProgressAction <ActionPreference>]
      [-WhatIf]
      [-Confirm]
      [<CommonParameters>]
Update-MgBetaUserProfileEmail
      -InputObject <IPeopleIdentity>
      -BodyParameter <IMicrosoftGraphItemEmail>
      [-ResponseHeadersVariable <String>]
      [-Headers <IDictionary>]
      [-ProgressAction <ActionPreference>]
      [-WhatIf]
      [-Confirm]
      [<CommonParameters>]

Description

Update the properties of an itemEmail object in a user's profile.

Permissions

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

Examples

Example 1: Code snippet

Import-Module Microsoft.Graph.Beta.People

$params = @{
	displayName = "Business Email"
	type = "work"
}

Update-MgBetaUserProfileEmail -UserId $userId -ItemEmailId $itemEmailId -BodyParameter $params

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

Parameters

-AdditionalProperties

Additional Parameters

Type:Hashtable
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-Address

The email address itself.

Type:String
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-AllowedAudiences

allowedAudiences

Type:String
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-BodyParameter

itemEmail To construct, see NOTES section for BODYPARAMETER properties and create a hash table.

Type:IMicrosoftGraphItemEmail
Position:Named
Default value:None
Required:True
Accept pipeline input:True
Accept wildcard characters:False

-Confirm

Prompts you for confirmation before running the cmdlet.

Type:SwitchParameter
Aliases:cf
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-CreatedBy

identitySet To construct, see NOTES section for CREATEDBY properties and create a hash table.

Type:IMicrosoftGraphIdentitySet
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-CreatedDateTime

Provides the dateTimeOffset for when the entity was created.

Type:DateTime
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-DisplayName

The name or label a user has associated with a particular email address.

Type:String
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-Headers

Optional headers that will be added to the request.

Type:IDictionary
Position:Named
Default value:None
Required:False
Accept pipeline input:True
Accept wildcard characters:False

-Id

The unique identifier for an entity. Read-only.

Type:String
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-Inference

inferenceData To construct, see NOTES section for INFERENCE properties and create a hash table.

Type:IMicrosoftGraphInferenceData
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-InputObject

Identity Parameter To construct, see NOTES section for INPUTOBJECT properties and create a hash table.

Type:IPeopleIdentity
Position:Named
Default value:None
Required:True
Accept pipeline input:True
Accept wildcard characters:False

-IsSearchable

Type:SwitchParameter
Position:Named
Default value:False
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-ItemEmailId

The unique identifier of itemEmail

Type:String
Position:Named
Default value:None
Required:True
Accept pipeline input:False
Accept wildcard characters:False

-LastModifiedBy

identitySet To construct, see NOTES section for LASTMODIFIEDBY properties and create a hash table.

Type:IMicrosoftGraphIdentitySet
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-LastModifiedDateTime

Provides the dateTimeOffset for when the entity was created.

Type:DateTime
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-ProgressAction

{{ Fill ProgressAction Description }}

Type:ActionPreference
Aliases:proga
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-ResponseHeadersVariable

Optional Response Headers Variable.

Type:String
Aliases:RHV
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-Source

personDataSources To construct, see NOTES section for SOURCE properties and create a hash table.

Type:IMicrosoftGraphPersonDataSources
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-Sources

Where the values within an entity originated if synced from another source. To construct, see NOTES section for SOURCES properties and create a hash table.

Type:IMicrosoftGraphProfileSourceAnnotation[]
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-Type

emailType

Type:String
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-UserId

The unique identifier of user

Type:String
Position:Named
Default value:None
Required:True
Accept pipeline input:False
Accept wildcard characters:False

-WhatIf

Shows what would happen if the cmdlet runs. The cmdlet is not run.

Type:SwitchParameter
Aliases:wi
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

Inputs

Microsoft.Graph.Beta.PowerShell.Models.IMicrosoftGraphItemEmail

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.

BODYPARAMETER <IMicrosoftGraphItemEmail>: itemEmail

  • [(Any) <Object>]: This indicates any property can be added to this object.
  • [AllowedAudiences <String>]: allowedAudiences
  • [CreatedBy <IMicrosoftGraphIdentitySet>]: identitySet
    • [(Any) <Object>]: This indicates any property can be added to this object.
    • [Application <IMicrosoftGraphIdentity>]: identity
      • [(Any) <Object>]: This indicates any property can be added to this object.
      • [DisplayName <String>]: The display name of the identity. This property is read-only.
      • [Id <String>]: The identifier of the identity. This property is read-only.
    • [Device <IMicrosoftGraphIdentity>]: identity
    • [User <IMicrosoftGraphIdentity>]: identity
  • [CreatedDateTime <DateTime?>]: Provides the dateTimeOffset for when the entity was created.
  • [Inference <IMicrosoftGraphInferenceData>]: inferenceData
    • [(Any) <Object>]: This indicates any property can be added to this object.
    • [ConfidenceScore <Double?>]: Confidence score reflecting the accuracy of the data inferred about the user.
    • [UserHasVerifiedAccuracy <Boolean?>]: Records if the user has confirmed this inference as being True or False.
  • [IsSearchable <Boolean?>]:
  • [LastModifiedBy <IMicrosoftGraphIdentitySet>]: identitySet
  • [LastModifiedDateTime <DateTime?>]: Provides the dateTimeOffset for when the entity was created.
  • [Source <IMicrosoftGraphPersonDataSources>]: personDataSources
    • [(Any) <Object>]: This indicates any property can be added to this object.
    • [Type <String- []>]:
  • [Sources <IMicrosoftGraphProfileSourceAnnotation- []>]: Where the values within an entity originated if synced from another source.
    • [IsDefaultSource <Boolean?>]: Indicates whether the source is the default one.
    • [Properties <String- []>]: Names of properties that have data from this source.
    • [SourceId <String>]:
  • [Id <String>]: The unique identifier for an entity. Read-only.
  • [Address <String>]: The email address itself.
  • [DisplayName <String>]: The name or label a user has associated with a particular email address.
  • [Type <String>]: emailType

CREATEDBY <IMicrosoftGraphIdentitySet>: identitySet

  • [(Any) <Object>]: This indicates any property can be added to this object.
  • [Application <IMicrosoftGraphIdentity>]: identity
    • [(Any) <Object>]: This indicates any property can be added to this object.
    • [DisplayName <String>]: The display name of the identity. This property is read-only.
    • [Id <String>]: The identifier of the identity. This property is read-only.
  • [Device <IMicrosoftGraphIdentity>]: identity
  • [User <IMicrosoftGraphIdentity>]: identity

INFERENCE <IMicrosoftGraphInferenceData>: inferenceData

  • [(Any) <Object>]: This indicates any property can be added to this object.
  • [ConfidenceScore <Double?>]: Confidence score reflecting the accuracy of the data inferred about the user.
  • [UserHasVerifiedAccuracy <Boolean?>]: Records if the user has confirmed this inference as being True or False.

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

LASTMODIFIEDBY <IMicrosoftGraphIdentitySet>: identitySet

  • [(Any) <Object>]: This indicates any property can be added to this object.
  • [Application <IMicrosoftGraphIdentity>]: identity
    • [(Any) <Object>]: This indicates any property can be added to this object.
    • [DisplayName <String>]: The display name of the identity. This property is read-only.
    • [Id <String>]: The identifier of the identity. This property is read-only.
  • [Device <IMicrosoftGraphIdentity>]: identity
  • [User <IMicrosoftGraphIdentity>]: identity

SOURCE <IMicrosoftGraphPersonDataSources>: personDataSources

  • [(Any) <Object>]: This indicates any property can be added to this object.
  • [Type <String- []>]:

SOURCES <IMicrosoftGraphProfileSourceAnnotation- []>: Where the values within an entity originated if synced from another source.

  • [IsDefaultSource <Boolean?>]: Indicates whether the source is the default one.
  • [Properties <String- []>]: Names of properties that have data from this source.
  • [SourceId <String>]: