Partilhar via


Microsoft.Azure.Cosmos Namespace

Classes

AccountConsistency

Representa a política de consistência de uma conta de banco de dados do serviço do Azure Cosmos DB.

AccountProperties

Representa um AccountProperties. Uma AccountProperties é o contêiner para bancos de dados no serviço do Azure Cosmos DB.

AccountRegion

A classe AccountLocation representa uma conta de banco de dados do Azure Cosmos DB em uma região específica.

BoundingBoxProperties

Representa a caixa delimitadora para o caminho espacial de geometria no serviço do Azure Cosmos DB

ChangeFeedEstimator

Usado para estimar o trabalho pendente a ser lido por uma ChangeFeedProcessor implantação.

ChangeFeedEstimatorRequestOptions

Opções de solicitação para ChangeFeedEstimator.

ChangeFeedMode

Classe base para o modo ChangeFeedRequestOptionsde feed de alterações.

ChangeFeedProcessor

Fornece uma API para iniciar e parar uma ChangeFeedProcessor instância criada por Build().

ChangeFeedProcessorBuilder

Fornece uma maneira flexível de criar uma instância de ChangeFeedProcessor com um conjunto personalizado de parâmetros.

ChangeFeedProcessorContext

Contexto relacionado ao conjunto de alterações entregues.

ChangeFeedProcessorState

Altere o estado do processador do Feed para um intervalo específico de chaves de partição.

ChangeFeedProcessorUserException

Exceção ocorreu quando uma operação em um IChangeFeedObserver está em execução e é gerada pelo código do usuário

ChangeFeedRequestOptions

As opções de solicitação do Feed de Alterações do Cosmos

ChangeFeedStartFrom

Classe base para onde iniciar uma operação do ChangeFeed no ChangeFeedRequestOptions.

ClientEncryptionIncludedPath

Caminho que precisa de criptografia e as configurações associadas em ClientEncryptionPolicy.

ClientEncryptionKey

Fornece operações para ler uma chave de criptografia de dados de cliente específica (também conhecida como ClientEncryptionKey) por Id. Consulte Database para obter operações para criar e enumerar chaves de criptografia do cliente. Consulte https://aka.ms/CosmosClientEncryption para obter mais informações sobre o suporte à criptografia do lado do cliente no Azure Cosmos DB.

ClientEncryptionKeyProperties

Detalhes de uma chave de criptografia para uso com o serviço do Azure Cosmos DB.

ClientEncryptionKeyResponse

Resposta do serviço do Cosmos DB para uma solicitação ClientEncryptionKey relacionada.

ClientEncryptionPolicy

O ClientEncryptionPolicy deve ser inicializado com o tipo de criptografia policyFormatVersion 2 e "Deterministic", se a propriedade "id" ou as propriedades que fazem parte da chave de partição precisarem ser criptografadas. Todos os valores de propriedade da chave de partição precisam ser cadeias de caracteres JSON.

CompositePath

DOM para um caminho composto. Um caminho composto é usado em um índice composto. Por exemplo, se você quiser executar uma consulta como "SELECT * FROM c ORDER BY c.age, c.height", será necessário adicionar "/age" e "/height" como caminhos compostos ao índice composto.

ConflictProperties

Representa um conflito no serviço do Azure Cosmos DB.

ConflictResolutionPolicy

Representa a configuração de política de resolução de conflitos para especificar como resolve conflitos caso gravações de regiões diferentes resultem em conflitos em itens no contêiner no serviço do Azure Cosmos DB.

Conflicts

Operações para ler/consultar conflitos em um contêiner do Azure Cosmos.

Container

Operações para ler, substituir ou excluir um contêiner ou item específico existente em um contêiner por ID. Há dois tipos diferentes de operações.

  1. As operações de objeto em que ele serializa e desserializa o item na solicitação/resposta
  2. A resposta de fluxo que usa um Stream que contém um objeto serializado JSON e retorna uma resposta que contém um Stream See Database para criar novos contêineres e ler/consultar todos os contêineres.
ContainerProperties

Representa um contêiner de documento no serviço do Azure Cosmos DB. Um contêiner é um contêiner lógico nomeado para documentos.

ContainerRequestOptions

As opções de solicitação de contêiner do Cosmos

ContainerResponse

A resposta do contêiner cosmos

CosmosClient

Fornece uma representação lógica do lado do cliente da conta do Azure Cosmos DB. Esse cliente pode ser usado para configurar e executar solicitações no serviço de banco de dados do Azure Cosmos DB.

O CosmosClient é thread-safe. É recomendável manter uma única instância do CosmosClient por tempo de vida do aplicativo que permite o gerenciamento e o desempenho de conexões eficientes. Consulte o guia de desempenho.

CosmosClientOptions

Define todas as opções configuráveis que o CosmosClient requer.

CosmosClientTelemetryOptions

Opções de telemetria para o Cliente Cosmos habilitar/desabilitar a telemetria e o rastreamento distribuído junto com os valores de limite correspondentes.

CosmosDiagnostics

Contém as informações de diagnóstico do Cosmos para a solicitação atual para o serviço do Azure Cosmos DB.

CosmosException

A exceção do Cliente Cosmos

CosmosLinqSerializerOptions

Essa classe fornece uma maneira de configurar as propriedades de serialização do Linq

CosmosOperationCanceledException

A exceção que é gerada em um thread com o cancelamento de uma operação que o thread estava sendo executado. Isso estende a OperationCanceledException para incluir o diagnóstico da operação que foi cancelada.

CosmosResponseFactory

Essa fábrica de resposta converte mensagens de resposta para a resposta de tipo correspondente usando o serializador CosmosClient

CosmosSerializationOptions

Essa classe fornece uma maneira de definir as configurações básicas do serializador.

CosmosSerializer

Essa é uma interface para permitir que um serializador personalizado seja usado pelo CosmosClient

CosmosThresholdOptions

Valores de limite para rastreamento distribuído

Database

Operações para ler ou excluir um banco de dados existente.

Consulte Client para criar novos bancos de dados e ler/consultar todos os bancos de dados; use client.Databases.

DatabaseProperties

Representa um banco de dados na conta do Azure Cosmos DB.

DatabaseResponse

A resposta do banco de dados cosmos

DedicatedGatewayRequestOptions

As opções de solicitação de Gateway Dedicado

EncryptionKeyWrapMetadata

Metadados que podem ser usados para encapsular/desembrulhar uma chave de criptografia de dados usando uma chave gerenciada pelo cliente. Consulte https://aka.ms/CosmosClientEncryption para obter mais informações sobre o suporte à criptografia do lado do cliente no Azure Cosmos DB.

ExcludedPath

Especifica um caminho dentro de um documento JSON a ser excluído durante a indexação de dados para o serviço do Azure Cosmos DB.

FeedIterator

Iterador de conjunto de resultados do Cosmos que controla o token de continuação ao recuperar resultados formam uma consulta.

FeedIterator<T>

Iterador de conjunto de resultados do Cosmos que controla o token de continuação ao recuperar resultados formam uma consulta.

FeedRange

Representa uma unidade de consumo de feed que pode ser usada como unidade de paralelismo.

FeedResponse<T>

O contrato do usuário para as várias respostas de feed que serializaram as respostas para um tipo. Para seguir o padrão .NET para respostas digitada, todas as exceções devem ser geradas ao usuário.

GeospatialConfig

Representa a configuração geoespacial de uma coleção no serviço do Azure Cosmos DB

Headers

Implementação de cabeçalho usada para solicitação e respostas

IncludedPath

Especifica um caminho dentro de um documento JSON a ser incluído no serviço do Azure Cosmos DB.

IndexingPolicy

Representa a configuração da política de indexação para uma coleção no serviço do Azure Cosmos DB.

ItemRequestOptions

Opções de solicitação de item do Cosmos

ItemResponse<T>

A resposta do item cosmos

PartitionKeyBuilder

Representa uma lista de valores de chave de partição no serviço do Azure Cosmos DB.

PatchItemRequestOptions

Opções de solicitação do Patch do Cosmos

PatchOperation

Detalhes da operação patch que deve ser aplicada ao item cosmos referenciado.

PatchOperation<T>

Define PatchOperation com um parâmetro de valor.

Permission

Operações para ler, substituir ou excluir uma permissão específica por ID. As permissões são usadas para criar ResourceTokens. Os tokens de recurso fornecem acesso aos recursos do aplicativo em um banco de dados. Tokens de recurso:

  • Fornece acesso a contêineres, chaves de partição, documentos, anexos, procedimentos armazenados, gatilhos e UDFs específicos.
  • São criados quando um usuário recebe permissões para um recurso específico.
  • São recriados quando um recurso de permissão recebe uma ação de uma chamada POST, GET ou PUT.
  • Use um token de recurso de hash construído especificamente para o usuário, o recurso e a permissão.
  • São associados a um período de validade personalizável. O intervalo de tempo válido padrão é de uma hora. O tempo de vida do token, no entanto, poderá ser explicitamente especificada, até um máximo de 24 horas.
  • Fornecem uma alternativa segura para o fornecimento da chave mestra.
  • Permitem aos clientes ler, gravar e excluir recursos da conta do Cosmos DB de acordo com as permissões que receberam.
PermissionProperties

Representa uma permissão no serviço do Azure Cosmos DB.

PermissionResponse

A resposta de permissão do Cosmos

QueryDefinition

Define uma consulta SQL do Cosmos

QueryRequestOptions

As opções de solicitação de consulta do Cosmos

ReadManyRequestOptions

As opções de solicitação de consulta do Cosmos

Regions

A classe LocationNames contém os nomes das regiões do Azure com suporte no momento pelo serviço do Azure Cosmos DB.

RequestHandler

Abstração que permite definir manipuladores de mensagens personalizados.

RequestMessage

Representa uma solicitação no pipeline de processamento do SDK do Azure Cosmos DB.

RequestOptions

As opções de solicitação padrão do Cosmos

Response<T>

A classe de resposta de recurso cosmos

ResponseMessage

Representa uma resposta do serviço do Azure Cosmos DB.

ServerSideCumulativeMetrics

Métricas recebidas para consultas do back-end.

ServerSideMetrics

Métricas recebidas para consultas do back-end.

ServerSidePartitionedMetrics

Representa métricas do lado do servidor específicas para uma única partição.

SpatialPath

Especificação de índice espacial

ThroughputProperties

Representa uma taxa de transferência dos recursos no serviço do Azure Cosmos DB. É o preço padrão do recurso no serviço do Azure Cosmos DB.

ThroughputResponse

A resposta da taxa de transferência do Cosmos

TransactionalBatch

Representa um lote de operações em relação a itens com o mesmo PartitionKey em um contêiner que será executado de maneira transacional no serviço do Azure Cosmos DB. Use CreateTransactionalBatch(PartitionKey) para criar uma instância de TransactionalBatch.

TransactionalBatchItemRequestOptions

RequestOptions que se aplica a uma operação dentro de um TransactionalBatch.

TransactionalBatchOperationResult

Representa um resultado para uma operação específica que fazia parte de uma solicitação TransactionalBatch .

TransactionalBatchOperationResult<T>

Representa um resultado para uma operação específica que faz parte de um lote.

TransactionalBatchPatchItemRequestOptions

Opções de solicitação do Patch do Lote do Cosmos

TransactionalBatchRequestOptions

Opções de solicitação em lote do Cosmos.

TransactionalBatchResponse

Resposta de uma solicitação TransactionalBatch .

UniqueKey

Representa uma chave exclusiva no que impõe a restrição de exclusividade em documentos na coleção no serviço do Azure Cosmos DB.

UniqueKeyPolicy

Representa a configuração de política de chave exclusiva para especificar restrições de exclusividade em documentos na coleção no serviço do Azure Cosmos DB.

User

Operações para ler, substituir ou excluir um usuário existente específico por ID e consultar as permissões de um usuário.

UserProperties

Representa um usuário no serviço do Azure Cosmos DB.

UserResponse

A resposta do usuário do Cosmos

Estruturas

PartitionKey

Representa um valor de chave de partição no serviço do Azure Cosmos DB.

Enumerações

CompositePathSortOrder

Define o tipo de dados de destino de uma especificação de caminho de índice no serviço do Azure Cosmos DB.

ConflictResolutionMode

Especifica os modos de resolução de conflitos com suporte, conforme especificado em ConflictResolutionPolicy

ConnectionMode

Representa o modo de conexão a ser usado pelo cliente ao se conectar ao serviço do Azure Cosmos DB.

ConsistencyLevel

Esses são os níveis de consistência compatíveis com o serviço do Azure Cosmos DB.

CosmosPropertyNamingPolicy

Determina a política de nomenclatura usada para converter um nome baseado em cadeia de caracteres em outro formato, como uma maiúsculas e minúsculas em que a primeira letra é minúscula.

DataType

Define o tipo de dados de destino de uma especificação de caminho de índice no serviço do Azure Cosmos DB.

GeospatialType

Especifica os tipos geoespaciais com suporte no serviço do Azure Cosmos DB.

IndexingDirective

Especifica se o recurso no banco de dados do Azure Cosmos DB deve ser indexado ou não.

IndexingMode

Especifica os modos de indexação com suporte no serviço do Azure Cosmos DB.

IndexKind

Esses são os tipos de indexação disponíveis para indexar um caminho no serviço do Azure Cosmos DB.

OperationKind

Esses são os tipos de operação que resultaram em um conflito de versão em um recurso.

PartitionKeyDefinitionVersion

Versão de particionamento.

PatchOperationType

Descreve a lista de tipos de operação compatíveis com Patch.

PermissionMode

Essas são as permissões de acesso para criar ou substituir um PermissionProperties recurso no serviço do Azure Cosmos DB.

PortReuseMode

Opções de política de reutilização de porta usadas pela pilha de transporte

SpatialType

Define o tipo de dados de destino de uma especificação de caminho de índice no serviço do Azure Cosmos DB.

Delegados

Container.ChangeFeedHandler<T>

Delegar para receber as alterações dentro de uma ChangeFeedProcessor execução.

Container.ChangeFeedHandlerWithManualCheckpoint<T>

Delegar para receber as alterações dentro de uma ChangeFeedProcessor execução com ponto de verificação manual.

Container.ChangeFeedMonitorErrorDelegate

Delegar para notificar erros durante operações de feed de alterações.

Container.ChangeFeedMonitorLeaseAcquireDelegate

Delegar para notificar eventos de concessões que estão sendo adquiridas por um processador de feed de alterações.

Container.ChangeFeedMonitorLeaseReleaseDelegate

Delegar para notificar eventos de concessões sendo versões por um processador de feed de alterações.

Container.ChangeFeedStreamHandler

Delegar para receber as alterações dentro de uma ChangeFeedProcessor execução.

Container.ChangeFeedStreamHandlerWithManualCheckpoint

Delegar para receber as alterações dentro de uma ChangeFeedProcessor execução com ponto de verificação manual.

Container.ChangesEstimationHandler

Delegar para receber a estimativa de alterações pendentes a serem lidas pela instância associada ChangeFeedProcessor .

Container.ChangesHandler<T>

Delegar para receber as alterações dentro de uma ChangeFeedProcessor execução.