Share via

Update-MgBetaUserProfileName

  • Reference
Module:
Microsoft.Graph.Beta.People

Update the navigation property names in users

Syntax

Update-MgBetaUserProfileName
      -PersonNameId <String>
      -UserId <String>
      [-ResponseHeadersVariable <String>]
      [-AdditionalProperties <Hashtable>]
      [-AllowedAudiences <String>]
      [-CreatedBy <IMicrosoftGraphIdentitySet>]
      [-CreatedDateTime <DateTime>]
      [-DisplayName <String>]
      [-First <String>]
      [-Id <String>]
      [-Inference <IMicrosoftGraphInferenceData>]
      [-Initials <String>]
      [-IsSearchable]
      [-LanguageTag <String>]
      [-Last <String>]
      [-LastModifiedBy <IMicrosoftGraphIdentitySet>]
      [-LastModifiedDateTime <DateTime>]
      [-Maiden <String>]
      [-Middle <String>]
      [-Nickname <String>]
      [-Pronunciation <IMicrosoftGraphPersonNamePronounciation>]
      [-Source <IMicrosoftGraphPersonDataSources>]
      [-Sources <IMicrosoftGraphProfileSourceAnnotation[]>]
      [-Suffix <String>]
      [-Title <String>]
      [-Headers <IDictionary>]
      [-ProgressAction <ActionPreference>]
      [-WhatIf]
      [-Confirm]
      [<CommonParameters>]
Update-MgBetaUserProfileName
      -PersonNameId <String>
      -UserId <String>
      -BodyParameter <IMicrosoftGraphPersonName>
      [-ResponseHeadersVariable <String>]
      [-Headers <IDictionary>]
      [-ProgressAction <ActionPreference>]
      [-WhatIf]
      [-Confirm]
      [<CommonParameters>]
Update-MgBetaUserProfileName
      -InputObject <IPeopleIdentity>
      [-ResponseHeadersVariable <String>]
      [-AdditionalProperties <Hashtable>]
      [-AllowedAudiences <String>]
      [-CreatedBy <IMicrosoftGraphIdentitySet>]
      [-CreatedDateTime <DateTime>]
      [-DisplayName <String>]
      [-First <String>]
      [-Id <String>]
      [-Inference <IMicrosoftGraphInferenceData>]
      [-Initials <String>]
      [-IsSearchable]
      [-LanguageTag <String>]
      [-Last <String>]
      [-LastModifiedBy <IMicrosoftGraphIdentitySet>]
      [-LastModifiedDateTime <DateTime>]
      [-Maiden <String>]
      [-Middle <String>]
      [-Nickname <String>]
      [-Pronunciation <IMicrosoftGraphPersonNamePronounciation>]
      [-Source <IMicrosoftGraphPersonDataSources>]
      [-Sources <IMicrosoftGraphProfileSourceAnnotation[]>]
      [-Suffix <String>]
      [-Title <String>]
      [-Headers <IDictionary>]
      [-ProgressAction <ActionPreference>]
      [-WhatIf]
      [-Confirm]
      [<CommonParameters>]
Update-MgBetaUserProfileName
      -InputObject <IPeopleIdentity>
      -BodyParameter <IMicrosoftGraphPersonName>
      [-ResponseHeadersVariable <String>]
      [-Headers <IDictionary>]
      [-ProgressAction <ActionPreference>]
      [-WhatIf]
      [-Confirm]
      [<CommonParameters>]

Description

Update the navigation property names in users

Examples

Example 1: Code snippet

Import-Module Microsoft.Graph.Beta.People

$params = @{
	nickname = "Kesha"
}

# A UPN can also be used as -UserId.
Update-MgBetaUserProfileName -UserId $userId -PersonNameId $personNameId -BodyParameter $params

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

Parameters

-AdditionalProperties

Additional Parameters

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

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

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

Provides an ordered rendering of firstName and lastName depending on the locale of the user or their device.

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

-First

First name of the user.

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

-Initials

Initials of the user.

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

-LanguageTag

Contains the name for the language (en-US, no-NB, en-AU) following IETF BCP47 format.

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

-Last

Last name of the user.

Type:String
Position:Named
Default value:None
Required:False
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

-Maiden

Maiden name of the user.

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

-Middle

Middle name of the user.

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

-Nickname

Nickname of the user.

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

-PersonNameId

The unique identifier of personName

Type:String
Position:Named
Default value:None
Required:True
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

-Pronunciation

personNamePronounciation To construct, see NOTES section for PRONUNCIATION properties and create a hash table.

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

-Suffix

Designators used after the users name (eg: PhD.)

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

-Title

Honorifics used to prefix a users name (eg: Dr, Sir, Madam, Mrs.)

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.IMicrosoftGraphPersonName

Microsoft.Graph.Beta.PowerShell.Models.IPeopleIdentity

System.Collections.IDictionary

Outputs

Microsoft.Graph.Beta.PowerShell.Models.IMicrosoftGraphPersonName

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 <IMicrosoftGraphPersonName>: personName

  • [(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. For drive items, the display name might not always be available or up to date. For example, if a user changes their display name the API might show the new value in a future response, but the items associated with the user don't show up as changed when using delta.
      • [Id <String>]: Unique identifier for the identity or actor. For example, in the access reviews decisions API, this property might record the id of the principal, that is, the group, user, or application that's subject to review.
    • [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.
  • [DisplayName <String>]: Provides an ordered rendering of firstName and lastName depending on the locale of the user or their device.
  • [First <String>]: First name of the user.
  • [Initials <String>]: Initials of the user.
  • [LanguageTag <String>]: Contains the name for the language (en-US, no-NB, en-AU) following IETF BCP47 format.
  • [Last <String>]: Last name of the user.
  • [Maiden <String>]: Maiden name of the user.
  • [Middle <String>]: Middle name of the user.
  • [Nickname <String>]: Nickname of the user.
  • [Pronunciation <IMicrosoftGraphPersonNamePronounciation>]: personNamePronounciation
    • [(Any) <Object>]: This indicates any property can be added to this object.
    • [DisplayName <String>]:
    • [First <String>]:
    • [Last <String>]:
    • [Maiden <String>]:
    • [Middle <String>]:
  • [Suffix <String>]: Designators used after the users name (eg: PhD.)
  • [Title <String>]: Honorifics used to prefix a users name (eg: Dr, Sir, Madam, Mrs.)

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. For drive items, the display name might not always be available or up to date. For example, if a user changes their display name the API might show the new value in a future response, but the items associated with the user don't show up as changed when using delta.
    • [Id <String>]: Unique identifier for the identity or actor. For example, in the access reviews decisions API, this property might record the id of the principal, that is, the group, user, or application that's subject to review.
  • [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. For drive items, the display name might not always be available or up to date. For example, if a user changes their display name the API might show the new value in a future response, but the items associated with the user don't show up as changed when using delta.
    • [Id <String>]: Unique identifier for the identity or actor. For example, in the access reviews decisions API, this property might record the id of the principal, that is, the group, user, or application that's subject to review.
  • [Device <IMicrosoftGraphIdentity>]: identity
  • [User <IMicrosoftGraphIdentity>]: identity

PRONUNCIATION <IMicrosoftGraphPersonNamePronounciation>: personNamePronounciation

  • [(Any) <Object>]: This indicates any property can be added to this object.
  • [DisplayName <String>]:
  • [First <String>]:
  • [Last <String>]:
  • [Maiden <String>]:
  • [Middle <String>]:

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