Partilhar via


Atualizar uma instalação

Os Hubs de Notificação do Azure suportam atualizações parciais para uma instalação com a norma JSON-Patch em RFC6902.

Pedir

Método URI do pedido Versão HTTP
PATCH https://{namespace}.servicebus.windows.net/{NotificationHub}/installations/{id}?api-version=2015-01 HTTP/1.1

Cabeçalhos do pedido

A tabela seguinte descreve os cabeçalhos de pedido obrigatórios e opcionais.

Cabeçalho do pedido Descrição
Content-Type application/json-patch+json
Autorização Token de SAS gerado conforme especificado em Autenticação de Assinatura de Acesso Partilhado com o Service Bus.
x-ms-version 2015-01

Corpo do pedido

São permitidas as seguintes operações de patch:

JSON-Patch operação Propriedade de Instalação Descrição e exemplo
adicionar PushChannel Atualize o canal de uma instalação.

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

Coloque expiredPushChannel como verdadeiro se pushChannel for alterado.

adicionar IDUtilizador Atualizar ou adicionar o valor de ID de utilizador.

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

adicionar Etiqueta Se o valor for matriz, adicione todas as etiquetas na matriz às etiquetas existentes (mesmo que não estejam presentes). Se o valor for uma cadeia, adicione uma etiqueta à matriz atual (ou crie uma nova matriz com um único valor, caso contrário, as etiquetas estão atualmente presentes).

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

adicionar Modelo (P2) Atualizar ou adicionar um modelo inteiro.

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

adicionar Corpo do modelo/cabeçalho/expiração/etiquetas Atualize ou adicione partes do modelo (tenha em atenção que "adicionar" nos cabeçalhos substitui o objeto de cabeçalhos atual). Adicionar em etiquetas tem a mesma semântica que as etiquetas nativas.

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

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

adicionar secondaryTile channel Atualizações o canal secundárioTile.

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

adicionar secondaryTile tag O mesmo que a atualização de etiquetas, mas o caminho refere-se ao mosaico secundário.

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

adicionar secondaryTile template O mesmo que os modelos normais, mas o caminho refere-se a tileId.
adicionar secondaryTile template body/header/expiry/tags O mesmo que os modelos normais, mas o caminho refere-se a tileId.
Remover Tal como acima Elimina uma propriedade, como userID, ou um elemento da matriz de etiquetas. Se a última etiqueta da propriedade tags for removida, toda a propriedade será removida.

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

Substituir Tal como acima Semanticamente equivalente a remover+adicionar.

Resposta

A resposta inclui um código de estado HTTP e um conjunto de cabeçalhos de resposta.

Códigos de resposta

Código Descrição
204 A instalação foi corrigida com êxito
400 Não foi possível corrigir a instalação porque o pedido tinha um formato incorreto.
401 Falha de autorização. A chave de acesso estava incorreta.
403 Quota excedida; demasiados registos neste espaço de nomes. Registo não criado.
403 Pedido rejeitado porque a taxa de chamadas à API é demasiado elevada.

Para obter informações sobre códigos de estado, veja Códigos de Estado e erro.

Cabeçalhos de resposta

Cabeçalho de resposta Descrição
Tipo de conteúdo application/json-patch+json
Localização do Conteúdo A localização da instalação no formato: https://{namespace}.servicebus.windows.net/{NotificationHub}/installations/<installationId>

Corpo da resposta

Nenhum.

Consulte também

Criar ou substituir uma instalação
Ler uma instalação
Eliminar uma instalação