次の方法で共有


DocumentClient.ReadDocumentAsync メソッド

定義

オーバーロード

ReadDocumentAsync(String, RequestOptions, CancellationToken)

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

ReadDocumentAsync(Uri, RequestOptions, CancellationToken)

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

ReadDocumentAsync<T>(String, RequestOptions, CancellationToken)

Documentを非同期操作として Azure Cosmos DB サービスからジェネリック型 T として読み取ります。

ReadDocumentAsync<T>(Uri, RequestOptions, CancellationToken)

Documentを非同期操作として Azure Cosmos DB サービスからジェネリック型 T として読み取ります。

ReadDocumentAsync(String, RequestOptions, CancellationToken)

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

public System.Threading.Tasks.Task<Microsoft.Azure.Documents.Client.ResourceResponse<Microsoft.Azure.Documents.Document>> ReadDocumentAsync (string documentLink, Microsoft.Azure.Documents.Client.RequestOptions options = default, System.Threading.CancellationToken cancellationToken = default);
abstract member ReadDocumentAsync : string * Microsoft.Azure.Documents.Client.RequestOptions * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Microsoft.Azure.Documents.Client.ResourceResponse<Microsoft.Azure.Documents.Document>>
override this.ReadDocumentAsync : string * Microsoft.Azure.Documents.Client.RequestOptions * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Microsoft.Azure.Documents.Client.ResourceResponse<Microsoft.Azure.Documents.Document>>
Public Function ReadDocumentAsync (documentLink As String, Optional options As RequestOptions = Nothing, Optional cancellationToken As CancellationToken = Nothing) As Task(Of ResourceResponse(Of Document))

パラメーター

documentLink
String

読み取るドキュメントのリンク。

options
RequestOptions

(省略可能)要求の要求オプション。

cancellationToken
CancellationToken

(省略可能) CancellationToken 取り消しの通知を受け取るために他のオブジェクトまたはスレッドで使用できる 。

戻り値

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

実装

例外

が設定されていない場合 documentLink

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

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

//This reads a document record from a database & collection where
// - sample_database is the ID of the database
// - sample_collection is the ID of the collection
// - document_id is the ID of the document resource
var docLink = "dbs/sample_database/colls/sample_collection/docs/document_id";
Document doc = await client.ReadDocumentAsync(docLink);

注釈

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

次に示す例では、ID ベースのリンクを使用します。このリンクは、リソースの作成時に使用される ID プロパティで構成されます。 必要に応じて、 SelfLink Document の プロパティを引き続き使用できます。 セルフリンクは、リソース識別子 (または _rid プロパティ) で構成されるリソースの URI です。 ID ベースのリンクと SelfLink はどちらも機能します。 の documentLink 形式は常に "dbs/{db identifier}/colls/{coll identifier}/docs/{doc identifier}" であり、リソースのアドレス指定に使用するメソッドに応じて、変更内 {} の値のみが使用されます。

こちらもご覧ください

適用対象

ReadDocumentAsync(Uri, RequestOptions, CancellationToken)

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

public System.Threading.Tasks.Task<Microsoft.Azure.Documents.Client.ResourceResponse<Microsoft.Azure.Documents.Document>> ReadDocumentAsync (Uri documentUri, Microsoft.Azure.Documents.Client.RequestOptions options = default, System.Threading.CancellationToken cancellationToken = default);
abstract member ReadDocumentAsync : Uri * Microsoft.Azure.Documents.Client.RequestOptions * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Microsoft.Azure.Documents.Client.ResourceResponse<Microsoft.Azure.Documents.Document>>
override this.ReadDocumentAsync : Uri * Microsoft.Azure.Documents.Client.RequestOptions * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Microsoft.Azure.Documents.Client.ResourceResponse<Microsoft.Azure.Documents.Document>>
Public Function ReadDocumentAsync (documentUri As Uri, Optional options As RequestOptions = Nothing, Optional cancellationToken As CancellationToken = Nothing) As Task(Of ResourceResponse(Of Document))

パラメーター

documentUri
Uri

読み取るドキュメント リソースの URI。

options
RequestOptions

要求の要求オプション。

cancellationToken
CancellationToken

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

戻り値

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

実装

例外

が設定されていない場合 documentUri

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

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

//Reads a Document resource where 
// - db_id is the ID property of the Database
// - coll_id is the ID property of the DocumentCollection
// - doc_id is the ID property of the Document you wish to read. 
var docUri = UriFactory.CreateDocumentUri("db_id", "coll_id", "doc_id");
Document document = await client.ReadDocumentAsync(docUri);

注釈

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

こちらもご覧ください

適用対象

ReadDocumentAsync<T>(String, RequestOptions, CancellationToken)

Documentを非同期操作として Azure Cosmos DB サービスからジェネリック型 T として読み取ります。

public System.Threading.Tasks.Task<Microsoft.Azure.Documents.Client.DocumentResponse<T>> ReadDocumentAsync<T> (string documentLink, Microsoft.Azure.Documents.Client.RequestOptions options = default, System.Threading.CancellationToken cancellationToken = default);
abstract member ReadDocumentAsync : string * Microsoft.Azure.Documents.Client.RequestOptions * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Microsoft.Azure.Documents.Client.DocumentResponse<'T>>
override this.ReadDocumentAsync : string * Microsoft.Azure.Documents.Client.RequestOptions * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Microsoft.Azure.Documents.Client.DocumentResponse<'T>>
Public Function ReadDocumentAsync(Of T) (documentLink As String, Optional options As RequestOptions = Nothing, Optional cancellationToken As CancellationToken = Nothing) As Task(Of DocumentResponse(Of T))

型パラメーター

T

パラメーター

documentLink
String

読み取るドキュメントのリンク。

options
RequestOptions

(省略可能)要求の要求オプション。

cancellationToken
CancellationToken

(省略可能) CancellationToken 取り消しの通知を受け取るために他のオブジェクトまたはスレッドで使用できる 。

戻り値

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

実装

例外

が設定されていない場合 documentLink

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

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

//This reads a document record from a database & collection where
// - sample_database is the ID of the database
// - sample_collection is the ID of the collection
// - document_id is the ID of the document resource
var docLink = "dbs/sample_database/colls/sample_collection/docs/document_id";
Customer customer = await client.ReadDocumentAsync<Customer>(docLink);

注釈

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

次に示す例では、ID ベースのリンクを使用します。このリンクは、リソースの作成時に使用される ID プロパティで構成されます。 必要に応じて、 SelfLink Document の プロパティを引き続き使用できます。 セルフリンクは、リソース識別子 (または _rid プロパティ) で構成されるリソースの URI です。 ID ベースのリンクと SelfLink はどちらも機能します。 の documentLink 形式は常に "dbs/{db identifier}/colls/{coll identifier}/docs/{doc identifier}" であり、リソースのアドレス指定に使用するメソッドに応じて、変更内 {} の値のみが使用されます。

こちらもご覧ください

適用対象

ReadDocumentAsync<T>(Uri, RequestOptions, CancellationToken)

Documentを非同期操作として Azure Cosmos DB サービスからジェネリック型 T として読み取ります。

public System.Threading.Tasks.Task<Microsoft.Azure.Documents.Client.DocumentResponse<T>> ReadDocumentAsync<T> (Uri documentUri, Microsoft.Azure.Documents.Client.RequestOptions options = default, System.Threading.CancellationToken cancellationToken = default);
abstract member ReadDocumentAsync : Uri * Microsoft.Azure.Documents.Client.RequestOptions * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Microsoft.Azure.Documents.Client.DocumentResponse<'T>>
override this.ReadDocumentAsync : Uri * Microsoft.Azure.Documents.Client.RequestOptions * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Microsoft.Azure.Documents.Client.DocumentResponse<'T>>
Public Function ReadDocumentAsync(Of T) (documentUri As Uri, Optional options As RequestOptions = Nothing, Optional cancellationToken As CancellationToken = Nothing) As Task(Of DocumentResponse(Of T))

型パラメーター

T

パラメーター

documentUri
Uri

読み取るドキュメント リソースの URI。

options
RequestOptions

要求の要求オプション。

cancellationToken
CancellationToken

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

戻り値

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

実装

例外

が設定されていない場合 documentUri

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

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

//Reads a Document resource where 
// - db_id is the ID property of the Database
// - coll_id is the ID property of the DocumentCollection
// - doc_id is the ID property of the Document you wish to read. 
var docUri = UriFactory.CreateDocumentUri("db_id", "coll_id", "doc_id");
Customer customer = await client.ReadDocumentAsync<Customer>(docUri);

注釈

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

こちらもご覧ください

適用対象