Attachments.Download(String, String, RequestContext) メソッド

定義

名前空間:

Azure.Verticals.AgriFood.Farming

アセンブリ:

Azure.Verticals.AgriFood.Farming.dll

パッケージ:

Azure.Verticals.AgriFood.Farming v1.0.0-beta.2

ソース:

Attachments.cs

指定された入力 filePath の応答として添付ファイルをダウンロードして返します。

public virtual Azure.Response Download (string partyId, string attachmentId, Azure.RequestContext context = default);

abstract member Download : string * string * Azure.RequestContext -> Azure.Response
override this.Download : string * string * Azure.RequestContext -> Azure.Response

Public Overridable Function Download (partyId As String, attachmentId As String, Optional context As RequestContext = Nothing) As Response

パラメーター

partyId

String

関連付けられたパーティの ID。

attachmentId

String

ダウンロードする添付ファイルの ID。

context

RequestContext

要求コンテキスト。これは、呼び出しごとにクライアント パイプラインの既定の動作をオーバーライドできます。

戻り値

Response

サービスから返された応答。

例外

ArgumentNullException

partyId または attachmentId が null です。

ArgumentException

partyId または attachmentId が空の文字列であり、空でないと想定されていました。

RequestFailedException

サービスから成功以外の状態コードが返されました。

例

このサンプルでは、必要なパラメーターを使用して Download を呼び出し、結果を解析する方法を示します。

var credential = new DefaultAzureCredential();
var client = new FarmBeatsClient(credential).GetAttachmentsClient(<2022-11-01-preview>);

Response response = client.Download("<partyId>", "<attachmentId>");
if (response.ContentStream != null)
{
    using(Stream outFileStream = File.OpenWrite("<filePath>")
    {
        response.ContentStream.CopyTo(outFileStream);
    }
}