BlobBaseClient.OpenRead(BlobOpenReadOptions, CancellationToken) Method

Reference

Definition

Namespace:: Azure.Storage.Blobs.Specialized

Assembly:: Azure.Storage.Blobs.dll

Package:: Azure.Storage.Blobs v12.24.0

Package:: Azure.Storage.Blobs v12.24.0-beta.1

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.

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

public virtual System.IO.Stream OpenRead(Azure.Storage.Blobs.Models.BlobOpenReadOptions options, System.Threading.CancellationToken cancellationToken = default);

abstract member OpenRead : Azure.Storage.Blobs.Models.BlobOpenReadOptions * System.Threading.CancellationToken -> System.IO.Stream
override this.OpenRead : Azure.Storage.Blobs.Models.BlobOpenReadOptions * System.Threading.CancellationToken -> System.IO.Stream

Public Overridable Function OpenRead (options As BlobOpenReadOptions, Optional cancellationToken As CancellationToken = Nothing) As Stream

Parameters

options: BlobOpenReadOptions

Optional parameters.

cancellationToken: CancellationToken

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

Returns

Stream

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

Remarks

A RequestFailedException will be thrown if a failure occurs. If multiple failures occur, an AggregateException will be thrown, containing each failure instance.

Applies to

Share via