Database.ReadThroughputAsync Método

Definição

Namespace:

Microsoft.Azure.Cosmos

Assembly:

Microsoft.Azure.Cosmos.Client.dll

Pacote:

Microsoft.Azure.Cosmos v3.36.0

Sobrecargas

ReadThroughputAsync(CancellationToken)	Obtém a taxa de transferência do banco de dados na medida das unidades de solicitação por segundo no serviço do Azure Cosmos.
ReadThroughputAsync(RequestOptions, CancellationToken)	Obtém a taxa de transferência do banco de dados na medida das unidades de solicitação por segundo no serviço do Azure Cosmos.

ReadThroughputAsync(CancellationToken)

Obtém a taxa de transferência do banco de dados na medida das unidades de solicitação por segundo no serviço do Azure Cosmos.

public abstract System.Threading.Tasks.Task<int?> ReadThroughputAsync (System.Threading.CancellationToken cancellationToken = default);

abstract member ReadThroughputAsync : System.Threading.CancellationToken -> System.Threading.Tasks.Task<Nullable<int>>

Public MustOverride Function ReadThroughputAsync (Optional cancellationToken As CancellationToken = Nothing) As Task(Of Nullable(Of Integer))

Parâmetros

cancellationToken

CancellationToken

(Opcional) CancellationToken que representa o cancelamento da solicitação.

Retornos

Task<Nullable<Int32>>

Taxa de transferência provisionada em unidades de solicitação por segundo

Exemplos

O exemplo a seguir mostra como obter a taxa de transferência do banco de dados.

int? throughput = await database.ReadThroughputAsync();

Comentários

Valor nulo indica um banco de dados sem taxa de transferência provisionada.

ReadThroughputAsync(RequestOptions, CancellationToken)

Obtém a taxa de transferência do banco de dados na medida das unidades de solicitação por segundo no serviço do Azure Cosmos.

public abstract System.Threading.Tasks.Task<Microsoft.Azure.Cosmos.ThroughputResponse> ReadThroughputAsync (Microsoft.Azure.Cosmos.RequestOptions requestOptions, System.Threading.CancellationToken cancellationToken = default);

abstract member ReadThroughputAsync : Microsoft.Azure.Cosmos.RequestOptions * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Microsoft.Azure.Cosmos.ThroughputResponse>

Public MustOverride Function ReadThroughputAsync (requestOptions As RequestOptions, Optional cancellationToken As CancellationToken = Nothing) As Task(Of ThroughputResponse)

Parâmetros

requestOptions

RequestOptions

As opções para a solicitação de taxa de transferência.

cancellationToken

CancellationToken

(Opcional) CancellationToken que representa o cancelamento da solicitação.

Retornos

Task<ThroughputResponse>

A resposta da taxa de transferência.

Exceções

CosmosException

Essa exceção pode encapsular muitos tipos diferentes de erros. Para determinar o erro específico, sempre examine a propriedade StatusCode. Alguns códigos comuns que você pode obter ao ler uma chave de criptografia do cliente são:

StatusCode	Motivo da exceção
404	NotFound – isso significa que o banco de dados não existe ou não tem nenhuma taxa de transferência atribuída.

Exemplos

O exemplo a seguir mostra como obter a taxa de transferência

 RequestOptions requestOptions = new RequestOptions();
ThroughputProperties throughputProperties = await database.ReadThroughputAsync(requestOptions);
Console.WriteLine($"Throughput: {throughputProperties?.Throughput}");

O exemplo a seguir mostra como obter taxa de transferência, MinThroughput e é substituído em andamento

RequestOptions requestOptions = new RequestOptions();
ThroughputResponse response = await database.ReadThroughputAsync(requestOptions);
Console.WriteLine($"Throughput: {response.Resource?.Throughput}");
Console.WriteLine($"MinThroughput: {response.MinThroughput}");
Console.WriteLine($"IsReplacePending: {response.IsReplacePending}");

Comentários

Valor nulo indica um banco de dados sem taxa de transferência provisionada.