Share via


Update-MgBetaUserProfilePhone

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

Syntax

UpdateExpanded (Default)

Update-MgBetaUserProfilePhone
    -ItemPhoneId <String>
    -UserId <String>
    [-ResponseHeadersVariable <String>]
    [-AdditionalProperties <Hashtable>]
    [-AllowedAudiences <String>]
    [-CreatedBy <IMicrosoftGraphIdentitySet>]
    [-CreatedDateTime <DateTime>]
    [-DisplayName <String>]
    [-Id <String>]
    [-Inference <IMicrosoftGraphInferenceData>]
    [-IsSearchable]
    [-LastModifiedBy <IMicrosoftGraphIdentitySet>]
    [-LastModifiedDateTime <DateTime>]
    [-Number <String>]
    [-Source <IMicrosoftGraphPersonDataSources>]
    [-Sources <IMicrosoftGraphProfileSourceAnnotation[]>]
    [-Type <String>]
    [-Headers <IDictionary>]
    [-WhatIf]
    [-Confirm]
    [<CommonParameters>]

Update

Update-MgBetaUserProfilePhone
    -ItemPhoneId <String>
    -UserId <String>
    -BodyParameter <IMicrosoftGraphItemPhone>
    [-ResponseHeadersVariable <String>]
    [-Headers <IDictionary>]
    [-WhatIf]
    [-Confirm]
    [<CommonParameters>]

UpdateViaIdentityExpanded

Update-MgBetaUserProfilePhone
    -InputObject <IPeopleIdentity>
    [-ResponseHeadersVariable <String>]
    [-AdditionalProperties <Hashtable>]
    [-AllowedAudiences <String>]
    [-CreatedBy <IMicrosoftGraphIdentitySet>]
    [-CreatedDateTime <DateTime>]
    [-DisplayName <String>]
    [-Id <String>]
    [-Inference <IMicrosoftGraphInferenceData>]
    [-IsSearchable]
    [-LastModifiedBy <IMicrosoftGraphIdentitySet>]
    [-LastModifiedDateTime <DateTime>]
    [-Number <String>]
    [-Source <IMicrosoftGraphPersonDataSources>]
    [-Sources <IMicrosoftGraphProfileSourceAnnotation[]>]
    [-Type <String>]
    [-Headers <IDictionary>]
    [-WhatIf]
    [-Confirm]
    [<CommonParameters>]

UpdateViaIdentity

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

Description

Update the properties of an itemPhone 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 = @{
	type = "other"
}

Update-MgBetaUserProfilePhone -UserId $userId -ItemPhoneId $itemPhoneId -BodyParameter $params

This example shows how to use the Update-MgBetaUserProfilePhone 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

-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

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

Parameter properties

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

-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

-DisplayName

Friendly name the user has assigned this phone number.

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

-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 properties of an itemPhone 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,

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

-ItemPhoneId

The unique identifier of itemPhone

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

-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

-Number

Phone number provided by the user.

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

-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

-Type

phoneType

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

-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

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

Microsoft.Graph.Beta.PowerShell.Models.IPeopleIdentity

System.Collections.IDictionary

Outputs

Microsoft.Graph.Beta.PowerShell.Models.IMicrosoftGraphItemPhone

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 <IMicrosoftGraphItemPhone>: itemPhone

  • [(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.
  • [DisplayName <String>]: Friendly name the user has assigned this phone number.
  • [Number <String>]: Phone number provided by the user.
  • [Type <String>]: phoneType

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