Set-CsPushNotificationConfiguration
Topic Last Modified: 2012-04-23
Modifies an existing collection of push notification configuration settings. The push notification service (Apple Push Notification Service and Microsoft Lync Server 2010 Push Notification Service) provides a way to send notifications about events such as new instant messages or new voice mail to mobile devices such as iPhones and Windows Phones, even if the Microsoft Lync 2010 application on those devices is currently suspended or running in the background.
Syntax
Set-CsPushNotificationConfiguration [-Identity <XdsIdentity>] [-Confirm [<SwitchParameter>]] [-EnableApplePushNotificationService <$true | $false>] [-EnableMicrosoftPushNotificationService <$true | $false>] [-Force <SwitchParameter>] [-Tenant <Nullable>] [-WhatIf [<SwitchParameter>]]
Set-CsPushNotificationConfiguration [-Confirm [<SwitchParameter>]] [-EnableApplePushNotificationService <$true | $false>] [-EnableMicrosoftPushNotificationService <$true | $false>] [-Force <SwitchParameter>] [-Instance <PSObject>] [-Tenant <Nullable>] [-WhatIf [<SwitchParameter>]]
Detailed Description
The Apple Push Notification Service and the Microsoft Lync Server 2010 Push Notification Service enable users running Lync 2010 on their Apple iPhone or Windows Phone to receive notifications about Lync 2010 events even when Lync 2010 is suspended or running in the background. For example, users can receive notice for events such as these:
- Invitations to a new instant messaging session or conference
- New instant messages
- New voice mail
Without the push notification service users would receive these notices only when Lync 2010 was in the foreground and serving as the active application.
Administrators have the ability to enable or disable push notifications for iPhone users and/or Windows Phone users. (By default, push notifications are disabled for both iPhone users and Windows Phone users.) Administrators can enable or disable push notifications at the global scope by using the Set-CsPushNotificationConfiguration cmdlet. They can also create custom push notification settings at the site scope by using the New-CsPushNotificationConfiguration cmdlet. These custom settings can also be modified by using the Set-CsPushNotificationConfiguration cmdlet.
With the push notification configuration settings there are only two property values for Administrators to manage: EnableApplePushNotificationService, which determines whether push notifications are sent to iPhone users; and EnableMicrosoftPushNotificationService, which determines whether push notifications are sent to Windows Phone users. Note that these property values do not have to be set to the same value. For example, you could enable push notifications to Windows Phone users (by setting EnableMicrosoftPushNotificationService to True) yet, at the same, disable notifications to iPhone users by setting EnableApplePushNotificationService to False.
Who can run this cmdlet: By default, members of the following groups are authorized to run the Set-CsPushNotificationConfiguration cmdlet locally: RTCUniversalServerAdmins.
Parameters
| Parameter | Required | Type | Description |
|---|---|---|---|
Identity |
Optional |
XdsIdentity |
Indicates the Identity of the push notification configuration settings to be modified. To refer to the global settings, use this syntax: -Identity global To refer to site settings, use syntax similar to this: -Identity site:Redmond Note that you cannot use wildcards when specifying an Identity. |
EnableApplePushNotificationService |
Optional |
Boolean |
When set to True, iPhone users will receive push notifications from the Apple Push Notification Service. When set to False, iPhone users will not receive these notifications. The default value is False. |
EnableMicrosoftPushNotificationService |
Optional |
Boolean |
When set to True, Windows Phone users will receive push notifications from the Microsoft Lync Server 2010 Push Notification Service. When set to False, Windows Phone users will not receive these notifications. The default value is False. |
Instance |
Optional |
Push configuration object |
Allows you to pass a reference to an object to the cmdlet rather than set individual parameter values. |
Tenant |
Optional |
GUID |
This parameter is reserved for use with Microsoft Office 365. |
Force |
Optional |
SwitchParameter |
Suppresses the display of any non-fatal error message that might occur when running the command. |
WhatIf |
Optional |
SwitchParameter |
Describes what would happen if you executed the command without actually executing the command. |
Confirm |
Optional |
SwitchParameter |
Prompts you for confirmation before executing the command. |
Input Types
Microsoft.Rtc.Management.WriteableConfig.Settings.PushNotificationConfiguration.PushNotificationConfiguration. Set-CsPushNotificationConfiguration accepts pipelined instances of the PushNotificationConfiguration object.
Return Types
None. Instead, Set-CsPushNotificationConfiguration modifies existing instances of the Microsoft.Rtc.Management.WriteableConfig.Settings.PushNotificationConfiguration.PushNotificationConfiguration object.
Example
-------------------------- Example 1 --------------------------
Set-CsPushNotificationService -Identity "site:Redmond" -EnableApplePushNotificationService $False
The command shown in Example 1 disables push notifications from the Apple Push Notification Service for the Redmond site.
-------------------------- Example 2 --------------------------
Get-CsPushNotificationService -Filter "site:*" | Set-CsPushNotificationService -EnableApplePushNotificationService $False
The preceding command disables push notifications from the Apple Push Notification Service for all the sites currently hosting push notification settings. To do this, the command first uses Get-CsPushNotificationConfiguration and the Filter parameter to return all the push notification settings configured at the site scope; the filter value "site:*" limits the returned settings to those that have an Identity that begins with the string value "site:". That collection of settings is then piped to the Set-CsPushNotificationConfiguration cmdlet, which takes each item in the collection and sets the EnableApplePushNotificationService property to False.
-------------------------- Example 3 --------------------------
Get-CsPushNotificationService | Where-Object {$_.EnableMicrosoftPushNotificationService -eq $False} | Set-CsPushNotificationService -EnableApplePushNotificationService $False
Example 3 demonstrates how you can locate all the push notification settings where push notifications from the Microsoft Lync Server 2010 Push Notification Service are disabled, and then disable push notifications from the Apple Push Notification Service for each of those settings as well. To carry out this task, the command first uses Get-CsPushNotificationConfiguration to return a collection of all the push notification settings currently in use the organization. This collection is then piped to the Where-Object cmdlet, which selects only those settings where the EnableMicrosoftPushNotificationService property is equal to (-eq) False. That filtered collection is then piped to Set-CsPushNotificationConfiguration, which takes each item in the filtered collection and sets the EnableApplePushNotificationService property to False.