Scenes.Download(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:: Scenes.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 file Stream as response for the given input filePath.

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

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

Public Overridable Function Download (filePath As String, Optional context As RequestContext = Nothing) As 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

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 Download with required parameters and parse the result.

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

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

Applies to

Share via