Updates a user in Azure Active Directory.
NOTE:Set-AzureDRAUser cmdlet supports multi-values only for the OtherMails attribute.
Set-AzureDRAUser -Tenant <String> [-Properties <Hashtable>] [-Replace <Hashtable>] [-Add <Hashtable>] [-Remove <Hashtable>] [-Clear <String[]>] -Identifier <String> [-DRARestServer <String>] [-DRARestPort <Int32>] [-IgnoreCertificateErrors <SwitchParameter>] [-Force <SwitchParameter>] [-Timeout <Int32>] <CommonParameters>]
The Set-AzureDRAUser cmdlet updates a user in Azure Active Directory. The requesting user must have the Modify All Azure User Properties power or a custom power with the necessary powers for the requested attributes.
Attribute / Description |
Values |
||||
---|---|---|---|---|---|
Required |
Position |
Default Value |
Accept Pipeline input? |
Accept wildcard characters? |
|
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 |
Replace [<Hashtable>] A Hashtable of property values to replace the current set of values for the specified property. The key is the name of a defined property in the REST interface. For example: -Replace @{Attribute1DRADisplayName="my value"; Attribute2DRADisplayName=value} Multiple values are specified as a comma-separated list and will replace currently set values.For example: -Replace @{Attribute1DRADisplayName=value1, value2} If the property name contains non-alphanumeric characters it needs to be quoted.For example: -Replace @{"Attribute1-DRA-DisplayName"=value} If the property value contains a quote it needs to be escaped with a backtick (`).For example: -Replace @{Attribute1DRADisplayName="`"sample`" value"} |
false |
named |
|
true (ByPropertyName) |
false |
Add [<Hashtable>] A Hashtable of property values to add to the current set of values for the specified multi-valued property. The key is the name of a defined property in the REST interface. For example: -Add @{Attribute1DRADisplayName=value; Attribute2DRADisplayName=value1, value2; ...; AttributeNDRADisplayName=value1, value2} Multiple values are specified as a comma-separated list.For example: -Add @{Attribute1DRADisplayName=value1, value2}} If the property name contains non-alphanumeric characters it needs to be quoted.For example: -Add @{"Attribute1-DRA-DisplayName"=value} If the property value contains a quote it needs to be escaped with a backtick (`).For example: -Add @{Attribute1DRADisplayName="`"sample`" value"} |
false |
named |
|
true (ByPropertyName) |
false |
Remove [<Hashtable>] A Hashtable of property values to remove from the current set of values for the specified multi-valued property. The key is the name of a defined property in the REST interface. For example: -Remove @{Attribute1DRADisplayName=value; Attribute2DRADisplayName=value1, value2; ...; AttributeNDRADisplayName=value1, value2} Multiple values are specified as a comma-separated list and will be removed from currently set values.For example: -Remove @{Attribute1DRADisplayName=value1,value2} If the property name contains non-alphanumeric characters it needs to be quoted.For example: -Remove @{"Attribute1-DRA-DisplayName"=value} If the property value contains a quote it needs to be escaped with a backtick (`).For example: -Remove @{Attribute1DRADisplayName="`"sample`" value"} |
false |
named |
|
true (ByPropertyName) |
false |
Clear [<String>] An array of property names whose values will be cleared. Each name is the name of a defined property in the REST interface. For example: -Clear "Attribute1-DRA-DisplayName" Multiple values need to be separated by a comma. For example: -Clear Attribute1DRADisplayName, Attribute2DRADisplayName |
false |
named |
|
true (ByPropertyName) |
false |
Identifier <String> The GUID or UPN of the Azure user. When the Identifier is a UPN, the Tenant parameter will be ignored. |
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 Set-AzureDRAUser -detailed". For technical information, type "Get-Help Set-AzureDRAUser -full".
Example 5-9 1
PS C:\>Set-AzureDRAUser -Tenant b201dhg8-087e-5n9d-9986-c4d987bfa0b1 -Identifier 23225bb1-5ac0-4b4c-a23c-beb7fad44b65 -Properties @{JobTitle="Manager";city="Houston"}
This example updates the specified properties of the user 23225bb1-5ac0-4b4c-a23c-beb7fad44b65 in tenant b201dhg8-087e-5n9d-9986-c4d987bfa0b1. The identifier contains the GUID for the Azure user. Two properties are updated: JobTitle and city.
Example 5-10 2
PS C:\>Set-AzureDRAUser -Tenant b201dhg8-087e-5n9d-9986-c4d987bfa0b1 -Identifier 23225bb1-5ac0-4b4c-a23c-beb7fad44b65 -Properties @{AddToGroups="CN=a89cc7f6-1e9f-41fc-9715-f3e27fb1f4cb,az=b201dhg8-087e-5n9d-9986-c4d987bfa0b1"}
This example updates the specified property of the user 23225bb1-5ac0-4b4c-a23c-beb7fad44b65 in the tenant b201dhg8-087e-5n9d-9986-c4d987bfa0b1. The identifier contains the GUID for the Azure user. The property AddToGroups will add the user to the specified group.
Example 5-11 3
PS C:\>Set-AzureDRAUser -Tenant MyTenant -Identifier 23225bb1-5ac0-4b4c-a23c-beb7fad44b65 -Properties @{AllowSignOn=$true}
This command enables the user account. If the user account is to be disabled, set AllowSignOn to $false.
Example 5-12 3
PS C:\>Set-AzureDRAUser -Tenant b201dhg8-087e-5n9d-9986-c4d987bfa0b1 -Identifier 23225bb1-5ac0-4b4c-a23c-beb7fad44b65 -Properties @{AcceptMessagesOnlyFromSendersOrMembers="CN=392B7949-32F0-4336-9130-CF460559AAF0,az=fd74da8a-3212-4626-8f12-aca06dc133f6","CN=MyUser,OU=Users,OU=ABC,DC=MYDOMAIN,DC=corp"}
This example updates the specified property of the user 23225bb1-5ac0-4b4c-a23c-beb7fad44b65 in tenant b201dhg8-087e-5n9d-9986-c4d987bfa0b1. The identifier contains the GUID for the Azure user. The Exchange Online property AcceptMessagesOnlyFromSendersOrMembers adds an Azure user and a synced user to the delivery restrictions.