Was this page helpful?
Additional feedback?
1500 characters remaining
Export (0) Print
Expand All



Applies to: Exchange Online

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

Use the Get-HotmailSubscription cmdlet to view information about Hotmail subscriptions configured in cloud-based mailboxes.

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

Get-HotmailSubscription [-Identity <AggregationSubscriptionIdParameter>] [-IncludeReport <SwitchParameter>] [-Mailbox <MailboxIdParameter>] [-AggregationType <Aggregation | Mirrored | Migration | PeopleConnection | All>] [-Confirm [<SwitchParameter>]] [-ResultSize <Unlimited>] [-WhatIf [<SwitchParameter>]]

This example lists all the Hotmail subscriptions configured in the mailbox of the user Brian Johnson.

Get-HotmailSubscription -Mailbox "Brian Johnson"

This example returns additional information about the Hotmail subscriptions configured in the mailbox of the user Kim Akers.

Get-HotmailSubscription -Mailbox "Kim Akers" -IncludeReport | Export-CSV C:\KimAkersHotmailReport

You can view the properties of the Hotmail subscription, such as the 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




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

  • All

  • Aggregation

  • Migration

  • Mirrored

  • PeopleConnection




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.




The Identity parameter specifies the Hotmail 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 Hotmail subscription, such as Identity and Name, by running this command: Get-HotmailSubscription -Mailbox <mailbox>.




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




The Mailbox parameter specifies the cloud-based mailbox that contains the Hotmail 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)




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.




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.




This parameter is reserved for internal Microsoft use.

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
© 2015 Microsoft