Anteckning
Åtkomst till den här sidan kräver auktorisering. Du kan prova att logga in eller ändra kataloger.
Åtkomst till den här sidan kräver auktorisering. Du kan prova att ändra kataloger.
Följande begärandehuvuden är gemensamma för alla uppgifter som du kan göra med SQL-API:et:
| Rubrik | Krävs | Typ | Beskrivning |
|---|---|---|---|
| auktorisering | Krävs | Sträng | Auktoriseringstoken för begäran. Mer information om hur du genererar en giltig auktoriseringstoken finns i Åtkomstkontroll på Cosmos DB-resurser |
| innehållstyp | Krävs (på PUT, PATCH och POST) | Sträng | För POST vid frågeåtgärder måste det vara program/query+json. För PATCH-åtgärder måste det vara application/json_patch+json. För bifogade filer måste vara inställt på Mime-typen för den bifogade filen. Mer information om Mime-typer finns i Skapa en bilaga För alla andra uppgifter måste vara application/json. |
| If-Match | Valfritt (gäller endast PUT och DELETE) | Sträng | Används för att villkora åtgärden för optimistisk samtidighet. Värdet ska vara resursens etag-värde. |
| If-None-Match | Valfritt (gäller endast på GET) | Sträng | Gör åtgärden villkorsstyrd för att endast köras om resursen har ändrats. Värdet ska vara resursens etag. |
| If-Modified-Since | Valfritt (gäller endast på GET) | Datum | Returnerar etag för resursen som ändrats efter angivet datum i RFC 1123-format. Ignoreras när If-None-Match anges |
| User-Agent | Valfri | Sträng | En sträng som anger klientanvändaragenten som utför begäran. Det rekommenderade formatet är {user agent name}/{version}. Till exempel anger det officiella SQL API .NET SDK User-Agent strängen till Microsoft.Document.Client/1.0.0.0. En anpassad användaragent kan likna ContosoMarketingApp/1.0.0. |
| x-ms-activity-id | Valfri | Sträng | En klient har angett identifierare för åtgärden, som upprepas i serversvaret. Det rekommenderade värdet är en unik identifierare. |
| x-ms-consistency-level | Valfri | Sträng | Åsidosättning på konsekvensnivå för läsalternativ mot dokument och bifogade filer. Giltiga värden är: Stark, Begränsad, Session eller Slutlig (i den ordning som är starkast till svagast). Åsidosättningen måste vara samma eller svagare än kontots konfigurerade konsekvensnivå. |
| x-ms-fortsättning | Valfri | Sträng | En strängtoken som returneras för frågor och läsflödesåtgärder om det finns fler resultat att läsa. Klienter kan hämta nästa sida med resultat genom att skicka begäran igen med rubriken x-ms-continuation request inställd på det här värdet. |
| x-ms-date | Krävs | Datum | Datum för begäran per RFC 1123-datumformat uttryckt i Coordinated Universal Time, till exempel Fre, 08 apr 2015 03:52:31 GMT. |
| x-ms-max-item-count | Valfri | Nummer | Ett heltal som anger det maximala antalet objekt som ska returneras per sida. Ett x-ms-max-item-count av -1 kan anges så att tjänsten kan fastställa det optimala antalet objekt. Det här är det rekommenderade konfigurationsvärdet för x-ms-max-item-count |
| x-ms-documentdb-partitionkey | Valfri | Samling | Partitionsnyckelvärdet för det begärda dokumentet eller den bifogade filen. Krävs för åtgärder mot dokument och bifogade filer när samlingsdefinitionen innehåller en partitionsnyckeldefinition. Det här värdet används för att begränsa frågan till dokument som matchar kriterierna för partitionsnyckeln. Avsiktligt är det en enskild partitionsfråga. Stöds i API-versionerna 2015-12-16 och senare. För närvarande stöder SQL-API:et en enda partitionsnyckel, så det här är en matris som bara innehåller ett värde. |
| x-ms-documentdb-query-enablecrosspartition | Valfri | Boolesk | När det här huvudet är inställt på true och om din fråga inte har någon partitionsnyckel, fläktar Azure Cosmos DB frågan över partitioner. Fläkten ut görs genom att utfärda enskilda frågor till alla partitioner. Om du vill läsa frågeresultaten bör klientprogrammen använda resultatet från FeedResponse och söka efter egenskapen ContinuationToken. Om du vill läsa alla resultat fortsätter du iterera på data tills ContinuationToken är null. |
| x-ms-session-token | Krävs (endast för sessionskonsekvens) | Sträng | En strängtoken som används med konsekvens på sessionsnivå. Mer information finns i Använda konsekvensnivåer i Cosmos DB- |
| x-ms-version | Krävs | Sträng | Versionen av Cosmos DB REST-tjänsten. En lista över API-versioner som stöds finns i REST API-referens för Azure Cosmos DB |
| A-IM | Valfri | Sträng | Anger en ändringsflöde begäran. Måste anges till "Inkrementell feed" eller utelämnas på annat sätt. |
| x-ms-documentdb-partitionkeyrangeid | Valfri | Nummer | Används i ändringsflöde begäranden. Partitionsnyckelns intervall-ID för att läsa data. |
| x-ms-cosmos-allow-tentative-writes | Valfri | Boolesk | När det här huvudet är inställt på sant för De Azure Cosmos-konton som konfigurerats med flera skrivplatser tillåter Azure Cosmos DB skrivningar till alla platser. Skrivbegäranden med värdet för det här huvudet inställt på false (eller om rubriken är frånvarande) misslyckas med 403 Svarsstatuskod med felmeddelandet "Skrivningar tillåts inte i regionen". |
Se även