Een installatie bijwerken

Artikel
05/26/2023

Azure Notification Hubs ondersteunt gedeeltelijke updates van een installatie met behulp van de JSON-Patch-standaard in RFC6902.

Aanvraag

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

Aanvraagheaders

In de volgende tabel worden vereiste en optionele aanvraagheaders beschreven.

Aanvraagheader	Beschrijving
Content-Type	`application/json-patch+json`
Autorisatie	SAS-token gegenereerd zoals opgegeven in Shared Access Signature Authentication met Service Bus.
x-ms-version	2015-01

Aanvraagbody

De volgende patchbewerkingen zijn toegestaan:

JSON-Patch bewerking	Installatie-eigenschap	Beschrijving en voorbeeld
add	PushChannel	Werk het kanaal van een installatie bij. `[ { "op": "add", "path": "/pushChannel", "value": "aaaaaaa"} ]` Zet verlopenPushChannel op true als pushChannel is gewijzigd.
add	UserId	Werk de waarde van de gebruikers-id bij of voeg deze toe. `[ { "op": "add", "path": "/userId", "value": "Bob"} ]`
add	Tag	Als waarde matrix is, voegt u alle tags in de matrix toe aan bestaande tags (zelfs als deze niet aanwezig zijn). Als waarde een tekenreeks is, voegt u een tag toe aan de huidige matrix (of maakt u een nieuwe matrix met één waarde, als er momenteel tags aanwezig zijn). `[ { "op": "add", "path": "/tags", "value": "tag"} ]`
add	Sjabloon (P2)	Werk de hele sjabloon bij of voeg deze toe. `[ { "op": "add", "path": "/templates/myTemplate", "value": '{"body": "…", "tags": ["tag"]}'} ]`
add	Hoofdtekst/koptekst/verloopdatum/tags van sjabloon	Onderdelen van de sjabloon bijwerken of toevoegen (houd er rekening mee dat 'toevoegen' aan headers het huidige headerobject vervangt). Add on tags heeft dezelfde semantiek als systeemeigen tags. `[ { "op": "add", "path": "/templates/myTemplate/body", "value": '{"aps": …}'} ]` `[ { "op": "add", "path": "/templates/myTemplate/headers", "value": '{"X-WNS-Type": "wns/toast"}'} ]`
add	secondaryTile-kanaal	Updates het kanaal secondaryTile. `[ { "op": "add", "path": "/secondaryTiles/myTile/pushChannel", "value": "aaaaaaa"} ]`
add	tag secondaryTile	Hetzelfde als tags worden bijgewerkt, maar het pad verwijst naar de secundaire tegel. `[ { "op": "add", "path": "/secondaryTiles/myTile/tags", "value": '["fooTag"]'} ]`
add	secondaryTile-sjabloon	Hetzelfde als normale sjablonen, maar het pad verwijst naar tileId.
add	secondaryTile-sjabloontekst/koptekst/verloop/tags	Hetzelfde als normale sjablonen, maar het pad verwijst naar tileId.
Verwijderen	Zoals hierboven	Hiermee verwijdert u een eigenschap, zoals userID, of een element van de tagsmatrix. Als de laatste tag van de eigenschap tags wordt verwijderd, wordt de hele eigenschap verwijderd. `[ { "op": "remove", "path": "/tags/myTag"} ]`
Vervangen	Zoals hierboven	Semantisch equivalent aan remove+add.

Antwoord

Het antwoord bevat een HTTP-statuscode en een set antwoordheaders.

Antwoordcodes

Code	Description
204	De installatie is gepatcht
400	De installatie kan niet worden gepatcht omdat de aanvraag onjuist is ingedeeld.
401	Autorisatiefout. De toegangssleutel is onjuist.
403	Quotum overschreden; te veel registraties in deze naamruimte. De registratie is niet gemaakt.
403	Aanvraag geweigerd omdat de API-aanroepsnelheid te hoog is.

Zie Status- en foutcodes voor meer informatie over statuscodes.

Antwoordheaders

Antwoordheader	Description
Inhoudstype	`application/json-patch+json`
Inhoudslocatie	De locatie van de installatie in de indeling: `https://{namespace}.servicebus.windows.net/{NotificationHub}/installations/<installationId>`

Hoofdtekst van de reactie

Geen.

Zie ook

Een installatie maken of overschrijven
Een installatie lezen
Een installatie verwijderen

Delen via