Container.ReadItemAsync<T> メソッド

定義

名前空間:

Microsoft.Azure.Cosmos

アセンブリ:

Microsoft.Azure.Cosmos.Client.dll

パッケージ:

Microsoft.Azure.Cosmos v3.36.0

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

public abstract System.Threading.Tasks.Task<Microsoft.Azure.Cosmos.ItemResponse<T>> ReadItemAsync<T> (string id, Microsoft.Azure.Cosmos.PartitionKey partitionKey, Microsoft.Azure.Cosmos.ItemRequestOptions requestOptions = default, System.Threading.CancellationToken cancellationToken = default);

abstract member ReadItemAsync : string * Microsoft.Azure.Cosmos.PartitionKey * Microsoft.Azure.Cosmos.ItemRequestOptions * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Microsoft.Azure.Cosmos.ItemResponse<'T>>

Public MustOverride Function ReadItemAsync(Of T) (id As String, partitionKey As PartitionKey, Optional requestOptions As ItemRequestOptions = Nothing, Optional cancellationToken As CancellationToken = Nothing) As Task(Of ItemResponse(Of T))

型パラメーター

T

パラメーター

id

String

Cosmos アイテム ID

partitionKey

PartitionKey

項目のパーティション キー。

requestOptions

ItemRequestOptions

(省略可能)アイテム要求のオプション。

cancellationToken

CancellationToken

(省略可能) CancellationToken 要求の取り消しを表します。

戻り値

Task<ItemResponse<T>>

Task読み取りリソース レコードをItemResponse<T>ラップする を含む 。

例外

CosmosException

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

StatusCode	例外の理由
429	TooManyRequests - つまり、1 秒あたりの要求ユニット数を超えています。

例

public class ToDoActivity{
    public string id {get; set;}
    public string status {get; set;}
}

ToDoActivity toDoActivity = await this.container.ReadItemAsync<ToDoActivity>("id", new PartitionKey("partitionKey"));

注釈

項目には、これらのメタデータ属性を の Tプロパティにマッピングすることによって取得できるメタデータが含まれています。 * "_ts": Azure Cosmos DB サービスから、アイテムに関連付けられている最後に変更されたタイム スタンプを取得します。 * "_etag": Azure Cosmos DB サービスから項目に関連付けられているエンティティ タグを取得します。 * "ttl": Azure Cosmos DB サービス内の項目の有効期間を秒単位で取得します。