DocumentClient.ReadOfferAsync(String) メソッド

定義

名前空間:

Microsoft.Azure.Documents.Client

アセンブリ:

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

パッケージ:

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

Offer非同期操作として Azure Cosmos DB サービスから を読み取ります。

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

パラメーター

offerLink

String

読み取るオファーへのリンク。

戻り値

Task<ResourceResponse<Offer>>

System.Threading.Tasks読み取りリソース レコードをResourceResponse<TResource>含む をOfferラップする を含む 。

実装

ReadOfferAsync(String)

例外

ArgumentNullException

が設定されていない場合 offerLink 。

DocumentClientException

この例外は、さまざまな種類のエラーをカプセル化できます。 特定のエラーを特定するには、常に StatusCode プロパティを参照してください。 ドキュメントの作成時に取得できる一般的なコードは次のとおりです。

StatusCode	例外の理由
404	NotFound - 読み取ろうとしたリソースが存在しなかったことを意味します。
429	TooManyRequests - つまり、1 秒あたりの要求ユニット数を超えています。 DocumentClientException.RetryAfter の値を調べ、この操作を再試行する前に待機する必要がある時間を確認します。

例

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

注釈

リソースの読み取りを行うことは、データベースからリソースを取得する最も効率的な方法です。 リソースの ID がわかっている場合は、ID によるクエリではなく読み取りを行います。

オファーの場合、ID は、リンクされたリソースの作成時にシステムによって常に内部的に生成されます。 id と_ridは、オファーで常に同じです。

https://docs.microsoft.com/en-us/azure/cosmos-db/how-to-provision-container-throughput Cosmos コンテナー (またはデータベース) の最小スループットの詳細については、「コレクション/データベースの最小スループットを取得するには、次のサンプルを使用してください。

// 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"];

こちらもご覧ください

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