IDocumentClient.ReadOfferAsync(String) Méthode

Référence

Définition

Espace de noms:: Microsoft.Azure.Documents

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

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

Important

Certaines informations portent sur la préversion du produit qui est susceptible d’être en grande partie modifiée avant sa publication. Microsoft exclut toute garantie, expresse ou implicite, concernant les informations fournies ici.

Lit un Offer à partir du service Azure Cosmos DB en tant qu’opération asynchrone.

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>>

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

Paramètres

offerLink: String

Lien vers l’offre à lire.

Retours

Task<ResourceResponse<Offer>>

System.Threading.Tasks contenant un ResourceResponse<TResource> qui encapsule un Offer contenant l’enregistrement de ressource de lecture.

Exceptions

ArgumentNullException

Si offerLink n’est pas défini.

DocumentClientException

Cette exception peut encapsuler de nombreux types d’erreurs différents. Pour déterminer l’erreur spécifique, examinez toujours la propriété StatusCode. Voici quelques codes courants que vous pouvez obtenir lors de la création d’un document :

StatusCode	Raison de l’exception
404	NotFound : cela signifie que la ressource que vous avez essayé de lire n’existait pas.
429	TooManyRequests : cela signifie que vous avez dépassé le nombre d’unités de requête par seconde. Consultez la valeur DocumentClientException.RetryAfter pour voir combien de temps vous devez attendre avant de réessayer cette opération.

Exemples

//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);

Remarques

La lecture d’une ressource est le moyen le plus efficace d’obtenir une ressource à partir de la base de données. Si vous connaissez l’ID de la ressource, effectuez une lecture au lieu d’une requête par ID.

Pour une offre, l’ID est toujours généré en interne par le système lors de la création de la ressource liée. id et _rid sont toujours les mêmes pour l’offre.

Reportez-vous à https://docs.microsoft.com/azure/cosmos-db/how-to-provision-container-throughput pour en savoir plus sur le débit minimal d’un conteneur Cosmos (ou d’une base de données) Pour récupérer le débit minimal d’une collection/base de données, utilisez l’exemple suivant

// 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 = readResponse.Headers["x-ms-cosmos-min-throughput"];

S’applique à

Partager via