Export (0) Print
Expand All

Remove-Subscription

Exchange Online
 

Applies to: Exchange Online

Topic Last Modified: 2012-09-17

This cmdlet is available only in the cloud-based service.

Use the Remove-Subscription cmdlet to remove a Hotmail, POP, or IMAP subscription from a user's cloud-based mailbox.

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

Remove-Subscription -Identity <AggregationSubscriptionIdParameter> [-Mailbox <MailboxIdParameter>] [-Confirm [<SwitchParameter>]] [-DomainController <Fqdn>] [-WhatIf [<SwitchParameter>]]

This example removes the subscription Contoso from the mailbox of the user Kim Akers.

Remove-Subscription Contoso -Mailbox "Kim Akers"

The Remove-Subscription cmdlet removes a Hotmail, POP, or IMAP subscription from a user's cloud-based mailbox. It doesn't remove the email messages or contacts previously downloaded to the cloud-based mailbox by the subscription.

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 "Subscriptions" entry in the Feature permissions in Exchange Online topic.

 

Parameter Required Type Description

Identity

Required

Microsoft.Exchange.Configuration.Tasks.AggregationSubscriptionIdParameter

The Identity parameter specifies the subscription. You can identify the subscription by using one of the following methods:

  • Specify the globally unique identifier of the subscription, which is its canonical name (CN).

  • Use the Mailbox parameter to specify the mailbox that contains the subscription, and then specify the name of the subscription.

You can find the identifying values for a subscription, such as Identity and Name, by running this command: Get-Subscription -Mailbox <mailbox>.

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

This parameter is reserved for internal Microsoft use.

Mailbox

Optional

Microsoft.Exchange.Configuration.Tasks.MailboxIdParameter

The Mailbox parameter specifies the cloud-based mailbox that contains the subscription. You can use any value that uniquely identifies the mailbox.

For example:

  • Alias

  • Distinguished name (DN)

  • GUID

  • Name

  • Display name

  • LegacyExchangeDN

  • Email address

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.

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.

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.

 
Was this page helpful?
(1500 characters remaining)
Thank you for your feedback
Show:
© 2014 Microsoft