Freigeben über


Microsoft.Azure.Cosmos Namespace

Klassen

AccountConsistency

Stellt die Konsistenzrichtlinie eines Datenbankkontos des Azure Cosmos DB-Diensts dar.

AccountProperties

Stellt einen AccountProperties dar. AccountProperties ist der Container für Datenbanken im Azure Cosmos DB-Dienst.

AccountRegion

Die AccountLocation-Klasse stellt ein Azure Cosmos DB-Datenbankkonto in einer bestimmten Region dar.

BoundingBoxProperties

Stellt das Begrenzungsfeld für den räumlichen Geometriepfad im Azure Cosmos DB-Dienst dar.

ChangeFeedEstimator

Wird verwendet, um die ausstehende Arbeit zu schätzen, die von einer ChangeFeedProcessor Bereitstellung gelesen werden soll.

ChangeFeedEstimatorRequestOptions

Anforderungsoptionen für ChangeFeedEstimator.

ChangeFeedMode

Basisklasse für den Änderungsfeedmodus ChangeFeedRequestOptions.

ChangeFeedProcessor

Stellt eine API zum Starten und Beenden einer ChangeFeedProcessor von Build()erstellten instance bereit.

ChangeFeedProcessorBuilder

Bietet eine flexible Möglichkeit zum Erstellen einer instance von ChangeFeedProcessor mit benutzerdefinierten Parametern.

ChangeFeedProcessorContext

Kontext, der sich auf den Satz der übermittelten Änderungen bezieht.

ChangeFeedProcessorState

Ändern des Feedprozessorstatus für einen bestimmten Bereich von Partitionsschlüsseln.

ChangeFeedProcessorUserException

Ausnahme tritt auf, wenn ein Vorgang in einem IChangeFeedObserver ausgeführt wird und nach Benutzercode ausgelöst wird.

ChangeFeedRequestOptions

Die Cosmos-Änderungsfeed-Anforderungsoptionen

ChangeFeedStartFrom

Basisklasse für den Start eines ChangeFeed-Vorgangs in ChangeFeedRequestOptions.

ClientEncryptionIncludedPath

Pfad, der eine Verschlüsselung und die zugehörigen Einstellungen in ClientEncryptionPolicybenötigt.

ClientEncryptionKey

Stellt Vorgänge zum Lesen eines bestimmten Clientdatenverschlüsselungsschlüssels (auch als ClientEncryptionKey bezeichnet) nach ID bereit. Weitere Informationen finden Sie Database unter Vorgänge zum Erstellen und Aufzählen von Clientverschlüsselungsschlüsseln. Weitere Informationen zur Unterstützung der clientseitigen Verschlüsselung in Azure Cosmos DB finden Sie https://aka.ms/CosmosClientEncryption unter .

ClientEncryptionKeyProperties

Details zu einem Verschlüsselungsschlüssel für die Verwendung mit dem Azure Cosmos DB-Dienst.

ClientEncryptionKeyResponse

Antwort des Cosmos DB-Diensts für eine ClientEncryptionKey zugehörige Anforderung.

ClientEncryptionPolicy

Sollte ClientEncryptionPolicy mit policyFormatVersion 2 und dem Verschlüsselungstyp "Deterministic" initialisiert werden, wenn die Eigenschaft "id" oder Eigenschaften, die Teil des Partitionsschlüssels sind, verschlüsselt werden müssen. Alle Partitionsschlüsseleigenschaftswerte müssen JSON-Zeichenfolgen sein.

CompositePath

DOM für einen zusammengesetzten Pfad. Ein zusammengesetzter Pfad wird in einem zusammengesetzten Index verwendet. Wenn Sie beispielsweise eine Abfrage wie "SELECT * FROM c ORDER BY c.age, c.height" ausführen möchten, müssen Sie ihrem zusammengesetzten Index "/age" und "/height" als zusammengesetzte Pfade hinzufügen.

ConflictProperties

Stellt einen Konflikt im Azure Cosmos DB-Dienst dar.

ConflictResolutionPolicy

Stellt die Richtlinienkonfiguration für die Konfliktlösung dar, mit der angegeben wird, wie Konflikte gelöst werden sollen, falls Schreibvorgänge aus verschiedenen Regionen zu Konflikten mit Elementen im Container im Azure Cosmos DB-Dienst führen.

Conflicts

Vorgänge zum Lesen/Abfragen von Konflikten in einem Azure Cosmos-Container.

Container

Vorgänge zum Lesen, Ersetzen oder Löschen eines bestimmten vorhandenen Containers oder Elements in einem Container nach ID. Es gibt zwei verschiedene Arten von Vorgängen.

  1. Die Objektvorgänge, bei denen das Element bei Anforderung/Antwort serialisiert und deserialisiert wird
  2. Die Streamantwort, die einen Stream mit einem serialisierten JSON-Objekt annimmt und eine Antwort zurückgibt, die eine Stream See Database zum Erstellen neuer Container und zum Lesen/Abfragen aller Container enthält.
ContainerProperties

Stellt einen Dokumentcontainer im Azure Cosmos DB-Dienst dar. Ein Container ist ein benannter logischer Container für Dokumente.

ContainerRequestOptions

Die Optionen für die Anforderung von Cosmos-Containern

ContainerResponse

Die Cosmos-Containerantwort

CosmosClient

Stellt eine clientseitige logische Darstellung des Azure Cosmos DB-Kontos bereit. Dieser Client kann zum Konfigurieren und Ausführen von Anforderungen im Azure Cosmos DB-Datenbankdienst verwendet werden.

CosmosClient ist threadsicher. Es wird empfohlen, eine einzelne instance von CosmosClient pro Lebensdauer der Anwendung beizubehalten, was eine effiziente Verbindungsverwaltung und -leistung ermöglicht. Weitere Informationen finden Sie im Leistungsleitfaden.

CosmosClientOptions

Definiert alle konfigurierbaren Optionen, die für CosmosClient erforderlich sind.

CosmosClientTelemetryOptions

Telemetrieoptionen für Den Cosmos-Client zum Aktivieren/Deaktivieren von Telemetriedaten und verteilter Ablaufverfolgung zusammen mit den entsprechenden Schwellenwerten.

CosmosDiagnostics

Enthält die Cosmos-Diagnoseinformationen für die aktuelle Anforderung an den Azure Cosmos DB-Dienst.

CosmosException

Die Cosmos-Client-Ausnahme

CosmosLinqSerializerOptions

Diese Klasse bietet eine Möglichkeit zum Konfigurieren der Linq-Serialisierungseigenschaften.

CosmosOperationCanceledException

Die Ausnahme, die in einem Thread beim Abbrechen eines vom Thread ausgeführten Vorgangs ausgelöst wird. Dadurch wird die OperationCanceledException um die Diagnose des abgebrochenen Vorgangs erweitert.

CosmosResponseFactory

Diese Antwortfactory konvertiert Antwortnachrichten mithilfe des CosmosClient-Serialisierungsprogramms in die entsprechende Typantwort.

CosmosSerializationOptions

Diese Klasse bietet eine Möglichkeit zum Konfigurieren grundlegender Serialisierungseinstellungen.

CosmosSerializer

Dies ist eine Schnittstelle, mit der ein benutzerdefiniertes Serialisierungsprogramm vom CosmosClient verwendet werden kann.

CosmosThresholdOptions

Schwellenwerte für die verteilte Ablaufverfolgung

Database

Vorgänge zum Lesen oder Löschen einer vorhandenen Datenbank.

Weitere Informationen finden Sie Client unter Erstellen neuer Datenbanken und Lesen/Abfragen aller Datenbanken. Verwenden Sie client.Databases.

DatabaseProperties

Stellt eine Datenbank im Azure Cosmos DB-Konto dar.

DatabaseResponse

Die Cosmos-Datenbankantwort

DedicatedGatewayRequestOptions

Die Optionen für die Anforderung für dedizierte Gateways

EncryptionKeyWrapMetadata

Metadaten, die zum Umschließen/Entpacken eines Datenverschlüsselungsschlüssels mithilfe eines kundenseitig verwalteten Schlüssels verwendet werden können. Weitere Informationen zur Unterstützung der clientseitigen Verschlüsselung in Azure Cosmos DB finden Sie https://aka.ms/CosmosClientEncryption unter .

ExcludedPath

Gibt einen Pfad innerhalb eines JSON-Dokuments an, der beim Indizieren von Daten für den Azure Cosmos DB-Dienst ausgeschlossen werden soll.

FeedIterator

Cosmos Resultset-Iterator, der das Fortsetzungstoken beim Abrufen von Ergebnissen aus einer Abfrage nachverfolgt.

FeedIterator<T>

Cosmos Resultset-Iterator, der das Fortsetzungstoken beim Abrufen von Ergebnissen aus einer Abfrage nachverfolgt.

FeedRange

Stellt eine Einheit des Feedverbrauchs dar, die als Einheit der Parallelität verwendet werden kann.

FeedResponse<T>

Der Benutzervertrag für die verschiedenen Feedantworten, die die Antworten in einen Typ serialisiert haben. Um dem .NET-Standard für typisierte Antworten zu folgen, sollten alle Ausnahmen für den Benutzer ausgelöst werden.

GeospatialConfig

Stellt die georäumliche Konfiguration für eine Sammlung im Azure Cosmos DB-Dienst dar.

Headers

Für Anforderung und Antworten verwendete Headerimplementierung

IncludedPath

Gibt einen Pfad innerhalb eines JSON-Dokuments an, der in den Azure Cosmos DB-Dienst eingeschlossen werden soll.

IndexingPolicy

Stellt die Indizierungsrichtlinienkonfiguration für eine Sammlung im Azure Cosmos DB-Dienst dar.

ItemRequestOptions

Cosmos-Elementanforderungsoptionen

ItemResponse<T>

Die Cosmos-Elementantwort

PartitionKeyBuilder

Stellt eine Partitionsschlüsselwertliste im Azure Cosmos DB-Dienst dar.

PatchItemRequestOptions

Cosmos Patch-Anforderungsoptionen

PatchOperation

Details zum Patchvorgang, der auf das verwiesene Cosmos-Element angewendet werden soll.

PatchOperation<T>

Definiert PatchOperation mit einem value-Parameter.

Permission

Vorgänge zum Lesen, Ersetzen oder Löschen einer bestimmten Berechtigung nach ID. Berechtigungen werden zum Erstellen von ResourceTokens verwendet. Ressourcentoken ermöglichen den Zugriff auf die Anwendungsressourcen in einer Datenbank. Ressourcentoken:

  • Ermöglichen den Zugriff auf bestimmte Container, Partitionsschlüssel, Dokumente, Anhänge, gespeicherte Prozeduren, Trigger und benutzerdefinierte Funktionen.
  • Werden erstellt, wenn einem BenutzerBerechtigungen für eine bestimmte Ressource gewährt werden.
  • Werden neu erstellt, wenn durch einen POST-, GET- oder PUT-Aufruf eine Aktion für eine Berechtigungsressource ausgeführt wird.
  • Verwenden ein Hashressourcentoken, das speziell für den Benutzer, die Ressource und die Berechtigung erstellt wird.
  • Verfügen über einen anpassbaren Gültigkeitszeitraum. Die Gültigkeitsdauer beträgt standardmäßig eine Stunde. Die Gültigkeitsdauer des Tokens kann bis maximal 24 Stunden angegeben werden.
  • Stellen eine sichere Alternative zur Weitergabe des Hauptschlüssels dar.
  • Ermöglichen Clients das Lesen, Schreiben und Löschen von Ressourcen im Cosmos DB-Konto gemäß den gewährten Berechtigungen.
PermissionProperties

Stellt eine Berechtigung im Azure Cosmos DB-Dienst dar.

PermissionResponse

Die Cosmos-Berechtigungsantwort

QueryDefinition

Definiert eine Cosmos SQL-Abfrage.

QueryRequestOptions

Die Cosmos-Abfrageanforderungsoptionen

ReadManyRequestOptions

Die Cosmos-Abfrageanforderungsoptionen

Regions

Die LocationNames-Klasse enthält die Namen der Azure-Regionen, die derzeit vom Azure Cosmos DB-Dienst unterstützt werden.

RequestHandler

Abstraktion, die das Definieren von benutzerdefinierten Nachrichtenhandlern ermöglicht.

RequestMessage

Stellt eine Anforderung in der Verarbeitungspipeline des Azure Cosmos DB SDK dar.

RequestOptions

Die Cosmos-Standardanforderungsoptionen

Response<T>

Die Cosmos-Ressourcenantwortklasse

ResponseMessage

Stellt eine Antwort des Azure Cosmos DB-Diensts dar.

ServerSideCumulativeMetrics

Metriken, die für Abfragen vom Back-End empfangen werden.

ServerSideMetrics

Metriken, die für Abfragen vom Back-End empfangen werden.

ServerSidePartitionedMetrics

Stellt serverseitige Metriken dar, die für eine einzelne Partition spezifisch sind.

SpatialPath

Spezifikation für räumlichen Index

ThroughputProperties

Stellt einen Durchsatz der Ressourcen im Azure Cosmos DB-Dienst dar. Dies ist der Standardpreis für die Ressource im Azure Cosmos DB-Dienst.

ThroughputResponse

Die Cosmos-Durchsatzantwort

TransactionalBatch

Stellt einen Batch von Vorgängen für Elemente mit demselben PartitionKey in einem Container dar, der auf transaktionale Weise im Azure Cosmos DB-Dienst ausgeführt wird. Verwenden Sie CreateTransactionalBatch(PartitionKey) , um eine instance von TransactionalBatch zu erstellen.

TransactionalBatchItemRequestOptions

RequestOptions , die für einen Vorgang in einem TransactionalBatchgilt.

TransactionalBatchOperationResult

Stellt ein Ergebnis für einen bestimmten Vorgang dar, der Teil einer TransactionalBatch Anforderung war.

TransactionalBatchOperationResult<T>

Stellt ein Ergebnis für einen bestimmten Vorgang dar, der Teil eines Batches ist.

TransactionalBatchPatchItemRequestOptions

Cosmos Batch Patch-Anforderungsoptionen

TransactionalBatchRequestOptions

Cosmos-Batchanforderungsoptionen.

TransactionalBatchResponse

Antwort auf eine TransactionalBatch Anforderung.

UniqueKey

Stellt einen eindeutigen Schlüssel für dar, der die Eindeutigkeitseinschränkung für Dokumente in der Sammlung im Azure Cosmos DB-Dienst erzwingt.

UniqueKeyPolicy

Stellt die Richtlinienkonfiguration für eindeutige Schlüssel zum Angeben von Eindeutigkeitseinschränkungen für Dokumente in der Sammlung im Azure Cosmos DB-Dienst dar.

User

Vorgänge zum Lesen, Ersetzen oder Löschen eines bestimmten vorhandenen Benutzers nach ID und Abfragen der Berechtigungen eines Benutzers.

UserProperties

Stellt einen Benutzer im Azure Cosmos DB-Dienst dar.

UserResponse

Die Cosmos-Benutzerantwort

Strukturen

PartitionKey

Stellt einen Partitionsschlüsselwert im Azure Cosmos DB-Dienst dar.

Enumerationen

CompositePathSortOrder

Definiert den Zieldatentyp einer Indexpfadspezifikation im Azure Cosmos DB-Dienst.

ConflictResolutionMode

Gibt die unterstützten Konfliktauflösungsmodi an, wie in angegeben ConflictResolutionPolicy

ConnectionMode

Stellt den Verbindungsmodus dar, der vom Client beim Herstellen einer Verbindung mit dem Azure Cosmos DB-Dienst verwendet werden soll.

ConsistencyLevel

Dies sind die vom Azure Cosmos DB-Dienst unterstützten Konsistenzebenen.

CosmosPropertyNamingPolicy

Bestimmt die Benennungsrichtlinie, die verwendet wird, um einen zeichenfolgenbasierten Namen in ein anderes Format zu konvertieren, z. B. eine Kamel-Großschreibung, bei der der erste Buchstabe Kleinbuchstaben ist.

DataType

Definiert den Zieldatentyp einer Indexpfadspezifikation im Azure Cosmos DB-Dienst.

GeospatialType

Gibt die unterstützten georäumlichen Typen im Azure Cosmos DB-Dienst an.

IndexingDirective

Gibt an, ob die Ressource in der Azure Cosmos DB-Datenbank indiziert werden soll.

IndexingMode

Gibt die unterstützten Indizierungsmodi im Azure Cosmos DB-Dienst an.

IndexKind

Dies sind die Indizierungstypen, die für die Indizierung eines Pfads im Azure Cosmos DB-Dienst verfügbar sind.

OperationKind

Dies sind die Vorgangstypen, die zu einem Versionskonflikt für eine Ressource geführt haben.

PartitionKeyDefinitionVersion

Partitionierungsversion.

PatchOperationType

Beschreibt die Liste der von Patch unterstützten Vorgangstypen.

PermissionMode

Dies sind die Zugriffsberechtigungen zum Erstellen oder Ersetzen einer PermissionProperties Ressource im Azure Cosmos DB-Dienst.

PortReuseMode

Vom Transportstapel verwendete Optionen für die Portwiederverwendung

SpatialType

Definiert den Zieldatentyp einer Indexpfadspezifikation im Azure Cosmos DB-Dienst.

Delegaten

Container.ChangeFeedHandler<T>

Delegat, um die Änderungen innerhalb einer ChangeFeedProcessor Ausführung zu empfangen.

Container.ChangeFeedHandlerWithManualCheckpoint<T>

Delegat, um die Änderungen innerhalb einer ChangeFeedProcessor Ausführung mit einem manuellen Prüfpunkt zu empfangen.

Container.ChangeFeedMonitorErrorDelegate

Delegat, um Fehler bei Änderungsfeedvorgängen zu benachrichtigen.

Container.ChangeFeedMonitorLeaseAcquireDelegate

Delegat, um Ereignisse über Leases zu benachrichtigen, die von einem Änderungsfeedprozessor abgerufen werden.

Container.ChangeFeedMonitorLeaseReleaseDelegate

Delegat, um Ereignisse zu benachrichtigen, wenn Leases von einem Änderungsfeedprozessor freigegeben werden.

Container.ChangeFeedStreamHandler

Delegat, um die Änderungen innerhalb einer ChangeFeedProcessor Ausführung zu empfangen.

Container.ChangeFeedStreamHandlerWithManualCheckpoint

Delegat, um die Änderungen innerhalb einer ChangeFeedProcessor Ausführung mit einem manuellen Prüfpunkt zu empfangen.

Container.ChangesEstimationHandler

Delegat, um die Schätzung der ausstehenden Änderungen zu erhalten, die vom zugeordneten ChangeFeedProcessor instance gelesen werden sollen.

Container.ChangesHandler<T>

Delegat, um die Änderungen innerhalb einer ChangeFeedProcessor Ausführung zu empfangen.