编辑

通过

Set-EntraUserExtension

Module:
Microsoft.Entra.Users Module v1.1

Updates a user's extension.

Syntax

SetSingle (Default) 

Set-EntraUserExtension

    -UserId <String>
    -ExtensionName <String>
    -ExtensionValue <String>
    [<CommonParameters>]

SetMultiple 

Set-EntraUserExtension

    -UserId <String>
    -ExtensionNameValues <System.Collections.Generic.Dictionary`2[System.String,System.String]>
    [<CommonParameters>]

Description

The Set-EntraUserExtension cmdlet updates a user's extension in Microsoft Entra ID.

Update-EntraUserExtension is an alias for Set-EntraUserExtension.

Examples

Example 1: Set the value of an extension attribute for a user

Connect-Entra -Scopes 'User.ReadWrite.All'
$extensionName = 'extension_e5e29b8a85d941eab8d12162bd004528_JobGroup'
$extensionValue = 'Job Group D'
Set-EntraUserExtension -UserId 'SawyerM@contoso.com' -ExtensionName $extensionName -ExtensionValue $extensionValue

This example demonstrates how to update a user's extension attribute for a specified user. Use (Get-EntraApplicationExtensionProperty -ApplicationId '{ApplicationId}').Name | Select-Object -First 1 to retrieve the extension name.

  • -UserId parameter specifies the user Id (User Principal Name or UserId).
  • -ExtensionName parameter specifies the name of an extension.
  • -ExtensionValue parameter specifies the extension name values.

Example 2: Update multiple values using ExtensionNameValues parameter

Connect-Entra -Scopes 'User.ReadWrite.All'
$userExtensionValues = New-Object 'System.Collections.Generic.Dictionary[String,String]'
$userExtensionValues.Add("extension_d2ba83696c3f45429fbabb363ae391a0_Benefits", "Pension")
$userExtensionValues.Add("extension_d2ba83696c3f45429fbabb363ae391a0_JobGroup", "D")
Set-EntraUserExtension -UserId 'SawyerM@contoso.com' -ExtensionNameValues $userExtensionValues

This example demonstrates how to update a user's extension attribute. Use (Get-EntraApplicationExtensionProperty -ApplicationId '{ApplicationId}').Name | Select-Object -First 1 to retrieve the extension name.

  • -UserId parameter specifies the user Id (User Principal Name or UserId).
  • -ExtensionNameValues parameter specifies a dictionary of key-value pairs for the extension name and value pair.

Parameters

-ExtensionName

Specifies the name of an extension.

Parameter properties

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

Parameter sets

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

-ExtensionNameValues

Specifies extension name values.

Parameter properties

Type:

System.Collections.Generic.Dictionary`2[System.String,System.String]

Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

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

-ExtensionValue

Specifies an extension value.

Parameter properties

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

Parameter sets

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

-UserId

Specifies the unique identifier for the user (User Principal Name or UserId).

Parameter properties

Type:System.String
Default value:None
Supports wildcards:False
DontShow:False
Aliases:ObjectId, UPN, Identity, UserPrincipalName

Parameter sets

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

Notes

Update-EntraUserExtension is an alias for Set-EntraUserExtension.