Set-EntraUserExtension

Reference

Module:: Microsoft.Entra

Updates a user's extension.

Syntax

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

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 '[email protected]' -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 '[email protected]' -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.

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

-ExtensionNameValues

Specifies extension name values.

Type:	System.Collections.Generic.Dictionary`2[System.String,System.String]
Position:	Named
Default value:	None
Required:	True
Accept pipeline input:	True
Accept wildcard characters:	False

-ExtensionValue

Specifies an extension value.

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

-UserId

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

Type:	System.String
Aliases:	ObjectId, UPN, Identity, UserPrincipalName
Position:	Named
Default value:	None
Required:	True
Accept pipeline input:	True
Accept wildcard characters:	False

Notes