DocumentClient.ReadAttachmentAsync メソッド

定義

名前空間:

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

オーバーロード

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

ReadAttachmentAsync(String, RequestOptions, CancellationToken)

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

public System.Threading.Tasks.Task<Microsoft.Azure.Documents.Client.ResourceResponse<Microsoft.Azure.Documents.Attachment>> ReadAttachmentAsync (string attachmentLink, Microsoft.Azure.Documents.Client.RequestOptions options = default, System.Threading.CancellationToken cancellationToken = default);

abstract member ReadAttachmentAsync : string * Microsoft.Azure.Documents.Client.RequestOptions * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Microsoft.Azure.Documents.Client.ResourceResponse<Microsoft.Azure.Documents.Attachment>>
override this.ReadAttachmentAsync : string * Microsoft.Azure.Documents.Client.RequestOptions * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Microsoft.Azure.Documents.Client.ResourceResponse<Microsoft.Azure.Documents.Attachment>>

Public Function ReadAttachmentAsync (attachmentLink As String, Optional options As RequestOptions = Nothing, Optional cancellationToken As CancellationToken = Nothing) As Task(Of ResourceResponse(Of Attachment))

パラメーター

attachmentLink

String

読み取る添付ファイルへのリンク。

options

RequestOptions

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

cancellationToken

CancellationToken

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

戻り値

Task<ResourceResponse<Attachment>>

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

実装

ReadAttachmentAsync(String, RequestOptions, CancellationToken)

例外

ArgumentNullException

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

DocumentClientException

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

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

例

//Reads an Attachment resource where
// - sample_db is the ID property of the Database
// - sample_coll is the ID property of the DocumentCollection
// - sample_doc is the ID property of the Document
// - attachment_id is the ID property of the Attachment resource you wish to read.
var attachLink = "/dbs/sample_db/colls/sample_coll/docs/sample_doc/attachments/attachment_id/";
Attachment attachment = await client.ReadAttachmentAsync(attachLink);

注釈

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

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

こちらもご覧ください

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

ReadAttachmentAsync(Uri, RequestOptions, CancellationToken)

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

public System.Threading.Tasks.Task<Microsoft.Azure.Documents.Client.ResourceResponse<Microsoft.Azure.Documents.Attachment>> ReadAttachmentAsync (Uri attachmentUri, Microsoft.Azure.Documents.Client.RequestOptions options = default, System.Threading.CancellationToken cancellationToken = default);

abstract member ReadAttachmentAsync : Uri * Microsoft.Azure.Documents.Client.RequestOptions * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Microsoft.Azure.Documents.Client.ResourceResponse<Microsoft.Azure.Documents.Attachment>>
override this.ReadAttachmentAsync : Uri * Microsoft.Azure.Documents.Client.RequestOptions * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Microsoft.Azure.Documents.Client.ResourceResponse<Microsoft.Azure.Documents.Attachment>>

Public Function ReadAttachmentAsync (attachmentUri As Uri, Optional options As RequestOptions = Nothing, Optional cancellationToken As CancellationToken = Nothing) As Task(Of ResourceResponse(Of Attachment))

パラメーター

attachmentUri

Uri

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

options

RequestOptions

要求の要求オプション。

cancellationToken

CancellationToken

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

戻り値

Task<ResourceResponse<Attachment>>

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

実装

ReadAttachmentAsync(Uri, RequestOptions, CancellationToken)

例外

ArgumentNullException

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

DocumentClientException

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

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

例

//Reads an Attachment 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
// - attachment_id is the ID property of the Attachment resource you wish to read. 
var attachLink = UriFactory.CreateAttachmentUri("db_id", "coll_id", "doc_id", "attachment_id");
Attachment attachment = await client.ReadAttachmentAsync(attachLink);

注釈

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

こちらもご覧ください

• Attachment
• RequestOptions
• ResourceResponse<TResource>
• Task