Partilhar via

Cabeçalhos de solicitação REST comuns do Azure Cosmos DB

  • Artigo

Os cabeçalhos de solicitação a seguir são comuns a todas as tarefas que você pode fazer com a API SQL:

Cabeçalho Necessário Tipo Descrição
Autorização Necessário String O token de autorização para a solicitação. Para obter mais informações sobre como gerar um token de autorização válido, consulte Access Control on Cosmos DB Resources
de tipo de conteúdo Obrigatório (em PUT, PATCH e POST) String Para operações de consulta POST, ele deve ser application/query+json.

Para operações PATCH, ele deve ser application/json_patch+json.

Para anexos, deve 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, deve ser application/json.
If-Match Opcional (aplicável apenas em PUT e DELETE) String Usado para condicionar a operação 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 somente se o recurso tiver sido alterado. O valor deve ser o etag do recurso.
If-Modified-Since Opcional (aplicável apenas no GET) Data Retorna etag de recurso modificado após a data especificada no formato RFC 1123. Ignorado quando If-None-Match é especificado
do User-Agent Opcional String Uma cadeia de caracteres que especifica o agente do usuário cliente que executa a solicitação. O formato recomendado é {user agent name}/{version}. Por exemplo, o SQL API .NET SDK oficial define a cadeia de caracteres User-Agent como Microsoft.Document.Client/1.0.0.0. Um agente de usuário 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.
de nível de consistência x-ms Opcional String A substituição do nível de consistência para opções de leitura em relação a documentos e anexos. Os valores válidos são: Forte, Limitado, Sessão ou Eventual (na ordem do mais forte para o mais fraco). A substituição deve 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 de caracteres retornado para consultas e operações de alimentação de leitura se houver mais resultados a serem lidos. Os clientes podem recuperar a próxima página de resultados reenviando a solicitação com o cabeçalho da solicitação x-ms-continuation definido para esse valor.
x-ms-date Necessário Data A data da solicitação por formato de data RFC 1123 expressa em Tempo Universal Coordenado, por exemplo, Fri, 08 Apr 2015 03:52:31 GMT.
x-ms-max-item-count Opcional Número Um inteiro que indica o número máximo de itens a serem retornados por página. Um x-ms-max-item-count de -1 pode ser especificado para permitir que o serviço determine a contagem ideal de itens. 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 o documento solicitado ou operação de anexo. Necessário para operações contra documentos e anexos quando a definição de coleção inclui uma definição de chave de partição. Esse valor é usado para definir o escopo de sua consulta para documentos que correspondem aos critérios de chave de partição. Por design, é uma consulta de partição única. Suportado nas versões API 2015-12-16 e mais recentes. Atualmente, a API SQL suporta uma única chave de partição, portanto, esta é uma matriz que contém apenas um valor.
x-ms-documentdb-query-enablecrosspartition Opcional Booleano Quando esse cabeçalho é definido como true e se sua consulta não tem uma chave de partição, o Azure Cosmos DB distribui a consulta entre partições. O fan out é feito emitindo consultas individuais para todas as partições. Para ler os resultados da consulta, os aplicativos cliente devem consumir os resultados do FeedResponse e verificar a propriedade ContinuationToken. Para ler todos os resultados, continue iterando os dados até que o ContinuationToken seja nulo.
x-ms-session-token Obrigatório (apenas para consistência da sessão) String Um token de cadeia de caracteres usado com consistência de nível de sessão. Para obter mais informações, consulte
Usando níveis de consistência no Cosmos DB
X-MS-versão Necessário String A versão do serviço REST do Cosmos DB.
Para obter uma lista de versões de API suportadas, consulte de referência da API REST do Azure Cosmos DB
A-IM Opcional String Indica um feed de alterações solicitação. Deve ser definido como "Alimentação incremental" ou omitido de outra forma.
X-MS-DOCUMENTDB-PARTITIONKEYRANGEID Opcional Número Usado em alterar solicitações de de alimentação. O ID do intervalo de chaves de partição para leitura de dados.
x-ms-cosmos-allow-tentative-writes Opcional Booleano Quando esse cabeçalho é definido como true para as contas do Azure Cosmos configuradas com vários locais de gravação, o Azure Cosmos DB permitirá gravações em todos os locais. As solicitações de gravação com o valor deste cabeçalho definido como false (ou se o cabeçalho estiver ausente) falharão com o código de status da resposta 403 com a mensagem de erro "Gravações não são permitidas na região".

Ver também