Atualizar uma instalação

Artigo
05/26/2023

Os Hubs de Notificação do Azure dão suporte a atualizações parciais para uma instalação usando o padrão JSON-Patch no RFC6902.

Solicitação

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

Cabeçalhos da solicitação

A tabela a seguir descreve os cabeçalhos de solicitação obrigatórios e opcionais.

Cabeçalho da solicitação	Descrição
Tipo de conteúdo	`application/json-patch+json`
Autorização	Token SAS gerado conforme especificado na Autenticação de Assinatura de Acesso Compartilhado com o Barramento de Serviço.
x-ms-version	2015-01

Corpo da solicitação

As seguintes operações de patch são permitidas:

operação JSON-Patch	Propriedade Installation	Descrição e exemplo
adicionar	PushChannel	Atualize o canal de uma instalação. `[ { "op": "add", "path": "/pushChannel", "value": "aaaaaaa"} ]` Coloque expiredPushChannel como true se pushChannel for alterado.
adicionar	UserId	Atualize ou adicione o valor da ID do usuário. `[ { "op": "add", "path": "/userId", "value": "Bob"} ]`
adicionar	Marca	Se o valor for matriz, adicione todas as marcas na matriz às marcas existentes (mesmo que não estejam presentes). Se value for uma cadeia de caracteres, adicione a marca à matriz atual (ou crie uma nova matriz com um único valor, se não as marcas estiverem presentes no momento). `[ { "op": "add", "path": "/tags", "value": "tag"} ]`
adicionar	Modelo (P2)	Atualize ou adicione um modelo inteiro. `[ { "op": "add", "path": "/templates/myTemplate", "value": '{"body": "…", "tags": ["tag"]}'} ]`
adicionar	Corpo/cabeçalho/expiração/marcas de modelo	Atualizar ou adicionar partes do modelo (observe que 'add' em cabeçalhos substitui o objeto de cabeçalhos atual). Adicionar marcas tem a mesma semântica que as marcas nativas. `[ { "op": "add", "path": "/templates/myTemplate/body", "value": '{"aps": …}'} ]` `[ { "op": "add", "path": "/templates/myTemplate/headers", "value": '{"X-WNS-Type": "wns/toast"}'} ]`
adicionar	canal secondaryTile	Atualizações o canal secondaryTile. `[ { "op": "add", "path": "/secondaryTiles/myTile/pushChannel", "value": "aaaaaaa"} ]`
adicionar	marca secondaryTile	O mesmo que as marcas são atualizadas, mas o caminho refere-se ao bloco secundário. `[ { "op": "add", "path": "/secondaryTiles/myTile/tags", "value": '["fooTag"]'} ]`
adicionar	modelo secondaryTile	O mesmo que modelos normais, mas o caminho refere-se a tileId.
adicionar	secondaryTile template body/header/expiry/tags	O mesmo que modelos normais, mas o caminho refere-se a tileId.
Remover	Como acima	Exclui uma propriedade, como userID, ou um elemento da matriz de marcas. Se a última marca da propriedade tags for removida, toda a propriedade será removida. `[ { "op": "remove", "path": "/tags/myTag"} ]`
Substitua	Como acima	Semanticamente equivalente a remover+adicionar.

Resposta

A resposta inclui um código de status 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	A instalação não pôde ser corrigida porque a solicitação estava malformada.
401	Falha de autorização. A chave de acesso estava incorreta.
403	Cota excedida; muitos registros neste namespace. Registro não criado.
403	Solicitação rejeitada porque a taxa de chamada à API é muito alta.

Para obter informações sobre status códigos, consulte Códigos de status e erro.

Cabeçalhos de resposta

Cabeçalho de resposta	Descrição
Content-type	`application/json-patch+json`
Local do conteúdo	O local 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
Excluir uma instalação

Compartilhar via