Algemene Azure Cosmos DB REST-aanvraagheaders
De volgende aanvraagheaders zijn gebruikelijk voor alle taken die u kunt uitvoeren met de SQL-API:
| Rubriek | Vereist | Type | Beschrijving |
|---|---|---|---|
| autorisatie- | Vereist | Snaar | Het autorisatietoken voor de aanvraag. Zie Toegangsbeheer op Cosmos DB-resources voor meer informatie over het genereren van een geldig autorisatietoken |
| inhoudstype | Vereist (op PUT, PATCH en POST) | Snaar | Voor POST bij querybewerkingen moet deze zijn application/query+json. Voor PATCH-bewerkingen moet deze application/json_patch+json-zijn. Voor bijlagen moet worden ingesteld op het Mime-type van de bijlage. Zie Een bijlage maken voor meer informatie over Mime-typen Voor alle andere taken moet toepassing/json zijn. |
| If-Match- | Optioneel (alleen van toepassing op PUT en DELETE) | Snaar | Wordt gebruikt om bewerking voorwaardelijk te maken voor optimistische gelijktijdigheid. De waarde moet de etag-waarde van de resource zijn. |
| If-None-Match- | Optioneel (alleen van toepassing op GET) | Snaar | Maakt de bewerking voorwaardelijk om alleen uit te voeren als de resource is gewijzigd. De waarde moet de etag van de resource zijn. |
| If-Modified-Since | Optioneel (alleen van toepassing op GET) | Datum | Retourneert de etag van de resource die is gewijzigd na de opgegeven datum in RFC 1123-indeling. Genegeerd wanneer If-None-Match- is opgegeven |
| user-agent- | Facultatief | Snaar | Een tekenreeks die de clientgebruikersagent opgeeft die de aanvraag uitvoert. De aanbevolen indeling is {user agent name}/{version}. De officiële SQL API .NET SDK stelt bijvoorbeeld de User-Agent tekenreeks in op Microsoft.Document.Client/1.0.0.0. Een aangepaste gebruikersagent kan bijvoorbeeld ContosoMarketingApp/1.0.0 zijn. |
| x-ms-activity-id | Facultatief | Snaar | Een client opgegeven id voor de bewerking, die wordt herhaald in het serverantwoord. De aanbevolen waarde is een unieke id. |
| x-ms-consistentieniveau | Facultatief | Snaar | Het consistentieniveau overschrijven voor leesopties voor documenten en bijlagen. De geldige waarden zijn: Sterk, Gebonden, Sessie of Uiteindelijk (in volgorde van sterkste naar zwakste). De onderdrukking moet hetzelfde of zwakker zijn dan het geconfigureerde consistentieniveau van het account. |
| x-ms-vervolg | Facultatief | Snaar | Een tekenreekstoken dat wordt geretourneerd voor query's en leesfeedbewerkingen als er meer resultaten moeten worden gelezen. Clients kunnen de volgende pagina met resultaten ophalen door de aanvraag opnieuw in te dienen met de aanvraagheader x-ms-continuation die is ingesteld op deze waarde. |
| x-ms-date | Vereist | Datum | De datum van de aanvraag per RFC 1123-datumnotatie uitgedrukt in Coordinated Universal Time, bijvoorbeeld vr, 08 apr 2015 03:52:31 GMT. |
| x-ms-max-item-count | Facultatief | Getal | Een geheel getal dat het maximum aantal items aangeeft dat per pagina moet worden geretourneerd. Een x-ms-max-item-count van -1 kan worden opgegeven om de service het optimale aantal items te laten bepalen. Dit is de aanbevolen configuratiewaarde voor x-ms-max-item-count |
| x-ms-documentdb-partitionkey | Facultatief | Array | De partitiesleutelwaarde voor de aangevraagde document- of bijlagebewerking. Vereist voor bewerkingen op documenten en bijlagen wanneer de verzamelingsdefinitie een partitiesleuteldefinitie bevat. Deze waarde wordt gebruikt om uw query te bepalen op documenten die voldoen aan de criteria voor de partitiesleutel. Het is standaard één partitiequery. Ondersteund in API-versies 2015-12-16 en hoger. Momenteel ondersteunt de SQL-API één partitiesleutel, dus dit is een matrix met slechts één waarde. |
| x-ms-documentdb-query-enablecrosspartition | Facultatief | Booleaans | Wanneer deze header is ingesteld op true en als uw query geen partitiesleutel heeft, wordt de query door Azure Cosmos DB uitgezet op meerdere partities. De uitwaaier wordt uitgevoerd door afzonderlijke query's uit te voeren op alle partities. Als u de queryresultaten wilt lezen, moeten de clienttoepassingen de resultaten van feedresponse gebruiken en controleren op de eigenschap ContinuationToken. Als u alle resultaten wilt lezen, blijft u herhalen op de gegevens totdat het ContinuationToken null is. |
| x-ms-session-token | Vereist (alleen voor sessieconsistentie) | Snaar | Een tekenreekstoken dat wordt gebruikt met consistentie op sessieniveau. Zie voor meer informatie Consistentieniveaus gebruiken in Cosmos DB |
| x-ms-versie | Vereist | Snaar | De versie van de Cosmos DB REST-service. Zie Azure Cosmos DB REST API Reference voor een lijst met ondersteunde API-versies |
| A-IM- | Facultatief | Snaar | Geeft een wijzigingsfeed aanvraag aan. Moet worden ingesteld op 'Incrementele feed' of anders worden weggelaten. |
| x-ms-documentdb-partitionkeyrangeid | Facultatief | Getal | Wordt gebruikt in wijzigingenfeed aanvragen. De bereik-id van de partitiesleutel voor het lezen van gegevens. |
| x-ms-cosmos-allow-tentative-writes | Facultatief | Booleaans | Wanneer deze header is ingesteld op waar voor de Azure Cosmos-accounts die zijn geconfigureerd met meerdere schrijflocaties, staat Azure Cosmos DB schrijfbewerkingen naar alle locaties toe. Schrijfaanvragen met de waarde van deze header ingesteld op false (of als de header afwezig is) mislukt met de 403-antwoordstatuscode met het foutbericht 'Schrijfbewerkingen zijn niet toegestaan in de regio'. |
Zie ook