你当前正在访问 Microsoft Azure Global Edition 技术文档网站。 如果需要访问由世纪互联运营的 Microsoft Azure 中国技术文档网站,请访问 https://docs.azure.cn

更新安装

Azure 通知中心支持使用 RFC6902 中的JSON-Patch标准对安装的部分更新。

请求

方法 请求 URI HTTP 版本
修补程序 https://{namespace}.servicebus.windows.net/{NotificationHub}/installations/{id}?api-version=2015-01 HTTP/1.1

请求标头

下表介绍必需的和可选的请求标头。

请求标头 说明
Content-Type application/json-patch+json
授权 使用 服务总线进行共享访问签名身份验证中指定的生成的 SAS 令牌。
x-ms-version 2015-01

请求正文

允许以下修补程序操作:

JSON-Patch操作 安装属性 说明和示例
添加 PushChannel 更新安装的通道。

[ { "op": "add", "path": "/pushChannel", "value": "aaaaaaa"} ]

如果更改 pushChannel,请将 expiredPushChannel 设置为 true。

添加 UserId 更新或添加用户 ID 值。

[ { "op": "add", "path": "/userId", "value": "Bob"} ]

添加 标记 如果 value 为 array,请将数组中的所有标记添加到现有标记 (,即使不存在) 。 如果 value 是字符串,请将标记添加到当前数组 (或创建具有单个值的新数组(如果当前不存在标记),) 。

[ { "op": "add", "path": "/tags", "value": "tag"} ]

添加 模板 (P2) 更新或添加整个模板。

[ { "op": "add", "path": "/templates/myTemplate", "value": '{"body": "…", "tags": ["tag"]}'} ]

添加 模板正文/标头/expiry/tags 更新或添加模板的一部分 (请注意,标头上的“add”将替换当前标头对象) 。 添加标记的语义与本机标记相同。

[ { "op": "add", "path": "/templates/myTemplate/body", "value": '{"aps": …}'} ]

[ { "op": "add", "path": "/templates/myTemplate/headers", "value": '{"X-WNS-Type": "wns/toast"}'} ]

添加 secondaryTile 通道 汇报 secondaryTile 通道。

[ { "op": "add", "path": "/secondaryTiles/myTile/pushChannel", "value": "aaaaaaa"} ]

添加 secondaryTile 标记 与标记更新相同,但路径引用辅助磁贴。

[ { "op": "add", "path": "/secondaryTiles/myTile/tags", "value": '["fooTag"]'} ]

添加 secondaryTile 模板 与普通模板相同,但路径引用 tileId。
添加 secondaryTile 模板 body/header/expiry/tags 与普通模板相同,但路径引用 tileId。
删除 同上 删除属性(如 userID)或标记数组的元素。 如果删除标记属性的最后一个标记,则会删除整个属性。

[ { "op": "remove", "path": "/tags/myTag"} ]

Replace 同上 在语义上等效于 remove+add。

响应

响应包括 HTTP 状态代码和一组响应标头。

响应代码

代码 说明
204 已成功修补安装
400 无法修补安装,因为请求格式不正确。
401 授权失败。 访问密钥不正确。
403 已超出配额;此命名空间中的注册太多。 未创建注册。
403 请求被拒绝,因为 API 调用速率太高。

有关状态代码的信息,请参阅 状态和错误代码

响应头

响应标头 说明
Content-type application/json-patch+json
Content-Location 采用以下格式的安装位置: https://{namespace}.servicebus.windows.net/{NotificationHub}/installations/<installationId>

响应正文

无。

另请参阅

创建或覆盖安装
读取安装
删除安装