Creare o sovrascrivere un'installazione

Articolo
06/08/2016

Crea o sovrascrive l'installazione.

Richiesta

Metodo	URI della richiesta	Versione HTTP
PUT	https://{Namespace}.ServiceBus.Windows.NET/{NotificationHub}/Installations/{ID}?API-Version=2015-01	HTTP/1.1

Intestazioni della richiesta

Nella tabella seguente vengono descritte le intestazioni di richiesta obbligatorie e facoltative.

Intestazione della richiesta	Descrizione
Tipo di contenuto	applicazione/json
Autorizzazione	Token generato come specificato nell'autenticazione della firma di accesso condiviso con Bus di servizio, o Bus di servizio autenticazione e autorizzazione con Microsoft Azure Active Directory Access Control (anche noto come Servizio di controllo di accesso o ACS).
x-ms-version	2015-01

Corpo della richiesta

Nella tabella seguente vengono descritte le proprietà del corpo della richiesta JSON per le installazioni:

Nome	Tipo	Richiesto	Sola lettura	Descrizione
ID di installazione	Stringa	Sì	No	Stringa dell'identificatore univoco globale
lastActiveOn	Stringa	No	Sì	Si tratta della data quando l'installazione è stata effettuata disattiva il PNS.
expirationTime	Stringa	No	Sì	Questa è una stringa contenente la data e ora in W3C DTF, aaaa-MM-Mmtzd (ad esempio 1997-07-16T19:20+01:00)) in cui scadrà la registrazione. Il valore può essere impostato a livello di hub nella creazione o l'aggiornamento e verrà predefinito che non scada (9999-12-31T23:59:59).
lastUpdate	Stringa	Ignorato durante l'aggiornamento. Restituito durante la lettura.	Sì	Data in formato W3C dell'ultimo aggiornamento di questa installazione.
piattaforma	Stringa	Sì	No	Può essere {APN, wns, mpns, adm, gcm}.
pushChannel	Stringa	Sì	No	Handle PNS per l'installazione (nel caso il valore di ChannelUri di ApplicationTile WNS).
expiredPushChannel	Valore booleano	Ignorato durante l'aggiornamento. Restituito durante la lettura.	Sì	Ciò è vero se il PNS scaduto il canale.
tag	Matrice di stringhe	No	No	Matrice di tag. I tag sono stringhe definite nelle specifiche di hub.
modelli	Oggetto JSON	No	No	Un oggetto JSON che rappresenta un dizionario di templateNames per la descrizione del modello.
modelli. {nome}	Stringa	No	No	Oggetto JSON che rappresenta un modello.
modelli. {nome} .body	Stringa	Sì, se presenta modello	No	Modello per il corpo del payload di notifica.
modelli. {nome} .headers	Oggetto JSON	No. Può essere presente solo se la piattaforma è wns o mpns.	No	Oggetto JSON in cui ogni proprietà è un nome di intestazione e il valore è un'espressione di modello.
modelli. {nome} .expiry	Stringa	No. Può essere presente solo se la piattaforma è apns	No	La valutazione in formato di data W3D espressione del modello.
modelli. {nome} .tags	Matrice di stringhe	No	No	Matrice di tag per questo modello.
secondaryTiles	Oggetto JSON	No. Può essere presente solo se la piattaforma è wns.	No	Oggetto JSON contenente un dizionario di oggetti secondaryTiles e ID di riquadro.
secondaryTile. {ID di riquadro}	Oggetto JSON	No	No	Oggetto JSON con le proprietà di push per i riquadri secondari.
secondaryTile. {ID di riquadro} .pushChannel	Stringa	Sì, se sono presenti ID di riquadro	No	Valore di ChannelUri per riquadro secondario.
secondaryTile. {ID di riquadro} .tags	Matrice di stringhe	No	No	Tag per le notifiche native al riquadro secondario.
secondaryTile. {ID di riquadro} .templates	Oggetto JSON	No	No	Uguale alla proprietà modelli ma per ogni riquadro secondario.

In JSON, l'ordine degli elementi non è importante.
Corpo del modello deve essere JSON per APNS, GCM e ADM.
Corpo del modello deve essere XML per WNS e MPNS (salvo che quando non elaborati).
Modelli per WNS devono includere l'intestazione X-WNS-Type.
Modelli per MPNS devono avere intestazioni compatibile come indicato l'invio di notifiche push per Windows Phone 8.

Alcuni esempi di JSON.

Esempio per la registrazione con il servizio APN:

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

Nota

Il Tags elemento è facoltativo.

Esempio di registrare in modo nativo con WNS incluso un modello e senza tag:

{ 
    "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"] 
            } 

        } 
}

Un elenco struttura di molti elementi possibili

{ 
    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"] 
                    } 
                } 
            } 
        }
}

Risposta

La risposta include un codice di stato HTTP e un set di intestazioni di risposta.

Codici di risposta

Codice	Descrizione
200	L'installazione è stato creato correttamente.
400	L'installazione potrebbe non creato o sovrascritto in quanto la richiesta non è corretto.
401	Errore di autorizzazione. La chiave di accesso non è corretta.
403	Troppi le installazioni in questo spazio dei nomi, le installazioni non create.
403	Richiesta rifiutata perché è troppo elevata frequenza di chiamata API.

Per informazioni sui codici di stato, vedere stato e codici di errore.

Intestazioni di risposta

Intestazione della risposta	Descrizione
Tipo di contenuto	applicazione/json
Percorso contenuto	Il percorso di installazione nel formato: https://{namespace}.servicebus.windows.net/{NotificationHub}/installations/<installationId>

Tipo di contenuto

applicazione/json

Percorso contenuto

Il percorso di installazione nel formato:

https://{namespace}.servicebus.windows.net/{NotificationHub}/installations/<installationId>

Corpo della risposta

Nessuno.

Vedere anche

Installazione di lettura
ID di installazione per installazione aggiornamento
Eliminare l'installazione

Condividi tramite