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>]
Description
這個 cmdlet 會Set-EntraUser更新 Microsoft Entra ID 中的使用者。 在 Microsoft Entra ID 中指定UserId更新使用者的參數。
Update-EntraUser 是 Set-EntraUser 的別名。
範例
範例 1:更新使用者
Connect-Entra -Scopes 'User.ReadWrite.All'
Set-EntraUser -UserId 'SawyerM@contoso.com' -DisplayName 'Updated user Name'
此範例更新指定使用者的顯示名稱參數。
-
-UserId 指定 ID 為使用者主體名稱(UPN)或使用者 ID。
範例 2:設定指定使用者的 AccountEnabled 參數
Connect-Entra -Scopes 'User.ReadWrite.All'
Set-EntraUser -UserId 'SawyerM@contoso.com' -AccountEnabled $true
此範例更新指定使用者的 AccountEnabled 參數。
-
-UserId 指定 ID 為使用者主體名稱(UPN)或使用者 ID。
-
-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)或使用者 ID。
-
-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)或使用者 ID。
-
-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)或使用者 ID。
-
-PasswordProfile 指定使用者的密碼設定檔。
範例 6:設定使用者的使用地點以分配授權
Connect-Entra -Scopes 'User.ReadWrite.All'
Set-EntraUser -UserId 'SawyerM@contoso.com' -UsageLocation 'US'
此範例更新指定使用者的使用位置以管理授權。
-
-UserId 指定 ID 為使用者主體名稱(UPN)或使用者 ID。
-
-UsageLocation 指定使用者的使用地點。 ISO 3166 國家代碼為兩字母。 授權使用者必須檢查服務可用性。 例子:美國、日本、英國。 不可為空。
範例 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)或使用者 ID。
範例 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)或使用者 ID。
範例 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)或使用者 ID。
參數
-AccountEnabled
顯示帳號是否已啟用。
參數屬性
| 類型: | System.Boolean
|
| 預設值: | None |
| 支援萬用字元: | False |
| 不要顯示: | False |
參數集
(All)
| Position: | Named |
| 必要: | False |
| 來自管線的值: | False |
| 來自管線按屬性名稱的值: | False |
| 來自剩餘引數的值: | False |
-AgeGroup
企業應用程式用來判定使用者的法定年齡群組。 此屬性為唯讀,根據年齡群組及同意(提供)計算。 允許的值:空值、次要值、非成人和成人。 看, 合法年齡組。
參數屬性
| 類型: | 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」。
建立工作或學校帳號時,不要指定屬性或設為空。
參數屬性
| 類型: | 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)。 使用者因法律規定需核查國家及地區服務可用性而必須使用授權。 例如:「美國」、「JP」和「GB」。不可取消。
參數屬性
| 類型: | System.String
|
| 預設值: | None |
| 支援萬用字元: | False |
| 不要顯示: | False |
參數集
(All)
| Position: | Named |
| 必要: | False |
| 來自管線的值: | False |
| 來自管線按屬性名稱的值: | False |
| 來自剩餘引數的值: | False |
-UserId
指定使用者的 ID(以 User Principal Name 或 UserID 形式)在 Microsoft Entra 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
一個字串值,可以用來分類目錄中的使用者類型,例如「成員」和「訪客」。
參數屬性
| 類型: | 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 的別名。