Attachments.DownloadAsync(String, String, RequestContext) Method

Reference

Definition

Namespace:: Azure.Verticals.AgriFood.Farming

Assembly:: Azure.Verticals.AgriFood.Farming.dll

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

Source:: Attachments.cs

Important

Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.

Downloads and returns attachment as response for the given input filePath.

public virtual System.Threading.Tasks.Task<Azure.Response> DownloadAsync (string partyId, string attachmentId, Azure.RequestContext context = default);

abstract member DownloadAsync : string * string * Azure.RequestContext -> System.Threading.Tasks.Task<Azure.Response>
override this.DownloadAsync : string * string * Azure.RequestContext -> System.Threading.Tasks.Task<Azure.Response>

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

Parameters

partyId: String

Id of the associated party.

attachmentId: String

Id of attachment to be downloaded.

context: RequestContext

The request context, which can override default behaviors of the client pipeline on a per-call basis.

Returns

Task<Response>

The response returned from the service.

Exceptions

ArgumentNullException

partyId or attachmentId is null.

ArgumentException

partyId or attachmentId is an empty string, and was expected to be non-empty.

RequestFailedException

Service returned a non-success status code.

Examples

This sample shows how to call DownloadAsync with required parameters and parse the result.

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

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

Applies to

Share via