BlobBaseClient.OpenReadAsync(BlobOpenReadOptions, CancellationToken) Method

  • Reference

Definition

Namespace:
Azure.Storage.Blobs.Specialized
Assembly:
Azure.Storage.Blobs.dll
Package:
Azure.Storage.Blobs v12.22.2
Package:
Azure.Storage.Blobs v12.23.0-beta.2
Source:
BlobBaseClient.cs
Source:
BlobBaseClient.cs

Opens a stream for reading from the blob. The stream will only download the blob as the stream is read from.

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

Parameters

options
BlobOpenReadOptions

Optional parameters.

cancellationToken
CancellationToken

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

Returns

Task<Stream>

Returns a stream that will download the blob as the stream is read from.

Applies to