Share via


Update-MgBetaUserProfileAccount

Update the navigation property account in users

Syntax

UpdateExpanded (Default)

Update-MgBetaUserProfileAccount
    -UserAccountInformationId <String>
    -UserId <String>
    [-ResponseHeadersVariable <String>]
    [-AdditionalProperties <Hashtable>]
    [-AgeGroup <String>]
    [-AllowedAudiences <String>]
    [-CountryCode <String>]
    [-CreatedBy <IMicrosoftGraphIdentitySet>]
    [-CreatedDateTime <DateTime>]
    [-Id <String>]
    [-Inference <IMicrosoftGraphInferenceData>]
    [-IsSearchable]
    [-LastModifiedBy <IMicrosoftGraphIdentitySet>]
    [-LastModifiedDateTime <DateTime>]
    [-PreferredLanguageTag <IMicrosoftGraphLocaleInfo>]
    [-Source <IMicrosoftGraphPersonDataSources>]
    [-Sources <IMicrosoftGraphProfileSourceAnnotation[]>]
    [-UserPrincipalName <String>]
    [-Headers <IDictionary>]
    [-WhatIf]
    [-Confirm]
    [<CommonParameters>]

Update

Update-MgBetaUserProfileAccount
    -UserAccountInformationId <String>
    -UserId <String>
    -BodyParameter <IMicrosoftGraphUserAccountInformation>
    [-ResponseHeadersVariable <String>]
    [-Headers <IDictionary>]
    [-WhatIf]
    [-Confirm]
    [<CommonParameters>]

UpdateViaIdentityExpanded

Update-MgBetaUserProfileAccount
    -InputObject <IPeopleIdentity>
    [-ResponseHeadersVariable <String>]
    [-AdditionalProperties <Hashtable>]
    [-AgeGroup <String>]
    [-AllowedAudiences <String>]
    [-CountryCode <String>]
    [-CreatedBy <IMicrosoftGraphIdentitySet>]
    [-CreatedDateTime <DateTime>]
    [-Id <String>]
    [-Inference <IMicrosoftGraphInferenceData>]
    [-IsSearchable]
    [-LastModifiedBy <IMicrosoftGraphIdentitySet>]
    [-LastModifiedDateTime <DateTime>]
    [-PreferredLanguageTag <IMicrosoftGraphLocaleInfo>]
    [-Source <IMicrosoftGraphPersonDataSources>]
    [-Sources <IMicrosoftGraphProfileSourceAnnotation[]>]
    [-UserPrincipalName <String>]
    [-Headers <IDictionary>]
    [-WhatIf]
    [-Confirm]
    [<CommonParameters>]

UpdateViaIdentity

Update-MgBetaUserProfileAccount
    -InputObject <IPeopleIdentity>
    -BodyParameter <IMicrosoftGraphUserAccountInformation>
    [-ResponseHeadersVariable <String>]
    [-Headers <IDictionary>]
    [-WhatIf]
    [-Confirm]
    [<CommonParameters>]

Description

Update the navigation property account in users

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 = @{
	countryCode = "NO"
}

# A UPN can also be used as -UserId.
Update-MgBetaUserProfileAccount -UserId $userId -UserAccountInformationId $userAccountInformationId -BodyParameter $params

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

Parameters

-AdditionalProperties

Additional Parameters

Parameter properties

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

Parameter sets

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

-AgeGroup

Shows the age group of user. Allowed values null, minor, notAdult and adult are generated by the directory and can't be changed.

Parameter properties

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

Parameter sets

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

-AllowedAudiences

allowedAudiences

Parameter properties

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

Parameter sets

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

-BodyParameter

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

Parameter properties

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

Parameter sets

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

-Confirm

Prompts you for confirmation before running the cmdlet.

Parameter properties

Type:SwitchParameter
Default value:None
Supports wildcards:False
DontShow:False
Aliases:cf

Parameter sets

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

-CountryCode

Contains the two-character country code associated with the users' account.

Parameter properties

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

Parameter sets

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

-CreatedBy

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

Parameter properties

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

Parameter sets

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

-CreatedDateTime

Provides the dateTimeOffset for when the entity was created.

Parameter properties

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

Parameter sets

UpdateExpanded
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False
UpdateViaIdentityExpanded
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

-Id

The unique identifier for an entity. Read-only.

Parameter properties

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

Parameter sets

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

-Inference

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

Parameter properties

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

Parameter sets

UpdateExpanded
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False
UpdateViaIdentityExpanded
Position:Named
Mandatory:False
Value from pipeline:False
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

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

-IsSearchable

Update the navigation property account in users

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,

Parameter properties

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

Parameter sets

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

-LastModifiedBy

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

Parameter properties

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

Parameter sets

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

-LastModifiedDateTime

Provides the dateTimeOffset for when the entity was created.

Parameter properties

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

Parameter sets

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

-PreferredLanguageTag

localeInfo To construct, see NOTES section for PREFERREDLANGUAGETAG properties and create a hash table.

Parameter properties

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

Parameter sets

UpdateExpanded
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False
UpdateViaIdentityExpanded
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

-Source

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

Parameter properties

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

Parameter sets

UpdateExpanded
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False
UpdateViaIdentityExpanded
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments: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.

Parameter properties

Type:

IMicrosoftGraphProfileSourceAnnotation[]

Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

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

-UserAccountInformationId

The unique identifier of userAccountInformation

Parameter properties

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

Parameter sets

UpdateExpanded
Position:Named
Mandatory:True
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False
Update
Position:Named
Mandatory:True
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

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

-UserPrincipalName

The user principal name (UPN) of the user associated with the account.

Parameter properties

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

Parameter sets

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

-WhatIf

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

Parameter properties

Type:SwitchParameter
Default value:None
Supports wildcards:False
DontShow:False
Aliases:wi

Parameter sets

(All)
Position:Named
Mandatory:False
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.IMicrosoftGraphUserAccountInformation

Microsoft.Graph.Beta.PowerShell.Models.IPeopleIdentity

System.Collections.IDictionary

Outputs

Microsoft.Graph.Beta.PowerShell.Models.IMicrosoftGraphUserAccountInformation

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 <IMicrosoftGraphUserAccountInformation>: userAccountInformation

  • [(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.
  • [AgeGroup <String>]: Shows the age group of user. Allowed values null, minor, notAdult and adult are generated by the directory and can't be changed.
  • [CountryCode <String>]: Contains the two-character country code associated with the users' account.
  • [PreferredLanguageTag <IMicrosoftGraphLocaleInfo>]: localeInfo
    • [(Any) <Object>]: This indicates any property can be added to this object.
    • [DisplayName <String>]: A name representing the user's locale in natural language, for example, 'English (United States)'.
    • [Locale <String>]: A locale representation for the user, which includes the user's preferred language and country/region. For example, 'en-us'. The language component follows 2-letter codes as defined in ISO 639-1, and the country component follows 2-letter codes as defined in ISO 3166-1 alpha-2.
  • [UserPrincipalName <String>]: The user principal name (UPN) of the user associated with the account.

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

PREFERREDLANGUAGETAG <IMicrosoftGraphLocaleInfo>: localeInfo

  • [(Any) <Object>]: This indicates any property can be added to this object.
  • [DisplayName <String>]: A name representing the user's locale in natural language, for example, 'English (United States)'.
  • [Locale <String>]: A locale representation for the user, which includes the user's preferred language and country/region. For example, 'en-us'. The language component follows 2-letter codes as defined in ISO 639-1, and the country component follows 2-letter codes as defined in ISO 3166-1 alpha-2.

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