Azure Cosmos DB

Az Azure Cosmos DB egy globálisan elosztott, többmodelles adatbázis-szolgáltatás, amely lehetővé teszi az átviteli sebesség és a tárolás rugalmas és egymástól független méretezését tetszőleges számú földrajzi régióban, átfogó SLA-val.

Ez az összekötő a következő termékekben és régiókban érhető el:

Service Class Régiók
Copilot Studio prémium Minden Power Automate-régió
Logic Apps Standard Minden Logic Apps-régió
Power Apps - Nem elérhető
Power Automate prémium Minden Power Automate-régió
Contact
Név Azure Cosmos DB
URL https://learn.microsoft.com/en-us/connectors/documentdb/
Email idcknowledgeeco@microsoft.com
Összekötő metaadatai
Kiadó Microsoft
Webhely https://www.office.com/
Adatvédelmi irányelvek https://privacy.microsoft.com/
Categories AI; Üzleti intelligencia

Az integráció használatához az Azure Portalon konfigurált Cosmos DB SQL API-fiókra lesz szüksége. Vegye figyelembe, hogy a Mongo DB API-fiókok jelenleg nem támogatottak.

Az SQL API-fiók létrehozása után adja meg a fiókazonosítót (documents.azure.com nélkül), amikor kapcsolatot hoz létre az Azure Cosmos DB-összekötővel, ha létrehoz egy típusú kapcsolatot Access Key . Ez a fiókazonosító a Microsoft Entra ID hitelesítést támogató újabb műveleti verziókhoz is szükséges.

Microsoft Entra ID-hitelesítés és Cosmos DB-összekötő

A Microsoft Entra ID-hitelesítés használatához a használt fiókot hozzá kell rendelni egy adott szerepkör-hozzárendeléshez. További információ: Szerepköralapú hozzáférés-vezérlés konfigurálása a Microsoft Entra-azonosítóval az Azure Cosmos DB-fiókhoz.

Megjegyzés:

Csak az adathozzáféréshez explicit módon definiált szerepkörök teszik lehetővé, hogy egy biztonsági tag hozzáférjen a Cosmos DB-adatokhoz. Olyan beépített szerepkörök, mint például Ownera Contributor Cosmos DB-adatokhoz való hozzáférés a fiókon belül a Microsoft Entra-azonosítón keresztül. Az Azure Cosmos DB két beépített szerepkört fed le:

  1. Cosmos DB Built-in Data Reader (szerepkördefiníció azonosítója 00000000-0000-0000-0000-000000000001)
  2. Cosmos DB Built-in Data Contributor (szerepkördefiníció azonosítója 00000000-0000-0000-0000-000000000002)

A szerepkörök számos módon hozzárendelhetők, és egyéni szerepkörök hozhatók létre a részletesebb hozzáférés érdekében.

Íme egy példa arra, hogy kihez rendeljen a Cosmos DB Built-in Data Reader PowerShell használatával (további információ a New-AzCosmosDBSqlRoleAssignment parancsról):

$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 "/"

A szerepkör-hozzárendelések hozzáadásának sikertelensége az alábbihoz hasonló jogosulatlan kérésekkel végződik: Request is blocked because principal [<<principal-id>>] does not have the required RBAC permissions to perform action <unauthorized actions>.

Megjegyzés:

Az Azure Cosmos DB nem támogatja a Microsoft Entra ID-hitelesítéssel végzett felügyeleti műveleteket ( itt dokumentálva). A következő műveletek csak a kapcsolatokkal Access Key működnek:

  1. Tárolt eljárás létrehozása (V1- és V2-verziók)
  2. Tárolt eljárás törlése (V1- és V2-verziók)
  3. Tárolt eljárás frissítése (V1 és V2 verziók)

A Microsoft Entra ID-hitelesítéssel nem támogatott műveletek

A Microsoft Entra ID-hitelesítés használatakor csak a Cosmos DB-fiók nevével paraméterként támogatott műveletek támogatottak. Az elavult műveletek továbbra is működni fognak a hitelesítéssel Access Key , de sikertelenek lesznek, ha Microsoft Entra ID-kapcsolattal használják.

Ismert problémák és korlátozások

Kapcsolat létrehozása

Az összekötő a következő hitelesítési típusokat támogatja:

[variables('keyBasedAuthDefaultDisplayName')] [variables('keyBasedAuthDefaultDescription')] A Azure Government és a Védelmi Minisztérium (DoD) kivételével minden régió Azure Government, a MOONCAKE és az USA kormánya (GCC-High) és az USA kormánya (GCC) területén Megosztható
[variables('oauthDefaultDisplayName')] [variables('oauthDefaultDescription')] A Azure Government és a Védelmi Minisztérium (DoD) kivételével minden régió Azure Government, a MOONCAKE és az USA kormánya (GCC-High) és az USA kormánya (GCC) területén Nem osztható meg
Hozzáférési kulcs Adja meg a fiók nevét és hozzáférési kulcsát a Cosmos DB-fiók eléréséhez. CSAK MOONCAKE Megosztható
Hozzáférési kulcs (Azure Government) Adja meg a fiók nevét és hozzáférési kulcsát a Cosmos DB-fiók eléréséhez. Azure Government és a Védelmi Minisztérium (DoD) csak az Azure Government és az USA kormányában (GCC-High) és az USA kormányában (GCC) Megosztható
Felügyelt identitás Kapcsolat létrehozása felügyelt identitással Csak LOGICAPPS Megosztható
Microsoft Entra ID integrált Az Azure Blob Storage eléréséhez használja a Microsoft Entra ID azonosítót. CSAK MOONCAKE Nem osztható meg
Microsoft Entra ID Integrált (Azure Kereskedelmi) A Microsoft Entra ID-vel elérheti az Azure Blob Storage-t az Azure Commercialben. Csak AZ USA kormánya (GCC) Nem osztható meg
Microsoft Entra ID Integrált (Azure Government) Az Azure Blob Storage eléréséhez használja a Microsoft Entra ID azonosítót. Azure Government és a Védelmi Minisztérium (DoD) csak az Azure Government és az USA kormányában (GCC-High) és az USA kormányában (GCC) Nem osztható meg
Alapértelmezett [ELAVULT] Ez a beállítás csak olyan régebbi kapcsolatokhoz használható, amelyeknek nincs explicit hitelesítési típusuk, és csak a visszamenőleges kompatibilitást biztosítják. Minden régió Nem osztható meg

[variables('keyBasedAuthDefaultDisplayName')]

Hitelesítési azonosító: keyBasedAuth

Alkalmazható: Az Azure Government és a Védelmi Minisztérium (DoD) kivételével minden régió Azure Government és MOONCAKE és US Government (GCC-High) és US Government (GCC) területén

[variables('keyBasedAuthDefaultDescription')]

Ez megosztható kapcsolat. Ha a power app meg van osztva egy másik felhasználóval, a kapcsolat is meg van osztva. További információkért tekintse meg a vászonalapú alkalmazások összekötőinek áttekintését – Power Apps | Microsoft Docs

Név Típus Description Kötelező
Fiókazonosító karakterlánc A fiók neve "documents.azure.com" rész nélkül True
Hozzáférési kulcs az Azure Cosmos DB-fiókhoz securestring Elsődleges vagy másodlagos kulcs True

[variables('oauthDefaultDisplayName')]

Hitelesítési azonosító: tokenBasedAuth

Alkalmazható: Az Azure Government és a Védelmi Minisztérium (DoD) kivételével minden régió Azure Government és MOONCAKE és US Government (GCC-High) és US Government (GCC) területén

[variables('oauthDefaultDescription')]

Ez nem megosztható kapcsolat. Ha a power app meg van osztva egy másik felhasználóval, a rendszer kérni fogja, hogy hozzon létre új kapcsolatot.

Hozzáférési kulcs

Hitelesítési azonosító: keyBasedAuth

Alkalmazható: csak MOONCAKE

Adja meg a fiók nevét és hozzáférési kulcsát a Cosmos DB-fiók eléréséhez.

Ez megosztható kapcsolat. Ha a power app meg van osztva egy másik felhasználóval, a kapcsolat is meg van osztva. További információkért tekintse meg a vászonalapú alkalmazások összekötőinek áttekintését – Power Apps | Microsoft Docs

Név Típus Description Kötelező
Fiókazonosító karakterlánc A fiók neve "documents.azure.com" rész nélkül True
Hozzáférési kulcs az Azure Cosmos DB-fiókhoz securestring Elsődleges vagy másodlagos kulcs True

Hozzáférési kulcs (Azure Government)

Hitelesítési azonosító: keyBasedAuth

Alkalmazható: Azure Government és a Védelmi Minisztérium (DoD) Azure Government és az EGYESÜLT Államok kormányában (GCC-High) és az USA kormányában (GCC) csak

Adja meg a fiók nevét és hozzáférési kulcsát a Cosmos DB-fiók eléréséhez.

Ez megosztható kapcsolat. Ha a power app meg van osztva egy másik felhasználóval, a kapcsolat is meg van osztva. További információkért tekintse meg a vászonalapú alkalmazások összekötőinek áttekintését – Power Apps | Microsoft Docs

Név Típus Description Kötelező
Fiókazonosító karakterlánc A fiók neve "documents.azure.com" rész nélkül True
Hozzáférési kulcs az Azure Cosmos DB-fiókhoz securestring Elsődleges vagy másodlagos kulcs True

Felügyelt identitás

Hitelesítési azonosító: managedIdentityAuth

Alkalmazható: csak LOGICAPPS

Kapcsolat létrehozása felügyelt identitással

Ez megosztható kapcsolat. Ha a power app meg van osztva egy másik felhasználóval, a kapcsolat is meg van osztva. További információkért tekintse meg a vászonalapú alkalmazások összekötőinek áttekintését – Power Apps | Microsoft Docs

Név Típus Description Kötelező
Felügyelt identitás managedIdentity Bejelentkezés felügyelt identitással True

Microsoft Entra id integrated

Hitelesítési azonosító: tokenBasedAuth

Alkalmazható: csak MOONCAKE

Az Azure Blob Storage eléréséhez használja a Microsoft Entra ID azonosítót.

Ez nem megosztható kapcsolat. Ha a power app meg van osztva egy másik felhasználóval, a rendszer kérni fogja, hogy hozzon létre új kapcsolatot.

Integrált Microsoft Entra ID (Azure Commercial)

Hitelesítési azonosító: oauthCom

Alkalmazható: csak az EGYESÜLT Államok kormánya (GCC)

A Microsoft Entra ID-vel elérheti az Azure Blob Storage-t az Azure Commercialben.

Ez nem megosztható kapcsolat. Ha a power app meg van osztva egy másik felhasználóval, a rendszer kérni fogja, hogy hozzon létre új kapcsolatot.

Integrált Microsoft Entra ID (Azure Government)

Hitelesítési azonosító: tokenBasedAuth

Alkalmazható: Azure Government és a Védelmi Minisztérium (DoD) Azure Government és az EGYESÜLT Államok kormányában (GCC-High) és az USA kormányában (GCC) csak

Az Azure Blob Storage eléréséhez használja a Microsoft Entra ID azonosítót.

Ez nem megosztható kapcsolat. Ha a power app meg van osztva egy másik felhasználóval, a rendszer kérni fogja, hogy hozzon létre új kapcsolatot.

Alapértelmezett [ELAVULT]

Alkalmazható: Minden régió

Ez a beállítás csak olyan régebbi kapcsolatokhoz használható, amelyeknek nincs explicit hitelesítési típusuk, és csak a visszamenőleges kompatibilitást biztosítják.

Ez nem megosztható kapcsolat. Ha a power app meg van osztva egy másik felhasználóval, a rendszer kérni fogja, hogy hozzon létre új kapcsolatot.

Név Típus Description Kötelező
Fiókazonosító karakterlánc A fiók neve "documents.azure.com" rész nélkül True
Hozzáférési kulcs az Azure Cosmos DB-fiókhoz securestring Elsődleges vagy másodlagos kulcs True

Szabályozási korlátok

Név Hívások Megújítási időszak
API-hívások kapcsolatonként 1500 60 másodperc

Műveletek

Az összes dokumentum lekérése (V3)

Az összes dokumentum lekérése (V3).

Az összes dokumentum lekérése [ELAVULT]

Ez a művelet elavult. Ehelyett használja az Összes dokumentum lekérése (V3) elemet .

Szerezze be az összes dokumentumot.

Az összes dokumentum lekérése v2 [ELAVULT]

Ez a művelet elavult. Ehelyett használja az Összes dokumentum lekérése (V3) elemet .

Az összes dokumentum lekérése v2.

Dokumentum cseréje (V2)

Dokumentum cseréje (V2).

Dokumentum cseréje [ELAVULT]

Ez a művelet elavult. Ehelyett használja a Dokumentum cseréje (V2) elemet .

Dokumentum cseréje.

Dokumentum lekérése (V2)

Dokumentum lekérése (V2).

Dokumentum lekérése [ELAVULT]

Ez a művelet elavult. Használja helyette a Dokumentum lekérése (V2) elemet .

Dokumentum lekérése.

Dokumentum létrehozása vagy frissítése (V2) [ELAVULT]

Ez a művelet elavult. Használja inkább a Dokumentum létrehozása vagy frissítése (V3) elemet .

Dokumentum létrehozása vagy frissítése. Amikor dokumentumot hoz létre a DocumentDB-ben, a törzsnek tartalmaznia kell egy azonosító tulajdonságot.

Dokumentum létrehozása vagy frissítése (V3)

Dokumentum létrehozása vagy frissítése. Amikor dokumentumot hoz létre a DocumentDB-ben, a törzsnek tartalmaznia kell egy azonosító tulajdonságot.

Dokumentum létrehozása vagy frissítése [ELAVULT]

Ez a művelet elavult. Használja inkább a Dokumentum létrehozása vagy frissítése (V3) elemet .

Dokumentum létrehozása vagy frissítése. Amikor dokumentumot hoz létre a DocumentDB-ben, a törzsnek tartalmaznia kell egy azonosító tulajdonságot.

Dokumentum törlése (V2)

Dokumentum törlése (V2).

Dokumentum törlése [ELAVULT]

Ez a művelet elavult. Ehelyett használja a Dokumentum törlése (V2) parancsot .

Dokumentum törlése.

Dokumentumok lekérdezése [ELAVULT]

Ez a művelet elavult. Használja inkább a V5-ös lekérdezési dokumentumokat .

Dokumentumok lekérdezése.

Dokumentumok lekérdezése V2 [ELAVULT]

Ez a művelet elavult. Használja inkább a V5-ös lekérdezési dokumentumokat .

Dokumentumok lekérdezése v2.

Dokumentumok lekérdezése V3 [ELAVULT]

Ez a művelet elavult. Használja inkább a V5-ös lekérdezési dokumentumokat .

Dokumentumok lekérdezése V3.

Dokumentumok lekérdezése V4 [ELAVULT]

Ez a művelet elavult. Használja inkább a V5-ös lekérdezési dokumentumokat .

Dokumentumok lekérdezése v4.

Dokumentumok lekérdezése V5

Dokumentumok lekérdezése (V5).

Tárolt eljárás cseréje (V2)

Cserélje le a tárolt eljárást (V2).

Tárolt eljárás cseréje [ELAVULT]

Ez a művelet elavult. Ehelyett használja a Tárolt eljárás cseréje (V2) parancsot.

Cserélje le a tárolt eljárást.

Tárolt eljárás létrehozása (V2)

Tárolt eljárás létrehozása (V2).

Tárolt eljárás létrehozása [ELAVULT]

Ez a művelet elavult. Ehelyett használja a Tárolt eljárás létrehozása (V2) parancsot.

Tárolt eljárás létrehozása.

Tárolt eljárás törlése (V2)

Tárolt eljárás törlése (V2).

Tárolt eljárás törlése [ELAVULT]

Ez a művelet elavult. Ehelyett használja a Tárolt törlési eljárást (V2).

Tárolt eljárás törlése.

Tárolt eljárás végrehajtása (V2)

Tárolt eljárás végrehajtása a megadott gyűjteményben (V2).

Tárolt eljárás végrehajtása [ELAVULT]

Ez a művelet elavult. Ehelyett használja a Tárolt eljárás végrehajtása (V2) parancsot.

Tárolt eljárás végrehajtása a megadott gyűjteményben.

Tárolt eljárások lekérése (V2)

Tárolt eljárások lekérése a megadott gyűjteményben (V2).

Tárolt eljárások lekérése [ELAVULT]

Ez a művelet elavult. Ehelyett használja a Tárolt eljárások lekérése (V2) parancsot .

Tárolt eljárások lekérése a megadott gyűjteményben.

Az összes dokumentum lekérése (V3)

Az összes dokumentum lekérése (V3).

Paraméterek

Név Kulcs Kötelező Típus Description
Partíciókulcs értéke
x-ms-documentdb-raw-partitionkey string

A kért dokumentum- vagy mellékletművelet partíciókulcs-értéke.

Maximális elemszám
x-ms-max-item-count number

Egész szám, amely az oldalonként visszaadandó elemek maximális számát jelzi.

Folytatási jogkivonat
x-ms-continuation string

A lekérdezésekhez és az olvasási hírcsatorna műveleteihez visszaadott sztring jogkivonat, ha több eredményt kell olvasni.

Konzisztenciaszint
x-ms-consistency-level string

Ez a 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).

Munkamenet-jogkivonat
x-ms-session-token string

Munkamenetszintű konzisztenciával használt sztring jogkivonat.

Tevékenységazonosító
x-ms-activity-id string

Egy ügyfél által megadott azonosító a művelethez, amely a kiszolgáló válaszában lesz visszhangzik.

Azure Cosmos DB-fiók neve
cosmosDbAccountName True string

Az Azure Cosmos DB-fiók neve (documents.azure.com nélkül).

Adatbázis-azonosító
databaseId True string

Az adatbázis neve.

Gyűjtemény azonosítója
collectionId True string

A gyűjtemény neve.

API-verzió
x-ms-version string

API-verzió.

Bizalmassági címke kinyerése
extractSensitivityLabel boolean

Adja meg, hogy mip-címkéket szeretne-e kinyerni.

Purview Acccount Name
purviewAccountName string

Az alapértelmezett gyűjtemény lekérdezve lesz, kivéve, ha meg van adva.

Válaszok

Név Elérési út Típus Description
_megszabadít
_rid string
Documents
Documents array of object
@metadata
@metadata array of DataWithSensitivityLabelInfo

Az oszlopok listája a bizalmassági címkékkel együtt

Az összes dokumentum lekérése [ELAVULT]

Ez a művelet elavult. Ehelyett használja az Összes dokumentum lekérése (V3) elemet .

Szerezze be az összes dokumentumot.

Paraméterek

Név Kulcs Kötelező Típus Description
Partíciókulcs értéke
x-ms-documentdb-raw-partitionkey string

A kért dokumentum- vagy mellékletművelet partíciókulcs-értéke.

Maximális elemszám
x-ms-max-item-count number

Egész szám, amely az oldalonként visszaadandó elemek maximális számát jelzi.

Folytatási jogkivonat
x-ms-continuation string

A lekérdezésekhez és az olvasási hírcsatorna műveleteihez visszaadott sztring jogkivonat, ha több eredményt kell olvasni.

Konzisztenciaszint
x-ms-consistency-level string

Ez a 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).

Munkamenet-jogkivonat
x-ms-session-token string

Munkamenetszintű konzisztenciával használt sztring jogkivonat.

Tevékenységazonosító
x-ms-activity-id string

Egy ügyfél által megadott azonosító a művelethez, amely a kiszolgáló válaszában lesz visszhangzik.

Adatbázis-azonosító
databaseId True string

Az adatbázis neve.

Gyűjtemény azonosítója
collectionId True string

A gyűjtemény neve.

API-verzió
x-ms-version string

API-verzió.

Válaszok

Az összes dokumentum lekérése v2 [ELAVULT]

Ez a művelet elavult. Ehelyett használja az Összes dokumentum lekérése (V3) elemet .

Az összes dokumentum lekérése v2.

Paraméterek

Név Kulcs Kötelező Típus Description
Adatbázis-azonosító
databaseId True string

Az adatbázis neve.

Gyűjtemény azonosítója
collectionId True string

A gyűjtemény neve.

Partíciókulcs értéke
partitionKey string

Ha üres, a rendszer az összes partíciót a dokumentumok keresésére használja.

Maximális elemszám
maxItemCount integer

Egész szám, amely az oldalonként visszaadandó elemek maximális számát jelzi.

Folytatási jogkivonat
continuationToken string

Jogkivonat további eredmények lekéréséhez.

Konzisztenciaszint
consistencyLevel string

A hírcsatorna (lekérdezési/olvasási csatorna) műveletéhez szükséges konzisztenciaszint.

Munkamenet-jogkivonat
sessionToken string

A munkamenet-konzisztenciával használható munkamenet-jogkivonat.

Válaszok

A kért lekérdezésnek és a kapcsolódó metaadatoknak megfelelő dokumentumok tömbje.

Dokumentum cseréje (V2)

Dokumentum cseréje (V2).

Paraméterek

Név Kulcs Kötelező Típus Description
Partíciókulcs értéke
x-ms-documentdb-raw-partitionkey string

A kért dokumentum- vagy mellékletművelet partíciókulcs-értéke.

Maximális elemszám
x-ms-max-item-count number

Egész szám, amely az oldalonként visszaadandó elemek maximális számát jelzi.

Folytatási jogkivonat
x-ms-continuation string

A lekérdezésekhez és az olvasási hírcsatorna műveleteihez visszaadott sztring jogkivonat, ha több eredményt kell olvasni.

Konzisztenciaszint
x-ms-consistency-level string

Ez a 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).

Munkamenet-jogkivonat
x-ms-session-token string

Munkamenetszintű konzisztenciával használt sztring jogkivonat.

Tevékenységazonosító
x-ms-activity-id string

Egy ügyfél által megadott azonosító a művelethez, amely a kiszolgáló válaszában lesz visszhangzik.

Eseményindító előtti
x-ms-documentdb-pre-trigger-include string

A dokumentumművelet végrehajtása előtt futtatandó eseményindítók vesszővel tagolt listája.

Eseményindító utáni
x-ms-documentdb-post-trigger-include string

A dokumentumművelet végrehajtása után futtatandó eseményindítók vesszővel tagolt listája.

Azure Cosmos DB-fiók neve
cosmosDbAccountName True string

Az Azure Cosmos DB-fiók neve (documents.azure.com nélkül).

Adatbázis-azonosító
databaseId True string

Az adatbázis neve.

Gyűjtemény azonosítója
collectionId True string

A gyűjtemény neve.

Dokumentumazonosító
documentId True string

A dokumentum azonosítója.

API-verzió
x-ms-version string

API-verzió.

Válaszok

Dokumentum cseréje [ELAVULT]

Ez a művelet elavult. Ehelyett használja a Dokumentum cseréje (V2) elemet .

Dokumentum cseréje.

Paraméterek

Név Kulcs Kötelező Típus Description
Partíciókulcs értéke
x-ms-documentdb-raw-partitionkey string

A kért dokumentum- vagy mellékletművelet partíciókulcs-értéke.

Maximális elemszám
x-ms-max-item-count number

Egész szám, amely az oldalonként visszaadandó elemek maximális számát jelzi.

Folytatási jogkivonat
x-ms-continuation string

A lekérdezésekhez és az olvasási hírcsatorna műveleteihez visszaadott sztring jogkivonat, ha több eredményt kell olvasni.

Konzisztenciaszint
x-ms-consistency-level string

Ez a 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).

Munkamenet-jogkivonat
x-ms-session-token string

Munkamenetszintű konzisztenciával használt sztring jogkivonat.

Tevékenységazonosító
x-ms-activity-id string

Egy ügyfél által megadott azonosító a művelethez, amely a kiszolgáló válaszában lesz visszhangzik.

Eseményindító előtti
x-ms-documentdb-pre-trigger-include string

A dokumentumművelet végrehajtása előtt futtatandó eseményindítók vesszővel tagolt listája.

Eseményindító utáni
x-ms-documentdb-post-trigger-include string

A dokumentumművelet végrehajtása után futtatandó eseményindítók vesszővel tagolt listája.

Adatbázis-azonosító
databaseId True string

Az adatbázis neve.

Gyűjtemény azonosítója
collectionId True string

A gyűjtemény neve.

Dokumentumazonosító
documentId True string

A dokumentum azonosítója.

API-verzió
x-ms-version string

API-verzió.

Válaszok

Dokumentum lekérése (V2)

Dokumentum lekérése (V2).

Paraméterek

Név Kulcs Kötelező Típus Description
Partíciókulcs értéke
x-ms-documentdb-raw-partitionkey string

A kért dokumentum- vagy mellékletművelet partíciókulcs-értéke.

Maximális elemszám
x-ms-max-item-count number

Egész szám, amely az oldalonként visszaadandó elemek maximális számát jelzi.

Folytatási jogkivonat
x-ms-continuation string

A lekérdezésekhez és az olvasási hírcsatorna műveleteihez visszaadott sztring jogkivonat, ha több eredményt kell olvasni.

Konzisztenciaszint
x-ms-consistency-level string

Ez a 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).

Munkamenet-jogkivonat
x-ms-session-token string

Munkamenetszintű konzisztenciával használt sztring jogkivonat.

Tevékenységazonosító
x-ms-activity-id string

Egy ügyfél által megadott azonosító a művelethez, amely a kiszolgáló válaszában lesz visszhangzik.

Azure Cosmos DB-fiók neve
cosmosDbAccountName True string

Az Azure Cosmos DB-fiók neve (documents.azure.com nélkül).

Adatbázis-azonosító
databaseId True string

Az adatbázis neve.

Gyűjtemény azonosítója
collectionId True string

A gyűjtemény neve.

Bizalmassági címke kinyerése
extractSensitivityLabel boolean

Adja meg, hogy mip-címkéket szeretne-e kinyerni.

Purview Acccount Name
purviewAccountName string

Az alapértelmezett gyűjtemény lekérdezve lesz, kivéve, ha meg van adva.

Dokumentumazonosító
documentId True string

A dokumentum azonosítója.

API-verzió
x-ms-version string

API-verzió.

Válaszok

Név Elérési út Típus Description
@metadata
@metadata array of DataWithSensitivityLabelInfo

Az oszlopok listája a bizalmassági címkékkel együtt

Dokumentum lekérése [ELAVULT]

Ez a művelet elavult. Használja helyette a Dokumentum lekérése (V2) elemet .

Dokumentum lekérése.

Paraméterek

Név Kulcs Kötelező Típus Description
Partíciókulcs értéke
x-ms-documentdb-raw-partitionkey string

A kért dokumentum- vagy mellékletművelet partíciókulcs-értéke.

Maximális elemszám
x-ms-max-item-count number

Egész szám, amely az oldalonként visszaadandó elemek maximális számát jelzi.

Folytatási jogkivonat
x-ms-continuation string

A lekérdezésekhez és az olvasási hírcsatorna műveleteihez visszaadott sztring jogkivonat, ha több eredményt kell olvasni.

Konzisztenciaszint
x-ms-consistency-level string

Ez a 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).

Munkamenet-jogkivonat
x-ms-session-token string

Munkamenetszintű konzisztenciával használt sztring jogkivonat.

Tevékenységazonosító
x-ms-activity-id string

Egy ügyfél által megadott azonosító a művelethez, amely a kiszolgáló válaszában lesz visszhangzik.

Adatbázis-azonosító
databaseId True string

Az adatbázis neve.

Gyűjtemény azonosítója
collectionId True string

A gyűjtemény neve.

Dokumentumazonosító
documentId True string

A dokumentum azonosítója.

API-verzió
x-ms-version string

API-verzió.

Válaszok

response
object

Dokumentum létrehozása vagy frissítése (V2) [ELAVULT]

Ez a művelet elavult. Használja inkább a Dokumentum létrehozása vagy frissítése (V3) elemet .

Dokumentum létrehozása vagy frissítése. Amikor dokumentumot hoz létre a DocumentDB-ben, a törzsnek tartalmaznia kell egy azonosító tulajdonságot.

Paraméterek

Név Kulcs Kötelező Típus Description
Maximális elemszám
x-ms-max-item-count number

Egész szám, amely az oldalonként visszaadandó elemek maximális számát jelzi.

Folytatási jogkivonat
x-ms-continuation string

A lekérdezésekhez és az olvasási hírcsatorna műveleteihez visszaadott sztring jogkivonat, ha több eredményt kell olvasni.

Konzisztenciaszint
x-ms-consistency-level string

Ez a 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).

Munkamenet-jogkivonat
x-ms-session-token string

Munkamenetszintű konzisztenciával használt sztring jogkivonat.

Tevékenységazonosító
x-ms-activity-id string

Egy ügyfél által megadott azonosító a művelethez, amely a kiszolgáló válaszában lesz visszhangzik.

IsUpsert
x-ms-documentdb-is-upsert boolean

Ha igaz értékre van állítva, a program lecseréli a dokumentumot, ha létezik másként létrehozva.

Eseményindító előtti
x-ms-documentdb-pre-trigger-include string

A dokumentumművelet végrehajtása előtt futtatandó eseményindítók vesszővel tagolt listája.

Eseményindító utáni
x-ms-documentdb-post-trigger-include string

A dokumentumművelet végrehajtása után futtatandó eseményindítók vesszővel tagolt listája.

Adatbázis-azonosító
databaseId True string

Az adatbázis neve.

Gyűjtemény azonosítója
collectionId True string

A gyűjtemény neve.

API-verzió
x-ms-version string

API-verzió.

Válaszok

Dokumentum létrehozása vagy frissítése (V3)

Dokumentum létrehozása vagy frissítése. Amikor dokumentumot hoz létre a DocumentDB-ben, a törzsnek tartalmaznia kell egy azonosító tulajdonságot.

Paraméterek

Név Kulcs Kötelező Típus Description
Maximális elemszám
x-ms-max-item-count number

Egész szám, amely az oldalonként visszaadandó elemek maximális számát jelzi.

Folytatási jogkivonat
x-ms-continuation string

A lekérdezésekhez és az olvasási hírcsatorna műveleteihez visszaadott sztring jogkivonat, ha több eredményt kell olvasni.

Konzisztenciaszint
x-ms-consistency-level string

Ez a 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).

Munkamenet-jogkivonat
x-ms-session-token string

Munkamenetszintű konzisztenciával használt sztring jogkivonat.

Tevékenységazonosító
x-ms-activity-id string

Egy ügyfél által megadott azonosító a művelethez, amely a kiszolgáló válaszában lesz visszhangzik.

IsUpsert
x-ms-documentdb-is-upsert boolean

Ha igaz értékre van állítva, a program lecseréli a dokumentumot, ha létezik másként létrehozva.

Eseményindító előtti
x-ms-documentdb-pre-trigger-include string

A dokumentumművelet végrehajtása előtt futtatandó eseményindítók vesszővel tagolt listája.

Eseményindító utáni
x-ms-documentdb-post-trigger-include string

A dokumentumművelet végrehajtása után futtatandó eseményindítók vesszővel tagolt listája.

Azure Cosmos DB-fiók neve
cosmosDbAccountName True string

Az Azure Cosmos DB-fiók neve (documents.azure.com nélkül).

Adatbázis-azonosító
databaseId True string

Az adatbázis neve.

Gyűjtemény azonosítója
collectionId True string

A gyűjtemény neve.

API-verzió
x-ms-version string

API-verzió.

Válaszok

Dokumentum létrehozása vagy frissítése [ELAVULT]

Ez a művelet elavult. Használja inkább a Dokumentum létrehozása vagy frissítése (V3) elemet .

Dokumentum létrehozása vagy frissítése. Amikor dokumentumot hoz létre a DocumentDB-ben, a törzsnek tartalmaznia kell egy azonosító tulajdonságot.

Paraméterek

Név Kulcs Kötelező Típus Description
Partíciókulcs értéke
x-ms-documentdb-raw-partitionkey string

A kért dokumentum- vagy mellékletművelet partíciókulcs-értéke.

Maximális elemszám
x-ms-max-item-count number

Egész szám, amely az oldalonként visszaadandó elemek maximális számát jelzi.

Folytatási jogkivonat
x-ms-continuation string

A lekérdezésekhez és az olvasási hírcsatorna műveleteihez visszaadott sztring jogkivonat, ha több eredményt kell olvasni.

Konzisztenciaszint
x-ms-consistency-level string

Ez a 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).

Munkamenet-jogkivonat
x-ms-session-token string

Munkamenetszintű konzisztenciával használt sztring jogkivonat.

Tevékenységazonosító
x-ms-activity-id string

Egy ügyfél által megadott azonosító a művelethez, amely a kiszolgáló válaszában lesz visszhangzik.

IsUpsert
x-ms-documentdb-is-upsert boolean

Ha igaz értékre van állítva, a program lecseréli a dokumentumot, ha létezik másként létrehozva.

Eseményindító előtti
x-ms-documentdb-pre-trigger-include string

A dokumentumművelet végrehajtása előtt futtatandó eseményindítók vesszővel tagolt listája.

Eseményindító utáni
x-ms-documentdb-post-trigger-include string

A dokumentumművelet végrehajtása után futtatandó eseményindítók vesszővel tagolt listája.

Adatbázis-azonosító
databaseId True string

Az adatbázis neve.

Gyűjtemény azonosítója
collectionId True string

A gyűjtemény neve.

API-verzió
x-ms-version string

API-verzió.

Válaszok

Dokumentum törlése (V2)

Dokumentum törlése (V2).

Paraméterek

Név Kulcs Kötelező Típus Description
Partíciókulcs értéke
x-ms-documentdb-raw-partitionkey string

A kért dokumentum- vagy mellékletművelet partíciókulcs-értéke.

Maximális elemszám
x-ms-max-item-count number

Egész szám, amely az oldalonként visszaadandó elemek maximális számát jelzi.

Folytatási jogkivonat
x-ms-continuation string

A lekérdezésekhez és az olvasási hírcsatorna műveleteihez visszaadott sztring jogkivonat, ha több eredményt kell olvasni.

Konzisztenciaszint
x-ms-consistency-level string

Ez a 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).

Munkamenet-jogkivonat
x-ms-session-token string

Munkamenetszintű konzisztenciával használt sztring jogkivonat.

Tevékenységazonosító
x-ms-activity-id string

Egy ügyfél által megadott azonosító a művelethez, amely a kiszolgáló válaszában lesz visszhangzik.

Eseményindító előtti
x-ms-documentdb-pre-trigger-include string

A dokumentumművelet végrehajtása előtt futtatandó eseményindítók vesszővel tagolt listája.

Eseményindító utáni
x-ms-documentdb-post-trigger-include string

A dokumentumművelet végrehajtása után futtatandó eseményindítók vesszővel tagolt listája.

Azure Cosmos DB-fiók neve
cosmosDbAccountName True string

Az Azure Cosmos DB-fiók neve (documents.azure.com nélkül).

Adatbázis-azonosító
databaseId True string

Az adatbázis neve.

Gyűjtemény azonosítója
collectionId True string

A gyűjtemény neve.

Dokumentumazonosító
documentId True string

A dokumentum azonosítója.

API-verzió
x-ms-version string

API-verzió.

Dokumentum törlése [ELAVULT]

Ez a művelet elavult. Ehelyett használja a Dokumentum törlése (V2) parancsot .

Dokumentum törlése.

Paraméterek

Név Kulcs Kötelező Típus Description
Partíciókulcs értéke
x-ms-documentdb-raw-partitionkey string

A kért dokumentum- vagy mellékletművelet partíciókulcs-értéke.

Maximális elemszám
x-ms-max-item-count number

Egész szám, amely az oldalonként visszaadandó elemek maximális számát jelzi.

Folytatási jogkivonat
x-ms-continuation string

A lekérdezésekhez és az olvasási hírcsatorna műveleteihez visszaadott sztring jogkivonat, ha több eredményt kell olvasni.

Konzisztenciaszint
x-ms-consistency-level string

Ez a 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).

Munkamenet-jogkivonat
x-ms-session-token string

Munkamenetszintű konzisztenciával használt sztring jogkivonat.

Tevékenységazonosító
x-ms-activity-id string

Egy ügyfél által megadott azonosító a művelethez, amely a kiszolgáló válaszában lesz visszhangzik.

Eseményindító előtti
x-ms-documentdb-pre-trigger-include string

A dokumentumművelet végrehajtása előtt futtatandó eseményindítók vesszővel tagolt listája.

Eseményindító utáni
x-ms-documentdb-post-trigger-include string

A dokumentumművelet végrehajtása után futtatandó eseményindítók vesszővel tagolt listája.

Adatbázis-azonosító
databaseId True string

Az adatbázis neve.

Gyűjtemény azonosítója
collectionId True string

A gyűjtemény neve.

Dokumentumazonosító
documentId True string

A dokumentum azonosítója.

API-verzió
x-ms-version string

API-verzió.

Dokumentumok lekérdezése [ELAVULT]

Ez a művelet elavult. Használja inkább a V5-ös lekérdezési dokumentumokat .

Dokumentumok lekérdezése.

Paraméterek

Név Kulcs Kötelező Típus Description
Partíciókulcs értéke
x-ms-documentdb-raw-partitionkey string

A kért dokumentum- vagy mellékletművelet partíciókulcs-értéke.

Maximális elemszám
x-ms-max-item-count number

Egész szám, amely az oldalonként visszaadandó elemek maximális számát jelzi.

Folytatási jogkivonat
x-ms-continuation string

A lekérdezésekhez és az olvasási hírcsatorna műveleteihez visszaadott sztring jogkivonat, ha több eredményt kell olvasni.

Partíciók közötti engedélyezés
x-ms-documentdb-query-enablecrosspartition boolean

Ha a gyűjtemény particionálva van, akkor ezt True értékre kell állítani, hogy több partíción is lehetővé tegye a végrehajtást.

Konzisztenciaszint
x-ms-consistency-level string

Ez a 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).

Munkamenet-jogkivonat
x-ms-session-token string

Munkamenetszintű konzisztenciával használt sztring jogkivonat.

Tevékenységazonosító
x-ms-activity-id string

Egy ügyfél által megadott azonosító a művelethez, amely a kiszolgáló válaszában lesz visszhangzik.

Adatbázis-azonosító
databaseId True string

Az adatbázis neve.

Gyűjtemény azonosítója
collectionId True string

A gyűjtemény neve.

lekérdezés
query string

Válaszok

Törzs
queryResponse

Dokumentumok lekérdezése V2 [ELAVULT]

Ez a művelet elavult. Használja inkább a V5-ös lekérdezési dokumentumokat .

Dokumentumok lekérdezése v2.

Paraméterek

Név Kulcs Kötelező Típus Description
Adatbázis-azonosító
databaseId True string

Az adatbázis neve.

Gyűjtemény azonosítója
collectionId True string

A gyűjtemény neve.

Lekérdezésszöveg
QueryText string

SQL-szintaxis lekérdezése dokumentumokon keresztül

Partíciókulcs értéke
partitionKey string

Partíciókulcs értéke.

Folytatási jogkivonat
continuationToken string

Jogkivonat a művelet további eredményeinek lekéréséhez.

Válaszok

A kért lekérdezésnek és a kapcsolódó metaadatoknak megfelelő dokumentumok tömbje.

Dokumentumok lekérdezése V3 [ELAVULT]

Ez a művelet elavult. Használja inkább a V5-ös lekérdezési dokumentumokat .

Dokumentumok lekérdezése V3.

Paraméterek

Név Kulcs Kötelező Típus Description
Adatbázis-azonosító
databaseId True string

Az adatbázis neve.

Gyűjtemény azonosítója
collectionId True string

A gyűjtemény neve.

SQL-szintaxis lekérdezése
queryText True string

SQL-lekérdezés.

Partíciókulcs értéke
partitionKey string

Ha üres, a rendszer az összes partíciót a dokumentumok keresésére használja.

Maximális elemszám
maxItemCount integer

Egész szám, amely az oldalonként visszaadandó elemek maximális számát jelzi.

Folytatási jogkivonat
continuationToken string

Jogkivonat további eredmények lekéréséhez.

Partíciók közötti engedélyezés
enableCrossPartition boolean

Azt jelzi, hogy a felhasználó több kérést is küldhet-e a lekérdezés végrehajtásához.

Konzisztenciaszint
consistencyLevel string

A hírcsatorna (lekérdezési/olvasási csatorna) műveletéhez szükséges konzisztenciaszint.

Munkamenet-jogkivonat
sessionToken string

A munkamenet-konzisztenciával használható munkamenet-jogkivonat.

Válaszok

A kért lekérdezésnek és a kapcsolódó metaadatoknak megfelelő dokumentumok tömbje.

Dokumentumok lekérdezése V4 [ELAVULT]

Ez a művelet elavult. Használja inkább a V5-ös lekérdezési dokumentumokat .

Dokumentumok lekérdezése v4.

Paraméterek

Név Kulcs Kötelező Típus Description
Adatbázis-azonosító
databaseId True string

Az adatbázis neve.

Tárolóazonosító
containerId True string

A tároló neve.

SQL-szintaxis lekérdezése
queryText string

SQL-lekérdezés. Ha üres, az összes dokumentumot visszaadja.

Partíciókulcs értéke
partitionKey string

Ha üres, a rendszer az összes partíciót a dokumentumok keresésére használja.

Maximális elemszám
maxItemCount integer

Egész szám, amely az oldalonként visszaadandó elemek maximális számát jelzi.

Folytatási jogkivonat
continuationToken string

Jogkivonat további eredmények lekéréséhez.

Konzisztenciaszint
consistencyLevel string

A hírcsatorna (lekérdezési/olvasási csatorna) műveletéhez szükséges konzisztenciaszint.

Munkamenet-jogkivonat
sessionToken string

A munkamenet-konzisztenciával használható munkamenet-jogkivonat.

Válaszok

A kért lekérdezésnek és a kapcsolódó metaadatoknak megfelelő dokumentumok tömbje.

Dokumentumok lekérdezése V5

Dokumentumok lekérdezése (V5).

Paraméterek

Név Kulcs Kötelező Típus Description
Azure Cosmos DB-fiók neve
cosmosDbAccountName True string

Az Azure Cosmos DB-fiók neve (documents.azure.com nélkül).

Adatbázis-azonosító
databaseId True string

Az adatbázis neve.

Tárolóazonosító
containerId True string

A tároló neve.

SQL-szintaxis lekérdezése
queryText string

SQL-lekérdezés. Ha üres, az összes dokumentumot visszaadja.

Partíciókulcs értéke
partitionKey string

Az értéket a típusának megfelelően kell megadni ("sztring", 42, 0,5). Ha üres, a rendszer az összes partíciót a dokumentumok keresésére használja.

Maximális elemszám
maxItemCount integer

Egész szám, amely az oldalonként visszaadandó elemek maximális számát jelzi.

Folytatási jogkivonat
continuationToken string

Jogkivonat további eredmények lekéréséhez.

Konzisztenciaszint
consistencyLevel string

A hírcsatorna (lekérdezési/olvasási csatorna) műveletéhez szükséges konzisztenciaszint.

Munkamenet-jogkivonat
sessionToken string

A munkamenet-konzisztenciával használható munkamenet-jogkivonat.

Bizalmassági címke kinyerése
extractSensitivityLabel boolean

Adja meg, hogy mip-címkéket szeretne-e kinyerni.

Purview Acccount Name
purviewAccountName string

Az alapértelmezett gyűjtemény lekérdezve lesz, kivéve, ha meg van adva.

Válaszok

Név Elérési út Típus Description
Documents
value array of ObjectWithoutType
Folytatási jogkivonat
ContinuationToken string
Dokumentumok száma
Count integer
Díj kérése
RequestCharge double
Munkamenet-jogkivonat
SessionToken string
Tevékenységazonosító
ActivityId string
@metadata
@metadata array of DataWithSensitivityLabelInfo

Az oszlopok listája a bizalmassági címkékkel együtt

Tárolt eljárás cseréje (V2)

Cserélje le a tárolt eljárást (V2).

Paraméterek

Név Kulcs Kötelező Típus Description
Azure Cosmos DB-fiók neve
cosmosDbAccountName True string

Az Azure Cosmos DB-fiók neve (documents.azure.com nélkül).

Adatbázis-azonosító
databaseId True string

Az adatbázis neve.

Gyűjtemény azonosítója
collectionId True string

A gyűjtemény neve.

Sproc-azonosító
sprocId True string

A tárolt eljárás neve.

Függvénydefiníció
body string

A tárolt eljárást meghatározó függvény, pl. "function(params){ ... }"

azonosító
id string

A meglévő tárolt eljárás azonosítója.

API-verzió
x-ms-version string

API-verzió.

Válaszok

Tárolt eljárás cseréje [ELAVULT]

Ez a művelet elavult. Ehelyett használja a Tárolt eljárás cseréje (V2) parancsot.

Cserélje le a tárolt eljárást.

Paraméterek

Név Kulcs Kötelező Típus Description
Adatbázis-azonosító
databaseId True string

Az adatbázis neve.

Gyűjtemény azonosítója
collectionId True string

A gyűjtemény neve.

Sproc-azonosító
sprocId True string

A tárolt eljárás neve.

Függvénydefiníció
body string

A tárolt eljárást meghatározó függvény, pl. "function(params){ ... }"

azonosító
id string

A meglévő tárolt eljárás azonosítója.

API-verzió
x-ms-version string

API-verzió.

Válaszok

Tárolt eljárás létrehozása (V2)

Tárolt eljárás létrehozása (V2).

Paraméterek

Név Kulcs Kötelező Típus Description
Azure Cosmos DB-fiók neve
cosmosDbAccountName True string

Az Azure Cosmos DB-fiók neve (documents.azure.com nélkül).

Adatbázis-azonosító
databaseId True string

Az adatbázis neve.

Gyűjtemény azonosítója
collectionId True string

A gyűjtemény neve.

Függvénydefiníció
body string

A tárolt eljárást meghatározó függvény, pl. "function(params){ ... }"

azonosító
id string

A tárolt eljárás új azonosítója.

API-verzió
x-ms-version string

API-verzió.

Válaszok

Tárolt eljárás létrehozása [ELAVULT]

Ez a művelet elavult. Ehelyett használja a Tárolt eljárás létrehozása (V2) parancsot.

Tárolt eljárás létrehozása.

Paraméterek

Név Kulcs Kötelező Típus Description
Adatbázis-azonosító
databaseId True string

Az adatbázis neve.

Gyűjtemény azonosítója
collectionId True string

A gyűjtemény neve.

Függvénydefiníció
body string

A tárolt eljárást meghatározó függvény, pl. "function(params){ ... }"

azonosító
id string

A tárolt eljárás új azonosítója.

API-verzió
x-ms-version string

API-verzió.

Válaszok

Tárolt eljárás törlése (V2)

Tárolt eljárás törlése (V2).

Paraméterek

Név Kulcs Kötelező Típus Description
Azure Cosmos DB-fiók neve
cosmosDbAccountName True string

Az Azure Cosmos DB-fiók neve (documents.azure.com nélkül).

Adatbázis-azonosító
databaseId True string

Az adatbázis neve.

Gyűjtemény azonosítója
collectionId True string

A gyűjtemény neve.

Sproc-azonosító
sprocId True string

A tárolt eljárás neve.

API-verzió
x-ms-version string

API-verzió.

Válaszok

response
string

Tárolt eljárás törlése [ELAVULT]

Ez a művelet elavult. Ehelyett használja a Tárolt törlési eljárást (V2).

Tárolt eljárás törlése.

Paraméterek

Név Kulcs Kötelező Típus Description
Adatbázis-azonosító
databaseId True string

Az adatbázis neve.

Gyűjtemény azonosítója
collectionId True string

A gyűjtemény neve.

Sproc-azonosító
sprocId True string

A tárolt eljárás neve.

API-verzió
x-ms-version string

API-verzió.

Válaszok

response
string

Tárolt eljárás végrehajtása (V2)

Tárolt eljárás végrehajtása a megadott gyűjteményben (V2).

Paraméterek

Név Kulcs Kötelező Típus Description
Azure Cosmos DB-fiók neve
cosmosDbAccountName True string

Az Azure Cosmos DB-fiók neve (documents.azure.com nélkül).

Adatbázis-azonosító
databaseId True string

Az adatbázis neve.

Gyűjtemény azonosítója
collectionId True string

A gyűjtemény neve.

Partíciókulcs értéke
x-ms-documentdb-raw-partitionkey string

A kért dokumentum- vagy mellékletművelet partíciókulcs-értéke.

Sproc-azonosító
sprocId True string

A tárolt eljárás neve.

A tárolt eljárás paraméterei
parameters string

Adjon meg érvényes JSON-t a tárolt eljárás paramétereihez, például ["param1", "param2"].

API-verzió
x-ms-version string

API-verzió.

Válaszok

Tárolt eljárás végrehajtása [ELAVULT]

Ez a művelet elavult. Ehelyett használja a Tárolt eljárás végrehajtása (V2) parancsot.

Tárolt eljárás végrehajtása a megadott gyűjteményben.

Paraméterek

Név Kulcs Kötelező Típus Description
Adatbázis-azonosító
databaseId True string

Az adatbázis neve.

Gyűjtemény azonosítója
collectionId True string

A gyűjtemény neve.

Partíciókulcs értéke
x-ms-documentdb-raw-partitionkey string

A kért dokumentum- vagy mellékletművelet partíciókulcs-értéke.

Sproc-azonosító
sprocId True string

A tárolt eljárás neve.

A tárolt eljárás paraméterei
parameters string

Adjon meg érvényes JSON-t a tárolt eljárás paramétereihez, például ["param1", "param2"].

API-verzió
x-ms-version string

API-verzió.

Válaszok

Tárolt eljárások lekérése (V2)

Tárolt eljárások lekérése a megadott gyűjteményben (V2).

Paraméterek

Név Kulcs Kötelező Típus Description
Azure Cosmos DB-fiók neve
cosmosDbAccountName True string

Az Azure Cosmos DB-fiók neve (documents.azure.com nélkül).

Adatbázis-azonosító
databaseId True string

Az adatbázis neve.

Gyűjtemény azonosítója
collectionId True string

A gyűjtemény neve.

API-verzió
x-ms-version string

API-verzió.

Válaszok

Tárolt eljárások lekérése [ELAVULT]

Ez a művelet elavult. Ehelyett használja a Tárolt eljárások lekérése (V2) parancsot .

Tárolt eljárások lekérése a megadott gyűjteményben.

Paraméterek

Név Kulcs Kötelező Típus Description
Adatbázis-azonosító
databaseId True string

Az adatbázis neve.

Gyűjtemény azonosítója
collectionId True string

A gyűjtemény neve.

API-verzió
x-ms-version string

API-verzió.

Válaszok

Definíciók

QueryDocumentsResponse

A kért lekérdezésnek és a kapcsolódó metaadatoknak megfelelő dokumentumok tömbje.

Név Elérési út Típus Description
Documents
Documents array of ObjectWithoutType

A kérésnek megfelelő dokumentumok tömbje.

Dokumentumok száma
_count integer

Dokumentumok száma.

Tevékenységazonosító
ActivityId string

Azure Cosmos DB szolgáltatástevékenység-azonosító.

DataWithSensitivityLabelInfo

Adatnév bizalmassági címkeadatokkal

Név Elérési út Típus Description
name
name string

Név

sensitivityLabelInfo
sensitivityLabelInfo array of SensitivityLabelMetadata

Bizalmassági címke adatainak listája

SensitivityLabelMetadata

A SensitivityLabel metaadatai

Név Elérési út Típus Description
sensitivityLabelId
sensitivityLabelId string

SensitivityLabel Id.

name
name string

SensitivityLabel név.

displayName
displayName string

SensitivityLabel displayName információ

elemleírás
tooltip string

A SensitivityLabel részletei az elemleíráson.

priority
priority integer

SensitivityLabel prioritás.

color
color string

SensitivityLabel szín.

isEncrypted
isEncrypted boolean

A SensitivityLabel Encrypted.

isEnabled
isEnabled boolean

Hogy a SensitivityLabel engedélyezve van-e.

isParent
isParent boolean

Hogy a SensitivityLabel szülő-e.

parentSensitivityLabelId
parentSensitivityLabelId string

Parent SensitivityLabel Id.

DocumentsCollection

A kért lekérdezésnek és a kapcsolódó metaadatoknak megfelelő dokumentumok tömbje.

Név Elérési út Típus Description
Documents
value array of ObjectWithoutType
Folytatási jogkivonat
ContinuationToken string
Dokumentumok száma
Count integer
Díj kérése
RequestCharge double
Munkamenet-jogkivonat
SessionToken string
Tevékenységazonosító
ActivityId string

postDocumentsResponse

Név Elérési út Típus Description
_megszabadít
_rid string
_Ts
_ts integer
_önmaga
_self string
_etag
_etag string
_Mellékletek
_attachments string
azonosító
id string

putDocumentResponse

Név Elérési út Típus Description
_megszabadít
_rid string
azonosító
id string

getDocumentsResponse

Név Elérési út Típus Description
_megszabadít
_rid string
Documents
Documents array of object

queryResponse

Név Elérési út Típus Description
_megszabadít
_rid string
_gróf
_count number
Documents
Documents array of

getStoredProceduresResponse

Név Elérési út Típus Description
_gróf
_count integer

_gróf

_megszabadít
_rid string

_megszabadít

Tárolt eljárások
StoredProcedures array of object

Tárolt eljárások

_etag
StoredProcedures._etag string

_etag

_megszabadít
StoredProcedures._rid string

_megszabadít

_önmaga
StoredProcedures._self string

_önmaga

_Ts
StoredProcedures._ts integer

_Ts

body
StoredProcedures.body string

body

azonosító
StoredProcedures.id string

azonosító

createStoredProcedureResponse

Név Elérési út Típus Description
_etag
_etag string

_etag

_megszabadít
_rid string

_megszabadít

_önmaga
_self string

_önmaga

_Ts
_ts integer

_Ts

body
body string

body

azonosító
id string

azonosító

ObjectWithoutType

karakterlánc

Ez a sztring alapszintű adattípusa.

objektum

Ez az "objektum" típus.