Allgemeine Azure Cosmos DB-REST-Anforderungsheader
Die folgenden Anforderungsheader sind allen Aufgaben gemeinsam, die Sie möglicherweise mit der SQL-API ausführen:
| Header | Erforderlich | type | BESCHREIBUNG |
|---|---|---|---|
| Autorisierung | Erforderlich | String | Das Autorisierungstoken für die Anforderung. Weitere Informationen zum Generieren eines gültigen Autorisierungstokens finden Sie unter Access Control in Cosmos DB-Ressourcen. |
| Content-Type | Erforderlich (für PUT, PATCH und POST) | String | Für POST in Abfragevorgängen muss es sich um application/query+json handeln. Für PATCH-Vorgänge muss es sich um application/json_patch+json handeln. Für Anlagen muss auf den Mime-Typ der Anlage festgelegt werden. Weitere Informationen zu Mimetypen finden Sie unter Erstellen einer Anlage. Für alle anderen Aufgaben muss application/json angegeben sein. |
| If-Match | Optional (gilt nur für PUT und DELETE) | String | Wird verwendet, um den Vorgang für eine optimistische Parallelität bedingt zu machen. Der Wert sollte der etag-Wert der Ressource sein. |
| If-None-Match | Optional (gilt nur für GET) | String | Bedingt, dass der Vorgang nur ausgeführt wird, wenn sich die Ressource geändert hat. Der Wert sollte das Etag der Ressource sein. |
| If-Modified-Since | Optional (gilt nur für GET) | Date | Gibt das etag der Ressource zurück, die nach dem angegebenen Datum im RFC 1123-Format geändert wurde. Wird ignoriert, wenn If-None-Match angegeben ist |
| User-Agent | Optional | String | Eine Zeichenfolge, die den Client-Benutzer-Agent angibt, der die Anforderung ausführt. Das empfohlene Format ist {user agent name}/{version}. Beispielsweise legt das offizielle .NET SDK der SQL-API die User-Agent Zeichenfolge auf Microsoft.Document.Client/1.0.0.0.0 fest. Ein benutzerdefinierter Benutzer-Agent kann etwa ContosoMarketingApp/1.0.0 sein. |
| x-ms-activity-id | Optional | String | Ein vom Client bereitgestellter Bezeichner für den Vorgang, der in der Serverantwort wiedergegeben wird. Der empfohlene Wert ist ein eindeutiger Bezeichner. |
| x-ms-consistency-level | Optional | String | Die Überschreibung der Konsistenzebene für Leseoptionen für Dokumente und Anlagen. Die gültigen Werte sind: Strong, Bounded, Session oder Eventual (in der Reihenfolge von stärkstem bis schwächstem Wert). Die Überschreibung muss identisch oder schwächer als die konfigurierte Konsistenzebene des Kontos sein. |
| x-ms-continuation | Optional | String | Ein Zeichenfolgentoken, das für Abfragen und Lesefeedvorgänge zurückgegeben wird, wenn weitere Ergebnisse gelesen werden müssen. Clients können die nächste Seite der Ergebnisse abrufen, indem sie die Anforderung erneut mit dem Header x-ms-continuation request übermitteln, der auf diesen Wert festgelegt ist. |
| x-ms-date | Erforderlich | Date | Das Datum der Anforderung pro RFC 1123-Datumsformat, ausgedrückt in koordinierter Weltzeit, z. B. Fr, 08 Apr 2015 03:52:31 GMT. |
| x-ms-max-item-count | Optional | Number | Eine ganze Zahl, die die maximale Anzahl von Elementen angibt, die pro Seite zurückgegeben werden sollen. Es kann eine x-ms-max-item-count von -1 angegeben werden, damit der Dienst die optimale Elementanzahl bestimmen kann. Dies ist der empfohlene Konfigurationswert für x-ms-max-item-count. |
| x-ms-documentdb-partitionkey | Optional | Array | Der Partitionsschlüsselwert für den angeforderten Dokument- oder Anlagevorgang. Erforderlich für Vorgänge für Dokumente und Anlagen, wenn die Auflistungsdefinition eine Partitionsschlüsseldefinition enthält. Dieser Wert wird verwendet, um Ihre Abfrage auf Dokumente einzugrenzen, die den Partitionsschlüsselkriterien entsprechen. Standardmäßig handelt es sich um eine einzelne Partitionsabfrage. Unterstützt in API-Versionen 2015-12-16 und höher. Derzeit unterstützt die SQL-API einen einzelnen Partitionsschlüssel, sodass es sich um ein Array handelt, das nur einen Wert enthält. |
| x-ms-documentdb-query-enablecrosspartition | Optional | Boolean | Wenn dieser Header auf "true" festgelegt ist und Ihre Abfrage keinen Partitionsschlüssel aufweist, wird die Abfrage von Azure Cosmos DB partitionsübergreifend verteilt. Für die Verteilung werden einzelne Abfragen an alle Partitionen gerichtet. Zum Lesen der Abfrageergebnisse müssen die Clientanwendungen die Ergebnisse aus „FeedResponse“ auf die Eigenschaft „ContinuationToken“ überprüfen. Um alle Ergebnisse zu lesen, durchlaufen Sie die Daten so lange, bis „ContinuationToken“ NULL ist. |
| x-ms-session-token | Erforderlich (nur für Sitzungskonsistenz) | String | Ein Zeichenfolgentoken, das mit Konsistenz auf Sitzungsebene verwendet wird. Weitere Informationen finden Sie unter Verwenden von Konsistenzebenen in Cosmos DB |
| x-ms-version | Erforderlich | String | Die Version des Cosmos DB-REST-Diensts. Eine Liste der unterstützten API-Versionen finden Sie in der Azure Cosmos DB-REST-API-Referenz. |
| A-Chat | Optional | String | Gibt eine Änderungsfeedanforderung an. Muss auf "Inkrementeller Feed" festgelegt oder andernfalls weggelassen werden. |
| x-ms-documentdb-partitionkeyrangeid | Optional | Number | Wird in Änderungsfeedanforderungen verwendet . Die ID des Partitionsschlüsselbereichs zum Lesen von Daten. |
| x-ms-cosmos-allow-tentative-writes | Optional | Boolean | Wenn dieser Header für die Mit mehreren Schreibspeicherorten konfigurierten Azure Cosmos-Konten auf true festgelegt ist, lässt Azure Cosmos DB Schreibvorgänge an allen Speicherorten zu. Schreibanforderungen mit dem Wert dieses Headers, der auf false festgelegt ist (oder wenn der Header nicht vorhanden ist), schlagen mit dem Antwortstatuscode 403 mit der Fehlermeldung "Schreibvorgänge sind in der Region nicht zulässig" fehl. |
Weitere Informationen