Disable-CsOnlineUMMailBox

 

Topic Last Modified: 2016-08-30

Use the Disable-CsOnlineUMMailBox cmdlet to disable Unified Messaging (UM) for UM-enabled mailboxes.

Disable-CsOnlineUMMailBox -Identity <String> [-BypassDualWrite <$true | $false>] [-DomainController <String>] [-Force <SwitchParameter>] [-IgnoreDefaultScope <SwitchParameter>] [-KeepProperties <$true | $false>] [-TenantId <Guid>] [-WhatIf [<SwitchParameter>]]

This example disables Unified Messaging on the mailbox for tonysmith@contoso.com.

Disable-UMMailbox -Identity tonysmith@contoso.com

After the mailbox is disabled for Unified Messaging, the user can no longer use the UM features that are included in UNRESOLVED_TOKEN_VAL(exMSExchange), and the UNRESOLVED_TOKEN_VAL(exMSExchange) Unified Messaging service no longer handle calls for the associated extension number. The mailbox continues to function normally for all other operations that are unrelated to Unified Messaging.

 

Parameter Required Type Description

Identity

Required

System.String

The Identity parameter specifies the mailbox that you want to disable for Unified Messaging. You can use any value that uniquely identifies the mailbox.

For example:

  • Name

  • Display name

  • Alias

  • Distinguished name (DN)

  • Canonical DN

  • <domain name>\<account name>

  • Email address

  • GUID

  • LegacyExchangeDN

  • SamAccountName

  • User ID or user principal name (UPN)

BypassDualWrite

Optional

System.Boolean

PARAMVALUE: $true | $false

DomainController

Optional

System.String

Specifies the domain controller that's used by the cmdlet to read or write the specified data. Valid inputs for this parameter are either the fully qualified domain name (FQDN) or the computer name.

Force

Optional

System.Management.Automation.SwitchParameter

PS_PD_Force_Desc

IgnoreDefaultScope

Optional

System.Management.Automation.SwitchParameter

The IgnoreDefaultScope switch tells the command to ignore the default recipient scope setting for the Exchange Management Shell session, and to use the entire forest as the scope. This allows the command to access UNRESOLVED_TOKEN_VAL(exADNoMk) objects that aren't currently available in the default scope.

Using the IgnoreDefaultScope switch 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.

KeepProperties

Optional

System.Boolean

The KeepProperties parameter specifies whether to keep or remove the UM properties for the mailbox. Valid values are:

  • $true   The UM properties are retained on the mailbox. This is the default value.

  • $false   The UM properties are removed from the mailbox.

TenantId

Optional

System.Guid

Specifies the globally unique identifier (GUID) of your Skype for Business Online tenant account. For example: -Tenant "38aad667-af54-4397-aaa7-e94c79ec2308". You can find your tenant ID by running this command: Get-CsTenant | Select-Object DisplayName, TenantID

If you are using a remote session of Windows PowerShell and are connected only to Skype for Business Online, you do not have to include the Tenant parameter. The tenant ID will be determined by your connection and credentials. The Tenant parameter is primarily for use in a hybrid deployment.

WhatIf

Optional

System.Management.Automation.SwitchParameter

The WhatIf switch causes the command to simulate its results. By using this switch, you can view what changes would occur without having to commit those changes.

 
Show: