Cabeçalhos de pedido REST do Azure Cosmos DB comuns
Os cabeçalhos de pedido seguintes são comuns a todas as tarefas que pode fazer com a API SQL:
| Cabeçalho | Necessário | Tipo | Description |
|---|---|---|---|
| Autorização | Necessário | String | O token de autorização do pedido. Para obter mais informações sobre como gerar um token de autorização válido, veja Controlo de Acesso nos Recursos do Cosmos DB |
| Tipo de Conteúdo | Necessário (em PUT, PATCH e POST) | String | Para post em operações de consulta, tem de ser aplicação/consulta+json. Para operações patch, tem de ser aplicação/json_patch+json. Para anexos, tem de ser definido como o tipo mime do anexo. Para obter mais informações sobre tipos de Mime, consulte Criar um Anexo Para todas as outras tarefas, tem de ser application/json. |
| If-Match | Opcional (aplicável apenas em PUT e DELETE) | String | Utilizado para tornar a operação condicional para simultaneidade otimista. O valor deve ser o valor etag do recurso. |
| If-None-Match | Opcional (aplicável apenas no GET) | String | Torna a operação condicional para ser executada apenas se o recurso tiver sido alterado. O valor deve ser a etag do recurso. |
| If-Modified-Since | Opcional (aplicável apenas no GET) | Date | Devolve o etag do recurso modificado após a data especificada no formato RFC 1123. Ignorado quando a opção If-None-Match é especificada |
| User-Agent | Opcional | String | Uma cadeia que especifica o agente de utilizador cliente que executa o pedido. O formato recomendado é {user agent name}/{version}. Por exemplo, o SDK .NET da API SQL oficial define a cadeia de User-Agent como Microsoft.Document.Client/1.0.0.0. Um agente de utilizador personalizado pode ser algo como ContosoMarketingApp/1.0.0. |
| x-ms-activity-id | Opcional | String | Um identificador fornecido pelo cliente para a operação, que é ecoado na resposta do servidor. O valor recomendado é um identificador exclusivo. |
| x-ms-consistency-level | Opcional | String | A substituição do nível de consistência para opções de leitura em documentos e anexos. Os valores válidos são: Forte, Vinculado, Sessão ou Eventual (por ordem do mais forte para o mais fraco). A substituição tem de ser igual ou mais fraca do que o nível de consistência configurado da conta. |
| x-ms-continuation | Opcional | String | Um token de cadeia devolvido para consultas e operações de feed de leitura se existirem mais resultados a ler. Os clientes podem obter a página seguinte dos resultados ao submeter novamente o pedido com o cabeçalho do pedido x-ms-continuation definido para este valor. |
| x-ms-date | Necessário | Data | A data do pedido por formato de data RFC 1123 expresso na Hora Universal Coordenada, por exemplo, Fri, 08 Abr 2015 03:52:31 GMT. |
| x-ms-max-item-count | Opcional | Número | Um número inteiro que indica o número máximo de itens a devolver por página. Pode especificar uma contagem de itens x-ms-max-item-count de -1 para permitir que o serviço determine a contagem de itens ideal. Este é o valor de configuração recomendado para x-ms-max-item-count |
| x-ms-documentdb-partitionkey | Opcional | Matriz | O valor da chave de partição para a operação de documento ou anexo pedida. Necessário para operações em documentos e anexos quando a definição da coleção inclui uma definição de chave de partição. Este valor é utilizado para definir o âmbito da consulta para documentos que correspondam aos critérios da chave de partição. Por predefinição, é uma única consulta de partição. Suportado nas versões de API 2015-12-16 e mais recentes. Atualmente, a API SQL suporta uma única chave de partição, pelo que esta é uma matriz que contém apenas um valor. |
| x-ms-documentdb-query-enablecrosspartition | Opcional | Booleano | Quando este cabeçalho está definido como verdadeiro e se a consulta não tiver uma chave de partição, o Azure Cosmos DB desativa a consulta entre partições. A saída da ventoinha é feita através da emissão de consultas individuais para todas as partições. Para ler os resultados da consulta, as aplicações cliente devem consumir os resultados do FeedResponse e verificar a propriedade ContinuationToken. Para ler todos os resultados, continue a iterar os dados até o ContinuationToken ser nulo. |
| x-ms-session-token | Necessário (apenas para consistência da sessão) | String | Um token de cadeia utilizado com consistência ao nível da sessão. Para obter mais informações, veja Utilizar níveis de consistência no Cosmos DB |
| x-ms-version | Necessário | String | A versão do serviço REST do Cosmos DB. Para obter uma lista das versões de API suportadas, veja Referência da API REST do Azure Cosmos DB |
| MI A | Opcional | String | Indica um pedido de feed de alterações . Tem de ser definido como "Feed incremental" ou omitido de outra forma. |
| x-ms-documentdb-partitionkeyrangeid | Opcional | Número | Utilizado em pedidos de feed de alterações . O ID do intervalo de chaves de partição para ler dados. |
| x-ms-cosmos-allow-tentative-writes | Opcional | Booleano | Quando este cabeçalho está definido como verdadeiro para as contas do Azure Cosmos configuradas com várias localizações de escrita, o Azure Cosmos DB permitirá escritas em todas as localizações. Os pedidos de escrita com o valor deste cabeçalho definido como falso (ou se o cabeçalho estiver ausente) falharão com o código 403 Estado de Resposta com a mensagem de erro "As escritas não são permitidas na região". |
Ver também