CloudBlob.DownloadToStreamAsync Method

Reference

Definition

Namespace:: Microsoft.Azure.Storage.Blob

Assembly:: Microsoft.Azure.Storage.Blob.dll

Package:: Microsoft.Azure.Storage.Blob v11.2.3

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

DownloadToStreamAsync(Stream)	Initiates an asynchronous operation to download the contents of a blob to a stream.
DownloadToStreamAsync(Stream, CancellationToken)	Initiates an asynchronous operation to download the contents of a blob to a stream.
DownloadToStreamAsync(Stream, AccessCondition, BlobRequestOptions, OperationContext)	Initiates an asynchronous operation to download the contents of a blob to a stream.
DownloadToStreamAsync(Stream, AccessCondition, BlobRequestOptions, OperationContext, CancellationToken)	Initiates an asynchronous operation to download the contents of a blob to a stream.
DownloadToStreamAsync(Stream, AccessCondition, BlobRequestOptions, OperationContext, IProgress<StorageProgress>, CancellationToken)	Initiates an asynchronous operation to download the contents of a blob to a stream.

DownloadToStreamAsync(Stream)

Initiates an asynchronous operation to download the contents of a blob to a stream.

[Microsoft.Azure.Storage.DoesServiceRequest]
public virtual System.Threading.Tasks.Task DownloadToStreamAsync (System.IO.Stream target);

[<Microsoft.Azure.Storage.DoesServiceRequest>]
abstract member DownloadToStreamAsync : System.IO.Stream -> System.Threading.Tasks.Task
override this.DownloadToStreamAsync : System.IO.Stream -> System.Threading.Tasks.Task

Public Overridable Function DownloadToStreamAsync (target As Stream) As Task

Parameters

target: Stream

A Stream object representing the target stream.

Returns

Task

A Task object that represents the asynchronous operation.

Attributes: DoesServiceRequestAttribute

Applies to

DownloadToStreamAsync(Stream, CancellationToken)

Initiates an asynchronous operation to download the contents of a blob to a stream.

[Microsoft.Azure.Storage.DoesServiceRequest]
public virtual System.Threading.Tasks.Task DownloadToStreamAsync (System.IO.Stream target, System.Threading.CancellationToken cancellationToken);

[<Microsoft.Azure.Storage.DoesServiceRequest>]
abstract member DownloadToStreamAsync : System.IO.Stream * System.Threading.CancellationToken -> System.Threading.Tasks.Task
override this.DownloadToStreamAsync : System.IO.Stream * System.Threading.CancellationToken -> System.Threading.Tasks.Task

Public Overridable Function DownloadToStreamAsync (target As Stream, cancellationToken As CancellationToken) As Task

Parameters

target: Stream

A Stream object representing the target stream.

cancellationToken: CancellationToken

A CancellationToken to observe while waiting for a task to complete.

Returns

Task

A Task object that represents the asynchronous operation.

Attributes: DoesServiceRequestAttribute

Applies to

DownloadToStreamAsync(Stream, AccessCondition, BlobRequestOptions, OperationContext)

Initiates an asynchronous operation to download the contents of a blob to a stream.

[Microsoft.Azure.Storage.DoesServiceRequest]
public virtual System.Threading.Tasks.Task DownloadToStreamAsync (System.IO.Stream target, Microsoft.Azure.Storage.AccessCondition accessCondition, Microsoft.Azure.Storage.Blob.BlobRequestOptions options, Microsoft.Azure.Storage.OperationContext operationContext);

[<Microsoft.Azure.Storage.DoesServiceRequest>]
abstract member DownloadToStreamAsync : System.IO.Stream * Microsoft.Azure.Storage.AccessCondition * Microsoft.Azure.Storage.Blob.BlobRequestOptions * Microsoft.Azure.Storage.OperationContext -> System.Threading.Tasks.Task
override this.DownloadToStreamAsync : System.IO.Stream * Microsoft.Azure.Storage.AccessCondition * Microsoft.Azure.Storage.Blob.BlobRequestOptions * Microsoft.Azure.Storage.OperationContext -> System.Threading.Tasks.Task

Public Overridable Function DownloadToStreamAsync (target As Stream, accessCondition As AccessCondition, options As BlobRequestOptions, operationContext As OperationContext) As Task

Parameters

target: Stream

A Stream object representing the target stream.

accessCondition: AccessCondition

An AccessCondition object that represents the condition that must be met in order for the request to proceed. If null, no condition is used.

options: BlobRequestOptions

A BlobRequestOptions object that specifies additional options for the request.

operationContext: OperationContext

An OperationContext object that represents the context for the current operation.

Returns

Task

A Task object that represents the asynchronous operation.

Attributes: DoesServiceRequestAttribute

Applies to

DownloadToStreamAsync(Stream, AccessCondition, BlobRequestOptions, OperationContext, CancellationToken)

Initiates an asynchronous operation to download the contents of a blob to a stream.

[Microsoft.Azure.Storage.DoesServiceRequest]
public virtual System.Threading.Tasks.Task DownloadToStreamAsync (System.IO.Stream target, Microsoft.Azure.Storage.AccessCondition accessCondition, Microsoft.Azure.Storage.Blob.BlobRequestOptions options, Microsoft.Azure.Storage.OperationContext operationContext, System.Threading.CancellationToken cancellationToken);

[<Microsoft.Azure.Storage.DoesServiceRequest>]
abstract member DownloadToStreamAsync : System.IO.Stream * Microsoft.Azure.Storage.AccessCondition * Microsoft.Azure.Storage.Blob.BlobRequestOptions * Microsoft.Azure.Storage.OperationContext * System.Threading.CancellationToken -> System.Threading.Tasks.Task
override this.DownloadToStreamAsync : System.IO.Stream * Microsoft.Azure.Storage.AccessCondition * Microsoft.Azure.Storage.Blob.BlobRequestOptions * Microsoft.Azure.Storage.OperationContext * System.Threading.CancellationToken -> System.Threading.Tasks.Task

Public Overridable Function DownloadToStreamAsync (target As Stream, accessCondition As AccessCondition, options As BlobRequestOptions, operationContext As OperationContext, cancellationToken As CancellationToken) As Task

Parameters

target: Stream

A Stream object representing the target stream.

accessCondition: AccessCondition

An AccessCondition object that represents the condition that must be met in order for the request to proceed. If null, no condition is used.

options: BlobRequestOptions

A BlobRequestOptions object that specifies additional options for the request.

operationContext: OperationContext

An OperationContext object that represents the context for the current operation.

cancellationToken: CancellationToken

A CancellationToken to observe while waiting for a task to complete.

Returns

Task

A Task object that represents the asynchronous operation.

Attributes: DoesServiceRequestAttribute

Applies to

DownloadToStreamAsync(Stream, AccessCondition, BlobRequestOptions, OperationContext, IProgress<StorageProgress>, CancellationToken)

Initiates an asynchronous operation to download the contents of a blob to a stream.

[Microsoft.Azure.Storage.DoesServiceRequest]
public virtual System.Threading.Tasks.Task DownloadToStreamAsync (System.IO.Stream target, Microsoft.Azure.Storage.AccessCondition accessCondition, Microsoft.Azure.Storage.Blob.BlobRequestOptions options, Microsoft.Azure.Storage.OperationContext operationContext, IProgress<Microsoft.Azure.Storage.Core.Util.StorageProgress> progressHandler, System.Threading.CancellationToken cancellationToken);

[<Microsoft.Azure.Storage.DoesServiceRequest>]
abstract member DownloadToStreamAsync : System.IO.Stream * Microsoft.Azure.Storage.AccessCondition * Microsoft.Azure.Storage.Blob.BlobRequestOptions * Microsoft.Azure.Storage.OperationContext * IProgress<Microsoft.Azure.Storage.Core.Util.StorageProgress> * System.Threading.CancellationToken -> System.Threading.Tasks.Task
override this.DownloadToStreamAsync : System.IO.Stream * Microsoft.Azure.Storage.AccessCondition * Microsoft.Azure.Storage.Blob.BlobRequestOptions * Microsoft.Azure.Storage.OperationContext * IProgress<Microsoft.Azure.Storage.Core.Util.StorageProgress> * System.Threading.CancellationToken -> System.Threading.Tasks.Task

Public Overridable Function DownloadToStreamAsync (target As Stream, accessCondition As AccessCondition, options As BlobRequestOptions, operationContext As OperationContext, progressHandler As IProgress(Of StorageProgress), cancellationToken As CancellationToken) As Task

Parameters

target: Stream

A Stream object representing the target stream.

accessCondition: AccessCondition

An AccessCondition object that represents the condition that must be met in order for the request to proceed. If null, no condition is used.

options: BlobRequestOptions

A BlobRequestOptions object that specifies additional options for the request.

operationContext: OperationContext

An OperationContext object that represents the context for the current operation.

progressHandler: IProgress<StorageProgress>

A IProgress<T> object to handle StorageProgress messages.

cancellationToken: CancellationToken

A CancellationToken to observe while waiting for a task to complete.

Returns

Task

A Task object that represents the asynchronous operation.

Attributes: DoesServiceRequestAttribute

Applies to

Share via

CloudBlob.DownloadToStreamAsync Method

Definition

Overloads

DownloadToStreamAsync(Stream)

Parameters

Returns

Applies to

DownloadToStreamAsync(Stream, CancellationToken)

Parameters

Returns

Applies to

DownloadToStreamAsync(Stream, AccessCondition, BlobRequestOptions, OperationContext)

Parameters

Returns

Applies to

DownloadToStreamAsync(Stream, AccessCondition, BlobRequestOptions, OperationContext, CancellationToken)

Parameters

Returns

Applies to

DownloadToStreamAsync(Stream, AccessCondition, BlobRequestOptions, OperationContext, IProgress<StorageProgress>, CancellationToken)

Parameters

Returns

Applies to

Additional resources