Export (0) Print
Expand All

Get-Subscription

Exchange Online
 

Applies to: Exchange Online

Topic Last Modified: 2014-03-26

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

Use the Get-Subscription cmdlet to view the properties of an existing subscription configured in a user's cloud-based mailbox. This cmdlet is used by Microsoft Office Outlook Web App options to display the list of email subscriptions that the end user has, such as POP, IMAP, Facebook, and LinkedIn.

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

Get-Subscription [-Identity <AggregationSubscriptionIdParameter>] [-IncludeReport <SwitchParameter>] [-Mailbox <MailboxIdParameter>] [-AggregationType <Aggregation | Mirrored | Migration | PeopleConnection | All>] [-Confirm [<SwitchParameter>]] [-DomainController <Fqdn>] [-ResultSize <Unlimited>] [-SubscriptionType <Unknown | Pop | DeltaSyncMail | IMAP | AllEMail | Facebook | LinkedIn | AllThatSupportSendAs | AllThatSupportPolicyInducedDeletion | AllThatSupportSendAsAndPeopleConnect | All>] [-WhatIf [<SwitchParameter>]]

This example lists all the subscriptions configured in the mailbox of the user Ayla Kol.

Get-Subscription -Mailbox "Ayla Kol"

You can view the properties of the subscription, such as the remote server, authentication method, connection status, and the last time a successful synchronization occurred.

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

AggregationType

Optional

Microsoft.Exchange.Transport.Sync.Common.Subscription.Pim.AggregationType

The AggregationType parameter filters the results by type. The acceptable values for this parameter are:

  • All

  • Aggregation

  • Migration

  • Mirrored

  • PeopleConnection

Confirm

Optional

System.Management.Automation.SwitchParameter

The Confirm switch causes the command to pause processing and requires you to acknowledge what the command will do before processing continues. You don't have to specify a value with the Confirm switch.

DomainController

Optional

Microsoft.Exchange.Data.Fqdn

This parameter is reserved for internal Microsoft use.

Identity

Optional

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>.

IncludeReport

Optional

System.Management.Automation.SwitchParameter

The IncludeReport switch specifies whether to return additional details, which can be used for troubleshooting.

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

ResultSize

Optional

Microsoft.Exchange.Data.Unlimited

The ResultSize parameter specifies the total number of subscriptions to return. If no value is specified, the parameter returns all results that match the filter.

SubscriptionType

Optional

Microsoft.Exchange.Transport.Sync.Common.Subscription.AggregationSubscriptionType

The SubscriptionType parameter filters the results based on the type of subscription. Valid values for this parameter are:

  • All

  • AllEmail

  • AllThatSupportPolicyInducedDeletion

  • AllThatSupportSendAs

  • AllThatSupportSendAsAndPeopleConnect

  • DeltaSyncMail

  • Facebook

  • IMAP

  • LinkedIn

  • Pop

  • Unknown

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