Intestazioni comuni di richiesta REST di Azure Cosmos DB
Le intestazioni di richiesta seguenti sono comuni a tutte le attività che è possibile eseguire con l'API SQL:
| Intestazione | Obbligatoria | Tipo | Descrizione |
|---|---|---|---|
| Autorizzazione | Necessario | string | Token di autorizzazione per la richiesta. Per altre informazioni sulla generazione di un token di autorizzazione valido, vedere Controllo di accesso nelle risorse di Cosmos DB |
| Content-Type | Obbligatorio (in PUT, PATCH e POST) | string | Per le operazioni post sulle query, deve essere application/query+json. Per le operazioni PATCH, deve essere application/json_patch+json. Per gli allegati, deve essere impostato sul tipo Mime dell'allegato. Per altre informazioni sui tipi Mime, vedere Creare un allegato Per tutte le altre attività, deve essere application/json. |
| If-Match | Facoltativo (applicabile solo in PUT e DELETE) | string | Usato per rendere condizionale l'operazione per la concorrenza ottimistica. Il valore deve essere il valore etag della risorsa. |
| If-None-Match | Facoltativo (applicabile solo in GET) | string | Rende condizionale l'operazione per l'esecuzione solo se la risorsa è stata modificata. Il valore deve essere l'etag della risorsa. |
| If-Modified-Since | Facoltativo (applicabile solo in GET) | Data | Restituisce l'etag della risorsa modificata dopo la data specificata nel formato RFC 1123. Ignorato quando si specifica If-None-Match |
| User-Agent | Facoltativo | String | Stringa che specifica l'agente utente del client che esegue la richiesta. Il formato consigliato è {user agent name}/{version}. Ad esempio, l'SDK .NET dell'API SQL ufficiale imposta la stringa User-Agent su Microsoft.Document.Client/1.0.0.0. Un agente utente personalizzato può essere simile a ContosoMarketingApp/1.0.0. |
| x-ms-activity-id | Facoltativo | String | Identificatore fornito dal client per l'operazione, che viene restituito nella risposta del server. Il valore consigliato è un identificatore univoco. |
| x-ms-consistency-level | Facoltativo | String | Override del livello di coerenza per le opzioni di lettura su documenti e allegati. I valori validi sono: Strong, Bounded, Session o Eventual (in ordine di più forte al più debole). L'override deve essere uguale o più debole del livello di coerenza configurato dell'account. |
| x-ms-continuation | Facoltativo | String | Token stringa restituito per le query e le operazioni di lettura-feed se sono presenti altri risultati da leggere. I client possono recuperare la pagina successiva dei risultati inviando di nuovo la richiesta con l'intestazione della richiesta x-ms-continuation impostata su questo valore. |
| x-ms-date | Necessario | Data | Data della richiesta per formato di data RFC 1123 espressa nell'ora universale coordinata, ad esempio Venerdì 08 Apr 2015 03:52:31 GMT. |
| x-ms-max-item-count | Facoltativo | Number | Intero che indica il numero massimo di elementi da restituire per pagina. È possibile specificare un valore x-ms-max-item-count pari a -1 per consentire al servizio di determinare il numero di elementi ottimale. Questo è il valore di configurazione consigliato per x-ms-max-item-count |
| x-ms-documentdb-partitionkey | Facoltativo | Array | Valore della chiave di partizione per il documento o l'operazione di allegato richiesta. Obbligatorio per le operazioni su documenti e allegati quando la definizione della raccolta include una definizione di chiave di partizione. Questo valore viene usato per definire l'ambito della query ai documenti che corrispondono ai criteri della chiave di partizione. Per impostazione predefinita, si tratta di una singola query di partizione. Supportato nelle versioni API 2015-12-16 e successive. Attualmente, l'API SQL supporta una singola chiave di partizione, quindi si tratta di una matrice contenente un solo valore. |
| x-ms-documentdb-query-enablecrosspartition | Facoltativo | Boolean | Quando questa intestazione è impostata su true e se la query non ha una chiave di partizione, Azure Cosmos DB visualizza la query tra le partizioni. Il fan-out viene eseguito tramite l'esecuzione di singole query per tutte le partizioni. Per leggere i risultati della query, le applicazioni client devono utilizzare i risultati di FeedResponse e controllare la proprietà ContinuationToken. Per leggere tutti i risultati, proseguire l'iterazione sui dati fino a quando ContinuationToken non diventa null. |
| x-ms-session-token | Obbligatorio (solo per la coerenza della sessione) | string | Token stringa usato con coerenza a livello di sessione. Per ulteriori informazioni, vedere Uso dei livelli di coerenza in Cosmos DB |
| x-ms-version | Necessario | string | Versione del servizio REST di Cosmos DB. Per un elenco delle versioni api supportate, vedere Informazioni di riferimento sulle API REST di Azure Cosmos DB |
| A-IM | Facoltativo | String | Indica una richiesta del feed di modifiche . Deve essere impostato su "Feed incrementale" o omesso in caso contrario. |
| x-ms-documentdb-partitionkeyrangeid | Facoltativo | Number | Usato nelle richieste del feed di modifiche . L'ID dell'intervallo di chiavi di partizione per la lettura dei dati. |
| x-ms-cosmos-allow-tentative-writes | Facoltativo | Boolean | Quando questa intestazione è impostata su true per gli account Azure Cosmos configurati con più posizioni di scrittura, Azure Cosmos DB consentirà le scritture in tutte le posizioni. Le richieste di scrittura con il valore di questa intestazione impostata su false (o se l'intestazione è assente) avranno esito negativo con il codice di stato della risposta 403 con il messaggio di errore "Le scritture non sono consentite nell'area". |
Vedere anche