Jegyzet
Az oldalhoz való hozzáférés engedélyezést igényel. Próbálhatod be jelentkezni vagy könyvtárat váltani.
Az oldalhoz való hozzáférés engedélyezést igényel. Megpróbálhatod a könyvtár váltását.
A következő kérésfejlécek gyakoriak az SQL API-val elvégezhető összes feladatnál:
| Fejléc | Szükséges | Típus | Leírás |
|---|---|---|---|
| engedélyezési | Szükséges | Húr | A kérelem engedélyezési jogkivonata. Az érvényes engedélyezési jogkivonatok létrehozásával kapcsolatos további információkért lásd: Hozzáférés-vezérlés a Cosmos DB-erőforrásokon |
| tartalomtípusú | Kötelező (PUT, PATCH és POST rendszeren) | Húr | A lekérdezési műveletek post-jának application/query+jsonkell lennie. A PATCH-műveletekhez alkalmazásnak/json_patch+jsonkell lennie. Mellékletek esetében a melléklet Mime típusának kell lennie. További információ a Mime-típusokról: Melléklet létrehozása Minden más tevékenységhez alkalmazásnak/jsonnak kell lennie. |
| If-Match | Nem kötelező (csak PUT és DELETE esetén alkalmazható) | Húr | A művelet optimista egyidejűséghez való feltételessé tétele. Az értéknek az erőforrás etagértékének kell lennie. |
| Ha nincs egyezés | Nem kötelező (csak GET esetén alkalmazható) | Húr | A művelet feltételesen csak akkor hajtható végre, ha az erőforrás módosult. Az értéknek az erőforrás etagjének kell lennie. |
| If-Modified-Since | Nem kötelező (csak GET esetén alkalmazható) | Dátum | A megadott dátum után módosított erőforráscímkét adja vissza RFC 1123 formátumban. Figyelmen kívül hagyva, ha Nincs egyezés van megadva |
| user-agent | Szabadon választható | Húr | A kérést végrehajtó ügyfél-felhasználói ügynököt meghatározó sztring. A javasolt formátum a következő: {user agent name}/{version}. A hivatalos SQL API .NET SDK például a User-Agent sztringet Microsoft.Document.Client/1.0.0.0 értékre állítja. Az egyéni felhasználói ügynök a ContosoMarketingApp/1.0.0-hoz hasonló lehet. |
| x-ms-activity-id | Szabadon választható | Húr | Egy ügyfél által megadott azonosító a művelethez, amelyet a kiszolgáló válasza visszhangzik. A javasolt érték egy egyedi azonosító. |
| x-ms-konzisztenciaszintű | Szabadon választható | Húr | A dokumentumok és mellékletek olvasási beállításainak konzisztenciaszint-felülbírálása. Az érvényes értékek a következők: Erős, Határolt, Munkamenet vagy Végleges (a legerősebb és a leggyengébb sorrendben). A felülbírálásnak azonosnak vagy gyengébbnek kell lennie, mint a fiók konzisztenciaszintje. |
| x-ms-folytatási | Szabadon választható | Húr | A lekérdezésekhez és az olvasási hírcsatorna műveleteihez visszaadott sztring jogkivonat, ha több eredményt kell olvasni. Az ügyfelek lekérhetik a következő eredményoldalt úgy, hogy újra beküldik a kérést az x-ms-folytatási kérelem fejlécének erre az értékre van állítva. |
| x-ms-date | Szükséges | Dátum | A kérelem dátuma RFC 1123 dátumformátumban kifejezve, például 2015. ápr. 08. p., 03:52:31 GMT. |
| x-ms-max-item-count | Szabadon választható | Szám | Egész szám, amely az oldalonként visszaadandó elemek maximális számát jelzi. Megadhatja a -1 x-ms-max-item-count értékét, hogy a szolgáltatás meghatározhassa az optimális elemszámot. Ez az x-ms-max-item-count ajánlott konfigurációs értéke |
| x-ms-documentdb-partitionkey | Szabadon választható | Tömb | A kért dokumentum- vagy mellékletművelet partíciókulcs-értéke. A dokumentumok és mellékletek műveleteihez szükséges, ha a gyűjteménydefiníció tartalmaz partíciókulcs-definíciót. Ez az érték a lekérdezés olyan dokumentumokra való hatókörének meghatározására szolgál, amelyek megfelelnek a partíciókulcs feltételeinek. Tervezés szerint ez egy partíciós lekérdezés. Az API 2015-12-16-os és újabb verzióiban támogatott. Az SQL API jelenleg egyetlen partíciókulcsot támogat, ezért ez egy tömb, amely csak egy értéket tartalmaz. |
| x-ms-documentdb-query-enablecrosspartition | Szabadon választható | Logikai | Ha ez a fejléc igaz értékre van állítva, és ha a lekérdezés nem rendelkezik partíciókulcskal, az Azure Cosmos DB támogatja a lekérdezést a partíciók között. A ventilátor ki van bocsátva azáltal, hogy egyedi lekérdezéseket ad ki az összes partícióra. A lekérdezési eredmények olvasásához az ügyfélalkalmazásoknak fel kell használniuk a FeedResponse eredményeit, és ellenőrizni kell a ContinuationToken tulajdonságot. Az összes eredmény elolvasásához folytassa az iterálást az adatokon, amíg a ContinuationToken értéke null nem lesz. |
| x-ms-session-token | Kötelező (csak munkamenet-konzisztencia esetén) | Húr | Munkamenetszintű konzisztenciával használt sztring jogkivonat. További információ: Konzisztenciaszintek használata a Cosmos DB |
| x-ms-version | Szükséges | Húr | A Cosmos DB REST szolgáltatás verziója. A támogatott API-verziók listáját az Azure Cosmos DB REST API-referencia |
| A-Csevegő | Szabadon választható | Húr | változáscsatorna kérést jelez. A "Növekményes hírcsatorna" értékre kell állítani, vagy másként nem adható meg. |
| x-ms-documentdb-partitionkeyrangeid | Szabadon választható | Szám | változáscsatorna kérésekben használatos. A partíciókulcs tartományazonosítója az adatok olvasásához. |
| x-ms-cosmos-allow-tentative-writes | Szabadon választható | Logikai | Ha ez a fejléc igaz értékre van állítva a több írási hellyel konfigurált Azure Cosmos-fiókok esetében, az Azure Cosmos DB minden helyre engedélyezi az írást. Ha a fejléc értéke hamis (vagy ha a fejléc hiányzik), a 403 válaszállapot-kód meghiúsul, és a következő hibaüzenet jelenik meg: "Az írások nem engedélyezettek a régióban". |
Lásd még: