Azure Cosmos DB
Azure Cosmos DB je globálně distribuovaná databázová služba s více modely, která umožňuje elasticky a nezávisle škálovat propustnost a úložiště napříč libovolným počtem geografických oblastí s komplexní smlouvou SLA.
Tento konektor je dostupný v následujících produktech a oblastech:
| Service | Class | Regions |
|---|---|---|
| Copilot Studio | Premium | Všechny oblasti Power Automate |
| Logic Apps | Standard | Všechny oblasti Logic Apps |
| Power Apps | - | Není k dispozici |
| Power Automate | Premium | Všechny oblasti Power Automate |
| Metadata konektoru | |
|---|---|
| Vydavatel | Microsoft |
K použití této integrace budete potřebovat účet rozhraní SQL API služby Cosmos DB nakonfigurovaný na webu Azure Portal. Upozorňujeme, že účty rozhraní Mongo DB API se v současné době nepodporují.
Po vytvoření účtu rozhraní SQL API při vytváření připojení ke konektoru Azure Cosmos DB při vytváření připojení Access Key typu zadejte ID účtu (bez documents.azure.com). Toto ID účtu se také vyžaduje pro novější verze operací, které podporují ověřování Microsoft Entra ID.
Ověřování microsoft entra ID a konektor Cosmos DB
Pokud chcete použít ověřování Microsoft Entra ID, musí být použitý účet přiřazen ke konkrétnímu přiřazení role. Další informace najdete v tématu Konfigurace řízení přístupu na základě role pomocí Id Microsoft Entra pro váš účet služby Azure Cosmos DB.
Poznámka:
Přístup k datům umožňují přístup ke službě Cosmos DB pouze role explicitně definované pro přístup k datům zabezpečení. Předdefinované role, jako Ownerje například , nebo Contributorneposkytují přístup k datům Cosmos DB v rámci tohoto účtu prostřednictvím Id Microsoft Entra. Služba Azure Cosmos DB vystavuje 2 předdefinované role:
-
Cosmos DB Built-in Data Reader(ID00000000-0000-0000-0000-000000000001definice role) -
Cosmos DB Built-in Data Contributor(ID00000000-0000-0000-0000-000000000002definice role)
Role je možné přiřadit mnoha způsoby a vlastní role je možné vytvořit pro podrobnější přístup.
Tady je příklad toho, kdo se má přiřadit Cosmos DB Built-in Data Reader přes PowerShell (další informace o tomto příkazu New-AzCosmosDBSqlRoleAssignment):
$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 "/"
Pokud nepřidáte tato přiřazení rolí, skončí se neautorizovanými požadavky, jako je tento: Request is blocked because principal [<<principal-id>>] does not have the required RBAC permissions to perform action <unauthorized actions>.
Poznámka:
Azure Cosmos DB nepodporuje žádný druh operací správy s ověřováním Microsoft Entra ID (zdokumentovaný zde). Následující operace budou fungovat jenom s připojeními Access Key :
- Vytvoření uložené procedury (verze V1 a V2)
- Odstranění uložené procedury (verze V1 a V2)
- Aktualizace uložené procedury (verze V1 a V2)
Operace se nepodporují s ověřováním Microsoft Entra ID
Při použití ověřování Microsoft Entra ID jsou podporovány pouze akce s názvem účtu Cosmos DB jako parametr. Zastaralé akce budou dál fungovat s ověřováním Access Key , ale v případě použití s připojením Microsoft Entra ID selžou.
Známé problémy a omezení
Maximální velikost dokumentu podporovaného konektorem DocumentDB (Azure Cosmos DB) je 2 MB.
Tady jsou zdokumentovaná omezení služby Azure Cosmos DB.
Konektor nepodporuje výběr oblasti zápisu a oblastí s více zápisy.
Hodnota klíče oddílu musí být zadána podle jeho typu. Například řetězcová hodnota by měla být uzavřena v uvozovkách, číslo by mělo být zadané tak, jak je. Příklad: "řetězcová hodnota", 123, 0,5.
Hodnota klíče oddílu je vyžadována pro dotazy s
ORDER BYDISTINCT, atd., které běží v dělených kolekcích.Dotazování dokumentů verze 2 [ZASTARALÉ], dotazování dokumentů V3, získání všech dokumentů verze 2 (Preview) používá sadu .NET SDK služby Azure Cosmos DB pro rozhraní SQL API (verze 2.13.1).
Akce dotazování dokumentů verze 4 (Preview) používá sadu .NET SDK služby Azure Cosmos DB pro rozhraní SQL API (verze 3.15.0).
Akce dotazování dokumentů (V5) (Preview) používá sadu .NET SDK služby Azure Cosmos DB pro rozhraní SQL API (verze 3.20.0).
Hodnota parametru Max Item Count může být libovolné číslo od 1 do 1000. Jakékoli číslo mimo tento rozsah se implicitně převede na -1, což službě Cosmos DB říká, aby určila optimální počet položek.
Pokud necháte prázdné, následující operace budou fungovat jenom s dokumenty, které nemají hodnotu klíče oddílu. Z těchto akcí budou vyloučeny položky s hodnotou klíče oddílu.
Vzhledem k tomu, že Azure Cosmos DB nepodporuje žádné operace správy s ověřováním Microsoft Entra ID (zdokumentované zde), operace Execute stored procedure (V2) (Preview) zobrazí při použití založeného připojení pouze dostupné uložené procedury (pro
SprocIdparametr).Access KeyTokenOvěřování založená na základě (ověřování Microsoft Entra ID) zobrazí prázdný seznam asprocIdmělo by být zadáno ručně jako vlastní hodnota.
Důležité
Integrovaná připojení Microsoft Entra ID (Azure Commercial) jsou ve výchozím nastavení zakázaná v prostředích státní správy USA (GCC ). Pokud chcete povolit tyto typy připojení, musí správce tenanta povolit nastavení Připojení ke komerční službě Azure v Centru pro správu Power Platform.
Zapnutí tohoto nastavení umožňuje připojení k prostředkům ve službě Azure Commercial, které provozují a odesílají data mimo hranice dodržování předpisů power platform US Government. Konkrétně se používá k povolení přístupu ke komerčním prostředkům z cloudových verzí konektorů Power Platform GCC.
Microsoft Entra ID Integrated (Azure Commercial) je jediný typ ověřování, který funguje z prostředí GCC (US Government) do komerčních prostředků Azure.
Komerční ověřování Azure je ve výchozím nastavení zakázané: 
.
Nastavení Připojení ke komerční službě Azure v Centru pro správu Power Platform: 
Vytvoření připojení
Konektor podporuje následující typy ověřování:
| Přístupový klíč | Zadejte název účtu a přístupový klíč pro přístup k účtu Cosmos DB. | Všechny oblasti kromě Azure Government a ministerstva obrany (DoD) ve službách Azure Government a US Government (GCC) a US Government (GCC-High) | Sdíletelný |
| Přístupový klíč (Azure Government) | Zadejte název účtu a přístupový klíč pro přístup k účtu Cosmos DB. | Azure Government a ministerstvo obrany (DoD) pouze ve službách Azure Government a US Government (GCC) a US Government (GCC-High) | Sdíletelný |
| Spravovaná identita Logic Apps | Vytvoření připojení pomocí spravované identity LogicApps | Pouze LOGICAPPS | Sdíletelný |
| Integrované Microsoft Entra ID | Pro přístup ke službě Azure Blob Storage použijte ID Microsoft Entra. | Všechny oblasti kromě Azure Government a ministerstva obrany (DoD) ve službách Azure Government a US Government (GCC) a US Government (GCC-High) | Nesdílitelné |
| Integrované ID Microsoft Entra (komerční prostředí Azure) | Pro přístup ke službě Azure Blob Storage ve službě Azure Commercial použijte ID Microsoft Entra. | Pouze státní správa USA (GCC) | Nesdílitelné |
| Integrované ID Microsoftu (Azure Government) | Pro přístup ke službě Azure Blob Storage použijte ID Microsoft Entra. | Azure Government a ministerstvo obrany (DoD) pouze ve službách Azure Government a US Government (GCC) a US Government (GCC-High) | Nesdílitelné |
| Výchozí [ZASTARALÉ] | Tato možnost je určená pouze pro starší připojení bez explicitního typu ověřování a poskytuje se pouze pro zpětnou kompatibilitu. | Všechny oblasti | Nesdílitelné |
Přístupová klávesa
ID ověřování: keyBasedAuth
Použitelné: Všechny oblasti kromě Azure Government a ministerstva obrany (DoD) ve službách Azure Government a US Government (GCC) a US Government (GCC-High)
Zadejte název účtu a přístupový klíč pro přístup k účtu Cosmos DB.
Toto připojení je možné sdílet. Pokud se power app sdílí s jiným uživatelem, sdílí se i připojení. Další informace najdete v přehledu konektorů pro aplikace plátna – Power Apps | Microsoft Docs
| Název | Typ | Description | Povinné |
|---|---|---|---|
| ID účtu | řetězec | Název účtu bez části documents.azure.com | Pravdivé |
| Přístupový klíč k účtu služby Azure Cosmos DB | securestring | Primární nebo sekundární klíč | Pravdivé |
Přístupový klíč (Azure Government)
ID ověřování: keyBasedAuth
Použitelné: Pouze Azure Government a Ministerstvo obrany (DoD) ve službě Azure Government a US Government (GCC) a US Government (GCC-High)
Zadejte název účtu a přístupový klíč pro přístup k účtu Cosmos DB.
Toto připojení je možné sdílet. Pokud se power app sdílí s jiným uživatelem, sdílí se i připojení. Další informace najdete v přehledu konektorů pro aplikace plátna – Power Apps | Microsoft Docs
| Název | Typ | Description | Povinné |
|---|---|---|---|
| ID účtu | řetězec | Název účtu bez části documents.azure.com | Pravdivé |
| Přístupový klíč k účtu služby Azure Cosmos DB | securestring | Primární nebo sekundární klíč | Pravdivé |
Spravovaná identita Logic Apps
ID ověřování: managedIdentityAuth
Použitelné: Pouze LOGICAPPS
Vytvoření připojení pomocí spravované identity LogicApps
Toto připojení je možné sdílet. Pokud se power app sdílí s jiným uživatelem, sdílí se i připojení. Další informace najdete v přehledu konektorů pro aplikace plátna – Power Apps | Microsoft Docs
| Název | Typ | Description | Povinné |
|---|---|---|---|
| Spravovaná identita LogicApps | managedIdentity | Přihlášení pomocí spravované identity Logic Apps | Pravdivé |
Integrované ID Microsoft Entra
ID ověřování: tokenBasedAuth
Použitelné: Všechny oblasti kromě Azure Government a ministerstva obrany (DoD) ve službách Azure Government a US Government (GCC) a US Government (GCC-High)
Pro přístup ke službě Azure Blob Storage použijte ID Microsoft Entra.
Toto připojení není možné sdílet. Pokud se power app sdílí s jiným uživatelem, zobrazí se výzva k explicitní vytvoření nového připojení.
Integrované ID Microsoft Entra (komerční prostředí Azure)
ID ověřování: oauthCom
Platné: Pouze státní správa USA (GCC)
Pro přístup ke službě Azure Blob Storage ve službě Azure Commercial použijte ID Microsoft Entra.
Toto připojení není možné sdílet. Pokud se power app sdílí s jiným uživatelem, zobrazí se výzva k explicitní vytvoření nového připojení.
Integrované ID Microsoftu (Azure Government)
ID ověřování: tokenBasedAuth
Použitelné: Pouze Azure Government a Ministerstvo obrany (DoD) ve službě Azure Government a US Government (GCC) a US Government (GCC-High)
Pro přístup ke službě Azure Blob Storage použijte ID Microsoft Entra.
Toto připojení není možné sdílet. Pokud se power app sdílí s jiným uživatelem, zobrazí se výzva k explicitní vytvoření nového připojení.
Výchozí [ZASTARALÉ]
Použitelné: Všechny oblasti
Tato možnost je určená pouze pro starší připojení bez explicitního typu ověřování a poskytuje se pouze pro zpětnou kompatibilitu.
Toto připojení není možné sdílet. Pokud se power app sdílí s jiným uživatelem, zobrazí se výzva k explicitní vytvoření nového připojení.
| Název | Typ | Description | Povinné |
|---|---|---|---|
| ID účtu | řetězec | Název účtu bez části documents.azure.com | Pravdivé |
| Přístupový klíč k účtu služby Azure Cosmos DB | securestring | Primární nebo sekundární klíč | Pravdivé |
Limity omezování
| Name | Volání | Období obnovení |
|---|---|---|
| Volání rozhraní API na připojení | 1500 | 60 sekund |
Akce
| Dotazování dokumentů [ZASTARALÉ] |
Tato akce je zastaralá. Místo toho použijte dokumenty dotazu V5 .
|
| Dotazování dokumentů V2 [ZASTARALÉ] |
Tato akce je zastaralá. Místo toho použijte dokumenty dotazu V5 .
|
| Dotazování dokumentů V3 [ZASTARALÉ] |
Tato akce je zastaralá. Místo toho použijte dokumenty dotazu V5 .
|
| Dotazování dokumentů V4 [ZASTARALÉ] |
Tato akce je zastaralá. Místo toho použijte dokumenty dotazu V5 .
|
| Dotazování dokumentů V5 |
Dotazování dokumentů (V5) |
| Nahradit uloženou proceduru [ZASTARALÉ] |
Tato akce je zastaralá. Místo toho použijte uloženou proceduru Nahradit (V2).
|
| Nahrazení dokumentu (V2) |
Nahrazení dokumentu (V2) |
| Nahrazení dokumentu [ZASTARALÉ] |
Tato akce je zastaralá. Místo toho použijte možnost Nahradit dokument (V2 ).
|
| Nahrazení uložené procedury (V2) |
Nahradit uloženou proceduru (V2). |
| Odstranit uloženou proceduru [ZASTARALÉ] |
Tato akce je zastaralá. Místo toho použijte uloženou proceduru Delete (V2).
|
| Odstranění dokumentu (V2) |
Odstranění dokumentu (V2) |
| Odstranění dokumentu [ZASTARALÉ] |
Tato akce je zastaralá. Místo toho použijte odstranit dokument (V2 ).
|
| Odstranění uložené procedury (V2) |
Odstraňte uloženou proceduru (V2). |
| Spustit uloženou proceduru (V2) |
Spusťte uloženou proceduru v zadané kolekci (V2). |
| Spustit uloženou proceduru [ZASTARALÉ] |
Tato akce je zastaralá. Místo toho použijte uloženou proceduru Execute (V2).
|
| Vytvoření nebo aktualizace dokumentu (V2) [ZASTARALÉ] |
Tato akce je zastaralá. Místo toho použijte příkaz Vytvořit nebo aktualizovat dokument (V3 ).
|
| Vytvoření nebo aktualizace dokumentu (V3) |
Vytvořte nebo aktualizujte dokument. Při vytváření dokumentu v DocumentDB musí text obsahovat vlastnost ID. |
| Vytvoření nebo aktualizace dokumentu [ZASTARALÉ] |
Tato akce je zastaralá. Místo toho použijte příkaz Vytvořit nebo aktualizovat dokument (V3 ).
|
| Vytvoření uložené procedury (V2) |
Vytvoření uložené procedury (V2) |
| Vytvoření uložené procedury [ZASTARALÉ] |
Tato akce je zastaralá. Místo toho použijte příkaz Vytvořit uloženou proceduru (V2 ).
|
| Získání dokumentu (V2) |
Získání dokumentu (V2) |
| Získání dokumentu [ZASTARALÉ] |
Tato akce je zastaralá. Místo toho použijte příkaz Získat dokument (V2 ).
|
| Získání uložených procedur (V2) |
Získejte uložené procedury v zadané kolekci (V2). |
| Získání uložených procedur [ZASTARALÉ] |
Tato akce je zastaralá. Místo toho použijte příkaz Získat uložené procedury (V2 ).
|
| Získání všech dokumentů (V3) |
Získání všech dokumentů (V3) |
| Získání všech dokumentů [ZASTARALÉ] |
Tato akce je zastaralá. Místo toho použijte možnost Získat všechny dokumenty (V3 ).
|
| Získání všech dokumentů V2 [ZASTARALÉ] |
Tato akce je zastaralá. Místo toho použijte možnost Získat všechny dokumenty (V3 ).
|
Dotazování dokumentů [ZASTARALÉ]
Tato akce je zastaralá. Místo toho použijte dokumenty dotazu V5 .
Dotazování dokumentů.
Parametry
| Name | Klíč | Vyžadováno | Typ | Description |
|---|---|---|---|---|
|
Hodnota klíče oddílu
|
x-ms-documentdb-raw-partitionkey | string |
Hodnota klíče oddílu pro požadovanou operaci dokumentu nebo přílohy. |
|
|
Maximální počet položek
|
x-ms-max-item-count | number |
Celé číslo označující maximální počet položek, které se mají vrátit na stránku. |
|
|
Token pokračování
|
x-ms-continuation | string |
Řetězcový token vrácený pro dotazy a operace kanálu pro čtení, pokud se mají přečíst další výsledky. |
|
|
Povolení křížového oddílu
|
x-ms-documentdb-query-enablecrosspartition | boolean |
Pokud je kolekce rozdělená na oddíly, musí být nastavena na hodnotu True, aby bylo možné provádět napříč více oddíly. |
|
|
Úroveň konzistence
|
x-ms-consistency-level | string |
Toto je přepsání na úrovni konzistence. Platné hodnoty jsou: Strong, Bounded, Session nebo Eventual (v pořadí od nejsilnějšího po nejslabší). |
|
|
Token relace
|
x-ms-session-token | string |
Řetězcový token používaný s konzistencí na úrovni relace. |
|
|
ID aktivity
|
x-ms-activity-id | string |
Zadaný identifikátor klienta pro operaci, který bude v odpovědi serveru ozvěna. |
|
|
ID databáze
|
databaseId | True | string |
Název databáze. |
|
ID kolekce
|
collectionId | True | string |
Název kolekce. |
|
dotaz
|
query | string |
Návraty
- Body
- queryResponse
Dotazování dokumentů V2 [ZASTARALÉ]
Tato akce je zastaralá. Místo toho použijte dokumenty dotazu V5 .
Dotazování dokumentů verze 2
Parametry
| Name | Klíč | Vyžadováno | Typ | Description |
|---|---|---|---|---|
|
ID databáze
|
databaseId | True | string |
Název databáze. |
|
ID kolekce
|
collectionId | True | string |
Název kolekce. |
|
Text dotazu
|
QueryText | string |
Dotaz syntaxe SQL na dokumenty |
|
|
Hodnota klíče oddílu
|
partitionKey | string |
Hodnota klíče oddílu |
|
|
Token pokračování
|
continuationToken | string |
Token, který načte další výsledky z operace. |
Návraty
Pole dokumentů, které odpovídají požadovanému dotazu a souvisejícím metadatem
Dotazování dokumentů V3 [ZASTARALÉ]
Tato akce je zastaralá. Místo toho použijte dokumenty dotazu V5 .
Dotazování dokumentů v3
Parametry
| Name | Klíč | Vyžadováno | Typ | Description |
|---|---|---|---|---|
|
ID databáze
|
databaseId | True | string |
Název databáze. |
|
ID kolekce
|
collectionId | True | string |
Název kolekce. |
|
Dotaz syntaxe SQL
|
queryText | True | string |
Dotaz SQL. |
|
Hodnota klíče oddílu
|
partitionKey | string |
Pokud jsou prázdné, budou se všechny oddíly používat k hledání dokumentů. |
|
|
Maximální počet položek
|
maxItemCount | integer |
Celé číslo označující maximální počet položek, které se mají vrátit na stránku. |
|
|
Token pokračování
|
continuationToken | string |
Token pro načtení dalších výsledků |
|
|
Povolení křížového oddílu
|
enableCrossPartition | boolean |
Určuje, jestli má uživatel povoleno odesílat více než jeden požadavek na spuštění dotazu. |
|
|
Úroveň konzistence
|
consistencyLevel | string |
Úroveň konzistence vyžadovaná pro operaci informačního kanálu (dotazování nebo čtení) |
|
|
Token relace
|
sessionToken | string |
Token relace pro použití s konzistencí relace. |
Návraty
Pole dokumentů, které odpovídají požadovanému dotazu a souvisejícím metadatem
- Body
- DocumentsCollection
Dotazování dokumentů V4 [ZASTARALÉ]
Tato akce je zastaralá. Místo toho použijte dokumenty dotazu V5 .
Dotazování dokumentů verze 4
Parametry
| Name | Klíč | Vyžadováno | Typ | Description |
|---|---|---|---|---|
|
ID databáze
|
databaseId | True | string |
Název databáze. |
|
ID kontejneru
|
containerId | True | string |
Název kontejneru. |
|
Dotaz syntaxe SQL
|
queryText | string |
Dotaz SQL. Pokud je prázdný, vrátí všechny dokumenty. |
|
|
Hodnota klíče oddílu
|
partitionKey | string |
Pokud jsou prázdné, budou se všechny oddíly používat k hledání dokumentů. |
|
|
Maximální počet položek
|
maxItemCount | integer |
Celé číslo označující maximální počet položek, které se mají vrátit na stránku. |
|
|
Token pokračování
|
continuationToken | string |
Token pro načtení dalších výsledků |
|
|
Úroveň konzistence
|
consistencyLevel | string |
Úroveň konzistence vyžadovaná pro operaci informačního kanálu (dotazování nebo čtení) |
|
|
Token relace
|
sessionToken | string |
Token relace pro použití s konzistencí relace. |
Návraty
Pole dokumentů, které odpovídají požadovanému dotazu a souvisejícím metadatem
- Body
- DocumentsCollection
Dotazování dokumentů V5
Dotazování dokumentů (V5)
Parametry
| Name | Klíč | Vyžadováno | Typ | Description |
|---|---|---|---|---|
|
Název účtu služby Azure Cosmos DB
|
cosmosDbAccountName | True | string |
Název účtu služby Azure Cosmos DB (bez documents.azure.com) |
|
ID databáze
|
databaseId | True | string |
Název databáze. |
|
ID kontejneru
|
containerId | True | string |
Název kontejneru. |
|
Dotaz syntaxe SQL
|
queryText | string |
Dotaz SQL. Pokud je prázdný, vrátí všechny dokumenty. |
|
|
Hodnota klíče oddílu
|
partitionKey | string |
Hodnota musí být zadána podle typu ("řetězec", 42, 0,5). Pokud jsou prázdné, budou se všechny oddíly používat k hledání dokumentů. |
|
|
Maximální počet položek
|
maxItemCount | integer |
Celé číslo označující maximální počet položek, které se mají vrátit na stránku. |
|
|
Token pokračování
|
continuationToken | string |
Token pro načtení dalších výsledků |
|
|
Úroveň konzistence
|
consistencyLevel | string |
Úroveň konzistence vyžadovaná pro operaci informačního kanálu (dotazování nebo čtení) |
|
|
Token relace
|
sessionToken | string |
Token relace pro použití s konzistencí relace. |
Návraty
Pole dokumentů, které odpovídají požadovanému dotazu a souvisejícím metadatem
- Body
- DocumentsCollection
Nahradit uloženou proceduru [ZASTARALÉ]
Tato akce je zastaralá. Místo toho použijte uloženou proceduru Nahradit (V2).
Nahraďte uloženou proceduru.
Parametry
| Name | Klíč | Vyžadováno | Typ | Description |
|---|---|---|---|---|
|
ID databáze
|
databaseId | True | string |
Název databáze. |
|
ID kolekce
|
collectionId | True | string |
Název kolekce. |
|
Sproc ID
|
sprocId | True | string |
Název uložené procedury. |
|
Definice funkce
|
body | string |
Funkce, která definuje uloženou proceduru, například "function(params){ ... }' |
|
|
identifikační číslo
|
id | string |
ID existující uložené procedury. |
|
|
Verze rozhraní API
|
x-ms-version | string |
Verze rozhraní API. |
Návraty
Nahrazení dokumentu (V2)
Nahrazení dokumentu (V2)
Parametry
| Name | Klíč | Vyžadováno | Typ | Description |
|---|---|---|---|---|
|
Hodnota klíče oddílu
|
x-ms-documentdb-raw-partitionkey | string |
Hodnota klíče oddílu pro požadovanou operaci dokumentu nebo přílohy. |
|
|
Maximální počet položek
|
x-ms-max-item-count | number |
Celé číslo označující maximální počet položek, které se mají vrátit na stránku. |
|
|
Token pokračování
|
x-ms-continuation | string |
Řetězcový token vrácený pro dotazy a operace kanálu pro čtení, pokud se mají přečíst další výsledky. |
|
|
Úroveň konzistence
|
x-ms-consistency-level | string |
Toto je přepsání na úrovni konzistence. Platné hodnoty jsou: Strong, Bounded, Session nebo Eventual (v pořadí od nejsilnějšího po nejslabší). |
|
|
Token relace
|
x-ms-session-token | string |
Řetězcový token používaný s konzistencí na úrovni relace. |
|
|
ID aktivity
|
x-ms-activity-id | string |
Zadaný identifikátor klienta pro operaci, který bude v odpovědi serveru ozvěna. |
|
|
Před triggerem
|
x-ms-documentdb-pre-trigger-include | string |
Čárkami oddělený seznam názvů aktivačních událostí, které se mají spustit před spuštěním operace dokumentu. |
|
|
Aktivační událost po spuštění
|
x-ms-documentdb-post-trigger-include | string |
Čárkami oddělený seznam názvů aktivačních událostí, které se mají spustit po spuštění operace dokumentu. |
|
|
Název účtu služby Azure Cosmos DB
|
cosmosDbAccountName | True | string |
Název účtu služby Azure Cosmos DB (bez documents.azure.com) |
|
ID databáze
|
databaseId | True | string |
Název databáze. |
|
ID kolekce
|
collectionId | True | string |
Název kolekce. |
|
ID dokumentu
|
documentId | True | string |
Identifikátor dokumentu. |
|
Verze rozhraní API
|
x-ms-version | string |
Verze rozhraní API. |
Návraty
- Body
- putDocumentResponse
Nahrazení dokumentu [ZASTARALÉ]
Tato akce je zastaralá. Místo toho použijte možnost Nahradit dokument (V2 ).
Nahraďte dokument.
Parametry
| Name | Klíč | Vyžadováno | Typ | Description |
|---|---|---|---|---|
|
Hodnota klíče oddílu
|
x-ms-documentdb-raw-partitionkey | string |
Hodnota klíče oddílu pro požadovanou operaci dokumentu nebo přílohy. |
|
|
Maximální počet položek
|
x-ms-max-item-count | number |
Celé číslo označující maximální počet položek, které se mají vrátit na stránku. |
|
|
Token pokračování
|
x-ms-continuation | string |
Řetězcový token vrácený pro dotazy a operace kanálu pro čtení, pokud se mají přečíst další výsledky. |
|
|
Úroveň konzistence
|
x-ms-consistency-level | string |
Toto je přepsání na úrovni konzistence. Platné hodnoty jsou: Strong, Bounded, Session nebo Eventual (v pořadí od nejsilnějšího po nejslabší). |
|
|
Token relace
|
x-ms-session-token | string |
Řetězcový token používaný s konzistencí na úrovni relace. |
|
|
ID aktivity
|
x-ms-activity-id | string |
Zadaný identifikátor klienta pro operaci, který bude v odpovědi serveru ozvěna. |
|
|
Před triggerem
|
x-ms-documentdb-pre-trigger-include | string |
Čárkami oddělený seznam názvů aktivačních událostí, které se mají spustit před spuštěním operace dokumentu. |
|
|
Aktivační událost po spuštění
|
x-ms-documentdb-post-trigger-include | string |
Čárkami oddělený seznam názvů aktivačních událostí, které se mají spustit po spuštění operace dokumentu. |
|
|
ID databáze
|
databaseId | True | string |
Název databáze. |
|
ID kolekce
|
collectionId | True | string |
Název kolekce. |
|
ID dokumentu
|
documentId | True | string |
Identifikátor dokumentu. |
|
Verze rozhraní API
|
x-ms-version | string |
Verze rozhraní API. |
Návraty
- Body
- putDocumentResponse
Nahrazení uložené procedury (V2)
Nahradit uloženou proceduru (V2).
Parametry
| Name | Klíč | Vyžadováno | Typ | Description |
|---|---|---|---|---|
|
Název účtu služby Azure Cosmos DB
|
cosmosDbAccountName | True | string |
Název účtu služby Azure Cosmos DB (bez documents.azure.com) |
|
ID databáze
|
databaseId | True | string |
Název databáze. |
|
ID kolekce
|
collectionId | True | string |
Název kolekce. |
|
Sproc ID
|
sprocId | True | string |
Název uložené procedury. |
|
Definice funkce
|
body | string |
Funkce, která definuje uloženou proceduru, například "function(params){ ... }' |
|
|
identifikační číslo
|
id | string |
ID existující uložené procedury. |
|
|
Verze rozhraní API
|
x-ms-version | string |
Verze rozhraní API. |
Návraty
Odstranit uloženou proceduru [ZASTARALÉ]
Tato akce je zastaralá. Místo toho použijte uloženou proceduru Delete (V2).
Odstraňte uloženou proceduru.
Parametry
| Name | Klíč | Vyžadováno | Typ | Description |
|---|---|---|---|---|
|
ID databáze
|
databaseId | True | string |
Název databáze. |
|
ID kolekce
|
collectionId | True | string |
Název kolekce. |
|
Sproc ID
|
sprocId | True | string |
Název uložené procedury. |
|
Verze rozhraní API
|
x-ms-version | string |
Verze rozhraní API. |
Návraty
- response
- string
Odstranění dokumentu (V2)
Odstranění dokumentu (V2)
Parametry
| Name | Klíč | Vyžadováno | Typ | Description |
|---|---|---|---|---|
|
Hodnota klíče oddílu
|
x-ms-documentdb-raw-partitionkey | string |
Hodnota klíče oddílu pro požadovanou operaci dokumentu nebo přílohy. |
|
|
Maximální počet položek
|
x-ms-max-item-count | number |
Celé číslo označující maximální počet položek, které se mají vrátit na stránku. |
|
|
Token pokračování
|
x-ms-continuation | string |
Řetězcový token vrácený pro dotazy a operace kanálu pro čtení, pokud se mají přečíst další výsledky. |
|
|
Úroveň konzistence
|
x-ms-consistency-level | string |
Toto je přepsání na úrovni konzistence. Platné hodnoty jsou: Strong, Bounded, Session nebo Eventual (v pořadí od nejsilnějšího po nejslabší). |
|
|
Token relace
|
x-ms-session-token | string |
Řetězcový token používaný s konzistencí na úrovni relace. |
|
|
ID aktivity
|
x-ms-activity-id | string |
Zadaný identifikátor klienta pro operaci, který bude v odpovědi serveru ozvěna. |
|
|
Před triggerem
|
x-ms-documentdb-pre-trigger-include | string |
Čárkami oddělený seznam názvů aktivačních událostí, které se mají spustit před spuštěním operace dokumentu. |
|
|
Aktivační událost po spuštění
|
x-ms-documentdb-post-trigger-include | string |
Čárkami oddělený seznam názvů aktivačních událostí, které se mají spustit po spuštění operace dokumentu. |
|
|
Název účtu služby Azure Cosmos DB
|
cosmosDbAccountName | True | string |
Název účtu služby Azure Cosmos DB (bez documents.azure.com) |
|
ID databáze
|
databaseId | True | string |
Název databáze. |
|
ID kolekce
|
collectionId | True | string |
Název kolekce. |
|
ID dokumentu
|
documentId | True | string |
Identifikátor dokumentu. |
|
Verze rozhraní API
|
x-ms-version | string |
Verze rozhraní API. |
Odstranění dokumentu [ZASTARALÉ]
Tato akce je zastaralá. Místo toho použijte odstranit dokument (V2 ).
Odstranění dokumentu
Parametry
| Name | Klíč | Vyžadováno | Typ | Description |
|---|---|---|---|---|
|
Hodnota klíče oddílu
|
x-ms-documentdb-raw-partitionkey | string |
Hodnota klíče oddílu pro požadovanou operaci dokumentu nebo přílohy. |
|
|
Maximální počet položek
|
x-ms-max-item-count | number |
Celé číslo označující maximální počet položek, které se mají vrátit na stránku. |
|
|
Token pokračování
|
x-ms-continuation | string |
Řetězcový token vrácený pro dotazy a operace kanálu pro čtení, pokud se mají přečíst další výsledky. |
|
|
Úroveň konzistence
|
x-ms-consistency-level | string |
Toto je přepsání na úrovni konzistence. Platné hodnoty jsou: Strong, Bounded, Session nebo Eventual (v pořadí od nejsilnějšího po nejslabší). |
|
|
Token relace
|
x-ms-session-token | string |
Řetězcový token používaný s konzistencí na úrovni relace. |
|
|
ID aktivity
|
x-ms-activity-id | string |
Zadaný identifikátor klienta pro operaci, který bude v odpovědi serveru ozvěna. |
|
|
Před triggerem
|
x-ms-documentdb-pre-trigger-include | string |
Čárkami oddělený seznam názvů aktivačních událostí, které se mají spustit před spuštěním operace dokumentu. |
|
|
Aktivační událost po spuštění
|
x-ms-documentdb-post-trigger-include | string |
Čárkami oddělený seznam názvů aktivačních událostí, které se mají spustit po spuštění operace dokumentu. |
|
|
ID databáze
|
databaseId | True | string |
Název databáze. |
|
ID kolekce
|
collectionId | True | string |
Název kolekce. |
|
ID dokumentu
|
documentId | True | string |
Identifikátor dokumentu. |
|
Verze rozhraní API
|
x-ms-version | string |
Verze rozhraní API. |
Odstranění uložené procedury (V2)
Odstraňte uloženou proceduru (V2).
Parametry
| Name | Klíč | Vyžadováno | Typ | Description |
|---|---|---|---|---|
|
Název účtu služby Azure Cosmos DB
|
cosmosDbAccountName | True | string |
Název účtu služby Azure Cosmos DB (bez documents.azure.com) |
|
ID databáze
|
databaseId | True | string |
Název databáze. |
|
ID kolekce
|
collectionId | True | string |
Název kolekce. |
|
Sproc ID
|
sprocId | True | string |
Název uložené procedury. |
|
Verze rozhraní API
|
x-ms-version | string |
Verze rozhraní API. |
Návraty
- response
- string
Spustit uloženou proceduru (V2)
Spusťte uloženou proceduru v zadané kolekci (V2).
Parametry
| Name | Klíč | Vyžadováno | Typ | Description |
|---|---|---|---|---|
|
Název účtu služby Azure Cosmos DB
|
cosmosDbAccountName | True | string |
Název účtu služby Azure Cosmos DB (bez documents.azure.com) |
|
ID databáze
|
databaseId | True | string |
Název databáze. |
|
ID kolekce
|
collectionId | True | string |
Název kolekce. |
|
Hodnota klíče oddílu
|
x-ms-documentdb-raw-partitionkey | string |
Hodnota klíče oddílu pro požadovanou operaci dokumentu nebo přílohy. |
|
|
Sproc ID
|
sprocId | True | string |
Název uložené procedury. |
|
Parametry uložené procedury
|
parameters | string |
Zadejte platný kód JSON pro parametry uložené procedury, například ["param1", "param2"]. |
|
|
Verze rozhraní API
|
x-ms-version | string |
Verze rozhraní API. |
Návraty
- response
- ObjectWithoutType
Spustit uloženou proceduru [ZASTARALÉ]
Tato akce je zastaralá. Místo toho použijte uloženou proceduru Execute (V2).
Spusťte uloženou proceduru v zadané kolekci.
Parametry
| Name | Klíč | Vyžadováno | Typ | Description |
|---|---|---|---|---|
|
ID databáze
|
databaseId | True | string |
Název databáze. |
|
ID kolekce
|
collectionId | True | string |
Název kolekce. |
|
Hodnota klíče oddílu
|
x-ms-documentdb-raw-partitionkey | string |
Hodnota klíče oddílu pro požadovanou operaci dokumentu nebo přílohy. |
|
|
Sproc ID
|
sprocId | True | string |
Název uložené procedury. |
|
Parametry uložené procedury
|
parameters | string |
Zadejte platný kód JSON pro parametry uložené procedury, například ["param1", "param2"]. |
|
|
Verze rozhraní API
|
x-ms-version | string |
Verze rozhraní API. |
Návraty
- response
- ObjectWithoutType
Vytvoření nebo aktualizace dokumentu (V2) [ZASTARALÉ]
Tato akce je zastaralá. Místo toho použijte příkaz Vytvořit nebo aktualizovat dokument (V3 ).
Vytvořte nebo aktualizujte dokument. Při vytváření dokumentu v DocumentDB musí text obsahovat vlastnost ID.
Parametry
| Name | Klíč | Vyžadováno | Typ | Description |
|---|---|---|---|---|
|
Maximální počet položek
|
x-ms-max-item-count | number |
Celé číslo označující maximální počet položek, které se mají vrátit na stránku. |
|
|
Token pokračování
|
x-ms-continuation | string |
Řetězcový token vrácený pro dotazy a operace kanálu pro čtení, pokud se mají přečíst další výsledky. |
|
|
Úroveň konzistence
|
x-ms-consistency-level | string |
Toto je přepsání na úrovni konzistence. Platné hodnoty jsou: Strong, Bounded, Session nebo Eventual (v pořadí od nejsilnějšího po nejslabší). |
|
|
Token relace
|
x-ms-session-token | string |
Řetězcový token používaný s konzistencí na úrovni relace. |
|
|
ID aktivity
|
x-ms-activity-id | string |
Zadaný identifikátor klienta pro operaci, který bude v odpovědi serveru ozvěna. |
|
|
IsUpsert
|
x-ms-documentdb-is-upsert | boolean |
Pokud je nastavená hodnota true, dokument se nahradí, pokud existuje jinak. |
|
|
Před triggerem
|
x-ms-documentdb-pre-trigger-include | string |
Čárkami oddělený seznam názvů aktivačních událostí, které se mají spustit před spuštěním operace dokumentu. |
|
|
Aktivační událost po spuštění
|
x-ms-documentdb-post-trigger-include | string |
Čárkami oddělený seznam názvů aktivačních událostí, které se mají spustit po spuštění operace dokumentu. |
|
|
ID databáze
|
databaseId | True | string |
Název databáze. |
|
ID kolekce
|
collectionId | True | string |
Název kolekce. |
|
Verze rozhraní API
|
x-ms-version | string |
Verze rozhraní API. |
Návraty
Vytvoření nebo aktualizace dokumentu (V3)
Vytvořte nebo aktualizujte dokument. Při vytváření dokumentu v DocumentDB musí text obsahovat vlastnost ID.
Parametry
| Name | Klíč | Vyžadováno | Typ | Description |
|---|---|---|---|---|
|
Maximální počet položek
|
x-ms-max-item-count | number |
Celé číslo označující maximální počet položek, které se mají vrátit na stránku. |
|
|
Token pokračování
|
x-ms-continuation | string |
Řetězcový token vrácený pro dotazy a operace kanálu pro čtení, pokud se mají přečíst další výsledky. |
|
|
Úroveň konzistence
|
x-ms-consistency-level | string |
Toto je přepsání na úrovni konzistence. Platné hodnoty jsou: Strong, Bounded, Session nebo Eventual (v pořadí od nejsilnějšího po nejslabší). |
|
|
Token relace
|
x-ms-session-token | string |
Řetězcový token používaný s konzistencí na úrovni relace. |
|
|
ID aktivity
|
x-ms-activity-id | string |
Zadaný identifikátor klienta pro operaci, který bude v odpovědi serveru ozvěna. |
|
|
IsUpsert
|
x-ms-documentdb-is-upsert | boolean |
Pokud je nastavená hodnota true, dokument se nahradí, pokud existuje jinak. |
|
|
Před triggerem
|
x-ms-documentdb-pre-trigger-include | string |
Čárkami oddělený seznam názvů aktivačních událostí, které se mají spustit před spuštěním operace dokumentu. |
|
|
Aktivační událost po spuštění
|
x-ms-documentdb-post-trigger-include | string |
Čárkami oddělený seznam názvů aktivačních událostí, které se mají spustit po spuštění operace dokumentu. |
|
|
Název účtu služby Azure Cosmos DB
|
cosmosDbAccountName | True | string |
Název účtu služby Azure Cosmos DB (bez documents.azure.com) |
|
ID databáze
|
databaseId | True | string |
Název databáze. |
|
ID kolekce
|
collectionId | True | string |
Název kolekce. |
|
Verze rozhraní API
|
x-ms-version | string |
Verze rozhraní API. |
Návraty
Vytvoření nebo aktualizace dokumentu [ZASTARALÉ]
Tato akce je zastaralá. Místo toho použijte příkaz Vytvořit nebo aktualizovat dokument (V3 ).
Vytvořte nebo aktualizujte dokument. Při vytváření dokumentu v DocumentDB musí text obsahovat vlastnost ID.
Parametry
| Name | Klíč | Vyžadováno | Typ | Description |
|---|---|---|---|---|
|
Hodnota klíče oddílu
|
x-ms-documentdb-raw-partitionkey | string |
Hodnota klíče oddílu pro požadovanou operaci dokumentu nebo přílohy. |
|
|
Maximální počet položek
|
x-ms-max-item-count | number |
Celé číslo označující maximální počet položek, které se mají vrátit na stránku. |
|
|
Token pokračování
|
x-ms-continuation | string |
Řetězcový token vrácený pro dotazy a operace kanálu pro čtení, pokud se mají přečíst další výsledky. |
|
|
Úroveň konzistence
|
x-ms-consistency-level | string |
Toto je přepsání na úrovni konzistence. Platné hodnoty jsou: Strong, Bounded, Session nebo Eventual (v pořadí od nejsilnějšího po nejslabší). |
|
|
Token relace
|
x-ms-session-token | string |
Řetězcový token používaný s konzistencí na úrovni relace. |
|
|
ID aktivity
|
x-ms-activity-id | string |
Zadaný identifikátor klienta pro operaci, který bude v odpovědi serveru ozvěna. |
|
|
IsUpsert
|
x-ms-documentdb-is-upsert | boolean |
Pokud je nastavená hodnota true, dokument se nahradí, pokud existuje jinak. |
|
|
Před triggerem
|
x-ms-documentdb-pre-trigger-include | string |
Čárkami oddělený seznam názvů aktivačních událostí, které se mají spustit před spuštěním operace dokumentu. |
|
|
Aktivační událost po spuštění
|
x-ms-documentdb-post-trigger-include | string |
Čárkami oddělený seznam názvů aktivačních událostí, které se mají spustit po spuštění operace dokumentu. |
|
|
ID databáze
|
databaseId | True | string |
Název databáze. |
|
ID kolekce
|
collectionId | True | string |
Název kolekce. |
|
Verze rozhraní API
|
x-ms-version | string |
Verze rozhraní API. |
Návraty
Vytvoření uložené procedury (V2)
Vytvoření uložené procedury (V2)
Parametry
| Name | Klíč | Vyžadováno | Typ | Description |
|---|---|---|---|---|
|
Název účtu služby Azure Cosmos DB
|
cosmosDbAccountName | True | string |
Název účtu služby Azure Cosmos DB (bez documents.azure.com) |
|
ID databáze
|
databaseId | True | string |
Název databáze. |
|
ID kolekce
|
collectionId | True | string |
Název kolekce. |
|
Definice funkce
|
body | string |
Funkce, která definuje uloženou proceduru, například "function(params){ ... }' |
|
|
identifikační číslo
|
id | string |
Nové ID uložené procedury |
|
|
Verze rozhraní API
|
x-ms-version | string |
Verze rozhraní API. |
Návraty
Vytvoření uložené procedury [ZASTARALÉ]
Tato akce je zastaralá. Místo toho použijte příkaz Vytvořit uloženou proceduru (V2 ).
Vytvořte uloženou proceduru.
Parametry
| Name | Klíč | Vyžadováno | Typ | Description |
|---|---|---|---|---|
|
ID databáze
|
databaseId | True | string |
Název databáze. |
|
ID kolekce
|
collectionId | True | string |
Název kolekce. |
|
Definice funkce
|
body | string |
Funkce, která definuje uloženou proceduru, například "function(params){ ... }' |
|
|
identifikační číslo
|
id | string |
Nové ID uložené procedury |
|
|
Verze rozhraní API
|
x-ms-version | string |
Verze rozhraní API. |
Návraty
Získání dokumentu (V2)
Získání dokumentu (V2)
Parametry
| Name | Klíč | Vyžadováno | Typ | Description |
|---|---|---|---|---|
|
Hodnota klíče oddílu
|
x-ms-documentdb-raw-partitionkey | string |
Hodnota klíče oddílu pro požadovanou operaci dokumentu nebo přílohy. |
|
|
Maximální počet položek
|
x-ms-max-item-count | number |
Celé číslo označující maximální počet položek, které se mají vrátit na stránku. |
|
|
Token pokračování
|
x-ms-continuation | string |
Řetězcový token vrácený pro dotazy a operace kanálu pro čtení, pokud se mají přečíst další výsledky. |
|
|
Úroveň konzistence
|
x-ms-consistency-level | string |
Toto je přepsání na úrovni konzistence. Platné hodnoty jsou: Strong, Bounded, Session nebo Eventual (v pořadí od nejsilnějšího po nejslabší). |
|
|
Token relace
|
x-ms-session-token | string |
Řetězcový token používaný s konzistencí na úrovni relace. |
|
|
ID aktivity
|
x-ms-activity-id | string |
Zadaný identifikátor klienta pro operaci, který bude v odpovědi serveru ozvěna. |
|
|
Název účtu služby Azure Cosmos DB
|
cosmosDbAccountName | True | string |
Název účtu služby Azure Cosmos DB (bez documents.azure.com) |
|
ID databáze
|
databaseId | True | string |
Název databáze. |
|
ID kolekce
|
collectionId | True | string |
Název kolekce. |
|
ID dokumentu
|
documentId | True | string |
Identifikátor dokumentu. |
|
Verze rozhraní API
|
x-ms-version | string |
Verze rozhraní API. |
Návraty
- response
- object
Získání dokumentu [ZASTARALÉ]
Tato akce je zastaralá. Místo toho použijte příkaz Získat dokument (V2 ).
Získejte dokument.
Parametry
| Name | Klíč | Vyžadováno | Typ | Description |
|---|---|---|---|---|
|
Hodnota klíče oddílu
|
x-ms-documentdb-raw-partitionkey | string |
Hodnota klíče oddílu pro požadovanou operaci dokumentu nebo přílohy. |
|
|
Maximální počet položek
|
x-ms-max-item-count | number |
Celé číslo označující maximální počet položek, které se mají vrátit na stránku. |
|
|
Token pokračování
|
x-ms-continuation | string |
Řetězcový token vrácený pro dotazy a operace kanálu pro čtení, pokud se mají přečíst další výsledky. |
|
|
Úroveň konzistence
|
x-ms-consistency-level | string |
Toto je přepsání na úrovni konzistence. Platné hodnoty jsou: Strong, Bounded, Session nebo Eventual (v pořadí od nejsilnějšího po nejslabší). |
|
|
Token relace
|
x-ms-session-token | string |
Řetězcový token používaný s konzistencí na úrovni relace. |
|
|
ID aktivity
|
x-ms-activity-id | string |
Zadaný identifikátor klienta pro operaci, který bude v odpovědi serveru ozvěna. |
|
|
ID databáze
|
databaseId | True | string |
Název databáze. |
|
ID kolekce
|
collectionId | True | string |
Název kolekce. |
|
ID dokumentu
|
documentId | True | string |
Identifikátor dokumentu. |
|
Verze rozhraní API
|
x-ms-version | string |
Verze rozhraní API. |
Návraty
- response
- object
Získání uložených procedur (V2)
Získejte uložené procedury v zadané kolekci (V2).
Parametry
| Name | Klíč | Vyžadováno | Typ | Description |
|---|---|---|---|---|
|
Název účtu služby Azure Cosmos DB
|
cosmosDbAccountName | True | string |
Název účtu služby Azure Cosmos DB (bez documents.azure.com) |
|
ID databáze
|
databaseId | True | string |
Název databáze. |
|
ID kolekce
|
collectionId | True | string |
Název kolekce. |
|
Verze rozhraní API
|
x-ms-version | string |
Verze rozhraní API. |
Návraty
Získání uložených procedur [ZASTARALÉ]
Tato akce je zastaralá. Místo toho použijte příkaz Získat uložené procedury (V2 ).
Získejte uložené procedury v zadané kolekci.
Parametry
| Name | Klíč | Vyžadováno | Typ | Description |
|---|---|---|---|---|
|
ID databáze
|
databaseId | True | string |
Název databáze. |
|
ID kolekce
|
collectionId | True | string |
Název kolekce. |
|
Verze rozhraní API
|
x-ms-version | string |
Verze rozhraní API. |
Návraty
Získání všech dokumentů (V3)
Získání všech dokumentů (V3)
Parametry
| Name | Klíč | Vyžadováno | Typ | Description |
|---|---|---|---|---|
|
Hodnota klíče oddílu
|
x-ms-documentdb-raw-partitionkey | string |
Hodnota klíče oddílu pro požadovanou operaci dokumentu nebo přílohy. |
|
|
Maximální počet položek
|
x-ms-max-item-count | number |
Celé číslo označující maximální počet položek, které se mají vrátit na stránku. |
|
|
Token pokračování
|
x-ms-continuation | string |
Řetězcový token vrácený pro dotazy a operace kanálu pro čtení, pokud se mají přečíst další výsledky. |
|
|
Úroveň konzistence
|
x-ms-consistency-level | string |
Toto je přepsání na úrovni konzistence. Platné hodnoty jsou: Strong, Bounded, Session nebo Eventual (v pořadí od nejsilnějšího po nejslabší). |
|
|
Token relace
|
x-ms-session-token | string |
Řetězcový token používaný s konzistencí na úrovni relace. |
|
|
ID aktivity
|
x-ms-activity-id | string |
Zadaný identifikátor klienta pro operaci, který bude v odpovědi serveru ozvěna. |
|
|
Název účtu služby Azure Cosmos DB
|
cosmosDbAccountName | True | string |
Název účtu služby Azure Cosmos DB (bez documents.azure.com) |
|
ID databáze
|
databaseId | True | string |
Název databáze. |
|
ID kolekce
|
collectionId | True | string |
Název kolekce. |
|
Verze rozhraní API
|
x-ms-version | string |
Verze rozhraní API. |
Návraty
- Body
- getDocumentsResponse
Získání všech dokumentů [ZASTARALÉ]
Tato akce je zastaralá. Místo toho použijte možnost Získat všechny dokumenty (V3 ).
Získejte všechny dokumenty.
Parametry
| Name | Klíč | Vyžadováno | Typ | Description |
|---|---|---|---|---|
|
Hodnota klíče oddílu
|
x-ms-documentdb-raw-partitionkey | string |
Hodnota klíče oddílu pro požadovanou operaci dokumentu nebo přílohy. |
|
|
Maximální počet položek
|
x-ms-max-item-count | number |
Celé číslo označující maximální počet položek, které se mají vrátit na stránku. |
|
|
Token pokračování
|
x-ms-continuation | string |
Řetězcový token vrácený pro dotazy a operace kanálu pro čtení, pokud se mají přečíst další výsledky. |
|
|
Úroveň konzistence
|
x-ms-consistency-level | string |
Toto je přepsání na úrovni konzistence. Platné hodnoty jsou: Strong, Bounded, Session nebo Eventual (v pořadí od nejsilnějšího po nejslabší). |
|
|
Token relace
|
x-ms-session-token | string |
Řetězcový token používaný s konzistencí na úrovni relace. |
|
|
ID aktivity
|
x-ms-activity-id | string |
Zadaný identifikátor klienta pro operaci, který bude v odpovědi serveru ozvěna. |
|
|
ID databáze
|
databaseId | True | string |
Název databáze. |
|
ID kolekce
|
collectionId | True | string |
Název kolekce. |
|
Verze rozhraní API
|
x-ms-version | string |
Verze rozhraní API. |
Návraty
- Body
- getDocumentsResponse
Získání všech dokumentů V2 [ZASTARALÉ]
Tato akce je zastaralá. Místo toho použijte možnost Získat všechny dokumenty (V3 ).
Získejte všechny dokumenty V2.
Parametry
| Name | Klíč | Vyžadováno | Typ | Description |
|---|---|---|---|---|
|
ID databáze
|
databaseId | True | string |
Název databáze. |
|
ID kolekce
|
collectionId | True | string |
Název kolekce. |
|
Hodnota klíče oddílu
|
partitionKey | string |
Pokud jsou prázdné, budou se všechny oddíly používat k hledání dokumentů. |
|
|
Maximální počet položek
|
maxItemCount | integer |
Celé číslo označující maximální počet položek, které se mají vrátit na stránku. |
|
|
Token pokračování
|
continuationToken | string |
Token pro načtení dalších výsledků |
|
|
Úroveň konzistence
|
consistencyLevel | string |
Úroveň konzistence vyžadovaná pro operaci informačního kanálu (dotazování nebo čtení) |
|
|
Token relace
|
sessionToken | string |
Token relace pro použití s konzistencí relace. |
Návraty
Pole dokumentů, které odpovídají požadovanému dotazu a souvisejícím metadatem
- Body
- DocumentsCollection
Definice
QueryDocumentsResponse
Pole dokumentů, které odpovídají požadovanému dotazu a souvisejícím metadatem
| Name | Cesta | Typ | Description |
|---|---|---|---|
|
Documents
|
Documents | array of ObjectWithoutType |
Pole dokumentů, které odpovídají požadavku |
|
Počet dokumentů
|
_count | integer |
Počet dokumentů |
|
ID aktivity
|
ActivityId | string |
ID aktivity služby Azure Cosmos DB |
DocumentsCollection
Pole dokumentů, které odpovídají požadovanému dotazu a souvisejícím metadatem
| Name | Cesta | Typ | Description |
|---|---|---|---|
|
Documents
|
value | array of ObjectWithoutType | |
|
Token pokračování
|
ContinuationToken | string | |
|
Počet dokumentů
|
Count | integer | |
|
Žádost o poplatek
|
RequestCharge | double | |
|
Token relace
|
SessionToken | string | |
|
ID aktivity
|
ActivityId | string |
postDocumentsResponse
| Name | Cesta | Typ | Description |
|---|---|---|---|
|
_zbavit
|
_rid | string | |
|
_Ts
|
_ts | integer | |
|
_já
|
_self | string | |
|
_etag
|
_etag | string | |
|
_přílohy
|
_attachments | string | |
|
identifikační číslo
|
id | string |
putDocumentResponse
| Name | Cesta | Typ | Description |
|---|---|---|---|
|
_zbavit
|
_rid | string | |
|
identifikační číslo
|
id | string |
getDocumentsResponse
| Name | Cesta | Typ | Description |
|---|---|---|---|
|
_zbavit
|
_rid | string | |
|
Documents
|
Documents | array of object |
queryResponse
| Name | Cesta | Typ | Description |
|---|---|---|---|
|
_zbavit
|
_rid | string | |
|
_počítat
|
_count | number | |
|
Documents
|
Documents | array of |
getStoredProceduresResponse
| Name | Cesta | Typ | Description |
|---|---|---|---|
|
_počítat
|
_count | integer |
_počítat |
|
_zbavit
|
_rid | string |
_zbavit |
|
Uložené procedury
|
StoredProcedures | array of object |
Uložené procedury |
|
_etag
|
StoredProcedures._etag | string |
_etag |
|
_zbavit
|
StoredProcedures._rid | string |
_zbavit |
|
_já
|
StoredProcedures._self | string |
_já |
|
_Ts
|
StoredProcedures._ts | integer |
_Ts |
|
body
|
StoredProcedures.body | string |
body |
|
identifikační číslo
|
StoredProcedures.id | string |
identifikační číslo |
createStoredProcedureResponse
| Name | Cesta | Typ | Description |
|---|---|---|---|
|
_etag
|
_etag | string |
_etag |
|
_zbavit
|
_rid | string |
_zbavit |
|
_já
|
_self | string |
_já |
|
_Ts
|
_ts | integer |
_Ts |
|
body
|
body | string |
body |
|
identifikační číslo
|
id | string |
identifikační číslo |
ObjectWithoutType
řetězec
Toto je základní datový typ String.
objekt
Toto je typ "object".