CosmosClient Klasse

Referenz

Definition

Namespace:: Microsoft.Azure.Cosmos

Assembly:: Microsoft.Azure.Cosmos.Client.dll

Paket:: Microsoft.Azure.Cosmos v3.39.0

Quelle:: CosmosClient.cs

Wichtig

Einige Informationen beziehen sich auf Vorabversionen, die vor dem Release ggf. grundlegend überarbeitet werden. Microsoft übernimmt hinsichtlich der hier bereitgestellten Informationen keine Gewährleistungen, seien sie ausdrücklich oder konkludent.

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.

public class CosmosClient : IDisposable

type CosmosClient = class
    interface IDisposable

Public Class CosmosClient
Implements IDisposable

Vererbung: Object
CosmosClient

Implementiert: IDisposable

Beispiele

In diesem Beispiel wird ein CosmosClient, Databaseund ein Containererstellt. Der CosmosClient wird mit der Verbindungszeichenfolge erstellt und für die Verwendung der Region "USA, Osten 2" konfiguriert.

using Microsoft.Azure.Cosmos;

CosmosClient cosmosClient = new CosmosClient(
            "connection-string-from-portal", 
            new CosmosClientOptions()
            {
                ApplicationRegion = Regions.EastUS2,
            });

Database db = await cosmosClient.CreateDatabaseAsync("database-id");
Container container = await db.CreateContainerAsync("container-id");

// Dispose cosmosClient at application exit

In diesem Beispiel werden , CosmosClient Databaseund erstelltContainer. Der CosmosClient wird mit der Region "AccountEndpoint", "AccountKey" oder "ResourceToken" erstellt und für die Verwendung der Region "USA, Osten 2" konfiguriert.

using Microsoft.Azure.Cosmos;

CosmosClient cosmosClient = new CosmosClient(
            "account-endpoint-from-portal", 
            "account-key-from-portal", 
            new CosmosClientOptions()
            {
                ApplicationRegion = Regions.EastUS2,
            });

Database db = await cosmosClient.CreateDatabaseAsync("database-id");
Container container = await db.CreateContainerAsync("container-id");

// Dispose cosmosClient at application exit

In diesem Beispiel werden , CosmosClient Databaseund erstelltContainer. Der CosmosClient wird mithilfe des Generatormusters CosmosClientBuildererstellt.

using Microsoft.Azure.Cosmos;
using Microsoft.Azure.Cosmos.Fluent;

CosmosClient cosmosClient = new CosmosClientBuilder("connection-string-from-portal")
    .WithApplicationRegion("East US 2")
    .Build();

Database db = await cosmosClient.CreateDatabaseAsync("database-id")
Container container = await db.CreateContainerAsync("container-id");

// Dispose cosmosClient at application exit

Hinweise

Der zurückgegebene nicht initialisierte Verweis garantiert keine Anmeldeinformationen oder Konnektivitätsüberprüfungen, da bei der Erstellung keine Netzwerkaufrufe ausgeführt werden.

Konstruktoren

CosmosClient()	Erstellen eines neuen CosmosClients, der für Pseudotests verwendet wird
CosmosClient(String, AzureKeyCredential, CosmosClientOptions)	Erstellt einen neuen CosmosClient mit der URI-Zeichenfolge des Kontoendpunkts und AzureKeyCredential. AzureKeyCredential ermöglicht das Ändern/Aktualisieren master-key/ResourceToken, während CosmosClient noch verwendet wird. 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.
CosmosClient(String, CosmosClientOptions)	Erstellt einen neuen CosmosClient mit dem Verbindungszeichenfolge. 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.
CosmosClient(String, String, CosmosClientOptions)	Erstellt einen neuen CosmosClient mit der URI-Zeichenfolge des Kontoendpunkts und dem Kontoschlüssel. 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.
CosmosClient(String, TokenCredential, CosmosClientOptions)	Erstellt einen neuen CosmosClient mit der URI-Zeichenfolge des Kontoendpunkts und TokenCredential. 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.

Eigenschaften

ClientOptions	Der CosmosClientOptions verwendete initialisiert CosmosClient.
Endpoint	Ruft den Endpunkt-URI für den Azure Cosmos DB-Dienst ab.
ResponseFactory	Die Antwortfactory, die zum Erstellen von CosmosClient-Antworttypen verwendet wird.

Methoden

CreateAndInitializeAsync(String, AzureKeyCredential, IReadOnlyList<ValueTuple<String,String>>, CosmosClientOptions, CancellationToken)	Erstellt einen neuen CosmosClient mit der URI-Zeichenfolge des Kontoendpunkts und AzureKeyCredential. AzureKeyCredential ermöglicht das Ändern/Aktualisieren master-key/ResourceToken, während CosmosClient noch verwendet wird. Darüber hinaus initialisiert es den Client mit bereitgestellten Containern, d. h. das SDK erwärmt die Caches und Verbindungen, bevor der erste Aufruf des Diensts erfolgt. Verwenden Sie dies, um beim Starten Ihrer Anwendung eine geringere Latenz zu erzielen. 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.
CreateAndInitializeAsync(String, IReadOnlyList<ValueTuple<String,String>>, CosmosClientOptions, CancellationToken)	Erstellt einen neuen CosmosClient mit der URI-Zeichenfolge des Kontoendpunkts und TokenCredential. Darüber hinaus initialisiert es den Client mit bereitgestellten Containern, d. h. das SDK erwärmt die Caches und Verbindungen, bevor der erste Aufruf des Diensts erfolgt. Verwenden Sie dies, um beim Starten Ihrer Anwendung eine geringere Latenz zu erzielen. 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.
CreateAndInitializeAsync(String, String, IReadOnlyList<ValueTuple<String,String>>, CosmosClientOptions, CancellationToken)	Erstellt einen neuen CosmosClient mit der URI-Zeichenfolge des Kontoendpunkts und TokenCredential. Darüber hinaus initialisiert es den Client mit bereitgestellten Containern, d. h. das SDK erwärmt die Caches und Verbindungen, bevor der erste Aufruf des Diensts erfolgt. Verwenden Sie dies, um beim Starten Ihrer Anwendung eine geringere Latenz zu erzielen. 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.
CreateAndInitializeAsync(String, TokenCredential, IReadOnlyList<ValueTuple<String,String>>, CosmosClientOptions, CancellationToken)	Erstellt einen neuen CosmosClient mit der URI-Zeichenfolge des Kontoendpunkts und TokenCredential. Darüber hinaus initialisiert es den Client mit bereitgestellten Containern, d. h. das SDK erwärmt die Caches und Verbindungen, bevor der erste Aufruf des Diensts erfolgt. Verwenden Sie dies, um beim Starten Ihrer Anwendung eine geringere Latenz zu erzielen. 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.
CreateDatabaseAsync(String, Nullable<Int32>, RequestOptions, CancellationToken)	Sendet eine Anforderung zum Erstellen einer Datenbank. Eine Datenbank verwaltet Benutzer, Berechtigungen und eine Reihe von Containern. Jedes Azure Cosmos DB-Datenbankkonto kann mehrere unabhängige benannte Datenbanken unterstützen, wobei die Datenbank der logische Container für Daten ist. Jede Datenbank besteht aus einem oder mehreren Containern, von denen jeder wiederum ein oder mehrere Dokumente enthält. Da Es sich bei Datenbanken um eine Administrative Ressource handelt, ist der Diensthauptschlüssel erforderlich, um mithilfe der Benutzer-APIs auf alle Aktionen zuzugreifen und diese erfolgreich abzuschließen.
CreateDatabaseAsync(String, ThroughputProperties, RequestOptions, CancellationToken)	Sendet eine Anforderung zum Erstellen einer Datenbank. Eine Datenbank verwaltet Benutzer, Berechtigungen und eine Reihe von Containern. Jedes Azure Cosmos DB-Datenbankkonto kann mehrere unabhängige benannte Datenbanken unterstützen, wobei die Datenbank der logische Container für Daten ist. Jede Datenbank besteht aus einem oder mehreren Containern, von denen jeder wiederum ein oder mehrere Dokumente enthält. Da Es sich bei Datenbanken um eine Administrative Ressource handelt, ist der Diensthauptschlüssel erforderlich, um mithilfe der Benutzer-APIs auf alle Aktionen zuzugreifen und diese erfolgreich abzuschließen.
CreateDatabaseIfNotExistsAsync(String, Nullable<Int32>, RequestOptions, CancellationToken)	Überprüfen Sie, ob eine Datenbank vorhanden ist, und erstellen Sie sie, falls dies nicht der Fall ist. Nur die Datenbank-ID wird verwendet, um zu überprüfen, ob eine Datenbank vorhanden ist. Andere Datenbankeigenschaften wie der Durchsatz werden nicht überprüft und können sich von den übergebenen Eigenschaften unterscheiden. Eine Datenbank verwaltet Benutzer, Berechtigungen und eine Reihe von Containern. Jedes Azure Cosmos DB-Datenbankkonto kann mehrere unabhängige benannte Datenbanken unterstützen, wobei die Datenbank der logische Container für Daten ist. Jede Datenbank besteht aus einem oder mehreren Containern, von denen jeder wiederum ein oder mehrere Dokumente enthält. Da Es sich bei Datenbanken um eine Administrative Ressource handelt, ist der Diensthauptschlüssel erforderlich, um mithilfe der Benutzer-APIs auf alle Aktionen zuzugreifen und diese erfolgreich abzuschließen.
CreateDatabaseIfNotExistsAsync(String, ThroughputProperties, RequestOptions, CancellationToken)	Überprüfen Sie, ob eine Datenbank vorhanden ist, und erstellen Sie sie, falls dies nicht der Fall ist. Nur die Datenbank-ID wird verwendet, um zu überprüfen, ob eine Datenbank vorhanden ist. Andere Datenbankeigenschaften wie der Durchsatz werden nicht überprüft und können sich von den übergebenen Eigenschaften unterscheiden. Eine Datenbank verwaltet Benutzer, Berechtigungen und eine Reihe von Containern. Jedes Azure Cosmos DB-Datenbankkonto kann mehrere unabhängige benannte Datenbanken unterstützen, wobei die Datenbank der logische Container für Daten ist. Jede Datenbank besteht aus einem oder mehreren Containern, von denen jeder wiederum ein oder mehrere Dokumente enthält. Da Es sich bei Datenbanken um eine Administrative Ressource handelt, ist der Diensthauptschlüssel erforderlich, um mithilfe der Benutzer-APIs auf alle Aktionen zuzugreifen und diese erfolgreich abzuschließen.
CreateDatabaseStreamAsync(DatabaseProperties, Nullable<Int32>, RequestOptions, CancellationToken)	Senden Sie eine Anforderung zum Erstellen einer Datenbank. Eine Datenbank verwaltet Benutzer, Berechtigungen und eine Reihe von Containern. Jedes Azure Cosmos DB-Datenbankkonto kann mehrere unabhängige benannte Datenbanken unterstützen, wobei die Datenbank der logische Container für Daten ist. Jede Datenbank besteht aus einem oder mehreren Containern, von denen jeder wiederum ein oder mehrere Dokumente enthält. Da Es sich bei Datenbanken um eine Administrative Ressource handelt, ist der Diensthauptschlüssel erforderlich, um mithilfe der Benutzer-APIs auf alle Aktionen zuzugreifen und diese erfolgreich abzuschließen.
Dispose()	Cosmos-Client verwerfen
Dispose(Boolean)	Cosmos-Client verwerfen
GetContainer(String, String)	Gibt einen Proxyverweis auf einen Container zurück.
GetDatabase(String)	Gibt einen Proxyverweis auf eine Datenbank zurück.
GetDatabaseQueryIterator<T>(QueryDefinition, String, QueryRequestOptions)	Diese Methode erstellt eine Abfrage für Datenbanken unter einem Cosmos DB-Konto mithilfe einer SQL-Anweisung mit parametrisierten Werten. Es gibt einen FeedIterator zurück. Weitere Informationen zum Vorbereiten von SQL-Anweisungen mit parametrisierten Werten finden Sie unter QueryDefinition.
GetDatabaseQueryIterator<T>(String, String, QueryRequestOptions)	Diese Methode erstellt eine Abfrage für Datenbanken unter einem Cosmos DB-Konto mithilfe einer SQL-Anweisung. Es gibt einen FeedIterator zurück.
GetDatabaseQueryStreamIterator(QueryDefinition, String, QueryRequestOptions)	Diese Methode erstellt eine Abfrage für Datenbanken unter einem Cosmos DB-Konto mithilfe einer SQL-Anweisung mit parametrisierten Werten. Es gibt einen FeedIterator zurück. Weitere Informationen zum Vorbereiten von SQL-Anweisungen mit parametrisierten Werten finden Sie unter QueryDefinition.
GetDatabaseQueryStreamIterator(String, String, QueryRequestOptions)	Diese Methode erstellt eine Abfrage für Datenbanken unter einem Cosmos DB-Konto mithilfe einer SQL-Anweisung. Es gibt einen FeedIterator zurück.
ReadAccountAsync()	Liest die AccountProperties für das Azure Cosmos DB-Konto.

Gilt für: