Set-EntraUser
语法
Default (默认值)
Set-EntraUser
-UserId <String>
[-PostalCode <String>]
[-CompanyName <String>]
[-GivenName <String>]
[-Mobile <String>]
[-PreferredLanguage <String>]
[-CreationType <String>]
[-UsageLocation <String>]
[-UserType <String>]
[-AgeGroup <String>]
[-MailNickName <String>]
[-ExtensionProperty <System.Collections.Generic.Dictionary`2[System.String,System.String]>]
[-ConsentProvidedForMinor <String>]
[-ImmutableId <String>]
[-Country <String>]
[-SignInNames <System.Collections.Generic.List`1[Microsoft.Open.AzureAD.Model.SignInName]>]
[-Department <String>]
[-StreetAddress <String>]
[-PasswordPolicies <String>]
[-JobTitle <String>]
[-City <String>]
[-OtherMails <System.Collections.Generic.List`1[System.String]>]
[-UserPrincipalName <String>]
[-DisplayName <String>]
[-AccountEnabled <Boolean>]
[-PasswordProfile <PasswordProfile>]
[-State <String>]
[-TelephoneNumber <String>]
[-Surname <String>]
[-ShowInAddressList <Boolean>]
[<CommonParameters>]
说明
该 cmdlet 更新Set-EntraUserMicrosoft Entra ID中的用户。 指定要UserId在Microsoft Entra ID中更新用户的参数。
Update-EntraUser 是 Set-EntraUser 的别名。
示例
示例 1:更新用户
Connect-Entra -Scopes 'User.ReadWrite.All'
Set-EntraUser -UserId 'SawyerM@contoso.com' -DisplayName 'Updated user Name'
此示例更新指定的用户的显示名称参数。
-
-UserId 将 ID 指定为用户主体名称(UPN)或 UserId。
示例 2:设置指定的用户的 AccountEnabled 参数
Connect-Entra -Scopes 'User.ReadWrite.All'
Set-EntraUser -UserId 'SawyerM@contoso.com' -AccountEnabled $true
此示例更新指定的用户的 AccountEnabled 参数。
-
-UserId 将 ID 指定为用户主体名称(UPN)或 UserId。
-
-AccountEnabled 指定是否启用帐户。
示例 3:将所有用户设置为具有家长同意的未成年人
Connect-Entra -Scopes 'User.ReadWrite.All'
Get-EntraUser -All | Where-Object -Property DisplayName -Match '(George|James|Education)' |
ForEach-Object { Set-EntraUser -UserId $($_.Id) -AgeGroup 'minor' -ConsentProvidedForMinor 'granted' }
此示例使用家长同意将指定用户的指定用户更新为未成年人。
-
-UserId 将 ID 指定为用户主体名称(UPN)或 UserId。
-
-ConsentProvidedForMinor 设置是否必须获得未成年人的许可。 允许的值:null、granted、denied 和 notRequired。
示例 4:设置指定的用户属性
Connect-Entra -Scopes 'User.ReadWrite.All'
$params = @{
UserId = 'SawyerM@contoso.com'
City = 'Add city name'
CompanyName = 'Microsoft'
Country = 'Add country name'
Department = 'Add department name'
GivenName = 'Sawyer Miller G'
JobTitle = 'Manager'
MailNickName = 'Add mailnickname'
Mobile = '9984534564'
OtherMails = 'johndoe@contosodev.com'
PasswordPolicies = 'DisableStrongPassword'
State = 'UP'
StreetAddress = 'Add address'
UserType = 'Member'
}
Set-EntraUser @params
此示例更新指定的用户属性。
-
-UserId 将 ID 指定为用户主体名称(UPN)或 UserId。
-
-UserType 对目录中的用户类型进行分类,例如“成员”和“来宾”。
-
-PasswordPolicies 指定用户的密码策略。
-
-OtherMails 指定用户的其他电子邮件地址
示例 5:设置指定的用户的 PasswordProfile 参数
Connect-Entra -Scopes 'User.ReadWrite.All'
Set-EntraUser -UserId 'SawyerM@contoso.com' -PasswordProfile @{
Password = '*****'
ForceChangePasswordNextSignIn = $true
}
此示例更新指定的用户的 PasswordProfile 参数。
-
-UserId 将 ID 指定为用户主体名称(UPN)或 UserId。
-
-PasswordProfile 指定用户的密码配置文件。
示例 6:为许可证分配设置用户的使用位置
Connect-Entra -Scopes 'User.ReadWrite.All'
Set-EntraUser -UserId 'SawyerM@contoso.com' -UsageLocation 'US'
此示例更新指定用户的许可证管理使用位置。
-
-UserId 将 ID 指定为用户主体名称(UPN)或 UserId。
-
-UsageLocation 指定用户的使用位置。 双字母 ISO 3166 国家/地区代码。 授权用户需要检查服务可用性。 示例:US、JP、GB。 不可为 null。
示例 7:更新用户的密码策略
Connect-Entra -Scopes 'User.ReadWrite.All'
Get-EntraUser -UserId 'SawyerM@contoso.com' | Set-EntraUser -PasswordPolicies DisablePasswordExpiration
此示例更新指定的用户密码策略。
密码策略的可能值包括:
-
DisableStrongPassword:允许比默认策略弱的密码。
-
DisablePasswordExpiration:防止密码过期。
可以同时指定这两个值,例如: DisablePasswordExpiration 和 DisableStrongPassword。 例如,Set-EntraUser -UserId 'SawyerM@contoso.com' -PasswordPolicies "DisablePasswordExpiration,DisableStrongPassword"。
示例 8:设置用户的扩展属性
Connect-Entra -Scopes 'User.ReadWrite.All'
$application = Get-EntraApplication -Filter "DisplayName eq 'Helpdesk Application'"
$extensionName = (Get-EntraApplicationExtensionProperty -ApplicationId $application.Id).Name | Select-Object -First 1
$additionalProperties = @{ $extensionName = "Survey.Report" }
Set-EntraUser -UserId 'SawyerM@contoso.com' -AdditionalProperties $additionalProperties
此示例更新指定的用户的扩展属性,例如应用程序的应用角色。
-
-UserId 将 ID 指定为用户主体名称(UPN)或 UserId。
示例 9:更新用户的 onPremisesExtension 属性属性
Connect-Entra -Scopes 'User.ReadWrite.All'
Set-EntraUser -UserId 'SawyerM@contoso.com' -AdditionalProperties @{
onPremisesExtensionAttributes = @{
extensionAttribute1 = "Job Group D"
extensionAttribute2 = "Audit Role"
}
}
此示例更新指定的用户的 onPremisesExtensionAttributes 属性。
-
-UserId 将 ID 指定为用户主体名称(UPN)或 UserId。
示例 10:更新用户的手机详细信息
Connect-Entra -Scopes 'User.ReadWrite.All'
Set-EntraUser -UserId 'SawyerM@contoso.com' -BusinessPhones '+1 425 555 0109' -OfficeLocation '18/2111'
此示例更新指定的用户的 onPremisesExtensionAttributes 属性。
-
-UserId 将 ID 指定为用户主体名称(UPN)或 UserId。
参数
-AccountEnabled
指示是否启用帐户。
参数属性
| 类型: | System.Boolean
|
| 默认值: | None |
| 支持通配符: | False |
| 不显示: | False |
参数集
(All)
| Position: | Named |
| 必需: | False |
| 来自管道的值: | False |
| 来自管道的值(按属性名称): | False |
| 来自剩余参数的值: | False |
-AgeGroup
由企业应用程序用于确定用户的法定年龄组。 此属性为只读,并且基于 ageGroup 和 consentProvidedForMinor 属性进行计算。 允许的值:null、minor、notAdult 和成人。 请参阅 法定年龄组。
参数属性
| 类型: | System.String
|
| 默认值: | None |
| 支持通配符: | False |
| 不显示: | False |
参数集
(All)
| Position: | Named |
| 必需: | False |
| 来自管道的值: | False |
| 来自管道的值(按属性名称): | False |
| 来自剩余参数的值: | False |
-City
指定用户的城市。
参数属性
| 类型: | System.String
|
| 默认值: | None |
| 支持通配符: | False |
| 不显示: | False |
参数集
(All)
| Position: | Named |
| 必需: | False |
| 来自管道的值: | False |
| 来自管道的值(按属性名称): | False |
| 来自剩余参数的值: | False |
-CompanyName
用户关联的公司名称。 此属性可用于描述外部用户所属的公司。 公司名称的最大长度为 64 个字符。
参数属性
| 类型: | System.String
|
| 默认值: | None |
| 支持通配符: | False |
| 不显示: | False |
参数集
(All)
| Position: | Named |
| 必需: | False |
| 来自管道的值: | False |
| 来自管道的值(按属性名称): | False |
| 来自剩余参数的值: | False |
设置是否必须获得未成年人的许可。 允许的值:null、granted、denied 和 notRequired。
| 类型: | System.String
|
| 默认值: | None |
| 支持通配符: | False |
| 不显示: | False |
(All)
| Position: | Named |
| 必需: | False |
| 来自管道的值: | False |
| 来自管道的值(按属性名称): | False |
| 来自剩余参数的值: | False |
-Country
指定用户的国家/地区。
参数属性
| 类型: | System.String
|
| 默认值: | None |
| 支持通配符: | False |
| 不显示: | False |
参数集
(All)
| Position: | Named |
| 必需: | False |
| 来自管道的值: | False |
| 来自管道的值(按属性名称): | False |
| 来自剩余参数的值: | False |
-CreationType
指示用户帐户是否为 Microsoft Entra ID B2C 租户的本地帐户。
可能的值为“LocalAccount”和 null。
创建本地帐户时,该属性是必需的,并且必须将其设置为“LocalAccount”。
创建工作或学校帐户时,请勿指定属性或将其设置为 null。
参数属性
| 类型: | System.String
|
| 默认值: | None |
| 支持通配符: | False |
| 不显示: | False |
参数集
(All)
| Position: | Named |
| 必需: | False |
| 来自管道的值: | False |
| 来自管道的值(按属性名称): | False |
| 来自剩余参数的值: | False |
-Department
指定用户的部门。
参数属性
| 类型: | System.String
|
| 默认值: | None |
| 支持通配符: | False |
| 不显示: | False |
参数集
(All)
| Position: | Named |
| 必需: | False |
| 来自管道的值: | False |
| 来自管道的值(按属性名称): | False |
| 来自剩余参数的值: | False |
-DisplayName
指定用户的显示名称。
参数属性
| 类型: | System.String
|
| 默认值: | None |
| 支持通配符: | False |
| 不显示: | False |
参数集
(All)
| Position: | Named |
| 必需: | False |
| 来自管道的值: | False |
| 来自管道的值(按属性名称): | False |
| 来自剩余参数的值: | False |
-ExtensionProperty
将数据作为基本开放扩展或更通用的架构扩展添加到自定义用户属性。
参数属性
| 类型: | System.Collections.Generic.Dictionary`2[System.String,System.String]
|
| 默认值: | None |
| 支持通配符: | False |
| 不显示: | False |
参数集
(All)
| Position: | Named |
| 必需: | False |
| 来自管道的值: | False |
| 来自管道的值(按属性名称): | False |
| 来自剩余参数的值: | False |
-GivenName
指定用户的给定名称。
参数属性
| 类型: | System.String
|
| 默认值: | None |
| 支持通配符: | False |
| 不显示: | False |
参数集
(All)
| Position: | Named |
| 必需: | False |
| 来自管道的值: | False |
| 来自管道的值(按属性名称): | False |
| 来自剩余参数的值: | False |
-ImmutableId
此属性将本地 Active Directory用户帐户链接到其Microsoft Entra ID用户对象。 如果用户的 userPrincipalName 使用联合域,则必须在 Graph 中创建新用户帐户时指定此属性。
重要说明:指定此属性时不要使用 $ 和 _ 字符。
参数属性
| 类型: | System.String
|
| 默认值: | None |
| 支持通配符: | False |
| 不显示: | False |
参数集
(All)
| Position: | Named |
| 必需: | False |
| 来自管道的值: | False |
| 来自管道的值(按属性名称): | False |
| 来自剩余参数的值: | False |
-JobTitle
指定用户的职务。
参数属性
| 类型: | System.String
|
| 默认值: | None |
| 支持通配符: | False |
| 不显示: | False |
参数集
(All)
| Position: | Named |
| 必需: | False |
| 来自管道的值: | False |
| 来自管道的值(按属性名称): | False |
| 来自剩余参数的值: | False |
-MailNickName
为用户的邮件地址指定一个昵称。
参数属性
| 类型: | System.String
|
| 默认值: | None |
| 支持通配符: | False |
| 不显示: | False |
参数集
(All)
| Position: | Named |
| 必需: | False |
| 来自管道的值: | False |
| 来自管道的值(按属性名称): | False |
| 来自剩余参数的值: | False |
-Mobile
指定用户的移动电话号码。
参数属性
| 类型: | System.String
|
| 默认值: | None |
| 支持通配符: | False |
| 不显示: | False |
参数集
(All)
| Position: | Named |
| 必需: | False |
| 来自管道的值: | False |
| 来自管道的值(按属性名称): | False |
| 来自剩余参数的值: | False |
-OtherMails
指定用户的其他电子邮件地址。
参数属性
| 类型: | System.Collections.Generic.List`1[System.String]
|
| 默认值: | None |
| 支持通配符: | False |
| 不显示: | False |
参数集
(All)
| Position: | Named |
| 必需: | False |
| 来自管道的值: | False |
| 来自管道的值(按属性名称): | False |
| 来自剩余参数的值: | False |
-PasswordPolicies
指定用户的密码策略。
参数属性
| 类型: | System.String
|
| 默认值: | None |
| 支持通配符: | False |
| 不显示: | False |
参数集
(All)
| Position: | Named |
| 必需: | False |
| 来自管道的值: | False |
| 来自管道的值(按属性名称): | False |
| 来自剩余参数的值: | False |
-PasswordProfile
指定用户的密码配置文件。
参数属性
| 类型: | PasswordProfile
|
| 默认值: | None |
| 支持通配符: | False |
| 不显示: | False |
参数集
(All)
| Position: | Named |
| 必需: | False |
| 来自管道的值: | False |
| 来自管道的值(按属性名称): | False |
| 来自剩余参数的值: | False |
-PostalCode
指定用户的邮政编码。
参数属性
| 类型: | System.String
|
| 默认值: | None |
| 支持通配符: | False |
| 不显示: | False |
参数集
(All)
| Position: | Named |
| 必需: | False |
| 来自管道的值: | False |
| 来自管道的值(按属性名称): | False |
| 来自剩余参数的值: | False |
-PreferredLanguage
指定用户的首选语言。
参数属性
| 类型: | System.String
|
| 默认值: | None |
| 支持通配符: | False |
| 不显示: | False |
参数集
(All)
| Position: | Named |
| 必需: | False |
| 来自管道的值: | False |
| 来自管道的值(按属性名称): | False |
| 来自剩余参数的值: | False |
-ShowInAddressList
设置为 True 以在地址列表中显示此用户。
参数属性
| 类型: | System.Boolean
|
| 默认值: | None |
| 支持通配符: | False |
| 不显示: | False |
参数集
(All)
| Position: | Named |
| 必需: | False |
| 来自管道的值: | False |
| 来自管道的值(按属性名称): | False |
| 来自剩余参数的值: | False |
-SignInNames
此用户的登录名称列表
参数属性
| 类型: | System.Collections.Generic.List`1[Microsoft.Open.AzureAD.Model.SignInName]
|
| 默认值: | None |
| 支持通配符: | False |
| 不显示: | False |
参数集
(All)
| Position: | Named |
| 必需: | False |
| 来自管道的值: | False |
| 来自管道的值(按属性名称): | False |
| 来自剩余参数的值: | False |
-State
指定用户的状态。
参数属性
| 类型: | System.String
|
| 默认值: | None |
| 支持通配符: | False |
| 不显示: | False |
参数集
(All)
| Position: | Named |
| 必需: | False |
| 来自管道的值: | False |
| 来自管道的值(按属性名称): | False |
| 来自剩余参数的值: | False |
-StreetAddress
指定用户的街道地址。
参数属性
| 类型: | System.String
|
| 默认值: | None |
| 支持通配符: | False |
| 不显示: | False |
参数集
(All)
| Position: | Named |
| 必需: | False |
| 来自管道的值: | False |
| 来自管道的值(按属性名称): | False |
| 来自剩余参数的值: | False |
-Surname
指定用户的姓氏。
参数属性
| 类型: | System.String
|
| 默认值: | None |
| 支持通配符: | False |
| 不显示: | False |
参数集
(All)
| Position: | Named |
| 必需: | False |
| 来自管道的值: | False |
| 来自管道的值(按属性名称): | False |
| 来自剩余参数的值: | False |
-TelephoneNumber
指定用户的电话号码。
参数属性
| 类型: | System.String
|
| 默认值: | None |
| 支持通配符: | False |
| 不显示: | False |
参数集
(All)
| Position: | Named |
| 必需: | False |
| 来自管道的值: | False |
| 来自管道的值(按属性名称): | False |
| 来自剩余参数的值: | False |
-UsageLocation
两个字母国家或地区代码(ISO 标准 3166)。 由于法律要求检查国家或地区服务的可用性,分配许可证的用户是必需的。 示例包括:“US”、“JP”和“GB”。不可为 null。
参数属性
| 类型: | System.String
|
| 默认值: | None |
| 支持通配符: | False |
| 不显示: | False |
参数集
(All)
| Position: | Named |
| 必需: | False |
| 来自管道的值: | False |
| 来自管道的值(按属性名称): | False |
| 来自剩余参数的值: | False |
-UserId
在Microsoft Entra ID中指定用户(作为用户主体名称或 UserId)的 ID。
参数属性
| 类型: | System.String
|
| 默认值: | None |
| 支持通配符: | False |
| 不显示: | False |
| 别名: | 对象标识符 (ObjectId), UPN, Identity, UserPrincipalName |
参数集
(All)
| Position: | Named |
| 必需: | True |
| 来自管道的值: | True |
| 来自管道的值(按属性名称): | True |
| 来自剩余参数的值: | False |
-UserPrincipalName
指定用户的用户主体名称。
参数属性
| 类型: | System.String
|
| 默认值: | None |
| 支持通配符: | False |
| 不显示: | False |
参数集
(All)
| Position: | Named |
| 必需: | False |
| 来自管道的值: | False |
| 来自管道的值(按属性名称): | False |
| 来自剩余参数的值: | False |
-UserType
可用于对目录中的用户类型进行分类的字符串值,例如“Member”和“Guest”。
参数属性
| 类型: | System.String
|
| 默认值: | None |
| 支持通配符: | False |
| 不显示: | False |
参数集
(All)
| Position: | Named |
| 必需: | False |
| 来自管道的值: | False |
| 来自管道的值(按属性名称): | False |
| 来自剩余参数的值: | False |
CommonParameters
此 cmdlet 支持通用参数:-Debug、-ErrorAction、-ErrorVariable、-InformationAction、-InformationVariable、-OutBuffer、-OutVariable、-PipelineVariable、-ProgressAction、-Verbose、-WarningAction 和 -WarningVariable。 有关详细信息,请参阅 about_CommonParameters。
备注
Update-EntraUser 是 Set-EntraUser 的别名。