インストールを更新する
Azure Notification Hubs では、 RFC6902 のJSON-Patch標準を使用したインストールの部分的な更新がサポートされています。
Request
| Method | 要求 URI | HTTP バージョン |
|---|---|---|
| PATCH | https://{namespace}.servicebus.windows.net/{NotificationHub}/installations/{id}?api-version=2015-01 |
HTTP/1.1 |
要求ヘッダー
必須要求ヘッダーと省略可能な要求ヘッダーを次の表に示します。
| 要求ヘッダー | 説明 |
|---|---|
| Content-Type | application/json-patch+json |
| 承認 | Service Bus を使用した Shared Access Signature Authentication で指定されたとおりに生成された SAS トークン。 |
| x-ms-version | 2015-01 |
要求本文
次のパッチ操作が許可されます。
| JSON-Patch操作 | Installation プロパティ | [説明とサンプル] |
|---|---|---|
| 追加 | PushChannel | インストールのチャネルを更新します。
pushChannel が変更された場合は、expiredPushChannel を true に設定します。 |
| 追加 | UserId | ユーザー ID 値を更新または追加します。
|
| 追加 | タグ | value が array の場合は、配列内のすべてのタグを既存のタグに追加します (存在しない場合でも)。 value が文字列の場合は、現在の配列にタグを追加します (タグがない場合は、1 つの値を持つ新しい配列を作成します)。
|
| 追加 | テンプレート (P2) | テンプレート全体を更新または追加します。
|
| 追加 | テンプレート本文/ヘッダー/expiry/tags | テンプレートの一部を更新または追加します (ヘッダーの 'add' は現在の headers オブジェクトに置き換えられます)。 [タグに追加] には、ネイティブ タグと同じセマンティクスがあります。
|
| 追加 | secondaryTile チャネル | secondaryTile チャネルを更新します。
|
| 追加 | secondaryTile タグ | タグの更新と同じですが、path はセカンダリ タイルを参照します。
|
| 追加 | secondaryTile テンプレート | 通常のテンプレートと同じですが、path は tileId を参照します。 |
| 追加 | secondaryTile テンプレート本文/ヘッダー/expiry/tags | 通常のテンプレートと同じですが、path は tileId を参照します。 |
| [削除] | 上記と同じ。 | userID などのプロパティ、または tags 配列の要素を削除します。 tags プロパティの最後のタグが削除されると、プロパティ全体が削除されます。
|
| Replace | 上記と同じ。 | 意味的には remove+ add と同等です。 |
Response
応答には、HTTP 状態コードおよび一連の応答ヘッダーが含まれています。
応答コード
| コード | 説明 |
|---|---|
| 204 | インストールに正常に修正プログラムが適用されました |
| 400 | 要求の形式が正しくないため、インストールに修正プログラムを適用できませんでした。 |
| 401 | 認証エラー。 アクセス キーが正しくありませんでした。 |
| 403 | クォータを超過しました。この名前空間内の登録数が多すぎます。 登録は作成されませんでした。 |
| 403 | API 呼び出し率が高すぎるため、要求が拒否されました。 |
状態コードの詳細については、「 状態コードとエラー コード」を参照してください。
応答ヘッダー
| 応答ヘッダー | 説明 |
|---|---|
| Content-type | application/json-patch+json |
| Content-Location | インストールの場所を次の形式で指定します。 https://{namespace}.servicebus.windows.net/{NotificationHub}/installations/<installationId> |
応答本文
[なし] :