New-EntraUser
建立一個 Microsoft Entra ID 使用者。
語法
Default (預設值)
New-EntraUser
-DisplayName <String>
-AccountEnabled <Boolean>
-PasswordProfile <PasswordProfile>
[-City <String>]
[-UserStateChangedOn <String>]
[-CompanyName <String>]
[-PreferredLanguage <String>]
[-FaxNumber <String>]
[-GivenName <String>]
[-Mobile <String>]
[-UsageLocation <String>]
[-PostalCode <String>]
[-AgeGroup <String>]
[-CreationType <String>]
[-ConsentProvidedForMinor <String>]
[-MailNickName <String>]
[-ImmutableId <String>]
[-Country <String>]
[-SignInNames <System.Collections.Generic.List`1[Microsoft.Open.AzureAD.Model.SignInName]>]
[-Department <String>]
[-PasswordPolicies <String>]
[-JobTitle <String>]
[-UserState <String>]
[-UserType <String>]
[-OtherMails <System.Collections.Generic.List`1[System.String]>]
[-UserPrincipalName <String>]
[-State <String>]
[-StreetAddress <String>]
[-BusinessPhones <String>]
[-Surname <String>]
[-ShowInAddressList <Boolean>]
[<CommonParameters>]
Description
該 cmdlet 在 New-EntraUser Microsoft Entra ID 中建立一個使用者。 指定 DisplayName、AccountEnabled 和 PasswordProfile 參數來建立使用者。
範例
範例 1:使用 MailNickName 參數建立使用者
Connect-Entra -Scopes 'User.ReadWrite.All'
$passwordProfile = New-Object -TypeName Microsoft.Open.AzureAD.Model.PasswordProfile
$passwordProfile.Password = '<Password>'
$userParams = @{
DisplayName = 'Avery Iona'
PasswordProfile = $passwordProfile
UserPrincipalName = 'AveryI@contoso.com'
AccountEnabled = $true
MailNickName = 'averyi'
}
New-EntraUser @userParams
ObjectId DisplayName UserPrincipalName UserType
-------- ----------- ----------------- --------
aaaaaaaa-0000-1111-2222-bbbbbbbbbbbb Avery Iona AveryI@contoso.com Member
此指令會建立一個新使用者。
範例 2:使用 AgeGroup 參數建立使用者
Connect-Entra -Scopes 'User.ReadWrite.All'
$passwordProfile = New-Object -TypeName Microsoft.Open.AzureAD.Model.PasswordProfile
$passwordProfile.Password = '<Password>'
$userParams = @{
DisplayName = 'Peyton Davis'
PasswordProfile = $passwordProfile
UserPrincipalName = 'PeytonD@contoso.com'
AccountEnabled = $true
MailNickName = 'PeytonD'
AgeGroup = 'adult'
}
New-EntraUser @userParams
ObjectId DisplayName UserPrincipalName UserType
-------- ----------- ----------------- --------
bbbbbbbb-1111-2222-3333-cccccccccccc Peyton Davis PeytonD@contoso.com Member
此指令會建立一個新使用者。
範例 3:使用 City 參數建立使用者
Connect-Entra -Scopes 'User.ReadWrite.All'
$passwordProfile = New-Object -TypeName Microsoft.Open.AzureAD.Model.PasswordProfile
$passwordProfile.Password = '<Password>'
$userParams = @{
DisplayName = 'Blake Martin'
PasswordProfile = $passwordProfile
UserPrincipalName = 'BlakeM@contoso.com'
AccountEnabled = $true
MailNickName = 'BlakeM'
City = 'New York'
}
New-EntraUser @userParams
ObjectId DisplayName UserPrincipalName UserType
-------- ----------- ----------------- --------
cccccccc-2222-3333-4444-dddddddddddd Blake Martin BlakeM@contoso.com Member
此指令會建立一個新使用者。
範例 4:使用 Department 參數建立使用者
Connect-Entra -Scopes 'User.ReadWrite.All'
$passwordProfile = New-Object -TypeName Microsoft.Open.AzureAD.Model.PasswordProfile
$passwordProfile.Password = '<Password>'
$userParams = @{
DisplayName = 'Parker Jones'
PasswordProfile = $passwordProfile
UserPrincipalName = 'ParkerJ@contoso.com'
AccountEnabled = $true
MailNickName = 'ParkerJ'
Department = 'IT'
}
New-EntraUser @userParams
ObjectId DisplayName UserPrincipalName UserType
-------- ----------- ----------------- --------
dddddddd-3333-4444-5555-eeeeeeeeeeee Parker Jones ParkerJ@contoso.com Member
此指令會建立一個新使用者。
範例 5:使用 Mobile 參數建立使用者
Connect-Entra -Scopes 'User.ReadWrite.All'
$passwordProfile = New-Object -TypeName Microsoft.Open.AzureAD.Model.PasswordProfile
$passwordProfile.Password = '<Password>'
$UserParams = @{
DisplayName = 'Sawyer Miller'
PasswordProfile = $passwordProfile
UserPrincipalName = 'SawyerM@contoso.com'
AccountEnabled = $true
MailNickName = 'SawyerM'
Mobile = '+18989898989'
}
New-EntraUser @UserParams
ObjectId DisplayName UserPrincipalName UserType
-------- ----------- ----------------- --------
eeeeeeee-4444-5555-6666-ffffffffffff Sawyer Miller SawyerM@contoso.com Member
此指令會建立一個新使用者。
參數
-AccountEnabled
顯示使用者帳號是否已啟用。
參數屬性
| 類型: | System.Boolean
|
| 預設值: | None |
| 支援萬用字元: | False |
| 不要顯示: | False |
參數集
(All)
| Position: | Named |
| 必要: | True |
| 來自管線的值: | False |
| 來自管線按屬性名稱的值: | False |
| 來自剩餘引數的值: | False |
-AgeGroup
指定使用者的年齡組別。
參數屬性
| 類型: | System.String
|
| 預設值: | None |
| 支援萬用字元: | False |
| 不要顯示: | False |
參數集
(All)
| Position: | Named |
| 必要: | False |
| 來自管線的值: | False |
| 來自管線按屬性名稱的值: | False |
| 來自剩餘引數的值: | False |
-BusinessPhones
指定電話號碼。
參數屬性
| 類型: | 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
指定使用者的公司名稱。
參數屬性
| 類型: | System.String
|
| 預設值: | None |
| 支援萬用字元: | False |
| 不要顯示: | False |
參數集
(All)
| Position: | Named |
| 必要: | False |
| 來自管線的值: | False |
| 來自管線按屬性名稱的值: | False |
| 來自剩餘引數的值: | False |
規定未成年人是否獲得同意。
| 類型: | 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 |
| 必要: | True |
| 來自管線的值: | False |
| 來自管線按屬性名稱的值: | False |
| 來自剩餘引數的值: | False |
-FaxNumber
指定使用者的傳真號碼。
參數屬性
| 類型: | 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
此屬性將本地使用者帳號連結至其 Microsoft Entra ID 物件,若使用者的 userPrincipalName (UPN) 位於聯邦網域,則在 Microsoft 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
使用者的其他電子郵件地址清單;例如:「bob@contoso.com, 「Robert@fabrikam.com」。
參數屬性
| 類型: | System.Collections.Generic.List`1[System.String]
|
| 預設值: | None |
| 支援萬用字元: | False |
| 不要顯示: | False |
參數集
(All)
| Position: | Named |
| 必要: | False |
| 來自管線的值: | False |
| 來自管線按屬性名稱的值: | False |
| 來自剩餘引數的值: | False |
-PasswordPolicies
為使用者指定密碼政策。
這個值是一個枚舉,其中一個可能的值是「DisableStrongPassword」,允許指定比預設政策更弱的密碼。
也可以指定「DisablePasswordExpiration」。
兩者可以一起指定;例如:「DisablePasswordExpiration, DisableStrongPassword」。
參數屬性
| 類型: | System.String
|
| 預設值: | None |
| 支援萬用字元: | False |
| 不要顯示: | False |
參數集
(All)
| Position: | Named |
| 必要: | False |
| 來自管線的值: | False |
| 來自管線按屬性名稱的值: | False |
| 來自剩餘引數的值: | False |
-PasswordProfile
指定使用者的密碼設定檔。
此參數的參數類型為「PasswordProfile」。
要傳遞此類型的參數,首先需在 PowerShell 中建立一個該型態的變數:
$passwordProfile = New-Object -TypeName Microsoft。Open.AzureAD.Model.PasswordProfile
接著你可以在這個變數中設定密碼的值:
$passwordProfile.Password = 「<密碼>」
最後你可以把這個變數傳給 cmdlet:
New-EntraUser -PasswordProfile $passwordProfile......
密碼設定檔中還可設定的其他屬性包括
參數屬性
| 類型: | PasswordProfile
|
| 預設值: | None |
| 支援萬用字元: | False |
| 不要顯示: | False |
參數集
(All)
| Position: | Named |
| 必要: | True |
| 來自管線的值: | 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
如果為真,請在地址列表中顯示此使用者。
參數屬性
| 類型: | System.Boolean
|
| 預設值: | None |
| 支援萬用字元: | False |
| 不要顯示: | False |
參數集
(All)
| Position: | Named |
| 必要: | False |
| 來自管線的值: | False |
| 來自管線按屬性名稱的值: | False |
| 來自剩餘引數的值: | False |
-SignInNames
指定 Microsoft Entra ID B2C 租戶中本地帳號的登入名稱集合。
每個登入名稱必須在公司/租戶間獨一無二。
在建立本地帳號使用者時必須指定該屬性;建立工作或學校帳號時不要特別說明。
參數屬性
| 類型: | 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 |
-UsageLocation
兩個字母的國家代碼(ISO 標準 3166)。
對於因法律要求而被指派授權以檢查各國服務可用性的使用者,必須使用此項。
例如:「美國」、「JP」和「GB」。
參數屬性
| 類型: | System.String
|
| 預設值: | None |
| 支援萬用字元: | False |
| 不要顯示: | False |
參數集
(All)
| Position: | Named |
| 必要: | False |
| 來自管線的值: | False |
| 來自管線按屬性名稱的值: | False |
| 來自剩餘引數的值: | False |
-UserPrincipalName
使用者主名稱 (UPN)。
UPN 是一種基於網際網路標準 RFC 822 的使用者登入名稱。
依照慣例,這個 UPN 應該對應到使用者的電子郵件名稱。
整體格式為「alias@domain」。
對於工作或學校帳號,該網域必須存在於租戶已驗證的網域集合中。
此屬性在建立工作或學校帳戶時是必需的;對本地帳戶來說是可選的。
參數屬性
| 類型: | System.String
|
| 預設值: | None |
| 支援萬用字元: | False |
| 不要顯示: | False |
參數集
(All)
| Position: | Named |
| 必要: | False |
| 來自管線的值: | False |
| 來自管線按屬性名稱的值: | False |
| 來自剩餘引數的值: | False |
-UserState
對於使用邀請 API 邀請至租用戶的外部使用者,此屬性代表受邀使用者的邀請狀態。
參數屬性
| 類型: | System.String
|
| 預設值: | None |
| 支援萬用字元: | False |
| 不要顯示: | False |
參數集
(All)
| Position: | Named |
| 必要: | False |
| 來自管線的值: | False |
| 來自管線按屬性名稱的值: | False |
| 來自剩餘引數的值: | False |
-UserStateChangedOn
顯示 userState 屬性最新變更的時間戳記。
參數屬性
| 類型: | 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。