Azure Cosmos DB

O Azure Cosmos DB é um serviço de banco de dados multimodelo distribuído globalmente projetado para permitir que você dimensione de forma elástica e independente a taxa de transferência e o armazenamento em qualquer número de regiões geográficas com um SLA abrangente.

Este conector está disponível nos seguintes produtos e regiões:

Serviço	Class	Regiões
Estúdio Copiloto	Premium	Todas as regiões do Power Automate
Aplicações Lógicas	Standard	Todas as regiões do Logic Apps
Aplicações Power	-	Não disponível
Automatize o poder	Premium	Todas as regiões do Power Automate

Metadados do conector
Editora	Microsoft

Para usar essa integração, você precisará de uma conta da API SQL do Cosmos DB configurada no Portal do Azure. Observe que as contas de API do Mongo DB não são suportadas no momento.

Depois que a conta da API SQL for criada, forneça a ID da conta (sem 'documents.azure.com') ao criar uma conexão com o conector do Azure Cosmos DB se estiver criando uma conexão do Access Key tipo. Este ID de conta também é necessário para versões de operação mais recentes que suportam a autenticação de ID do Microsoft Entra.

Autenticação Microsoft Entra ID e conector Cosmos DB

Para usar a autenticação do Microsoft Entra ID, a conta que está sendo usada precisa receber uma atribuição de função específica, para obter mais informações, visite Configurar controle de acesso baseado em função com ID do Microsoft Entra para sua conta do Azure Cosmos DB.

Observação

Somente funções explicitamente definidas para acesso a dados permitem que uma entidade de segurança acesse dados do Cosmos DB. Funções internas, como Owner, ou Contributornão fornecem acesso aos dados do Cosmos DB dentro dessa conta por meio do Microsoft Entra ID. Há 2 funções internas expostas pelo Azure Cosmos DB:

1. Cosmos DB Built-in Data Reader (ID de definição de 00000000-0000-0000-0000-000000000001função)
2. Cosmos DB Built-in Data Contributor (ID de definição de 00000000-0000-0000-0000-000000000002função)

As funções podem ser atribuídas de várias maneiras e as funções personalizadas podem ser criadas para acesso mais granular.

Aqui está um exemplo sobre quem atribuir Cosmos DB Built-in Data Reader via PowerShell (mais informações sobre este comando New-AzCosmosDBSqlRoleAssignment):

$resourceGroupName = "<myResourceGroup>"
$accountName = "<myCosmosAccount>"
$principalId = "<myPrincipalId>"
$roleDefinitionId = "/subscriptions/<<mySubscription>>/resourceGroups/<<myResourceGroup>>/providers/Microsoft.DocumentDB/databaseAccounts/<<myCosmosAccount>>/sqlRoleDefinitions/00000000-0000-0000-0000-000000000001"
New-AzCosmosDBSqlRoleAssignment -AccountName $accountName `
    -ResourceGroupName $resourceGroupName `
    -RoleDefinitionId $roleDefinitionId `
    -PrincipalId $principalId `
    -AssignableScope "/"

A falha ao adicionar essas atribuições de função, acabará com solicitações não autorizadas como esta: Request is blocked because principal [<<principal-id>>] does not have the required RBAC permissions to perform action <unauthorized actions>.

Observação

O Azure Cosmos DB não suporta nenhum tipo de operações de gestão com a autenticação Microsoft Entra ID (documentada aqui). As seguintes operações só funcionarão com Access Key conexões:

1. Criar procedimento armazenado (versões V1 e V2)
2. Excluir procedimento armazenado (versões V1 e V2)
3. Procedimento armazenado de atualização (versões V1 e V2)

Operações não suportadas com a autenticação do Microsoft Entra ID

Ao usar a autenticação do Microsoft Entra ID , apenas ações com o nome da conta do Cosmos DB como parâmetro são suportadas. As ações preteridas continuarão a funcionar com Access Key autenticação, mas falharão se usadas com uma conexão de ID do Microsoft Entra.

Problemas conhecidos e limitações

• O tamanho máximo de um documento suportado pelo conector do Banco de Dados de Documentos (Azure Cosmos DB) é de 2 MB.

• As limitações do Azure Cosmos DB estão documentadas aqui.

• A escolha de uma região de gravação e de várias regiões de gravação não é suportada pelo conector.

• O "Valor da chave de partição" deve ser fornecido de acordo com o seu tipo. Por exemplo, um valor de cadeia de caracteres deve ser colocado entre aspas, um número deve ser fornecido como está. Por exemplo: "string value",123, 0,5.

• O "Valor da chave de partição" é necessário para consultas com ORDER BY, DISTINCT, etc, que são executadas em coleções particionadas.

• As ações Consultar documentos V2 [DEPRECATED], Consultar documentos V3, Obter todos os documentos V2 (Pré-visualização) utilizam o Azure Cosmos DB .NET SDK para API SQL (versão 2.13.1).

• A ação Consultar documentos V4 (Pré-visualização) utiliza o Azure Cosmos DB .NET SDK para API SQL (versão 3.15.0).

• A ação Consultar documentos (V5) (Pré-visualização) utiliza o Azure Cosmos DB .NET SDK para API SQL (versão 3.20.0).

• O valor do parâmetro "Max Item Count" pode ser qualquer número de 1 a 1000. Qualquer número fora desse intervalo será implicitamente convertido em "-1", que informa ao serviço Cosmos DB para determinar a contagem ideal de itens.

• Se deixadas vazias, as operações a seguir funcionarão apenas com documentos que não têm um valor de chave de partição. Os itens com um valor de chave de partição serão excluídos dessas ações.

  1. Obter um documento
  2. Obter um documento (V2)
  3. Substituir um documento
  4. Substituir um documento (V2)
  5. Eliminar um documento
  6. Eliminar um documento (V2)
  7. Executar procedimento armazenado
  8. Executar procedimento armazenado (v2)

• Devido ao Azure Cosmos DB não suportar qualquer tipo de operações de gestão com a autenticação Microsoft Entra ID (documentada aqui), a operação Executar procedimento armazenado (V2) (Pré-visualização) apenas apresentará os procedimentos armazenados disponíveis (para o SprocId parâmetro) quando utilizar uma Access Key ligação baseada. Token as autenticações baseadas (autenticações do Microsoft Entra ID) mostrarão uma lista vazia e o deve ser inserido sprocId manualmente como um valor personalizado.

Importante

As conexões do Microsoft Entra ID Integrated (Azure Commercial) são desabilitadas em ambientes do Governo dos EUA (GCC) por padrão. Para habilitar esses tipos de conexões, a configuração Conectar ao Azure Comercial deve ser habilitada no Centro de administração da Power Platform por um administrador de locatário.

Ativar esta definição permite ligações a recursos no Azure Commercial que operam e enviam dados fora dos limites de conformidade da Power Platform US Government. Isso é usado especificamente para permitir o acesso a recursos comerciais a partir de versões em nuvem do GCC dos Power Platform Connectors.

O Microsoft Entra ID Integrated (Azure Commercial) é o único tipo de autenticação que funciona a partir de ambientes do Governo dos EUA (GCC) para recursos comerciais do Azure.

Autenticação Comercial do Azure desabilitada por padrão:

A configuração Conectar ao Comercial do Azure no Centro de administração da Power Platform:

A criar uma ligação

O conector suporta os seguintes tipos de autenticação:

Chave de Acesso	Forneça o Nome da Conta e a Chave de Acesso para acessar sua conta do Cosmos DB.	Todas as regiões, exceto o Azure Government e o Department of Defense (DoD) no Azure Government e no US Government (GCC) e no US Government (GCC-High)	Compartilhável
Chave de Acesso (Azure Government)	Forneça o Nome da Conta e a Chave de Acesso para acessar sua conta do Cosmos DB.	Azure Government and Department of Defense (DoD) apenas no Azure Government e US Government (GCC) e US Government (GCC-High)	Compartilhável
Identidade gerenciada de aplicativos lógicos	Criar uma conexão usando uma identidade gerenciada do LogicApps	Apenas LOGICAPPS	Compartilhável
Microsoft Entra ID Integrado	Use a ID do Microsoft Entra para acessar seu armazenamento de Blob do Azure.	Todas as regiões, exceto o Azure Government e o Department of Defense (DoD) no Azure Government e no US Government (GCC) e no US Government (GCC-High)	Não compartilhável
Microsoft Entra ID Integrado (Azure Commercial)	Use a ID do Microsoft Entra para acessar seu Armazenamento de Blob do Azure no Azure Commercial.	Apenas Governo dos EUA (CCG)	Não compartilhável
Microsoft Entra ID Integrated (Azure Government)	Use a ID do Microsoft Entra para acessar seu armazenamento de Blob do Azure.	Azure Government and Department of Defense (DoD) apenas no Azure Government e US Government (GCC) e US Government (GCC-High)	Não compartilhável
Padrão [DEPRECATED]	Esta opção é apenas para conexões mais antigas sem um tipo de autenticação explícita e é fornecida apenas para compatibilidade com versões anteriores.	Todas as regiões	Não compartilhável

Tecla de Acesso

ID de autenticação: keyBasedAuth

Aplicável: Todas as regiões, exceto o Azure Government e o Department of Defense (DoD) no Azure Government e no US Government (GCC) e no US Government (GCC-High)

Forneça o Nome da Conta e a Chave de Acesso para acessar sua conta do Cosmos DB.

Esta é uma conexão compartilhável. Se o aplicativo de energia for compartilhado com outro usuário, a conexão também será compartilhada. Para obter mais informações, consulte a Visão geral de conectores para aplicativos de tela - Power Apps | Documentos Microsoft

Nome	Tipo	Description	Obrigatório
ID da conta	cadeia (de caracteres)	Nome da conta sem parte «documents.azure.com»	Verdade
Chave de acesso à sua conta do Azure Cosmos DB	securestring	Chave primária ou secundária	Verdade

Chave de Acesso (Azure Government)

ID de autenticação: keyBasedAuth

Aplicável: Azure Government e Department of Defense (DoD) apenas no Azure Government e US Government (GCC) e US Government (GCC-High)

Forneça o Nome da Conta e a Chave de Acesso para acessar sua conta do Cosmos DB.

Esta é uma conexão compartilhável. Se o aplicativo de energia for compartilhado com outro usuário, a conexão também será compartilhada. Para obter mais informações, consulte a Visão geral de conectores para aplicativos de tela - Power Apps | Documentos Microsoft

Nome	Tipo	Description	Obrigatório
ID da conta	cadeia (de caracteres)	Nome da conta sem parte «documents.azure.com»	Verdade
Chave de acesso à sua conta do Azure Cosmos DB	securestring	Chave primária ou secundária	Verdade

Identidade gerenciada de aplicativos lógicos

ID de autenticação: managedIdentityAuth

Aplicável: apenas LOGICAPPS

Criar uma conexão usando uma identidade gerenciada do LogicApps

Esta é uma conexão compartilhável. Se o aplicativo de energia for compartilhado com outro usuário, a conexão também será compartilhada. Para obter mais informações, consulte a Visão geral de conectores para aplicativos de tela - Power Apps | Documentos Microsoft

Nome	Tipo	Description	Obrigatório
Identidade gerenciada do LogicApps	managedIdentity	Entrar com uma identidade gerenciada de aplicativos lógicos	Verdade

ID do Microsoft Entra Integrado

ID de autenticação: tokenBasedAuth

Aplicável: Todas as regiões, exceto o Azure Government e o Department of Defense (DoD) no Azure Government e no US Government (GCC) e no US Government (GCC-High)

Use a ID do Microsoft Entra para acessar seu armazenamento de Blob do Azure.

Esta conexão não é compartilhável. Se o aplicativo avançado for compartilhado com outro usuário, outro usuário será solicitado a criar uma nova conexão explicitamente.

Microsoft Entra ID Integrado (Azure Commercial)

Auth ID: oauthCom

Aplicável: apenas Governo dos EUA (GCC)

Use a ID do Microsoft Entra para acessar seu Armazenamento de Blob do Azure no Azure Commercial.

Esta conexão não é compartilhável. Se o aplicativo avançado for compartilhado com outro usuário, outro usuário será solicitado a criar uma nova conexão explicitamente.

Microsoft Entra ID Integrated (Azure Government)

ID de autenticação: tokenBasedAuth

Aplicável: Azure Government e Department of Defense (DoD) apenas no Azure Government e US Government (GCC) e US Government (GCC-High)

Use a ID do Microsoft Entra para acessar seu armazenamento de Blob do Azure.

Esta conexão não é compartilhável. Se o aplicativo avançado for compartilhado com outro usuário, outro usuário será solicitado a criar uma nova conexão explicitamente.

Padrão [DEPRECATED]

Aplicável: Todas as regiões

Esta opção é apenas para conexões mais antigas sem um tipo de autenticação explícita e é fornecida apenas para compatibilidade com versões anteriores.

Esta conexão não é compartilhável. Se o aplicativo avançado for compartilhado com outro usuário, outro usuário será solicitado a criar uma nova conexão explicitamente.

Nome	Tipo	Description	Obrigatório
ID da conta	cadeia (de caracteres)	Nome da conta sem parte «documents.azure.com»	Verdade
Chave de acesso à sua conta do Azure Cosmos DB	securestring	Chave primária ou secundária	Verdade

Limites de Limitação

Name	Chamadas	Período de Renovação
Chamadas de API por conexão	1500	60 segundos

Ações

Consultar documentos [DEPRECATED]	Esta ação foi preterida. Em vez disso, use Consultar documentos V5 . Consultar documentos.
Consultar documentos V2 [DEPRECATED]	Esta ação foi preterida. Em vez disso, use Consultar documentos V5 . Consultar documentos V2.
Consultar documentos V3 [DEPRECATED]	Esta ação foi preterida. Em vez disso, use Consultar documentos V5 . Consultar documentos V3.
Consultar documentos V4 [DEPRECATED]	Esta ação foi preterida. Em vez disso, use Consultar documentos V5 . Consultar documentos V4.
Consultar documentos V5	Consultar documentos (V5).
Criar ou atualizar documento (V2) [DEPRECATED]	Esta ação foi preterida. Em vez disso, use Criar ou atualizar documento (V3). Criar ou atualizar documento. Ao criar um documento no Banco de Dados de Documentos, o corpo deve incluir uma propriedade id.
Criar ou atualizar documento (V3)	Criar ou atualizar documento. Ao criar um documento no Banco de Dados de Documentos, o corpo deve incluir uma propriedade id.
Criar ou atualizar documento [DEPRECATED]	Esta ação foi preterida. Em vez disso, use Criar ou atualizar documento (V3). Criar ou atualizar documento. Ao criar um documento no Banco de Dados de Documentos, o corpo deve incluir uma propriedade id.
Criar procedimento armazenado (V2)	Criar procedimento armazenado (V2).
Criar procedimento armazenado [DEPRECATED]	Esta ação foi preterida. Em vez disso, use Criar procedimento armazenado (V2). Criar procedimento armazenado.
Eliminar um documento (V2)	Eliminar um documento (V2).
Eliminar um documento [DEPRECATED]	Esta ação foi preterida. Em vez disso, utilize Eliminar um documento (V2). Excluir um documento.
Excluir procedimento armazenado (V2)	Excluir procedimento armazenado (V2).
Excluir procedimento armazenado [DEPRECATED]	Esta ação foi preterida. Em vez disso, use Excluir procedimento armazenado (V2). Excluir procedimento armazenado.
Executar procedimento armazenado (V2)	Execute o procedimento armazenado na coleção especificada (V2).
Executar procedimento armazenado [DEPRECATED]	Esta ação foi preterida. Em vez disso, use Executar procedimento armazenado (V2). Execute o procedimento armazenado na coleção especificada.
Obter procedimentos armazenados (V2)	Obtenha procedimentos armazenados na coleção especificada (V2).
Obter procedimentos armazenados [DEPRECATED]	Esta ação foi preterida. Em vez disso, use Obter procedimentos armazenados (V2). Obtenha procedimentos armazenados na coleção especificada.
Obter todos os documentos (V3)	Obter todos os documentos (V3).
Obter todos os documentos [DEPRECATED]	Esta ação foi preterida. Em vez disso, use Obter todos os documentos (V3). Obtenha todos os documentos.
Obter todos os documentos V2 [DEPRECATED]	Esta ação foi preterida. Em vez disso, use Obter todos os documentos (V3). Obtenha todos os documentos V2.
Obter um documento (V2)	Obter um documento (V2).
Obter um documento [DEPRECATED]	Esta ação foi preterida. Em vez disso, utilize Obter um documento (V2). Obtenha um documento.
Substituir procedimento armazenado (V2)	Substitua o procedimento armazenado (V2).
Substituir procedimento armazenado [DEPRECATED]	Esta ação foi preterida. Em vez disso, use Substituir procedimento armazenado (V2). Substitua o procedimento armazenado.
Substituir um documento (V2)	Substitua um documento (V2).
Substituir um documento [DEPRECATED]	Esta ação foi preterida. Em vez disso, use Substituir um documento (V2). Substitua um documento.

Consultar documentos [DEPRECATED]

ID da Operação:

QueryDocuments

Esta ação foi preterida. Em vez disso, use Consultar documentos V5 .

Consultar documentos.

Parâmetros

Name	Chave	Necessário	Tipo	Description
Valor da chave de partição	x-ms-documentdb-raw-partitionkey		string	O valor da chave de partição para o documento solicitado ou operação de anexo.
Contagem máxima de itens	x-ms-max-item-count		number	Um inteiro que indica o número máximo de itens a serem retornados por página.
Token de continuação	x-ms-continuation		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.
Ativar partição cruzada	x-ms-documentdb-query-enablecrosspartition		boolean	Se a coleção for particionada, ela deverá ser definida como True para permitir a execução em várias partições.
Nível de consistência	x-ms-consistency-level		string	Esta é a substituição do nível de consistência. Os valores válidos são: Forte, Limitado, Sessão ou Eventual (na ordem do mais forte para o mais fraco).
Token de sessão	x-ms-session-token		string	Um token de cadeia de caracteres usado com consistência de nível de sessão.
ID da atividade	x-ms-activity-id		string	Um identificador fornecido pelo cliente para a operação, que será ecoado na resposta do servidor.
ID da Base de Dados	databaseId	True	string	O nome do banco de dados.
ID da coleção	collectionId	True	string	O nome da coleção.
consulta	query		string

Devoluções

Body

queryResponse

Consultar documentos V2 [DEPRECATED]

ID da Operação:

QueryDocumentsV2

Esta ação foi preterida. Em vez disso, use Consultar documentos V5 .

Consultar documentos V2.

Parâmetros

Name	Chave	Necessário	Tipo	Description
ID da Base de Dados	databaseId	True	string	O nome do banco de dados.
ID da coleção	collectionId	True	string	O nome da coleção.
Texto de Consulta	QueryText		string	Consulta de sintaxe SQL sobre documentos
Valor da chave de partição	partitionKey		string	Valor da chave de partição.
Token de continuação	continuationToken		string	Um token para obter resultados adicionais da operação.

Devoluções

Matriz de documentos que correspondem à consulta solicitada e aos metadados relacionados.

Body

QueryDocumentsResponse

Consultar documentos V3 [DEPRECATED]

ID da Operação:

QueryDocumentsV3

Esta ação foi preterida. Em vez disso, use Consultar documentos V5 .

Consultar documentos V3.

Parâmetros

Name	Chave	Necessário	Tipo	Description
ID da Base de Dados	databaseId	True	string	O nome do banco de dados.
ID da coleção	collectionId	True	string	O nome da coleção.
Consulta de sintaxe SQL	queryText	True	string	Consulta SQL.
Valor da chave de partição	partitionKey		string	Se estiverem vazias, todas as partições serão usadas para procurar documentos.
Contagem máxima de itens	maxItemCount		integer	Um inteiro que indica o número máximo de itens a serem retornados por página.
Token de continuação	continuationToken		string	Um token para obter resultados adicionais.
Ativar partição cruzada	enableCrossPartition		boolean	Indica se o usuário está habilitado para enviar mais de uma solicitação para executar a consulta.
Nível de consistência	consistencyLevel		string	Nível de consistência necessário para a operação de feed (feed de consulta/leitura).
Token de sessão	sessionToken		string	O token de sessão para uso com consistência de sessão.

Devoluções

Matriz de documentos que correspondem à consulta solicitada e aos metadados relacionados.

Body

DocumentsCollection

Consultar documentos V4 [DEPRECATED]

ID da Operação:

QueryDocumentsV4

Esta ação foi preterida. Em vez disso, use Consultar documentos V5 .

Consultar documentos V4.

Parâmetros

Name	Chave	Necessário	Tipo	Description
ID da Base de Dados	databaseId	True	string	O nome do banco de dados.
ID do contêiner	containerId	True	string	O nome do contêiner.
Consulta de sintaxe SQL	queryText		string	Consulta SQL. Se estiver vazio, devolverá todos os documentos.
Valor da chave de partição	partitionKey		string	Se estiverem vazias, todas as partições serão usadas para procurar documentos.
Contagem máxima de itens	maxItemCount		integer	Um inteiro que indica o número máximo de itens a serem retornados por página.
Token de continuação	continuationToken		string	Um token para obter resultados adicionais.
Nível de consistência	consistencyLevel		string	Nível de consistência necessário para a operação de feed (feed de consulta/leitura).
Token de sessão	sessionToken		string	O token de sessão para uso com consistência de sessão.

Devoluções

Matriz de documentos que correspondem à consulta solicitada e aos metadados relacionados.

Body

DocumentsCollection

Consultar documentos V5

ID da Operação:

QueryDocuments_V5

Consultar documentos (V5).

Parâmetros

Name	Chave	Necessário	Tipo	Description
Nome da conta do Azure Cosmos DB	cosmosDbAccountName	True	string	O nome da conta do Azure Cosmos DB (sem documents.azure.com).
ID da Base de Dados	databaseId	True	string	O nome do banco de dados.
ID do contêiner	containerId	True	string	O nome do contêiner.
Consulta de sintaxe SQL	queryText		string	Consulta SQL. Se estiver vazio, devolverá todos os documentos.
Valor da chave de partição	partitionKey		string	O valor deve ser fornecido de acordo com o seu tipo ("string", 42, 0,5). Se estiverem vazias, todas as partições serão usadas para procurar documentos.
Contagem máxima de itens	maxItemCount		integer	Um inteiro que indica o número máximo de itens a serem retornados por página.
Token de continuação	continuationToken		string	Um token para obter resultados adicionais.
Nível de consistência	consistencyLevel		string	Nível de consistência necessário para a operação de feed (feed de consulta/leitura).
Token de sessão	sessionToken		string	O token de sessão para uso com consistência de sessão.

Devoluções

Matriz de documentos que correspondem à consulta solicitada e aos metadados relacionados.

Body

DocumentsCollection

Criar ou atualizar documento (V2) [DEPRECATED]

ID da Operação:

CreateDocumentV2

Esta ação foi preterida. Em vez disso, use Criar ou atualizar documento (V3).

Criar ou atualizar documento. Ao criar um documento no Banco de Dados de Documentos, o corpo deve incluir uma propriedade id.

Parâmetros

Name	Chave	Necessário	Tipo	Description
Contagem máxima de itens	x-ms-max-item-count		number	Um inteiro que indica o número máximo de itens a serem retornados por página.
Token de continuação	x-ms-continuation		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.
Nível de consistência	x-ms-consistency-level		string	Esta é a substituição do nível de consistência. Os valores válidos são: Forte, Limitado, Sessão ou Eventual (na ordem do mais forte para o mais fraco).
Token de sessão	x-ms-session-token		string	Um token de cadeia de caracteres usado com consistência de nível de sessão.
ID da atividade	x-ms-activity-id		string	Um identificador fornecido pelo cliente para a operação, que será ecoado na resposta do servidor.
IsUpsert	x-ms-documentdb-is-upsert		boolean	Se definido como true, o documento será substituído se existir outro criado.
Pré-Gatilho	x-ms-documentdb-pre-trigger-include		string	Lista separada por vírgulas de nomes de gatilho a serem executados antes que a operação de documento seja executada.
Pós-Gatilho	x-ms-documentdb-post-trigger-include		string	Lista separada por vírgulas de nomes de gatilho a serem executados após a execução da operação de documento.
ID da Base de Dados	databaseId	True	string	O nome do banco de dados.
ID da coleção	collectionId	True	string	O nome da coleção.
Versão da API	x-ms-version		string	Versão da API.

Devoluções

Body

postDocumentsResponse

Criar ou atualizar documento (V3)

ID da Operação:

CreateDocument_V3

Criar ou atualizar documento. Ao criar um documento no Banco de Dados de Documentos, o corpo deve incluir uma propriedade id.

Parâmetros

Name	Chave	Necessário	Tipo	Description
Contagem máxima de itens	x-ms-max-item-count		number	Um inteiro que indica o número máximo de itens a serem retornados por página.
Token de continuação	x-ms-continuation		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.
Nível de consistência	x-ms-consistency-level		string	Esta é a substituição do nível de consistência. Os valores válidos são: Forte, Limitado, Sessão ou Eventual (na ordem do mais forte para o mais fraco).
Token de sessão	x-ms-session-token		string	Um token de cadeia de caracteres usado com consistência de nível de sessão.
ID da atividade	x-ms-activity-id		string	Um identificador fornecido pelo cliente para a operação, que será ecoado na resposta do servidor.
IsUpsert	x-ms-documentdb-is-upsert		boolean	Se definido como true, o documento será substituído se existir outro criado.
Pré-Gatilho	x-ms-documentdb-pre-trigger-include		string	Lista separada por vírgulas de nomes de gatilho a serem executados antes que a operação de documento seja executada.
Pós-Gatilho	x-ms-documentdb-post-trigger-include		string	Lista separada por vírgulas de nomes de gatilho a serem executados após a execução da operação de documento.
Nome da conta do Azure Cosmos DB	cosmosDbAccountName	True	string	O nome da conta do Azure Cosmos DB (sem documents.azure.com).
ID da Base de Dados	databaseId	True	string	O nome do banco de dados.
ID da coleção	collectionId	True	string	O nome da coleção.
Versão da API	x-ms-version		string	Versão da API.

Devoluções

Body

postDocumentsResponse

Criar ou atualizar documento [DEPRECATED]

ID da Operação:

CreateDocument

Esta ação foi preterida. Em vez disso, use Criar ou atualizar documento (V3).

Criar ou atualizar documento. Ao criar um documento no Banco de Dados de Documentos, o corpo deve incluir uma propriedade id.

Parâmetros

Name	Chave	Necessário	Tipo	Description
Valor da chave de partição	x-ms-documentdb-raw-partitionkey		string	O valor da chave de partição para o documento solicitado ou operação de anexo.
Contagem máxima de itens	x-ms-max-item-count		number	Um inteiro que indica o número máximo de itens a serem retornados por página.
Token de continuação	x-ms-continuation		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.
Nível de consistência	x-ms-consistency-level		string	Esta é a substituição do nível de consistência. Os valores válidos são: Forte, Limitado, Sessão ou Eventual (na ordem do mais forte para o mais fraco).
Token de sessão	x-ms-session-token		string	Um token de cadeia de caracteres usado com consistência de nível de sessão.
ID da atividade	x-ms-activity-id		string	Um identificador fornecido pelo cliente para a operação, que será ecoado na resposta do servidor.
IsUpsert	x-ms-documentdb-is-upsert		boolean	Se definido como true, o documento será substituído se existir outro criado.
Pré-Gatilho	x-ms-documentdb-pre-trigger-include		string	Lista separada por vírgulas de nomes de gatilho a serem executados antes que a operação de documento seja executada.
Pós-Gatilho	x-ms-documentdb-post-trigger-include		string	Lista separada por vírgulas de nomes de gatilho a serem executados após a execução da operação de documento.
ID da Base de Dados	databaseId	True	string	O nome do banco de dados.
ID da coleção	collectionId	True	string	O nome da coleção.
Versão da API	x-ms-version		string	Versão da API.

Devoluções

Body

postDocumentsResponse

Criar procedimento armazenado (V2)

ID da Operação:

CreateStoredProcedure_V2

Criar procedimento armazenado (V2).

Parâmetros

Name	Chave	Necessário	Tipo	Description
Nome da conta do Azure Cosmos DB	cosmosDbAccountName	True	string	O nome da conta do Azure Cosmos DB (sem documents.azure.com).
ID da Base de Dados	databaseId	True	string	O nome do banco de dados.
ID da coleção	collectionId	True	string	O nome da coleção.
Definição de função	body		string	Função que define o procedimento armazenado, por exemplo, 'function(params){ ... }'
id	id		string	Nova id do procedimento armazenado.
Versão da API	x-ms-version		string	Versão da API.

Devoluções

Body

createStoredProcedureResponse

Criar procedimento armazenado [DEPRECATED]

ID da Operação:

CreateStoredProcedure

Esta ação foi preterida. Em vez disso, use Criar procedimento armazenado (V2).

Criar procedimento armazenado.

Parâmetros

Name	Chave	Necessário	Tipo	Description
ID da Base de Dados	databaseId	True	string	O nome do banco de dados.
ID da coleção	collectionId	True	string	O nome da coleção.
Definição de função	body		string	Função que define o procedimento armazenado, por exemplo, 'function(params){ ... }'
id	id		string	Nova id do procedimento armazenado.
Versão da API	x-ms-version		string	Versão da API.

Devoluções

Body

createStoredProcedureResponse

Eliminar um documento (V2)

ID da Operação:

DeleteDocument_V2

Eliminar um documento (V2).

Parâmetros

Name	Chave	Necessário	Tipo	Description
Valor da chave de partição	x-ms-documentdb-raw-partitionkey		string	O valor da chave de partição para o documento solicitado ou operação de anexo.
Contagem máxima de itens	x-ms-max-item-count		number	Um inteiro que indica o número máximo de itens a serem retornados por página.
Token de continuação	x-ms-continuation		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.
Nível de consistência	x-ms-consistency-level		string	Esta é a substituição do nível de consistência. Os valores válidos são: Forte, Limitado, Sessão ou Eventual (na ordem do mais forte para o mais fraco).
Token de sessão	x-ms-session-token		string	Um token de cadeia de caracteres usado com consistência de nível de sessão.
ID da atividade	x-ms-activity-id		string	Um identificador fornecido pelo cliente para a operação, que será ecoado na resposta do servidor.
Pré-Gatilho	x-ms-documentdb-pre-trigger-include		string	Lista separada por vírgulas de nomes de gatilho a serem executados antes que a operação de documento seja executada.
Pós-Gatilho	x-ms-documentdb-post-trigger-include		string	Lista separada por vírgulas de nomes de gatilho a serem executados após a execução da operação de documento.
Nome da conta do Azure Cosmos DB	cosmosDbAccountName	True	string	O nome da conta do Azure Cosmos DB (sem documents.azure.com).
ID da Base de Dados	databaseId	True	string	O nome do banco de dados.
ID da coleção	collectionId	True	string	O nome da coleção.
ID do documento	documentId	True	string	O identificador do documento.
Versão da API	x-ms-version		string	Versão da API.

Eliminar um documento [DEPRECATED]

ID da Operação:

DeleteDocument

Esta ação foi preterida. Em vez disso, utilize Eliminar um documento (V2).

Excluir um documento.

Parâmetros

Name	Chave	Necessário	Tipo	Description
Valor da chave de partição	x-ms-documentdb-raw-partitionkey		string	O valor da chave de partição para o documento solicitado ou operação de anexo.
Contagem máxima de itens	x-ms-max-item-count		number	Um inteiro que indica o número máximo de itens a serem retornados por página.
Token de continuação	x-ms-continuation		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.
Nível de consistência	x-ms-consistency-level		string	Esta é a substituição do nível de consistência. Os valores válidos são: Forte, Limitado, Sessão ou Eventual (na ordem do mais forte para o mais fraco).
Token de sessão	x-ms-session-token		string	Um token de cadeia de caracteres usado com consistência de nível de sessão.
ID da atividade	x-ms-activity-id		string	Um identificador fornecido pelo cliente para a operação, que será ecoado na resposta do servidor.
Pré-Gatilho	x-ms-documentdb-pre-trigger-include		string	Lista separada por vírgulas de nomes de gatilho a serem executados antes que a operação de documento seja executada.
Pós-Gatilho	x-ms-documentdb-post-trigger-include		string	Lista separada por vírgulas de nomes de gatilho a serem executados após a execução da operação de documento.
ID da Base de Dados	databaseId	True	string	O nome do banco de dados.
ID da coleção	collectionId	True	string	O nome da coleção.
ID do documento	documentId	True	string	O identificador do documento.
Versão da API	x-ms-version		string	Versão da API.

Excluir procedimento armazenado (V2)

ID da Operação:

DeleteStoredProcedure_V2

Excluir procedimento armazenado (V2).

Parâmetros

Name	Chave	Necessário	Tipo	Description
Nome da conta do Azure Cosmos DB	cosmosDbAccountName	True	string	O nome da conta do Azure Cosmos DB (sem documents.azure.com).
ID da Base de Dados	databaseId	True	string	O nome do banco de dados.
ID da coleção	collectionId	True	string	O nome da coleção.
Sproc ID	sprocId	True	string	O nome do procedimento armazenado.
Versão da API	x-ms-version		string	Versão da API.

Devoluções

response

string

Excluir procedimento armazenado [DEPRECATED]

ID da Operação:

DeleteStoredProcedure

Esta ação foi preterida. Em vez disso, use Excluir procedimento armazenado (V2).

Excluir procedimento armazenado.

Parâmetros

Name	Chave	Necessário	Tipo	Description
ID da Base de Dados	databaseId	True	string	O nome do banco de dados.
ID da coleção	collectionId	True	string	O nome da coleção.
Sproc ID	sprocId	True	string	O nome do procedimento armazenado.
Versão da API	x-ms-version		string	Versão da API.

Devoluções

response

string

Executar procedimento armazenado (V2)

ID da Operação:

ExecuteStoredProcedure_V2

Execute o procedimento armazenado na coleção especificada (V2).

Parâmetros

Name	Chave	Necessário	Tipo	Description
Nome da conta do Azure Cosmos DB	cosmosDbAccountName	True	string	O nome da conta do Azure Cosmos DB (sem documents.azure.com).
ID da Base de Dados	databaseId	True	string	O nome do banco de dados.
ID da coleção	collectionId	True	string	O nome da coleção.
Valor da chave de partição	x-ms-documentdb-raw-partitionkey		string	O valor da chave de partição para o documento solicitado ou operação de anexo.
Sproc ID	sprocId	True	string	O nome do procedimento armazenado.
Parâmetros para o procedimento armazenado	parameters		string	Especifique JSON válido para os parâmetros do procedimento armazenado, por exemplo, ["param1", "param2"].
Versão da API	x-ms-version		string	Versão da API.

Devoluções

response

ObjectWithoutType

Executar procedimento armazenado [DEPRECATED]

ID da Operação:

ExecuteStoredProcedure

Esta ação foi preterida. Em vez disso, use Executar procedimento armazenado (V2).

Execute o procedimento armazenado na coleção especificada.

Parâmetros

Name	Chave	Necessário	Tipo	Description
ID da Base de Dados	databaseId	True	string	O nome do banco de dados.
ID da coleção	collectionId	True	string	O nome da coleção.
Valor da chave de partição	x-ms-documentdb-raw-partitionkey		string	O valor da chave de partição para o documento solicitado ou operação de anexo.
Sproc ID	sprocId	True	string	O nome do procedimento armazenado.
Parâmetros para o procedimento armazenado	parameters		string	Especifique JSON válido para os parâmetros do procedimento armazenado, por exemplo, ["param1", "param2"].
Versão da API	x-ms-version		string	Versão da API.

Devoluções

response

ObjectWithoutType

Obter procedimentos armazenados (V2)

ID da Operação:

GetStoredProcedures_V2

Obtenha procedimentos armazenados na coleção especificada (V2).

Parâmetros

Name	Chave	Necessário	Tipo	Description
Nome da conta do Azure Cosmos DB	cosmosDbAccountName	True	string	O nome da conta do Azure Cosmos DB (sem documents.azure.com).
ID da Base de Dados	databaseId	True	string	O nome do banco de dados.
ID da coleção	collectionId	True	string	O nome da coleção.
Versão da API	x-ms-version		string	Versão da API.

Devoluções

Body

getStoredProceduresResponse

Obter procedimentos armazenados [DEPRECATED]

ID da Operação:

GetStoredProcedures

Esta ação foi preterida. Em vez disso, use Obter procedimentos armazenados (V2).

Obtenha procedimentos armazenados na coleção especificada.

Parâmetros

Name	Chave	Necessário	Tipo	Description
ID da Base de Dados	databaseId	True	string	O nome do banco de dados.
ID da coleção	collectionId	True	string	O nome da coleção.
Versão da API	x-ms-version		string	Versão da API.

Devoluções

Body

getStoredProceduresResponse

Obter todos os documentos (V3)

ID da Operação:

GetDocuments_V3

Obter todos os documentos (V3).

Parâmetros

Name	Chave	Necessário	Tipo	Description
Valor da chave de partição	x-ms-documentdb-raw-partitionkey		string	O valor da chave de partição para o documento solicitado ou operação de anexo.
Contagem máxima de itens	x-ms-max-item-count		number	Um inteiro que indica o número máximo de itens a serem retornados por página.
Token de continuação	x-ms-continuation		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.
Nível de consistência	x-ms-consistency-level		string	Esta é a substituição do nível de consistência. Os valores válidos são: Forte, Limitado, Sessão ou Eventual (na ordem do mais forte para o mais fraco).
Token de sessão	x-ms-session-token		string	Um token de cadeia de caracteres usado com consistência de nível de sessão.
ID da atividade	x-ms-activity-id		string	Um identificador fornecido pelo cliente para a operação, que será ecoado na resposta do servidor.
Nome da conta do Azure Cosmos DB	cosmosDbAccountName	True	string	O nome da conta do Azure Cosmos DB (sem documents.azure.com).
ID da Base de Dados	databaseId	True	string	O nome do banco de dados.
ID da coleção	collectionId	True	string	O nome da coleção.
Versão da API	x-ms-version		string	Versão da API.

Devoluções

Body

getDocumentsResponse

Obter todos os documentos [DEPRECATED]

ID da Operação:

GetDocuments

Esta ação foi preterida. Em vez disso, use Obter todos os documentos (V3).

Obtenha todos os documentos.

Parâmetros

Name	Chave	Necessário	Tipo	Description
Valor da chave de partição	x-ms-documentdb-raw-partitionkey		string	O valor da chave de partição para o documento solicitado ou operação de anexo.
Contagem máxima de itens	x-ms-max-item-count		number	Um inteiro que indica o número máximo de itens a serem retornados por página.
Token de continuação	x-ms-continuation		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.
Nível de consistência	x-ms-consistency-level		string	Esta é a substituição do nível de consistência. Os valores válidos são: Forte, Limitado, Sessão ou Eventual (na ordem do mais forte para o mais fraco).
Token de sessão	x-ms-session-token		string	Um token de cadeia de caracteres usado com consistência de nível de sessão.
ID da atividade	x-ms-activity-id		string	Um identificador fornecido pelo cliente para a operação, que será ecoado na resposta do servidor.
ID da Base de Dados	databaseId	True	string	O nome do banco de dados.
ID da coleção	collectionId	True	string	O nome da coleção.
Versão da API	x-ms-version		string	Versão da API.

Devoluções

Body

getDocumentsResponse

Obter todos os documentos V2 [DEPRECATED]

ID da Operação:

GetDocumentsV2

Esta ação foi preterida. Em vez disso, use Obter todos os documentos (V3).

Obtenha todos os documentos V2.

Parâmetros

Name	Chave	Necessário	Tipo	Description
ID da Base de Dados	databaseId	True	string	O nome do banco de dados.
ID da coleção	collectionId	True	string	O nome da coleção.
Valor da chave de partição	partitionKey		string	Se estiverem vazias, todas as partições serão usadas para procurar documentos.
Contagem máxima de itens	maxItemCount		integer	Um inteiro que indica o número máximo de itens a serem retornados por página.
Token de continuação	continuationToken		string	Um token para obter resultados adicionais.
Nível de consistência	consistencyLevel		string	Nível de consistência necessário para a operação de feed (feed de consulta/leitura).
Token de sessão	sessionToken		string	O token de sessão para uso com consistência de sessão.

Devoluções

Matriz de documentos que correspondem à consulta solicitada e aos metadados relacionados.

Body

DocumentsCollection

Obter um documento (V2)

ID da Operação:

GetDocument_V2

Obter um documento (V2).

Parâmetros

Name	Chave	Necessário	Tipo	Description
Valor da chave de partição	x-ms-documentdb-raw-partitionkey		string	O valor da chave de partição para o documento solicitado ou operação de anexo.
Contagem máxima de itens	x-ms-max-item-count		number	Um inteiro que indica o número máximo de itens a serem retornados por página.
Token de continuação	x-ms-continuation		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.
Nível de consistência	x-ms-consistency-level		string	Esta é a substituição do nível de consistência. Os valores válidos são: Forte, Limitado, Sessão ou Eventual (na ordem do mais forte para o mais fraco).
Token de sessão	x-ms-session-token		string	Um token de cadeia de caracteres usado com consistência de nível de sessão.
ID da atividade	x-ms-activity-id		string	Um identificador fornecido pelo cliente para a operação, que será ecoado na resposta do servidor.
Nome da conta do Azure Cosmos DB	cosmosDbAccountName	True	string	O nome da conta do Azure Cosmos DB (sem documents.azure.com).
ID da Base de Dados	databaseId	True	string	O nome do banco de dados.
ID da coleção	collectionId	True	string	O nome da coleção.
ID do documento	documentId	True	string	O identificador do documento.
Versão da API	x-ms-version		string	Versão da API.

Devoluções

response

object

Obter um documento [DEPRECATED]

ID da Operação:

GetDocument

Esta ação foi preterida. Em vez disso, utilize Obter um documento (V2).

Obtenha um documento.

Parâmetros

Name	Chave	Necessário	Tipo	Description
Valor da chave de partição	x-ms-documentdb-raw-partitionkey		string	O valor da chave de partição para o documento solicitado ou operação de anexo.
Contagem máxima de itens	x-ms-max-item-count		number	Um inteiro que indica o número máximo de itens a serem retornados por página.
Token de continuação	x-ms-continuation		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.
Nível de consistência	x-ms-consistency-level		string	Esta é a substituição do nível de consistência. Os valores válidos são: Forte, Limitado, Sessão ou Eventual (na ordem do mais forte para o mais fraco).
Token de sessão	x-ms-session-token		string	Um token de cadeia de caracteres usado com consistência de nível de sessão.
ID da atividade	x-ms-activity-id		string	Um identificador fornecido pelo cliente para a operação, que será ecoado na resposta do servidor.
ID da Base de Dados	databaseId	True	string	O nome do banco de dados.
ID da coleção	collectionId	True	string	O nome da coleção.
ID do documento	documentId	True	string	O identificador do documento.
Versão da API	x-ms-version		string	Versão da API.

Devoluções

response

object

Substituir procedimento armazenado (V2)

ID da Operação:

ReplaceStoredProcedure_V2

Substitua o procedimento armazenado (V2).

Parâmetros

Name	Chave	Necessário	Tipo	Description
Nome da conta do Azure Cosmos DB	cosmosDbAccountName	True	string	O nome da conta do Azure Cosmos DB (sem documents.azure.com).
ID da Base de Dados	databaseId	True	string	O nome do banco de dados.
ID da coleção	collectionId	True	string	O nome da coleção.
Sproc ID	sprocId	True	string	O nome do procedimento armazenado.
Definição de função	body		string	Função que define o procedimento armazenado, por exemplo, 'function(params){ ... }'
id	id		string	Id do procedimento armazenado existente.
Versão da API	x-ms-version		string	Versão da API.

Devoluções

Body

createStoredProcedureResponse

Substituir procedimento armazenado [DEPRECATED]

ID da Operação:

ReplaceStoredProcedure

Esta ação foi preterida. Em vez disso, use Substituir procedimento armazenado (V2).

Substitua o procedimento armazenado.

Parâmetros

Name	Chave	Necessário	Tipo	Description
ID da Base de Dados	databaseId	True	string	O nome do banco de dados.
ID da coleção	collectionId	True	string	O nome da coleção.
Sproc ID	sprocId	True	string	O nome do procedimento armazenado.
Definição de função	body		string	Função que define o procedimento armazenado, por exemplo, 'function(params){ ... }'
id	id		string	Id do procedimento armazenado existente.
Versão da API	x-ms-version		string	Versão da API.

Devoluções

Body

createStoredProcedureResponse

Substituir um documento (V2)

ID da Operação:

ReplaceDocument_V2

Substitua um documento (V2).

Parâmetros

Name	Chave	Necessário	Tipo	Description
Valor da chave de partição	x-ms-documentdb-raw-partitionkey		string	O valor da chave de partição para o documento solicitado ou operação de anexo.
Contagem máxima de itens	x-ms-max-item-count		number	Um inteiro que indica o número máximo de itens a serem retornados por página.
Token de continuação	x-ms-continuation		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.
Nível de consistência	x-ms-consistency-level		string	Esta é a substituição do nível de consistência. Os valores válidos são: Forte, Limitado, Sessão ou Eventual (na ordem do mais forte para o mais fraco).
Token de sessão	x-ms-session-token		string	Um token de cadeia de caracteres usado com consistência de nível de sessão.
ID da atividade	x-ms-activity-id		string	Um identificador fornecido pelo cliente para a operação, que será ecoado na resposta do servidor.
Pré-Gatilho	x-ms-documentdb-pre-trigger-include		string	Lista separada por vírgulas de nomes de gatilho a serem executados antes que a operação de documento seja executada.
Pós-Gatilho	x-ms-documentdb-post-trigger-include		string	Lista separada por vírgulas de nomes de gatilho a serem executados após a execução da operação de documento.
Nome da conta do Azure Cosmos DB	cosmosDbAccountName	True	string	O nome da conta do Azure Cosmos DB (sem documents.azure.com).
ID da Base de Dados	databaseId	True	string	O nome do banco de dados.
ID da coleção	collectionId	True	string	O nome da coleção.
ID do documento	documentId	True	string	O identificador do documento.
Versão da API	x-ms-version		string	Versão da API.

Devoluções

Body

putDocumentResponse

Substituir um documento [DEPRECATED]

ID da Operação:

ReplaceDocument

Esta ação foi preterida. Em vez disso, use Substituir um documento (V2).

Substitua um documento.

Parâmetros

Name	Chave	Necessário	Tipo	Description
Valor da chave de partição	x-ms-documentdb-raw-partitionkey		string	O valor da chave de partição para o documento solicitado ou operação de anexo.
Contagem máxima de itens	x-ms-max-item-count		number	Um inteiro que indica o número máximo de itens a serem retornados por página.
Token de continuação	x-ms-continuation		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.
Nível de consistência	x-ms-consistency-level		string	Esta é a substituição do nível de consistência. Os valores válidos são: Forte, Limitado, Sessão ou Eventual (na ordem do mais forte para o mais fraco).
Token de sessão	x-ms-session-token		string	Um token de cadeia de caracteres usado com consistência de nível de sessão.
ID da atividade	x-ms-activity-id		string	Um identificador fornecido pelo cliente para a operação, que será ecoado na resposta do servidor.
Pré-Gatilho	x-ms-documentdb-pre-trigger-include		string	Lista separada por vírgulas de nomes de gatilho a serem executados antes que a operação de documento seja executada.
Pós-Gatilho	x-ms-documentdb-post-trigger-include		string	Lista separada por vírgulas de nomes de gatilho a serem executados após a execução da operação de documento.
ID da Base de Dados	databaseId	True	string	O nome do banco de dados.
ID da coleção	collectionId	True	string	O nome da coleção.
ID do documento	documentId	True	string	O identificador do documento.
Versão da API	x-ms-version		string	Versão da API.

Devoluções

Body

putDocumentResponse

Definições

QueryDocumentsResponse

Matriz de documentos que correspondem à consulta solicitada e aos metadados relacionados.

Name	Caminho	Tipo	Description
Documents	Documents	array of ObjectWithoutType	Matriz de documentos que correspondem à solicitação.
Número de documentos	_count	integer	Número de documentos.
ID da atividade	ActivityId	string	ID de atividade do serviço Azure Cosmos DB.

DocumentsCollection

Matriz de documentos que correspondem à consulta solicitada e aos metadados relacionados.

Name	Caminho	Tipo	Description
Documents	value	array of ObjectWithoutType
Token de continuação	ContinuationToken	string
Número de documentos	Count	integer
Solicitar Cobrança	RequestCharge	double
Token de sessão	SessionToken	string
ID da atividade	ActivityId	string

postDocumentosResposta

Name	Caminho	Tipo	Description
_rid	_rid	string
_ts	_ts	integer
_self	_self	string
_etag	_etag	string
_attachments	_attachments	string
id	id	string

putDocumentResponse

Name	Caminho	Tipo	Description
_rid	_rid	string
id	id	string

getDocumentsResponse

Name	Caminho	Tipo	Description
_rid	_rid	string
Documents	Documents	array of object

queryResponse

Name	Caminho	Tipo	Description
_rid	_rid	string
_count	_count	number
Documents	Documents	array of

getStoredProceduresResponse

Name	Caminho	Tipo	Description
_count	_count	integer	_count
_rid	_rid	string	_rid
StoredProcedures	StoredProcedures	array of object	StoredProcedures
_etag	StoredProcedures._etag	string	_etag
_rid	StoredProcedures._rid	string	_rid
_self	StoredProcedures._self	string	_self
_ts	StoredProcedures._ts	integer	_ts
body	StoredProcedures.body	string	body
id	StoredProcedures.id	string	id

createStoredProcedureResponse

Name	Caminho	Tipo	Description
_etag	_etag	string	_etag
_rid	_rid	string	_rid
_self	_self	string	_self
_ts	_ts	integer	_ts
body	body	string	body
id	id	string	id

ObjectWithoutType

cadeia (de caracteres)

Este é o tipo de dados básico 'string'.

objecto

Este é o tipo 'objeto'.