@azure/cosmos package

Classes

AbortError	Este erro é gerado quando uma operação assíncrona foi abortada. Verifique este erro ao testar se a name propriedade de nome 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. Utilize 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	Utilize para ler ou eliminar um determinado Conflito por ID. Veja Conflitos para consultar ou ler todos os conflitos.
ConflictResponse
Conflicts	Utilize para consultar ou ler todos os conflitos. Veja Conflito para ler ou eliminar um determinado Conflito por ID.
Container	Operações de leitura, substituição ou eliminação de um contentor específico existente por ID. Veja Contentores para criar novos contentores e ler/consultar todos os contentores; utilizar .containers. Nota: todas estas operações fazem chamadas relativamente a um orçamento fixo. Deve estruturar o seu sistema de modo a que estas chamadas dimensionem sublinearmente com a sua aplicação. Por exemplo, não chame container(id).read() antes de cada item.read() chamada, para garantir que o contentor existe; faça-o uma vez no arranque da aplicação.
ContainerResponse	Objeto de resposta para operações de contentor
Containers	Operações para criar novos contentores e ler/consultar todos os contentores Veja Contentor para ler, substituir ou eliminar um contentor existente; utilizar .container(id). Nota: todas estas operações fazem chamadas relativamente a um orçamento fixo. Deve estruturar o seu sistema de modo a que estas chamadas dimensionem sublinearmente com a sua aplicação. Por exemplo, não chame containers.readAll() antes de cada item.read() chamada, para garantir que o contentor existe; faça-o uma vez no arranque da aplicação.
CosmosClient	Fornece uma representação lógica do lado do cliente da conta de base de dados do Azure Cosmos DB. Este cliente é utilizado para configurar e executar pedidos no serviço de base de dados do Azure Cosmos DB. Exemplo Instanciar um cliente e criar uma nova base de dados const client = new CosmosClient({endpoint: "<URL HERE>", auth: {masterKey: "<KEY HERE>"}}); await client.databases.create({id: "<datbase name here>"}); Exemplo Instanciar um cliente com uma Política de Ligação personalizada const connectionPolicy = new ConnectionPolicy(); connectionPolicy.RequestTimeout = 10000; const client = new CosmosClient({ endpoint: "<URL HERE>", auth: {masterKey: "<KEY HERE>"}, connectionPolicy });
CosmosDiagnostics	Este é um tipo de Diagnóstico do Cosmos que contém informações de diagnóstico recolhidas durante as operações de cliente. Ou seja, Item.read(), Container.create(). Tem três membros - clientSideRequestStatistics membro contém informações de diagnóstico agregadas, incluindo - pesquisas de metadados. Aqui, todos os pedidos do servidor, para além do recurso final pretendido, são considerados chamadas de metadados. Ou seja, para item.read(id), se o cliente fizer uma chamada de servidor para detetar pontos finais, será considerado como uma chamada de metadados. repetições pontos finais contactados. estatísticas de payload de pedido, resposta. gatewayStatistics - Informações correspondentes à operação principal. Por exemplo, durante Item.read(), o cliente pode realizar 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 a estrutura que captura informações de diagnóstico detalhadas. Por predefinição, está desativada e destina-se a ser utilizada apenas para depuração em ambientes de não produção. O tipo de detalhes capturados no diagnosticNode é controlado por CosmosDbDiagnosticLevel. CosmosDbDiagnosticLevel.info – é o valor predefinido. Neste nível, apenas clientSideRequestStatistics são capturados. Destina-se a ambientes de produção. CosmosDbDiagnosticLevel.debug - Captura diagnosticNode e clientConfig. Não são capturados payloads de pedidos e respostas. Não se destina a ser utilizado no ambiente de produção. CosmosDbDiagnosticLevel.debug-unsafe – além dos dados capturados em CosmosDbDiagnosticLevel.debug, também captura payloads de pedidos e respostas. Não se destina a ser utilizado no ambiente de produção. clientConfig – captura informações relacionadas com a forma como o cliente foi configurado durante a inicialização.
Database	Operações para ler ou eliminar uma base de dados existente. Veja Bases de dados para criar novas bases de dados e ler/consultar todas as bases de dados; utilizar client.databases. Nota: todas estas operações fazem chamadas relativamente a um orçamento fixo. Deve estruturar o seu sistema de modo a que estas chamadas dimensionem sublinearmente com a sua aplicação. Por exemplo, não chame database.read() antes de cada item.read() chamada, para garantir que a base de dados existe; faça-o uma vez no arranque da aplicação.
DatabaseAccount	Representa uma DatabaseAccount no serviço de base de dados do Azure Cosmos DB.
DatabaseResponse	Objeto de resposta para operações da Base de Dados
Databases	Operações para criar novas bases de dados e ler/consultar todas as bases de dados Veja Base de dados para ler ou eliminar uma base de dados existente; utilizar client.database(id). Nota: todas estas operações fazem chamadas relativamente a um orçamento fixo. Deve estruturar o seu sistema de modo a que estas chamadas dimensionem sublinearmente com a sua aplicação. Por exemplo, não chame databases.readAll() antes de cada item.read() chamada, para garantir que a base de dados existe; faça-o uma vez no arranque da aplicação.
ErrorResponse
FeedRange	Especifica um intervalo de feed para o changefeed.
FeedResponse
Item	Utilizado para realizar operações num item específico. Veja 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 Veja Item para ler, substituir ou eliminar um contentor existente; utilizar .item(id).
Offer	Utilize para ler ou substituir uma Oferta existente por ID. Veja Ofertas para consultar ou ler todas as ofertas.
OfferResponse
Offers	Utilize para consultar ou ler todas as Ofertas. Veja Oferta para ler ou substituir uma Oferta existente por ID.
PartitionKeyBuilder	Classe construtora para criar PartitionKey.
Permission	Utilize para ler, substituir ou eliminar uma determinada Permissão por ID. Veja Permissões para criar, atualizar, consultar ou ler todas as Permissões.
PermissionResponse
Permissions	Utilize para criar, substituir, consultar e ler todas as Permissões. Veja Permissão para ler, substituir ou eliminar uma permissão específica por ID.
QueryIterator	Representa um Objeto QueryIterator, uma implementação de feed ou resposta de consulta que permite o percurso e iteração sobre a resposta no serviço de base de dados do Azure Cosmos DB.
QueryMetrics
QueryPreparationTimes
ResourceResponse
RestError	Um tipo de erro personalizado para pedidos de pipeline falhados.
RuntimeExecutionTimes
SasTokenProperties
Scripts
StoredProcedure	Operações de leitura, substituição, eliminação ou execução de um procedimento armazenado específico e existente 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 operações de leitura, substituição, eliminação ou execução de um procedimento armazenado específico e existente por ID, consulte container.storedProcedure().
TimeoutError
Trigger	Operações para ler, substituir ou eliminar um Acionador. Utilize container.triggers para criar, atualizar, consultar ou ler tudo.
TriggerResponse
Triggers	Operações para criar, atualizar, consultar e ler todos os acionadores. Utilize container.triggers para ler, substituir ou eliminar um Acionador.
User	Utilizado para ler, substituir e eliminar Utilizadores. Além disso, pode aceder às permissões de um determinado utilizador através user.permission de e user.permissions. Consulte Utilizadores para criar, atualizar, consultar ou ler tudo.
UserDefinedFunction	Utilizado para ler, substituir ou eliminar uma Função Definida pelo Utilizador especificada por ID. Veja UserDefinedFunction para criar, upsert, consultar, ler todas as Funções Definidas pelo Utilizador.
UserDefinedFunctionResponse
UserDefinedFunctions	Utilizado para criar, upsert, consultar ou ler todas as Funções Definidas pelo Utilizador. Veja UserDefinedFunction para ler, substituir ou eliminar uma determinada Função Definida pelo Utilizador por ID.
UserResponse
Users	Utilizado para criar, atualizar, consultar e ler todos os utilizadores. Consulte Utilizador para ler, substituir ou eliminar um Utilizador específico por ID.

Interfaces

@azure/cosmos.Index

Agent
BulkOptions	Objeto de opções utilizado para modificar a execução em massa. continueOnError (Valor predefinido: falso) - Continua a execução em massa quando uma operação falha ** NOTA ISTO SERÁ PREDEFINIDO PARA VERDADEIRO NA VERSÃO 4.0
ChangeFeedIteratorOptions	Especifica opções para o feed de alterações Se nenhuma dessas opções estiver definida, começará a ler as alterações a partir de agora para todo o contentor.
ChangeFeedOptions	Especifica opções para o feed de alterações Algumas destas opções controlam onde e quando começar a ler a partir do feed de alterações. A ordem de precedência é: continuação startTime startFromBeginning Se nenhuma dessas opções estiver definida, começará a ler as alterações da primeira ChangeFeedIterator.fetchNext() chamada.
ChangeFeedPullModelIterator	Utilize Items.getChangeFeedIterator() para devolver um iterador que pode iterar todas as alterações de uma chave de partição, intervalo de feed ou um contentor inteiro.
ConflictDefinition
ConflictResolutionPolicy	Representa a configuração da política de resolução de conflitos para especificar como resolver conflitos caso as escritas de diferentes regiões resultem em conflitos em documentos na coleção no serviço Azure Cosmos DB.
ConnectionPolicy	Representa a política de ligação associada a um CosmosClient no serviço de base de dados do Azure Cosmos DB.
ContainerDefinition
ContainerRequest
CosmosClientOptions
CosmosHeaders
CreateOperationInput
DatabaseDefinition
DatabaseRequest
DeleteOperationInput
DiagnosticNode	Representa uma árvore como a estrutura para capturar informações de diagnóstico.
ErrorBody
FailedRequestAttemptDiagnostic	Este tipo captura informações de diagnóstico relativamente a um pedido falhado para a api de 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 de Item permite que forneça o seu próprio tipo que expande o itemDefinition muito simples. Não pode utilizar chaves reservadas. Pode ver a lista de chaves reservadas em <xref:ItemBody>
JSONArray
JSONObject
Location	Utilizado para especificar as localizações disponíveis, a leitura é o índice 1 e a escrita é o índice 0.
MetadataLookUpDiagnostic	Este tipo contém informações de diagnóstico sobre um único pedido de metadados para o servidor.
OfferDefinition
OperationBase
OperationResponse
PartitionKeyDefinition
PartitionKeyRangePropertiesNames
PatchOperationInput
PermissionBody
PermissionDefinition
ReadOperationInput
ReplaceOperationInput
RequestOptions	Opções que podem ser especificadas para um pedido emitido para os servidores do Azure Cosmos DB.=
Resource
RetryOptions	Representa a política de Repetição associada com pedidos limitados no serviço de base de dados do Azure Cosmos DB.
SharedOptions	Opções que podem ser especificadas para um pedido emitido para os servidores do Azure Cosmos DB.=
SpatialIndex
SqlParameter	Representa um parâmetro numa consulta SQL parametrizada, especificada no SqlQuerySpec
SqlQuerySpec	Representa uma consulta SQL no serviço Azure Cosmos DB. As consultas com entradas devem ser parametrizadas para proteger contra a 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 transmitida como parte de UniqueKeyPolicy
UniqueKeyPolicy	Interface para definir chaves exclusivas na criação de contentores
UpsertOperationInput
UserDefinedFunctionDefinition
UserDefinition

Aliases de Tipo

AggregateType
BulkOperationResponse
BulkPatchOperation
ClientConfigDiagnostic	Este tipo contém informações relacionadas com a inicialização de CosmosClient
ClientSideRequestStatistics	Este é um tipo de coleção para todas as informações de diagnóstico do lado do cliente.
CreateOperation
DeleteOperation
ExistingKeyOperation
GatewayStatistics
GroupByExpressions
JSONValue
MetadataLookUpDiagnostics	Este tipo contém informações de diagnóstico sobre todos os pedidos de metadados para o servidor durante uma operação de cliente do CosmosDB.
NonePartitionKeyType	O objeto devolvido representa um valor de chave de partição que permite criar e aceder a itens sem um valor para a chave de partição
NullPartitionKeyType	O objeto devolvido representa um valor de chave de partição que permite criar e aceder a itens com um valor nulo para a chave de partição.
Operation
OperationInput
OperationWithItem
PartitionKey	PartitionKey de um contentor.
PatchOperation
PatchRequestBody
PrimitivePartitionKeyValue	Um valor primitivo da Chave de Partição.
ReadOperation
RemoveOperation
ReplaceOperation
RetryDiagnostics	Este 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 ligação do CosmosClient. Tenha em atenção que atualmente só suportamos o Modo de Gateway.
ConsistencyLevel	Representa os níveis de consistência suportados para as operações de cliente do Azure Cosmos DB. O ConsistencyLevel pedido tem de corresponder ou ser mais fraco do que o aprovisionado para a conta de base 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. Veja https://aka.ms/cosmos-consistency para obter documentação mais detalhada sobre Os 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 Azure Cosmos DB.
GeospatialType
IndexKind	Especifica os tipos de Índice suportados.
IndexingMode	Especifica os modos de indexação suportados.
MetadataLookUpType	Este é um número para pesquisas de Tipo de Metadados possíveis.
PartitionKeyDefinitionVersion	PartitionKey Definition Version
PartitionKeyKind	Tipo de PartitionKey, ou seja, Hash, MultiHash
PermissionMode	Enum para valores do modo de permissão.
PriorityLevel	Representa o Nível de Prioridade associado a cada pedido de cliente do Azure Cosmos DB. Os pedidos de prioridade baixa são sempre limitados antes de quaisquer pedidos de alta prioridade. Por predefinição, todos os pedidos são considerados pedidos de alta prioridade. Veja https://aka.ms/CosmosDB/PriorityBasedExecution para obter documentação mais detalhada sobre limitação baseada em prioridades.
SpatialType
TriggerOperation	Enum para valores de operação de acionador. especifica as operações em que um acionador deve ser executado.
TriggerType	Enum para valores de tipo de acionador. Especifica o tipo do acionador.
UserDefinedFunctionType	Enum para valores de tipo udf. Especifica os tipos de funções definidas pelo utilizador.

Funções

createAuthorizationSasToken(string, SasTokenProperties)

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

Detalhes de Função

createAuthorizationSasToken(string, SasTokenProperties)

Interno experimental Gera apenas o payload 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

Devoluções

Promise<string>