Mettre à jour une installation

Article
05/26/2023

Azure Notification Hubs prend en charge les mises à jour partielles d’une installation à l’aide de la norme JSON-Patch dans RFC6902.

Requête

Méthode	URI de demande	Version HTTP
PATCH	`https://{namespace}.servicebus.windows.net/{NotificationHub}/installations/{id}?api-version=2015-01`	HTTP/1.1

En-têtes de requête

Le tableau suivant décrit les en-têtes de demande obligatoires ou facultatifs.

En-tête de requête	Description
Content-Type	`application/json-patch+json`
Autorisation	Jeton SAS généré comme spécifié dans Authentification par signature d’accès partagé avec Service Bus.
x-ms-version	2015-01

Corps de la demande

Les opérations correctives suivantes sont autorisées :

JSON-Patch opération	Installation, propriété	Description et exemple
ajouter	PushChannel	Mettez à jour le canal d’une installation. `[ { "op": "add", "path": "/pushChannel", "value": "aaaaaaa"} ]` Placez expiredPushChannel sur true si pushChannel est modifié.
ajouter	UserId	Mettez à jour ou ajoutez une valeur d’ID utilisateur. `[ { "op": "add", "path": "/userId", "value": "Bob"} ]`
ajouter	Tag	Si la valeur est un tableau, ajoutez toutes les balises du tableau aux balises existantes (même si elles ne sont pas présentes). Si la valeur est une chaîne, ajoutez une balise au tableau actuel (ou créez un tableau avec une valeur unique, si des balises ne sont pas présentes). `[ { "op": "add", "path": "/tags", "value": "tag"} ]`
ajouter	Modèle (P2)	Mettre à jour ou ajouter un modèle entier. `[ { "op": "add", "path": "/templates/myTemplate", "value": '{"body": "…", "tags": ["tag"]}'} ]`
ajouter	Corps/en-tête/expiration/balises du modèle	Mettez à jour ou ajoutez des parties du modèle (notez que « ajouter » sur les en-têtes remplace l’objet en-têtes actuel). Les balises d’ajout ont la même sémantique que les balises natives. `[ { "op": "add", "path": "/templates/myTemplate/body", "value": '{"aps": …}'} ]` `[ { "op": "add", "path": "/templates/myTemplate/headers", "value": '{"X-WNS-Type": "wns/toast"}'} ]`
ajouter	canal secondaryTile	Mises à jour le canal secondaryTile. `[ { "op": "add", "path": "/secondaryTiles/myTile/pushChannel", "value": "aaaaaaa"} ]`
ajouter	balise secondaryTile	Identique à la mise à jour des balises, mais le chemin fait référence à la vignette secondaire. `[ { "op": "add", "path": "/secondaryTiles/myTile/tags", "value": '["fooTag"]'} ]`
ajouter	modèle secondaryTile	Identique aux modèles normaux, mais le chemin fait référence à tileId.
ajouter	secondaryTile template body/header/expiry/tags	Identique aux modèles normaux, mais le chemin fait référence à tileId.
Supprimer	Identique à ce qui précède	Supprime une propriété, telle que userID, ou un élément du tableau de balises. Si la dernière balise de la propriété tags est supprimée, la propriété entière est supprimée. `[ { "op": "remove", "path": "/tags/myTag"} ]`
Replace	Identique à ce qui précède	Sémantiquement équivalent à remove+add.

response

La réponse inclut un code d'état HTTP et un ensemble d'en-têtes de réponse.

Codes de réponse

Code	Description
204	L’installation a été corrigée avec succès
400	L’installation n’a pas pu être corrigée, car la demande était incorrecte.
401	Échec de l'autorisation. La clé d’accès était incorrecte.
403	Quota dépassé ; trop d’inscriptions dans cet espace de noms. Inscription non créée.
403	Demande rejetée, car le taux d’appels d’API est trop élevé.

Pour plus d’informations sur les codes status, consultez Codes d’état et d’erreur.

En-têtes de réponse

En-tête de réponse	Description
Content-Type	`application/json-patch+json`
Content-Location	Emplacement de l’installation au format : `https://{namespace}.servicebus.windows.net/{NotificationHub}/installations/<installationId>`

Response body

Aucun.

Voir aussi

Créer ou remplacer une installation
Lire une installation
Supprimer une installation

Partager via