CosmosClient Classe

Definição

Namespace:

Microsoft.Azure.Cosmos

Assembly:

Microsoft.Azure.Cosmos.Client.dll

Pacote:

Microsoft.Azure.Cosmos v3.39.0

Origem:

CosmosClient.cs

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, o que permite o gerenciamento e o desempenho de conexões eficientes. Consulte o guia de desempenho.

public class CosmosClient : IDisposable

type CosmosClient = class
    interface IDisposable

Public Class CosmosClient
Implements IDisposable

Herança

Object

CosmosClient

Implementações

IDisposable

Exemplos

Este exemplo cria um CosmosClient, Databasee um Container. O CosmosClient é criado com o cadeia de conexão e configurado para usar a região "Leste dos EUA 2".

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

Este exemplo cria um CosmosClient, Databasee um Container. O CosmosClient é criado com AccountEndpoint, AccountKey ou ResourceToken e configurado para usar a região "Leste dos EUA 2".

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

Este exemplo cria um CosmosClient, Databasee um Container. O CosmosClient é criado por meio do padrão de construtor usando CosmosClientBuilder.

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

Comentários

A referência não inicializada retornada não garante credenciais ou validações de conectividade porque a criação não faz nenhuma chamada de rede

Construtores

CosmosClient()	Criar um novo CosmosClient usado para testes fictícios
CosmosClient(String, AzureKeyCredential, CosmosClientOptions)	Cria um novo CosmosClient com a cadeia de caracteres de URI do ponto de extremidade da conta e AzureKeyCredential. AzureKeyCredential permite alterar/atualizar master-key/ResourceToken enquanto o CosmosClient ainda está em uso. O CosmosClient é thread-safe. É recomendável manter uma única instância do CosmosClient por tempo de vida do aplicativo, o que permite o gerenciamento e o desempenho de conexões eficientes. Consulte o guia de desempenho.
CosmosClient(String, CosmosClientOptions)	Cria um novo CosmosClient com o cadeia de conexão. O CosmosClient é thread-safe. É recomendável manter uma única instância do CosmosClient por tempo de vida do aplicativo, o que permite o gerenciamento e o desempenho de conexões eficientes. Consulte o guia de desempenho.
CosmosClient(String, String, CosmosClientOptions)	Cria um novo CosmosClient com a cadeia de caracteres de URI do ponto de extremidade da conta e a chave de conta. O CosmosClient é thread-safe. É recomendável manter uma única instância do CosmosClient por tempo de vida do aplicativo, o que permite o gerenciamento e o desempenho de conexões eficientes. Consulte o guia de desempenho.
CosmosClient(String, TokenCredential, CosmosClientOptions)	Cria um novo CosmosClient com a cadeia de caracteres de URI do ponto de extremidade da conta e TokenCredential. O CosmosClient é thread-safe. É recomendável manter uma única instância do CosmosClient por tempo de vida do aplicativo, o que permite o gerenciamento e o desempenho de conexões eficientes. Consulte o guia de desempenho.

Propriedades

ClientOptions	O CosmosClientOptions usado inicializa o CosmosClient.
Endpoint	Obtém o URI do ponto de extremidade para o serviço do Azure Cosmos DB.
ResponseFactory	O alocador de resposta usado para criar tipos de resposta do CosmosClient.

Métodos

CreateAndInitializeAsync(String, AzureKeyCredential, IReadOnlyList<ValueTuple<String,String>>, CosmosClientOptions, CancellationToken)	Cria um novo CosmosClient com a cadeia de caracteres de URI do ponto de extremidade da conta e AzureKeyCredential. AzureKeyCredential permite alterar/atualizar master-key/ResourceToken enquanto o CosmosClient ainda está em uso. Além disso, ele inicializa o cliente com contêineres fornecidos, ou seja, o SDK aquece os caches e as conexões antes que a primeira chamada para o serviço seja feita. Use isso para obter menor latência durante a inicialização do aplicativo. O CosmosClient é thread-safe. É recomendável manter uma única instância do CosmosClient por tempo de vida do aplicativo, o que permite o gerenciamento e o desempenho de conexões eficientes. Consulte o guia de desempenho.
CreateAndInitializeAsync(String, IReadOnlyList<ValueTuple<String,String>>, CosmosClientOptions, CancellationToken)	Cria um novo CosmosClient com a cadeia de caracteres de URI do ponto de extremidade da conta e TokenCredential. Além disso, ele inicializa o cliente com contêineres fornecidos, ou seja, o SDK aquece os caches e as conexões antes que a primeira chamada para o serviço seja feita. Use isso para obter menor latência durante a inicialização do aplicativo. O CosmosClient é thread-safe. É recomendável manter uma única instância do CosmosClient por tempo de vida do aplicativo, o que permite o gerenciamento e o desempenho de conexões eficientes. Consulte o guia de desempenho.
CreateAndInitializeAsync(String, String, IReadOnlyList<ValueTuple<String,String>>, CosmosClientOptions, CancellationToken)	Cria um novo CosmosClient com a cadeia de caracteres de URI do ponto de extremidade da conta e TokenCredential. Além disso, ele inicializa o cliente com contêineres fornecidos, ou seja, o SDK aquece os caches e as conexões antes que a primeira chamada para o serviço seja feita. Use isso para obter menor latência durante a inicialização do aplicativo. O CosmosClient é thread-safe. É recomendável manter uma única instância do CosmosClient por tempo de vida do aplicativo, o que permite o gerenciamento e o desempenho de conexões eficientes. Consulte o guia de desempenho.
CreateAndInitializeAsync(String, TokenCredential, IReadOnlyList<ValueTuple<String,String>>, CosmosClientOptions, CancellationToken)	Cria um novo CosmosClient com a cadeia de caracteres de URI do ponto de extremidade da conta e TokenCredential. Além disso, ele inicializa o cliente com contêineres fornecidos, ou seja, o SDK aquece os caches e as conexões antes que a primeira chamada para o serviço seja feita. Use isso para obter menor latência durante a inicialização do aplicativo. O CosmosClient é thread-safe. É recomendável manter uma única instância do CosmosClient por tempo de vida do aplicativo, o que permite o gerenciamento e o desempenho de conexões eficientes. Consulte o guia de desempenho.
CreateDatabaseAsync(String, Nullable<Int32>, RequestOptions, CancellationToken)	Envia uma solicitação para criar um banco de dados. Um banco de dados gerencia usuários, permissões e um conjunto de contêineres. Cada conta de banco de dados do Azure Cosmos DB é capaz de dar suporte a vários bancos de dados nomeados independentes, sendo o banco de dados o contêiner lógico para dados. Cada Banco de Dados consiste em um ou mais contêineres, cada um dos quais, por sua vez, contém um ou mais documentos. Como os bancos de dados são um recurso administrativo, a Chave Mestra de Serviço será necessária para acessar e concluir com êxito qualquer ação usando as APIs de Usuário.
CreateDatabaseAsync(String, ThroughputProperties, RequestOptions, CancellationToken)	Envia uma solicitação para criar um banco de dados. Um banco de dados gerencia usuários, permissões e um conjunto de contêineres. Cada conta de banco de dados do Azure Cosmos DB é capaz de dar suporte a vários bancos de dados nomeados independentes, sendo o banco de dados o contêiner lógico para dados. Cada Banco de Dados consiste em um ou mais contêineres, cada um dos quais, por sua vez, contém um ou mais documentos. Como os bancos de dados são um recurso administrativo, a Chave Mestra de Serviço será necessária para acessar e concluir com êxito qualquer ação usando as APIs de Usuário.
CreateDatabaseIfNotExistsAsync(String, Nullable<Int32>, RequestOptions, CancellationToken)	Verifique se existe um banco de dados e, se não existir, crie-o. Somente a ID do banco de dados é usada para verificar se há um banco de dados existente. Outras propriedades de banco de dados, como taxa de transferência, não são validadas e podem ser diferentes e, em seguida, as propriedades passadas. Um banco de dados gerencia usuários, permissões e um conjunto de contêineres. Cada conta de banco de dados do Azure Cosmos DB é capaz de dar suporte a vários bancos de dados nomeados independentes, sendo o banco de dados o contêiner lógico para dados. Cada Banco de Dados consiste em um ou mais contêineres, cada um dos quais, por sua vez, contém um ou mais documentos. Como os bancos de dados são um recurso administrativo, a Chave Mestra de Serviço será necessária para acessar e concluir com êxito qualquer ação usando as APIs de Usuário.
CreateDatabaseIfNotExistsAsync(String, ThroughputProperties, RequestOptions, CancellationToken)	Verifique se existe um banco de dados e, se não existir, crie-o. Somente a ID do banco de dados é usada para verificar se há um banco de dados existente. Outras propriedades de banco de dados, como taxa de transferência, não são validadas e podem ser diferentes e, em seguida, as propriedades passadas. Um banco de dados gerencia usuários, permissões e um conjunto de contêineres. Cada conta de banco de dados do Azure Cosmos DB é capaz de dar suporte a vários bancos de dados nomeados independentes, sendo o banco de dados o contêiner lógico para dados. Cada Banco de Dados consiste em um ou mais contêineres, cada um dos quais, por sua vez, contém um ou mais documentos. Como os bancos de dados são um recurso administrativo, a Chave Mestra de Serviço será necessária para acessar e concluir com êxito qualquer ação usando as APIs de Usuário.
CreateDatabaseStreamAsync(DatabaseProperties, Nullable<Int32>, RequestOptions, CancellationToken)	Envie uma solicitação para criar um banco de dados. Um banco de dados gerencia usuários, permissões e um conjunto de contêineres. Cada conta de banco de dados do Azure Cosmos DB é capaz de dar suporte a vários bancos de dados nomeados independentes, sendo o banco de dados o contêiner lógico para dados. Cada Banco de Dados consiste em um ou mais contêineres, cada um dos quais, por sua vez, contém um ou mais documentos. Como os bancos de dados são um recurso administrativo, a Chave Mestra de Serviço será necessária para acessar e concluir com êxito qualquer ação usando as APIs de Usuário.
Dispose()	Descartar o cliente cosmos
Dispose(Boolean)	Descartar o cliente cosmos
GetContainer(String, String)	Retorna uma referência de proxy a um contêiner.
GetDatabase(String)	Retorna uma referência de proxy a um banco de dados.
GetDatabaseQueryIterator<T>(QueryDefinition, String, QueryRequestOptions)	Esse método cria uma consulta para bancos de dados em uma conta do Cosmos DB usando uma instrução SQL com valores parametrizados. Ele retorna um FeedIterator. Para obter mais informações sobre como preparar instruções SQL com valores parametrizados, consulte QueryDefinition.
GetDatabaseQueryIterator<T>(String, String, QueryRequestOptions)	Esse método cria uma consulta para bancos de dados em uma conta do Cosmos DB usando uma instrução SQL. Ele retorna um FeedIterator.
GetDatabaseQueryStreamIterator(QueryDefinition, String, QueryRequestOptions)	Esse método cria uma consulta para bancos de dados em uma conta do Cosmos DB usando uma instrução SQL com valores parametrizados. Ele retorna um FeedIterator. Para obter mais informações sobre como preparar instruções SQL com valores parametrizados, consulte QueryDefinition.
GetDatabaseQueryStreamIterator(String, String, QueryRequestOptions)	Esse método cria uma consulta para bancos de dados em uma conta do Cosmos DB usando uma instrução SQL. Ele retorna um FeedIterator.
ReadAccountAsync()	Lê o AccountProperties da conta do Azure Cosmos DB.

Confira também

• CosmosClientBuilder
• CosmosClientOptions