@azure/cosmos package

Classes

AbortError	Esse erro é gerado quando uma operação assíncrona é anulada. Verifique se esse erro está testando o name de que a propriedade name do erro corresponde "AbortError"a . Exemplo const controller = new AbortController(); controller.abort(); try { doAsyncWork(controller.signal) } catch (e) { if (e.name === 'AbortError') { // handle abort error here. } }
ChangeFeedIterator	Fornece iterador para feed de alterações. Use Items.changeFeed() para obter uma instância do iterador.
ChangeFeedIteratorResponse	Uma única página de resposta do Feed de Alterações do Azure Cosmos DB
ChangeFeedResponse	Uma única página de resposta do Feed de Alterações do Azure Cosmos DB
ChangeFeedStartFrom	Classe base para onde iniciar um ChangeFeedIterator.
ClientSideMetrics
Conflict	Use para ler ou excluir um determinado Conflito por ID. Confira Conflitos para consultar ou ler todos os conflitos.
ConflictResponse
Conflicts	Use para consultar ou ler todos os conflitos. Confira Conflito para ler ou excluir um determinado Conflito por ID.
Container	Operações para ler, substituir ou excluir um contêiner existente específico por ID. Consulte Contêineres para criar novos contêineres e ler/consultar todos os contêineres; use .containers. Observação: todas essas operações fazem chamadas contra um orçamento fixo. Você deve projetar seu sistema de modo que essas chamadas sejam dimensionadas de forma sublinear com seu aplicativo. Por exemplo, não chame container(id).read() antes de cada item.read() chamada, para garantir que o contêiner exista; faça isso uma vez na inicialização do aplicativo.
ContainerResponse	Objeto de resposta para operações de contêiner
Containers	Operações para criar novos contêineres e ler/consultar todos os contêineres Consulte Contêiner para ler, substituir ou excluir um contêiner existente; use .container(id). Observação: todas essas operações fazem chamadas contra um orçamento fixo. Você deve projetar seu sistema de modo que essas chamadas sejam dimensionadas de forma sublinear com seu aplicativo. Por exemplo, não chame containers.readAll() antes de cada item.read() chamada, para garantir que o contêiner exista; faça isso uma vez na inicialização do aplicativo.
CosmosClient	Fornece uma representação lógica do lado do cliente da conta de banco de dados do Azure Cosmos DB. Esse cliente é usado para configurar e executar solicitações no serviço de banco de dados do Azure Cosmos DB. Exemplo Criar uma instância de um cliente e criar um novo banco de dados const client = new CosmosClient({endpoint: "<URL HERE>", auth: {masterKey: "<KEY HERE>"}}); await client.databases.create({id: "<datbase name here>"}); Exemplo Criar uma instância de um cliente com política de conexão personalizada const connectionPolicy = new ConnectionPolicy(); connectionPolicy.RequestTimeout = 10000; const client = new CosmosClient({ endpoint: "<URL HERE>", auth: {masterKey: "<KEY HERE>"}, connectionPolicy });
CosmosDiagnostics	Esse é um tipo de Diagnóstico do Cosmos que contém informações de diagnóstico coletadas durante operações de cliente. Ie. Item.read(), Container.create(). Ele tem três membros - clientSideRequestStatistics membro contém informações de diagnóstico agregadas, incluindo - pesquisas de metadados. Aqui, todas as solicitações de servidor, além do recurso final pretendido, são consideradas como chamadas de metadados. Ou seja, para item.read(id), se o cliente fizer uma chamada de servidor para descobrir pontos de extremidade, ele será considerado como uma chamada de metadados. retries pontos de extremidade contatados. estatísticas de conteúdo de solicitação e resposta. gatewayStatistics – informações correspondentes à operação de main. Por exemplo, durante Item.read(), o cliente pode executar muitas operações, ou seja, pesquisa de metadados etc. mas gatewayStatistics representa as informações de diagnóstico para a operação de leitura real. diagnosticNode – é uma árvore como estrutura que captura informações detalhadas de diagnóstico. Por padrão, ele está desabilitado e deve ser usado apenas para depuração em ambientes que não são de produção. O tipo de detalhes capturados no diagnosticNode é controlado por CosmosDbDiagnosticLevel. CosmosDbDiagnosticLevel.info – é o valor padrão. Nesse nível, somente clientSideRequestStatistics são capturados. É destinado a ambientes de produção. CosmosDbDiagnosticLevel.debug – captura diagnosticNode e clientConfig. Nenhum conteúdo de solicitação e resposta é capturado. Não deve ser usado no ambiente de produção. CosmosDbDiagnosticLevel.debug-unsafe – além dos dados capturados em CosmosDbDiagnosticLevel.debug, também captura cargas de solicitação e resposta. Não deve ser usado no ambiente de produção. clientConfig – captura informações relacionadas a como o cliente foi configurado durante a inicialização.
Database	Operações para ler ou excluir um banco de dados existente. Consulte Bancos de dados para criar novos bancos de dados e ler/consultar todos os bancos de dados; use client.databases. Observação: todas essas operações fazem chamadas contra um orçamento fixo. Você deve projetar seu sistema de modo que essas chamadas sejam dimensionadas de forma sublinear com seu aplicativo. Por exemplo, não chame database.read() antes de cada item.read() chamada, para garantir que o banco de dados exista; faça isso uma vez na inicialização do aplicativo.
DatabaseAccount	Representa uma DatabaseAccount no serviço de banco de dados do Azure Cosmos DB.
DatabaseResponse	Objeto response para operações de banco de dados
Databases	Operações para criar novos bancos de dados e ler/consultar todos os bancos de dados Consulte Banco de dados para ler ou excluir um banco de dados existente; use client.database(id). Observação: todas essas operações fazem chamadas contra um orçamento fixo. Você deve projetar seu sistema de modo que essas chamadas sejam dimensionadas de forma sublinear com seu aplicativo. Por exemplo, não chame databases.readAll() antes de cada item.read() chamada, para garantir que o banco de dados exista; faça isso uma vez na inicialização do aplicativo.
ErrorResponse
FeedRange	Especifica um intervalo de feed para o feed de alterações.
FeedResponse
Item	Usado para executar operações em um item específico. Consulte Itens para operações em todos os itens; consulte container.items.
ItemResponse
Items	Operações para criar novos itens e ler/consultar todos os itens Consulte Item para ler, substituir ou excluir um contêiner existente; use .item(id).
Offer	Use para ler ou substituir uma oferta existente por id. Consulte Ofertas para consultar ou ler todas as ofertas.
OfferResponse
Offers	Use para consultar ou ler todas as Ofertas. Consulte Oferta para ler ou substituir uma oferta existente por id.
PartitionKeyBuilder	Classe builder para criar PartitionKey.
Permission	Use para ler, substituir ou excluir uma determinada permissão por id. Consulte Permissões para criar, upsert, consultar ou ler todas as Permissões.
PermissionResponse
Permissions	Use para criar, substituir, consultar e ler todas as Permissões. Consulte Permissão para ler, substituir ou excluir uma permissão específica por id.
QueryIterator	Representa um objeto QueryIterator, uma implementação de feed ou resposta de consulta que permite a passagem e a iteração sobre a resposta no serviço de banco de dados do Azure Cosmos DB.
QueryMetrics
QueryPreparationTimes
ResourceResponse
RestError	Um tipo de erro personalizado para solicitações de pipeline com falha.
RuntimeExecutionTimes
SasTokenProperties
Scripts
StoredProcedure	Operações para ler, substituir, excluir ou executar um procedimento armazenado existente específico por ID. Para operações para criar, ler tudo ou consultar procedimentos armazenados,
StoredProcedureResponse
StoredProcedures	Operações para criar, aumentar ou ler/consultar todos os procedimentos armazenados. Para que as operações leiam, substituam, excluam ou executem um procedimento armazenado existente específico por id, consulte container.storedProcedure().
TimeoutError
Trigger	Operações para ler, substituir ou excluir um Gatilho. Use container.triggers para criar, upsert, consultar ou ler tudo.
TriggerResponse
Triggers	Operações para criar, upsert, consultar e ler todos os gatilhos. Use container.triggers para ler, substituir ou excluir um Gatilho.
User	Usado para ler, substituir e excluir Usuários. Além disso, você pode acessar as permissões para um determinado usuário por meio de user.permission e user.permissions. Consulte Usuários para criar, upsert, consultar ou ler tudo.
UserDefinedFunction	Usado para ler, substituir ou excluir uma função definida pelo usuário especificada por id. Consulte UserDefinedFunction para criar, upsert, consulta, ler todas as funções definidas pelo usuário.
UserDefinedFunctionResponse
UserDefinedFunctions	Usado para criar, upsert, consultar ou ler todas as funções definidas pelo usuário. Consulte UserDefinedFunction para ler, substituir ou excluir uma determinada Função Definida pelo Usuário por id.
UserResponse
Users	Usado para criar, upsert, consultar e ler todos os usuários. Consulte Usuário para ler, substituir ou excluir um usuário específico por id.

Interfaces

@azure/cosmos.Index

Agent
BulkOptions	Objeto Options usado para modificar a execução em massa. continueOnError (valor padrão: false) – Continua a execução em massa quando uma operação falha ** OBSERVAÇÃO ESTE PADRÃO SERÁ TRUE NA VERSÃO 4.0
ChangeFeedIteratorOptions	Especifica opções para o feed de alterações Se nenhuma dessas opções estiver definida, ela começará a ler as alterações a partir de agora para todo o contêiner.
ChangeFeedOptions	Especifica opções para o feed de alterações Algumas dessas opções controlam onde e quando começar a ler do feed de alterações. A ordem de precedência é: Continuação startTime startFromBeginning Se nenhuma dessas opções estiver definida, ela começará a ler as alterações da primeira ChangeFeedIterator.fetchNext() chamada.
ChangeFeedPullModelIterator	Use Items.getChangeFeedIterator() para retornar um iterador que pode iterar em todas as alterações de uma chave de partição, intervalo de feeds ou um contêiner inteiro.
ConflictDefinition
ConflictResolutionPolicy	Representa a configuração da política de resolução de conflitos para especificar como resolve conflitos caso gravações de regiões diferentes resultem em conflitos em documentos na coleção no serviço do Azure Cosmos DB.
ConnectionPolicy	Representa a política de conexão associada a um CosmosClient no serviço de banco de dados do Azure Cosmos DB.
ContainerDefinition
ContainerRequest
CosmosClientOptions
CosmosHeaders
CreateOperationInput
DatabaseDefinition
DatabaseRequest
DeleteOperationInput
DiagnosticNode	Representa uma árvore como estrutura, para capturar informações de diagnóstico.
ErrorBody
FailedRequestAttemptDiagnostic	Esse tipo captura informações de diagnóstico sobre uma solicitação com falha para a API do servidor.
FeedOptions	As opções de feed e os métodos de consulta.
GroupByAliasToAggregateType
IndexedPath
IndexingPolicy
ItemDefinition	Os itens no Cosmos DB são simplesmente objetos JSON. A maioria das operações item permite que você forneça seu próprio tipo que estende o ItemDefinition muito simples. Não é possível usar chaves reservadas. Você pode ver a lista de chaves reservadas em <xref:ItemBody>
JSONArray
JSONObject
Location	Usado para especificar os locais disponíveis, leitura é índice 1 e gravação é índice 0.
MetadataLookUpDiagnostic	Esse tipo contém informações de diagnóstico sobre uma única solicitação de metadados para o servidor.
OfferDefinition
OperationBase
OperationResponse
PartitionKeyDefinition
PartitionKeyRangePropertiesNames
PatchOperationInput
PermissionBody
PermissionDefinition
ReadOperationInput
ReplaceOperationInput
RequestOptions	Opções que podem ser especificadas para um emitido solicitado para os servidores do Azure Cosmos DB.=
Resource
RetryOptions	Representa a política de repetição associada com solicitações limitadas no serviço de banco de dados do Azure Cosmos DB.
SharedOptions	Opções que podem ser especificadas para um emitido solicitado para os servidores do Azure Cosmos DB.=
SpatialIndex
SqlParameter	Representa um parâmetro em uma consulta SQL parametrizada, especificada em SqlQuerySpec
SqlQuerySpec	Representa uma consulta SQL no serviço do Azure Cosmos DB. As consultas com entradas devem ser parametrizadas para proteger contra injeção de SQL. Exemplo Consulta SQL parametrizada const query: SqlQuerySpec = { query: "SELECT * FROM Families f where f.lastName = @lastName", parameters: [ {name: "@lastName", value: "Wakefield"} ] };
StoredProcedureDefinition
TriggerDefinition
UniqueKey	Interface para uma única chave exclusiva passada como parte de UniqueKeyPolicy
UniqueKeyPolicy	Interface para definir chaves exclusivas na criação do contêiner
UpsertOperationInput
UserDefinedFunctionDefinition
UserDefinition

Aliases de tipo

AggregateType
BulkOperationResponse
BulkPatchOperation
ClientConfigDiagnostic	Esse tipo contém informações relacionadas à inicialização de CosmosClient
ClientSideRequestStatistics	Esse é um tipo de coleção para todas as informações de diagnóstico do lado do cliente.
CreateOperation
DeleteOperation
ExistingKeyOperation
GatewayStatistics
GroupByExpressions
JSONValue
MetadataLookUpDiagnostics	Esse tipo contém informações de diagnóstico sobre todas as solicitações de metadados para o servidor durante uma operação de cliente do CosmosDB.
NonePartitionKeyType	O objeto retornado representa um valor de chave de partição que permite criar e acessar itens sem um valor para chave de partição
NullPartitionKeyType	O objeto retornado representa um valor de chave de partição que permite criar e acessar itens com um valor nulo para a chave de partição.
Operation
OperationInput
OperationWithItem
PartitionKey	PartitionKey de um contêiner.
PatchOperation
PatchRequestBody
PrimitivePartitionKeyValue	Um valor de chave de partição primitiva.
ReadOperation
RemoveOperation
ReplaceOperation
RetryDiagnostics	Esse tipo captura informações de diagnóstico sobre tentativas de repetição durante uma operação de cliente do CosmosDB.
TokenProvider
UpsertOperation

Enumerações

ConflictResolutionMode
ConnectionMode	Determina o comportamento de conexão do CosmosClient. Observe que, atualmente, só damos suporte ao Modo de Gateway.
ConsistencyLevel	Representa os níveis de consistência com suporte para operações de cliente do Azure Cosmos DB. O ConsistencyLevel solicitado deve corresponder ou ser mais fraco do que o provisionado para a conta de banco de dados. Níveis de consistência. Os níveis de consistência por ordem de força são Strong, BoundedStaleness, Session, Consistent Prefix e Eventual. Consulte https://aka.ms/cosmos-consistency para obter uma documentação mais detalhada sobre níveis de consistência.
CosmosDbDiagnosticLevel	Nível de diagnóstico do Cosmos DB
DataType	Define um tipo de dados de destino de uma especificação de caminho de índice no serviço do Azure Cosmos DB.
GeospatialType
IndexKind	Especifica os tipos de índice com suporte.
IndexingMode	Especifica os modos de indexação com suporte.
MetadataLookUpType	Essa é uma enumeração para o tipo de pesquisa de metadados possível.
PartitionKeyDefinitionVersion	Versão de definição partitionKey
PartitionKeyKind	Tipo de PartitionKey, ou seja, Hash, MultiHash
PermissionMode	Enumeração para valores de modo de permissão.
PriorityLevel	Representa o Nível de Prioridade associado a cada solicitação de cliente do Azure Cosmos DB. As solicitações de baixa prioridade são sempre limitadas antes de qualquer solicitação de alta prioridade. Por padrão, todas as solicitações são consideradas como solicitações de alta prioridade. Consulte https://aka.ms/CosmosDB/PriorityBasedExecution para obter uma documentação mais detalhada sobre a limitação baseada em prioridade.
SpatialType
TriggerOperation	Enumeração para valores de operação de gatilho. especifica as operações nas quais um gatilho deve ser executado.
TriggerType	Enumeração para valores de tipo de gatilho. Especifica o tipo do gatilho.
UserDefinedFunctionType	Enumeração para valores de tipo udf. Especifica os tipos de funções definidas pelo usuário.

Funções

createAuthorizationSasToken(string, SasTokenProperties)

Interno experimental gera apenas a carga que representa a configuração de permissão para o token sas.

Detalhes da função

createAuthorizationSasToken(string, SasTokenProperties)

Interno experimental gera apenas a carga que representa a configuração de permissão para o token sas.

function createAuthorizationSasToken(masterKey: string, sasTokenProperties: SasTokenProperties): Promise<string>

Parâmetros

masterKey

string

sasTokenProperties

SasTokenProperties

Retornos

Promise<string>