Remarque
L’accès à cette page nécessite une autorisation. Vous pouvez essayer de vous connecter ou de modifier des répertoires.
L’accès à cette page nécessite une autorisation. Vous pouvez essayer de modifier des répertoires.
Les en-têtes de requête suivants sont communs à toutes les tâches que vous pouvez effectuer avec l’API SQL :
| En-tête | Obligatoire | Type | Description |
|---|---|---|---|
| d’autorisation | Obligatoire | Corde | Jeton d’autorisation pour la demande. Pour plus d’informations sur la génération d’un jeton d’autorisation valide, consultez Contrôle d’accès sur les ressources Cosmos DB |
| de type de contenu | Obligatoire (sur PUT, PATCH et POST) | Corde | Pour post sur les opérations de requête, il doit être application/query+json. Pour les opérations PATCH, il doit être application/json_patch+json. Pour les pièces jointes, doit être définie sur le type Mime de la pièce jointe. Pour plus d’informations sur les types Mime, consultez Créer une pièce jointe Pour toutes les autres tâches, doit être application/json. |
| if-Match | Facultatif (applicable uniquement sur PUT et DELETE) | Corde | Utilisé pour rendre l’opération conditionnelle pour l’accès concurrentiel optimiste. La valeur doit être la valeur etag de la ressource. |
| If-None-Match | Facultatif (applicable uniquement sur GET) | Corde | Rend l’opération conditionnelle à s’exécuter uniquement si la ressource a changé. La valeur doit être l’etag de la ressource. |
| si modifié depuis | Facultatif (applicable uniquement sur GET) | Date | Retourne l’etag de ressource modifiée après la date spécifiée au format RFC 1123. Ignoré lorsque If-None-Match est spécifié |
| de l’agent utilisateur | Optionnel | Corde | Chaîne qui spécifie l’agent utilisateur client effectuant la requête. Le format recommandé est {user agent name}/{version}. Par exemple, le Kit de développement logiciel (SDK) .NET de l’API SQL officielle définit la chaîne User-Agent sur Microsoft.Document.Client/1.0.0.0. Un agent utilisateur personnalisé peut être quelque chose comme ContosoMarketingApp/1.0.0. |
| x-ms-activity-id | Optionnel | Corde | Identificateur fourni par le client pour l’opération, qui est écho dans la réponse du serveur. La valeur recommandée est un identificateur unique. |
| de niveau de cohérence x-ms | Optionnel | Corde | Remplacement du niveau de cohérence pour les options de lecture par rapport aux documents et pièces jointes. Les valeurs valides sont : Strong, Bounded, Session ou Eventual (dans l’ordre le plus fort au plus faible). Le remplacement doit être identique ou plus faible que le niveau de cohérence configuré du compte. |
| x-ms-continuation | Optionnel | Corde | 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. Les clients peuvent récupérer la page suivante des résultats en renvoyant la requête avec l’en-tête de requête x-ms-continuation défini sur cette valeur. |
| x-ms-date | Obligatoire | Date | Date de la demande par format de date RFC 1123 exprimée en heure universelle coordonnée, par exemple, 08 avril 2015 03:52:31 GMT. |
| x-ms-max-item-count | Optionnel | Nombre | Entier indiquant le nombre maximal d’éléments à renvoyer par page. Un nombre x-ms-max-item de -1 peut être spécifié pour permettre au service de déterminer le nombre d’éléments optimal. Il s’agit de la valeur de configuration recommandée pour x-ms-max-item-count |
| x-ms-documentdb-partitionkey | Optionnel | Tableau | Valeur de clé de partition pour l’opération de document ou de pièce jointe demandée. Obligatoire pour les opérations sur les documents et les pièces jointes lorsque la définition de collection inclut une définition de clé de partition. Cette valeur est utilisée pour étendre votre requête à des documents qui correspondent aux critères de clé de partition. Par conception, il s’agit d’une requête de partition unique. Prise en charge dans les versions d’API 2015-12-16 et ultérieures. Actuellement, l’API SQL prend en charge une clé de partition unique. Il s’agit donc d’un tableau contenant une seule valeur. |
| x-ms-documentdb-query-enablecrosspartition | Optionnel | Booléen | Lorsque cet en-tête est défini sur true et si votre requête n’a pas de clé de partition, Azure Cosmos DB analyse la requête entre les partitions. Le ventilateur est effectué en émettant des requêtes individuelles à toutes les partitions. Pour lire les résultats de la requête, les applications clientes doivent consommer les résultats de FeedResponse et rechercher la propriété ContinuationToken. Pour lire tous les résultats, continuez à itérer sur les données jusqu’à ce que continuationToken soit null. |
| x-ms-session-token | Obligatoire (pour la cohérence de session uniquement) | Corde | Jeton de chaîne utilisé avec cohérence au niveau de la session. Pour plus d’informations, consultez Utilisation des niveaux de cohérence dans Cosmos DB |
| x-ms-version | Obligatoire | Corde | Version du service REST Cosmos DB. Pour obtenir la liste des versions d’API prises en charge, consultez informations de référence sur l’API REST Azure Cosmos DB |
| A-IM | Optionnel | Corde | Indique une demande de flux de modification . Doit être défini sur « Flux incrémentiel » ou omis dans le cas contraire. |
| x-ms-documentdb-partitionkeyrangeid | Optionnel | Nombre | Utilisé dans demandes de flux de modification. ID de plage de clés de partition pour la lecture des données. |
| x-ms-cosmos-allow-tentative-writes | Optionnel | Booléen | Lorsque cet en-tête est défini sur true pour les comptes Azure Cosmos configurés avec plusieurs emplacements d’écriture, Azure Cosmos DB autorise les écritures dans tous les emplacements. Les demandes d’écriture avec la valeur de cet en-tête définie sur false (ou si l’en-tête est absent) échouent avec le code d’état de la réponse 403 avec le message d’erreur « Les écritures ne sont pas autorisées dans la région ». |
Voir également