Aracılığıyla paylaş


Azure Cosmos DB veritabanı

Azure Cosmos DB, kapsamlı bir SLA ile herhangi bir sayıda coğrafi bölgede aktarım hızını ve depolamayı esnek ve bağımsız olarak ölçeklendirmenizi sağlamak için tasarlanmış, küresel olarak dağıtılmış çok modelli bir veritabanı hizmetidir.

Bu bağlayıcı aşağıdaki ürün ve bölgelerde kullanılabilir:

Hizmet Class Bölgeler
Copilot Studio Premium Tüm Power Automate bölgeleri
Logic Apps Standart Tüm Logic Apps bölgeleri
Power Apps - Mevcut değil
Power Automate Premium Tüm Power Automate bölgeleri
Bağlayıcı Meta Verileri
Publisher Microsoft

Bu tümleştirmeyi kullanmak için Azure Portal'da yapılandırılmış bir Cosmos DB SQL API hesabına sahip olmanız gerekir. Mongo DB API hesaplarının şu anda desteklenmediğini unutmayın.

SQL API hesabı oluşturulduktan sonra, türdeki bir bağlantı Access Key oluşturuyorsanız Azure Cosmos DB bağlayıcısı ile bağlantı oluştururken hesap kimliğini ('documents.azure.com' olmadan) sağlayın. Bu hesap kimliği, Microsoft Entra Id kimlik doğrulamasını destekleyen daha yeni işlem sürümleri için de gereklidir.

Microsoft Entra Id kimlik doğrulaması ve Cosmos DB bağlayıcısı

Microsoft Entra Id kimlik doğrulamasını kullanmak için kullanılan hesaba belirli bir rol ataması atanması gerekir. Daha fazla bilgi için Azure Cosmos DB hesabınız için Microsoft Entra Id ile rol tabanlı erişim denetimini yapılandırma makalesini ziyaret edin.

Uyarı

Yalnızca veri erişimi için açıkça tanımlanan roller, güvenlik sorumlusunın Cosmos DB verilerine erişmesine izin verir. gibi Owneryerleşik roller veya Contributor Microsoft Entra Id aracılığıyla bu hesaptaki Cosmos DB verilerine erişim sağlamaz. Azure Cosmos DB tarafından kullanıma sunulan 2 yerleşik rol vardır:

  1. Cosmos DB Built-in Data Reader (rol tanımı kimliği 00000000-0000-0000-0000-000000000001)
  2. Cosmos DB Built-in Data Contributor (rol tanımı kimliği 00000000-0000-0000-0000-000000000002)

Rollere çok sayıda yol atanabilir ve daha ayrıntılı erişim için özel roller oluşturulabilir.

Aşağıda, PowerShell aracılığıyla kimlerin atanacakları Cosmos DB Built-in Data Reader hakkında bir örnek verilmiştir ( new-AzCosmosDBSqlRoleAssignment komutu hakkında daha fazla bilgi):

$resourceGroupName = "<myResourceGroup>"
$accountName = "<myCosmosAccount>"
$principalId = "<myPrincipalId>"
$roleDefinitionId = "/subscriptions/<<mySubscription>>/resourceGroups/<<myResourceGroup>>/providers/Microsoft.DocumentDB/databaseAccounts/<<myCosmosAccount>>/sqlRoleDefinitions/00000000-0000-0000-0000-000000000001"
New-AzCosmosDBSqlRoleAssignment -AccountName $accountName `
    -ResourceGroupName $resourceGroupName `
    -RoleDefinitionId $roleDefinitionId `
    -PrincipalId $principalId `
    -AssignableScope "/"

Bu rol atamalarının eklenememesi, aşağıdaki gibi yetkisiz isteklerle sonuçlanır: Request is blocked because principal [<<principal-id>>] does not have the required RBAC permissions to perform action <unauthorized actions>.

Uyarı

Azure Cosmos DB, Microsoft Entra Id kimlik doğrulamasıyla (burada belgelenmiştir) herhangi bir yönetim işlemi türünü desteklemez. Aşağıdaki işlemler yalnızca bağlantılarla Access Key çalışır:

  1. Saklı yordam oluşturma (V1 ve V2 sürümleri)
  2. Saklı yordamı silme (V1 ve V2 sürümleri)
  3. Saklı yordamı güncelleştirme (V1 ve V2 sürümleri)

Microsoft Entra ID kimlik doğrulaması ile desteklenmeyen işlemler

Microsoft Entra ID kimlik doğrulaması kullanılırken yalnızca Cosmos DB hesap adı parametre olarak olan eylemler desteklenir. Kullanım dışı bırakılan eylemler kimlik doğrulamasıyla Access Key çalışmaya devam eder, ancak Microsoft Entra Id bağlantısıyla kullanıldığında başarısız olur.

Bilinen Sorunlar ve Sınırlamalar

  • DocumentDB (Azure Cosmos DB) bağlayıcısı tarafından desteklenen bir belgenin boyutu üst sınırı 2 MB'tır.

  • Azure Cosmos DB sınırlamaları burada belgelenmiştir.

  • Yazma bölgesi ve çoklu yazma bölgeleri seçme bağlayıcı tarafından desteklenmez.

  • "Bölüm anahtarı değeri" türüne göre sağlanmalıdır. Örneğin, bir dize değeri tırnak içine alınmalıdır, bir sayı olduğu gibi sağlanmalıdır. Örneğin: "dize değeri", 123, 0,5.

  • Bölümlenmiş koleksiyonlarda çalışan , DISTINCTvb. sorgular ORDER BYiçin "Bölüm anahtarı değeri" gereklidir.

  • Belgeleri sorgulama V2 [KULLANIM DIŞI], Belgeleri sorgulama V3, Tüm belgeleri al V2 (Önizleme) eylemleri SQL API için Azure Cosmos DB .NET SDK'sını (sürüm 2.13.1) kullanır.

  • Belgeleri sorgulama V4 (Önizleme) eylemi, SQL API için Azure Cosmos DB .NET SDK'sını (sürüm 3.15.0) kullanır.

  • Belgeleri sorgulama (V5) (Önizleme) eylemi, SQL API için Azure Cosmos DB .NET SDK'sını (sürüm 3.20.0) kullanır.

  • "En Fazla Öğe Sayısı" parametre değeri 1 ile 1000 aralığındaki herhangi bir sayı olabilir. Bu aralığın dışındaki herhangi bir sayı örtük olarak "-1" olarak dönüştürülür ve cosmos DB hizmetine en uygun öğe sayısını belirlemesini söyler.

  • Boş bırakılırsa, aşağıdaki işlemler yalnızca bölüm anahtarı değeri olmayan belgelerle çalışır. Bölüm anahtarı değerine sahip öğeler bu eylemlerin dışında tutulur .

    1. Belge alma
    2. Belge alma (V2)
    3. Belgeyi değiştirme
    4. Belgeyi değiştirme (V2)
    5. Belgeyi silme
    6. Belgeyi silme (V2)
    7. Saklı yordamı yürütme
    8. Saklı yordamı yürütme (v2)
  • Azure Cosmos DB, Microsoft Entra ID kimlik doğrulamasıyla (burada belgelenmiştir) herhangi bir yönetim işlemini desteklemediğinden, Saklı yordamı yürüt (V2) (Önizleme) işlemi, yalnızca bir tabanlı bağlantı kullanırken Access Key kullanılabilir saklı yordamları (parametre içinSprocId) görüntüler. Token tabanlı kimlik doğrulamaları (Microsoft Entra Id kimlik doğrulamaları) boş bir liste gösterir ve sprocId özel değer olarak el ile girilmelidir.

Önemli

Microsoft Entra ID Tümleşik (Azure Ticari) bağlantıları , ABD Kamu (GCC) ortamlarında varsayılan olarak devre dışı bırakılır. Bu tür bağlantıları etkinleştirmek için, Kiracı yöneticisi tarafından Power Platform Yönetim merkezinde Azure Ticari'ye Bağlan ayarının etkinleştirilmesi gerekir.

Bu ayarın açılması, Power Platform US Government uyumluluk sınırının dışında çalışan ve veri gönderen Azure Ticari'deki kaynaklara bağlantı sağlanmasına olanak tanır. Bu özellikle Power Platform Bağlayıcıları'nın GCC bulut sürümlerinden ticari kaynaklara erişime izin vermek için kullanılır.

Microsoft Entra ID Integrated (Azure Ticari),ABD Kamu (GCC) ortamlarından Azure Ticari kaynaklarına kadar çalışan tek kimlik doğrulama türüdür.

Azure Ticari Kimlik Doğrulaması varsayılan olarak devre dışı: Varsayılan olarak devre dışı

Power Platform Yönetim merkezinde Azure Ticari'ye Bağlan ayarı: Yönetici görünümü

Ayar

Bağlantı oluşturma

Bağlayıcı aşağıdaki kimlik doğrulama türlerini destekler:

Erişim Anahtarı Cosmos DB hesabınıza erişmek için Hesap Adı ve Erişim Anahtarı sağlayın. Azure Kamu ve ABD Kamu (GCC) ve US Government (GCC-High) içindeki Azure Kamu ve Savunma Bakanlığı (DoD) dışındaki tüm bölgeler Paylaşılabilir
Erişim Anahtarı (Azure Kamu) Cosmos DB hesabınıza erişmek için Hesap Adı ve Erişim Anahtarı sağlayın. Yalnızca Azure Kamu ve ABD Kamu (GCC) ve ABD Kamu'da (GCC-High) Azure Kamu ve Savunma Bakanlığı (DoD) Paylaşılabilir
Logic Apps Yönetilen Kimliği LogicApps Yönetilen Kimliği kullanarak bağlantı oluşturma Yalnızca LOGICAPPS Paylaşılabilir
Microsoft Entra ID Integrated Azure Blob depolamanıza erişmek için Microsoft Entra Id kullanın. Azure Kamu ve ABD Kamu (GCC) ve US Government (GCC-High) içindeki Azure Kamu ve Savunma Bakanlığı (DoD) dışındaki tüm bölgeler Paylaşılamaz
Microsoft Entra ID Tümleşik (Azure Ticari) Azure Ticari'de Azure Blob Depolamanıza erişmek için Microsoft Entra Id kullanın. Yalnızca ABD Kamu (GCC) Paylaşılamaz
Microsoft Entra Id Integrated (Azure Kamu) Azure Blob depolamanıza erişmek için Microsoft Entra Id kullanın. Yalnızca Azure Kamu ve ABD Kamu (GCC) ve ABD Kamu'da (GCC-High) Azure Kamu ve Savunma Bakanlığı (DoD) Paylaşılamaz
Varsayılan [KULLANIM DIŞI] Bu seçenek yalnızca açık kimlik doğrulama türü olmayan eski bağlantılar içindir ve yalnızca geriye dönük uyumluluk için sağlanır. Tüm bölgeler Paylaşılamaz

Erişim Tuşu

Kimlik Doğrulaması Kimliği: keyBasedAuth

Geçerli: Azure Kamu ve ABD Kamu (GCC) ve US Government (GCC-High) içindeki Azure Kamu ve Savunma Bakanlığı (DoD) dışındaki tüm bölgeler

Cosmos DB hesabınıza erişmek için Hesap Adı ve Erişim Anahtarı sağlayın.

Bu, paylaşılabilir bir bağlantıdır. Power app başka bir kullanıcıyla paylaşılıyorsa, bağlantı da paylaşılır. Daha fazla bilgi için bkz . Tuval uygulamaları için bağlayıcılara genel bakış - Power Apps | Microsoft Docs

İsim Türü Description Gerekli
Hesap Kimliği String 'documents.azure.com' bölümü olmayan hesabın adı Doğru
Azure Cosmos DB hesabınıza Erişim Anahtarı securestring Birincil veya İkincil Anahtar Doğru

Erişim Anahtarı (Azure Kamu)

Kimlik Doğrulaması Kimliği: keyBasedAuth

Geçerli: Yalnızca Azure Kamu ve ABD Kamu (GCC) ve ABD Kamu'da (GCC-High) Azure Kamu ve Savunma Bakanlığı (DoD)

Cosmos DB hesabınıza erişmek için Hesap Adı ve Erişim Anahtarı sağlayın.

Bu, paylaşılabilir bir bağlantıdır. Power app başka bir kullanıcıyla paylaşılıyorsa, bağlantı da paylaşılır. Daha fazla bilgi için bkz . Tuval uygulamaları için bağlayıcılara genel bakış - Power Apps | Microsoft Docs

İsim Türü Description Gerekli
Hesap Kimliği String 'documents.azure.com' bölümü olmayan hesabın adı Doğru
Azure Cosmos DB hesabınıza Erişim Anahtarı securestring Birincil veya İkincil Anahtar Doğru

Logic Apps Yönetilen Kimliği

Kimlik Doğrulaması Kimliği: managedIdentityAuth

Uygulanabilir: Yalnızca LOGICAPPS

LogicApps Yönetilen Kimliği kullanarak bağlantı oluşturma

Bu, paylaşılabilir bir bağlantıdır. Power app başka bir kullanıcıyla paylaşılıyorsa, bağlantı da paylaşılır. Daha fazla bilgi için bkz . Tuval uygulamaları için bağlayıcılara genel bakış - Power Apps | Microsoft Docs

İsim Türü Description Gerekli
LogicApps Yönetilen Kimliği managedIdentity Logic Apps Yönetilen Kimliği ile oturum açma Doğru

Microsoft Entra Kimliği Entegre

Kimlik Doğrulama Kimliği: tokenBasedAuth

Geçerli: Azure Kamu ve ABD Kamu (GCC) ve US Government (GCC-High) içindeki Azure Kamu ve Savunma Bakanlığı (DoD) dışındaki tüm bölgeler

Azure Blob depolamanıza erişmek için Microsoft Entra Id kullanın.

Bu, paylaşılabilir bir bağlantı değildir. Power app başka bir kullanıcıyla paylaşılıyorsa, başka bir kullanıcıdan açıkça yeni bağlantı oluşturması istenir.

Microsoft Entra ID Tümleşik (Azure Ticari)

Kimlik Doğrulama Kimliği: oauthCom

Geçerli: Yalnızca ABD Kamu (GCC)

Azure Ticari'de Azure Blob Depolamanıza erişmek için Microsoft Entra Id kullanın.

Bu, paylaşılabilir bir bağlantı değildir. Power app başka bir kullanıcıyla paylaşılıyorsa, başka bir kullanıcıdan açıkça yeni bağlantı oluşturması istenir.

Microsoft Entra Id Integrated (Azure Kamu)

Kimlik Doğrulama Kimliği: tokenBasedAuth

Geçerli: Yalnızca Azure Kamu ve ABD Kamu (GCC) ve ABD Kamu'da (GCC-High) Azure Kamu ve Savunma Bakanlığı (DoD)

Azure Blob depolamanıza erişmek için Microsoft Entra Id kullanın.

Bu, paylaşılabilir bir bağlantı değildir. Power app başka bir kullanıcıyla paylaşılıyorsa, başka bir kullanıcıdan açıkça yeni bağlantı oluşturması istenir.

Varsayılan [KULLANIM DIŞI]

Geçerli: Tüm bölgeler

Bu seçenek yalnızca açık kimlik doğrulama türü olmayan eski bağlantılar içindir ve yalnızca geriye dönük uyumluluk için sağlanır.

Bu, paylaşılabilir bir bağlantı değildir. Power app başka bir kullanıcıyla paylaşılıyorsa, başka bir kullanıcıdan açıkça yeni bağlantı oluşturması istenir.

İsim Türü Description Gerekli
Hesap Kimliği String 'documents.azure.com' bölümü olmayan hesabın adı Doğru
Azure Cosmos DB hesabınıza Erişim Anahtarı securestring Birincil veya İkincil Anahtar Doğru

Azaltma Sınırları

Name Çağrılar Yenileme Dönemi
Bağlantı başına API çağrıları 1500 60 saniye

Eylemler

Belge alma (V2)

Belge alma (V2).

Belge alma [KULLANIM DIŞI]

Bu eylem kullanım dışı bırakıldı. Bunun yerine lütfen Belge al (V2) kullanın.

Bir belge alın.

Belge oluşturma veya güncelleştirme (V2) [KULLANIM DIŞI]

Bu eylem kullanım dışı bırakıldı. Bunun yerine lütfen Belge oluştur veya güncelleştir (V3) kullanın.

Belge oluşturun veya güncelleştirin. DocumentDB'de belge oluştururken gövdenin bir kimlik özelliği içermesi gerekir.

Belge oluşturma veya güncelleştirme (V3)

Belge oluşturun veya güncelleştirin. DocumentDB'de belge oluştururken gövdenin bir kimlik özelliği içermesi gerekir.

Belge oluşturma veya güncelleştirme [KULLANIM DIŞI]

Bu eylem kullanım dışı bırakıldı. Bunun yerine lütfen Belge oluştur veya güncelleştir (V3) kullanın.

Belge oluşturun veya güncelleştirin. DocumentDB'de belge oluştururken gövdenin bir kimlik özelliği içermesi gerekir.

Belge silme [KULLANIM DIŞI]

Bu eylem kullanım dışı bırakıldı. Lütfen bunun yerine Belgeyi sil (V2) kullanın.

Belgeyi silme.

Belgeleri sorgulama [KULLANIM DIŞI]

Bu eylem kullanım dışı bırakıldı. Lütfen Bunun yerine Sorgu belgeleri V5'i kullanın.

Belgeleri sorgula.

Belgeleri sorgulama V2 [KULLANIM DIŞI]

Bu eylem kullanım dışı bırakıldı. Lütfen Bunun yerine Sorgu belgeleri V5'i kullanın.

Belgeleri sorgulama V2.

Belgeleri sorgulama V3 [KULLANIM DIŞI]

Bu eylem kullanım dışı bırakıldı. Lütfen Bunun yerine Sorgu belgeleri V5'i kullanın.

Belgeleri sorgula V3.

Belgeleri sorgulama V4 [KULLANIM DIŞI]

Bu eylem kullanım dışı bırakıldı. Lütfen Bunun yerine Sorgu belgeleri V5'i kullanın.

Belgeleri sorgula V4.

Belgeleri sorgulama V5

Belgeleri sorgulama (V5).

Belgeyi değiştirme (V2)

Belgeyi (V2) değiştirin.

Belgeyi değiştirme [KULLANIM DIŞI]

Bu eylem kullanım dışı bırakıldı. Bunun yerine lütfen Belgeyi değiştir (V2) kullanın.

Belgeyi değiştirme.

Belgeyi silme (V2)

Belgeyi silme (V2).

Saklı yordam oluşturma (V2)

Saklı yordam (V2) oluşturun.

Saklı yordam oluşturma [KULLANIM DIŞI]

Bu eylem kullanım dışı bırakıldı. Lütfen bunun yerine Saklı yordam oluştur (V2) kullanın.

Saklı yordam oluşturma.

Saklı yordamları alma (V2)

Belirtilen koleksiyonda (V2) saklı yordamları alın.

Saklı yordamları alma [KULLANIM DIŞI]

Bu eylem kullanım dışı bırakıldı. Bunun yerine lütfen Saklı yordamları al (V2) kullanın.

Belirtilen koleksiyonda saklı yordamları alın.

Saklı yordamı değiştirme (V2)

saklı yordamı (V2) değiştirin.

Saklı yordamı değiştirme [KULLANIM DIŞI]

Bu eylem kullanım dışı bırakıldı. Lütfen bunun yerine Saklı yordamı değiştir (V2) kullanın.

saklı yordamı değiştirin.

Saklı yordamı silme (V2)

Saklı yordamı (V2) silin.

Saklı yordamı silme [KULLANIM DIŞI]

Bu eylem kullanım dışı bırakıldı. Lütfen bunun yerine Saklı yordamı sil (V2) kullanın.

Saklı yordamı silin.

Saklı yordamı yürütme (V2)

Belirtilen koleksiyonda (V2) saklı yordamı yürütür.

Saklı yordamı yürütme [KULLANIM DIŞI]

Bu eylem kullanım dışı bırakıldı. Lütfen bunun yerine Execute saklı yordamını (V2) kullanın.

Belirtilen koleksiyonda saklı yordamı yürütür.

Tüm belgeleri alma (V3)

Tüm belgeleri (V3) alın.

Tüm belgeleri alma [KULLANIM DIŞI]

Bu eylem kullanım dışı bırakıldı. Lütfen Bunun yerine Tüm belgeleri al (V3) kullanın.

Tüm belgeleri alın.

Tüm belgeleri alma V2 [KULLANIM DIŞI]

Bu eylem kullanım dışı bırakıldı. Lütfen Bunun yerine Tüm belgeleri al (V3) kullanın.

Tüm belgeleri alma V2.

Belge alma (V2)

Belge alma (V2).

Parametreler

Name Anahtar Gerekli Tür Description
Bölüm anahtarı değeri
x-ms-documentdb-raw-partitionkey string

İstenen belge veya ek işlemi için bölüm anahtarı değeri.

En Fazla Öğe Sayısı
x-ms-max-item-count number

Sayfa başına döndürülecek en fazla öğe sayısını gösteren tamsayı.

Devamlılık Belirteci
x-ms-continuation string

Okunacak daha fazla sonuç varsa sorgular ve okuma akışı işlemleri için döndürülen dize belirteci.

Tutarlılık Düzeyi
x-ms-consistency-level string

Bu, tutarlılık düzeyi geçersiz kılma işlemidir. Geçerli değerler şunlardır: Strong, Bounded, Session veya Eventual (en güçlüden en zayıfa doğru).

Oturum Belirteci
x-ms-session-token string

Oturum düzeyi tutarlılığı ile kullanılan dize belirteci.

Etkinlik kimliği
x-ms-activity-id string

sunucu yanıtında yankılanacak işlem için bir istemci tarafından sağlanan tanımlayıcı.

Azure Cosmos DB hesap adı
cosmosDbAccountName True string

Azure Cosmos DB hesap adı (documents.azure.com olmadan).

Veritabanı Kimliği
databaseId True string

Veritabanının adı.

Koleksiyon Kimliği
collectionId True string

Koleksiyonun adı.

Belge Kimliği
documentId True string

Belgenin tanımlayıcısı.

API sürümü
x-ms-version string

API sürümü.

Döndürülenler

response
object

Belge alma [KULLANIM DIŞI]

Bu eylem kullanım dışı bırakıldı. Bunun yerine lütfen Belge al (V2) kullanın.

Bir belge alın.

Parametreler

Name Anahtar Gerekli Tür Description
Bölüm anahtarı değeri
x-ms-documentdb-raw-partitionkey string

İstenen belge veya ek işlemi için bölüm anahtarı değeri.

En Fazla Öğe Sayısı
x-ms-max-item-count number

Sayfa başına döndürülecek en fazla öğe sayısını gösteren tamsayı.

Devamlılık Belirteci
x-ms-continuation string

Okunacak daha fazla sonuç varsa sorgular ve okuma akışı işlemleri için döndürülen dize belirteci.

Tutarlılık Düzeyi
x-ms-consistency-level string

Bu, tutarlılık düzeyi geçersiz kılma işlemidir. Geçerli değerler şunlardır: Strong, Bounded, Session veya Eventual (en güçlüden en zayıfa doğru).

Oturum Belirteci
x-ms-session-token string

Oturum düzeyi tutarlılığı ile kullanılan dize belirteci.

Etkinlik kimliği
x-ms-activity-id string

sunucu yanıtında yankılanacak işlem için bir istemci tarafından sağlanan tanımlayıcı.

Veritabanı Kimliği
databaseId True string

Veritabanının adı.

Koleksiyon Kimliği
collectionId True string

Koleksiyonun adı.

Belge Kimliği
documentId True string

Belgenin tanımlayıcısı.

API sürümü
x-ms-version string

API sürümü.

Döndürülenler

response
object

Belge oluşturma veya güncelleştirme (V2) [KULLANIM DIŞI]

Bu eylem kullanım dışı bırakıldı. Bunun yerine lütfen Belge oluştur veya güncelleştir (V3) kullanın.

Belge oluşturun veya güncelleştirin. DocumentDB'de belge oluştururken gövdenin bir kimlik özelliği içermesi gerekir.

Parametreler

Name Anahtar Gerekli Tür Description
En Fazla Öğe Sayısı
x-ms-max-item-count number

Sayfa başına döndürülecek en fazla öğe sayısını gösteren tamsayı.

Devamlılık Belirteci
x-ms-continuation string

Okunacak daha fazla sonuç varsa sorgular ve okuma akışı işlemleri için döndürülen dize belirteci.

Tutarlılık Düzeyi
x-ms-consistency-level string

Bu, tutarlılık düzeyi geçersiz kılma işlemidir. Geçerli değerler şunlardır: Strong, Bounded, Session veya Eventual (en güçlüden en zayıfa doğru).

Oturum Belirteci
x-ms-session-token string

Oturum düzeyi tutarlılığı ile kullanılan dize belirteci.

Etkinlik kimliği
x-ms-activity-id string

sunucu yanıtında yankılanacak işlem için bir istemci tarafından sağlanan tanımlayıcı.

IsUpsert
x-ms-documentdb-is-upsert boolean

True olarak ayarlanırsa, başka bir belge oluşturulduysa belge değiştirilir.

Ön Tetikleyici
x-ms-documentdb-pre-trigger-include string

Belge işlemi yürütülmeden önce çalıştırılacak tetikleyici adlarının virgülle ayrılmış listesi.

Tetikleyici Sonrası
x-ms-documentdb-post-trigger-include string

Belge işlemi yürütüldükten sonra çalıştırılacak tetikleyici adlarının virgülle ayrılmış listesi.

Veritabanı Kimliği
databaseId True string

Veritabanının adı.

Koleksiyon Kimliği
collectionId True string

Koleksiyonun adı.

API sürümü
x-ms-version string

API sürümü.

Döndürülenler

Belge oluşturma veya güncelleştirme (V3)

Belge oluşturun veya güncelleştirin. DocumentDB'de belge oluştururken gövdenin bir kimlik özelliği içermesi gerekir.

Parametreler

Name Anahtar Gerekli Tür Description
En Fazla Öğe Sayısı
x-ms-max-item-count number

Sayfa başına döndürülecek en fazla öğe sayısını gösteren tamsayı.

Devamlılık Belirteci
x-ms-continuation string

Okunacak daha fazla sonuç varsa sorgular ve okuma akışı işlemleri için döndürülen dize belirteci.

Tutarlılık Düzeyi
x-ms-consistency-level string

Bu, tutarlılık düzeyi geçersiz kılma işlemidir. Geçerli değerler şunlardır: Strong, Bounded, Session veya Eventual (en güçlüden en zayıfa doğru).

Oturum Belirteci
x-ms-session-token string

Oturum düzeyi tutarlılığı ile kullanılan dize belirteci.

Etkinlik kimliği
x-ms-activity-id string

sunucu yanıtında yankılanacak işlem için bir istemci tarafından sağlanan tanımlayıcı.

IsUpsert
x-ms-documentdb-is-upsert boolean

True olarak ayarlanırsa, başka bir belge oluşturulduysa belge değiştirilir.

Ön Tetikleyici
x-ms-documentdb-pre-trigger-include string

Belge işlemi yürütülmeden önce çalıştırılacak tetikleyici adlarının virgülle ayrılmış listesi.

Tetikleyici Sonrası
x-ms-documentdb-post-trigger-include string

Belge işlemi yürütüldükten sonra çalıştırılacak tetikleyici adlarının virgülle ayrılmış listesi.

Azure Cosmos DB hesap adı
cosmosDbAccountName True string

Azure Cosmos DB hesap adı (documents.azure.com olmadan).

Veritabanı Kimliği
databaseId True string

Veritabanının adı.

Koleksiyon Kimliği
collectionId True string

Koleksiyonun adı.

API sürümü
x-ms-version string

API sürümü.

Döndürülenler

Belge oluşturma veya güncelleştirme [KULLANIM DIŞI]

Bu eylem kullanım dışı bırakıldı. Bunun yerine lütfen Belge oluştur veya güncelleştir (V3) kullanın.

Belge oluşturun veya güncelleştirin. DocumentDB'de belge oluştururken gövdenin bir kimlik özelliği içermesi gerekir.

Parametreler

Name Anahtar Gerekli Tür Description
Bölüm anahtarı değeri
x-ms-documentdb-raw-partitionkey string

İstenen belge veya ek işlemi için bölüm anahtarı değeri.

En Fazla Öğe Sayısı
x-ms-max-item-count number

Sayfa başına döndürülecek en fazla öğe sayısını gösteren tamsayı.

Devamlılık Belirteci
x-ms-continuation string

Okunacak daha fazla sonuç varsa sorgular ve okuma akışı işlemleri için döndürülen dize belirteci.

Tutarlılık Düzeyi
x-ms-consistency-level string

Bu, tutarlılık düzeyi geçersiz kılma işlemidir. Geçerli değerler şunlardır: Strong, Bounded, Session veya Eventual (en güçlüden en zayıfa doğru).

Oturum Belirteci
x-ms-session-token string

Oturum düzeyi tutarlılığı ile kullanılan dize belirteci.

Etkinlik kimliği
x-ms-activity-id string

sunucu yanıtında yankılanacak işlem için bir istemci tarafından sağlanan tanımlayıcı.

IsUpsert
x-ms-documentdb-is-upsert boolean

True olarak ayarlanırsa, başka bir belge oluşturulduysa belge değiştirilir.

Ön Tetikleyici
x-ms-documentdb-pre-trigger-include string

Belge işlemi yürütülmeden önce çalıştırılacak tetikleyici adlarının virgülle ayrılmış listesi.

Tetikleyici Sonrası
x-ms-documentdb-post-trigger-include string

Belge işlemi yürütüldükten sonra çalıştırılacak tetikleyici adlarının virgülle ayrılmış listesi.

Veritabanı Kimliği
databaseId True string

Veritabanının adı.

Koleksiyon Kimliği
collectionId True string

Koleksiyonun adı.

API sürümü
x-ms-version string

API sürümü.

Döndürülenler

Belge silme [KULLANIM DIŞI]

Bu eylem kullanım dışı bırakıldı. Lütfen bunun yerine Belgeyi sil (V2) kullanın.

Belgeyi silme.

Parametreler

Name Anahtar Gerekli Tür Description
Bölüm anahtarı değeri
x-ms-documentdb-raw-partitionkey string

İstenen belge veya ek işlemi için bölüm anahtarı değeri.

En Fazla Öğe Sayısı
x-ms-max-item-count number

Sayfa başına döndürülecek en fazla öğe sayısını gösteren tamsayı.

Devamlılık Belirteci
x-ms-continuation string

Okunacak daha fazla sonuç varsa sorgular ve okuma akışı işlemleri için döndürülen dize belirteci.

Tutarlılık Düzeyi
x-ms-consistency-level string

Bu, tutarlılık düzeyi geçersiz kılma işlemidir. Geçerli değerler şunlardır: Strong, Bounded, Session veya Eventual (en güçlüden en zayıfa doğru).

Oturum Belirteci
x-ms-session-token string

Oturum düzeyi tutarlılığı ile kullanılan dize belirteci.

Etkinlik kimliği
x-ms-activity-id string

sunucu yanıtında yankılanacak işlem için bir istemci tarafından sağlanan tanımlayıcı.

Ön Tetikleyici
x-ms-documentdb-pre-trigger-include string

Belge işlemi yürütülmeden önce çalıştırılacak tetikleyici adlarının virgülle ayrılmış listesi.

Tetikleyici Sonrası
x-ms-documentdb-post-trigger-include string

Belge işlemi yürütüldükten sonra çalıştırılacak tetikleyici adlarının virgülle ayrılmış listesi.

Veritabanı Kimliği
databaseId True string

Veritabanının adı.

Koleksiyon Kimliği
collectionId True string

Koleksiyonun adı.

Belge Kimliği
documentId True string

Belgenin tanımlayıcısı.

API sürümü
x-ms-version string

API sürümü.

Belgeleri sorgulama [KULLANIM DIŞI]

Bu eylem kullanım dışı bırakıldı. Lütfen Bunun yerine Sorgu belgeleri V5'i kullanın.

Belgeleri sorgula.

Parametreler

Name Anahtar Gerekli Tür Description
Bölüm anahtarı değeri
x-ms-documentdb-raw-partitionkey string

İstenen belge veya ek işlemi için bölüm anahtarı değeri.

En Fazla Öğe Sayısı
x-ms-max-item-count number

Sayfa başına döndürülecek en fazla öğe sayısını gösteren tamsayı.

Devamlılık Belirteci
x-ms-continuation string

Okunacak daha fazla sonuç varsa sorgular ve okuma akışı işlemleri için döndürülen dize belirteci.

Bölümler Arası Etkinleştir
x-ms-documentdb-query-enablecrosspartition boolean

Koleksiyon bölümlenmişse, birden çok bölümde yürütmeye izin vermek için bunun True olarak ayarlanması gerekir.

Tutarlılık Düzeyi
x-ms-consistency-level string

Bu, tutarlılık düzeyi geçersiz kılma işlemidir. Geçerli değerler şunlardır: Strong, Bounded, Session veya Eventual (en güçlüden en zayıfa doğru).

Oturum Belirteci
x-ms-session-token string

Oturum düzeyi tutarlılığı ile kullanılan dize belirteci.

Etkinlik kimliği
x-ms-activity-id string

sunucu yanıtında yankılanacak işlem için bir istemci tarafından sağlanan tanımlayıcı.

Veritabanı Kimliği
databaseId True string

Veritabanının adı.

Koleksiyon Kimliği
collectionId True string

Koleksiyonun adı.

soru
query string

Döndürülenler

Belgeleri sorgulama V2 [KULLANIM DIŞI]

Bu eylem kullanım dışı bırakıldı. Lütfen Bunun yerine Sorgu belgeleri V5'i kullanın.

Belgeleri sorgulama V2.

Parametreler

Name Anahtar Gerekli Tür Description
Veritabanı Kimliği
databaseId True string

Veritabanının adı.

Koleksiyon Kimliği
collectionId True string

Koleksiyonun adı.

SorguMetni
QueryText string

Belgeler üzerinde SQL Sözdizimi Sorgusu

Bölüm anahtarı değeri
partitionKey string

Bölüm anahtarı değeri.

Devamlılık Belirteci
continuationToken string

İşlemden ek sonuçlar getirmek için bir belirteç.

Döndürülenler

İstenen sorgu ve ilgili meta verilerle eşleşen belge dizisi.

Belgeleri sorgulama V3 [KULLANIM DIŞI]

Bu eylem kullanım dışı bırakıldı. Lütfen Bunun yerine Sorgu belgeleri V5'i kullanın.

Belgeleri sorgula V3.

Parametreler

Name Anahtar Gerekli Tür Description
Veritabanı Kimliği
databaseId True string

Veritabanının adı.

Koleksiyon Kimliği
collectionId True string

Koleksiyonun adı.

SQL Sözdizimi Sorgusu
queryText True string

SQL sorgusu.

Bölüm anahtarı değeri
partitionKey string

Boşsa, tüm bölümler belgeleri aramak için kullanılır.

En Fazla Öğe Sayısı
maxItemCount integer

Sayfa başına döndürülecek en fazla öğe sayısını gösteren tamsayı.

Devamlılık Belirteci
continuationToken string

Ek sonuçları getirmek için bir belirteç.

Bölümler Arası Etkinleştir
enableCrossPartition boolean

Kullanıcının sorguyu yürütmek için birden fazla istek göndermek üzere etkinleştirilip etkinleştirilmediğini gösterir.

Tutarlılık Düzeyi
consistencyLevel string

Akış (sorgu/okuma akışı) işlemi için tutarlılık düzeyi gereklidir.

Oturum Belirteci
sessionToken string

Oturum tutarlılığı ile kullanılacak oturum belirteci.

Döndürülenler

İstenen sorgu ve ilgili meta verilerle eşleşen belge dizisi.

Belgeleri sorgulama V4 [KULLANIM DIŞI]

Bu eylem kullanım dışı bırakıldı. Lütfen Bunun yerine Sorgu belgeleri V5'i kullanın.

Belgeleri sorgula V4.

Parametreler

Name Anahtar Gerekli Tür Description
Veritabanı Kimliği
databaseId True string

Veritabanının adı.

Kapsayıcı Kimliği
containerId True string

Kapsayıcının adı.

SQL Sözdizimi Sorgusu
queryText string

SQL sorgusu. Boşsa, tüm belgeleri döndürür.

Bölüm anahtarı değeri
partitionKey string

Boşsa, tüm bölümler belgeleri aramak için kullanılır.

En Fazla Öğe Sayısı
maxItemCount integer

Sayfa başına döndürülecek en fazla öğe sayısını gösteren tamsayı.

Devamlılık Belirteci
continuationToken string

Ek sonuçları getirmek için bir belirteç.

Tutarlılık Düzeyi
consistencyLevel string

Akış (sorgu/okuma akışı) işlemi için tutarlılık düzeyi gereklidir.

Oturum Belirteci
sessionToken string

Oturum tutarlılığı ile kullanılacak oturum belirteci.

Döndürülenler

İstenen sorgu ve ilgili meta verilerle eşleşen belge dizisi.

Belgeleri sorgulama V5

Belgeleri sorgulama (V5).

Parametreler

Name Anahtar Gerekli Tür Description
Azure Cosmos DB hesap adı
cosmosDbAccountName True string

Azure Cosmos DB hesap adı (documents.azure.com olmadan).

Veritabanı Kimliği
databaseId True string

Veritabanının adı.

Kapsayıcı Kimliği
containerId True string

Kapsayıcının adı.

SQL Sözdizimi Sorgusu
queryText string

SQL sorgusu. Boşsa, tüm belgeleri döndürür.

Bölüm anahtarı değeri
partitionKey string

Değer türüne ("dize", 42, 0,5) göre sağlanmalıdır. Boşsa, tüm bölümler belgeleri aramak için kullanılır.

En Fazla Öğe Sayısı
maxItemCount integer

Sayfa başına döndürülecek en fazla öğe sayısını gösteren tamsayı.

Devamlılık Belirteci
continuationToken string

Ek sonuçları getirmek için bir belirteç.

Tutarlılık Düzeyi
consistencyLevel string

Akış (sorgu/okuma akışı) işlemi için tutarlılık düzeyi gereklidir.

Oturum Belirteci
sessionToken string

Oturum tutarlılığı ile kullanılacak oturum belirteci.

Döndürülenler

İstenen sorgu ve ilgili meta verilerle eşleşen belge dizisi.

Belgeyi değiştirme (V2)

Belgeyi (V2) değiştirin.

Parametreler

Name Anahtar Gerekli Tür Description
Bölüm anahtarı değeri
x-ms-documentdb-raw-partitionkey string

İstenen belge veya ek işlemi için bölüm anahtarı değeri.

En Fazla Öğe Sayısı
x-ms-max-item-count number

Sayfa başına döndürülecek en fazla öğe sayısını gösteren tamsayı.

Devamlılık Belirteci
x-ms-continuation string

Okunacak daha fazla sonuç varsa sorgular ve okuma akışı işlemleri için döndürülen dize belirteci.

Tutarlılık Düzeyi
x-ms-consistency-level string

Bu, tutarlılık düzeyi geçersiz kılma işlemidir. Geçerli değerler şunlardır: Strong, Bounded, Session veya Eventual (en güçlüden en zayıfa doğru).

Oturum Belirteci
x-ms-session-token string

Oturum düzeyi tutarlılığı ile kullanılan dize belirteci.

Etkinlik kimliği
x-ms-activity-id string

sunucu yanıtında yankılanacak işlem için bir istemci tarafından sağlanan tanımlayıcı.

Ön Tetikleyici
x-ms-documentdb-pre-trigger-include string

Belge işlemi yürütülmeden önce çalıştırılacak tetikleyici adlarının virgülle ayrılmış listesi.

Tetikleyici Sonrası
x-ms-documentdb-post-trigger-include string

Belge işlemi yürütüldükten sonra çalıştırılacak tetikleyici adlarının virgülle ayrılmış listesi.

Azure Cosmos DB hesap adı
cosmosDbAccountName True string

Azure Cosmos DB hesap adı (documents.azure.com olmadan).

Veritabanı Kimliği
databaseId True string

Veritabanının adı.

Koleksiyon Kimliği
collectionId True string

Koleksiyonun adı.

Belge Kimliği
documentId True string

Belgenin tanımlayıcısı.

API sürümü
x-ms-version string

API sürümü.

Döndürülenler

Belgeyi değiştirme [KULLANIM DIŞI]

Bu eylem kullanım dışı bırakıldı. Bunun yerine lütfen Belgeyi değiştir (V2) kullanın.

Belgeyi değiştirme.

Parametreler

Name Anahtar Gerekli Tür Description
Bölüm anahtarı değeri
x-ms-documentdb-raw-partitionkey string

İstenen belge veya ek işlemi için bölüm anahtarı değeri.

En Fazla Öğe Sayısı
x-ms-max-item-count number

Sayfa başına döndürülecek en fazla öğe sayısını gösteren tamsayı.

Devamlılık Belirteci
x-ms-continuation string

Okunacak daha fazla sonuç varsa sorgular ve okuma akışı işlemleri için döndürülen dize belirteci.

Tutarlılık Düzeyi
x-ms-consistency-level string

Bu, tutarlılık düzeyi geçersiz kılma işlemidir. Geçerli değerler şunlardır: Strong, Bounded, Session veya Eventual (en güçlüden en zayıfa doğru).

Oturum Belirteci
x-ms-session-token string

Oturum düzeyi tutarlılığı ile kullanılan dize belirteci.

Etkinlik kimliği
x-ms-activity-id string

sunucu yanıtında yankılanacak işlem için bir istemci tarafından sağlanan tanımlayıcı.

Ön Tetikleyici
x-ms-documentdb-pre-trigger-include string

Belge işlemi yürütülmeden önce çalıştırılacak tetikleyici adlarının virgülle ayrılmış listesi.

Tetikleyici Sonrası
x-ms-documentdb-post-trigger-include string

Belge işlemi yürütüldükten sonra çalıştırılacak tetikleyici adlarının virgülle ayrılmış listesi.

Veritabanı Kimliği
databaseId True string

Veritabanının adı.

Koleksiyon Kimliği
collectionId True string

Koleksiyonun adı.

Belge Kimliği
documentId True string

Belgenin tanımlayıcısı.

API sürümü
x-ms-version string

API sürümü.

Döndürülenler

Belgeyi silme (V2)

Belgeyi silme (V2).

Parametreler

Name Anahtar Gerekli Tür Description
Bölüm anahtarı değeri
x-ms-documentdb-raw-partitionkey string

İstenen belge veya ek işlemi için bölüm anahtarı değeri.

En Fazla Öğe Sayısı
x-ms-max-item-count number

Sayfa başına döndürülecek en fazla öğe sayısını gösteren tamsayı.

Devamlılık Belirteci
x-ms-continuation string

Okunacak daha fazla sonuç varsa sorgular ve okuma akışı işlemleri için döndürülen dize belirteci.

Tutarlılık Düzeyi
x-ms-consistency-level string

Bu, tutarlılık düzeyi geçersiz kılma işlemidir. Geçerli değerler şunlardır: Strong, Bounded, Session veya Eventual (en güçlüden en zayıfa doğru).

Oturum Belirteci
x-ms-session-token string

Oturum düzeyi tutarlılığı ile kullanılan dize belirteci.

Etkinlik kimliği
x-ms-activity-id string

sunucu yanıtında yankılanacak işlem için bir istemci tarafından sağlanan tanımlayıcı.

Ön Tetikleyici
x-ms-documentdb-pre-trigger-include string

Belge işlemi yürütülmeden önce çalıştırılacak tetikleyici adlarının virgülle ayrılmış listesi.

Tetikleyici Sonrası
x-ms-documentdb-post-trigger-include string

Belge işlemi yürütüldükten sonra çalıştırılacak tetikleyici adlarının virgülle ayrılmış listesi.

Azure Cosmos DB hesap adı
cosmosDbAccountName True string

Azure Cosmos DB hesap adı (documents.azure.com olmadan).

Veritabanı Kimliği
databaseId True string

Veritabanının adı.

Koleksiyon Kimliği
collectionId True string

Koleksiyonun adı.

Belge Kimliği
documentId True string

Belgenin tanımlayıcısı.

API sürümü
x-ms-version string

API sürümü.

Saklı yordam oluşturma (V2)

Saklı yordam (V2) oluşturun.

Parametreler

Name Anahtar Gerekli Tür Description
Azure Cosmos DB hesap adı
cosmosDbAccountName True string

Azure Cosmos DB hesap adı (documents.azure.com olmadan).

Veritabanı Kimliği
databaseId True string

Veritabanının adı.

Koleksiyon Kimliği
collectionId True string

Koleksiyonun adı.

İşlev tanımı
body string

Saklı yordamı tanımlayan işlev; örneğin, 'function(params){ ... }'

kimlik
id string

Saklı yordamın yeni kimliği.

API sürümü
x-ms-version string

API sürümü.

Döndürülenler

Saklı yordam oluşturma [KULLANIM DIŞI]

Bu eylem kullanım dışı bırakıldı. Lütfen bunun yerine Saklı yordam oluştur (V2) kullanın.

Saklı yordam oluşturma.

Parametreler

Name Anahtar Gerekli Tür Description
Veritabanı Kimliği
databaseId True string

Veritabanının adı.

Koleksiyon Kimliği
collectionId True string

Koleksiyonun adı.

İşlev tanımı
body string

Saklı yordamı tanımlayan işlev; örneğin, 'function(params){ ... }'

kimlik
id string

Saklı yordamın yeni kimliği.

API sürümü
x-ms-version string

API sürümü.

Döndürülenler

Saklı yordamları alma (V2)

Belirtilen koleksiyonda (V2) saklı yordamları alın.

Parametreler

Name Anahtar Gerekli Tür Description
Azure Cosmos DB hesap adı
cosmosDbAccountName True string

Azure Cosmos DB hesap adı (documents.azure.com olmadan).

Veritabanı Kimliği
databaseId True string

Veritabanının adı.

Koleksiyon Kimliği
collectionId True string

Koleksiyonun adı.

API sürümü
x-ms-version string

API sürümü.

Döndürülenler

Saklı yordamları alma [KULLANIM DIŞI]

Bu eylem kullanım dışı bırakıldı. Bunun yerine lütfen Saklı yordamları al (V2) kullanın.

Belirtilen koleksiyonda saklı yordamları alın.

Parametreler

Name Anahtar Gerekli Tür Description
Veritabanı Kimliği
databaseId True string

Veritabanının adı.

Koleksiyon Kimliği
collectionId True string

Koleksiyonun adı.

API sürümü
x-ms-version string

API sürümü.

Döndürülenler

Saklı yordamı değiştirme (V2)

saklı yordamı (V2) değiştirin.

Parametreler

Name Anahtar Gerekli Tür Description
Azure Cosmos DB hesap adı
cosmosDbAccountName True string

Azure Cosmos DB hesap adı (documents.azure.com olmadan).

Veritabanı Kimliği
databaseId True string

Veritabanının adı.

Koleksiyon Kimliği
collectionId True string

Koleksiyonun adı.

Sproc Kimliği
sprocId True string

Saklı yordamın adı.

İşlev tanımı
body string

Saklı yordamı tanımlayan işlev; örneğin, 'function(params){ ... }'

kimlik
id string

Mevcut saklı yordamın kimliği.

API sürümü
x-ms-version string

API sürümü.

Döndürülenler

Saklı yordamı değiştirme [KULLANIM DIŞI]

Bu eylem kullanım dışı bırakıldı. Lütfen bunun yerine Saklı yordamı değiştir (V2) kullanın.

saklı yordamı değiştirin.

Parametreler

Name Anahtar Gerekli Tür Description
Veritabanı Kimliği
databaseId True string

Veritabanının adı.

Koleksiyon Kimliği
collectionId True string

Koleksiyonun adı.

Sproc Kimliği
sprocId True string

Saklı yordamın adı.

İşlev tanımı
body string

Saklı yordamı tanımlayan işlev; örneğin, 'function(params){ ... }'

kimlik
id string

Mevcut saklı yordamın kimliği.

API sürümü
x-ms-version string

API sürümü.

Döndürülenler

Saklı yordamı silme (V2)

Saklı yordamı (V2) silin.

Parametreler

Name Anahtar Gerekli Tür Description
Azure Cosmos DB hesap adı
cosmosDbAccountName True string

Azure Cosmos DB hesap adı (documents.azure.com olmadan).

Veritabanı Kimliği
databaseId True string

Veritabanının adı.

Koleksiyon Kimliği
collectionId True string

Koleksiyonun adı.

Sproc Kimliği
sprocId True string

Saklı yordamın adı.

API sürümü
x-ms-version string

API sürümü.

Döndürülenler

response
string

Saklı yordamı silme [KULLANIM DIŞI]

Bu eylem kullanım dışı bırakıldı. Lütfen bunun yerine Saklı yordamı sil (V2) kullanın.

Saklı yordamı silin.

Parametreler

Name Anahtar Gerekli Tür Description
Veritabanı Kimliği
databaseId True string

Veritabanının adı.

Koleksiyon Kimliği
collectionId True string

Koleksiyonun adı.

Sproc Kimliği
sprocId True string

Saklı yordamın adı.

API sürümü
x-ms-version string

API sürümü.

Döndürülenler

response
string

Saklı yordamı yürütme (V2)

Belirtilen koleksiyonda (V2) saklı yordamı yürütür.

Parametreler

Name Anahtar Gerekli Tür Description
Azure Cosmos DB hesap adı
cosmosDbAccountName True string

Azure Cosmos DB hesap adı (documents.azure.com olmadan).

Veritabanı Kimliği
databaseId True string

Veritabanının adı.

Koleksiyon Kimliği
collectionId True string

Koleksiyonun adı.

Bölüm anahtarı değeri
x-ms-documentdb-raw-partitionkey string

İstenen belge veya ek işlemi için bölüm anahtarı değeri.

Sproc Kimliği
sprocId True string

Saklı yordamın adı.

Saklı yordam için parametreler
parameters string

Saklı yordamın parametreleri için geçerli JSON belirtin; örneğin, ["param1", "param2"].

API sürümü
x-ms-version string

API sürümü.

Döndürülenler

Saklı yordamı yürütme [KULLANIM DIŞI]

Bu eylem kullanım dışı bırakıldı. Lütfen bunun yerine Execute saklı yordamını (V2) kullanın.

Belirtilen koleksiyonda saklı yordamı yürütür.

Parametreler

Name Anahtar Gerekli Tür Description
Veritabanı Kimliği
databaseId True string

Veritabanının adı.

Koleksiyon Kimliği
collectionId True string

Koleksiyonun adı.

Bölüm anahtarı değeri
x-ms-documentdb-raw-partitionkey string

İstenen belge veya ek işlemi için bölüm anahtarı değeri.

Sproc Kimliği
sprocId True string

Saklı yordamın adı.

Saklı yordam için parametreler
parameters string

Saklı yordamın parametreleri için geçerli JSON belirtin; örneğin, ["param1", "param2"].

API sürümü
x-ms-version string

API sürümü.

Döndürülenler

Tüm belgeleri alma (V3)

Tüm belgeleri (V3) alın.

Parametreler

Name Anahtar Gerekli Tür Description
Bölüm anahtarı değeri
x-ms-documentdb-raw-partitionkey string

İstenen belge veya ek işlemi için bölüm anahtarı değeri.

En Fazla Öğe Sayısı
x-ms-max-item-count number

Sayfa başına döndürülecek en fazla öğe sayısını gösteren tamsayı.

Devamlılık Belirteci
x-ms-continuation string

Okunacak daha fazla sonuç varsa sorgular ve okuma akışı işlemleri için döndürülen dize belirteci.

Tutarlılık Düzeyi
x-ms-consistency-level string

Bu, tutarlılık düzeyi geçersiz kılma işlemidir. Geçerli değerler şunlardır: Strong, Bounded, Session veya Eventual (en güçlüden en zayıfa doğru).

Oturum Belirteci
x-ms-session-token string

Oturum düzeyi tutarlılığı ile kullanılan dize belirteci.

Etkinlik kimliği
x-ms-activity-id string

sunucu yanıtında yankılanacak işlem için bir istemci tarafından sağlanan tanımlayıcı.

Azure Cosmos DB hesap adı
cosmosDbAccountName True string

Azure Cosmos DB hesap adı (documents.azure.com olmadan).

Veritabanı Kimliği
databaseId True string

Veritabanının adı.

Koleksiyon Kimliği
collectionId True string

Koleksiyonun adı.

API sürümü
x-ms-version string

API sürümü.

Döndürülenler

Tüm belgeleri alma [KULLANIM DIŞI]

Bu eylem kullanım dışı bırakıldı. Lütfen Bunun yerine Tüm belgeleri al (V3) kullanın.

Tüm belgeleri alın.

Parametreler

Name Anahtar Gerekli Tür Description
Bölüm anahtarı değeri
x-ms-documentdb-raw-partitionkey string

İstenen belge veya ek işlemi için bölüm anahtarı değeri.

En Fazla Öğe Sayısı
x-ms-max-item-count number

Sayfa başına döndürülecek en fazla öğe sayısını gösteren tamsayı.

Devamlılık Belirteci
x-ms-continuation string

Okunacak daha fazla sonuç varsa sorgular ve okuma akışı işlemleri için döndürülen dize belirteci.

Tutarlılık Düzeyi
x-ms-consistency-level string

Bu, tutarlılık düzeyi geçersiz kılma işlemidir. Geçerli değerler şunlardır: Strong, Bounded, Session veya Eventual (en güçlüden en zayıfa doğru).

Oturum Belirteci
x-ms-session-token string

Oturum düzeyi tutarlılığı ile kullanılan dize belirteci.

Etkinlik kimliği
x-ms-activity-id string

sunucu yanıtında yankılanacak işlem için bir istemci tarafından sağlanan tanımlayıcı.

Veritabanı Kimliği
databaseId True string

Veritabanının adı.

Koleksiyon Kimliği
collectionId True string

Koleksiyonun adı.

API sürümü
x-ms-version string

API sürümü.

Döndürülenler

Tüm belgeleri alma V2 [KULLANIM DIŞI]

Bu eylem kullanım dışı bırakıldı. Lütfen Bunun yerine Tüm belgeleri al (V3) kullanın.

Tüm belgeleri alma V2.

Parametreler

Name Anahtar Gerekli Tür Description
Veritabanı Kimliği
databaseId True string

Veritabanının adı.

Koleksiyon Kimliği
collectionId True string

Koleksiyonun adı.

Bölüm anahtarı değeri
partitionKey string

Boşsa, tüm bölümler belgeleri aramak için kullanılır.

En Fazla Öğe Sayısı
maxItemCount integer

Sayfa başına döndürülecek en fazla öğe sayısını gösteren tamsayı.

Devamlılık Belirteci
continuationToken string

Ek sonuçları getirmek için bir belirteç.

Tutarlılık Düzeyi
consistencyLevel string

Akış (sorgu/okuma akışı) işlemi için tutarlılık düzeyi gereklidir.

Oturum Belirteci
sessionToken string

Oturum tutarlılığı ile kullanılacak oturum belirteci.

Döndürülenler

İstenen sorgu ve ilgili meta verilerle eşleşen belge dizisi.

Tanımlar

QueryDocumentsResponse

İstenen sorgu ve ilgili meta verilerle eşleşen belge dizisi.

Name Yol Tür Description
Documents
Documents array of ObjectWithoutType

İstekle eşleşen belge dizisi.

Belge Sayısı
_count integer

Belge sayısı.

Etkinlik Kimliği
ActivityId string

Azure Cosmos DB hizmet etkinliği kimliği.

DocumentsCollection

İstenen sorgu ve ilgili meta verilerle eşleşen belge dizisi.

Name Yol Tür Description
Documents
value array of ObjectWithoutType
Devamlılık Belirteci
ContinuationToken string
Belge Sayısı
Count integer
Ücret İste
RequestCharge double
Oturum Belirteci
SessionToken string
Etkinlik Kimliği
ActivityId string

postDocumentsResponse

Name Yol Tür Description
_rid
_rid string
_Ts
_ts integer
_kendi
_self string
_etag
_etag string
_Ekleri
_attachments string
kimlik
id string

putDocumentResponse

Name Yol Tür Description
_rid
_rid string
kimlik
id string

getDocumentsResponse

Name Yol Tür Description
_rid
_rid string
Documents
Documents array of object

queryResponse

Name Yol Tür Description
_rid
_rid string
_saymak
_count number
Documents
Documents array of

getStoredProceduresResponse

Name Yol Tür Description
_saymak
_count integer

_saymak

_rid
_rid string

_rid

Saklı Prosedürler
StoredProcedures array of object

Saklı Prosedürler

_etag
StoredProcedures._etag string

_etag

_rid
StoredProcedures._rid string

_rid

_kendi
StoredProcedures._self string

_kendi

_Ts
StoredProcedures._ts integer

_Ts

body
StoredProcedures.body string

body

kimlik
StoredProcedures.id string

kimlik

createStoredProcedureResponse

Name Yol Tür Description
_etag
_etag string

_etag

_rid
_rid string

_rid

_kendi
_self string

_kendi

_Ts
_ts integer

_Ts

body
body string

body

kimlik
id string

kimlik

ObjectWithoutType

String

Bu, 'string' temel veri türüdür.

object

Bu , 'object' türüdür.