Removes a user in Azure Active Directory.
Remove-AzureDRAUser -Tenant <String> -Identifier <String> [-DRARestServer <String>] [-DRARestPort <Int32>] [-IgnoreCertificateErrors <SwitchParameter>] [-Force <SwitchParameter>] [-Timeout <Int32>] [<CommonParameters>]
The Remove-AzureDRAUser cmdlet removes a user in Azure Active Directory. The requesting user must have the Delete Azure User Account Permanently power.
Attribute / Description |
Values |
||||
---|---|---|---|---|---|
Required |
Position |
Default Value |
Accept Pipeline input? |
Accept wildcard characters? |
|
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 Remove-AzureDRAUser -detailed". For technical information, type "Get-Help Remove-AzureDRAUser -full".
Example 5-7 1
PS C:\>Remove-AzureDRAUser -Tenant b201dhg8-087e-5n9d-9986-c4d987bfa0b1 -Identifier 23225bb1-5ac0-4b4c-a23c-beb7fad44b65
This example deletes the Azure user identified by GUID 23225bb1-5ac0-4b4c-a23c-beb7fad44b65 in the tenant identified by GUID b201dhg8-087e-5n9d-9986-c4d987bfa0b1. The Identifier parameter contains the GUID of the Azure user.
Example 5-8 2
PS C:\>Remove-AzureDRAUser -Tenant MyTenant -Identifier testuser@mytenant.onmicrosoft.com
This example deletes the Azure user identified by UPN testuser@mytenant.onmicrosoft.com in the tenant and display name is MyTenant. The Identifier parameter contains the UPN of the Azure user. When the Identifier is a UPN, the Tenant parameter will be ignored.