Get-CsPushNotificationConfiguration
トピックの最終更新日: 2012-04-23
現在、組織で使用中のプッシュ通知構成設定に関する情報を取得します。プッシュ通知サービス (Apple Push Notification Service および Microsoft Lync Server 2010 Push Notification Service) は、新しいインスタント メッセージ、新しいボイス メールなどのイベントに関する通知を、iPhone、Windows Phone などのモバイル デバイスに送信する手段を提供します。こうしたイベントに関する通知は、これらのデバイスで Microsoft Lync 2010 アプリケーションが一時停止している場合、またはバックグラウンドで実行されている場合でも送信されます。
構文
Get-CsPushNotificationConfiguration [-Identity <XdsIdentity>] [-LocalStore <SwitchParameter>] [-Tenant <Nullable>]
Get-CsPushNotificationConfiguration [-Filter <String>] [-LocalStore <SwitchParameter>] [-Tenant <Nullable>]
解説
Apple Push Notification Service と Microsoft Lync Server 2010 Push Notification Service を使用すれば、Apple iPhone あるいは Windows Phone で Lync 2010 を実行中のユーザーは、Lync 2010 が一時停止しているか、あるいはバックグラウンドで実行中でも、Lync 2010 イベントの通知を受信できます。たとえば、ユーザーは以下のようなイベントの通知を受信できます。
- 新しいインスタント メッセージング セッションあるいは会議への招待
- 新しいインスタント メッセージ
- 新しいボイス メール
プッシュ通知サービスがない場合は、Lync 2010 がフォアグラウンドでアクティブなアプリケーションとして実行中のときだけ、ユーザーはこれらの通知を受信します。
管理者は、iPhone ユーザーあるいは Windows Phone ユーザー、もしくはその両方に対して、プッシュ通知の有効と無効を切り替えることができます (既定では、プッシュ通知は、iPhone ユーザーと Windows Phone ユーザーの両方に対して無効です)。管理者は、Set-CsPushNotificationConfiguration コマンドレットを使用して、グローバル スコープでプッシュ通知の有効と無効を切り替えることができます。また、New-CsPushNotificationConfiguration コマンドレットを使用して、サイト スコープでカスタムのプッシュ通知設定を作成できます。
Get-CsPushNotificationConfiguration コマンドレットを使用すると、組織で現在使用されているプッシュ通知構成設定に関する情報を戻します。
このコマンドレットを実行できるユーザー: 既定では、Get-CsPushNotificationConfiguration コマンドレットをローカルで実行する権限があるのは、RTCUniversalServerAdmins グループのメンバーです。
パラメーター
| パラメーター | 必須かどうか | 型 | 説明 |
|---|---|---|---|
Identity |
省略可能 |
XdsIdentity |
戻すプッシュ通知設定のコレクションの一意識別子を示します。グローバル設定を参照するには、以下の構文を使用します。 -Identity global サイト スコープで構成されるコレクションを参照するには、次のような構文を使用します。 -Identity site:Redmond Identity 指定時はワイルドカードを使用できないことに注意してください。ワイルドカードを使用する必要がある場合は、代わりに Filter パラメーターを指定します。 このパラメーターを指定しない場合、Get-CsPushNotificationConfiguration は組織で使用中のすべてのプッシュ通知構成設定のコレクションを戻します。 |
Tenant |
省略可能 |
GUID |
このパラメーターは、Microsoft Office 365 で使用する目的で予約されています。 |
Filter |
省略可能 |
文字列 |
プッシュ通知構成設定の 1 つのコレクション (または複数のコレクション) を戻すために、ワイルドカード文字を使用できます。サイト スコープで構成されたすべての設定のコレクションを戻すには、以下の構文を使用します。 -Filter site:* Identity (フィルターできるのはこのプロパティのみです) の中に "Canada" という文字列値を含むすべての設定のコレクションを戻すには、次の構文を使用します。 -Filter "*Canada*" |
LocalStore |
省略可能 |
スイッチ パラメーター |
中央管理ストア 自体ではなく、中央管理ストア のローカル レプリカからプッシュ通知構成データを取得します。 |
入力の種類
Get-CsPushNotificationConfiguration はパイプライン入力を受け入れません。
戻り値の種類
Get-CsPushNotificationConfiguration は、Microsoft.Rtc.Management.WriteableConfig.Settings.PushNotificationConfiguration.PushNotificationConfiguration オブジェクトのインスタンスを戻します。
例
-------------------------- 例 1 --------------------------
Get-CsPushNotificationConfiguration
上記のコマンドでは、組織で使用されるように構成されたすべてのプッシュ通知設定に関する情報が戻されます。
-------------------------- 例 2 --------------------------
Get-CsPushNotificationConfiguration -Identity "site:Redmond"
例 2 で示したコマンドは、プッシュ通知設定の単一のコレクションの情報を戻します。これは、Redmond サイト用に構成された設定です。
-------------------------- 例 3 --------------------------
Get-CsPushNotificationConfiguration -Filter "site:*"
例 3 では、コマンドはサイト スコープに割り当てられたすべてのプッシュ通知設定を戻します。これを実行する目的で、コマンドは Filter パラメーターとフィルター値 "site:*" を使用します。このフィルター値により、ID が文字列値 "site:" で始まる設定のみが戻されます。
-------------------------- 例 4 --------------------------
Get-CsPushNotificationConfiguration | Where-Object {$_.EnableApplePushNotificationService -eq $False}
前記のコマンドは、iPhone のプッシュ通知が無効にされたすべてのプッシュ通知設定を戻します。この処理を行う目的で、コマンドは、まず、Get-CsPushNotificationConfiguration コマンドレットを使用して、組織内で現在使用されているすべてのプッシュ通知設定のコレクションを戻します。次に、このコレクションは Where-Object コマンドレットにパイプされます。これにより、EnableApplePushNotificationService プロパティが False に等しい (-eq) 設定のみが選ばれます。
-------------------------- 例 5 --------------------------
Get-CsPushNotificationConfiguration | Where-Object {$_.EnableApplePushNotificationService -eq $False -or $_.EnableMicrosoftPushNotificationService -eq $False}
例 5 では、Apple Push Notification Service と Lync Server 2010 Push Notification Service のどちらか、またはその両方が無効にされた、すべてのプッシュ通知設定についての情報が戻されます。このタスクを実行する目的で、まず、Get-CsPushNotificationConfiguration コマンドレットを使用して、現在、使用されているすべてのプッシュ通知設定のコレクションを戻します。次に、このコレクションは Where-Object コマンドレットにパイプされます。これにより、以下の条件のどちらかを (あるいは両方) を満たす設定が選ばれます。1) EnableApplePushNotificationService プロパティが False に等しい (-eq)。2) EnableMicrosoftPushNotificationService プロパティが False に等しい。-or 演算子は、Where-Object に、どちらかの条件を満たす設定を選択するように指示します。戻されるデータを、両方のサービスが無効にされた設定に制限するには、以下のように、代わりに -and 演算子を使用します。
Get-CsPushNotificationConfiguration | Where-Object {$_.EnableApplePushNotificationService –eq $False –and $_.EnableMicrosoftPushNotificationService –eq $False}