(0) exportieren Drucken
Alle erweitern

TPM OM-API: Anforderungs- und Antwortheader

Letzte Aktualisierung: November 2013

Mithilfe der TPM OM-API können Benutzer OData-basierte HTTP-Anforderungen senden, um TPM OM-Entitäten zu erstellen und Antworten im ausführlichen JSON-, Atom- und Pub- oder direktem XML-Format zu erhalten. Da die TPM OM-API den Entwurfsrichtlinien von Azure entspricht, ist ein Satz von erforderlichen HTTP-Headern, die von jedem Client beim Herstellen der Verbindung zum TPM OM-API-REST-Endpunkt verwendet werden müssen, sowie ein Satz optionaler Header verfügbar. In den folgenden Abschnitten werden die Header und HTTP-Verben beschrieben, die mit der TPM OM-API verwendet werden können.

Jeder Aufruf eines TPM OM-API-REST-Endpunkts muss einen Satz erforderlicher sowie bei Bedarf einen Satz optionaler Header umfassen. In der folgenden Tabelle werden die erforderlichen Header aufgelistet:

Erforderliche Header

 

Header Typ Wert

Autorisierung

WRAP ACS-Token

Der Wert muss den Zugriffstoken umfassen, der vom Zugriffssteuerung für Microsoft Azure Active Directory (auch Zugriffssteuerungsdienst oder ACS) bereitgestellt wird. Anweisungen zum Abrufen eines ACS-Tokens mithilfe des WRAP-Protokolls finden Sie unter http://msdn.microsoft.com/library/windowsazure/hh674475.aspx.

Host

String

Gibt den Host und die Portnummer der Zielressource an.

DataServiceVersion

Dezimal

1.0

MaxDataServiceVersion

Dezimal

3.0

x-ms-version

Dezimal

1.0

If-Match

Entitätstag

Gibt an, dass ein Vorgang nur ausgeführt wird, wenn das im Anforderungsheader angegebene Entitätstag mit dem Entitätstag des Objekts übereinstimmt.

noteHinweis
Dieser Header ist nur für Aktualisierungs- oder Löschvorgänge erforderlich.

noteHinweis
Da die TPM OM-API zum Offenlegen ihres zugrunde liegenden Ressourcenmetadatenrepositorys über REST-APIs "OData" verwendet, müssen die Header DataServiceVersion und MaxDataServiceVersion in sämtliche Anforderungen einbezogen werden. Andernfalls geht die TPM OM-API derzeit davon aus, dass der für DataServiceVersion verwendete Wert "1.0" ist.

Optionale Header

 

Header Typ Wert

Datum

RFC 1123 Date

Zeitstempel der Anforderung

Accept

Inhaltstyp

Der angeforderte Inhaltstyp für die Antwort. Beispiel:

  • application/xml

  • application/json;odata=verbose

  • application/atom+xml

Accept-Encoding

Gzip, deflate

GZIP- und DEFLATE-Codierung, falls zutreffend.

Accept-Language

"en", "es" usw.

Gibt die bevorzugte Sprache der Antwort an.

Accept-Charset

Ein Zeichensatztyp wie UTF-8.

Der Standardwert ist UTF-8.

X-HTTP-Method

HTTP-Methode

Gestattet es Clients oder Firewalls, die HTTP-Methoden wie PUT oder DELETE nicht unterstützen, diese Methoden zu verwenden, die über einen GET-Aufruf einbezogen werden.

Content-Type

Inhaltstyp

Der Inhaltstyp des Anforderungstexts in POST- und PUT-Anforderungen.

Nachfolgend ist ein Satz von Headern aufgeführt, die in Abhängigkeit von der angeforderten Ressource und der auszuführenden Aktion möglicherweise an Sie zurückgegeben werden.

 

Header Typ Wert

Datum

RFC 1123 Date

Das Datum, an dem die Anforderung verarbeitet wurde.

Content-Type

Variiert

Der Inhaltstyp des Antworttexts.

Content-Encoding

Variiert

Gzip oder deflate, nach Bedarf

Cache-Control

-

Gibt an, ob das Objekt von Cachemechanismen, von Server bis Client, zwischengespeichert wird.

Content-Length

Inhaltstyp

Die Länge des Antworttexts.

Server

-

Ein Servername.

X-Content-Type-Options

Inhaltstyp

Der einzige zulässige Wert "nonsniff" verhindert, dass Browser die MIME-Ermittlung für Antworten mit dem deklarierten Inhaltstyp ausführen.

Nachfolgend finden Sie eine vollständige Liste von HTTP-Verben, die von der TPM OM-API unterstützt werden und beim Erstellen von HTTP-Anforderungen verwendet werden können:

 

VERB Beschreibung

GET

Gibt den aktuellen Wert für eine Entität wieder.

POST

Erstellt auf Basis der bereitgestellten Daten ein Objekt (oder übermittelt einen Befehl).

PUT

Ersetzt ein Objekt oder erstellt ein neues Objekt (falls zutreffend).

DELETE

Löscht ein Objekt.

MERGE

Aktualisiert ein vorhandenes Objekt mit benannten Eigenschaftsänderungen.

Anzeigen:
© 2014 Microsoft