Compartir a través de


Microsoft.Azure.Cosmos Espacio de nombres

Clases

AccountConsistency

Representa la directiva de coherencia de una cuenta de base de datos del servicio Azure Cosmos DB.

AccountProperties

Representa un objeto AccountProperties. AccountProperties es el contenedor de bases de datos del servicio Azure Cosmos DB.

AccountRegion

La clase AccountLocation representa una cuenta de base de datos de Azure Cosmos DB en una región específica.

BoundingBoxProperties

Representa el rectángulo de selección de la ruta espacial de geometría en el servicio Azure Cosmos DB.

ChangeFeedEstimator

Se usa para calcular el trabajo pendiente que queda para que lo lea una ChangeFeedProcessor implementación.

ChangeFeedEstimatorRequestOptions

Opciones de solicitud para ChangeFeedEstimator.

ChangeFeedMode

Clase base para el modo ChangeFeedRequestOptionsde fuente de cambios .

ChangeFeedProcessor

Proporciona una API para iniciar y detener una ChangeFeedProcessor instancia creada por Build().

ChangeFeedProcessorBuilder

Proporciona una manera flexible de crear una instancia de ChangeFeedProcessor con un conjunto personalizado de parámetros.

ChangeFeedProcessorContext

Contexto relacionado con el conjunto de cambios entregados.

ChangeFeedProcessorState

Estado del procesador de fuente de cambios para un intervalo determinado de claves de partición.

ChangeFeedProcessorUserException

Excepción que se produjo cuando se está ejecutando una operación en un IChangeFeedObserver y se produce mediante código de usuario

ChangeFeedRequestOptions

Opciones de solicitud de fuente de cambios de Cosmos

ChangeFeedStartFrom

Clase base para dónde iniciar una operación ChangeFeed en ChangeFeedRequestOptions.

ClientEncryptionIncludedPath

Ruta de acceso que necesita cifrado y la configuración asociada dentro de ClientEncryptionPolicy.

ClientEncryptionKey

Proporciona operaciones para leer una clave de cifrado de datos de cliente específica (también conocida como ClientEncryptionKey) por id. Consulte Database para ver las operaciones para crear y enumerar las claves de cifrado de cliente. Consulte https://aka.ms/CosmosClientEncryption para más información sobre la compatibilidad con el cifrado del lado cliente en Azure Cosmos DB.

ClientEncryptionKeyProperties

Detalles de una clave de cifrado para su uso con el servicio Azure Cosmos DB.

ClientEncryptionKeyResponse

Respuesta del servicio Cosmos DB para una ClientEncryptionKey solicitud relacionada.

ClientEncryptionPolicy

ClientEncryptionPolicy Debe inicializarse con el tipo de cifrado policyFormatVersion 2 y "Deterministic", si es necesario cifrar la propiedad "id" o las propiedades que forman parte de la clave de partición. Todos los valores de propiedad de clave de partición deben ser cadenas JSON.

CompositePath

DOM para una ruta de acceso compuesta. Una ruta de acceso compuesta se usa en un índice compuesto. Por ejemplo, si desea ejecutar una consulta como "SELECT * FROM c ORDER BY c.age, c.height", deberá agregar "/age" y "/height" como rutas de acceso compuestas al índice compuesto.

ConflictProperties

Representa un conflicto en el servicio Azure Cosmos DB.

ConflictResolutionPolicy

Representa la configuración de la directiva de resolución de conflictos para especificar cómo resolver conflictos en caso de que las escrituras de regiones diferentes produzcan conflictos en los elementos del contenedor en el servicio Azure Cosmos DB.

Conflicts

Operaciones para leer o consultar conflictos en un contenedor de Azure Cosmos.

Container

Operaciones para leer, reemplazar o eliminar un contenedor o elemento específico existente en un contenedor por identificador. Hay dos tipos diferentes de operaciones.

  1. Las operaciones de objeto en las que serializa y deserializa el elemento en la solicitud o respuesta.
  2. La respuesta de secuencia que toma un objeto Stream que contiene un objeto serializado JSON y devuelve una respuesta que contiene un objeto Stream See Database para crear nuevos contenedores y leer y consultar todos los contenedores.
ContainerProperties

Representa un contenedor de documentos en el servicio Azure Cosmos DB. Un contenedor es un contenedor lógico con nombre para documentos.

ContainerRequestOptions

Opciones de solicitud de contenedor de Cosmos

ContainerResponse

Respuesta del contenedor de Cosmos

CosmosClient

Proporciona una representación lógica del lado cliente de la cuenta de Azure Cosmos DB. Este cliente se puede usar para configurar y ejecutar solicitudes en el servicio de base de datos de Azure Cosmos DB.

CosmosClient es seguro para subprocesos. Se recomienda mantener una única instancia de CosmosClient por duración de la aplicación, lo que permite una administración y un rendimiento de conexiones eficaces. Consulte la guía de rendimiento.

CosmosClientOptions

Define todas las opciones configurables que requiere CosmosClient.

CosmosClientTelemetryOptions

Opciones de telemetría para que el cliente de Cosmos habilite o deshabilite la telemetría y el seguimiento distribuido junto con los valores de umbral correspondientes.

CosmosDiagnostics

Contiene la información de diagnóstico de Cosmos para la solicitud actual al servicio Azure Cosmos DB.

CosmosException

Excepción del cliente de Cosmos

CosmosLinqSerializerOptions

Esta clase proporciona una manera de configurar las propiedades de serialización de Linq.

CosmosOperationCanceledException

Excepción que se produce en un subproceso cuando se cancela una operación que estaba ejecutando dicho subproceso. Esto amplía OperationCanceledException para incluir los diagnósticos de la operación que se canceló.

CosmosResponseFactory

Este generador de respuestas convierte los mensajes de respuesta en la respuesta de tipo correspondiente mediante el serializador CosmosClient.

CosmosSerializationOptions

Esta clase proporciona una manera de configurar las opciones básicas del serializador.

CosmosSerializer

Se trata de una interfaz para permitir que CosmosClient use un serializador personalizado.

CosmosThresholdOptions

Valores de umbral para el seguimiento distribuido

Database

Operaciones para leer o eliminar una base de datos existente.

Consulte Client para crear nuevas bases de datos y leer y consultar todas las bases de datos; use client.Databases.

DatabaseProperties

Representa una base de datos de la cuenta de Azure Cosmos DB.

DatabaseResponse

Respuesta de la base de datos de Cosmos

DedicatedGatewayRequestOptions

Opciones de solicitud de puerta de enlace dedicada

EncryptionKeyWrapMetadata

Metadatos que se pueden usar para encapsular o desencapsular una clave de cifrado de datos mediante una clave administrada por el cliente. Consulte https://aka.ms/CosmosClientEncryption para más información sobre la compatibilidad con el cifrado del lado cliente en Azure Cosmos DB.

ExcludedPath

Especifica una ruta de acceso dentro de un documento JSON que se va a excluir al indexar datos para el servicio Azure Cosmos DB.

FeedIterator

Iterador del conjunto de resultados de Cosmos que realiza un seguimiento del token de continuación al recuperar los resultados forman una consulta.

FeedIterator<T>

Iterador del conjunto de resultados de Cosmos que realiza un seguimiento del token de continuación al recuperar los resultados forman una consulta.

FeedRange

Representa una unidad de consumo de alimentación que se puede usar como unidad de paralelismo.

FeedResponse<T>

Contrato de usuario para las distintas respuestas de fuente que serializaron las respuestas a un tipo. Para seguir el estándar de .NET para las respuestas con tipo, se deben producir excepciones al usuario.

GeospatialConfig

Representa la configuración geoespacial de una colección en el servicio Azure Cosmos DB.

Headers

Implementación de encabezado usada para solicitudes y respuestas

IncludedPath

Especifica una ruta de acceso dentro de un documento JSON que se va a incluir en el servicio Azure Cosmos DB.

IndexingPolicy

Representa la configuración de la directiva de indexación de una colección en el servicio Azure Cosmos DB.

ItemRequestOptions

Opciones de solicitud de elemento de Cosmos

ItemResponse<T>

Respuesta del elemento de Cosmos

PartitionKeyBuilder

Representa una lista de valores de clave de partición en el servicio Azure Cosmos DB.

PatchItemRequestOptions

Opciones de solicitud de revisión de Cosmos

PatchOperation

Detalles de la operación de revisión que se va a aplicar al elemento de Cosmos al que se hace referencia.

PatchOperation<T>

Define PatchOperation con un parámetro de valor.

Permission

Operaciones para leer, reemplazar o eliminar un permiso específico por id. Los permisos se usan para crear ResourceTokens. Los tokens de recursos proporcionan acceso a los recursos de la aplicación en una base de datos. Los tokens de recursos:

  • Proporcionan acceso a contenedores, claves de partición, documentos, datos adjuntos, procedimientos almacenados, desencadenadores y UDF concretos.
  • Se crean cuando a un usuario se le conceden permisos para un recurso concreto.
  • Se vuelven a crear cuando una llamada POST, GET o PUT aplica una acción a un recurso de permiso.
  • Usan un token de recurso de hash construido específicamente para el usuario, el recurso y el permiso.
  • Está limitado por un período de validez personalizable. El intervalo de tiempo válido predeterminado es una hora. Sin embargo, la vigencia del token puede especificarse explícitamente, hasta un máximo de 24 horas.
  • Proporcionan una alternativa segura a proporcionar la clave maestra.
  • Permiten que los clientes lean, escriban y eliminen recursos de la cuenta de Cosmos DB en función de los permisos que se les haya otorgado.
PermissionProperties

Representa un permiso en el servicio Azure Cosmos DB.

PermissionResponse

Respuesta de permisos de Cosmos

QueryDefinition

Define una consulta de Cosmos SQL

QueryRequestOptions

Opciones de solicitud de consulta de Cosmos

ReadManyRequestOptions

Opciones de solicitud de consulta de Cosmos

Regions

La clase LocationNames contiene los nombres de las regiones de Azure compatibles actualmente con el servicio Azure Cosmos DB.

RequestHandler

Abstracción que permite definir controladores de mensajes personalizados.

RequestMessage

Representa una solicitud en la canalización de procesamiento del SDK de Azure Cosmos DB.

RequestOptions

Opciones de solicitud de Cosmos predeterminadas

Response<T>

Clase de respuesta de recursos de Cosmos

ResponseMessage

Representa una respuesta del servicio Azure Cosmos DB.

ServerSideCumulativeMetrics

Métricas recibidas para las consultas del back-end.

ServerSideMetrics

Métricas recibidas para las consultas del back-end.

ServerSidePartitionedMetrics

Representa métricas del lado servidor específicas para una sola partición.

SpatialPath

Especificación del índice espacial

ThroughputProperties

Representa un rendimiento de los recursos del servicio Azure Cosmos DB. Es el precio estándar del recurso en el servicio Azure Cosmos DB.

ThroughputResponse

Respuesta de rendimiento de Cosmos

TransactionalBatch

Representa un lote de operaciones en los elementos con el mismo PartitionKey en un contenedor que se realizará de forma transaccional en el servicio Azure Cosmos DB. Use CreateTransactionalBatch(PartitionKey) para crear una instancia de TransactionalBatch.

TransactionalBatchItemRequestOptions

RequestOptionsque se aplica a una operación dentro de .TransactionalBatch

TransactionalBatchOperationResult

Representa un resultado para una operación específica que formaba parte de una TransactionalBatch solicitud.

TransactionalBatchOperationResult<T>

Representa un resultado para una operación específica que forma parte de un lote.

TransactionalBatchPatchItemRequestOptions

Opciones de solicitud de revisión de Cosmos Batch

TransactionalBatchRequestOptions

Opciones de solicitud por lotes de Cosmos.

TransactionalBatchResponse

Respuesta de una TransactionalBatch solicitud.

UniqueKey

Representa una clave única en la que se aplica una restricción de unicidad en los documentos de la colección del servicio Azure Cosmos DB.

UniqueKeyPolicy

Representa la configuración de directiva de clave única para especificar restricciones de unicidad en los documentos de la colección en el servicio Azure Cosmos DB.

User

Operaciones para leer, reemplazar o eliminar un usuario existente específico por identificador y consultar los permisos de un usuario.

UserProperties

Representa un usuario en el servicio Azure Cosmos DB.

UserResponse

Respuesta del usuario de Cosmos

Estructuras

PartitionKey

Representa un valor de clave de partición en el servicio Azure Cosmos DB.

Enumeraciones

CompositePathSortOrder

Define el tipo de datos de destino de una especificación de ruta de acceso de índice en el servicio Azure Cosmos DB.

ConflictResolutionMode

Especifica los modos de resolución de conflictos admitidos, tal y como se especifica en ConflictResolutionPolicy

ConnectionMode

Representa el modo de conexión que va a usar el cliente al conectarse al servicio Azure Cosmos DB.

ConsistencyLevel

Estos son los niveles de coherencia admitidos por el servicio Azure Cosmos DB.

CosmosPropertyNamingPolicy

Determina la directiva de nomenclatura que se usa para convertir un nombre basado en cadenas a otro formato, como un uso de mayúsculas y minúsculas en camel, donde la primera letra es minúscula.

DataType

Define el tipo de datos de destino de una especificación de ruta de acceso de índice en el servicio Azure Cosmos DB.

GeospatialType

Especifica los tipos geoespaciales admitidos en el servicio Azure Cosmos DB.

IndexingDirective

Especifica si el recurso de la base de datos de Azure Cosmos DB se va a indexar o no.

IndexingMode

Especifica los modos de indexación admitidos en el servicio Azure Cosmos DB.

IndexKind

Estos son los tipos de indexación disponibles para indexar una ruta de acceso en el servicio Azure Cosmos DB.

OperationKind

Estos son los tipos de operación que provocaron un conflicto de versión en un recurso.

PartitionKeyDefinitionVersion

Versión de creación de particiones.

PatchOperationType

Describe la lista de tipos de operaciones compatibles con patch.

PermissionMode

Estos son los permisos de acceso para crear o reemplazar un PermissionProperties recurso en el servicio Azure Cosmos DB.

PortReuseMode

Opciones de directiva de reutilización de puertos usadas por la pila de transporte

SpatialType

Define el tipo de datos de destino de una especificación de ruta de acceso de índice en el servicio Azure Cosmos DB.

Delegados

Container.ChangeFeedHandler<T>

Delegado para recibir los cambios dentro de una ChangeFeedProcessor ejecución.

Container.ChangeFeedHandlerWithManualCheckpoint<T>

Delegar para recibir los cambios dentro de una ejecución con punto ChangeFeedProcessor de control manual.

Container.ChangeFeedMonitorErrorDelegate

Delegar para notificar errores durante las operaciones de fuente de cambios.

Container.ChangeFeedMonitorLeaseAcquireDelegate

Delegar para notificar a los eventos de concesiones que adquiere un procesador de fuente de cambios.

Container.ChangeFeedMonitorLeaseReleaseDelegate

Delegar para notificar a los eventos de concesiones que publica un procesador de fuente de cambios.

Container.ChangeFeedStreamHandler

Delegado para recibir los cambios dentro de una ChangeFeedProcessor ejecución.

Container.ChangeFeedStreamHandlerWithManualCheckpoint

Delegar para recibir los cambios dentro de una ejecución con punto ChangeFeedProcessor de control manual.

Container.ChangesEstimationHandler

Delegue para recibir la estimación de los cambios pendientes que leerá la instancia asociada ChangeFeedProcessor .

Container.ChangesHandler<T>

Delegado para recibir los cambios dentro de una ChangeFeedProcessor ejecución.