DocumentClient.CreateAttachmentAsync メソッド

リファレンス

定義

名前空間:: 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

重要

一部の情報は、リリース前に大きく変更される可能性があるプレリリースされた製品に関するものです。 Microsoft は、ここに記載されている情報について、明示または黙示を問わず、一切保証しません。

オーバーロード

CreateAttachmentAsync(String, Stream, MediaOptions, RequestOptions, CancellationToken)	Attachment Azure Cosmos DB サービスで非同期操作として提供される `mediaStream` の内容を使用してを作成します。
CreateAttachmentAsync(Uri, Stream, MediaOptions, RequestOptions, CancellationToken)	Azure Cosmos DB サービスで非同期操作として添付ファイルを作成します。
CreateAttachmentAsync(String, Object, RequestOptions, CancellationToken)	Azure Cosmos DB サービスで、添付ファイルを非同期操作として作成します。
CreateAttachmentAsync(Uri, Object, RequestOptions, CancellationToken)	Azure Cosmos DB サービスで、添付ファイルを非同期操作として作成します。

CreateAttachmentAsync(String, Stream, MediaOptions, RequestOptions, CancellationToken)

Attachment Azure Cosmos DB サービスで非同期操作として提供される mediaStream の内容を使用してを作成します。

public System.Threading.Tasks.Task<Microsoft.Azure.Documents.Client.ResourceResponse<Microsoft.Azure.Documents.Attachment>> CreateAttachmentAsync (string attachmentsLink, System.IO.Stream mediaStream, Microsoft.Azure.Documents.Client.MediaOptions options = default, Microsoft.Azure.Documents.Client.RequestOptions requestOptions = default, System.Threading.CancellationToken cancellationToken = default);

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

Public Function CreateAttachmentAsync (attachmentsLink As String, mediaStream As Stream, Optional options As MediaOptions = Nothing, Optional requestOptions As RequestOptions = Nothing, Optional cancellationToken As CancellationToken = Nothing) As Task(Of ResourceResponse(Of Attachment))

パラメーター

attachmentsLink: String

ドキュメントの添付ファイルリンク。例: dbs/db_rid/colls/col_rid/docs/doc_rid/attachments/

mediaStream: Stream

添付 Stream ファイルメディアの。

options: MediaOptions

要求 MediaOptions の。

requestOptions: RequestOptions

要求オプション。

cancellationToken: CancellationToken

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

戻り値

Task<ResourceResponse<Attachment>>

非同期操作のサービス応答を表すタスクオブジェクト。

実装

CreateAttachmentAsync(String, Stream, MediaOptions, RequestOptions, CancellationToken)

例外

ArgumentNullException

または mediaStream がattachmentsLink設定されていない場合。

例

//This attachment could be any binary you want to attach. Like images, videos, word documents, pdfs etc. it doesn't matter
using (FileStream fileStream = new FileStream(@".\something.pdf", FileMode.Open))
{
    //Create the attachment
    Attachment attachment = await client.CreateAttachmentAsync("dbs/db_rid/colls/coll_rid/docs/doc_rid/attachments/",
                                        fileStream,
                                        new MediaOptions
                                        {
                                            ContentType = "application/pdf",
                                            Slug = "something.pdf"
                                        });
}

こちらもご覧ください

適用対象

CreateAttachmentAsync(Uri, Stream, MediaOptions, RequestOptions, CancellationToken)

Azure Cosmos DB サービスで非同期操作として添付ファイルを作成します。

public System.Threading.Tasks.Task<Microsoft.Azure.Documents.Client.ResourceResponse<Microsoft.Azure.Documents.Attachment>> CreateAttachmentAsync (Uri documentUri, System.IO.Stream mediaStream, Microsoft.Azure.Documents.Client.MediaOptions options = default, Microsoft.Azure.Documents.Client.RequestOptions requestOptions = default, System.Threading.CancellationToken cancellationToken = default);

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

Public Function CreateAttachmentAsync (documentUri As Uri, mediaStream As Stream, Optional options As MediaOptions = Nothing, Optional requestOptions As RequestOptions = Nothing, Optional cancellationToken As CancellationToken = Nothing) As Task(Of ResourceResponse(Of Attachment))

パラメーター

documentUri: Uri

添付ファイルを作成するドキュメントの URI。

mediaStream: Stream

添付ファイルメディアのストリーム。

options: MediaOptions

要求のメディアオプション。

requestOptions: RequestOptions

要求の要求オプション。

cancellationToken: CancellationToken

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

戻り値

Task<ResourceResponse<Attachment>>

非同期操作のサービス応答を表すタスクオブジェクト。

実装

CreateAttachmentAsync(Uri, Stream, MediaOptions, RequestOptions, CancellationToken)

適用対象

CreateAttachmentAsync(String, Object, RequestOptions, CancellationToken)

Azure Cosmos DB サービスで、添付ファイルを非同期操作として作成します。

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

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

Public Function CreateAttachmentAsync (documentLink As String, attachment As Object, Optional options As RequestOptions = Nothing, Optional cancellationToken As CancellationToken = Nothing) As Task(Of ResourceResponse(Of Attachment))

パラメーター

documentLink: String

この新しい添付ファイルの親ドキュメントのリンク。例: dbs/db_rid/colls/col_rid/docs/doc_rid/

attachment: Object

添付ファイルオブジェクト。

options: RequestOptions

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

cancellationToken: CancellationToken

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

戻り値

Task<ResourceResponse<Attachment>>

Task非同期操作のサービス応答を表すオブジェクト。

実装

CreateAttachmentAsync(String, Object, RequestOptions, CancellationToken)

例

次の例では、新しいドキュメントを作成し、そのドキュメントの新しい添付ファイルを作成します

dynamic d = new
{
    id = "DOC1800243243470"
};

Document doc = await client.CreateDocumentAsync(collectionSelfLink, d);

//Create an Attachment which links to binary content stored somewhere else
//Use the MediaLink property of Attachment to set where the binary resides
//MediaLink can also point at another Attachment within Azure Cosmos DB.
Attachment a = await client.CreateAttachmentAsync(doc.SelfLink, new Attachment { Id = "foo", ContentType = "text/plain", MediaLink = "link to your media" });

//Because Attachment is a Dynamic object you can use SetPropertyValue method to any property you like
//Even if that property doesn't exist. Here we are creating two new properties on the Attachment we created above.
a.SetPropertyValue("Foo", "some value");
a.SetPropertyValue("Bar", "some value");

//Now update the Attachment object in the database to persist the new properties on the object
client.ReplaceAttachmentAsync(a);

//Let's now create another Attachment except this time we're going to use a Dynamic object instead
//of a <see cref="Microsoft.Azure.Documents.Attachment"/> as we did above.
var b = await client.CreateAttachmentAsync(doc.SelfLink, new { id = "foo", contentType = "text/plain", media="link to your media", a = 5, b = 6 });

//Now you will have a Document in your database with two attachments.

こちらもご覧ください

適用対象

CreateAttachmentAsync(Uri, Object, RequestOptions, CancellationToken)

Azure Cosmos DB サービスで、添付ファイルを非同期操作として作成します。

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

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

Public Function CreateAttachmentAsync (documentUri As Uri, attachment As Object, Optional options As RequestOptions = Nothing, Optional cancellationToken As CancellationToken = Nothing) As Task(Of ResourceResponse(Of Attachment))

パラメーター

documentUri: Uri

添付ファイルを作成するドキュメントの URI。

attachment: Object

添付ファイルオブジェクト。

options: RequestOptions

要求の要求オプション。

cancellationToken: CancellationToken

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

戻り値

Task<ResourceResponse<Attachment>>

非同期操作のサービス応答を表すタスクオブジェクト。

実装

CreateAttachmentAsync(Uri, Object, RequestOptions, CancellationToken)

適用対象

次の方法で共有

DocumentClient.CreateAttachmentAsync メソッド

定義

オーバーロード

CreateAttachmentAsync(String, Stream, MediaOptions, RequestOptions, CancellationToken)

パラメーター

戻り値

実装

例外

例

こちらもご覧ください

適用対象

CreateAttachmentAsync(Uri, Stream, MediaOptions, RequestOptions, CancellationToken)

パラメーター

戻り値

実装

適用対象

CreateAttachmentAsync(String, Object, RequestOptions, CancellationToken)

パラメーター

戻り値

実装

例

こちらもご覧ください

適用対象

CreateAttachmentAsync(Uri, Object, RequestOptions, CancellationToken)

パラメーター

戻り値

実装

適用対象

その他のリソース