Base de données Azure Cosmos DB
Azure Cosmos DB est un service de base de données multimodèle distribué globalement conçu pour vous permettre de mettre à l’échelle de manière élastique et indépendante le débit et le stockage sur un nombre quelconque de régions géographiques avec un contrat SLA complet.
Ce connecteur est disponible dans les produits et régions suivants :
| Service | classe | Régions |
|---|---|---|
| Copilot Studio | Premium | Toutes les régions Power Automate |
| Applications logiques | Norme | Toutes les régions Logic Apps |
| Power Apps | - | Non disponible |
| Power Automate | Premium | Toutes les régions Power Automate |
| Métadonnées du connecteur | |
|---|---|
| Éditeur | Microsoft |
Pour utiliser cette intégration, vous aurez besoin d’un compte d’API SQL Cosmos DB configuré dans le portail Azure. Notez que les comptes d’API Mongo DB ne sont actuellement pas pris en charge.
Une fois le compte d’API SQL créé, fournissez l’ID de compte (sans « documents.azure.com ») lors de la création d’une connexion avec le connecteur Azure Cosmos DB si vous créez une connexion de Access Key type. Cet ID de compte est également requis pour les versions plus récentes d’opération qui prennent en charge l’authentification Microsoft Entra ID.
Authentification microsoft Entra ID et connecteur Cosmos DB
Pour utiliser l’authentification d’ID Microsoft Entra, le compte utilisé doit être affecté à une attribution de rôle spécifique, pour plus d’informations, consultez Configurer le contrôle d’accès en fonction du rôle avec l’ID Microsoft Entra pour votre compte Azure Cosmos DB.
Note
Seuls les rôles explicitement définis pour l’accès aux données permettent à un principal de sécurité d’accéder aux données Cosmos DB. Les rôles intégrés tels que Owner, ou Contributorne fournissent pas d’accès aux données Cosmos DB au sein de ce compte via l’ID Microsoft Entra. Il existe 2 rôles intégrés exposés par Azure Cosmos DB :
-
Cosmos DB Built-in Data Reader(ID00000000-0000-0000-0000-000000000001de définition de rôle) -
Cosmos DB Built-in Data Contributor(ID00000000-0000-0000-0000-000000000002de définition de rôle)
Les rôles peuvent être attribués de nombreuses façons et des rôles personnalisés peuvent être créés pour un accès plus granulaire.
Voici un exemple sur les personnes à attribuer Cosmos DB Built-in Data Reader via PowerShell (plus d’informations sur cette commande 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 "/"
L’échec de l’ajout de ces attributions de rôles se termine par des requêtes non autorisées comme celle-ci : Request is blocked because principal [<<principal-id>>] does not have the required RBAC permissions to perform action <unauthorized actions>.
Note
Azure Cosmos DB ne prend pas en charge les opérations de gestion avec l’authentification Microsoft Entra ID (documentée ici). Les opérations suivantes fonctionnent uniquement avec Access Key les connexions :
- Créer une procédure stockée (versions V1 et V2)
- Supprimer la procédure stockée (versions V1 et V2)
- Mettre à jour la procédure stockée (versions V1 et V2)
Opérations non prises en charge avec l’authentification Microsoft Entra ID
Lorsque vous utilisez l’authentification Microsoft Entra ID , seules les actions avec le nom du compte Cosmos DB en tant que paramètre sont prises en charge. Les actions déconseillées continueront de fonctionner avec Access Key l’authentification, mais échoueront si elles sont utilisées avec une connexion Microsoft Entra ID.
Problèmes connus et limitations
La taille maximale d’un document pris en charge par le connecteur DocumentDB (Azure Cosmos DB) est de 2 Mo.
Les limitations d’Azure Cosmos DB sont documentées ici.
Le choix d’une région d’écriture et d’une région à plusieurs écritures n’est pas pris en charge par le connecteur.
La « valeur de clé de partition » doit être fournie en fonction de son type. Par exemple, une valeur de chaîne doit être placée entre guillemets, un nombre doit être fourni tel quel. Par exemple : « valeur de chaîne »,123, 0,5.
La « valeur de clé de partition » est requise pour les requêtes avec
ORDER BY,DISTINCTetc. qui s’exécutent sur des collections partitionnée.Interroger les documents V2 [DEPRECATED], Interroger les documents V3, obtenir tous les documents V2 (préversion) utilise le Kit de développement logiciel (SDK) .NET Azure Cosmos DB pour l’API SQL (version 2.13.1).
L’action Interroger les documents V4 (préversion) utilise le Kit de développement logiciel (SDK) .NET Azure Cosmos DB pour l’API SQL (version 3.15.0).
L’action Interroger des documents (V5) (préversion) utilise le Kit de développement logiciel (SDK) .NET Azure Cosmos DB pour l’API SQL (version 3.20.0).
La valeur du paramètre « Nombre maximal d’éléments » peut être n’importe quel nombre compris entre 1 et 1 000. Tout nombre en dehors de cette plage sera implicitement converti en « -1 », ce qui indique au service Cosmos DB de déterminer le nombre d’éléments optimal.
Si elles sont laissées vides, les opérations suivantes fonctionnent uniquement avec les documents qui n’ont pas de valeur de clé de partition. Les éléments dont la valeur de clé de partition est exclue de ces actions.
En raison d’Azure Cosmos DB qui ne prend pas en charge les opérations de gestion avec l’authentification Microsoft Entra ID (documentée ici), l’opération Exécuter la procédure stockée (V2) (préversion) affiche uniquement les procédures stockées disponibles (pour le paramètre) lors de l’utilisation
SprocIdd’uneAccess Keyconnexion basée.TokenLes authentifications basées sur Microsoft Entra (authentifications d’ID Microsoft Entra) affichent une liste vide et lasprocIdvaleur personnalisée doit être entrée manuellement.
Important
Les connexions Microsoft Entra ID Integrated (Azure Commercial) sont désactivées dans les environnements US Government (GCC) par défaut. Pour activer ces types de connexions, le paramètre Se connecter à Azure Commercial doit être activé dans le Centre d’administration Power Platform par un administrateur client.
L’activation de ce paramètre permet aux connexions aux ressources dans Azure Commercial qui opèrent et envoient des données en dehors de la limite de conformité de Power Platform US Government. Cela est spécifiquement utilisé pour autoriser l’accès aux ressources commerciales à partir des versions cloud GCC de Power Platform Connectors.
Microsoft Entra ID Integrated (Azure Commercial) est le seul type d’authentification qui fonctionne à partir d’environnements US Government (GCC) aux ressources commerciales Azure.
Authentification commerciale Azure désactivée par défaut : 
Paramètre Se connecter à Azure Commercial dans le Centre d’administration Power Platform : 
Création d’une connexion
Le connecteur prend en charge les types d’authentification suivants :
| Clé d'accès | Fournissez le nom du compte et la clé d’accès pour accéder à votre compte Cosmos DB. | Toutes les régions à l’exception d’Azure Government et du Ministère de la Défense (DoD) dans Azure Government et US Government (GCC) et US Government (GCC-High) | Partageable |
| Clé d’accès (Azure Government) | Fournissez le nom du compte et la clé d’accès pour accéder à votre compte Cosmos DB. | Azure Government and Department of Defense (DoD) dans Azure Government and US Government (GCC) et US Government (GCC-High) uniquement | Partageable |
| Identités managées par applications logiques | Créer une connexion à l’aide d’une identité managée LogicApps | LOGICAPPS uniquement | Partageable |
| Microsoft Entra ID Intégré | Utilisez l’ID Microsoft Entra pour accéder à votre stockage Blob Azure. | Toutes les régions à l’exception d’Azure Government et du Ministère de la Défense (DoD) dans Azure Government et US Government (GCC) et US Government (GCC-High) | Non partageable |
| Microsoft Entra ID Integrated (Azure Commercial) | Utilisez l’ID Microsoft Entra pour accéder à votre Stockage Blob Azure dans Azure Commercial. | Us Government (GCC) uniquement | Non partageable |
| Microsoft Entra ID Integrated (Azure Government) | Utilisez l’ID Microsoft Entra pour accéder à votre stockage Blob Azure. | Azure Government and Department of Defense (DoD) dans Azure Government and US Government (GCC) et US Government (GCC-High) uniquement | Non partageable |
| Valeur par défaut [DÉCONSEILLÉE] | Cette option concerne uniquement les connexions plus anciennes sans type d’authentification explicite et est fournie uniquement pour la compatibilité descendante. | Toutes les régions | Non partageable |
Clé d’accès
ID d’authentification : keyBasedAuth
Applicable : Toutes les régions à l’exception d’Azure Government et du Ministère de la Défense (DoD) dans Azure Government et US Government (GCC) et US Government (GCC-High)
Fournissez le nom du compte et la clé d’accès pour accéder à votre compte Cosmos DB.
Il s’agit d’une connexion partageable. Si l’application d’alimentation est partagée avec un autre utilisateur, la connexion est également partagée. Pour plus d’informations, consultez la vue d’ensemble des connecteurs pour les applications de canevas - Power Apps | Microsoft Docs
| Nom | Type | Descriptif | Obligatoire |
|---|---|---|---|
| ID de compte | ficelle | Nom du compte sans partie « documents.azure.com » | Vrai |
| Clé d’accès à votre compte Azure Cosmos DB | securestring | Clé primaire ou secondaire | Vrai |
Clé d’accès (Azure Government)
ID d’authentification : keyBasedAuth
Applicable : Azure Government and Department of Defense (DoD) dans Azure Government and US Government (GCC) et US Government (GCC-High) uniquement
Fournissez le nom du compte et la clé d’accès pour accéder à votre compte Cosmos DB.
Il s’agit d’une connexion partageable. Si l’application d’alimentation est partagée avec un autre utilisateur, la connexion est également partagée. Pour plus d’informations, consultez la vue d’ensemble des connecteurs pour les applications de canevas - Power Apps | Microsoft Docs
| Nom | Type | Descriptif | Obligatoire |
|---|---|---|---|
| ID de compte | ficelle | Nom du compte sans partie « documents.azure.com » | Vrai |
| Clé d’accès à votre compte Azure Cosmos DB | securestring | Clé primaire ou secondaire | Vrai |
Identité managée Logic Apps
ID d’authentification : managedIdentityAuth
Applicable : LOGICAPPS uniquement
Créer une connexion à l’aide d’une identité managée LogicApps
Il s’agit d’une connexion partageable. Si l’application d’alimentation est partagée avec un autre utilisateur, la connexion est également partagée. Pour plus d’informations, consultez la vue d’ensemble des connecteurs pour les applications de canevas - Power Apps | Microsoft Docs
| Nom | Type | Descriptif | Obligatoire |
|---|---|---|---|
| Identité managée LogicApps | managedIdentity | Se connecter avec une identité managée Logic Apps | Vrai |
Identifiant Microsoft Entra intégré
ID d’authentification : tokenBasedAuth
Applicable : Toutes les régions à l’exception d’Azure Government et du Ministère de la Défense (DoD) dans Azure Government et US Government (GCC) et US Government (GCC-High)
Utilisez l’ID Microsoft Entra pour accéder à votre stockage Blob Azure.
Cette connexion n’est pas partageable. Si l’application power est partagée avec un autre utilisateur, un autre utilisateur est invité à créer une connexion explicitement.
Microsoft Entra ID Integrated (Azure Commercial)
ID d’authentification : oauthCom
Applicable : US Government (GCC) uniquement
Utilisez l’ID Microsoft Entra pour accéder à votre Stockage Blob Azure dans Azure Commercial.
Cette connexion n’est pas partageable. Si l’application power est partagée avec un autre utilisateur, un autre utilisateur est invité à créer une connexion explicitement.
Microsoft Entra ID Integrated (Azure Government)
ID d’authentification : tokenBasedAuth
Applicable : Azure Government and Department of Defense (DoD) dans Azure Government and US Government (GCC) et US Government (GCC-High) uniquement
Utilisez l’ID Microsoft Entra pour accéder à votre stockage Blob Azure.
Cette connexion n’est pas partageable. Si l’application power est partagée avec un autre utilisateur, un autre utilisateur est invité à créer une connexion explicitement.
Valeur par défaut [DÉCONSEILLÉE]
Applicable : Toutes les régions
Cette option concerne uniquement les connexions plus anciennes sans type d’authentification explicite et est fournie uniquement pour la compatibilité descendante.
Cette connexion n’est pas partageable. Si l’application power est partagée avec un autre utilisateur, un autre utilisateur est invité à créer une connexion explicitement.
| Nom | Type | Descriptif | Obligatoire |
|---|---|---|---|
| ID de compte | ficelle | Nom du compte sans partie « documents.azure.com » | Vrai |
| Clé d’accès à votre compte Azure Cosmos DB | securestring | Clé primaire ou secondaire | Vrai |
Limitations
| Nom | Appels | Période de renouvellement |
|---|---|---|
| Appels d’API par connexion | 1500 | 60 secondes |
Actions
| Créer ou mettre à jour un document (V2) [DÉCONSEILLÉ] |
Cette action a été déconseillée. Utilisez plutôt Créer ou mettre à jour un document (V3).
|
| Créer ou mettre à jour un document (V3) |
Créez ou mettez à jour un document. Lors de la création d’un document dans DocumentDB, le corps doit inclure une propriété d’ID. |
| Créer ou mettre à jour un document [DÉCONSEILLÉ] |
Cette action a été déconseillée. Utilisez plutôt Créer ou mettre à jour un document (V3).
|
| Créer une procédure stockée (V2) |
Créer une procédure stockée (V2). |
| Créer une procédure stockée [DÉPRÉCIÉ] |
Cette action a été déconseillée. Utilisez plutôt Créer une procédure stockée (V2).
|
| Exécuter une procédure stockée (V2) |
Exécutez la procédure stockée dans la collection spécifiée (V2). |
| Exécuter une procédure stockée [DÉPRÉCIÉ] |
Cette action a été déconseillée. Utilisez la procédure stockée Execute (V2) à la place.
|
| Interroger des documents [DÉCONSEILLÉ] |
Cette action a été déconseillée. Utilisez plutôt les documents de requête V5 .
|
| Interroger des documents V2 [DÉCONSEILLÉ] |
Cette action a été déconseillée. Utilisez plutôt les documents de requête V5 .
|
| Interroger des documents V3 [DÉCONSEILLÉ] |
Cette action a été déconseillée. Utilisez plutôt les documents de requête V5 .
|
| Interroger des documents V4 [DÉCONSEILLÉ] |
Cette action a été déconseillée. Utilisez plutôt les documents de requête V5 .
|
| Interroger des documents V5 |
Interroger des documents (V5). |
| Obtenir des procédures stockées (V2) |
Obtenir les procédures stockées dans la collection spécifiée (V2). |
| Obtenir des procédures stockées [DÉCONSEILLÉE] |
Cette action a été déconseillée. Utilisez les procédures stockées Get (V2) à la place.
|
| Obtenir tous les documents (V3) |
Obtenir tous les documents (V3). |
| Obtenir tous les documents [DÉCONSEILLÉ] |
Cette action a été déconseillée. Utilisez plutôt Obtenir tous les documents (V3).
|
| Obtenir tous les documents V2 [DÉCONSEILLÉ] |
Cette action a été déconseillée. Utilisez plutôt Obtenir tous les documents (V3).
|
| Obtenir un document (V2) |
Obtenir un document (V2). |
| Obtenir un document [DÉCONSEILLÉ] |
Cette action a été déconseillée. Utilisez plutôt Obtenir un document (V2).
|
| Remplacer la procédure stockée (V2) |
Remplacez la procédure stockée (V2). |
| Remplacer la procédure stockée [DÉPRÉCIÉ] |
Cette action a été déconseillée. Utilisez plutôt remplacer la procédure stockée (V2).
|
| Remplacer un document (V2) |
Remplacez un document (V2). |
| Remplacer un document [DÉPRÉCIÉ] |
Cette action a été déconseillée. Utilisez à la place Remplacer un document (V2).
|
| Supprimer la procédure stockée (V2) |
Supprimer la procédure stockée (V2). |
| Supprimer la procédure stockée [DÉPRÉCIÉ] |
Cette action a été déconseillée. Utilisez la procédure stockée Delete (V2) à la place.
|
| Supprimer un document (V2) |
Supprimez un document (V2). |
| Supprimer un document [DÉCONSEILLÉ] |
Cette action a été déconseillée. Utilisez plutôt Supprimer un document (V2).
|
Créer ou mettre à jour un document (V2) [DÉCONSEILLÉ]
Cette action a été déconseillée. Utilisez plutôt Créer ou mettre à jour un document (V3).
Créez ou mettez à jour un document. Lors de la création d’un document dans DocumentDB, le corps doit inclure une propriété d’ID.
Paramètres
| Nom | Clé | Obligatoire | Type | Description |
|---|---|---|---|---|
|
Nombre maximal d’éléments
|
x-ms-max-item-count | number |
Entier indiquant le nombre maximal d’éléments à renvoyer par page. |
|
|
Jeton de continuation
|
x-ms-continuation | string |
Jeton de chaîne retourné pour les requêtes et les opérations de flux de lecture s’il existe d’autres résultats à lire. |
|
|
Niveau de cohérence
|
x-ms-consistency-level | string |
Il s’agit du remplacement du niveau de cohérence. Les valeurs valides sont : Strong, Bounded, Session ou Eventual (dans l’ordre le plus fort au plus faible). |
|
|
Jeton de session
|
x-ms-session-token | string |
Jeton de chaîne utilisé avec cohérence au niveau de la session. |
|
|
ID d’activité
|
x-ms-activity-id | string |
Identificateur fourni par le client pour l’opération, qui sera écho dans la réponse du serveur. |
|
|
IsUpsert
|
x-ms-documentdb-is-upsert | boolean |
Si la valeur est true, le document est remplacé s’il existe un autre élément créé. |
|
|
Pré-déclencheur
|
x-ms-documentdb-pre-trigger-include | string |
Liste séparée par des virgules des noms de déclencheurs à exécuter avant l’exécution de l’opération de document. |
|
|
Post-déclencheur
|
x-ms-documentdb-post-trigger-include | string |
Liste séparée par des virgules des noms de déclencheurs à exécuter après l’exécution de l’opération de document. |
|
|
ID de base de données
|
databaseId | True | string |
Nom de la base de données. |
|
Collection ID
|
collectionId | True | string |
Nom de la collection. |
|
Version de l’API
|
x-ms-version | string |
Version de l’API. |
Retours
- Corps
- postDocumentsResponse
Créer ou mettre à jour un document (V3)
Créez ou mettez à jour un document. Lors de la création d’un document dans DocumentDB, le corps doit inclure une propriété d’ID.
Paramètres
| Nom | Clé | Obligatoire | Type | Description |
|---|---|---|---|---|
|
Nombre maximal d’éléments
|
x-ms-max-item-count | number |
Entier indiquant le nombre maximal d’éléments à renvoyer par page. |
|
|
Jeton de continuation
|
x-ms-continuation | string |
Jeton de chaîne retourné pour les requêtes et les opérations de flux de lecture s’il existe d’autres résultats à lire. |
|
|
Niveau de cohérence
|
x-ms-consistency-level | string |
Il s’agit du remplacement du niveau de cohérence. Les valeurs valides sont : Strong, Bounded, Session ou Eventual (dans l’ordre le plus fort au plus faible). |
|
|
Jeton de session
|
x-ms-session-token | string |
Jeton de chaîne utilisé avec cohérence au niveau de la session. |
|
|
ID d’activité
|
x-ms-activity-id | string |
Identificateur fourni par le client pour l’opération, qui sera écho dans la réponse du serveur. |
|
|
IsUpsert
|
x-ms-documentdb-is-upsert | boolean |
Si la valeur est true, le document est remplacé s’il existe un autre élément créé. |
|
|
Pré-déclencheur
|
x-ms-documentdb-pre-trigger-include | string |
Liste séparée par des virgules des noms de déclencheurs à exécuter avant l’exécution de l’opération de document. |
|
|
Post-déclencheur
|
x-ms-documentdb-post-trigger-include | string |
Liste séparée par des virgules des noms de déclencheurs à exécuter après l’exécution de l’opération de document. |
|
|
Nom du compte Azure Cosmos DB
|
cosmosDbAccountName | True | string |
Nom du compte Azure Cosmos DB (sans documents.azure.com). |
|
ID de base de données
|
databaseId | True | string |
Nom de la base de données. |
|
Collection ID
|
collectionId | True | string |
Nom de la collection. |
|
Version de l’API
|
x-ms-version | string |
Version de l’API. |
Retours
- Corps
- postDocumentsResponse
Créer ou mettre à jour un document [DÉCONSEILLÉ]
Cette action a été déconseillée. Utilisez plutôt Créer ou mettre à jour un document (V3).
Créez ou mettez à jour un document. Lors de la création d’un document dans DocumentDB, le corps doit inclure une propriété d’ID.
Paramètres
| Nom | Clé | Obligatoire | Type | Description |
|---|---|---|---|---|
|
Valeur de clé de partition
|
x-ms-documentdb-raw-partitionkey | string |
Valeur de clé de partition pour l’opération de document ou de pièce jointe demandée. |
|
|
Nombre maximal d’éléments
|
x-ms-max-item-count | number |
Entier indiquant le nombre maximal d’éléments à renvoyer par page. |
|
|
Jeton de continuation
|
x-ms-continuation | string |
Jeton de chaîne retourné pour les requêtes et les opérations de flux de lecture s’il existe d’autres résultats à lire. |
|
|
Niveau de cohérence
|
x-ms-consistency-level | string |
Il s’agit du remplacement du niveau de cohérence. Les valeurs valides sont : Strong, Bounded, Session ou Eventual (dans l’ordre le plus fort au plus faible). |
|
|
Jeton de session
|
x-ms-session-token | string |
Jeton de chaîne utilisé avec cohérence au niveau de la session. |
|
|
ID d’activité
|
x-ms-activity-id | string |
Identificateur fourni par le client pour l’opération, qui sera écho dans la réponse du serveur. |
|
|
IsUpsert
|
x-ms-documentdb-is-upsert | boolean |
Si la valeur est true, le document est remplacé s’il existe un autre élément créé. |
|
|
Pré-déclencheur
|
x-ms-documentdb-pre-trigger-include | string |
Liste séparée par des virgules des noms de déclencheurs à exécuter avant l’exécution de l’opération de document. |
|
|
Post-déclencheur
|
x-ms-documentdb-post-trigger-include | string |
Liste séparée par des virgules des noms de déclencheurs à exécuter après l’exécution de l’opération de document. |
|
|
ID de base de données
|
databaseId | True | string |
Nom de la base de données. |
|
Collection ID
|
collectionId | True | string |
Nom de la collection. |
|
Version de l’API
|
x-ms-version | string |
Version de l’API. |
Retours
- Corps
- postDocumentsResponse
Créer une procédure stockée (V2)
Créer une procédure stockée (V2).
Paramètres
| Nom | Clé | Obligatoire | Type | Description |
|---|---|---|---|---|
|
Nom du compte Azure Cosmos DB
|
cosmosDbAccountName | True | string |
Nom du compte Azure Cosmos DB (sans documents.azure.com). |
|
ID de base de données
|
databaseId | True | string |
Nom de la base de données. |
|
Collection ID
|
collectionId | True | string |
Nom de la collection. |
|
Définition de fonction
|
body | string |
Fonction qui définit la procédure stockée, par exemple « function(params){ ... } » |
|
|
pièce d'identité
|
id | string |
Nouvel ID de la procédure stockée. |
|
|
Version de l’API
|
x-ms-version | string |
Version de l’API. |
Retours
Créer une procédure stockée [DÉPRÉCIÉ]
Cette action a été déconseillée. Utilisez plutôt Créer une procédure stockée (V2).
Créez une procédure stockée.
Paramètres
| Nom | Clé | Obligatoire | Type | Description |
|---|---|---|---|---|
|
ID de base de données
|
databaseId | True | string |
Nom de la base de données. |
|
Collection ID
|
collectionId | True | string |
Nom de la collection. |
|
Définition de fonction
|
body | string |
Fonction qui définit la procédure stockée, par exemple « function(params){ ... } » |
|
|
pièce d'identité
|
id | string |
Nouvel ID de la procédure stockée. |
|
|
Version de l’API
|
x-ms-version | string |
Version de l’API. |
Retours
Exécuter une procédure stockée (V2)
Exécutez la procédure stockée dans la collection spécifiée (V2).
Paramètres
| Nom | Clé | Obligatoire | Type | Description |
|---|---|---|---|---|
|
Nom du compte Azure Cosmos DB
|
cosmosDbAccountName | True | string |
Nom du compte Azure Cosmos DB (sans documents.azure.com). |
|
ID de base de données
|
databaseId | True | string |
Nom de la base de données. |
|
Collection ID
|
collectionId | True | string |
Nom de la collection. |
|
Valeur de clé de partition
|
x-ms-documentdb-raw-partitionkey | string |
Valeur de clé de partition pour l’opération de document ou de pièce jointe demandée. |
|
|
Sproc ID
|
sprocId | True | string |
Nom de la procédure stockée. |
|
Paramètres de la procédure stockée
|
parameters | string |
Spécifiez le json valide pour les paramètres de la procédure stockée, par exemple ["param1 », « param2"]. |
|
|
Version de l’API
|
x-ms-version | string |
Version de l’API. |
Retours
- response
- ObjectWithoutType
Exécuter une procédure stockée [DÉPRÉCIÉ]
Cette action a été déconseillée. Utilisez la procédure stockée Execute (V2) à la place.
Exécutez la procédure stockée dans la collection spécifiée.
Paramètres
| Nom | Clé | Obligatoire | Type | Description |
|---|---|---|---|---|
|
ID de base de données
|
databaseId | True | string |
Nom de la base de données. |
|
Collection ID
|
collectionId | True | string |
Nom de la collection. |
|
Valeur de clé de partition
|
x-ms-documentdb-raw-partitionkey | string |
Valeur de clé de partition pour l’opération de document ou de pièce jointe demandée. |
|
|
Sproc ID
|
sprocId | True | string |
Nom de la procédure stockée. |
|
Paramètres de la procédure stockée
|
parameters | string |
Spécifiez le json valide pour les paramètres de la procédure stockée, par exemple ["param1 », « param2"]. |
|
|
Version de l’API
|
x-ms-version | string |
Version de l’API. |
Retours
- response
- ObjectWithoutType
Interroger des documents [DÉCONSEILLÉ]
Cette action a été déconseillée. Utilisez plutôt les documents de requête V5 .
Interroger des documents.
Paramètres
| Nom | Clé | Obligatoire | Type | Description |
|---|---|---|---|---|
|
Valeur de clé de partition
|
x-ms-documentdb-raw-partitionkey | string |
Valeur de clé de partition pour l’opération de document ou de pièce jointe demandée. |
|
|
Nombre maximal d’éléments
|
x-ms-max-item-count | number |
Entier indiquant le nombre maximal d’éléments à renvoyer par page. |
|
|
Jeton de continuation
|
x-ms-continuation | string |
Jeton de chaîne retourné pour les requêtes et les opérations de flux de lecture s’il existe d’autres résultats à lire. |
|
|
Activer la partition croisée
|
x-ms-documentdb-query-enablecrosspartition | boolean |
Si la collection est partitionnée, la valeur True doit être définie sur True pour autoriser l’exécution sur plusieurs partitions. |
|
|
Niveau de cohérence
|
x-ms-consistency-level | string |
Il s’agit du remplacement du niveau de cohérence. Les valeurs valides sont : Strong, Bounded, Session ou Eventual (dans l’ordre le plus fort au plus faible). |
|
|
Jeton de session
|
x-ms-session-token | string |
Jeton de chaîne utilisé avec cohérence au niveau de la session. |
|
|
ID d’activité
|
x-ms-activity-id | string |
Identificateur fourni par le client pour l’opération, qui sera écho dans la réponse du serveur. |
|
|
ID de base de données
|
databaseId | True | string |
Nom de la base de données. |
|
Collection ID
|
collectionId | True | string |
Nom de la collection. |
|
query
|
query | string |
Retours
- Corps
- queryResponse
Interroger des documents V2 [DÉCONSEILLÉ]
Cette action a été déconseillée. Utilisez plutôt les documents de requête V5 .
Interroger des documents V2.
Paramètres
| Nom | Clé | Obligatoire | Type | Description |
|---|---|---|---|---|
|
ID de base de données
|
databaseId | True | string |
Nom de la base de données. |
|
Collection ID
|
collectionId | True | string |
Nom de la collection. |
|
Texte de requête
|
QueryText | string |
Requête de syntaxe SQL sur les documents |
|
|
Valeur de clé de partition
|
partitionKey | string |
Valeur de clé de partition. |
|
|
Jeton de continuation
|
continuationToken | string |
Jeton permettant d’extraire des résultats supplémentaires de l’opération. |
Retours
Tableau de documents qui correspondent à la requête demandée et aux métadonnées associées.
- Corps
- QueryDocumentsResponse
Interroger des documents V3 [DÉCONSEILLÉ]
Cette action a été déconseillée. Utilisez plutôt les documents de requête V5 .
Interroger des documents V3.
Paramètres
| Nom | Clé | Obligatoire | Type | Description |
|---|---|---|---|---|
|
ID de base de données
|
databaseId | True | string |
Nom de la base de données. |
|
Collection ID
|
collectionId | True | string |
Nom de la collection. |
|
Requête de syntaxe SQL
|
queryText | True | string |
Requête SQL. |
|
Valeur de clé de partition
|
partitionKey | string |
Si elles sont vides, toutes les partitions sont utilisées pour rechercher des documents. |
|
|
Nombre maximal d’éléments
|
maxItemCount | integer |
Entier indiquant le nombre maximal d’éléments à renvoyer par page. |
|
|
Jeton de continuation
|
continuationToken | string |
Jeton permettant d’extraire des résultats supplémentaires. |
|
|
Activer la partition croisée
|
enableCrossPartition | boolean |
Indique si l’utilisateur est activé pour envoyer plusieurs requêtes pour exécuter la requête. |
|
|
Niveau de cohérence
|
consistencyLevel | string |
Niveau de cohérence requis pour l’opération de flux (flux de requête/lecture). |
|
|
Jeton de session
|
sessionToken | string |
Jeton de session à utiliser avec cohérence de session. |
Retours
Tableau de documents qui correspondent à la requête demandée et aux métadonnées associées.
- Corps
- DocumentsCollection
Interroger des documents V4 [DÉCONSEILLÉ]
Cette action a été déconseillée. Utilisez plutôt les documents de requête V5 .
Interroger des documents V4.
Paramètres
| Nom | Clé | Obligatoire | Type | Description |
|---|---|---|---|---|
|
ID de base de données
|
databaseId | True | string |
Nom de la base de données. |
|
ID de conteneur
|
containerId | True | string |
nom du conteneur. |
|
Requête de syntaxe SQL
|
queryText | string |
Requête SQL. S’il est vide, retourne tous les documents. |
|
|
Valeur de clé de partition
|
partitionKey | string |
Si elles sont vides, toutes les partitions sont utilisées pour rechercher des documents. |
|
|
Nombre maximal d’éléments
|
maxItemCount | integer |
Entier indiquant le nombre maximal d’éléments à renvoyer par page. |
|
|
Jeton de continuation
|
continuationToken | string |
Jeton permettant d’extraire des résultats supplémentaires. |
|
|
Niveau de cohérence
|
consistencyLevel | string |
Niveau de cohérence requis pour l’opération de flux (flux de requête/lecture). |
|
|
Jeton de session
|
sessionToken | string |
Jeton de session à utiliser avec cohérence de session. |
Retours
Tableau de documents qui correspondent à la requête demandée et aux métadonnées associées.
- Corps
- DocumentsCollection
Interroger des documents V5
Interroger des documents (V5).
Paramètres
| Nom | Clé | Obligatoire | Type | Description |
|---|---|---|---|---|
|
Nom du compte Azure Cosmos DB
|
cosmosDbAccountName | True | string |
Nom du compte Azure Cosmos DB (sans documents.azure.com). |
|
ID de base de données
|
databaseId | True | string |
Nom de la base de données. |
|
ID de conteneur
|
containerId | True | string |
nom du conteneur. |
|
Requête de syntaxe SQL
|
queryText | string |
Requête SQL. S’il est vide, retourne tous les documents. |
|
|
Valeur de clé de partition
|
partitionKey | string |
La valeur doit être fournie en fonction de son type (« string », 42, 0,5). Si elles sont vides, toutes les partitions sont utilisées pour rechercher des documents. |
|
|
Nombre maximal d’éléments
|
maxItemCount | integer |
Entier indiquant le nombre maximal d’éléments à renvoyer par page. |
|
|
Jeton de continuation
|
continuationToken | string |
Jeton permettant d’extraire des résultats supplémentaires. |
|
|
Niveau de cohérence
|
consistencyLevel | string |
Niveau de cohérence requis pour l’opération de flux (flux de requête/lecture). |
|
|
Jeton de session
|
sessionToken | string |
Jeton de session à utiliser avec cohérence de session. |
Retours
Tableau de documents qui correspondent à la requête demandée et aux métadonnées associées.
- Corps
- DocumentsCollection
Obtenir des procédures stockées (V2)
Obtenir les procédures stockées dans la collection spécifiée (V2).
Paramètres
| Nom | Clé | Obligatoire | Type | Description |
|---|---|---|---|---|
|
Nom du compte Azure Cosmos DB
|
cosmosDbAccountName | True | string |
Nom du compte Azure Cosmos DB (sans documents.azure.com). |
|
ID de base de données
|
databaseId | True | string |
Nom de la base de données. |
|
Collection ID
|
collectionId | True | string |
Nom de la collection. |
|
Version de l’API
|
x-ms-version | string |
Version de l’API. |
Retours
Obtenir des procédures stockées [DÉCONSEILLÉE]
Cette action a été déconseillée. Utilisez les procédures stockées Get (V2) à la place.
Obtenir des procédures stockées dans la collection spécifiée.
Paramètres
| Nom | Clé | Obligatoire | Type | Description |
|---|---|---|---|---|
|
ID de base de données
|
databaseId | True | string |
Nom de la base de données. |
|
Collection ID
|
collectionId | True | string |
Nom de la collection. |
|
Version de l’API
|
x-ms-version | string |
Version de l’API. |
Retours
Obtenir tous les documents (V3)
Obtenir tous les documents (V3).
Paramètres
| Nom | Clé | Obligatoire | Type | Description |
|---|---|---|---|---|
|
Valeur de clé de partition
|
x-ms-documentdb-raw-partitionkey | string |
Valeur de clé de partition pour l’opération de document ou de pièce jointe demandée. |
|
|
Nombre maximal d’éléments
|
x-ms-max-item-count | number |
Entier indiquant le nombre maximal d’éléments à renvoyer par page. |
|
|
Jeton de continuation
|
x-ms-continuation | string |
Jeton de chaîne retourné pour les requêtes et les opérations de flux de lecture s’il existe d’autres résultats à lire. |
|
|
Niveau de cohérence
|
x-ms-consistency-level | string |
Il s’agit du remplacement du niveau de cohérence. Les valeurs valides sont : Strong, Bounded, Session ou Eventual (dans l’ordre le plus fort au plus faible). |
|
|
Jeton de session
|
x-ms-session-token | string |
Jeton de chaîne utilisé avec cohérence au niveau de la session. |
|
|
ID d’activité
|
x-ms-activity-id | string |
Identificateur fourni par le client pour l’opération, qui sera écho dans la réponse du serveur. |
|
|
Nom du compte Azure Cosmos DB
|
cosmosDbAccountName | True | string |
Nom du compte Azure Cosmos DB (sans documents.azure.com). |
|
ID de base de données
|
databaseId | True | string |
Nom de la base de données. |
|
Collection ID
|
collectionId | True | string |
Nom de la collection. |
|
Version de l’API
|
x-ms-version | string |
Version de l’API. |
Retours
- Corps
- getDocumentsResponse
Obtenir tous les documents [DÉCONSEILLÉ]
Cette action a été déconseillée. Utilisez plutôt Obtenir tous les documents (V3).
Obtenez tous les documents.
Paramètres
| Nom | Clé | Obligatoire | Type | Description |
|---|---|---|---|---|
|
Valeur de clé de partition
|
x-ms-documentdb-raw-partitionkey | string |
Valeur de clé de partition pour l’opération de document ou de pièce jointe demandée. |
|
|
Nombre maximal d’éléments
|
x-ms-max-item-count | number |
Entier indiquant le nombre maximal d’éléments à renvoyer par page. |
|
|
Jeton de continuation
|
x-ms-continuation | string |
Jeton de chaîne retourné pour les requêtes et les opérations de flux de lecture s’il existe d’autres résultats à lire. |
|
|
Niveau de cohérence
|
x-ms-consistency-level | string |
Il s’agit du remplacement du niveau de cohérence. Les valeurs valides sont : Strong, Bounded, Session ou Eventual (dans l’ordre le plus fort au plus faible). |
|
|
Jeton de session
|
x-ms-session-token | string |
Jeton de chaîne utilisé avec cohérence au niveau de la session. |
|
|
ID d’activité
|
x-ms-activity-id | string |
Identificateur fourni par le client pour l’opération, qui sera écho dans la réponse du serveur. |
|
|
ID de base de données
|
databaseId | True | string |
Nom de la base de données. |
|
Collection ID
|
collectionId | True | string |
Nom de la collection. |
|
Version de l’API
|
x-ms-version | string |
Version de l’API. |
Retours
- Corps
- getDocumentsResponse
Obtenir tous les documents V2 [DÉCONSEILLÉ]
Cette action a été déconseillée. Utilisez plutôt Obtenir tous les documents (V3).
Obtenez tous les documents V2.
Paramètres
| Nom | Clé | Obligatoire | Type | Description |
|---|---|---|---|---|
|
ID de base de données
|
databaseId | True | string |
Nom de la base de données. |
|
Collection ID
|
collectionId | True | string |
Nom de la collection. |
|
Valeur de clé de partition
|
partitionKey | string |
Si elles sont vides, toutes les partitions sont utilisées pour rechercher des documents. |
|
|
Nombre maximal d’éléments
|
maxItemCount | integer |
Entier indiquant le nombre maximal d’éléments à renvoyer par page. |
|
|
Jeton de continuation
|
continuationToken | string |
Jeton permettant d’extraire des résultats supplémentaires. |
|
|
Niveau de cohérence
|
consistencyLevel | string |
Niveau de cohérence requis pour l’opération de flux (flux de requête/lecture). |
|
|
Jeton de session
|
sessionToken | string |
Jeton de session à utiliser avec cohérence de session. |
Retours
Tableau de documents qui correspondent à la requête demandée et aux métadonnées associées.
- Corps
- DocumentsCollection
Obtenir un document (V2)
Obtenir un document (V2).
Paramètres
| Nom | Clé | Obligatoire | Type | Description |
|---|---|---|---|---|
|
Valeur de clé de partition
|
x-ms-documentdb-raw-partitionkey | string |
Valeur de clé de partition pour l’opération de document ou de pièce jointe demandée. |
|
|
Nombre maximal d’éléments
|
x-ms-max-item-count | number |
Entier indiquant le nombre maximal d’éléments à renvoyer par page. |
|
|
Jeton de continuation
|
x-ms-continuation | string |
Jeton de chaîne retourné pour les requêtes et les opérations de flux de lecture s’il existe d’autres résultats à lire. |
|
|
Niveau de cohérence
|
x-ms-consistency-level | string |
Il s’agit du remplacement du niveau de cohérence. Les valeurs valides sont : Strong, Bounded, Session ou Eventual (dans l’ordre le plus fort au plus faible). |
|
|
Jeton de session
|
x-ms-session-token | string |
Jeton de chaîne utilisé avec cohérence au niveau de la session. |
|
|
ID d’activité
|
x-ms-activity-id | string |
Identificateur fourni par le client pour l’opération, qui sera écho dans la réponse du serveur. |
|
|
Nom du compte Azure Cosmos DB
|
cosmosDbAccountName | True | string |
Nom du compte Azure Cosmos DB (sans documents.azure.com). |
|
ID de base de données
|
databaseId | True | string |
Nom de la base de données. |
|
Collection ID
|
collectionId | True | string |
Nom de la collection. |
|
Document ID
|
documentId | True | string |
Identificateur du document. |
|
Version de l’API
|
x-ms-version | string |
Version de l’API. |
Retours
- response
- object
Obtenir un document [DÉCONSEILLÉ]
Cette action a été déconseillée. Utilisez plutôt Obtenir un document (V2).
Obtenir un document.
Paramètres
| Nom | Clé | Obligatoire | Type | Description |
|---|---|---|---|---|
|
Valeur de clé de partition
|
x-ms-documentdb-raw-partitionkey | string |
Valeur de clé de partition pour l’opération de document ou de pièce jointe demandée. |
|
|
Nombre maximal d’éléments
|
x-ms-max-item-count | number |
Entier indiquant le nombre maximal d’éléments à renvoyer par page. |
|
|
Jeton de continuation
|
x-ms-continuation | string |
Jeton de chaîne retourné pour les requêtes et les opérations de flux de lecture s’il existe d’autres résultats à lire. |
|
|
Niveau de cohérence
|
x-ms-consistency-level | string |
Il s’agit du remplacement du niveau de cohérence. Les valeurs valides sont : Strong, Bounded, Session ou Eventual (dans l’ordre le plus fort au plus faible). |
|
|
Jeton de session
|
x-ms-session-token | string |
Jeton de chaîne utilisé avec cohérence au niveau de la session. |
|
|
ID d’activité
|
x-ms-activity-id | string |
Identificateur fourni par le client pour l’opération, qui sera écho dans la réponse du serveur. |
|
|
ID de base de données
|
databaseId | True | string |
Nom de la base de données. |
|
Collection ID
|
collectionId | True | string |
Nom de la collection. |
|
Document ID
|
documentId | True | string |
Identificateur du document. |
|
Version de l’API
|
x-ms-version | string |
Version de l’API. |
Retours
- response
- object
Remplacer la procédure stockée (V2)
Remplacez la procédure stockée (V2).
Paramètres
| Nom | Clé | Obligatoire | Type | Description |
|---|---|---|---|---|
|
Nom du compte Azure Cosmos DB
|
cosmosDbAccountName | True | string |
Nom du compte Azure Cosmos DB (sans documents.azure.com). |
|
ID de base de données
|
databaseId | True | string |
Nom de la base de données. |
|
Collection ID
|
collectionId | True | string |
Nom de la collection. |
|
Sproc ID
|
sprocId | True | string |
Nom de la procédure stockée. |
|
Définition de fonction
|
body | string |
Fonction qui définit la procédure stockée, par exemple « function(params){ ... } » |
|
|
pièce d'identité
|
id | string |
ID de la procédure stockée existante. |
|
|
Version de l’API
|
x-ms-version | string |
Version de l’API. |
Retours
Remplacer la procédure stockée [DÉPRÉCIÉ]
Cette action a été déconseillée. Utilisez plutôt remplacer la procédure stockée (V2).
Remplacez la procédure stockée.
Paramètres
| Nom | Clé | Obligatoire | Type | Description |
|---|---|---|---|---|
|
ID de base de données
|
databaseId | True | string |
Nom de la base de données. |
|
Collection ID
|
collectionId | True | string |
Nom de la collection. |
|
Sproc ID
|
sprocId | True | string |
Nom de la procédure stockée. |
|
Définition de fonction
|
body | string |
Fonction qui définit la procédure stockée, par exemple « function(params){ ... } » |
|
|
pièce d'identité
|
id | string |
ID de la procédure stockée existante. |
|
|
Version de l’API
|
x-ms-version | string |
Version de l’API. |
Retours
Remplacer un document (V2)
Remplacez un document (V2).
Paramètres
| Nom | Clé | Obligatoire | Type | Description |
|---|---|---|---|---|
|
Valeur de clé de partition
|
x-ms-documentdb-raw-partitionkey | string |
Valeur de clé de partition pour l’opération de document ou de pièce jointe demandée. |
|
|
Nombre maximal d’éléments
|
x-ms-max-item-count | number |
Entier indiquant le nombre maximal d’éléments à renvoyer par page. |
|
|
Jeton de continuation
|
x-ms-continuation | string |
Jeton de chaîne retourné pour les requêtes et les opérations de flux de lecture s’il existe d’autres résultats à lire. |
|
|
Niveau de cohérence
|
x-ms-consistency-level | string |
Il s’agit du remplacement du niveau de cohérence. Les valeurs valides sont : Strong, Bounded, Session ou Eventual (dans l’ordre le plus fort au plus faible). |
|
|
Jeton de session
|
x-ms-session-token | string |
Jeton de chaîne utilisé avec cohérence au niveau de la session. |
|
|
ID d’activité
|
x-ms-activity-id | string |
Identificateur fourni par le client pour l’opération, qui sera écho dans la réponse du serveur. |
|
|
Pré-déclencheur
|
x-ms-documentdb-pre-trigger-include | string |
Liste séparée par des virgules des noms de déclencheurs à exécuter avant l’exécution de l’opération de document. |
|
|
Post-déclencheur
|
x-ms-documentdb-post-trigger-include | string |
Liste séparée par des virgules des noms de déclencheurs à exécuter après l’exécution de l’opération de document. |
|
|
Nom du compte Azure Cosmos DB
|
cosmosDbAccountName | True | string |
Nom du compte Azure Cosmos DB (sans documents.azure.com). |
|
ID de base de données
|
databaseId | True | string |
Nom de la base de données. |
|
Collection ID
|
collectionId | True | string |
Nom de la collection. |
|
Document ID
|
documentId | True | string |
Identificateur du document. |
|
Version de l’API
|
x-ms-version | string |
Version de l’API. |
Retours
- Corps
- putDocumentResponse
Remplacer un document [DÉPRÉCIÉ]
Cette action a été déconseillée. Utilisez à la place Remplacer un document (V2).
Remplacez un document.
Paramètres
| Nom | Clé | Obligatoire | Type | Description |
|---|---|---|---|---|
|
Valeur de clé de partition
|
x-ms-documentdb-raw-partitionkey | string |
Valeur de clé de partition pour l’opération de document ou de pièce jointe demandée. |
|
|
Nombre maximal d’éléments
|
x-ms-max-item-count | number |
Entier indiquant le nombre maximal d’éléments à renvoyer par page. |
|
|
Jeton de continuation
|
x-ms-continuation | string |
Jeton de chaîne retourné pour les requêtes et les opérations de flux de lecture s’il existe d’autres résultats à lire. |
|
|
Niveau de cohérence
|
x-ms-consistency-level | string |
Il s’agit du remplacement du niveau de cohérence. Les valeurs valides sont : Strong, Bounded, Session ou Eventual (dans l’ordre le plus fort au plus faible). |
|
|
Jeton de session
|
x-ms-session-token | string |
Jeton de chaîne utilisé avec cohérence au niveau de la session. |
|
|
ID d’activité
|
x-ms-activity-id | string |
Identificateur fourni par le client pour l’opération, qui sera écho dans la réponse du serveur. |
|
|
Pré-déclencheur
|
x-ms-documentdb-pre-trigger-include | string |
Liste séparée par des virgules des noms de déclencheurs à exécuter avant l’exécution de l’opération de document. |
|
|
Post-déclencheur
|
x-ms-documentdb-post-trigger-include | string |
Liste séparée par des virgules des noms de déclencheurs à exécuter après l’exécution de l’opération de document. |
|
|
ID de base de données
|
databaseId | True | string |
Nom de la base de données. |
|
Collection ID
|
collectionId | True | string |
Nom de la collection. |
|
Document ID
|
documentId | True | string |
Identificateur du document. |
|
Version de l’API
|
x-ms-version | string |
Version de l’API. |
Retours
- Corps
- putDocumentResponse
Supprimer la procédure stockée (V2)
Supprimer la procédure stockée (V2).
Paramètres
| Nom | Clé | Obligatoire | Type | Description |
|---|---|---|---|---|
|
Nom du compte Azure Cosmos DB
|
cosmosDbAccountName | True | string |
Nom du compte Azure Cosmos DB (sans documents.azure.com). |
|
ID de base de données
|
databaseId | True | string |
Nom de la base de données. |
|
Collection ID
|
collectionId | True | string |
Nom de la collection. |
|
Sproc ID
|
sprocId | True | string |
Nom de la procédure stockée. |
|
Version de l’API
|
x-ms-version | string |
Version de l’API. |
Retours
- response
- string
Supprimer la procédure stockée [DÉPRÉCIÉ]
Cette action a été déconseillée. Utilisez la procédure stockée Delete (V2) à la place.
Supprimer la procédure stockée.
Paramètres
| Nom | Clé | Obligatoire | Type | Description |
|---|---|---|---|---|
|
ID de base de données
|
databaseId | True | string |
Nom de la base de données. |
|
Collection ID
|
collectionId | True | string |
Nom de la collection. |
|
Sproc ID
|
sprocId | True | string |
Nom de la procédure stockée. |
|
Version de l’API
|
x-ms-version | string |
Version de l’API. |
Retours
- response
- string
Supprimer un document (V2)
Supprimez un document (V2).
Paramètres
| Nom | Clé | Obligatoire | Type | Description |
|---|---|---|---|---|
|
Valeur de clé de partition
|
x-ms-documentdb-raw-partitionkey | string |
Valeur de clé de partition pour l’opération de document ou de pièce jointe demandée. |
|
|
Nombre maximal d’éléments
|
x-ms-max-item-count | number |
Entier indiquant le nombre maximal d’éléments à renvoyer par page. |
|
|
Jeton de continuation
|
x-ms-continuation | string |
Jeton de chaîne retourné pour les requêtes et les opérations de flux de lecture s’il existe d’autres résultats à lire. |
|
|
Niveau de cohérence
|
x-ms-consistency-level | string |
Il s’agit du remplacement du niveau de cohérence. Les valeurs valides sont : Strong, Bounded, Session ou Eventual (dans l’ordre le plus fort au plus faible). |
|
|
Jeton de session
|
x-ms-session-token | string |
Jeton de chaîne utilisé avec cohérence au niveau de la session. |
|
|
ID d’activité
|
x-ms-activity-id | string |
Identificateur fourni par le client pour l’opération, qui sera écho dans la réponse du serveur. |
|
|
Pré-déclencheur
|
x-ms-documentdb-pre-trigger-include | string |
Liste séparée par des virgules des noms de déclencheurs à exécuter avant l’exécution de l’opération de document. |
|
|
Post-déclencheur
|
x-ms-documentdb-post-trigger-include | string |
Liste séparée par des virgules des noms de déclencheurs à exécuter après l’exécution de l’opération de document. |
|
|
Nom du compte Azure Cosmos DB
|
cosmosDbAccountName | True | string |
Nom du compte Azure Cosmos DB (sans documents.azure.com). |
|
ID de base de données
|
databaseId | True | string |
Nom de la base de données. |
|
Collection ID
|
collectionId | True | string |
Nom de la collection. |
|
Document ID
|
documentId | True | string |
Identificateur du document. |
|
Version de l’API
|
x-ms-version | string |
Version de l’API. |
Supprimer un document [DÉCONSEILLÉ]
Cette action a été déconseillée. Utilisez plutôt Supprimer un document (V2).
Supprimez un document.
Paramètres
| Nom | Clé | Obligatoire | Type | Description |
|---|---|---|---|---|
|
Valeur de clé de partition
|
x-ms-documentdb-raw-partitionkey | string |
Valeur de clé de partition pour l’opération de document ou de pièce jointe demandée. |
|
|
Nombre maximal d’éléments
|
x-ms-max-item-count | number |
Entier indiquant le nombre maximal d’éléments à renvoyer par page. |
|
|
Jeton de continuation
|
x-ms-continuation | string |
Jeton de chaîne retourné pour les requêtes et les opérations de flux de lecture s’il existe d’autres résultats à lire. |
|
|
Niveau de cohérence
|
x-ms-consistency-level | string |
Il s’agit du remplacement du niveau de cohérence. Les valeurs valides sont : Strong, Bounded, Session ou Eventual (dans l’ordre le plus fort au plus faible). |
|
|
Jeton de session
|
x-ms-session-token | string |
Jeton de chaîne utilisé avec cohérence au niveau de la session. |
|
|
ID d’activité
|
x-ms-activity-id | string |
Identificateur fourni par le client pour l’opération, qui sera écho dans la réponse du serveur. |
|
|
Pré-déclencheur
|
x-ms-documentdb-pre-trigger-include | string |
Liste séparée par des virgules des noms de déclencheurs à exécuter avant l’exécution de l’opération de document. |
|
|
Post-déclencheur
|
x-ms-documentdb-post-trigger-include | string |
Liste séparée par des virgules des noms de déclencheurs à exécuter après l’exécution de l’opération de document. |
|
|
ID de base de données
|
databaseId | True | string |
Nom de la base de données. |
|
Collection ID
|
collectionId | True | string |
Nom de la collection. |
|
Document ID
|
documentId | True | string |
Identificateur du document. |
|
Version de l’API
|
x-ms-version | string |
Version de l’API. |
Définitions
QueryDocumentsResponse
Tableau de documents qui correspondent à la requête demandée et aux métadonnées associées.
| Nom | Chemin d’accès | Type | Description |
|---|---|---|---|
|
Documents
|
Documents | array of ObjectWithoutType |
Tableau de documents qui correspondent à la requête. |
|
Nombre de documents
|
_count | integer |
Nombre de documents. |
|
ID d’activité
|
ActivityId | string |
ID d’activité du service Azure Cosmos DB. |
DocumentsCollection
Tableau de documents qui correspondent à la requête demandée et aux métadonnées associées.
| Nom | Chemin d’accès | Type | Description |
|---|---|---|---|
|
Documents
|
value | array of ObjectWithoutType | |
|
Jeton de continuation
|
ContinuationToken | string | |
|
Nombre de documents
|
Count | integer | |
|
Frais de demande
|
RequestCharge | double | |
|
Jeton de session
|
SessionToken | string | |
|
ID d’activité
|
ActivityId | string |
postDocumentsResponse
| Nom | Chemin d’accès | Type | Description |
|---|---|---|---|
|
_rid
|
_rid | string | |
|
_ts
|
_ts | integer | |
|
_même
|
_self | string | |
|
_etag
|
_etag | string | |
|
_Pièces jointes
|
_attachments | string | |
|
pièce d'identité
|
id | string |
putDocumentResponse
| Nom | Chemin d’accès | Type | Description |
|---|---|---|---|
|
_rid
|
_rid | string | |
|
pièce d'identité
|
id | string |
getDocumentsResponse
| Nom | Chemin d’accès | Type | Description |
|---|---|---|---|
|
_rid
|
_rid | string | |
|
Documents
|
Documents | array of object |
queryResponse
| Nom | Chemin d’accès | Type | Description |
|---|---|---|---|
|
_rid
|
_rid | string | |
|
_compter
|
_count | number | |
|
Documents
|
Documents | array of |
getStoredProceduresResponse
| Nom | Chemin d’accès | Type | Description |
|---|---|---|---|
|
_compter
|
_count | integer |
_compter |
|
_rid
|
_rid | string |
_rid |
|
Procédures stockées
|
StoredProcedures | array of object |
Procédures stockées |
|
_etag
|
StoredProcedures._etag | string |
_etag |
|
_rid
|
StoredProcedures._rid | string |
_rid |
|
_même
|
StoredProcedures._self | string |
_même |
|
_ts
|
StoredProcedures._ts | integer |
_ts |
|
body
|
StoredProcedures.body | string |
body |
|
pièce d'identité
|
StoredProcedures.id | string |
pièce d'identité |
createStoredProcedureResponse
| Nom | Chemin d’accès | Type | Description |
|---|---|---|---|
|
_etag
|
_etag | string |
_etag |
|
_rid
|
_rid | string |
_rid |
|
_même
|
_self | string |
_même |
|
_ts
|
_ts | integer |
_ts |
|
body
|
body | string |
body |
|
pièce d'identité
|
id | string |
pièce d'identité |
ObjectWithoutType
ficelle
Il s’agit du type de données de base « string ».
objet
Il s’agit du type 'object'.