Aktualizowanie instalacji

Usługa Azure Notification Hubs obsługuje częściowe aktualizacje instalacji przy użyciu standardu JSON-Patch w języku RFC6902.

Żądanie

Metoda	Identyfikator URI żądania	Wersja PROTOKOŁU HTTP
PATCH	https://{namespace}.servicebus.windows.net/{NotificationHub}/installations/{id}?api-version=2015-01	HTTP/1.1

Nagłówki żądań

W poniższej tabeli opisano wymagane i opcjonalne nagłówki żądań.

Nagłówek żądania	Opis
Content-Type	application/json-patch+json
Autoryzacja	Token sygnatury dostępu współdzielonego wygenerowany zgodnie z uwierzytelnianiem sygnatury dostępu współdzielonego za pomocą usługi Service Bus.
x-ms-version	2015-01

Treść żądania

Dozwolone są następujące operacje poprawek:

operacja JSON-Patch	Właściwość instalacji	Opis i przykład
add	PushChannel	Zaktualizuj kanał instalacji. [ { "op": "add", "path": "/pushChannel", "value": "aaaaaaa"} ] Umieść wartość expiredPushChannel na wartość true, jeśli zostanie zmieniona wartość pushChannel.
add	UserId	Zaktualizuj lub dodaj wartość identyfikatora użytkownika. [ { "op": "add", "path": "/userId", "value": "Bob"} ]
add	Tag	Jeśli wartość to tablica, dodaj wszystkie tagi w tablicy do istniejących tagów (nawet jeśli nie ma). Jeśli wartość jest ciągiem, dodaj tag do bieżącej tablicy (lub utwórz nową tablicę z pojedynczą wartością, jeśli nie są obecnie obecne tagi). [ { "op": "add", "path": "/tags", "value": "tag"} ]
add	Szablon (P2)	Zaktualizuj lub dodaj cały szablon. [ { "op": "add", "path": "/templates/myTemplate", "value": '{"body": "…", "tags": ["tag"]}'} ]
add	Treść szablonu/nagłówek/wygaśnięcie/tagi	Zaktualizuj lub dodaj części szablonu (zwróć uwagę, że element "add" w nagłówkach zastępuje bieżący obiekt nagłówków). Dodawanie tagów ma takie same semantyki jak tagi natywne. [ { "op": "add", "path": "/templates/myTemplate/body", "value": '{"aps": …}'} ] [ { "op": "add", "path": "/templates/myTemplate/headers", "value": '{"X-WNS-Type": "wns/toast"}'} ]
add	kanał secondaryTile	Aktualizacje kanału secondaryTile. [ { "op": "add", "path": "/secondaryTiles/myTile/pushChannel", "value": "aaaaaaa"} ]
add	secondaryTile tag	Tak samo jak aktualizacja tagów, ale ścieżka odwołuje się do pomocniczego kafelka. [ { "op": "add", "path": "/secondaryTiles/myTile/tags", "value": '["fooTag"]'} ]
add	szablon secondaryTile	Tak samo jak normalne szablony, ale ścieżka odnosi się do tileId.
add	pomocnicza treść szablonu/nagłówek/wygaśnięcie/tagi	Tak samo jak normalne szablony, ale ścieżka odnosi się do tileId.
Usuń	Jak powyżej	Usuwa właściwość, taką jak userID lub element tablicy tagów. Jeśli ostatni tag właściwości tags zostanie usunięty, zostanie usunięta cała właściwość. [ { "op": "remove", "path": "/tags/myTag"} ]
Zamień	Jak powyżej	Semantycznie równoważne do usuwania+dodawania.

Reakcja

Odpowiedź zawiera kod stanu HTTP i zestaw nagłówków odpowiedzi.

Kody odpowiedzi

Kod	Opis
204	Instalacja została pomyślnie poprawiona
400	Nie można zastosować poprawek instalacji, ponieważ żądanie zostało źle sformułowane.
401	Niepowodzenie autoryzacji. Klucz dostępu był niepoprawny.
403	Przekroczono limit przydziału; zbyt wiele rejestracji w tej przestrzeni nazw. Rejestracja nie została utworzona.
403	Żądanie odrzucone, ponieważ szybkość wywołań interfejsu API jest zbyt wysoka.

Aby uzyskać informacje o kodach stanu, zobacz Kody stanu i błędów.

Nagłówki odpowiedzi

Nagłówek odpowiedzi	Opis
Typ zawartości	application/json-patch+json
Lokalizacja zawartości	Lokalizacja instalacji w formacie: https://{namespace}.servicebus.windows.net/{NotificationHub}/installations/<installationId>

Treść odpowiedzi

Brak.

Zobacz też

Tworzenie lub zastępowanie instalacji
Odczytywanie instalacji
Usuwanie instalacji