Cabeçalhos de pedido de Azure Cosmos DB REST

Os seguintes cabeçalhos de pedido são comuns a todas as tarefas que possa fazer com a API SQL:

Cabeçalho Necessário Tipo Description
Autorização Necessário String O sinal de autorização para o pedido. Para obter mais informações sobre a geração de um token de autorização válido, consulte Controlo de Acesso sobre a Cosmos DB Resources
Tipo de conteúdo Obrigatório (em PUT, PATCH e POST) String Para POST em operações de consulta, deve ser aplicação/consulta+json.

Para operações PATCH, deve ser aplicação/json_patch+json.

Para os acessórios, deve ser definido para o tipo Mime do acessório. Para obter mais informações sobre os tipos de Mime, consulte Criar um Anexo

Para todas as outras tarefas, deve ser aplicação/json.
Se-Match Opcional (aplicável apenas em PUT e DELETE) String Usado para condicionar a operação para uma concordância otimista. O valor deve ser o valor etag do recurso.
Se-Nenhum-Match Opcional (aplicável apenas no GET) String O funcionamento só condiciona para executar se o recurso tiver mudado. O valor deve ser o etag do recurso.
If-Modificado-Desde Opcional (aplicável apenas no GET) Data Devolve etag de recurso modificado após data especificada no formato RFC 1123. Ignorado quando se especificado o Se-Nenhum-Match
Agente-utilizador Opcional String Uma cadeia que especifica o agente utilizador cliente que realiza o pedido. O formato recomendado é {user agent name}/{version}. Por exemplo, o SQL oficial API .NET SDK define a cadeia User-Agent para Microsoft.Document.Client/1.0.0.0.0. Um agente de utilizador personalizado pode ser algo como ContosoMarketingApp/1.0.0.
x-ms-activity-id Opcional String Um cliente forneceu o identificador para a operação, que é ecoado na resposta do servidor. O valor recomendado é um identificador único.
x-ms-nível de consistência Opcional String O nível de consistência sobrepõe-se às opções de leitura contra documentos e anexos. Os valores válidos são: Forte, Limitado, Sessão ou Eventual (por ordem dos mais fortes aos mais fracos). O sobreposição deve ser o mesmo ou mais fraco do que o nível de consistência configurado da conta.
x-ms-continuação Opcional String Um símbolo de corda devolvido para consultas e operações de feed de leitura se houver mais resultados a serem lidos. Os clientes podem recuperar a próxima página de resultados, reenviando o pedido com o cabeçalho de pedido x-ms-continuação definido para este valor.
x-ms-data Necessário Data A data do pedido por formato de data RFC 1123 expressa no Tempo Universal Coordenado, por exemplo, Sex, 08 abr 2015 03:52:31 GMT.
x-ms-max-item-contagem Opcional Número Um número inteiro que indica o número máximo de itens a devolver por página. Pode especificar-se uma contagem de -1 x-ms-max-item para permitir que o serviço determine a contagem ideal do item. Este é o valor de configuração recomendado para x-ms-max-item-contagem
x-ms-documentdb-partitionkey Opcional Matriz O valor chave da partição para a operação de documento ou anexo solicitado. Necessário para operações contra documentos e anexos quando a definição de recolha inclui uma definição de chave de partição. Este valor é utilizado para estender a sua consulta a documentos que correspondam aos critérios-chave da partição. Por design é uma única consulta de partição. Suportado nas versões API 2015-12-16 e mais recente. Atualmente, a API SQL suporta uma única chave de partição, por isso esta é uma matriz contendo apenas um valor.
x-ms-documentdb-consulta-enablecrosspartition Opcional Booleano Quando este cabeçalho é definido como verdadeiro e se a sua consulta não tem uma chave de partição, Azure Cosmos DB abana a consulta através de divisórias. O ventilador é feito emitindo consultas individuais a todas as divisórias. Para ler os resultados da consulta, as aplicações do cliente devem consumir os resultados da FeedResponse e verificar se a propriedade ContinuationToken. Para ler todos os resultados, mantenha-se iterante nos dados até que o ContinuationToken seja nulo.
x-ms-session-token Necessário (apenas para a consistência da sessão) String Um símbolo de corda usado com consistência do nível de sessão. Para obter mais informações, veja
Usando níveis de consistência em Cosmos DB
x-ms-versão Necessário String A versão do serviço Cosmos DB REST.
Para obter uma lista de versões API suportadas, consulte referência API API do Azure Cosmos DB REST
A-IM Opcional String Indica um pedido de alteração . Deve ser definido como "Alimentação incremental", ou omitido de outra forma.
x-ms-documentdb-partitionkeyrangeid Opcional Número Usado em pedidos de mudança de alimentação . O ID da chave de partição para os dados de leitura.
x-ms-cosmos-permitir-tentativa-escritos Opcional Booleano Quando este cabeçalho for definido como verdadeiro para as contas do Azure Cosmos configurados com vários locais de escrita, a Azure Cosmos DB permitirá escrever em todos os locais. Escreva pedidos com o valor deste cabeçalho definido para falso (ou se o cabeçalho estiver ausente) falhará com o código de Estado de resposta 403 com mensagem de erro "Não são permitidas escritas na região".

Ver também