Applies to: Exchange Server 2013

Topic Last Modified: 2012-08-08

Use the Disable-RemoteMailbox cmdlet to remove a mailbox from the cloud-based service. The associated user object in the on-premises Active Directory isn't removed.

For information about the parameter sets in the Syntax section below, see Syntax.

Syntax

Disable-RemoteMailbox <COMMON PARAMETERS>
Disable-RemoteMailbox [-Archive <SwitchParameter>] <COMMON PARAMETERS>
COMMON PARAMETERS: -Identity <RemoteMailboxIdParameter> [-Confirm [<SwitchParameter>]] [-DomainController <Fqdn>] [-IgnoreDefaultScope <SwitchParameter>] [-IgnoreLegalHold <SwitchParameter>] [-WhatIf [<SwitchParameter>]]

Examples

EXAMPLE 1

This example removes the mailbox in the service associated with the on-premises mail-enabled user Kim Akers. The mail-enabled user is automatically converted to a regular user. This example assumes directory synchronization has been configured.

Copy Code 
Disable-RemoteMailbox "Kim Akers"

EXAMPLE 2

This example removes an archive mailbox in the service but keeps the mailbox in the service associated with the on-premises mail-enabled user David Strome. This example assumes directory synchronization has been configured.

Copy Code 
Disable-RemoteMailbox "David Strome" -Archive

Detailed Description

Use the Disable-RemoteMailbox cmdlet if you want to remove the mailbox from the service but keep the associated on-premises mail-enabled user. You can also use it to disconnect the archive mailbox in the service from the mailbox in the service. If you want to remove both the mailbox from the service and the on-premises mail-enabled user, use the Remove-RemoteMailbox cmdlet.

Directory synchronization must be configured correctly for a mailbox to be removed from the service. Removal of the mailbox from the service isn't immediate and depends on the directory synchronization schedule.

You need to be assigned permissions before you can run this cmdlet. Although all parameters for this cmdlet are listed in this topic, you may not have access to some parameters if they're not included in the permissions assigned to you. To see what permissions you need, see the "Remote mailboxes" entry in the Recipients Permissions topic.

Parameters

Parameter Required Type Description

Identity

Required

Microsoft.Exchange.Configuration.Tasks.RemoteMailboxIdParameter

The Identity parameter takes one of the following values:

  • ADObjectID

  • GUID

  • Distinguished name (DN)

  • Domain\SamAccountName

  • User principal name (UPN)

  • LegacyExchangeDN

  • Email address

  • User alias

Archive

Optional

System.Management.Automation.SwitchParameter

The Archive switch specifies whether to disconnect the archive mailbox in the service from the associated mailbox in the service.

The on-premises mail-enabled user and its associated mailbox in the service aren't removed if you use this switch.

Confirm

Optional

System.Management.Automation.SwitchParameter

The Confirm switch can be used to suppress the confirmation prompt that appears by default when this cmdlet is run. To suppress the confirmation prompt, use the syntax -Confirm:$False. You must include a colon ( : ) in the syntax.

DomainController

Optional

Microsoft.Exchange.Data.Fqdn

The DomainController parameter specifies the fully qualified domain name (FQDN) of the domain controller that writes this configuration change to Active Directory.

IgnoreDefaultScope

Optional

System.Management.Automation.SwitchParameter

The IgnoreDefaultScope parameter instructs the command to ignore the default recipient scope setting for the Exchange Management Shell session and use the entire forest as the scope. This allows the command to access Active Directory objects that aren't currently in the default scope. Using the IgnoreDefaultScope parameter introduces the following restrictions:

  • You can't use the DomainController parameter. The command uses an appropriate global catalog server automatically.

  • You can only use the DN for the Identity parameter. Other forms of identification, such as alias or GUID, aren't accepted.

IgnoreLegalHold

Optional

System.Management.Automation.SwitchParameter

The IgnoreLegalHold switch ignores the legal hold status of the mailbox user and allows you to disable the cloud-based mailbox that's on legal hold.

Caution:
When you disable a mailbox, the mailbox is disconnected from the user account. After you disable a mailbox, you can't include it in a discovery search. Disconnected mailboxes are permanently deleted from the mailbox database after the deleted mailbox retention period expires. Check with your organization's legal or Human Resources department before disabling a mailbox that's on legal hold.

WhatIf

Optional

System.Management.Automation.SwitchParameter

The WhatIf switch instructs the command to simulate the actions that it would take on the object. By using the WhatIf switch, you can view what changes would occur without having to apply any of those changes. You don't have to specify a value with the WhatIf switch.

Input Types

To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types. If the Input Type field for a cmdlet is blank, the cmdlet doesn’t accept input data.

Return Types

To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types. If the Output Type field is blank, the cmdlet doesn’t return data.