CosmosClient Construtores

Referência

Definição

Namespace:: Microsoft.Azure.Cosmos

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

Pacote:: Microsoft.Azure.Cosmos v3.36.0

Importante

Algumas informações se referem a produtos de pré-lançamento que podem ser substancialmente modificados antes do lançamento. A Microsoft não oferece garantias, expressas ou implícitas, das informações aqui fornecidas.

Sobrecargas

CosmosClient()	Criar um novo CosmosClient usado para testes fictícios
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 que permite o gerenciamento e o desempenho de conexões eficientes. Consulte o guia de desempenho.
CosmosClient(String, AzureKeyCredential, CosmosClientOptions)	Cria um novo CosmosClient com a cadeia de caracteres de URI do ponto de extremidade da conta e AzureKeyCredential. O 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 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 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 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.

CosmosClient()

Criar um novo CosmosClient usado para testes fictícios

protected CosmosClient ();

Protected Sub New ()

Aplica-se a

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

public CosmosClient (string connectionString, Microsoft.Azure.Cosmos.CosmosClientOptions clientOptions = default);

new Microsoft.Azure.Cosmos.CosmosClient : string * Microsoft.Azure.Cosmos.CosmosClientOptions -> Microsoft.Azure.Cosmos.CosmosClient

Public Sub New (connectionString As String, Optional clientOptions As CosmosClientOptions = Nothing)

Parâmetros

connectionString: String

O cadeia de conexão para a conta do Cosmos. ex: AccountEndpoint=https://XXXXX.documents.azure.com:443/; AccountKey=SuperSecretKey;

clientOptions: CosmosClientOptions

Opções de cliente (opcional)

Exemplos

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(
            "account-endpoint-from-portal", 
            "account-key-from-portal", 
            new CosmosClientOptions()
            {
                ApplicationRegion = Regions.EastUS2,
            });

// Dispose cosmosClient at application exit

Comentários

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

Confira também

Aplica-se a

CosmosClient(String, AzureKeyCredential, CosmosClientOptions)

Cria um novo CosmosClient com a cadeia de caracteres de URI do ponto de extremidade da conta e AzureKeyCredential. O AzureKeyCredential permite alterar/atualizar master-key/ResourceToken enquanto o CosmosClient ainda está em uso.

public CosmosClient (string accountEndpoint, Azure.AzureKeyCredential authKeyOrResourceTokenCredential, Microsoft.Azure.Cosmos.CosmosClientOptions clientOptions = default);

new Microsoft.Azure.Cosmos.CosmosClient : string * Azure.AzureKeyCredential * Microsoft.Azure.Cosmos.CosmosClientOptions -> Microsoft.Azure.Cosmos.CosmosClient

Public Sub New (accountEndpoint As String, authKeyOrResourceTokenCredential As AzureKeyCredential, Optional clientOptions As CosmosClientOptions = Nothing)

Parâmetros

accountEndpoint: String

O ponto de extremidade de serviço do Cosmos a ser usado

authKeyOrResourceTokenCredential: AzureKeyCredential

AzureKeyCredential com master chave ou token de recurso..

clientOptions: CosmosClientOptions

Opções de cliente (opcional)

Exemplos

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

using Microsoft.Azure.Cosmos;

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

....

// To udpate key/credentials 
keyCredential.Update("updated master-key/ResourceToken");

// Dispose cosmosClient at application exit

Comentários

O AzureKeyCredential permite alterar/atualizar master-key/ResourceToken whle CosmosClient ainda está em uso. A referência retornada não garante credenciais ou validações de conectividade porque a criação não faz chamadas de rede.

Confira também

Aplica-se a

CosmosClient(String, TokenCredential, CosmosClientOptions)

Cria um novo CosmosClient com a cadeia de caracteres de URI do ponto de extremidade da conta e TokenCredential.

public CosmosClient (string accountEndpoint, Azure.Core.TokenCredential tokenCredential, Microsoft.Azure.Cosmos.CosmosClientOptions clientOptions = default);

new Microsoft.Azure.Cosmos.CosmosClient : string * Azure.Core.TokenCredential * Microsoft.Azure.Cosmos.CosmosClientOptions -> Microsoft.Azure.Cosmos.CosmosClient

Public Sub New (accountEndpoint As String, tokenCredential As TokenCredential, Optional clientOptions As CosmosClientOptions = Nothing)

Parâmetros

accountEndpoint: String

O ponto de extremidade de serviço cosmos a ser usado.

tokenCredential: TokenCredential

TokenCredentialO token para fornecer o token do AAD para autorização.

clientOptions: CosmosClientOptions

Opções de cliente (opcional)

Comentários

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

Aplica-se a

CosmosClient(String, String, CosmosClientOptions)

Cria um novo CosmosClient com a cadeia de caracteres de URI do ponto de extremidade da conta e a chave da conta.

public CosmosClient (string accountEndpoint, string authKeyOrResourceToken, Microsoft.Azure.Cosmos.CosmosClientOptions clientOptions = default);

new Microsoft.Azure.Cosmos.CosmosClient : string * string * Microsoft.Azure.Cosmos.CosmosClientOptions -> Microsoft.Azure.Cosmos.CosmosClient

Public Sub New (accountEndpoint As String, authKeyOrResourceToken As String, Optional clientOptions As CosmosClientOptions = Nothing)

Parâmetros

accountEndpoint: String

O ponto de extremidade de serviço do Cosmos a ser usado

authKeyOrResourceToken: String

A chave da conta cosmos ou o token de recurso a ser usado para criar o cliente.

clientOptions: CosmosClientOptions

Opções de cliente (opcional)

Exemplos

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,
            });

// Dispose cosmosClient at application exit

Comentários

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

Confira também

Aplica-se a

Partilhar via

CosmosClient Construtores

Definição

Sobrecargas

CosmosClient()

Aplica-se a

CosmosClient(String, CosmosClientOptions)

Parâmetros

Exemplos

Comentários

Confira também

Aplica-se a

CosmosClient(String, AzureKeyCredential, CosmosClientOptions)

Parâmetros

Exemplos

Comentários

Confira também

Aplica-se a

CosmosClient(String, TokenCredential, CosmosClientOptions)

Parâmetros

Comentários

Aplica-se a

CosmosClient(String, String, CosmosClientOptions)

Parâmetros

Exemplos

Comentários

Confira também

Aplica-se a

Recursos adicionais