DocumentClient.ReadOfferAsync(String) Método

Definição

Namespace:

Microsoft.Azure.Documents.Client

Assemblies:

Microsoft.Azure.DocumentDB.Core.dll, Microsoft.Azure.Documents.Client.dll

Pacotes:

Microsoft.Azure.DocumentDB v2.18.0, Microsoft.Azure.DocumentDB.Core v2.18.0

Lê um Offer do serviço do Azure Cosmos DB como uma operação assíncrona.

public System.Threading.Tasks.Task<Microsoft.Azure.Documents.Client.ResourceResponse<Microsoft.Azure.Documents.Offer>> ReadOfferAsync (string offerLink);

abstract member ReadOfferAsync : string -> System.Threading.Tasks.Task<Microsoft.Azure.Documents.Client.ResourceResponse<Microsoft.Azure.Documents.Offer>>
override this.ReadOfferAsync : string -> System.Threading.Tasks.Task<Microsoft.Azure.Documents.Client.ResourceResponse<Microsoft.Azure.Documents.Offer>>

Public Function ReadOfferAsync (offerLink As String) As Task(Of ResourceResponse(Of Offer))

Parâmetros

offerLink

String

O link para a Oferta a ser lida.

Retornos

Task<ResourceResponse<Offer>>

Um System.Threading.Tasks que contém um ResourceResponse<TResource> que encapsula um Offer que contém o registro de recurso de leitura.

Implementações

ReadOfferAsync(String)

Exceções

ArgumentNullException

Se offerLink não estiver definido.

DocumentClientException

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 criar um Documento são:

StatusCode	Motivo da exceção
404	NotFound - Isso significa que o recurso que você tentou ler não existia.
429	TooManyRequests - Isso significa que você excedeu o número de unidades de solicitação por segundo. Consulte o valor DocumentClientException.RetryAfter para ver quanto tempo você deve aguardar antes de repetir essa operação.

Exemplos

//Reads an Offer resource from a Database
// - offer_id is the ID of the offer to be read
var offerLink = "/offers/offer_id";
Offer offer = await client.ReadOfferAsync(offerLink);

Comentários

Fazer uma leitura de um recurso é a maneira mais eficiente de obter um recurso do Banco de Dados. Se você souber a ID do recurso, faça uma leitura em vez de uma consulta por ID.

Para uma Oferta, a ID sempre é gerada internamente pelo sistema quando o recurso vinculado é criado. ID e _rid são sempre os mesmos para a Oferta.

Consulte para https://docs.microsoft.com/en-us/azure/cosmos-db/how-to-provision-container-throughput saber mais sobre a taxa de transferência mínima de um contêiner do Cosmos (ou um banco de dados) Para recuperar a taxa de transferência mínima de uma coleção/banco de dados, use o exemplo a seguir

// Find the offer for the collection by SelfLink
Offer offer = client.CreateOfferQuery(
    string.Format("SELECT * FROM offers o WHERE o.resource = '{0}'", collectionSelfLink)).AsEnumerable().FirstOrDefault();
ResourceResponse<Offer> response = await client.ReadOfferAsync(offer.SelfLink);
string minimumRUsForCollection = response.ResponseHeaders["x-ms-cosmos-min-throughput"];

Confira também

• ResourceResponse<TResource>
• Task
• Uri
• Conflict
• RequestOptions