Erstellen oder eine Installation überschreiben
Erstellt oder überschreibt eine Installation.
Anforderung
Methode |
Anforderungs-URI |
HTTP-Version |
|---|---|---|
PUT |
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 |
Autorisierung |
Gemäß der Shared Access Signature Authentifizierung mit generierte Token Servicebus, oder Servicebus Authentifizierung und Autorisierung über Zugriffssteuerung für Microsoft Azure Active Directory (auch Zugriffssteuerungsdienst oder ACS). |
x-ms-version |
2015-01 |
Anforderungstext
Die folgende Tabelle beschreibt die Eigenschaften des JSON-Anforderungstext für Installationen:
Name |
Typ |
Erforderlich |
Schreibgeschützt |
Beschreibung |
|---|---|---|---|---|
installationId |
"String" |
Ja |
Nein |
GUID-Zeichenfolge |
lastActiveOn |
"String" |
Nein |
Ja |
Dies ist das Datum, wann die Installation vom PNS vorgenommen wurde deaktiviert. |
expirationTime |
"String" |
Beim Aktualisieren werden ignoriert. Beim Lesen der zurückgegeben. |
Ja |
Dies ist eine Zeichenfolge, die das Datum und die Uhrzeit in W3C DTF, JJJJ-MM-TTThh: Mmtzd (z. B. 1997-07-16T19:20 + 01:00)) in der Registrierung abläuft. Der Benutzer kann diesen Wert nicht aktualisieren. Der Wert wird bei der Registrierung berechnet und in jedes Update aktualisiert werden, um jetzt () + -Wert der Systemeigenschaft (2 Jahre?). |
lastUpdate |
"String" |
Beim Aktualisieren werden ignoriert. Beim Lesen der zurückgegeben. |
Ja |
Das Datum im W3C-Format des letzten Updates für diese Installation. |
user |
"String" |
Nein |
Nein |
Dies ist der Benutzer, die diese Installation zugeordnet sind. |
advertisingId |
"String" |
Nein |
Nein |
Diese Eigenschaft wird verwendet, können Sie diese Registrierung AdvertisingIds zuordnen. |
appId |
"String" |
Nein |
Nein |
Diese Eigenschaft wird verwendet, um dieser Installation für eine bestimmte Anwendung zu bezeichnen. Verwendung: verfolgen Sie AdvertisingIds über alle apps hinweg. |
plattform |
"String" |
Ja |
Nein |
{Apns, Wns, Mpns, Adm, Gcm} werden können. |
pushChannel |
"String" |
Ja |
Nein |
Das PNS-handle für diese Installation (bei WNS-Kanal-URI von der ApplicationTile). |
expiredPushChannel |
Boolean |
Beim Aktualisieren werden ignoriert. Beim Lesen der zurückgegeben. |
Ja |
Dies ist True, wenn das PNS den Kanal abgelaufen. |
tags |
Array von Zeichenfolgen |
Nein |
Nein |
Ein Array von Tags. Tags sind Zeichenfolgen, wie in der Hub-Spezifikationen definiert. |
Vorlagen |
JSON-Objekt |
Nein |
Nein |
Ein JSON-Objekt, das ein Wörterbuch mit TemplateNames Beschreibung der Vorlage darstellt. |
Vorlagen. {Name} |
"String" |
Nein |
Nein |
JSON-Objekt, das eine Vorlage darstellt. |
Vorlagen. {Name} .body |
"String" |
Ja, wenn die Vorlage vorhanden |
Nein |
Vorlage für den Text der benachrichtigungsnutzlast. |
Vorlagen. {Name} .headers |
JSON-Objekt |
Nein. Kann nur bei einer Plattform Wns oder Mpns vorhanden sein. |
Nein |
JSON-Objekt, wobei jede Eigenschaft einen Namen und Wert ist, ist ein Vorlagenausdruck. |
Vorlagen. {Name} .expiry |
"String" |
Nein. Kann nur bei einer Plattform Apns vorhanden sein |
Nein |
Ein Vorlagenausdruck im W3D Datumsformat auswerten. |
Vorlagen. {Name} .tags |
Array von Zeichenfolgen |
Nein |
Nein |
Ein Array von Tags für diese Vorlage. |
secondaryTiles |
JSON-Objekt |
Nein. Kann nur bei einer Plattform Wns vorhanden sein. |
Nein |
JSON-Objekt, das ein Wörterbuch mit TileId und SecondaryTiles-Objekte enthält. |
"secondarytile". {TileId} |
JSON-Objekt |
Nein |
Nein |
JSON-Objekt mit der Push-Eigenschaften für sekundäre Kacheln. |
"secondarytile". {TileId} .pushChannel |
"String" |
Ja, wenn TileId vorhanden ist. |
Nein |
Kanal-URI für die sekundäre Kachel. |
"secondarytile". {TileId} .tags |
Array von Zeichenfolgen |
Nein |
Nein |
Tags für systemeigene Benachrichtigungen an sekundäre Kachel. |
"secondarytile". {TileId} .templates |
JSON-Objekt |
Nein |
Nein |
Identisch mit Vorlagen-Eigenschaft, aber für jede sekundäre Kachel. |
Die Reihenfolge der Elemente ist in JSON nicht wichtig.
Text der Vorlage muss JSON für APNS, GCM, ADM sein
Text der Vorlage muss XML für WNS und MPNS (außer wenn raw) sein.
Vorlagen für WNS müssen X-WNS-Type-Header enthalten.
Vorlagen für MPNS müssen kompatible Header, wie unter Senden von Pushbenachrichtigungen für Windows Phone 8.
Führen Sie die Beispiele für JSON.
Beispiel mit APNS zu registrieren:
{ "installationId": "12234", "tags": ["foo", "bar"], "platform": "apns", "pushChannel": "ABCDEF-123456-…" }
Hinweis
Die Tags Element ist optional.
Beispiel systemintern mit WNS, einschließlich einer Vorlage und keine Tags zu registrieren:
{ "installationId": "12234", "platform": "wns", "pushChannel": "https://db3...", "templates": { "myTemplate" : { body : '<toast><visual lang="en-US"><binding template="ToastTest01"><text id="1">$myTextProp1</text></binding></visual></tile>', headers: { "X-WNS-Type": "wns/toast" }, "tags": ["foo", "bar"] } } }
Eine Skelett Liste viele Elemente
{ installationId: "", expirationTime: "", tags: ["foo", "bar"], lastUpdate: “”, user: "", advertisingId: "", appId: "" platform: "", pushChannel: "", templates: { "templateName1" : { body: "", headers: { "X-WNS-Type": "wns/tile" }, expiration: "", tags: ["foo", "bar"] } } secondaryTiles: { "tileId1": { pushChannel: "", tags: ["foo", "bar"], templates: { "otherTemplate": { bodyTemplate: "", headers: { ... }, tags: ["foo"] } } } } }
Antwort
Die Antwort enthält den HTTP-Statuscode und einen Satz von Antwortheadern.
Antwortcodes
Code |
Beschreibung |
|---|---|
200 |
Die Installation wurde erfolgreich erstellt. |
400 |
Die Installation konnte nicht erstellt/überschrieben werden, da die Anforderung falsch formatiert war. |
401 |
Autorisierungsfehler Der Zugriffsschlüssel war falsch. |
403 |
Zu viele Installationen in diesem Namespace - Installationen nicht erstellt. |
403 |
Die Anforderung abgelehnt, da der API-Aufruf Rate zu hoch ist. |
Informationen zu Statuscodes finden Sie unter Status- und Fehlercodes.
Antwortheader
Antwortheader |
Beschreibung |
|---|---|
Content-type |
application/json |
Content-Location |
Der Speicherort der Installation im Format: https://{namespace}.servicebus.windows.net/{NotificationHub}/installations/<installationId> |
Antworttext
Keine.
Siehe auch
Lesen Sie die Installation
Aktualisieren Sie die Installation vom Installations-ID
Löschen Sie die Installation