Remove-Subscription
Syntax
Remove-Subscription
[-Identity] <AggregationSubscriptionIdParameter>
[-Confirm]
[-Mailbox <MailboxIdParameter>]
[-WhatIf]
[<CommonParameters>]Description
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 this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see Find the permissions required to run any Exchange cmdlet (https://technet.microsoft.com/library/mt432940.aspx).
Examples
-------------------------- Example 1 --------------------------
Remove-Subscription Contoso -Mailbox "Kim Akers"This example removes the subscription Contoso from the mailbox of the user Kim Akers.
Required Parameters
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>.
| Type: | AggregationSubscriptionIdParameter |
| Position: | 1 |
| Default value: | None |
| Accept pipeline input: | True |
| Accept wildcard characters: | False |
Optional Parameters
The Confirm switch specifies whether to show or hide the confirmation prompt. How this switch affects the cmdlet depends on if the cmdlet requires confirmation before proceeding.
Destructive cmdlets (for example, Remove-* cmdlets) have a built-in pause that forces you to acknowledge the command before proceeding. For these cmdlets, you can skip the confirmation prompt by using this exact syntax: -Confirm:$false.
Most other cmdlets (for example, New-* and Set-* cmdlets) don't have a built-in pause. For these cmdlets, specifying the Confirm switch without a value introduces a pause that forces you acknowledge the command before proceeding.
| Type: | SwitchParameter |
| Aliases: | cf |
| Position: | Named |
| Default value: | None |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
The Mailbox parameter specifies the cloud-based mailbox that contains the subscription. 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)
| Type: | MailboxIdParameter |
| Position: | Named |
| Default value: | None |
| Accept pipeline input: | True |
| Accept wildcard characters: | False |
The WhatIf switch simulates the actions of the command. You can use this switch to view the changes that would occur without actually applying those changes. You don't need to specify a value with this switch.
| Type: | SwitchParameter |
| Aliases: | wi |
| Position: | Named |
| Default value: | None |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
Inputs
To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?linkId=616387). If the Input Type field for a cmdlet is blank, the cmdlet doesn't accept input data.
Outputs
To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types (https://go.microsoft.com/fwlink/p/?linkId=616387). If the Output Type field is blank, the cmdlet doesn't return data.