BlobBaseClient.DownloadStreaming Method

Reference

Definition

Namespace:: Azure.Storage.Blobs.Specialized

Assembly:: Azure.Storage.Blobs.dll

Package:: Azure.Storage.Blobs v12.23.0

Package:: Azure.Storage.Blobs v12.23.0-beta.2

Source:: BlobBaseClient.cs

Source:: BlobBaseClient.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.

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

For more information, see Get Blob.

public virtual Azure.Response<Azure.Storage.Blobs.Models.BlobDownloadStreamingResult> DownloadStreaming (Azure.Storage.Blobs.Models.BlobDownloadOptions options = default, System.Threading.CancellationToken cancellationToken = default);

abstract member DownloadStreaming : Azure.Storage.Blobs.Models.BlobDownloadOptions * System.Threading.CancellationToken -> Azure.Response<Azure.Storage.Blobs.Models.BlobDownloadStreamingResult>
override this.DownloadStreaming : Azure.Storage.Blobs.Models.BlobDownloadOptions * System.Threading.CancellationToken -> Azure.Response<Azure.Storage.Blobs.Models.BlobDownloadStreamingResult>

Public Overridable Function DownloadStreaming (Optional options As BlobDownloadOptions = Nothing, Optional cancellationToken As CancellationToken = Nothing) As Response(Of BlobDownloadStreamingResult)

Parameters

options: BlobDownloadOptions

Optional parameters.

cancellationToken: CancellationToken

Optional CancellationToken to propagate notifications that the operation should be cancelled.

Returns

Response<BlobDownloadStreamingResult>

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

Share via