Removes a mailbox specified by the Identifier parameter from the cloud-based service.
Disable-DRARemoteMailbox -Domain <String> [-Archive <SwitchParameter>] -Identifier <String> [-DRARestServer <String>] [-DRARestPort <Int32>] [-IgnoreCertificateErrors <SwitchParameter>] [-Force <SwitchParameter>] [-Timeout <Int32>] [<CommonParameters>]
Use the Disable-DRARemoteMailbox cmdlet to:
Remove a mailbox from the cloud-based service while retaining the associated on-premises user account. The requesting user must have the Delete Mailbox power.
Remove the archive mailbox for an on-premises user account with an associated mailbox in the cloud-based service. The on-premises user account and the associated cloud-based mailbox are retained. The Archive parameter is mandatory and the requesting user must have the Delete Archive Mailbox power.
Remove the archive mailbox for an on-premises object with an associated shared mailbox in the cloud-based service. The on-premises object and the associated cloud-based shared mailbox are retained. The Archive parameter is mandatory and the requesting user must have the Delete Archive Mailbox power.
Attribute / Description |
Parameters / Values |
||||
---|---|---|---|---|---|
Required |
Position |
Default Value |
Accept Pipeline input? |
Accept wildcard characters? |
|
Archive [<SwitchParameter>] The Archive switch specifies whether to disconnect the cloud-based archive mailbox from the associated cloud-based mailbox. The on-premises user account and its associated cloud-based mailbox are not removed if you use this switch. |
false |
named |
true (ByPropertyName) |
false |
|
Identifier <String> The name or 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 Disable-DRARemoteMailbox -detailed". For technical information, type "Get-Help Disable-DRARemoteMailbox -full".
Example 20-1 1
PS C:\>Disable-DRARemoteMailbox -Domain "MyDomain.corp" -Identifier "CN=MyUser,OU=MyOU,DC=MyDomain,DC=corp"
This example removes the cloud-based mailbox that is associated with the on-premises user account MyUser. The identifier contains the distinguished name for the user.
Example 20-2 2
PS C:\>Disable-DRARemoteMailbox -Domain "MyDomain.corp" -Identifier "CN=MyObject,OU=MyOU,DC=MyDomain,DC=corp" -Archive
This example removes the cloud-based archive mailbox but keeps the cloud-based mailbox that is associated with the object MyObject. The identifier contains the distinguished name for the user or the shared mailbox. The removal of the archive mailbox is not immediate and depends on the directory synchronization schedule.