Aggiornare un'installazione

  • Articolo

Hub di notifica di Azure supporta aggiornamenti parziali per un'installazione usando lo standard JSON-Patch in RFC6902.

Richiesta

Metodo URI richiesta Versione HTTP
PATCH https://{namespace}.servicebus.windows.net/{NotificationHub}/installations/{id}?api-version=2015-01 HTTP/1.1

Intestazioni della richiesta

Nella seguente tabella vengono descritte le intestazioni di richiesta obbligatorie e facoltative.

Intestazione della richiesta Descrizione
Content-Type application/json-patch+json
Autorizzazione Token di firma di accesso condiviso generato come specificato in Autenticazione della firma di accesso condiviso con il bus di servizio.
x-ms-version 2015-01

Testo della richiesta

Sono consentite le operazioni patch seguenti:

operazione JSON-Patch Installation, proprietà Descrizione ed esempio
add PushChannel Aggiornare il canale di un'installazione.

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

Impostare expiredPushChannel su true se pushChannel viene modificato.
add UserId Aggiornare o aggiungere il valore dell'ID utente.

[ { "op": "add", "path": "/userId", "value": "Bob"} ]
add Tag Se value è matrice, aggiungere tutti i tag nella matrice ai tag esistenti (anche se non presenti). Se value è una stringa, aggiungere un tag alla matrice corrente (o creare una nuova matrice con un singolo valore, se non sono presenti tag).

[ { "op": "add", "path": "/tags", "value": "tag"} ]
add Modello (P2) Aggiornare o aggiungere un modello intero.

[ { "op": "add", "path": "/templates/myTemplate", "value": '{"body": "…", "tags": ["tag"]}'} ]
add Corpo del modello/intestazione/scadenza/tag Aggiornare o aggiungere parti del modello . Si noti che 'add' nelle intestazioni sostituisce l'oggetto intestazioni correnti. I tag Add on hanno la stessa semantica dei tag nativi.

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

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

[ { "op": "add", "path": "/secondaryTiles/myTile/pushChannel", "value": "aaaaaaa"} ]
add tag secondaryTile Uguale all'aggiornamento dei tag, ma il percorso fa riferimento al riquadro secondario.

[ { "op": "add", "path": "/secondaryTiles/myTile/tags", "value": '["fooTag"]'} ]
add modello secondaryTile Uguale ai modelli normali, ma il percorso fa riferimento a tileId.
add corpo/intestazione/scadenza/tag del modello secondaryTile Uguale ai modelli normali, ma il percorso fa riferimento a tileId.
Rimuovi Come sopra. Elimina una proprietà, ad esempio userID, o un elemento della matrice di tag. Se l'ultimo tag della proprietà tags viene rimosso, l'intera proprietà viene rimossa.

[ { "op": "remove", "path": "/tags/myTag"} ]
Sostituisci Come sopra. Semanticamente equivalente a remove+add.

Risposta

Nella risposta sono inclusi un codice di stato HTTP e un set di intestazioni per la risposta.

Codici di risposta

Codice Descrizione
204 L'installazione è stata applicata correttamente
400 Impossibile applicare patch all'installazione perché la richiesta non è riuscita.
401 Errore di autorizzazione. La chiave di accesso non è corretta.
403 Quota superata; troppe registrazioni in questo spazio dei nomi. Registrazione non creata.
403 Richiesta rifiutata perché la frequenza delle chiamate API è troppo elevata.

Per informazioni sui codici di stato, vedere Codici di stato e di errore.

Intestazioni di risposta

Intestazione risposta Descrizione
Tipo di contenuto application/json-patch+json
Content-Location Percorso dell'installazione nel formato: https://{namespace}.servicebus.windows.net/{NotificationHub}/installations/<installationId>

Corpo della risposta

No.

Vedere anche

Creare o sovrascrivere un'installazione
Leggere un'installazione
Eliminare un'installazione