Edit

Share via

Set-EntraBetaUserExtension

  • Reference
Module:
Microsoft.Entra.Beta

Sets a user extension.

Syntax

Set-EntraBetaUserExtension
   -ExtensionName <String>
   -ObjectId <String>
   -ExtensionValue <String>
   [<CommonParameters>]
Set-EntraBetaUserExtension
   -ObjectId <String>
   -ExtensionNameValues <System.Collections.Generic.Dictionary`2[System.String,System.String]>
   [<CommonParameters>]

Description

The Set-EntraBetaUserExtension cmdlet updates a user extension in Microsoft Entra ID.

Examples

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

Connect-Entra -Scopes 'User.ReadWrite.All'
$extensionName = 'extension_e5e29b8a85d941eab8d12162bd004528_extensionAttribute8'
$extensionValue = 'New Value'
Set-EntraBetaUserExtension -ObjectId 'SawyerM@contoso.com' -ExtensionName $extensionName -ExtensionValue $extensionValue

This example shows how to update the value of the extension attribute for a specified user.

  • -ObjectId parameter specifies the user Id.
  • -ExtensionName parameter specifies the name of an extension.
  • -ExtensionValue parameter specifies the extension name values.

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

-ObjectId

Specifies the ID of an object.

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