Azure Cosmos DB (ein Microsoft-Datenbankdienst)
Azure Cosmos DB ist ein global verteilter Multimodelldatenbankdienst, der Es Ihnen ermöglicht, den Durchsatz und die Speicherung in einer beliebigen Anzahl geografischer Regionen mit einem umfassenden SLA elastisch und unabhängig zu skalieren.
Dieser Connector ist in den folgenden Produkten und Regionen verfügbar:
| Dienstleistung | Class | Regions |
|---|---|---|
| Copilot Studio | Premium | Alle Power Automate-Regionen |
| Logik-Apps | Norm | Alle Logik-Apps-Regionen |
| Power Apps | - | Nicht verfügbar |
| Power Automate | Premium | Alle Power Automate-Regionen |
| Connectormetadaten | |
|---|---|
| Herausgeber | Microsoft |
Um diese Integration zu verwenden, benötigen Sie ein Im Azure-Portal konfiguriertes Cosmos DB SQL-API-Konto. Beachten Sie, dass Mongo DB-API-Konten derzeit nicht unterstützt werden.
Nachdem das SQL-API-Konto erstellt wurde, stellen Sie die Konto-ID (ohne "documents.azure.com") beim Erstellen einer Verbindung mit dem Azure Cosmos DB-Connector bereit, wenn eine Verbindung vom Access Key Typ erstellt wird. Diese Konto-ID ist auch für neuere Betriebsversionen erforderlich, die die Microsoft Entra ID-Authentifizierung unterstützen.
Microsoft Entra ID-Authentifizierung und Cosmos DB-Connector
Um die Microsoft Entra ID-Authentifizierung zu verwenden, muss dem verwendeten Konto eine bestimmte Rollenzuweisung zugewiesen werden, um weitere Informationen zu erhalten, besuchen Sie " Konfigurieren der rollenbasierten Zugriffssteuerung mit Microsoft Entra-ID für Ihr Azure Cosmos DB-Konto".
Hinweis
Nur für den Datenzugriff definierte Rollen ermöglichen einen Sicherheitsprinzipal für den Zugriff auf Cosmos DB-Daten. Integrierte Rollen wie Owner, oder Contributor bieten keinen Zugriff auf die Cosmos DB-Daten innerhalb dieses Kontos über Microsoft Entra ID. Es gibt zwei integrierte Rollen, die von Azure Cosmos DB verfügbar gemacht werden:
-
Cosmos DB Built-in Data Reader(Rollendefinitions-ID00000000-0000-0000-0000-000000000001) -
Cosmos DB Built-in Data Contributor(Rollendefinitions-ID00000000-0000-0000-0000-000000000002)
Rollen können zahlreiche Möglichkeiten zugewiesen werden, und benutzerdefinierte Rollen können für differenzierteren Zugriff erstellt werden.
Hier ist ein Beispiel für die Person, die über PowerShell zugewiesen Cosmos DB Built-in Data Reader werden soll (weitere Informationen zu diesem Befehl 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 "/"
Wenn Diese Rollenzuweisungen nicht hinzugefügt werden, werden nicht autorisierte Anforderungen wie diese angezeigt: Request is blocked because principal [<<principal-id>>] does not have the required RBAC permissions to perform action <unauthorized actions>.
Hinweis
Azure Cosmos DB unterstützt keine Art von Verwaltungsvorgängen mit der Microsoft Entra ID-Authentifizierung ( hier dokumentiert). Die folgenden Vorgänge funktionieren nur mit Access Key Verbindungen:
- Erstellen einer gespeicherten Prozedur (V1- und V2-Versionen)
- Gespeicherte Prozedur löschen (V1- und V2-Versionen)
- Gespeicherte Prozedur aktualisieren (V1- und V2-Versionen)
Vorgänge, die bei der Microsoft Entra ID-Authentifizierung nicht unterstützt werden
Bei verwendung der Microsoft Entra ID-Authentifizierung werden nur Aktionen mit dem Cosmos DB-Kontonamen als Parameter unterstützt. Veraltete Aktionen funktionieren weiterhin mit Access Key der Authentifizierung, schlagen jedoch fehl, wenn sie mit einer Microsoft Entra-ID-Verbindung verwendet werden.
Bekannte Probleme und Einschränkungen
Die maximale Größe eines Dokuments, das vom DocumentDB-Connector (Azure Cosmos DB) unterstützt wird, beträgt 2 MB.
Die Azure Cosmos DB-Einschränkungen sind hier dokumentiert.
Das Auswählen eines Schreibbereichs und mehrere Schreibbereiche wird vom Connector nicht unterstützt.
Der "Partitionsschlüsselwert" muss gemäß seinem Typ bereitgestellt werden. Beispielsweise sollte ein Zeichenfolgenwert in Anführungszeichen eingeschlossen werden, eine Zahl sollte wie folgt angegeben werden. Beispiel: "string value", 123, 0,5.
Der Wert "Partitionsschlüssel" ist für Abfragen mit
ORDER BY,DISTINCTusw. erforderlich, die auf partitionierten Auflistungen ausgeführt werden.Abfragedokumente V2 [VERALTET], Abfragedokumente V3, Aktionen zum Abrufen aller Dokumente V2 (Vorschau) verwenden Azure Cosmos DB .NET SDK für SQL-API (Version 2.13.1).
Abfragedokumente V4 (Vorschau) -Aktion verwendet Azure Cosmos DB .NET SDK für SQL-API (Version 3.15.0).
Abfragedokumente (V5) (Vorschau) -Aktion verwendet Azure Cosmos DB .NET SDK für SQL-API (Version 3.20.0).
Der Parameterwert "Max Item Count" kann eine beliebige Zahl zwischen 1 und 1000 sein. Eine beliebige Zahl außerhalb dieses Bereichs wird implizit in "-1" konvertiert, die Cosmos DB-Dienst angibt, die optimale Elementanzahl zu bestimmen.
Wenn sie leer gelassen werden, funktionieren die folgenden Vorgänge nur mit Dokumenten, die keinen Partitionsschlüsselwert aufweisen. Elemente mit einem Partitionsschlüsselwert werden von diesen Aktionen ausgeschlossen.
Da Azure Cosmos DB keine Arten von Verwaltungsvorgängen mit der Microsoft Entra ID-Authentifizierung unterstützt ( hier dokumentiert), zeigt operation Execute stored procedure (V2) (Preview) nur die verfügbaren gespeicherten Prozeduren (für den
SprocIdParameter) bei Verwendung einerAccess Keybasierten Verbindung an.TokenBasierende Authentifizierungen (Microsoft Entra ID-Authentifizierungen) zeigen eine leere Liste an, und diesprocIdsollte manuell als benutzerdefinierter Wert eingegeben werden.
Von Bedeutung
Microsoft Entra ID Integrated (Azure Commercial) -Verbindungen sind standardmäßig in US Government(GCC) -Umgebungen deaktiviert. Um diese Arten von Verbindungen zu aktivieren, muss die Einstellung "Mit Azure Commercial verbinden " im Power Platform Admin Center von einem Mandantenadministrator aktiviert werden.
Wenn Sie diese Einstellung aktivieren, können Verbindungen zu Ressourcen in Azure Commercial verwendet werden, die Daten außerhalb der Compliancegrenze von Power Platform US Government betreiben und senden. Dies wird speziell verwendet, um den Zugriff auf kommerzielle Ressourcen aus GCC-Cloudversionen von Power Platform Connectors zu ermöglichen.
Microsoft Entra ID Integrated (Azure Commercial) ist der einzige Authentifizierungstyp, der von US Government (GCC)- Umgebungen zu Azure Commercial-Ressourcen funktioniert.
Standardmäßig deaktivierte kommerzielle Azure-Authentifizierung: 
Die Einstellung "Mit Azure Commercial verbinden " im Power Platform Admin Center: 
Erstellen einer Verbindung
Der Connector unterstützt die folgenden Authentifizierungstypen:
| Zugriffsschlüssel | Geben Sie Kontoname und Zugriffsschlüssel an, um auf Ihr Cosmos DB-Konto zuzugreifen. | Alle Regionen außer Azure Government and Department of Defense (DoD) in Azure Government and US Government (GCC) und US Government (GCC-High) | Freigabefähig |
| Zugriffstaste (Azure Government) | Geben Sie Kontoname und Zugriffsschlüssel an, um auf Ihr Cosmos DB-Konto zuzugreifen. | Nur Azure Government und Department of Defense (DoD) in Azure Government and US Government (GCC) und US Government (GCC-High) | Freigabefähig |
| Verwaltete Logic Apps-Identität | Erstellen einer Verbindung mit einer verwalteten LogicApps-Identität | NUR LOGICAPPS | Freigabefähig |
| Microsoft Entra ID-integriert | Verwenden Sie Microsoft Entra-ID, um auf Ihren Azure Blob Storage zuzugreifen. | Alle Regionen außer Azure Government and Department of Defense (DoD) in Azure Government and US Government (GCC) und US Government (GCC-High) | Nicht teilbar |
| Microsoft Entra ID Integrated (Azure Commercial) | Verwenden Sie die Microsoft Entra-ID, um auf Ihren Azure Blob Storage in Azure Commercial zuzugreifen. | Nur US-Regierung (GCC) | Nicht teilbar |
| Microsoft Entra ID Integrated (Azure Government) | Verwenden Sie Microsoft Entra-ID, um auf Ihren Azure Blob Storage zuzugreifen. | Nur Azure Government und Department of Defense (DoD) in Azure Government and US Government (GCC) und US Government (GCC-High) | Nicht teilbar |
| Standard [VERALTET] | Diese Option ist nur für ältere Verbindungen ohne expliziten Authentifizierungstyp vorgesehen und wird nur aus Gründen der Abwärtskompatibilität bereitgestellt. | Alle Regionen | Nicht teilbar |
Zugriffsschlüssel
Auth-ID: keyBasedAuth
Anwendbar: Alle Regionen außer Azure Government and Department of Defense (DoD) in Azure Government and US Government (GCC) und US Government (GCC-High)
Geben Sie Kontoname und Zugriffsschlüssel an, um auf Ihr Cosmos DB-Konto zuzugreifen.
Dies ist eine freigabefähige Verbindung. Wenn die Power-App für einen anderen Benutzer freigegeben wird, wird auch die Verbindung freigegeben. Weitere Informationen finden Sie in der Übersicht über Connectors für Canvas-Apps – Power Apps | Microsoft-Dokumente
| Name | Typ | Description | Erforderlich |
|---|---|---|---|
| Konto-ID | Schnur | Name des Kontos ohne "documents.azure.com"-Teil | Richtig |
| Zugriffsschlüssel für Ihr Azure Cosmos DB-Konto | securestring | Primär- oder Sekundärschlüssel | Richtig |
Zugriffstaste (Azure Government)
Auth-ID: keyBasedAuth
Anwendbar: Nur Azure Government und Department of Defense (DoD) in Azure Government and US Government (GCC) und US Government (GCC-High)
Geben Sie Kontoname und Zugriffsschlüssel an, um auf Ihr Cosmos DB-Konto zuzugreifen.
Dies ist eine freigabefähige Verbindung. Wenn die Power-App für einen anderen Benutzer freigegeben wird, wird auch die Verbindung freigegeben. Weitere Informationen finden Sie in der Übersicht über Connectors für Canvas-Apps – Power Apps | Microsoft-Dokumente
| Name | Typ | Description | Erforderlich |
|---|---|---|---|
| Konto-ID | Schnur | Name des Kontos ohne "documents.azure.com"-Teil | Richtig |
| Zugriffsschlüssel für Ihr Azure Cosmos DB-Konto | securestring | Primär- oder Sekundärschlüssel | Richtig |
Verwaltete Identität von Logik-Apps
Auth-ID: managedIdentityAuth
Anwendbar: NUR LOGICAPPS
Erstellen einer Verbindung mit einer verwalteten LogicApps-Identität
Dies ist eine freigabefähige Verbindung. Wenn die Power-App für einen anderen Benutzer freigegeben wird, wird auch die Verbindung freigegeben. Weitere Informationen finden Sie in der Übersicht über Connectors für Canvas-Apps – Power Apps | Microsoft-Dokumente
| Name | Typ | Description | Erforderlich |
|---|---|---|---|
| LogicApps Managed Identity | managedIdentity | Anmelden mit einer verwalteten Logik-App-Identität | Richtig |
Microsoft Entra ID integriert
Auth-ID: tokenBasedAuth
Anwendbar: Alle Regionen außer Azure Government and Department of Defense (DoD) in Azure Government and US Government (GCC) und US Government (GCC-High)
Verwenden Sie Microsoft Entra-ID, um auf Ihren Azure Blob Storage zuzugreifen.
Dies ist keine freigabefähige Verbindung. Wenn die Power-App für einen anderen Benutzer freigegeben wird, wird ein anderer Benutzer aufgefordert, eine neue Verbindung explizit zu erstellen.
Microsoft Entra ID Integrated (Azure Commercial)
Auth-ID: oauthCom
Anwendbar: Nur US Government (GCC)
Verwenden Sie die Microsoft Entra-ID, um auf Ihren Azure Blob Storage in Azure Commercial zuzugreifen.
Dies ist keine freigabefähige Verbindung. Wenn die Power-App für einen anderen Benutzer freigegeben wird, wird ein anderer Benutzer aufgefordert, eine neue Verbindung explizit zu erstellen.
Microsoft Entra ID Integrated (Azure Government)
Auth-ID: tokenBasedAuth
Anwendbar: Nur Azure Government und Department of Defense (DoD) in Azure Government and US Government (GCC) und US Government (GCC-High)
Verwenden Sie Microsoft Entra-ID, um auf Ihren Azure Blob Storage zuzugreifen.
Dies ist keine freigabefähige Verbindung. Wenn die Power-App für einen anderen Benutzer freigegeben wird, wird ein anderer Benutzer aufgefordert, eine neue Verbindung explizit zu erstellen.
Standard [VERALTET]
Anwendbar: Alle Regionen
Diese Option ist nur für ältere Verbindungen ohne expliziten Authentifizierungstyp vorgesehen und wird nur aus Gründen der Abwärtskompatibilität bereitgestellt.
Dies ist keine freigabefähige Verbindung. Wenn die Power-App für einen anderen Benutzer freigegeben wird, wird ein anderer Benutzer aufgefordert, eine neue Verbindung explizit zu erstellen.
| Name | Typ | Description | Erforderlich |
|---|---|---|---|
| Konto-ID | Schnur | Name des Kontos ohne "documents.azure.com"-Teil | Richtig |
| Zugriffsschlüssel für Ihr Azure Cosmos DB-Konto | securestring | Primär- oder Sekundärschlüssel | Richtig |
Drosselungsgrenzwerte
| Name | Aufrufe | Verlängerungszeitraum |
|---|---|---|
| API-Aufrufe pro Verbindung | 1500 | 60 Sekunden |
Aktionen
| Abfragen von Dokumenten [VERALTET] |
Diese Aktion ist veraltet. Verwenden Sie stattdessen Abfragedokumente V5 .
|
| Abfragen von Dokumenten V2 [VERALTET] |
Diese Aktion ist veraltet. Verwenden Sie stattdessen Abfragedokumente V5 .
|
| Abfragen von Dokumenten V3 [VERALTET] |
Diese Aktion ist veraltet. Verwenden Sie stattdessen Abfragedokumente V5 .
|
| Abfragen von Dokumenten V4 [VERALTET] |
Diese Aktion ist veraltet. Verwenden Sie stattdessen Abfragedokumente V5 .
|
| Abfragen von Dokumenten V5 |
Abfragen von Dokumenten (V5). |
| Abrufen aller Dokumente (V3) |
Abrufen aller Dokumente (V3). |
| Abrufen aller Dokumente [VERALTET] |
Diese Aktion ist veraltet. Verwenden Sie stattdessen "Alle Dokumente abrufen" (V3 ).
|
| Abrufen aller Dokumente V2 [VERALTET] |
Diese Aktion ist veraltet. Verwenden Sie stattdessen "Alle Dokumente abrufen" (V3 ).
|
| Abrufen eines Dokuments (V2) |
Abrufen eines Dokuments (V2). |
| Abrufen eines Dokuments [VERALTET] |
Diese Aktion ist veraltet. Verwenden Sie stattdessen get a document (V2 ).
|
| Abrufen gespeicherter Prozeduren (V2) |
Abrufen gespeicherter Prozeduren in der angegebenen Auflistung (V2). |
| Abrufen gespeicherter Prozeduren [VERALTET] |
Diese Aktion ist veraltet. Verwenden Sie stattdessen "Gespeicherte Prozeduren abrufen" (V2 ).
|
| Ausgeführte gespeicherte Prozedur (V2) |
Ausführen der gespeicherten Prozedur in der angegebenen Auflistung (V2). |
| Ausgeführte gespeicherte Prozedur [VERALTET] |
Diese Aktion ist veraltet. Verwenden Sie stattdessen die gespeicherte Execute-Prozedur (V2 ).
|
| Dokument erstellen oder aktualisieren (V2) [VERALTET] |
Diese Aktion ist veraltet. Verwenden Sie stattdessen "Dokument erstellen oder aktualisieren" (V3 ).
|
| Dokument erstellen oder aktualisieren [VERALTET] |
Diese Aktion ist veraltet. Verwenden Sie stattdessen "Dokument erstellen oder aktualisieren" (V3 ).
|
| Ersetzen eines Dokuments (V2) |
Ersetzen eines Dokuments (V2). |
| Ersetzen eines Dokuments [VERALTET] |
Diese Aktion ist veraltet. Verwenden Sie stattdessen "Ersetzen" (V2).
|
| Erstellen einer gespeicherten Prozedur (V2) |
Erstellen einer gespeicherten Prozedur (V2). |
| Erstellen oder Aktualisieren eines Dokuments (V3) |
Erstellen oder Aktualisieren des Dokuments. Beim Erstellen eines Dokuments in DocumentDB muss der Textkörper eine ID-Eigenschaft enthalten. |
| Gespeicherte Prozedur ersetzen (V2) |
Gespeicherte Prozedur ersetzen (V2). |
| Gespeicherte Prozedur ersetzen [VERALTET] |
Diese Aktion ist veraltet. Verwenden Sie stattdessen "Gespeicherte Prozedur ersetzen" (V2 ).
|
| Gespeicherte Prozedur erstellen [VERALTET] |
Diese Aktion ist veraltet. Verwenden Sie stattdessen "Gespeicherte Prozedur erstellen" (V2 ).
|
| Gespeicherte Prozedur löschen (V2) |
Gespeicherte Prozedur löschen (V2). |
| Gespeicherte Prozedur löschen [VERALTET] |
Diese Aktion ist veraltet. Verwenden Sie stattdessen delete stored procedure (V2 ).
|
| Löschen eines Dokuments (V2) |
Löschen eines Dokuments (V2). |
| Löschen eines Dokuments [VERALTET] |
Diese Aktion ist veraltet. Verwenden Sie stattdessen das Löschen eines Dokuments (V2 ).
|
Abfragen von Dokumenten [VERALTET]
Diese Aktion ist veraltet. Verwenden Sie stattdessen Abfragedokumente V5 .
Abfragen von Dokumenten.
Parameter
| Name | Schlüssel | Erforderlich | Typ | Beschreibung |
|---|---|---|---|---|
|
Partitionsschlüsselwert
|
x-ms-documentdb-raw-partitionkey | string |
Der Partitionsschlüsselwert für den angeforderten Dokument- oder Anlagenvorgang. |
|
|
Max. Elementanzahl
|
x-ms-max-item-count | number |
Eine ganze Zahl, die die maximale Anzahl von Elementen angibt, die pro Seite zurückgegeben werden sollen. |
|
|
Fortsetzungstoken
|
x-ms-continuation | string |
Ein Zeichenfolgentoken, das für Abfragen und Lesefeedvorgänge zurückgegeben wird, wenn weitere Ergebnisse gelesen werden müssen. |
|
|
Aktivieren der partitionsübergreifenden Partition
|
x-ms-documentdb-query-enablecrosspartition | boolean |
Wenn die Auflistung partitioniert ist, muss dies auf "True" festgelegt werden, um die Ausführung über mehrere Partitionen hinweg zuzulassen. |
|
|
Konsistenzstufe
|
x-ms-consistency-level | string |
Dies ist die Außerkraftsetzung der Konsistenzstufe. Die gültigen Werte sind: "Strong", "Bounded", "Session" oder "Eventual" (in Der Reihenfolge der stärksten bis schwächsten). |
|
|
Sitzungstoken
|
x-ms-session-token | string |
Ein Zeichenfolgentoken, das mit Konsistenz auf Sitzungsebene verwendet wird. |
|
|
Aktivitäts-ID
|
x-ms-activity-id | string |
Ein Client hat einen Bezeichner für den Vorgang angegeben, der in der Serverantwort wiedergegeben wird. |
|
|
Datenbank-ID
|
databaseId | True | string |
Der Name der Datenbank. |
|
Sammlungs-ID
|
collectionId | True | string |
Der Name der Sammlung. |
|
Anfrage
|
query | string |
Gibt zurück
- Body
- queryResponse
Abfragen von Dokumenten V2 [VERALTET]
Diese Aktion ist veraltet. Verwenden Sie stattdessen Abfragedokumente V5 .
Abfragen von Dokumenten V2.
Parameter
| Name | Schlüssel | Erforderlich | Typ | Beschreibung |
|---|---|---|---|---|
|
Datenbank-ID
|
databaseId | True | string |
Der Name der Datenbank. |
|
Sammlungs-ID
|
collectionId | True | string |
Der Name der Sammlung. |
|
Abfragetext
|
QueryText | string |
SQL-Syntaxabfrage über Dokumente |
|
|
Partitionsschlüsselwert
|
partitionKey | string |
Partitionsschlüsselwert. |
|
|
Fortsetzungstoken
|
continuationToken | string |
Ein Token zum Abrufen zusätzlicher Ergebnisse aus dem Vorgang. |
Gibt zurück
Array von Dokumenten, die der angeforderten Abfrage und den zugehörigen Metadaten entsprechen.
Abfragen von Dokumenten V3 [VERALTET]
Diese Aktion ist veraltet. Verwenden Sie stattdessen Abfragedokumente V5 .
Abfragen von Dokumenten V3.
Parameter
| Name | Schlüssel | Erforderlich | Typ | Beschreibung |
|---|---|---|---|---|
|
Datenbank-ID
|
databaseId | True | string |
Der Name der Datenbank. |
|
Sammlungs-ID
|
collectionId | True | string |
Der Name der Sammlung. |
|
SQL-Syntaxabfrage
|
queryText | True | string |
SQL-Abfrage. |
|
Partitionsschlüsselwert
|
partitionKey | string |
Wenn leer, werden alle Partitionen verwendet, um nach Dokumenten zu suchen. |
|
|
Max. Elementanzahl
|
maxItemCount | integer |
Eine ganze Zahl, die die maximale Anzahl von Elementen angibt, die pro Seite zurückgegeben werden sollen. |
|
|
Fortsetzungstoken
|
continuationToken | string |
Ein Token zum Abrufen zusätzlicher Ergebnisse. |
|
|
Aktivieren der partitionsübergreifenden Partition
|
enableCrossPartition | boolean |
Gibt an, ob der Benutzer aktiviert ist, mehr als eine Anforderung zum Ausführen der Abfrage zu senden. |
|
|
Konsistenzstufe
|
consistencyLevel | string |
Konsistenzstufe, die für den Feedvorgang (Abfrage-/Lesefeed) erforderlich ist. |
|
|
Sitzungstoken
|
sessionToken | string |
Das Sitzungstoken für die Verwendung mit Sitzungskonsistenz. |
Gibt zurück
Array von Dokumenten, die der angeforderten Abfrage und den zugehörigen Metadaten entsprechen.
- Body
- DocumentsCollection
Abfragen von Dokumenten V4 [VERALTET]
Diese Aktion ist veraltet. Verwenden Sie stattdessen Abfragedokumente V5 .
Abfragen von Dokumenten V4.
Parameter
| Name | Schlüssel | Erforderlich | Typ | Beschreibung |
|---|---|---|---|---|
|
Datenbank-ID
|
databaseId | True | string |
Der Name der Datenbank. |
|
Container-ID
|
containerId | True | string |
Der Name des Containers, |
|
SQL-Syntaxabfrage
|
queryText | string |
SQL-Abfrage. Wenn leer, werden alle Dokumente zurückgegeben. |
|
|
Partitionsschlüsselwert
|
partitionKey | string |
Wenn leer, werden alle Partitionen verwendet, um nach Dokumenten zu suchen. |
|
|
Max. Elementanzahl
|
maxItemCount | integer |
Eine ganze Zahl, die die maximale Anzahl von Elementen angibt, die pro Seite zurückgegeben werden sollen. |
|
|
Fortsetzungstoken
|
continuationToken | string |
Ein Token zum Abrufen zusätzlicher Ergebnisse. |
|
|
Konsistenzstufe
|
consistencyLevel | string |
Konsistenzstufe, die für den Feedvorgang (Abfrage-/Lesefeed) erforderlich ist. |
|
|
Sitzungstoken
|
sessionToken | string |
Das Sitzungstoken für die Verwendung mit Sitzungskonsistenz. |
Gibt zurück
Array von Dokumenten, die der angeforderten Abfrage und den zugehörigen Metadaten entsprechen.
- Body
- DocumentsCollection
Abfragen von Dokumenten V5
Abfragen von Dokumenten (V5).
Parameter
| Name | Schlüssel | Erforderlich | Typ | Beschreibung |
|---|---|---|---|---|
|
Azure Cosmos DB-Kontoname
|
cosmosDbAccountName | True | string |
Der Name des Azure Cosmos DB-Kontos (ohne documents.azure.com). |
|
Datenbank-ID
|
databaseId | True | string |
Der Name der Datenbank. |
|
Container-ID
|
containerId | True | string |
Der Name des Containers, |
|
SQL-Syntaxabfrage
|
queryText | string |
SQL-Abfrage. Wenn leer, werden alle Dokumente zurückgegeben. |
|
|
Partitionsschlüsselwert
|
partitionKey | string |
Der Wert muss gemäß seinem Typ ("Zeichenfolge", 42, 0,5) angegeben werden. Wenn leer, werden alle Partitionen verwendet, um nach Dokumenten zu suchen. |
|
|
Max. Elementanzahl
|
maxItemCount | integer |
Eine ganze Zahl, die die maximale Anzahl von Elementen angibt, die pro Seite zurückgegeben werden sollen. |
|
|
Fortsetzungstoken
|
continuationToken | string |
Ein Token zum Abrufen zusätzlicher Ergebnisse. |
|
|
Konsistenzstufe
|
consistencyLevel | string |
Konsistenzstufe, die für den Feedvorgang (Abfrage-/Lesefeed) erforderlich ist. |
|
|
Sitzungstoken
|
sessionToken | string |
Das Sitzungstoken für die Verwendung mit Sitzungskonsistenz. |
Gibt zurück
Array von Dokumenten, die der angeforderten Abfrage und den zugehörigen Metadaten entsprechen.
- Body
- DocumentsCollection
Abrufen aller Dokumente (V3)
Abrufen aller Dokumente (V3).
Parameter
| Name | Schlüssel | Erforderlich | Typ | Beschreibung |
|---|---|---|---|---|
|
Partitionsschlüsselwert
|
x-ms-documentdb-raw-partitionkey | string |
Der Partitionsschlüsselwert für den angeforderten Dokument- oder Anlagenvorgang. |
|
|
Max. Elementanzahl
|
x-ms-max-item-count | number |
Eine ganze Zahl, die die maximale Anzahl von Elementen angibt, die pro Seite zurückgegeben werden sollen. |
|
|
Fortsetzungstoken
|
x-ms-continuation | string |
Ein Zeichenfolgentoken, das für Abfragen und Lesefeedvorgänge zurückgegeben wird, wenn weitere Ergebnisse gelesen werden müssen. |
|
|
Konsistenzstufe
|
x-ms-consistency-level | string |
Dies ist die Außerkraftsetzung der Konsistenzstufe. Die gültigen Werte sind: "Strong", "Bounded", "Session" oder "Eventual" (in Der Reihenfolge der stärksten bis schwächsten). |
|
|
Sitzungstoken
|
x-ms-session-token | string |
Ein Zeichenfolgentoken, das mit Konsistenz auf Sitzungsebene verwendet wird. |
|
|
Aktivitäts-ID
|
x-ms-activity-id | string |
Ein Client hat einen Bezeichner für den Vorgang angegeben, der in der Serverantwort wiedergegeben wird. |
|
|
Azure Cosmos DB-Kontoname
|
cosmosDbAccountName | True | string |
Der Name des Azure Cosmos DB-Kontos (ohne documents.azure.com). |
|
Datenbank-ID
|
databaseId | True | string |
Der Name der Datenbank. |
|
Sammlungs-ID
|
collectionId | True | string |
Der Name der Sammlung. |
|
API-Version
|
x-ms-version | string |
API-Version. |
Gibt zurück
- Body
- getDocumentsResponse
Abrufen aller Dokumente [VERALTET]
Diese Aktion ist veraltet. Verwenden Sie stattdessen "Alle Dokumente abrufen" (V3 ).
Ruft alle Dokumente ab.
Parameter
| Name | Schlüssel | Erforderlich | Typ | Beschreibung |
|---|---|---|---|---|
|
Partitionsschlüsselwert
|
x-ms-documentdb-raw-partitionkey | string |
Der Partitionsschlüsselwert für den angeforderten Dokument- oder Anlagenvorgang. |
|
|
Max. Elementanzahl
|
x-ms-max-item-count | number |
Eine ganze Zahl, die die maximale Anzahl von Elementen angibt, die pro Seite zurückgegeben werden sollen. |
|
|
Fortsetzungstoken
|
x-ms-continuation | string |
Ein Zeichenfolgentoken, das für Abfragen und Lesefeedvorgänge zurückgegeben wird, wenn weitere Ergebnisse gelesen werden müssen. |
|
|
Konsistenzstufe
|
x-ms-consistency-level | string |
Dies ist die Außerkraftsetzung der Konsistenzstufe. Die gültigen Werte sind: "Strong", "Bounded", "Session" oder "Eventual" (in Der Reihenfolge der stärksten bis schwächsten). |
|
|
Sitzungstoken
|
x-ms-session-token | string |
Ein Zeichenfolgentoken, das mit Konsistenz auf Sitzungsebene verwendet wird. |
|
|
Aktivitäts-ID
|
x-ms-activity-id | string |
Ein Client hat einen Bezeichner für den Vorgang angegeben, der in der Serverantwort wiedergegeben wird. |
|
|
Datenbank-ID
|
databaseId | True | string |
Der Name der Datenbank. |
|
Sammlungs-ID
|
collectionId | True | string |
Der Name der Sammlung. |
|
API-Version
|
x-ms-version | string |
API-Version. |
Gibt zurück
- Body
- getDocumentsResponse
Abrufen aller Dokumente V2 [VERALTET]
Diese Aktion ist veraltet. Verwenden Sie stattdessen "Alle Dokumente abrufen" (V3 ).
Ruft alle Dokumente V2 ab.
Parameter
| Name | Schlüssel | Erforderlich | Typ | Beschreibung |
|---|---|---|---|---|
|
Datenbank-ID
|
databaseId | True | string |
Der Name der Datenbank. |
|
Sammlungs-ID
|
collectionId | True | string |
Der Name der Sammlung. |
|
Partitionsschlüsselwert
|
partitionKey | string |
Wenn leer, werden alle Partitionen verwendet, um nach Dokumenten zu suchen. |
|
|
Max. Elementanzahl
|
maxItemCount | integer |
Eine ganze Zahl, die die maximale Anzahl von Elementen angibt, die pro Seite zurückgegeben werden sollen. |
|
|
Fortsetzungstoken
|
continuationToken | string |
Ein Token zum Abrufen zusätzlicher Ergebnisse. |
|
|
Konsistenzstufe
|
consistencyLevel | string |
Konsistenzstufe, die für den Feedvorgang (Abfrage-/Lesefeed) erforderlich ist. |
|
|
Sitzungstoken
|
sessionToken | string |
Das Sitzungstoken für die Verwendung mit Sitzungskonsistenz. |
Gibt zurück
Array von Dokumenten, die der angeforderten Abfrage und den zugehörigen Metadaten entsprechen.
- Body
- DocumentsCollection
Abrufen eines Dokuments (V2)
Abrufen eines Dokuments (V2).
Parameter
| Name | Schlüssel | Erforderlich | Typ | Beschreibung |
|---|---|---|---|---|
|
Partitionsschlüsselwert
|
x-ms-documentdb-raw-partitionkey | string |
Der Partitionsschlüsselwert für den angeforderten Dokument- oder Anlagenvorgang. |
|
|
Max. Elementanzahl
|
x-ms-max-item-count | number |
Eine ganze Zahl, die die maximale Anzahl von Elementen angibt, die pro Seite zurückgegeben werden sollen. |
|
|
Fortsetzungstoken
|
x-ms-continuation | string |
Ein Zeichenfolgentoken, das für Abfragen und Lesefeedvorgänge zurückgegeben wird, wenn weitere Ergebnisse gelesen werden müssen. |
|
|
Konsistenzstufe
|
x-ms-consistency-level | string |
Dies ist die Außerkraftsetzung der Konsistenzstufe. Die gültigen Werte sind: "Strong", "Bounded", "Session" oder "Eventual" (in Der Reihenfolge der stärksten bis schwächsten). |
|
|
Sitzungstoken
|
x-ms-session-token | string |
Ein Zeichenfolgentoken, das mit Konsistenz auf Sitzungsebene verwendet wird. |
|
|
Aktivitäts-ID
|
x-ms-activity-id | string |
Ein Client hat einen Bezeichner für den Vorgang angegeben, der in der Serverantwort wiedergegeben wird. |
|
|
Azure Cosmos DB-Kontoname
|
cosmosDbAccountName | True | string |
Der Name des Azure Cosmos DB-Kontos (ohne documents.azure.com). |
|
Datenbank-ID
|
databaseId | True | string |
Der Name der Datenbank. |
|
Sammlungs-ID
|
collectionId | True | string |
Der Name der Sammlung. |
|
Dokument-ID
|
documentId | True | string |
Der Bezeichner für das Dokument. |
|
API-Version
|
x-ms-version | string |
API-Version. |
Gibt zurück
- response
- object
Abrufen eines Dokuments [VERALTET]
Diese Aktion ist veraltet. Verwenden Sie stattdessen get a document (V2 ).
Abrufen eines Dokuments.
Parameter
| Name | Schlüssel | Erforderlich | Typ | Beschreibung |
|---|---|---|---|---|
|
Partitionsschlüsselwert
|
x-ms-documentdb-raw-partitionkey | string |
Der Partitionsschlüsselwert für den angeforderten Dokument- oder Anlagenvorgang. |
|
|
Max. Elementanzahl
|
x-ms-max-item-count | number |
Eine ganze Zahl, die die maximale Anzahl von Elementen angibt, die pro Seite zurückgegeben werden sollen. |
|
|
Fortsetzungstoken
|
x-ms-continuation | string |
Ein Zeichenfolgentoken, das für Abfragen und Lesefeedvorgänge zurückgegeben wird, wenn weitere Ergebnisse gelesen werden müssen. |
|
|
Konsistenzstufe
|
x-ms-consistency-level | string |
Dies ist die Außerkraftsetzung der Konsistenzstufe. Die gültigen Werte sind: "Strong", "Bounded", "Session" oder "Eventual" (in Der Reihenfolge der stärksten bis schwächsten). |
|
|
Sitzungstoken
|
x-ms-session-token | string |
Ein Zeichenfolgentoken, das mit Konsistenz auf Sitzungsebene verwendet wird. |
|
|
Aktivitäts-ID
|
x-ms-activity-id | string |
Ein Client hat einen Bezeichner für den Vorgang angegeben, der in der Serverantwort wiedergegeben wird. |
|
|
Datenbank-ID
|
databaseId | True | string |
Der Name der Datenbank. |
|
Sammlungs-ID
|
collectionId | True | string |
Der Name der Sammlung. |
|
Dokument-ID
|
documentId | True | string |
Der Bezeichner für das Dokument. |
|
API-Version
|
x-ms-version | string |
API-Version. |
Gibt zurück
- response
- object
Abrufen gespeicherter Prozeduren (V2)
Abrufen gespeicherter Prozeduren in der angegebenen Auflistung (V2).
Parameter
| Name | Schlüssel | Erforderlich | Typ | Beschreibung |
|---|---|---|---|---|
|
Azure Cosmos DB-Kontoname
|
cosmosDbAccountName | True | string |
Der Name des Azure Cosmos DB-Kontos (ohne documents.azure.com). |
|
Datenbank-ID
|
databaseId | True | string |
Der Name der Datenbank. |
|
Sammlungs-ID
|
collectionId | True | string |
Der Name der Sammlung. |
|
API-Version
|
x-ms-version | string |
API-Version. |
Gibt zurück
Abrufen gespeicherter Prozeduren [VERALTET]
Diese Aktion ist veraltet. Verwenden Sie stattdessen "Gespeicherte Prozeduren abrufen" (V2 ).
Abrufen gespeicherter Prozeduren in der angegebenen Auflistung.
Parameter
| Name | Schlüssel | Erforderlich | Typ | Beschreibung |
|---|---|---|---|---|
|
Datenbank-ID
|
databaseId | True | string |
Der Name der Datenbank. |
|
Sammlungs-ID
|
collectionId | True | string |
Der Name der Sammlung. |
|
API-Version
|
x-ms-version | string |
API-Version. |
Gibt zurück
Ausgeführte gespeicherte Prozedur (V2)
Ausführen der gespeicherten Prozedur in der angegebenen Auflistung (V2).
Parameter
| Name | Schlüssel | Erforderlich | Typ | Beschreibung |
|---|---|---|---|---|
|
Azure Cosmos DB-Kontoname
|
cosmosDbAccountName | True | string |
Der Name des Azure Cosmos DB-Kontos (ohne documents.azure.com). |
|
Datenbank-ID
|
databaseId | True | string |
Der Name der Datenbank. |
|
Sammlungs-ID
|
collectionId | True | string |
Der Name der Sammlung. |
|
Partitionsschlüsselwert
|
x-ms-documentdb-raw-partitionkey | string |
Der Partitionsschlüsselwert für den angeforderten Dokument- oder Anlagenvorgang. |
|
|
Sproc-ID
|
sprocId | True | string |
Der Name der gespeicherten Prozedur. |
|
Parameter für die gespeicherte Prozedur
|
parameters | string |
Geben Sie gültige JSON für die Parameter der gespeicherten Prozedur an, z. B. ["param1", "param2"]. |
|
|
API-Version
|
x-ms-version | string |
API-Version. |
Gibt zurück
- response
- ObjectWithoutType
Ausgeführte gespeicherte Prozedur [VERALTET]
Diese Aktion ist veraltet. Verwenden Sie stattdessen die gespeicherte Execute-Prozedur (V2 ).
Führen Sie die gespeicherte Prozedur in der angegebenen Auflistung aus.
Parameter
| Name | Schlüssel | Erforderlich | Typ | Beschreibung |
|---|---|---|---|---|
|
Datenbank-ID
|
databaseId | True | string |
Der Name der Datenbank. |
|
Sammlungs-ID
|
collectionId | True | string |
Der Name der Sammlung. |
|
Partitionsschlüsselwert
|
x-ms-documentdb-raw-partitionkey | string |
Der Partitionsschlüsselwert für den angeforderten Dokument- oder Anlagenvorgang. |
|
|
Sproc-ID
|
sprocId | True | string |
Der Name der gespeicherten Prozedur. |
|
Parameter für die gespeicherte Prozedur
|
parameters | string |
Geben Sie gültige JSON für die Parameter der gespeicherten Prozedur an, z. B. ["param1", "param2"]. |
|
|
API-Version
|
x-ms-version | string |
API-Version. |
Gibt zurück
- response
- ObjectWithoutType
Dokument erstellen oder aktualisieren (V2) [VERALTET]
Diese Aktion ist veraltet. Verwenden Sie stattdessen "Dokument erstellen oder aktualisieren" (V3 ).
Erstellen oder Aktualisieren des Dokuments. Beim Erstellen eines Dokuments in DocumentDB muss der Textkörper eine ID-Eigenschaft enthalten.
Parameter
| Name | Schlüssel | Erforderlich | Typ | Beschreibung |
|---|---|---|---|---|
|
Max. Elementanzahl
|
x-ms-max-item-count | number |
Eine ganze Zahl, die die maximale Anzahl von Elementen angibt, die pro Seite zurückgegeben werden sollen. |
|
|
Fortsetzungstoken
|
x-ms-continuation | string |
Ein Zeichenfolgentoken, das für Abfragen und Lesefeedvorgänge zurückgegeben wird, wenn weitere Ergebnisse gelesen werden müssen. |
|
|
Konsistenzstufe
|
x-ms-consistency-level | string |
Dies ist die Außerkraftsetzung der Konsistenzstufe. Die gültigen Werte sind: "Strong", "Bounded", "Session" oder "Eventual" (in Der Reihenfolge der stärksten bis schwächsten). |
|
|
Sitzungstoken
|
x-ms-session-token | string |
Ein Zeichenfolgentoken, das mit Konsistenz auf Sitzungsebene verwendet wird. |
|
|
Aktivitäts-ID
|
x-ms-activity-id | string |
Ein Client hat einen Bezeichner für den Vorgang angegeben, der in der Serverantwort wiedergegeben wird. |
|
|
IsUpsert
|
x-ms-documentdb-is-upsert | boolean |
Wenn dieser Wert auf "true" festgelegt ist, wird das Dokument ersetzt, wenn es sonst erstellt wurde. |
|
|
Vorauslöser
|
x-ms-documentdb-pre-trigger-include | string |
Durch Trennzeichen getrennte Liste der Triggernamen, die ausgeführt werden sollen, bevor der Dokumentvorgang ausgeführt wird. |
|
|
Posttrigger
|
x-ms-documentdb-post-trigger-include | string |
Durch Trennzeichen getrennte Liste der Triggernamen, die nach der Ausführung des Dokumentvorgangs ausgeführt werden sollen. |
|
|
Datenbank-ID
|
databaseId | True | string |
Der Name der Datenbank. |
|
Sammlungs-ID
|
collectionId | True | string |
Der Name der Sammlung. |
|
API-Version
|
x-ms-version | string |
API-Version. |
Gibt zurück
Dokument erstellen oder aktualisieren [VERALTET]
Diese Aktion ist veraltet. Verwenden Sie stattdessen "Dokument erstellen oder aktualisieren" (V3 ).
Erstellen oder Aktualisieren des Dokuments. Beim Erstellen eines Dokuments in DocumentDB muss der Textkörper eine ID-Eigenschaft enthalten.
Parameter
| Name | Schlüssel | Erforderlich | Typ | Beschreibung |
|---|---|---|---|---|
|
Partitionsschlüsselwert
|
x-ms-documentdb-raw-partitionkey | string |
Der Partitionsschlüsselwert für den angeforderten Dokument- oder Anlagenvorgang. |
|
|
Max. Elementanzahl
|
x-ms-max-item-count | number |
Eine ganze Zahl, die die maximale Anzahl von Elementen angibt, die pro Seite zurückgegeben werden sollen. |
|
|
Fortsetzungstoken
|
x-ms-continuation | string |
Ein Zeichenfolgentoken, das für Abfragen und Lesefeedvorgänge zurückgegeben wird, wenn weitere Ergebnisse gelesen werden müssen. |
|
|
Konsistenzstufe
|
x-ms-consistency-level | string |
Dies ist die Außerkraftsetzung der Konsistenzstufe. Die gültigen Werte sind: "Strong", "Bounded", "Session" oder "Eventual" (in Der Reihenfolge der stärksten bis schwächsten). |
|
|
Sitzungstoken
|
x-ms-session-token | string |
Ein Zeichenfolgentoken, das mit Konsistenz auf Sitzungsebene verwendet wird. |
|
|
Aktivitäts-ID
|
x-ms-activity-id | string |
Ein Client hat einen Bezeichner für den Vorgang angegeben, der in der Serverantwort wiedergegeben wird. |
|
|
IsUpsert
|
x-ms-documentdb-is-upsert | boolean |
Wenn dieser Wert auf "true" festgelegt ist, wird das Dokument ersetzt, wenn es sonst erstellt wurde. |
|
|
Vorauslöser
|
x-ms-documentdb-pre-trigger-include | string |
Durch Trennzeichen getrennte Liste der Triggernamen, die ausgeführt werden sollen, bevor der Dokumentvorgang ausgeführt wird. |
|
|
Posttrigger
|
x-ms-documentdb-post-trigger-include | string |
Durch Trennzeichen getrennte Liste der Triggernamen, die nach der Ausführung des Dokumentvorgangs ausgeführt werden sollen. |
|
|
Datenbank-ID
|
databaseId | True | string |
Der Name der Datenbank. |
|
Sammlungs-ID
|
collectionId | True | string |
Der Name der Sammlung. |
|
API-Version
|
x-ms-version | string |
API-Version. |
Gibt zurück
Ersetzen eines Dokuments (V2)
Ersetzen eines Dokuments (V2).
Parameter
| Name | Schlüssel | Erforderlich | Typ | Beschreibung |
|---|---|---|---|---|
|
Partitionsschlüsselwert
|
x-ms-documentdb-raw-partitionkey | string |
Der Partitionsschlüsselwert für den angeforderten Dokument- oder Anlagenvorgang. |
|
|
Max. Elementanzahl
|
x-ms-max-item-count | number |
Eine ganze Zahl, die die maximale Anzahl von Elementen angibt, die pro Seite zurückgegeben werden sollen. |
|
|
Fortsetzungstoken
|
x-ms-continuation | string |
Ein Zeichenfolgentoken, das für Abfragen und Lesefeedvorgänge zurückgegeben wird, wenn weitere Ergebnisse gelesen werden müssen. |
|
|
Konsistenzstufe
|
x-ms-consistency-level | string |
Dies ist die Außerkraftsetzung der Konsistenzstufe. Die gültigen Werte sind: "Strong", "Bounded", "Session" oder "Eventual" (in Der Reihenfolge der stärksten bis schwächsten). |
|
|
Sitzungstoken
|
x-ms-session-token | string |
Ein Zeichenfolgentoken, das mit Konsistenz auf Sitzungsebene verwendet wird. |
|
|
Aktivitäts-ID
|
x-ms-activity-id | string |
Ein Client hat einen Bezeichner für den Vorgang angegeben, der in der Serverantwort wiedergegeben wird. |
|
|
Vorauslöser
|
x-ms-documentdb-pre-trigger-include | string |
Durch Trennzeichen getrennte Liste der Triggernamen, die ausgeführt werden sollen, bevor der Dokumentvorgang ausgeführt wird. |
|
|
Posttrigger
|
x-ms-documentdb-post-trigger-include | string |
Durch Trennzeichen getrennte Liste der Triggernamen, die nach der Ausführung des Dokumentvorgangs ausgeführt werden sollen. |
|
|
Azure Cosmos DB-Kontoname
|
cosmosDbAccountName | True | string |
Der Name des Azure Cosmos DB-Kontos (ohne documents.azure.com). |
|
Datenbank-ID
|
databaseId | True | string |
Der Name der Datenbank. |
|
Sammlungs-ID
|
collectionId | True | string |
Der Name der Sammlung. |
|
Dokument-ID
|
documentId | True | string |
Der Bezeichner des Dokuments. |
|
API-Version
|
x-ms-version | string |
API-Version. |
Gibt zurück
- Body
- putDocumentResponse
Ersetzen eines Dokuments [VERALTET]
Diese Aktion ist veraltet. Verwenden Sie stattdessen "Ersetzen" (V2).
Ersetzen Sie ein Dokument.
Parameter
| Name | Schlüssel | Erforderlich | Typ | Beschreibung |
|---|---|---|---|---|
|
Partitionsschlüsselwert
|
x-ms-documentdb-raw-partitionkey | string |
Der Partitionsschlüsselwert für den angeforderten Dokument- oder Anlagenvorgang. |
|
|
Max. Elementanzahl
|
x-ms-max-item-count | number |
Eine ganze Zahl, die die maximale Anzahl von Elementen angibt, die pro Seite zurückgegeben werden sollen. |
|
|
Fortsetzungstoken
|
x-ms-continuation | string |
Ein Zeichenfolgentoken, das für Abfragen und Lesefeedvorgänge zurückgegeben wird, wenn weitere Ergebnisse gelesen werden müssen. |
|
|
Konsistenzstufe
|
x-ms-consistency-level | string |
Dies ist die Außerkraftsetzung der Konsistenzstufe. Die gültigen Werte sind: "Strong", "Bounded", "Session" oder "Eventual" (in Der Reihenfolge der stärksten bis schwächsten). |
|
|
Sitzungstoken
|
x-ms-session-token | string |
Ein Zeichenfolgentoken, das mit Konsistenz auf Sitzungsebene verwendet wird. |
|
|
Aktivitäts-ID
|
x-ms-activity-id | string |
Ein Client hat einen Bezeichner für den Vorgang angegeben, der in der Serverantwort wiedergegeben wird. |
|
|
Vorauslöser
|
x-ms-documentdb-pre-trigger-include | string |
Durch Trennzeichen getrennte Liste der Triggernamen, die ausgeführt werden sollen, bevor der Dokumentvorgang ausgeführt wird. |
|
|
Posttrigger
|
x-ms-documentdb-post-trigger-include | string |
Durch Trennzeichen getrennte Liste der Triggernamen, die nach der Ausführung des Dokumentvorgangs ausgeführt werden sollen. |
|
|
Datenbank-ID
|
databaseId | True | string |
Der Name der Datenbank. |
|
Sammlungs-ID
|
collectionId | True | string |
Der Name der Sammlung. |
|
Dokument-ID
|
documentId | True | string |
Der Bezeichner des Dokuments. |
|
API-Version
|
x-ms-version | string |
API-Version. |
Gibt zurück
- Body
- putDocumentResponse
Erstellen einer gespeicherten Prozedur (V2)
Erstellen einer gespeicherten Prozedur (V2).
Parameter
| Name | Schlüssel | Erforderlich | Typ | Beschreibung |
|---|---|---|---|---|
|
Azure Cosmos DB-Kontoname
|
cosmosDbAccountName | True | string |
Der Name des Azure Cosmos DB-Kontos (ohne documents.azure.com). |
|
Datenbank-ID
|
databaseId | True | string |
Der Name der Datenbank. |
|
Sammlungs-ID
|
collectionId | True | string |
Der Name der Sammlung. |
|
Funktionsdefinition
|
body | string |
Funktion, die die gespeicherte Prozedur definiert, z. B. 'function(params){ ... }' |
|
|
id
|
id | string |
Neue ID der gespeicherten Prozedur. |
|
|
API-Version
|
x-ms-version | string |
API-Version. |
Gibt zurück
Erstellen oder Aktualisieren eines Dokuments (V3)
Erstellen oder Aktualisieren des Dokuments. Beim Erstellen eines Dokuments in DocumentDB muss der Textkörper eine ID-Eigenschaft enthalten.
Parameter
| Name | Schlüssel | Erforderlich | Typ | Beschreibung |
|---|---|---|---|---|
|
Max. Elementanzahl
|
x-ms-max-item-count | number |
Eine ganze Zahl, die die maximale Anzahl von Elementen angibt, die pro Seite zurückgegeben werden sollen. |
|
|
Fortsetzungstoken
|
x-ms-continuation | string |
Ein Zeichenfolgentoken, das für Abfragen und Lesefeedvorgänge zurückgegeben wird, wenn weitere Ergebnisse gelesen werden müssen. |
|
|
Konsistenzstufe
|
x-ms-consistency-level | string |
Dies ist die Außerkraftsetzung der Konsistenzstufe. Die gültigen Werte sind: "Strong", "Bounded", "Session" oder "Eventual" (in Der Reihenfolge der stärksten bis schwächsten). |
|
|
Sitzungstoken
|
x-ms-session-token | string |
Ein Zeichenfolgentoken, das mit Konsistenz auf Sitzungsebene verwendet wird. |
|
|
Aktivitäts-ID
|
x-ms-activity-id | string |
Ein Client hat einen Bezeichner für den Vorgang angegeben, der in der Serverantwort wiedergegeben wird. |
|
|
IsUpsert
|
x-ms-documentdb-is-upsert | boolean |
Wenn dieser Wert auf "true" festgelegt ist, wird das Dokument ersetzt, wenn es sonst erstellt wurde. |
|
|
Vorauslöser
|
x-ms-documentdb-pre-trigger-include | string |
Durch Trennzeichen getrennte Liste der Triggernamen, die ausgeführt werden sollen, bevor der Dokumentvorgang ausgeführt wird. |
|
|
Posttrigger
|
x-ms-documentdb-post-trigger-include | string |
Durch Trennzeichen getrennte Liste der Triggernamen, die nach der Ausführung des Dokumentvorgangs ausgeführt werden sollen. |
|
|
Azure Cosmos DB-Kontoname
|
cosmosDbAccountName | True | string |
Der Name des Azure Cosmos DB-Kontos (ohne documents.azure.com). |
|
Datenbank-ID
|
databaseId | True | string |
Der Name der Datenbank. |
|
Sammlungs-ID
|
collectionId | True | string |
Der Name der Sammlung. |
|
API-Version
|
x-ms-version | string |
API-Version. |
Gibt zurück
Gespeicherte Prozedur ersetzen (V2)
Gespeicherte Prozedur ersetzen (V2).
Parameter
| Name | Schlüssel | Erforderlich | Typ | Beschreibung |
|---|---|---|---|---|
|
Azure Cosmos DB-Kontoname
|
cosmosDbAccountName | True | string |
Der Name des Azure Cosmos DB-Kontos (ohne documents.azure.com). |
|
Datenbank-ID
|
databaseId | True | string |
Der Name der Datenbank. |
|
Sammlungs-ID
|
collectionId | True | string |
Der Name der Sammlung. |
|
Sproc-ID
|
sprocId | True | string |
Der Name der gespeicherten Prozedur. |
|
Funktionsdefinition
|
body | string |
Funktion, die die gespeicherte Prozedur definiert, z. B. 'function(params){ ... }' |
|
|
id
|
id | string |
ID der vorhandenen gespeicherten Prozedur. |
|
|
API-Version
|
x-ms-version | string |
API-Version. |
Gibt zurück
Gespeicherte Prozedur ersetzen [VERALTET]
Diese Aktion ist veraltet. Verwenden Sie stattdessen "Gespeicherte Prozedur ersetzen" (V2 ).
Ersetzen Sie die gespeicherte Prozedur.
Parameter
| Name | Schlüssel | Erforderlich | Typ | Beschreibung |
|---|---|---|---|---|
|
Datenbank-ID
|
databaseId | True | string |
Der Name der Datenbank. |
|
Sammlungs-ID
|
collectionId | True | string |
Der Name der Sammlung. |
|
Sproc-ID
|
sprocId | True | string |
Der Name der gespeicherten Prozedur. |
|
Funktionsdefinition
|
body | string |
Funktion, die die gespeicherte Prozedur definiert, z. B. 'function(params){ ... }' |
|
|
id
|
id | string |
ID der vorhandenen gespeicherten Prozedur. |
|
|
API-Version
|
x-ms-version | string |
API-Version. |
Gibt zurück
Gespeicherte Prozedur erstellen [VERALTET]
Diese Aktion ist veraltet. Verwenden Sie stattdessen "Gespeicherte Prozedur erstellen" (V2 ).
Erstellen Sie eine gespeicherte Prozedur.
Parameter
| Name | Schlüssel | Erforderlich | Typ | Beschreibung |
|---|---|---|---|---|
|
Datenbank-ID
|
databaseId | True | string |
Der Name der Datenbank. |
|
Sammlungs-ID
|
collectionId | True | string |
Der Name der Sammlung. |
|
Funktionsdefinition
|
body | string |
Funktion, die die gespeicherte Prozedur definiert, z. B. 'function(params){ ... }' |
|
|
id
|
id | string |
Neue ID der gespeicherten Prozedur. |
|
|
API-Version
|
x-ms-version | string |
API-Version. |
Gibt zurück
Gespeicherte Prozedur löschen (V2)
Gespeicherte Prozedur löschen (V2).
Parameter
| Name | Schlüssel | Erforderlich | Typ | Beschreibung |
|---|---|---|---|---|
|
Azure Cosmos DB-Kontoname
|
cosmosDbAccountName | True | string |
Der Name des Azure Cosmos DB-Kontos (ohne documents.azure.com). |
|
Datenbank-ID
|
databaseId | True | string |
Der Name der Datenbank. |
|
Sammlungs-ID
|
collectionId | True | string |
Der Name der Sammlung. |
|
Sproc-ID
|
sprocId | True | string |
Der Name der gespeicherten Prozedur. |
|
API-Version
|
x-ms-version | string |
API-Version. |
Gibt zurück
- response
- string
Gespeicherte Prozedur löschen [VERALTET]
Diese Aktion ist veraltet. Verwenden Sie stattdessen delete stored procedure (V2 ).
Gespeicherte Prozedur löschen.
Parameter
| Name | Schlüssel | Erforderlich | Typ | Beschreibung |
|---|---|---|---|---|
|
Datenbank-ID
|
databaseId | True | string |
Der Name der Datenbank. |
|
Sammlungs-ID
|
collectionId | True | string |
Der Name der Sammlung. |
|
Sproc-ID
|
sprocId | True | string |
Der Name der gespeicherten Prozedur. |
|
API-Version
|
x-ms-version | string |
API-Version. |
Gibt zurück
- response
- string
Löschen eines Dokuments (V2)
Löschen eines Dokuments (V2).
Parameter
| Name | Schlüssel | Erforderlich | Typ | Beschreibung |
|---|---|---|---|---|
|
Partitionsschlüsselwert
|
x-ms-documentdb-raw-partitionkey | string |
Der Partitionsschlüsselwert für den angeforderten Dokument- oder Anlagenvorgang. |
|
|
Max. Elementanzahl
|
x-ms-max-item-count | number |
Eine ganze Zahl, die die maximale Anzahl von Elementen angibt, die pro Seite zurückgegeben werden sollen. |
|
|
Fortsetzungstoken
|
x-ms-continuation | string |
Ein Zeichenfolgentoken, das für Abfragen und Lesefeedvorgänge zurückgegeben wird, wenn weitere Ergebnisse gelesen werden müssen. |
|
|
Konsistenzstufe
|
x-ms-consistency-level | string |
Dies ist die Außerkraftsetzung der Konsistenzstufe. Die gültigen Werte sind: "Strong", "Bounded", "Session" oder "Eventual" (in Der Reihenfolge der stärksten bis schwächsten). |
|
|
Sitzungstoken
|
x-ms-session-token | string |
Ein Zeichenfolgentoken, das mit Konsistenz auf Sitzungsebene verwendet wird. |
|
|
Aktivitäts-ID
|
x-ms-activity-id | string |
Ein Client hat einen Bezeichner für den Vorgang angegeben, der in der Serverantwort wiedergegeben wird. |
|
|
Vorauslöser
|
x-ms-documentdb-pre-trigger-include | string |
Durch Trennzeichen getrennte Liste der Triggernamen, die ausgeführt werden sollen, bevor der Dokumentvorgang ausgeführt wird. |
|
|
Posttrigger
|
x-ms-documentdb-post-trigger-include | string |
Durch Trennzeichen getrennte Liste der Triggernamen, die nach der Ausführung des Dokumentvorgangs ausgeführt werden sollen. |
|
|
Azure Cosmos DB-Kontoname
|
cosmosDbAccountName | True | string |
Der Name des Azure Cosmos DB-Kontos (ohne documents.azure.com). |
|
Datenbank-ID
|
databaseId | True | string |
Der Name der Datenbank. |
|
Sammlungs-ID
|
collectionId | True | string |
Der Name der Sammlung. |
|
Dokument-ID
|
documentId | True | string |
Der Bezeichner des Dokuments. |
|
API-Version
|
x-ms-version | string |
API-Version. |
Löschen eines Dokuments [VERALTET]
Diese Aktion ist veraltet. Verwenden Sie stattdessen das Löschen eines Dokuments (V2 ).
Löschen eines Dokuments.
Parameter
| Name | Schlüssel | Erforderlich | Typ | Beschreibung |
|---|---|---|---|---|
|
Partitionsschlüsselwert
|
x-ms-documentdb-raw-partitionkey | string |
Der Partitionsschlüsselwert für den angeforderten Dokument- oder Anlagenvorgang. |
|
|
Max. Elementanzahl
|
x-ms-max-item-count | number |
Eine ganze Zahl, die die maximale Anzahl von Elementen angibt, die pro Seite zurückgegeben werden sollen. |
|
|
Fortsetzungstoken
|
x-ms-continuation | string |
Ein Zeichenfolgentoken, das für Abfragen und Lesefeedvorgänge zurückgegeben wird, wenn weitere Ergebnisse gelesen werden müssen. |
|
|
Konsistenzstufe
|
x-ms-consistency-level | string |
Dies ist die Außerkraftsetzung der Konsistenzstufe. Die gültigen Werte sind: "Strong", "Bounded", "Session" oder "Eventual" (in Der Reihenfolge der stärksten bis schwächsten). |
|
|
Sitzungstoken
|
x-ms-session-token | string |
Ein Zeichenfolgentoken, das mit Konsistenz auf Sitzungsebene verwendet wird. |
|
|
Aktivitäts-ID
|
x-ms-activity-id | string |
Ein Client hat einen Bezeichner für den Vorgang angegeben, der in der Serverantwort wiedergegeben wird. |
|
|
Vorauslöser
|
x-ms-documentdb-pre-trigger-include | string |
Durch Trennzeichen getrennte Liste der Triggernamen, die ausgeführt werden sollen, bevor der Dokumentvorgang ausgeführt wird. |
|
|
Posttrigger
|
x-ms-documentdb-post-trigger-include | string |
Durch Trennzeichen getrennte Liste der Triggernamen, die nach der Ausführung des Dokumentvorgangs ausgeführt werden sollen. |
|
|
Datenbank-ID
|
databaseId | True | string |
Der Name der Datenbank. |
|
Sammlungs-ID
|
collectionId | True | string |
Der Name der Sammlung. |
|
Dokument-ID
|
documentId | True | string |
Der Bezeichner des Dokuments. |
|
API-Version
|
x-ms-version | string |
API-Version. |
Definitionen
QueryDocumentsResponse
Array von Dokumenten, die der angeforderten Abfrage und den zugehörigen Metadaten entsprechen.
| Name | Pfad | Typ | Beschreibung |
|---|---|---|---|
|
Dokumente
|
Documents | array of ObjectWithoutType |
Array von Dokumenten, die der Anforderung entsprechen. |
|
Anzahl der Dokumente
|
_count | integer |
Anzahl der Dokumente. |
|
Aktivitäts-ID
|
ActivityId | string |
Azure Cosmos DB-Dienstaktivitäts-ID. |
DocumentsCollection
Array von Dokumenten, die der angeforderten Abfrage und den zugehörigen Metadaten entsprechen.
| Name | Pfad | Typ | Beschreibung |
|---|---|---|---|
|
Dokumente
|
value | array of ObjectWithoutType | |
|
Fortsetzungstoken
|
ContinuationToken | string | |
|
Anzahl der Dokumente
|
Count | integer | |
|
Gebühr anfordern
|
RequestCharge | double | |
|
Sitzungstoken
|
SessionToken | string | |
|
Aktivitäts-ID
|
ActivityId | string |
postDocumentsResponse
| Name | Pfad | Typ | Beschreibung |
|---|---|---|---|
|
_rid
|
_rid | string | |
|
_ts
|
_ts | integer | |
|
_selbst
|
_self | string | |
|
_etag
|
_etag | string | |
|
_Anhängsel
|
_attachments | string | |
|
id
|
id | string |
putDocumentResponse
| Name | Pfad | Typ | Beschreibung |
|---|---|---|---|
|
_rid
|
_rid | string | |
|
id
|
id | string |
getDocumentsResponse
| Name | Pfad | Typ | Beschreibung |
|---|---|---|---|
|
_rid
|
_rid | string | |
|
Dokumente
|
Documents | array of object |
queryResponse
| Name | Pfad | Typ | Beschreibung |
|---|---|---|---|
|
_rid
|
_rid | string | |
|
_zählen
|
_count | number | |
|
Dokumente
|
Documents | array of |
getStoredProceduresResponse
| Name | Pfad | Typ | Beschreibung |
|---|---|---|---|
|
_zählen
|
_count | integer |
_zählen |
|
_rid
|
_rid | string |
_rid |
|
Gespeicherte Prozeduren
|
StoredProcedures | array of object |
Gespeicherte Prozeduren |
|
_etag
|
StoredProcedures._etag | string |
_etag |
|
_rid
|
StoredProcedures._rid | string |
_rid |
|
_selbst
|
StoredProcedures._self | string |
_selbst |
|
_ts
|
StoredProcedures._ts | integer |
_ts |
|
body
|
StoredProcedures.body | string |
body |
|
id
|
StoredProcedures.id | string |
id |
createStoredProcedureResponse
| Name | Pfad | Typ | Beschreibung |
|---|---|---|---|
|
_etag
|
_etag | string |
_etag |
|
_rid
|
_rid | string |
_rid |
|
_selbst
|
_self | string |
_selbst |
|
_ts
|
_ts | integer |
_ts |
|
body
|
body | string |
body |
|
id
|
id | string |
id |
ObjectWithoutType
Schnur
Dies ist der grundlegende Datentyp "string".
Objekt
Dies ist der Typ 'object'.