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.
Esse conector está disponível nos seguintes produtos e regiões:
| Service | Class | Regions |
|---|---|---|
| Copilot Studio | Premium | Todas as regiões do Power Automate |
| Aplicativos Lógicos | Standard | Todas as regiões de Aplicativos Lógicos |
| Power Apps | - | Não disponível |
| Power Automate | Premium | Todas as regiões do Power Automate |
| Metadados do conector | |
|---|---|
| Publicador | 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 da API do Mongo DB não têm suporte no momento.
Depois que a conta da API do 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 criar uma conexão de Access Key tipo. Essa ID de conta também é necessária para versões de operação mais recentes que dão suporte à autenticação da ID do Microsoft Entra.
Autenticação do Microsoft Entra ID e conector do Cosmos DB
Para usar a autenticação da ID do Microsoft Entra, a conta que está sendo usada precisa receber uma atribuição de função específica, para obter mais informações, visite Configurar o controle de acesso baseado em função com a ID do Microsoft Entra para sua conta do Azure Cosmos DB.
Observação
Somente as funções definidas explicitamente para acesso a dados permitem que uma entidade de segurança acesse os dados do Cosmos DB. Funções internas, como Owner, ou Contributornão fornecem acesso aos dados do Cosmos DB dentro dessa conta por meio da ID do Microsoft Entra. Há 2 funções internas expostas pelo Azure Cosmos DB:
-
Cosmos DB Built-in Data Reader(ID da definição de00000000-0000-0000-0000-000000000001função) -
Cosmos DB Built-in Data Contributor(ID da definição de00000000-0000-0000-0000-000000000002função)
As funções podem ser atribuídas de várias maneiras e funções personalizadas podem ser criadas para acesso mais granular.
Aqui está um exemplo sobre quem atribuir Cosmos DB Built-in Data Reader por meio do 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 dá suporte a nenhum tipo de operações de gerenciamento com a autenticação de ID do Microsoft Entra (documentada aqui). As seguintes operações funcionarão apenas com Access Key conexões:
- Criar procedimento armazenado (versões V1 e V2)
- Excluir procedimento armazenado (versões V1 e V2)
- Atualizar o procedimento armazenado (versões V1 e V2)
Operações sem suporte com a autenticação da ID do Microsoft Entra
Ao usar a autenticação da ID do Microsoft Entra , há suporte apenas para ações com o nome da conta do Cosmos DB como parâmetro. As ações preteridas continuarão a funcionar com Access Key a autenticação, mas falharão se forem usadas com uma conexão de ID do Microsoft Entra.
Problemas e limitações conhecidos
O tamanho máximo de um documento compatível com o conector do DocumentDB (Azure Cosmos DB) é de 2 MB.
As limitações do Azure Cosmos DB estão documentadas aqui.
Não há suporte para escolher uma região de gravação e várias regiões de gravação pelo conector.
O "valor da chave de partição" deve ser fornecido de acordo com 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: "valor da cadeia de caracteres",123, 0,5.
O "valor da chave de partição" é necessário para consultas com
ORDER BY,DISTINCTetc, que são executadas em coleções particionadas.Consultar documentos V2 [PRETERIDO], Consultar documentos V3, Obter todos os documentos V2 (versão prévia) ações usa o SDK do .NET do Azure Cosmos DB para API do SQL (versão 2.13.1).
A ação consultar documentos V4 (versão prévia) usa o SDK do .NET do Azure Cosmos DB para a API do SQL (versão 3.15.0).
A ação de documentos de consulta (V5) (versão prévia) usa o SDK do .NET do Azure Cosmos DB para a API do SQL (versão 3.20.0).
O valor do parâmetro "Contagem Máxima de Itens" pode ser qualquer número de 1 a 1000. Qualquer número fora desse intervalo será convertido implicitamente em "-1", o que informa o serviço do Cosmos DB para determinar a contagem de itens ideal.
Se deixado vazio, as operações a seguir funcionarão apenas com documentos que não têm um valor de chave de partição. Itens com um valor de chave de partição serão excluídos dessas ações.
Devido ao Azure Cosmos DB não dar suporte a nenhum tipo de operações de gerenciamento com a autenticação de ID do Microsoft Entra (documentada aqui), a operação Executar procedimento armazenado (V2) (versão prévia) exibirá apenas os procedimentos armazenados disponíveis (para o
SprocIdparâmetro) ao usar umaAccess Keyconexão baseada.TokenAutenticações baseadas (autenticações de ID do Microsoft Entra) mostrarão uma lista vazia e devemsprocIdser inseridas manualmente como um valor personalizado.
Importante
As conexões integradas à ID do Microsoft Entra (Azure Commercial) são desabilitadas em ambientes do GCC (Governo dos EUA) 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 do Power Platform por um administrador de locatários.
Ativar essa configuração permite conexões com recursos no Azure Commercial que operam e enviam dados fora do limite de conformidade do Governo dos EUA da Power Platform. Isso é usado especificamente para permitir o acesso a recursos comerciais de versões da nuvem GCC de Conectores do Power Platform.
O Microsoft Entra ID Integrado (Azure Commercial) é o único tipo de autenticação que funciona 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 Azure Comercial no centro de administração do Power Platform: 
Criando uma conexão
O conector dá suporte aos 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 Governo do Azure e o Departamento de Defesa (DoD) no Azure Governamental e no Governo dos EUA (GCC) e no Governo dos EUA (GCC-High) | Compartilhável |
| Chave de Acesso (Azure Governamental) | Forneça o nome da conta e a chave de acesso para acessar sua conta do Cosmos DB. | Governo do Azure e Departamento de Defesa (DoD) no Azure Governamental e governo dos EUA (GCC) e governo dos EUA (GCC-High) somente | Compartilhável |
| Identidades gerenciadas de Aplicativos Lógicos | Criar uma conexão usando uma Identidade Gerenciada do LogicApps | Somente LOGICAPPS | Compartilhável |
| Microsoft Entra ID Integrado | Use a ID do Microsoft Entra para acessar o armazenamento de Blobs do Azure. | Todas as regiões, exceto o Governo do Azure e o Departamento de Defesa (DoD) no Azure Governamental e no Governo dos EUA (GCC) e no Governo dos EUA (GCC-High) | Não compartilhável |
| Microsoft Entra ID Integrada (Comercial do Azure) | Use a ID do Microsoft Entra para acessar o Armazenamento de Blobs do Azure no Azure Commercial. | Somente governo dos EUA (GCC) | Não compartilhável |
| Microsoft Entra ID Integrada (Azure Government) | Use a ID do Microsoft Entra para acessar o armazenamento de Blobs do Azure. | Governo do Azure e Departamento de Defesa (DoD) no Azure Governamental e governo dos EUA (GCC) e governo dos EUA (GCC-High) somente | Não compartilhável |
| Padrão [PRETERIDO] | Essa 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 |
Chave de Acesso
ID de autenticação: keyBasedAuth
Aplicável: todas as regiões, exceto o Governo do Azure e o Departamento de Defesa (DoD) no Azure Governamental e no Governo dos EUA (GCC) e no Governo dos EUA (GCC-High)
Forneça o nome da conta e a chave de acesso para acessar sua conta do Cosmos DB.
Essa é 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 dos Conectores para aplicativos de tela – Power Apps | Microsoft Docs
| Nome | Tipo | Description | Obrigatório |
|---|---|---|---|
| AccountID | cadeia | Nome da conta sem a 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 Governamental)
ID de autenticação: keyBasedAuth
Aplicável: Azure Governamental e Departamento de Defesa (DoD) somente no Azure Governamental e no Governo dos EUA (GCC) e governo dos EUA (GCC-High)
Forneça o nome da conta e a chave de acesso para acessar sua conta do Cosmos DB.
Essa é 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 dos Conectores para aplicativos de tela – Power Apps | Microsoft Docs
| Nome | Tipo | Description | Obrigatório |
|---|---|---|---|
| AccountID | cadeia | Nome da conta sem a 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: somente LOGICAPPS
Criar uma conexão usando uma Identidade Gerenciada do LogicApps
Essa é 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 dos Conectores para aplicativos de tela – Power Apps | Microsoft Docs
| Nome | Tipo | Description | Obrigatório |
|---|---|---|---|
| Identidade Gerenciada do LogicApps | managedIdentity | Entrar com uma identidade gerenciada de aplicativos lógicos | Verdade |
Microsoft Entra ID Integrado
ID de autenticação: tokenBasedAuth
Aplicável: todas as regiões, exceto o Governo do Azure e o Departamento de Defesa (DoD) no Azure Governamental e no Governo dos EUA (GCC) e no Governo dos EUA (GCC-High)
Use a ID do Microsoft Entra para acessar o armazenamento de Blobs do Azure.
Essa não é uma conexão compartilhável. Se o aplicativo de energia for compartilhado com outro usuário, outro usuário será solicitado a criar uma nova conexão explicitamente.
Microsoft Entra ID Integrada (Comercial do Azure)
ID de autenticação: oauthCom
Aplicável: somente governo dos EUA (GCC)
Use a ID do Microsoft Entra para acessar o Armazenamento de Blobs do Azure no Azure Commercial.
Essa não é uma conexão compartilhável. Se o aplicativo de energia for compartilhado com outro usuário, outro usuário será solicitado a criar uma nova conexão explicitamente.
Microsoft Entra ID Integrada (Azure Government)
ID de autenticação: tokenBasedAuth
Aplicável: Azure Governamental e Departamento de Defesa (DoD) somente no Azure Governamental e no Governo dos EUA (GCC) e governo dos EUA (GCC-High)
Use a ID do Microsoft Entra para acessar o armazenamento de Blobs do Azure.
Essa não é uma conexão compartilhável. Se o aplicativo de energia for compartilhado com outro usuário, outro usuário será solicitado a criar uma nova conexão explicitamente.
Padrão [PRETERIDO]
Aplicável: todas as regiões
Essa 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.
Essa não é uma conexão compartilhável. Se o aplicativo de energia for compartilhado com outro usuário, outro usuário será solicitado a criar uma nova conexão explicitamente.
| Nome | Tipo | Description | Obrigatório |
|---|---|---|---|
| AccountID | cadeia | Nome da conta sem a parte 'documents.azure.com' | Verdade |
| Chave de Acesso à sua conta do Azure Cosmos DB | secureString | Chave Primária ou Secundária | Verdade |
Limitações
| Nome | Chamadas | Período de renovação |
|---|---|---|
| Chamadas à API por conexão | 1500 | 60 segundos |
Ações
| Consultar documentos [PRETERIDO] |
Esta ação foi preterida. Em vez disso, use documentos de consulta V5 .
|
| Consultar documentos V2 [PRETERIDO] |
Esta ação foi preterida. Em vez disso, use documentos de consulta V5 .
|
| Consultar documentos V3 [PRETERIDO] |
Esta ação foi preterida. Em vez disso, use documentos de consulta V5 .
|
| Consultar documentos V4 [PRETERIDO] |
Esta ação foi preterida. Em vez disso, use documentos de consulta V5 .
|
| Consultar documentos V5 |
Consultar documentos (V5). |
| Criar ou atualizar documento (V2) [PRETERIDO] |
Esta ação foi preterida. Em vez disso, use Criar ou atualizar documento (V3 ).
|
| Criar ou atualizar documento (V3) |
Criar ou atualizar documento. Ao criar um documento no DocumentDB, o corpo deve incluir uma propriedade de ID. |
| Criar ou atualizar documento [PRETERIDO] |
Esta ação foi preterida. Em vez disso, use Criar ou atualizar documento (V3 ).
|
| Criar procedimento armazenado (V2) |
Criar procedimento armazenado (V2). |
| Criar procedimento armazenado [PRETERIDO] |
Esta ação foi preterida. Em vez disso, use Criar procedimento armazenado (V2 ).
|
| Excluir procedimento armazenado (V2) |
Excluir procedimento armazenado (V2). |
| Excluir procedimento armazenado [PRETERIDO] |
Esta ação foi preterida. Em vez disso, use Excluir procedimento armazenado (V2 ).
|
| Excluir um documento (V2) |
Excluir um documento (V2). |
| Excluir um documento [PRETERIDO] |
Esta ação foi preterida. Em vez disso, use Excluir um documento (V2 ).
|
| Executar procedimento armazenado (V2) |
Execute o procedimento armazenado na coleção especificada (V2). |
| Executar procedimento armazenado [PRETERIDO] |
Esta ação foi preterida. Em vez disso, use Executar procedimento armazenado (V2 ).
|
| Obter procedimentos armazenados (V2) |
Obter procedimentos armazenados na coleção especificada (V2). |
| Obter procedimentos armazenados [PRETERIDO] |
Esta ação foi preterida. Em vez disso, use Obter procedimentos armazenados (V2 ).
|
| Obter todos os documentos (V3) |
Obter todos os documentos (V3). |
| Obter todos os documentos [PRETERIDO] |
Esta ação foi preterida. Em vez disso, use Obter todos os documentos (V3 ).
|
| Obter todos os documentos V2 [PRETERIDO] |
Esta ação foi preterida. Em vez disso, use Obter todos os documentos (V3 ).
|
| Obter um documento (V2) |
Obtenha um documento (V2). |
| Obter um documento [PRETERIDO] |
Esta ação foi preterida. Em vez disso, use Obter um documento (V2 ).
|
| Substituir o procedimento armazenado [PRETERIDO] |
Esta ação foi preterida. Em vez disso, use Substituir procedimento armazenado (V2 ).
|
| Substituir procedimento armazenado (V2) |
Substitua o procedimento armazenado (V2). |
| Substituir um documento (V2) |
Substitua um documento (V2). |
| Substituir um documento [PRETERIDO] |
Esta ação foi preterida. Em vez disso, use Substituir um documento (V2 ).
|
Consultar documentos [PRETERIDO]
Esta ação foi preterida. Em vez disso, use documentos de consulta V5 .
Consultar documentos.
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
Valor da chave de partição
|
x-ms-documentdb-raw-partitionkey | string |
O valor da chave de partição para a operação de anexo ou documento solicitado. |
|
|
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 feed de leitura se houver mais resultados a serem lidos. |
|
|
Habilitar 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 |
Essa é a substituição do nível de consistência. Os valores válidos são: Strong, Bounded, Session ou Eventual (em ordem de mais forte a mais fraca). |
|
|
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 do banco 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 |
Retornos
- Corpo
- queryResponse
Consultar documentos V2 [PRETERIDO]
Esta ação foi preterida. Em vez disso, use documentos de consulta V5 .
Consultar documentos V2.
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
ID do banco de dados
|
databaseId | True | string |
O nome do banco de dados. |
|
ID da coleção
|
collectionId | True | string |
O nome da coleção. |
|
QueryText
|
QueryText | string |
Consulta de sintaxe do SQL em documentos |
|
|
Valor da chave de partição
|
partitionKey | string |
Valor da chave de partição. |
|
|
Token de continuação
|
continuationToken | string |
Um token para buscar resultados adicionais da operação. |
Retornos
Matriz de documentos que correspondem à consulta solicitada e aos metadados relacionados.
- Corpo
- QueryDocumentsResponse
Consultar documentos V3 [PRETERIDO]
Esta ação foi preterida. Em vez disso, use documentos de consulta V5 .
Consultar documentos V3.
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
ID do banco 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 DO 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 pesquisar 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 buscar resultados adicionais. |
|
|
Habilitar 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 feed (feed de consulta/leitura). |
|
|
Token de sessão
|
sessionToken | string |
O token de sessão para uso com consistência de sessão. |
Retornos
Matriz de documentos que correspondem à consulta solicitada e aos metadados relacionados.
- Corpo
- DocumentsCollection
Consultar documentos V4 [PRETERIDO]
Esta ação foi preterida. Em vez disso, use documentos de consulta V5 .
Consultar documentos V4.
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
ID do banco 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 DO SQL
|
queryText | string |
Consulta SQL. Se estiver vazio, retornará todos os documentos. |
|
|
Valor da chave de partição
|
partitionKey | string |
Se estiverem vazias, todas as partições serão usadas para pesquisar 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 buscar resultados adicionais. |
|
|
Nível de consistência
|
consistencyLevel | string |
Nível de consistência necessário para a operação feed (feed de consulta/leitura). |
|
|
Token de sessão
|
sessionToken | string |
O token de sessão para uso com consistência de sessão. |
Retornos
Matriz de documentos que correspondem à consulta solicitada e aos metadados relacionados.
- Corpo
- DocumentsCollection
Consultar documentos V5
Consultar documentos (V5).
Parâmetros
| Nome | Chave | Obrigató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 do banco 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 DO SQL
|
queryText | string |
Consulta SQL. Se estiver vazio, retornará todos os documentos. |
|
|
Valor da chave de partição
|
partitionKey | string |
O valor deve ser fornecido de acordo com seu tipo ("string", 42, 0,5). Se estiverem vazias, todas as partições serão usadas para pesquisar 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 buscar resultados adicionais. |
|
|
Nível de consistência
|
consistencyLevel | string |
Nível de consistência necessário para a operação feed (feed de consulta/leitura). |
|
|
Token de sessão
|
sessionToken | string |
O token de sessão para uso com consistência de sessão. |
Retornos
Matriz de documentos que correspondem à consulta solicitada e aos metadados relacionados.
- Corpo
- DocumentsCollection
Criar ou atualizar documento (V2) [PRETERIDO]
Esta ação foi preterida. Em vez disso, use Criar ou atualizar documento (V3 ).
Criar ou atualizar documento. Ao criar um documento no DocumentDB, o corpo deve incluir uma propriedade de ID.
Parâmetros
| Nome | Chave | Obrigató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 feed de leitura se houver mais resultados a serem lidos. |
|
|
Nível de consistência
|
x-ms-consistency-level | string |
Essa é a substituição do nível de consistência. Os valores válidos são: Strong, Bounded, Session ou Eventual (em ordem de mais forte a mais fraca). |
|
|
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 outra opção criada. |
|
|
Pré-gatilho
|
x-ms-documentdb-pre-trigger-include | string |
Lista separada por vírgulas de nomes de gatilho a serem executados antes da operação do documento ser 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 do banco 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. |
Retornos
- Corpo
- postDocumentsResponse
Criar ou atualizar documento (V3)
Criar ou atualizar documento. Ao criar um documento no DocumentDB, o corpo deve incluir uma propriedade de ID.
Parâmetros
| Nome | Chave | Obrigató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 feed de leitura se houver mais resultados a serem lidos. |
|
|
Nível de consistência
|
x-ms-consistency-level | string |
Essa é a substituição do nível de consistência. Os valores válidos são: Strong, Bounded, Session ou Eventual (em ordem de mais forte a mais fraca). |
|
|
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 outra opção criada. |
|
|
Pré-gatilho
|
x-ms-documentdb-pre-trigger-include | string |
Lista separada por vírgulas de nomes de gatilho a serem executados antes da operação do documento ser 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 do banco 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. |
Retornos
- Corpo
- postDocumentsResponse
Criar ou atualizar documento [PRETERIDO]
Esta ação foi preterida. Em vez disso, use Criar ou atualizar documento (V3 ).
Criar ou atualizar documento. Ao criar um documento no DocumentDB, o corpo deve incluir uma propriedade de ID.
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
Valor da chave de partição
|
x-ms-documentdb-raw-partitionkey | string |
O valor da chave de partição para a operação de anexo ou documento solicitado. |
|
|
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 feed de leitura se houver mais resultados a serem lidos. |
|
|
Nível de consistência
|
x-ms-consistency-level | string |
Essa é a substituição do nível de consistência. Os valores válidos são: Strong, Bounded, Session ou Eventual (em ordem de mais forte a mais fraca). |
|
|
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 outra opção criada. |
|
|
Pré-gatilho
|
x-ms-documentdb-pre-trigger-include | string |
Lista separada por vírgulas de nomes de gatilho a serem executados antes da operação do documento ser 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 do banco 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. |
Retornos
- Corpo
- postDocumentsResponse
Criar procedimento armazenado (V2)
Criar procedimento armazenado (V2).
Parâmetros
| Nome | Chave | Obrigató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 do banco 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. |
Retornos
Criar procedimento armazenado [PRETERIDO]
Esta ação foi preterida. Em vez disso, use Criar procedimento armazenado (V2 ).
Criar procedimento armazenado.
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
ID do banco 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. |
Retornos
Excluir procedimento armazenado (V2)
Excluir procedimento armazenado (V2).
Parâmetros
| Nome | Chave | Obrigató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 do banco 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. |
Retornos
- response
- string
Excluir procedimento armazenado [PRETERIDO]
Esta ação foi preterida. Em vez disso, use Excluir procedimento armazenado (V2 ).
Excluir procedimento armazenado.
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
ID do banco 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. |
Retornos
- response
- string
Excluir um documento (V2)
Excluir um documento (V2).
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
Valor da chave de partição
|
x-ms-documentdb-raw-partitionkey | string |
O valor da chave de partição para a operação de anexo ou documento solicitado. |
|
|
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 feed de leitura se houver mais resultados a serem lidos. |
|
|
Nível de consistência
|
x-ms-consistency-level | string |
Essa é a substituição do nível de consistência. Os valores válidos são: Strong, Bounded, Session ou Eventual (em ordem de mais forte a mais fraca). |
|
|
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 da operação do documento ser 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 do banco 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 um documento [PRETERIDO]
Esta ação foi preterida. Em vez disso, use Excluir um documento (V2 ).
Excluir um documento.
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
Valor da chave de partição
|
x-ms-documentdb-raw-partitionkey | string |
O valor da chave de partição para a operação de anexo ou documento solicitado. |
|
|
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 feed de leitura se houver mais resultados a serem lidos. |
|
|
Nível de consistência
|
x-ms-consistency-level | string |
Essa é a substituição do nível de consistência. Os valores válidos são: Strong, Bounded, Session ou Eventual (em ordem de mais forte a mais fraca). |
|
|
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 da operação do documento ser 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 do banco 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. |
Executar procedimento armazenado (V2)
Execute o procedimento armazenado na coleção especificada (V2).
Parâmetros
| Nome | Chave | Obrigató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 do banco 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 a operação de anexo ou documento solicitado. |
|
|
Sproc ID
|
sprocId | True | string |
O nome do procedimento armazenado. |
|
Parâmetros para o procedimento armazenado
|
parameters | string |
Especifique o 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. |
Retornos
- response
- ObjectWithoutType
Executar procedimento armazenado [PRETERIDO]
Esta ação foi preterida. Em vez disso, use Executar procedimento armazenado (V2 ).
Execute o procedimento armazenado na coleção especificada.
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
ID do banco 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 a operação de anexo ou documento solicitado. |
|
|
Sproc ID
|
sprocId | True | string |
O nome do procedimento armazenado. |
|
Parâmetros para o procedimento armazenado
|
parameters | string |
Especifique o 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. |
Retornos
- response
- ObjectWithoutType
Obter procedimentos armazenados (V2)
Obter procedimentos armazenados na coleção especificada (V2).
Parâmetros
| Nome | Chave | Obrigató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 do banco 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. |
Retornos
Obter procedimentos armazenados [PRETERIDO]
Esta ação foi preterida. Em vez disso, use Obter procedimentos armazenados (V2 ).
Obter procedimentos armazenados na coleção especificada.
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
ID do banco 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. |
Retornos
Obter todos os documentos (V3)
Obter todos os documentos (V3).
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
Valor da chave de partição
|
x-ms-documentdb-raw-partitionkey | string |
O valor da chave de partição para a operação de anexo ou documento solicitado. |
|
|
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 feed de leitura se houver mais resultados a serem lidos. |
|
|
Nível de consistência
|
x-ms-consistency-level | string |
Essa é a substituição do nível de consistência. Os valores válidos são: Strong, Bounded, Session ou Eventual (em ordem de mais forte a mais fraca). |
|
|
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 do banco 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. |
Retornos
- Corpo
- getDocumentsResponse
Obter todos os documentos [PRETERIDO]
Esta ação foi preterida. Em vez disso, use Obter todos os documentos (V3 ).
Obtenha todos os documentos.
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
Valor da chave de partição
|
x-ms-documentdb-raw-partitionkey | string |
O valor da chave de partição para a operação de anexo ou documento solicitado. |
|
|
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 feed de leitura se houver mais resultados a serem lidos. |
|
|
Nível de consistência
|
x-ms-consistency-level | string |
Essa é a substituição do nível de consistência. Os valores válidos são: Strong, Bounded, Session ou Eventual (em ordem de mais forte a mais fraca). |
|
|
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 do banco 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. |
Retornos
- Corpo
- getDocumentsResponse
Obter todos os documentos V2 [PRETERIDO]
Esta ação foi preterida. Em vez disso, use Obter todos os documentos (V3 ).
Obtenha todos os documentos V2.
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
ID do banco 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 pesquisar 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 buscar resultados adicionais. |
|
|
Nível de consistência
|
consistencyLevel | string |
Nível de consistência necessário para a operação feed (feed de consulta/leitura). |
|
|
Token de sessão
|
sessionToken | string |
O token de sessão para uso com consistência de sessão. |
Retornos
Matriz de documentos que correspondem à consulta solicitada e aos metadados relacionados.
- Corpo
- DocumentsCollection
Obter um documento (V2)
Obtenha um documento (V2).
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
Valor da chave de partição
|
x-ms-documentdb-raw-partitionkey | string |
O valor da chave de partição para a operação de anexo ou documento solicitado. |
|
|
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 feed de leitura se houver mais resultados a serem lidos. |
|
|
Nível de consistência
|
x-ms-consistency-level | string |
Essa é a substituição do nível de consistência. Os valores válidos são: Strong, Bounded, Session ou Eventual (em ordem de mais forte a mais fraca). |
|
|
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 do banco 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. |
Retornos
- response
- object
Obter um documento [PRETERIDO]
Esta ação foi preterida. Em vez disso, use Obter um documento (V2 ).
Obtenha um documento.
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
Valor da chave de partição
|
x-ms-documentdb-raw-partitionkey | string |
O valor da chave de partição para a operação de anexo ou documento solicitado. |
|
|
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 feed de leitura se houver mais resultados a serem lidos. |
|
|
Nível de consistência
|
x-ms-consistency-level | string |
Essa é a substituição do nível de consistência. Os valores válidos são: Strong, Bounded, Session ou Eventual (em ordem de mais forte a mais fraca). |
|
|
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 do banco 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. |
Retornos
- response
- object
Substituir o procedimento armazenado [PRETERIDO]
Esta ação foi preterida. Em vez disso, use Substituir procedimento armazenado (V2 ).
Substitua o procedimento armazenado.
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
ID do banco 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. |
Retornos
Substituir procedimento armazenado (V2)
Substitua o procedimento armazenado (V2).
Parâmetros
| Nome | Chave | Obrigató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 do banco 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. |
Retornos
Substituir um documento (V2)
Substitua um documento (V2).
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
Valor da chave de partição
|
x-ms-documentdb-raw-partitionkey | string |
O valor da chave de partição para a operação de anexo ou documento solicitado. |
|
|
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 feed de leitura se houver mais resultados a serem lidos. |
|
|
Nível de consistência
|
x-ms-consistency-level | string |
Essa é a substituição do nível de consistência. Os valores válidos são: Strong, Bounded, Session ou Eventual (em ordem de mais forte a mais fraca). |
|
|
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 da operação do documento ser 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 do banco 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. |
Retornos
- Corpo
- putDocumentResponse
Substituir um documento [PRETERIDO]
Esta ação foi preterida. Em vez disso, use Substituir um documento (V2 ).
Substitua um documento.
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
Valor da chave de partição
|
x-ms-documentdb-raw-partitionkey | string |
O valor da chave de partição para a operação de anexo ou documento solicitado. |
|
|
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 feed de leitura se houver mais resultados a serem lidos. |
|
|
Nível de consistência
|
x-ms-consistency-level | string |
Essa é a substituição do nível de consistência. Os valores válidos são: Strong, Bounded, Session ou Eventual (em ordem de mais forte a mais fraca). |
|
|
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 da operação do documento ser 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 do banco 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. |
Retornos
- Corpo
- putDocumentResponse
Definições
QueryDocumentsResponse
Matriz de documentos que correspondem à consulta solicitada e aos metadados relacionados.
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
Documentos
|
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 da atividade de serviço do Azure Cosmos DB. |
DocumentsCollection
Matriz de documentos que correspondem à consulta solicitada e aos metadados relacionados.
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
Documentos
|
value | array of ObjectWithoutType | |
|
Token de continuação
|
ContinuationToken | string | |
|
Número de documentos
|
Count | integer | |
|
Cobrança de solicitação
|
RequestCharge | double | |
|
Token de sessão
|
SessionToken | string | |
|
ID da atividade
|
ActivityId | string |
postDocumentsResponse
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
_rid
|
_rid | string | |
|
_ts
|
_ts | integer | |
|
_eu
|
_self | string | |
|
_etag
|
_etag | string | |
|
_Anexos
|
_attachments | string | |
|
id
|
id | string |
putDocumentResponse
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
_rid
|
_rid | string | |
|
id
|
id | string |
getDocumentsResponse
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
_rid
|
_rid | string | |
|
Documentos
|
Documents | array of object |
queryResponse
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
_rid
|
_rid | string | |
|
_contar
|
_count | number | |
|
Documentos
|
Documents | array of |
getStoredProceduresResponse
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
_contar
|
_count | integer |
_contar |
|
_rid
|
_rid | string |
_rid |
|
Procedimentos armazenados
|
StoredProcedures | array of object |
Procedimentos armazenados |
|
_etag
|
StoredProcedures._etag | string |
_etag |
|
_rid
|
StoredProcedures._rid | string |
_rid |
|
_eu
|
StoredProcedures._self | string |
_eu |
|
_ts
|
StoredProcedures._ts | integer |
_ts |
|
body
|
StoredProcedures.body | string |
body |
|
id
|
StoredProcedures.id | string |
id |
createStoredProcedureResponse
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
_etag
|
_etag | string |
_etag |
|
_rid
|
_rid | string |
_rid |
|
_eu
|
_self | string |
_eu |
|
_ts
|
_ts | integer |
_ts |
|
body
|
body | string |
body |
|
id
|
id | string |
id |
ObjectWithoutType
cadeia
Esse é o tipo de dados básico 'string'.
objeto
Esse é o tipo 'object'.