Creates a user in Azure Active Directory.
New-AzureDRAUser -Tenant <String> [-Password <String>] -Properties <Hashtable> [-DRARestServer <String>] [-DRARestPort <Int32>] [-IgnoreCertificateErrors <SwitchParameter>] [-Force <SwitchParameter>] [-Timeout <Int32>] [<CommonParameters>]
The New-AzureDRAUser cmdlet creates a user in Azure Active Directory. The requesting user must have the Create Azure User and Modify All Properties power or a custom power with the necessary powers for the requested attributes. Use the Properties parameter to specify the values to use when creating the Azure user.
|
Attribute / Description |
Values |
||||
|---|---|---|---|---|---|
|
Required |
Position |
Default Value |
Accept Pipeline input? |
Accept wildcard characters? |
|
|
Password [<String>] The value of the new password that should be set on the user account. The password must meet the password policies set for the domain. |
false |
named |
|
true (ByPropertyName) |
false |
|
Properties <Hashtable> A hashtable of property values. The key is the name of a defined attribute in the REST interface. For example: -Properties @{Attribute1DRADisplayName="my value"; Attribute2DRADisplayName=value} Multiple values are specified as a comma-separated list.For example: -Properties @{Attribute1DRADisplayName=value1, value2} If the property name contains non-alphanumeric characters it needs to be quoted.For example: -Properties @{"Attribute1-DRA-DisplayName"=value} If the property value contains a quote it needs to be escaped with a backtick (`).For example: -Properties @{Attribute1DRADisplayName="`"sample`" value"} |
true |
named |
|
true (ByPropertyName) |
false |
|
Tenant <String> The Tenant ID of the object in GUID or displayname format. For example: b201dhg8-087e-5n9d-9986-c4d987bfa0b1 or MyTenant |
true |
named |
|
true (ByPropertyName) |
false |
|
DRARestServer [<String>] The name of the computer running the DRA REST Service. The requested DRA operation will execute on this server. If the parameter is not specified, the value defaults to 'localhost'. |
false |
named |
true (ByPropertyName) |
false |
|
|
DRARestPort [<Int32>] The port where the DRA REST Service listens for requests. This parameter is used only when the DRARestServer parameter is also specified. If the parameter is not specified, the value defaults to 8755. |
false |
named |
8755 |
true (ByPropertyName) |
false |
|
IgnoreCertificateErrors [<SwitchParameter>] Allows the request to bypass any SSL certificate errors, such as the InvalidOperation error that occurs when the REST Service is bound to a self-signed certificate. |
false |
named |
false |
false |
|
|
Force [<SwitchParameter>] Suppresses any request for user input and supplies a 'yes' response. For example: -Force with a delete request will perform the delete without presenting the confirmation request to the user. |
false |
named |
false |
false |
|
|
Timeout [<Int32>] The wait time in seconds before the request to the DRA REST server times out. To specify an infinite timeout, you can set this parameter to -1. |
false |
named |
100 seconds |
true (ByPropertyName) |
false |
|
<CommonParameters> Verbose, Debug, ErrorAction, ErrorVariable, WarningAction, WarningVariable, OutBuffer, PipelineVariable, and OutVariable. For more information, see About CommonParameters. |
|
|
|
|
|
NOTE:For more information, type "Get-Help New-AzureDRAUser -detailed". For technical information, type "Get-Help New-AzureDRAUser -full".
Example 5-4 1
PS C:\>New-AzureDRAUser -Tenant MyTenant -Password "MyNewPassword" -Properties @{DisplayName="MyUser";UserPrincipalName="MyUser@MyTenant.online.com";AllowSignOn=$true;UserMustChangePassword=$true}
This example creates an Azure user named MyUser in Azure Active Directory using the DisplayName and UserPrincipalName properties. The Azure user will be created in the tenant MyTenant. There are two properties set on this Azure user: DisplayName and UserPrincipalName.
Example 5-5 2
PS C:\>New-AzureDRAUser -Tenant MyTenant -Password "MyNewPassword" -Properties @{DisplayName="MyUser";UserPrincipalName="MyUser@MyTenant.online.com";AllowSignOn=$true;UserMustChangePassword=$true;AddToGroups="CN=a89cc7f6-1e9f-41fc-9715-f3e27fb1f4cb,az=3d562c8d-1d55-45ae-8288-7b58486bad44"}
-DRARestServer localhost -DRARestPort 9000 -IgnoreCertificateErrors –Force
This example creates an Azure user named MyUser in Azure Active Directory using multiple properties including adding the user to a group. The Azure user will be created in the tenant MyTenant. It specifies the server and its rest port. Also it ignores certificate errors and suppresses confirmations.
Example 5-6 3
PS C:\>New-AzureDRAUser -Tenant MyTenant -Password "MyNewPassword" -Properties @{DisplayName="MyUser";UserPrincipalName="MyUser@MyTenant.online.com";AllowSignOn=$true;CreateEmail=$true;MailNickname="MyUserNickName";Mail="MyUser@mail.com"}
This example creates a mail-enabled Azure user named MyUser in Azure Active Directory using the DisplayName and UserPrincipalName properties. The Azure user will be created in the tenant MyTenant. There are three email-related properties set on this Azure user: CreateEmail, MailNickname and Mail.