Removes an on-premises object specified by the Identifier parameter as well as the associated mailbox from the cloud-based service.
Remove-DRARemoteMailbox -Domain <String> -Identifier <String> [-DRARestServer <String>] [-DRARestPort <Int32>] -IgnoreCertificateErrors <SwitchParameter>] [-Force <SwitchParameter>] [-Timeout <Int32>] [<CommonParameters>]
Use the Remove-DRARemoteMailbox cmdlet to:
Remove an on-premises user account and the associated mailbox from the cloud-based service. The requesting user must have the Delete User power.
Remove an on-premises object and the associated shared mailbox from the cloud-based service. The requesting user must have the Delete Shared Mailbox power.
If the Recycle Bin is enabled for the domain, the specified account is moved to the Recycle Bin. Otherwise, it is removed permanently. To restore the account, use the Restore-DRAUser cmdlet.
|
Attribute / Description |
Parameters / Values |
||||
|---|---|---|---|---|---|
|
Required |
Position |
Default Value |
Accept Pipeline input? |
Accept wildcard characters? |
|
|
Identifier <String> The distinguished name of an existing Active Directory object. |
true |
named |
true (ByPropertyName) |
false |
|
|
Domain <String> The domain of the object in FQDN format. For example: mydomain.corp |
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. 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 number of seconds to wait 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-DRARemoteMailbox -detailed". For technical information, type "Get-Help Remove-DRARemoteMailbox -full".
Example 20-15 1
PS C:\>Remove-DRARemoteMailbox -Domain MyDomain.corp -Identifier "CN=MyUser,OU=MyOU,DC=MyDomain,DC=corp"
This example removes the user account named MyUser from MyDomain.corp and the associated mailbox from the cloud-based service. The identifier contains the distinguished name for the user. If the Recycle Bin is enabled for the domain, the user account is moved to the Recycle Bin and the licenses associated with the user account are also removed. If the Recycle Bin is not enabled, the user account is removed permanently. The removal of the mailbox from the service is not immediate and depends on the directory synchronization schedule.
Example 20-16 2
PS C:\>Remove-DRARemoteMailbox -Domain MyDomain.corp -Identifier "CN=SMB,OU=MyOU,DC=MyDomain,DC=lab"
This example removes the on-premises object named SMB and the associated shared mailbox from the cloud-based service. The identifier contains the distinguished name for the remote shared mailbox. If the Recycle Bin is enabled for the domain, the remote shared mailbox is moved to the Recycle Bin. Otherwise, it is removed permanently.