Export (0) Print
Expand All

Set-HotmailSubscription

Exchange Online
 

Applies to: Exchange Online

Topic Last Modified: 2012-09-18

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

Use the Set-HotmailSubscription cmdlet to modify the properties of an existing Hotmail subscription configured in a user's cloud-based mailbox.

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

Set-HotmailSubscription -Identity <AggregationSubscriptionIdParameter> [-DisplayName <String>] [-Enabled <$true | $false>] [-EnablePoisonSubscription <SwitchParameter>] [-Mailbox <MailboxIdParameter>] [-Password <SecureString>] <COMMON PARAMETERS>
Set-HotmailSubscription -Identity <AggregationSubscriptionIdParameter> [-DisableAsPoison <SwitchParameter>] [-Mailbox <MailboxIdParameter>] <COMMON PARAMETERS>
Set-HotmailSubscription -Identity <AggregationSubscriptionIdParameter> [-Mailbox <MailboxIdParameter>] <COMMON PARAMETERS>
COMMON PARAMETERS: [-Confirm [<SwitchParameter>]] [-DomainController <Fqdn>] [-WhatIf [<SwitchParameter>]]

This example modifies the display name of the Hotmail subscription Contoso Hotmail that's configured in the cloud-based mailbox of the user Ayla Kol.

Set-HotmailSubscription "Contoso Hotmail" -Mailbox "Ayla Kol" -DisplayName "Ayla's Contoso Subscription"

You can set properties for the Hotmail subscription, such as the display name and password.

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

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.

DisableAsPoison

Optional

System.Management.Automation.SwitchParameter

This parameter is reserved for internal Microsoft use.

DisplayName

Optional

System.String

The DisplayName parameter specifies the friendly name of the subscription.

DomainController

Optional

Microsoft.Exchange.Data.Fqdn

This parameter is reserved for internal Microsoft use.

Enabled

Optional

System.Boolean

The Enabled parameter specifies whether the Hotmail subscription is enabled. This parameter accepts $true or $false values. The default value is $true.

EnablePoisonSubscription

Optional

System.Management.Automation.SwitchParameter

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 Hotmail subscription. You can use any value that uniquely identifies the mailbox.

For example:

  • Alias

  • Distinguished name (DN)

  • GUID

  • Name

  • Display name

  • LegacyExchangeDN

  • Email address

Password

Optional

System.Security.SecureString

The Password parameter specifies the password used to sign in to the Hotmail mailbox. You must specify the value for this parameter in a secure format, for example, (ConvertTo-SecureString -String '<password>' -AsPlainText -Force).

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