Sdílet prostřednictvím


BlobBaseClient.DownloadStreamingAsync Method

Definition

The DownloadStreamingAsync(BlobDownloadOptions, CancellationToken) operation downloads a blob from the service, including its metadata and properties.

For more information, see Get Blob.

public virtual System.Threading.Tasks.Task<Azure.Response<Azure.Storage.Blobs.Models.BlobDownloadStreamingResult>> DownloadStreamingAsync (Azure.Storage.Blobs.Models.BlobDownloadOptions options = default, System.Threading.CancellationToken cancellationToken = default);
abstract member DownloadStreamingAsync : Azure.Storage.Blobs.Models.BlobDownloadOptions * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Azure.Response<Azure.Storage.Blobs.Models.BlobDownloadStreamingResult>>
override this.DownloadStreamingAsync : Azure.Storage.Blobs.Models.BlobDownloadOptions * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Azure.Response<Azure.Storage.Blobs.Models.BlobDownloadStreamingResult>>
Public Overridable Function DownloadStreamingAsync (Optional options As BlobDownloadOptions = Nothing, Optional cancellationToken As CancellationToken = Nothing) As Task(Of Response(Of BlobDownloadStreamingResult))

Parameters

options
BlobDownloadOptions

Optional parameters.

cancellationToken
CancellationToken

Returns

A Response<T> describing the downloaded blob. Content contains the blob's data.

Remarks

A RequestFailedException will be thrown if a failure occurs.

This API gives access directly to network stream that should be disposed after usage. Consider the following alternatives:

  • DownloadContentAsync: as a prefered way of downloading small blobs that can fit into memory
  • DownloadToAsync: to stream blob content to a path or a Stream

Applies to