Erstellen oder Überschreiben einer InstallationCreate or overwrite an installation

Diese Methode erstellt oder überschreibt eine-Installation.This method creates or overwrites an installation.

AnforderungRequest

MethodeMethod Anforderungs-URIRequest URI HTTP-VersionHTTP version
PUTPUT https://{namespace}.servicebus.windows.net/{NotificationHub}/installations/{id}?api-version=2015-01 HTTP/1.1HTTP/1.1

AnforderungsheaderRequest headers

In der folgenden Tabelle werden erforderliche und optionale Anforderungsheader beschrieben.The following table describes required and optional request headers.

AnforderungsheaderRequest header BESCHREIBUNGDescription
Content-TypeContent-Type Anwendung/jsonapplication/json
AuthorizationAuthorization Das in Shared Access Signature Authentifizierung mit Service Bus angegebene Token oder Service Bus Authentifizierung und Autorisierung mit Microsoft Azure Active Directory Access Control (auch bekannt als Access Control Service oder ACS).Token generated as specified in Shared Access Signature Authentication with Service Bus, or Service Bus authentication and authorization with Microsoft Azure Active Directory Access Control (also known as Access Control Service or ACS).
x-ms-versionx-ms-version 2015-012015-01

AnforderungstextRequest body

In der folgenden Tabelle werden die Eigenschaften des JSON-Anforderungs Texts für Installationen beschrieben:The following table describes the properties of the JSON request body for installations:

NameName TypType ErforderlichRequired SchreibgeschütztRead-only BeschreibungDescription
installationIdinstallationId StringString JaYes NeinNo Global eindeutige BezeichnerzeichenfolgeGlobally unique identifier string
userIDuserID StringString NeinNo NeinNo Benutzerdefinierte Zeichenfolge, die eine Kombination aus alphanumerischen Zeichen und-_ @ #.: = \ enthält.Custom string containing a combination of alphanumeric characters and -_@#.:=. Zwischen der UserID und der Installations-ID besteht eine 1: n-Beziehung (d. h.There is a one to many relationship between UserID and Installation ID (i.e eine Benutzer-ID kann mehreren Installationen zugeordnet werden.)one User ID can be associated with multiple installations)
lastactiveonlastActiveOn StringString NeinNo JaYes Das Datum, an dem die Installation durch den PNS deaktiviert wurde.The date when the installation was made inactivate by the PNS.
expirationTimeexpirationTime StringString NeinNo JaYes Eine Zeichenfolge, die das Datum und die Uhrzeit in der W3C-DTF, yyyy-mm-ddThh: mmtzd (z. b. 1997-07-16t19:20 + 01:00)) enthält, in der die Registrierung abläuft.A string containing the date and time in W3C DTF, YYYY-MM-DDThh:mmTZD (for example, 1997-07-16T19:20+01:00)) in which the registration will expire. Der Wert kann bei CREATE oder Update auf der Hub-Ebene festgelegt werden und wird standardmäßig nie ablaufen (9999-12-31t23:59:59).The value can be set at the hub level on create or update, and will default to never expire (9999-12-31T23:59:59).
Last UpdatelastUpdate StringString Wird beim Aktualisieren ignoriert.Ignored when updating. Wird beim Lesen von zurückgegeben.Returned when reading. JaYes Datum im W3C-Format des letzten Updates dieser Installation.Date in W3C format of last update to this installation.
platformplatform StringString JaYes NeinNo Kann {APNs, WNS, mpns, ADM, GCM} sein.Can be {APNS, WNS, MPNS, ADM, GCM}.
pushchannelpushChannel StringString JaYes NeinNo Das PNS-Handle für diese Installation (im Falle von WNS der channelUri von applicationtile).The PNS handle for this installation (in case of WNS the ChannelUri of the ApplicationTile).
expiredpushchannelexpiredPushChannel BooleanBoolean Wird beim Aktualisieren ignoriert.Ignored when updating. Wird beim Lesen von zurückgegeben.Returned when reading. JaYes Dies trifft zu, wenn der PNS den Kanal abgelaufen ist.This is true if the PNS expired the channel.
tagstags Array von ZeichenfolgenArray of strings NeinNo NeinNo Ein Array von-Tags.An array of tags. Tags sind Zeichen folgen, die in den Hub-Spezifikationen definiert sind.Tags are strings as defined in hub specs.
Vorlagentemplates JSON-ObjektJSON object NeinNo NeinNo Ein JSON-Objekt, das ein Wörterbuch mit "templatenames" zur Vorlagen Beschreibung darstellt.A JSON object representing a dictionary of templateNames to template description.
betrachtet. Benennentemplates.{name} StringString NeinNo NeinNo JSON-Objekt, das eine Vorlage darstellt.JSON object representing a template.
betrachtet. {Name}. Texttemplates.{name}.body StringString Ja, wenn Vorlage vorhandenYes, if template present NeinNo Vorlage für den Textkörper der Benachrichtigungs Nutzlast.Template for the body of notification payload.
betrachtet. {Name}. Headertemplates.{name}.headers JSON-ObjektJSON object NeinNo. Kann nur vorhanden sein, wenn die Plattform WNS oder mpns ist.Can be present only if platform is WNS or MPNS. NeinNo JSON-Objekt, wobei jede Eigenschaft ein Header Name und value ein Vorlagen Ausdruck ist.JSON object where each property is a header name and value is a template expression.
betrachtet. {Name}. Ablauftemplates.{name}.expiry StringString NeinNo. Kann nur vorhanden sein, wenn die Plattform eine APNs-Plattform istCan be present only if platform is apns NeinNo Vorlagen Ausdruck, der im W3D Date-Format ausgewertet wird.Template expression evaluating in W3D date format.
betrachtet. {Name}. Tagstemplates.{name}.tags Array von ZeichenfolgenArray of strings NeinNo NeinNo Array von Tags für diese Vorlage.Array of tags for this template.
secondaryTilessecondaryTiles JSON-ObjektJSON object NeinNo. Kann nur vorhanden sein, wenn die Plattform WNS ist.Can be present only if platform is wns. NeinNo JSON-Objekt, das ein Wörterbuch mit tileid-und secondarytiles-Objekten enthält.JSON object containing a dictionary of tileId and secondaryTiles objects.
"secondarytile". {tileid}secondaryTile.{tileId} JSON-ObjektJSON object NeinNo NeinNo JSON-Objekt mit Push-Eigenschaften für sekundäre Kacheln.JSON object with push properties for secondary tiles.
"secondarytile". {tileid}. pushchannelsecondaryTile.{tileId}.pushChannel StringString Ja, wenn tileid vorhanden istYes, if tileId is present NeinNo ChannelUri für sekundäre Kachel.ChannelUri for secondary tile.
"secondarytile". {tileid}. TagssecondaryTile.{tileId}.tags Array von ZeichenfolgenArray of strings NeinNo NeinNo Tags für Native Benachrichtigungen an eine sekundäre Kachel.Tags for native notifications to secondary tile.
"secondarytile". {tileid}. VorlagensecondaryTile.{tileId}.templates JSON-ObjektJSON object NeinNo NeinNo Identisch mit der Eigenschaft "Vorlagen", jedoch für jede sekundäre Kachel.Same as templates property but for each secondary tile.

Beachten Sie folgende Punkte:Note the following points:

  • In JSON ist die Reihenfolge der Elemente nicht wichtig.In JSON, the order of elements is not important.
  • Der Vorlagen Text muss JSON für APNs, GCM, ADM sein.Template body has to be JSON for APNS, GCM, ADM.
  • Der Vorlagen Text muss XML für WNS und mpns sein (mit Ausnahme von RAW).Template body must be XML for WNS and MPNS (except when raw).
  • Vorlagen für WNS müssen einen X-WNS-Type-Header enthalten.Templates for WNS must include X-WNS-Type header.
  • Vorlagen für mpns müssen über kompatible Header verfügen, wie unter Senden von Pushbenachrichtigungen für Windows Phone 8angegeben.Templates for MPNS must have compatible headers as mentioned in Sending push notifications for Windows Phone 8.

Es folgen einige JSON-Beispiele.Some JSON examples follow.

Beispiel für die Registrierung bei APNs:Example to register with APNS:

{ 
    "installationId": "12234", 
    "userID": "MyAmazingUser",
    "tags": ["foo", "bar"], 
    "platform": "apns", 
    "pushChannel": "ABCDEF-123456-…" 
}  

Hinweis

Das Tags-Element ist optional.The Tags element is optional.

Beispiel für eine systemeigene Registrierung bei WNS, einschließlich einer Vorlage und ohne Tags:Example to register natively with WNS including a template and no tags:

{ 
    "installationId": "12234", 
    "userID": "MyAmazingUser",
    "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 Gerüst Auflistung von vielen möglichen ElementenA skeleton listing of many possible elements

{ 
    installationId: "", 
    userID: "",
    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"] 
                    } 
                } 
            } 
        }
}  

AntwortResponse

Die Antwort enthält den HTTP-Statuscode und einen Satz von Antwortheadern.The response includes an HTTP status code and a set of response headers.

Antwort CodesResponse codes

CodeCode BESCHREIBUNGDescription
200200 Die Installation wurde erfolgreich in die Warteschlange eingereiht und wird im Hintergrund verarbeitet.The installation was queued successfully and will be processed in the background..
400400 Die Installation konnte nicht erstellt/überschrieben werden, da die Anforderung falsch formatiert war.The installation could not be created/overwritten because the request was malformed.
401401 AutorisierungsfehlerAuthorization failure. Der Zugriffsschlüssel war falsch.The access key was incorrect.
403403 Zu viele Installationen in diesem Namespace: Installationen werden nicht erstellt.Too many installations in this namespace - Installations not created.

Weitere Informationen zu Statuscodes finden Sie unter Status-und Fehlercodes.For information about status codes, see Status and Error Codes.

AntwortheaderResponse headers

AntwortheaderResponse header BESCHREIBUNGDescription
InhaltstypContent-type Anwendung/jsonapplication/json
Content-LocationContent-Location Der Speicherort der Installation im folgenden Format: https://{namespace}.servicebus.windows.net/{NotificationHub}/installations/<installationId>The location of the installation in the format: https://{namespace}.servicebus.windows.net/{NotificationHub}/installations/<installationId>

AntworttextResponse body

Keine.None.

Weitere InformationenSee Also

Lesen einer InstallationRead an installation
Aktualisieren einer Installation anhand der Installations-IDUpdate an installation by Installation ID
Löschen einer InstallationDelete an installation