BlobBaseClient.DownloadContent Method

Definition

Namespace:

Azure.Storage.Blobs.Specialized

Assembly:

Azure.Storage.Blobs.dll

Package:

Azure.Storage.Blobs v12.23.0

Overloads

DownloadContent()	The DownloadContent() operation downloads a blob from the service, including its metadata and properties. For more information, see Get Blob.
DownloadContent(CancellationToken)	The DownloadContent(CancellationToken) operation downloads a blob from the service, including its metadata and properties. For more information, see Get Blob.
DownloadContent(BlobDownloadOptions, CancellationToken)	The DownloadContent(BlobDownloadOptions, CancellationToken) operation downloads a blob from the service, including its metadata and properties. For more information, see Get Blob.

DownloadContent()

Source:

BlobBaseClient.cs

The DownloadContent() 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.BlobDownloadResult> DownloadContent ();

abstract member DownloadContent : unit -> Azure.Response<Azure.Storage.Blobs.Models.BlobDownloadResult>
override this.DownloadContent : unit -> Azure.Response<Azure.Storage.Blobs.Models.BlobDownloadResult>

Public Overridable Function DownloadContent () As Response(Of BlobDownloadResult)

Returns

Response<BlobDownloadResult>

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 is a prefered way to fetch blobs that can fit into memory. The content is provided as BinaryData that provides a lightweight abstraction for a payload of bytes. It provides convenient helper methods to get out commonly used primitives, such as streams, strings, or bytes. Consider the following alternatives:

• DownloadTo: to stream blob content to a path or a Stream
• DownloadStreaming: as a replacement to this API. Use it to access network stream directly for any advanced scenario.

DownloadContent(CancellationToken)

Source:

BlobBaseClient.cs

The DownloadContent(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.BlobDownloadResult> DownloadContent (System.Threading.CancellationToken cancellationToken = default);

abstract member DownloadContent : System.Threading.CancellationToken -> Azure.Response<Azure.Storage.Blobs.Models.BlobDownloadResult>
override this.DownloadContent : System.Threading.CancellationToken -> Azure.Response<Azure.Storage.Blobs.Models.BlobDownloadResult>

Public Overridable Function DownloadContent (Optional cancellationToken As CancellationToken = Nothing) As Response(Of BlobDownloadResult)

Parameters

cancellationToken

CancellationToken

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

Returns

Response<BlobDownloadResult>

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 is a prefered way to fetch blobs that can fit into memory. The content is provided as BinaryData that provides a lightweight abstraction for a payload of bytes. It provides convenient helper methods to get out commonly used primitives, such as streams, strings, or bytes. Consider the following alternatives:

• DownloadTo: to stream blob content to a path or a Stream
• DownloadStreaming: as a replacement to this API. Use it to access network stream directly for any advanced scenario.

DownloadContent(BlobDownloadOptions, CancellationToken)

Source:

BlobBaseClient.cs

The DownloadContent(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.BlobDownloadResult> DownloadContent (Azure.Storage.Blobs.Models.BlobDownloadOptions options = default, System.Threading.CancellationToken cancellationToken = default);

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

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

Parameters

options

BlobDownloadOptions

Optional parameters for download operation.

cancellationToken

CancellationToken

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

Returns

Response<BlobDownloadResult>

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 is a prefered way to fetch blobs that can fit into memory. The content is provided as BinaryData that provides a lightweight abstraction for a payload of bytes. It provides convenient helper methods to get out commonly used primitives, such as streams, strings, or bytes. Consider the following alternatives:

• DownloadToAsync: to stream blob content to a path or a Stream
• DownloadStreamingAsync: as a replacement to this API. Use it to access network stream directly for any advanced scenario.