IDocumentClient.ReadUserAsync メソッド

定義

名前空間:

Microsoft.Azure.Documents

アセンブリ:

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

パッケージ:

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

オーバーロード

ReadUserAsync(String, RequestOptions)	User非同期操作として Azure Cosmos DB サービスから を読み取ります。
ReadUserAsync(Uri, RequestOptions)	Userを Azure Cosmos DB サービスから非同期操作として読み取ります。

ReadUserAsync(String, RequestOptions)

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

public System.Threading.Tasks.Task<Microsoft.Azure.Documents.Client.ResourceResponse<Microsoft.Azure.Documents.User>> ReadUserAsync (string userLink, Microsoft.Azure.Documents.Client.RequestOptions options = default);

abstract member ReadUserAsync : string * Microsoft.Azure.Documents.Client.RequestOptions -> System.Threading.Tasks.Task<Microsoft.Azure.Documents.Client.ResourceResponse<Microsoft.Azure.Documents.User>>

Public Function ReadUserAsync (userLink As String, Optional options As RequestOptions = Nothing) As Task(Of ResourceResponse(Of User))

パラメーター

userLink

String

読み取るユーザー リソースへのリンク。

options

RequestOptions

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

戻り値

Task<ResourceResponse<User>>

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

例外

ArgumentNullException

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

DocumentClientException

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

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

例

//Reads a User resource from a Database
// - sample_database is the ID of the database
// - user_id is the ID of the user to be read
var userLink = "/dbs/sample_database/users/user_id";
User user = await client.ReadUserAsync(userLink);

注釈

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

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

こちらもご覧ください

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

ReadUserAsync(Uri, RequestOptions)

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

public System.Threading.Tasks.Task<Microsoft.Azure.Documents.Client.ResourceResponse<Microsoft.Azure.Documents.User>> ReadUserAsync (Uri userUri, Microsoft.Azure.Documents.Client.RequestOptions options = default);

abstract member ReadUserAsync : Uri * Microsoft.Azure.Documents.Client.RequestOptions -> System.Threading.Tasks.Task<Microsoft.Azure.Documents.Client.ResourceResponse<Microsoft.Azure.Documents.User>>

Public Function ReadUserAsync (userUri As Uri, Optional options As RequestOptions = Nothing) As Task(Of ResourceResponse(Of User))

パラメーター

userUri

Uri

読み取るユーザー リソースへの URI。

options

RequestOptions

要求の要求オプション。

戻り値

Task<ResourceResponse<User>>

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

例外

ArgumentNullException

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

DocumentClientException

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

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

例

//Reads a User resource where 
// - db_id is the ID property of the Database
// - user_id is the ID property of the User you wish to read. 
var userLink = UriFactory.CreateUserUri("db_id", "user_id");
User user = await client.ReadUserAsync(userLink);

注釈

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

こちらもご覧ください

• ResourceResponse<TResource>
• Task
• User
• RequestOptions