CosmosClient Classe

Definição

Namespace:

Azure.Cosmos

Assembly:

Azure.Cosmos.dll

Pacote:

Azure.Cosmos v4.0.0-preview3

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 em https://docs.microsoft.com/azure/cosmos-db/performance-tips.

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, CosmosDatabasee um CosmosContainer. O CosmosClient é criado com a cadeia de conexão e configurado para usar a região "Leste dos EUA 2".

using Azure.Cosmos;

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

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

// Dispose cosmosClient at application exit

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

using Azure.Cosmos;

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

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

// Dispose cosmosClient at application exit

Este exemplo cria um CosmosClient, CosmosDatabasee um CosmosContainer. O CosmosClient é criado por meio do padrão CosmosClientBuilderde construtor .

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

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

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

// Dispose cosmosClient at application exit

Comentários

https://docs.microsoft.com/azure/cosmos-db/performance-tips https://docs.microsoft.com/azure/cosmos-db/troubleshoot-dot-net-sdk https://docs.microsoft.com/azure/cosmos-db/distribute-data-globally https://docs.microsoft.com/azure/cosmos-db/partitioning-overview https://docs.microsoft.com/azure/cosmos-db/request-units

Construtores

CosmosClient()	Criar um novo CosmosClient usado para testes fictícios
CosmosClient(String, CosmosClientOptions)	Criar um novo CosmosClient com a cadeia de conexão 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 em https://docs.microsoft.com/azure/cosmos-db/performance-tips.
CosmosClient(String, String, CosmosClientOptions)	Criar um novo CosmosClient com a cadeia de caracteres de URI do ponto de extremidade da conta e a chave da conta 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 em https://docs.microsoft.com/azure/cosmos-db/performance-tips.

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.

Métodos

CreateDatabaseAsync(String, 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 do 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 do 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 do 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, CancellationToken)	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, CancellationToken)	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. Para obter mais informações sobre como preparar instruções SQL com valores parametrizados, consulte QueryDefinition sobrecarga.
GetDatabaseQueryStreamIterator(QueryDefinition, String, QueryRequestOptions, CancellationToken)	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, CancellationToken)	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. Para obter mais informações sobre como preparar instruções SQL com valores parametrizados, consulte QueryDefinition sobrecarga.
ReadAccountAsync()	Ler as propriedades da conta do Azure Cosmos DB AccountProperties