BlobBaseClient.DownloadContentAsync Method
Definition
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.
Overloads
| DownloadContentAsync() |
The DownloadContentAsync() operation downloads a blob from the service, including its metadata and properties. For more information, see Get Blob. |
| DownloadContentAsync(CancellationToken) |
The DownloadContentAsync(CancellationToken) operation downloads a blob from the service, including its metadata and properties. For more information, see Get Blob. |
| DownloadContentAsync(BlobDownloadOptions, CancellationToken) |
The DownloadContentAsync(BlobDownloadOptions, CancellationToken) operation downloads a blob from the service, including its metadata and properties. For more information, see Get Blob. |
DownloadContentAsync()
- Source:
- BlobBaseClient.cs
- Source:
- BlobBaseClient.cs
The DownloadContentAsync() 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.BlobDownloadResult>> DownloadContentAsync ();abstract member DownloadContentAsync : unit -> System.Threading.Tasks.Task<Azure.Response<Azure.Storage.Blobs.Models.BlobDownloadResult>>
override this.DownloadContentAsync : unit -> System.Threading.Tasks.Task<Azure.Response<Azure.Storage.Blobs.Models.BlobDownloadResult>>Public Overridable Function DownloadContentAsync () As Task(Of Response(Of BlobDownloadResult))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 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.
Applies to
DownloadContentAsync(CancellationToken)
- Source:
- BlobBaseClient.cs
- Source:
- BlobBaseClient.cs
The DownloadContentAsync(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.BlobDownloadResult>> DownloadContentAsync (System.Threading.CancellationToken cancellationToken);abstract member DownloadContentAsync : System.Threading.CancellationToken -> System.Threading.Tasks.Task<Azure.Response<Azure.Storage.Blobs.Models.BlobDownloadResult>>
override this.DownloadContentAsync : System.Threading.CancellationToken -> System.Threading.Tasks.Task<Azure.Response<Azure.Storage.Blobs.Models.BlobDownloadResult>>Public Overridable Function DownloadContentAsync (cancellationToken As CancellationToken) As Task(Of Response(Of BlobDownloadResult))Parameters
- cancellationToken
- CancellationToken
Optional CancellationToken to propagate notifications that the operation should be cancelled.
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 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.
Applies to
DownloadContentAsync(BlobDownloadOptions, CancellationToken)
- Source:
- BlobBaseClient.cs
- Source:
- BlobBaseClient.cs
The DownloadContentAsync(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.BlobDownloadResult>> DownloadContentAsync (Azure.Storage.Blobs.Models.BlobDownloadOptions options = default, System.Threading.CancellationToken cancellationToken = default);abstract member DownloadContentAsync : Azure.Storage.Blobs.Models.BlobDownloadOptions * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Azure.Response<Azure.Storage.Blobs.Models.BlobDownloadResult>>
override this.DownloadContentAsync : Azure.Storage.Blobs.Models.BlobDownloadOptions * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Azure.Response<Azure.Storage.Blobs.Models.BlobDownloadResult>>Public Overridable Function DownloadContentAsync (Optional options As BlobDownloadOptions = Nothing, Optional cancellationToken As CancellationToken = Nothing) As Task(Of 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
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.
Applies to
Azure SDK for .NET
Feedback
Coming soon: Throughout 2024 we will be phasing out GitHub Issues as the feedback mechanism for content and replacing it with a new feedback system. For more information see: https://aka.ms/ContentUserFeedback.
Submit and view feedback for