Set-​Azure​AD​User

Updates a user.

Syntax

Set-AzureADUser
   [-AccountEnabled <Boolean>]
   [-City <String>]
   [-Country <String>]
   [-CreationType <String>]
   [-Department <String>]
   [-DisplayName <String>]
   [-ExtensionProperty <System.Collections.Generic.Dictionary`2[System.String,System.String]>]
   [-GivenName <String>]
   [-ImmutableId <String>]
   [-IsCompromised <Boolean>]
   [-JobTitle <String>]
   [-MailNickName <String>]
   [-Mobile <String>]
   -ObjectId <String>
   [-OtherMails <System.Collections.Generic.List`1[System.String]>]
   [-PasswordPolicies <String>]
   [-PasswordProfile <PasswordProfile>]
   [-PhysicalDeliveryOfficeName <String>]
   [-PostalCode <String>]
   [-PreferredLanguage <String>]
   [-ShowInAddressList <Boolean>]
   [-SignInNames <System.Collections.Generic.List`1[Microsoft.Open.AzureAD.Model.SignInName]>]
   [-State <String>]
   [-StreetAddress <String>]
   [-Surname <String>]
   [-TelephoneNumber <String>]
   [-UsageLocation <String>]
   [-UserPrincipalName <String>]
   [-UserType <String>]
   [-FacsimileTelephoneNumber <String>]
   [<CommonParameters>]

Description

The Set-AzureADUser cmdlet updates a user in Azure Active Directory (AD).

Examples

Example 1: Update a user

PS C:\> $user = Get-AzureADUser -ObjectId TestUser@example.com 
PS C:\> $user.DisplayName = 'YetAnotherTestUser' 
PS C:\> Set-AzureADUser -ObjectId TestUser@example.com -Displayname $user.Displayname

This command updates the specified user's property.

Required Parameters

-ObjectId

Specifies the ID of a user (as a UPN or ObjectId) in Azure AD.

Type:String
Position:Named
Default value:None
Accept pipeline input:True (ByPropertyName, ByValue)
Accept wildcard characters:False

Optional Parameters

-AccountEnabled

Indicates whether the account is enabled.

Type:Boolean
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:False
-City

Specifies the user's city.

Type:String
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:False
-Country

Specifies the user's country.

Type:String
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:False
-CreationType

Indicates whether the user account is a local account for an Azure Active Directory B2C tenant. Possible values are "LocalAccount" and null. When creating a local account, the property is required and you must set it to "LocalAccount". When creating a work or school account, do not specify the property or set it to null.

Type:String
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:False
-Department

Specifies the user's department.

Type:String
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:False
-DisplayName

Specifies the user's display name.

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

The Facsimile TelephoneNumber of the user

Type:String
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:False
-GivenName

Specifies the user's given name.

Type:String
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:False
-ImmutableId
Type:String
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:False
-IsCompromised

True if this user is compromised

Type:Boolean
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:False
-JobTitle

Specifies the user's job title.

Type:String
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:False
-MailNickName

Specifies a nickname for the user's mail address.

Type:String
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:False
-Mobile

Specifies the user's mobile phone number.

Type:String
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:False
-OtherMails

Specifies other email addresses for the user.

Type:System.Collections.Generic.List`1[System.String]
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:False
-PasswordPolicies

Specifies password policies for the user.

Type:String
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:False
-PasswordProfile

Specifies the user's password profile.

Type:PasswordProfile
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:False
-PhysicalDeliveryOfficeName

@{Text=}

Type:String
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:False
-PostalCode

Specifies the user's postal code.

Type:String
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:False
-PreferredLanguage

Specifies the user's preferred language.

Type:String
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:False
-ShowInAddressList

Set to True to show this user in the address list.

Type:Boolean
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:False
-SignInNames

The list of sign in names for this user

Type:System.Collections.Generic.List`1[Microsoft.Open.AzureAD.Model.SignInName]
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:False
-State

Specifies the user's state.

Type:String
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:False
-StreetAddress

Specifies the user's street address.

Type:String
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:False
-Surname

Specifies the user's surname.

Type:String
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:False
-TelephoneNumber

Specifies the user's telephone number.

Type:String
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:False
-UsageLocation
Type:String
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:False
-UserPrincipalName

Specifies the user's user principal name.

Type:String
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:False
-UserType
Type:String
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:False