Yaygın Azure Cosmos DB REST isteği üst bilgileri
Aşağıdaki istek üst bilgileri, SQL API'siyle yapabileceğiniz tüm görevler için ortaktır:
| Üstbilgi | Gerekli | Tür | Açıklama |
|---|---|---|---|
| Yetkilendirme | Gerekli | Dizgi | İstek için yetkilendirme belirteci. Geçerli bir yetkilendirme belirteci oluşturma hakkında daha fazla bilgi için bkz. Cosmos DB Kaynakları Erişim Denetimi |
| İçerik Türü | Gerekli (PUT, PATCH ve POST'ta) | Dizgi | Sorgu işlemlerinde POST için application/query+json olmalıdır. PATCH işlemleri için application/json_patch+jsonolmalı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. |
| Eşleşme | İsteğe bağlı (yalnızca PUT ve DELETE için geçerlidir) | Dizgi | İş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. |
| Eşleşmediyse | İsteğe bağlı (yalnızca GET'de geçerlidir) | Dizgi | İş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. |
| Beri Değiştirildiyse | İ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. Eşleşme yoksay belirtildiğinde yoksayılır |
| Kullanıcı Aracısı | Opsiyonel | Dizgi | İsteği gerçekleştiren istemci kullanıcı aracısını belirten bir dize. Önerilen biçim :{user agent name}/{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 | Opsiyonel | Dizgi | 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 düzeyi | Opsiyonel | Dizgi | Tutarlılık düzeyi, belgeler ve eklerde okuma seçenekleri için geçersiz kılar. 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ılmış tutarlılık düzeyinden aynı veya daha zayıf olmalıdır. |
| x-ms-continuation | Opsiyonel | Dizgi | Okunacak daha fazla sonuç varsa sorgular ve okuma akışı işlemleri için döndürülen 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 ile ifade edilir; örneğin, Cum, 08 Nis 2015 03:52:31 GMT. |
| x-ms-max-item-count | Opsiyonel | 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 | Opsiyonel | 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 | Opsiyonel | Boolean | Bu üst bilgi true olarak ayarlandığında ve sorgunuzda bölüm anahtarı yoksa Azure Cosmos DB sorguyu bölümler arasında destekler. Tüm bölümlere tek tek sorgular düzenlenerek çıkış yapılır. Sorgu sonuçlarını okumak için istemci uygulamalarının FeedResponse'dan sonuçları 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) | Dizgi | Oturum düzeyi tutarlılığı ile kullanılan dize belirteci. Daha fazla bilgi için bkz. cosmos DB tutarlılık düzeylerini kullanma |
| x-ms-version | Gerekli | Dizgi | 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 ileti | Opsiyonel | Dizgi | 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 | Opsiyonel | Sayı | değişiklik akışı istekleri kullanılır. Verileri okumak için bölüm anahtarı aralığı kimliği. |
| x-ms-cosmos-allow-tentative-writes | Opsiyonel | Boolean | Bu üst bilgi, birden çok yazma konumuyla yapılandırılan Azure Cosmos hesapları için true olarak ayarlandığında, Azure Cosmos DB tüm konumlarda yazma işlemlerine izin verir. Bu üst bilgi değerinin false olarak ayarlandığı yazma istekleri (veya üst bilgi yoksa) 403 Yanıt Durumu koduyla başarısız olur ve "Bölgede yazma işlemlerine izin verilmiyor" hata iletisiyle başarısız olur. |
Ayrıca bkz.
- Azure Cosmos DB
- Azure Cosmos DB SQL API
- Azure Cosmos DB SQL API SDK'larını
- .NET Örnek REST