Aktualisieren einer Installation

Artikel
05/26/2023

Azure Notification Hubs unterstützt teilweise Updates für eine Installation mithilfe des JSON-Patch-Standards in RFC6902.

Anforderung

Methode	Anforderungs-URI	HTTP-Version
PATCH	`https://{namespace}.servicebus.windows.net/{NotificationHub}/installations/{id}?api-version=2015-01`	HTTP/1.1

Anforderungsheader

In der folgenden Tabelle werden erforderliche und optionale Anforderungsheader beschrieben.

Anforderungsheader	BESCHREIBUNG
Content-Type	`application/json-patch+json`
Authorization	SAS-Token generiert, wie unter Shared Access Signature Authentication with Service Bus angegeben.
x-ms-version	2015-01

Anforderungstext

Die folgenden Patchvorgänge sind zulässig:

JSON-Patch Vorgang	Installationseigenschaft	Beschreibung und Beispiel
hinzufügen	PushChannel	Aktualisieren Sie den Kanal einer Installation. `[ { "op": "add", "path": "/pushChannel", "value": "aaaaaaa"} ]` Setzen Sie expiredPushChannel auf true, wenn pushChannel geändert wird.
hinzufügen	UserId	Aktualisieren oder Hinzufügen des Benutzer-ID-Werts. `[ { "op": "add", "path": "/userId", "value": "Bob"} ]`
hinzufügen	Tag	Wenn der Wert array ist, fügen Sie alle Tags im Array zu vorhandenen Tags hinzu (auch wenn sie nicht vorhanden sind). Wenn der Wert eine Zeichenfolge ist, fügen Sie dem aktuellen Array ein Tag hinzu (oder erstellen Sie ein neues Array mit einem einzelnen Wert, falls derzeit keine Tags vorhanden sind). `[ { "op": "add", "path": "/tags", "value": "tag"} ]`
hinzufügen	Vorlage (P2)	Aktualisieren oder Hinzufügen der gesamten Vorlage. `[ { "op": "add", "path": "/templates/myTemplate", "value": '{"body": "…", "tags": ["tag"]}'} ]`
hinzufügen	Vorlagentext/Header/Ablauf/Tags	Aktualisieren oder Hinzufügen von Teilen der Vorlage (beachten Sie, dass "hinzufügen" für Header das aktuelle Headerobjekt ersetzt). Add on-Tags haben dieselbe Semantik wie native Tags. `[ { "op": "add", "path": "/templates/myTemplate/body", "value": '{"aps": …}'} ]` `[ { "op": "add", "path": "/templates/myTemplate/headers", "value": '{"X-WNS-Type": "wns/toast"}'} ]`
hinzufügen	secondaryTile-Kanal	Updates den sekundärenTile-Kanal. `[ { "op": "add", "path": "/secondaryTiles/myTile/pushChannel", "value": "aaaaaaa"} ]`
hinzufügen	secondaryTile-Tag	Identisch mit der Aktualisierung von Tags, aber Pfad bezieht sich auf die sekundäre Kachel. `[ { "op": "add", "path": "/secondaryTiles/myTile/tags", "value": '["fooTag"]'} ]`
hinzufügen	secondaryTile-Vorlage	Identisch mit normalen Vorlagen, aber pfad bezieht sich auf tileId.
hinzufügen	secondaryTile template body/header/expiry/tags	Identisch mit normalen Vorlagen, aber pfad bezieht sich auf tileId.
Remove (Entfernen)	Wie oben.	Löscht eine Eigenschaft, z. B. userID, oder ein Element des Tagsarrays. Wenn das letzte Tag der Tags-Eigenschaft entfernt wird, wird die gesamte Eigenschaft entfernt. `[ { "op": "remove", "path": "/tags/myTag"} ]`
Replace	Wie oben.	Semantisch gleichbedeutend mit entfernen+hinzufügen.

Antwort

Die Antwort enthält den HTTP-Statuscode und einen Satz von Antwortheadern.

Antwortcodes

Code	BESCHREIBUNG
204	Die Installation wurde erfolgreich gepatcht.
400	Die Installation konnte nicht gepatcht werden, da die Anforderung fehlerhaft war.
401	Autorisierungsfehler Der Zugriffsschlüssel war falsch.
403	Kontingent überschritten; zu viele Registrierungen in diesem Namespace. Registrierung nicht erstellt.
403	Die Anforderung wurde abgelehnt, weil die API-Aufrufrate zu hoch ist.

Informationen zu status Codes finden Sie unter Status- und Fehlercodes.

Antwortheader

Antwortheader	BESCHREIBUNG
Inhaltstyp	`application/json-patch+json`
Content-Location	Der Speicherort der Installation im Format: `https://{namespace}.servicebus.windows.net/{NotificationHub}/installations/<installationId>`

Antworttext

Keine.

Weitere Informationen

Erstellen oder Überschreiben einer Installation
Lesen einer Installation
Löschen einer Installation

Freigeben über