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ó
Logikai alkalmazások	Standard	Minden Logic Apps-régió
Power Alkalmazások	-	Nem elérhető
Power Automate	prémium	Minden Power Automate-régió

Összekötő metaadatai
Kiadó	Microsoft

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

• A DocumentDB (Azure Cosmos DB) összekötő által támogatott dokumentumok maximális mérete 2 MB.

• Az Azure Cosmos DB korlátait itt dokumentáljuk.

• Az összekötő nem támogatja az írási régió és a több írási régió kiválasztását.

• A "Partíciókulcs értékét" a típusának megfelelően kell megadni. A sztringértékeket például idézőjelek közé kell tenni, egy számot pedig a következőképpen kell megadni. Például: "sztringérték", 123, 0,5.

• A particionált gyűjteményeken ORDER BYfutó lekérdezésekhez DISTINCTa "partíciókulcs értéke" szükséges.

• Dokumentumok lekérdezése V2 [ELAVULT], Dokumentumok lekérdezése V3, Összes dokumentum lekérése V2 (előzetes verzió) művelet az Azure Cosmos DB .NET SDK-t használja az SQL API-hoz (2.13.1-es verzió).

• A lekérdezési dokumentumok V4 (előzetes verzió) művelete az SQL API-hoz készült Azure Cosmos DB .NET SDK-t (3.15.0-s verzió) használja.

• A dokumentumok lekérdezése (V5) (előzetes verzió) művelet az SQL API-hoz készült Azure Cosmos DB .NET SDK-t (3.20.0-s verzió) használja.

• A "Maximális tételszám" paraméter értéke 1 és 1000 közötti szám lehet. A tartományon kívüli számok implicit módon "-1" értékre lesznek konvertálva, ami arra utasítja a Cosmos DB szolgáltatást, hogy határozza meg az optimális elemszámot.

• Ha üres marad, a következő műveletek csak olyan dokumentumokkal működnek, amelyek nem rendelkeznek partíciókulcs-értékkel. A partíciókulcs-értékkel rendelkező elemek ki lesznek zárva ebből a műveletből.

  1. Dokumentum lekérése
  2. Dokumentum lekérése (V2)
  3. Dokumentum cseréje
  4. Dokumentum cseréje (V2)
  5. Dokumentum törlése
  6. Dokumentum törlése (V2)
  7. Tárolt eljárás végrehajtása
  8. Tárolt eljárás végrehajtása (v2)

• Mivel az Azure Cosmos DB nem támogatja a Microsoft Entra ID-hitelesítéssel ( itt dokumentált) felügyeleti műveleteket, a Tárolt eljárás végrehajtása művelet (V2) (előzetes verzió) csak a rendelkezésre álló tárolt eljárásokat jeleníti meg (a SprocId paraméterhez) egy alapú kapcsolat használatakor Access Key . Token A alapú hitelesítések (Microsoft Entra ID-hitelesítések) üres listát fognak megjeleníteni, és azokat sprocId manuálisan kell megadni egyéni értékként.

Fontos

A Microsoft Entra ID integrált (Azure Commercial) kapcsolatai alapértelmezés szerint le vannak tiltva az USA kormányzati (GCC) környezeteiben. Az ilyen típusú kapcsolatok engedélyezéséhez a Power Platform Felügyeleti központban egy bérlői rendszergazdának engedélyeznie kell a Csatlakozás az Azure Kereskedelmi szolgáltatáshoz beállítást.

Ha bekapcsolja ezt a beállítást, az Azure Commercial azon erőforrásaihoz való kapcsolódást teszi lehetővé, amelyek adatokat üzemeltetnek és küldenek a Power Platform US Government megfelelőségi határán kívül. Ez kifejezetten a Power Platform-összekötők GCC-felhőverzióiból származó kereskedelmi erőforrásokhoz való hozzáférés engedélyezésére szolgál.

A Microsoft Entra ID Integrated (Azure Commercial) az egyetlen hitelesítési típus, amely az USA kormányzati (GCC) környezeteitől az Azure Commercial-erőforrásokig működik.

Az Azure Kereskedelmi hitelesítés alapértelmezés szerint le van tiltva:

A Csatlakozás az Azure Kereskedelmi szolgáltatáshoz beállítás a Power Platform Felügyeleti központban:

Kapcsolat létrehozása

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

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.	Az Azure Government és a Védelmi Minisztérium (DoD) kivételével minden régió az Azure Government és az US Government (GCC) és az US Government (GCC-High) kivételével	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 and Department of Defense (DoD) in Azure Government and US Government (GCC) and US Government (GCC-High) csak	Megosztható
Felügyelt Logic Apps-identitás	Kapcsolat létrehozása LogicApps Managed Identity használatával	Csak LOGICAPPS	Megosztható
Integrált Microsoft Entra-azonosító	Az Azure Blob Storage eléréséhez használja a Microsoft Entra ID azonosítót.	Az Azure Government és a Védelmi Minisztérium (DoD) kivételével minden régió az Azure Government és az US Government (GCC) és az US Government (GCC-High) kivételével	Nem osztható meg
Integrált Microsoft Entra ID (Azure Commercial)	A Microsoft Entra ID-vel elérheti az Azure Blob Storage-t az Azure Commercialben.	Csak AZ USA kormánya (GCC)	Nem osztható meg
Integrált Microsoft Entra ID (Azure Government)	Az Azure Blob Storage eléréséhez használja a Microsoft Entra ID azonosítót.	Azure Government and Department of Defense (DoD) in Azure Government and US Government (GCC) and US Government (GCC-High) csak	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

Hozzáférési kulcs

Hitelesítési azonosító: keyBasedAuth

Alkalmazható: Az Azure Government és a Department of Defense (DoD) kivételével minden régió az Azure Government és az US Government (GCC) és az US Government (GCC-High) területén

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ó: Az Azure Government és a Department of Defense (DoD) csak az Azure Government és az US Government (GCC) és az US Government (GCC-High) esetében

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 Logic Apps-identitás

Hitelesítési azonosító: managedIdentityAuth

Alkalmazható: csak LOGICAPPS

Kapcsolat létrehozása LogicApps Managed Identity használatával

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ő
LogicApps felügyelt identitás	managedIdentity	Bejelentkezés felügyelt Logic Apps-identitással	True

Microsoft Entra id integrated

Hitelesítési azonosító: tokenBasedAuth

Alkalmazható: Az Azure Government és a Department of Defense (DoD) kivételével minden régió az Azure Government és az US Government (GCC) és az US Government (GCC-High) területén

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ó: Az Azure Government és a Department of Defense (DoD) csak az Azure Government és az US Government (GCC) és az US Government (GCC-High) esetében

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

Name	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)

Műveletazonosító:

GetDocuments_V3

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

Paraméterek

Name	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ó.

Válaszok

Törzs

getDocumentsResponse

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

Műveletazonosító:

GetDocuments

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

Szerezze be az összes dokumentumot.

Paraméterek

Name	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

Törzs

getDocumentsResponse

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

Műveletazonosító:

GetDocumentsV2

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

Name	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.

Törzs

DocumentsCollection

Dokumentum cseréje (V2)

Műveletazonosító:

ReplaceDocument_V2

Dokumentum cseréje (V2).

Paraméterek

Name	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

Törzs

putDocumentResponse

Dokumentum cseréje [ELAVULT]

Műveletazonosító:

ReplaceDocument

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

Dokumentum cseréje.

Paraméterek

Name	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

Törzs

putDocumentResponse

Dokumentum lekérése (V2)

Műveletazonosító:

GetDocument_V2

Dokumentum lekérése (V2).

Paraméterek

Name	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.
Dokumentumazonosító	documentId	True	string	A dokumentum azonosítója.
API-verzió	x-ms-version		string	API-verzió.

Válaszok

response

object

Dokumentum lekérése [ELAVULT]

Műveletazonosító:

GetDocument

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

Dokumentum lekérése.

Paraméterek

Name	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]

Műveletazonosító:

CreateDocumentV2

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

Name	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

Törzs

postDocumentsResponse

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

Műveletazonosító:

CreateDocument_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

Name	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

Törzs

postDocumentsResponse

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

Műveletazonosító:

CreateDocument

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

Name	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

Törzs

postDocumentsResponse

Dokumentum törlése (V2)

Műveletazonosító:

DeleteDocument_V2

Dokumentum törlése (V2).

Paraméterek

Name	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]

Műveletazonosító:

DeleteDocument

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

Dokumentum törlése.

Paraméterek

Name	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]

Műveletazonosító:

QueryDocuments

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

Dokumentumok lekérdezése.

Paraméterek

Name	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]

Műveletazonosító:

QueryDocumentsV2

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

Dokumentumok lekérdezése v2.

Paraméterek

Name	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.

Törzs

QueryDocumentsResponse

Dokumentumok lekérdezése V3 [ELAVULT]

Műveletazonosító:

QueryDocumentsV3

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

Dokumentumok lekérdezése V3.

Paraméterek

Name	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.

Törzs

DocumentsCollection

Dokumentumok lekérdezése V4 [ELAVULT]

Műveletazonosító:

QueryDocumentsV4

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

Dokumentumok lekérdezése v4.

Paraméterek

Name	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.

Törzs

DocumentsCollection

Dokumentumok lekérdezése V5

Műveletazonosító:

QueryDocuments_V5

Dokumentumok lekérdezése (V5).

Paraméterek

Name	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.

Válaszok

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

Törzs

DocumentsCollection

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

Műveletazonosító:

ReplaceStoredProcedure_V2

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

Paraméterek

Name	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örzs

createStoredProcedureResponse

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

Műveletazonosító:

ReplaceStoredProcedure

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

Name	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örzs

createStoredProcedureResponse

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

Műveletazonosító:

CreateStoredProcedure_V2

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

Paraméterek

Name	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örzs

createStoredProcedureResponse

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

Műveletazonosító:

CreateStoredProcedure

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

Name	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örzs

createStoredProcedureResponse

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

Műveletazonosító:

DeleteStoredProcedure_V2

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

Paraméterek

Name	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]

Műveletazonosító:

DeleteStoredProcedure

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

Name	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)

Műveletazonosító:

ExecuteStoredProcedure_V2

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

Paraméterek

Name	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

response

ObjectWithoutType

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

Műveletazonosító:

ExecuteStoredProcedure

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

Name	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

response

ObjectWithoutType

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

Műveletazonosító:

GetStoredProcedures_V2

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

Paraméterek

Name	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örzs

getStoredProceduresResponse

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

Műveletazonosító:

GetStoredProcedures

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

Name	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

Törzs

getStoredProceduresResponse

Definíciók

QueryDocumentsResponse

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

Name	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ó.

DocumentsCollection

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

Name	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

Name	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

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

getDocumentsResponse

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

queryResponse

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

getStoredProceduresResponse

Name	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

Name	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.