Uppdatera en installation

Artikel
05/26/2023

Azure Notification Hubs stöder partiella uppdateringar av en installation med JSON-Patch standard i RFC6902.

Förfrågan

Metod	URI för förfrågan	HTTP-version
PATCH	`https://{namespace}.servicebus.windows.net/{NotificationHub}/installations/{id}?api-version=2015-01`	HTTP/1.1

Begärandehuvuden

I följande tabell beskrivs obligatoriska och valfria begärandehuvuden.

Begärandehuvud	Beskrivning
Content-Type	`application/json-patch+json`
Auktorisering	SAS-token genereras enligt vad som anges i Signaturautentisering för delad åtkomst med Service Bus.
x-ms-version	2015-01

Begärandetext

Följande korrigeringsåtgärder tillåts:

JSON-Patch åtgärd	Installationsegenskap	Beskrivning och exempel
add	PushChannel	Uppdatera kanalen för en installation. `[ { "op": "add", "path": "/pushChannel", "value": "aaaaaaa"} ]` Sätt expiredPushChannel till true om pushChannel ändras.
add	UserId	Uppdatera eller lägg till användar-ID-värde. `[ { "op": "add", "path": "/userId", "value": "Bob"} ]`
add	Tagg	Om värdet är matris lägger du till alla taggar i matrisen till befintliga taggar (även om de inte finns). Om värdet är en sträng lägger du till tagg i den aktuella matrisen (eller skapar en ny matris med ett enda värde, om inte taggar för närvarande finns). `[ { "op": "add", "path": "/tags", "value": "tag"} ]`
add	Mall (P2)	Uppdatera eller lägg till en hel mall. `[ { "op": "add", "path": "/templates/myTemplate", "value": '{"body": "…", "tags": ["tag"]}'} ]`
add	Malltext/sidhuvud/förfallodatum/taggar	Uppdatera eller lägg till delar av mallen (observera att "lägg till" i rubriker ersätter aktuellt rubrikobjekt). Lägg till taggar har samma semantik som interna taggar. `[ { "op": "add", "path": "/templates/myTemplate/body", "value": '{"aps": …}'} ]` `[ { "op": "add", "path": "/templates/myTemplate/headers", "value": '{"X-WNS-Type": "wns/toast"}'} ]`
add	secondaryTile-kanal	Uppdateringar den sekundäraTile-kanalen. `[ { "op": "add", "path": "/secondaryTiles/myTile/pushChannel", "value": "aaaaaaa"} ]`
add	secondaryTile-tagg	Samma som taggar uppdateras men sökvägen refererar till den sekundära panelen. `[ { "op": "add", "path": "/secondaryTiles/myTile/tags", "value": '["fooTag"]'} ]`
add	secondaryTile-mall	Samma som vanliga mallar men sökvägen refererar till tileId.
add	secondaryTile template body/header/expiry/tags	Samma som vanliga mallar men sökvägen refererar till tileId.
Ta bort	Som ovan	Tar bort en egenskap, till exempel userID, eller ett element i taggar-matrisen. Om den sista taggen för egenskapen tags tas bort tas hela egenskapen bort. `[ { "op": "remove", "path": "/tags/myTag"} ]`
Ersätt	Som ovan	Semantiskt likvärdigt med remove+add.

Svarsåtgärder

Svaret innehåller en HTTP-statuskod och en uppsättning svarshuvuden.

Svarskoder

Kod	Description
204	Installationen har korrigerats
400	Det gick inte att korrigera installationen eftersom begäran var felaktig.
401	Auktoriseringsfel. Åtkomstnyckeln var felaktig.
403	Kvoten har överskridits. för många registreringar i det här namnområdet. Registreringen har inte skapats.
403	Begäran avvisades eftersom API-anropsfrekvensen är för hög.

Information om statuskoder finns i Status och Felkoder.

Svarshuvuden

Svarsrubrik	Description
Innehållstyp	`application/json-patch+json`
Innehållsplats	Platsen för installationen i formatet: `https://{namespace}.servicebus.windows.net/{NotificationHub}/installations/<installationId>`

Själva svaret

Inga.

Se även

Skapa eller skriva över en installation
Läsa en installation
Ta bort en installation

Dela via