Scenes.DownloadAsync(String, RequestContext) Method

Definition

Namespace:

Azure.Verticals.AgriFood.Farming

Assembly:

Azure.Verticals.AgriFood.Farming.dll

Package:

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

Source:

Scenes.cs

Downloads and returns file Stream as response for the given input filePath.

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

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

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

Parameters

filePath

String

cloud storage path of scene file.

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

filePath is null.

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).GetScenesClient(<2022-11-01-preview>);

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