Yaygın Azure Cosmos DB REST isteği üst bilgileri
Aşağıdaki istek üst bilgileri, SQL API'siyle gerçekleştirdiğiniz tüm görevler için ortaktır:
| Üst bilgi | Gerekli | Tür | Description |
|---|---|---|---|
| Yetkilendirme | Gerekli | Dize | İsteğin yetkilendirme belirteci. Geçerli bir yetkilendirme belirteci oluşturma hakkında daha fazla bilgi için bkz. Cosmos DB Kaynakları'nda Access Control |
| İçerik Türü | Gerekli (PUT, PATCH ve POST'ta) | Dize | Sorgu işlemlerinde POST için application/query+json olmalıdır. PATCH işlemleri için application/json_patch+json olmalıdır. Ekler için, ekin Mime türüne ayarlanmalıdır. Mime türleri hakkında daha fazla bilgi için bkz. Ek Oluşturma Diğer tüm görevler için application/json olmalıdır. |
| If-Match | İsteğe bağlı (yalnızca PUT ve DELETE için geçerlidir) | Dize | İşlemi iyimser eşzamanlılık için koşullu hale getirmek için kullanılır. Değer, kaynağın etag değeri olmalıdır. |
| If-None-Match | İsteğe bağlı (yalnızca GET'de geçerlidir) | Dize | İşlemi yalnızca kaynak değiştirildiğinde yürütülecek şekilde koşullu hale getirir. Değer, kaynağın etag'i olmalıdır. |
| If-Modified-Since | İsteğe bağlı (yalnızca GET'de geçerlidir) | Tarih | RFC 1123 biçiminde belirtilen tarihten sonra değiştirilen kaynağın etag'ini döndürür. If-None-Match belirtildiğinde yoksayılır |
| Kullanıcı Aracısı | İsteğe Bağlı | Dize | İsteği gerçekleştiren istemci kullanıcı aracısını belirten bir dize. Önerilen biçim :{kullanıcı aracısı adı}/{version}. Örneğin, resmi SQL API .NET SDK'sı User-Agent dizesini Microsoft.Document.Client/1.0.0.0 olarak ayarlar. Özel kullanıcı aracısı ContosoMarketingApp/1.0.0 gibi bir şey olabilir. |
| x-ms-activity-id | İsteğe Bağlı | Dize | sunucu yanıtında yankılanan, işlem için bir istemci tarafından sağlanan tanımlayıcı. Önerilen değer benzersiz bir tanımlayıcıdır. |
| x-ms-consistency-level | İsteğe Bağlı | Dize | Belgelere ve eklere karşı okuma seçenekleri için tutarlılık düzeyi geçersiz kılınıyor. Geçerli değerler şunlardır: Strong, Bounded, Session veya Eventual (en güçlüden en zayıfa doğru). Geçersiz kılma, hesabın yapılandırılan tutarlılık düzeyinden aynı veya daha zayıf olmalıdır. |
| x-ms-continuation | İsteğe Bağlı | Dize | Okunacak daha fazla sonuç varsa sorgular ve okuma akışı işlemleri için döndürülen bir dize belirteci. İstemciler, x-ms-continuation istek üst bilgisi bu değere ayarlanmış isteği yeniden ileterek sonuçların sonraki sayfasını alabilir. |
| x-ms-date | Gerekli | Tarih | Rfc 1123 başına isteğin tarih biçimi Eşgüdümlü Evrensel Saat cinsinden ifade edilir, örneğin Cum, 08 Nis 2015 03:52:31 GMT. |
| x-ms-max-item-count | İsteğe Bağlı | Sayı | Sayfa başına döndürülecek en fazla öğe sayısını gösteren tamsayı. Hizmetin en uygun öğe sayısını belirlemesine izin vermek için -1 x-ms-max-item-count belirtilebilir. Bu, x-ms-max-item-count için önerilen yapılandırma değeridir |
| x-ms-documentdb-partitionkey | İsteğe Bağlı | Dizi | İstenen belge veya ek işlemi için bölüm anahtarı değeri. Koleksiyon tanımı bir bölüm anahtarı tanımı içerdiğinde belgelere ve eklere yönelik işlemler için gereklidir. Bu değer, sorgunuzun kapsamını bölüm anahtarı ölçütleriyle eşleşen belgelere göre ayarlamak için kullanılır. Tasarım gereği tek bir bölüm sorgusu olur. API 2015-12-16 ve daha yeni sürümlerde desteklenir. Şu anda SQL API'sinde tek bir bölüm anahtarı desteklendiğinden bu, yalnızca bir değer içeren bir dizidir. |
| x-ms-documentdb-query-enablecrosspartition | İsteğe Bağlı | Boole | Bu üst bilgi true olarak ayarlandığında ve sorgunuzun bölüm anahtarı yoksa Azure Cosmos DB sorguyu bölümler arasında destekler. Bu işlem, tüm bölümlere tek tek sorgular düzenlenerek gerçekleştirilir. Sorgu sonuçlarını okumak için istemci uygulamalarının FeedResponse sonuçlarını tüketmesi ve ContinuationToken özelliğini denetlemesi gerekir. Tüm sonuçları okumak için ContinuationToken null olana kadar verilerde yinelemeye devam edin. |
| x-ms-session-token | Gerekli (yalnızca oturum tutarlılığı için) | Dize | Oturum düzeyi tutarlılığı ile kullanılan dize belirteci. Daha fazla bilgi için bkz. Cosmos DB'de tutarlılık düzeylerini kullanma |
| x-ms-version | Gerekli | Dize | Cosmos DB REST hizmetinin sürümü. Desteklenen API sürümlerinin listesi için bkz. Azure Cosmos DB REST API Başvurusu |
| Anlık İleti | İsteğe Bağlı | Dize | Değişiklik akışı isteğini gösterir. "Artımlı akış" olarak ayarlanmalıdır veya aksi takdirde atlanmalıdır. |
| x-ms-documentdb-partitionkeyrangeid | İsteğe Bağlı | Sayı | Değişiklik akışı isteklerinde kullanılır. Verileri okumak için bölüm anahtarı aralığı kimliği. |
| x-ms-cosmos-allow-tentative-writes | İsteğe Bağlı | Boole | Bu üst bilgi, birden çok yazma konumuyla yapılandırılmış Azure Cosmos hesapları için true olarak ayarlandığında, Azure Cosmos DB tüm konumlara yazma işlemine izin verir. Bu üst bilgi değerinin false olarak ayarlandığı yazma istekleri (veya üst bilgi yoksa) 403 Yanıt Durumu koduyla "Bölgede yazmalara izin verilmiyor" hata iletisiyle başarısız olur. |
Ayrıca bkz.