CloudBlob.OpenReadAsync 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
| OpenReadAsync() |
Initiates an asynchronous operation to open a stream for reading from the blob. |
| OpenReadAsync(CancellationToken) |
Initiates an asynchronous operation to open a stream for reading from the blob. |
| OpenReadAsync(AccessCondition, BlobRequestOptions, OperationContext) |
Initiates an asynchronous operation to open a stream for reading from the blob. |
| OpenReadAsync(AccessCondition, BlobRequestOptions, OperationContext, CancellationToken) |
Initiates an asynchronous operation to open a stream for reading from the blob. |
OpenReadAsync()
Initiates an asynchronous operation to open a stream for reading from the blob.
[Microsoft.Azure.Storage.DoesServiceRequest]
public virtual System.Threading.Tasks.Task<System.IO.Stream> OpenReadAsync ();[<Microsoft.Azure.Storage.DoesServiceRequest>]
abstract member OpenReadAsync : unit -> System.Threading.Tasks.Task<System.IO.Stream>
override this.OpenReadAsync : unit -> System.Threading.Tasks.Task<System.IO.Stream>Public Overridable Function OpenReadAsync () As Task(Of Stream)Returns
A Task<TResult> object of type Stream that represents the asynchronous operation.
- Attributes
Remarks
On the Stream object returned by this method, the EndRead(IAsyncResult) method must be called exactly once for every BeginRead(Byte[], Int32, Int32, AsyncCallback, Object) call. Failing to end the read process before beginning another read process can cause unexpected behavior.
Note that this method always makes a call to the FetchAttributesAsync(AccessCondition, BlobRequestOptions, OperationContext, CancellationToken) method under the covers.
Set the StreamMinimumReadSizeInBytes property before calling this method to specify the minimum number of bytes to buffer when reading from the stream. The value must be at least 16 KB.
Applies to
OpenReadAsync(CancellationToken)
Initiates an asynchronous operation to open a stream for reading from the blob.
[Microsoft.Azure.Storage.DoesServiceRequest]
public virtual System.Threading.Tasks.Task<System.IO.Stream> OpenReadAsync (System.Threading.CancellationToken cancellationToken);[<Microsoft.Azure.Storage.DoesServiceRequest>]
abstract member OpenReadAsync : System.Threading.CancellationToken -> System.Threading.Tasks.Task<System.IO.Stream>
override this.OpenReadAsync : System.Threading.CancellationToken -> System.Threading.Tasks.Task<System.IO.Stream>Public Overridable Function OpenReadAsync (cancellationToken As CancellationToken) As Task(Of Stream)Parameters
- cancellationToken
- CancellationToken
A CancellationToken to observe while waiting for a task to complete.
Returns
A Task<TResult> object of type Stream that represents the asynchronous operation.
- Attributes
Remarks
On the Stream object returned by this method, the EndRead(IAsyncResult) method must be called exactly once for every BeginRead(Byte[], Int32, Int32, AsyncCallback, Object) call. Failing to end the read process before beginning another read process can cause unexpected behavior.
Note that this method always makes a call to the FetchAttributesAsync(AccessCondition, BlobRequestOptions, OperationContext, CancellationToken) method under the covers.
Set the StreamMinimumReadSizeInBytes property before calling this method to specify the minimum number of bytes to buffer when reading from the stream. The value must be at least 16 KB.
Applies to
OpenReadAsync(AccessCondition, BlobRequestOptions, OperationContext)
Initiates an asynchronous operation to open a stream for reading from the blob.
[Microsoft.Azure.Storage.DoesServiceRequest]
public virtual System.Threading.Tasks.Task<System.IO.Stream> OpenReadAsync (Microsoft.Azure.Storage.AccessCondition accessCondition, Microsoft.Azure.Storage.Blob.BlobRequestOptions options, Microsoft.Azure.Storage.OperationContext operationContext);[<Microsoft.Azure.Storage.DoesServiceRequest>]
abstract member OpenReadAsync : Microsoft.Azure.Storage.AccessCondition * Microsoft.Azure.Storage.Blob.BlobRequestOptions * Microsoft.Azure.Storage.OperationContext -> System.Threading.Tasks.Task<System.IO.Stream>
override this.OpenReadAsync : Microsoft.Azure.Storage.AccessCondition * Microsoft.Azure.Storage.Blob.BlobRequestOptions * Microsoft.Azure.Storage.OperationContext -> System.Threading.Tasks.Task<System.IO.Stream>Public Overridable Function OpenReadAsync (accessCondition As AccessCondition, options As BlobRequestOptions, operationContext As OperationContext) As Task(Of Stream)Parameters
- 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
A Task<TResult> object of type Stream that represents the asynchronous operation.
- Attributes
Remarks
On the Stream object returned by this method, the EndRead(IAsyncResult) method must be called exactly once for every BeginRead(Byte[], Int32, Int32, AsyncCallback, Object) call. Failing to end the read process before beginning another read process can cause unexpected behavior.
Note that this method always makes a call to the FetchAttributesAsync(AccessCondition, BlobRequestOptions, OperationContext, CancellationToken) method under the covers.
Set the StreamMinimumReadSizeInBytes property before calling this method to specify the minimum number of bytes to buffer when reading from the stream. The value must be at least 16 KB.
Applies to
OpenReadAsync(AccessCondition, BlobRequestOptions, OperationContext, CancellationToken)
Initiates an asynchronous operation to open a stream for reading from the blob.
[Microsoft.Azure.Storage.DoesServiceRequest]
public virtual System.Threading.Tasks.Task<System.IO.Stream> OpenReadAsync (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 OpenReadAsync : Microsoft.Azure.Storage.AccessCondition * Microsoft.Azure.Storage.Blob.BlobRequestOptions * Microsoft.Azure.Storage.OperationContext * System.Threading.CancellationToken -> System.Threading.Tasks.Task<System.IO.Stream>
override this.OpenReadAsync : Microsoft.Azure.Storage.AccessCondition * Microsoft.Azure.Storage.Blob.BlobRequestOptions * Microsoft.Azure.Storage.OperationContext * System.Threading.CancellationToken -> System.Threading.Tasks.Task<System.IO.Stream>Public Overridable Function OpenReadAsync (accessCondition As AccessCondition, options As BlobRequestOptions, operationContext As OperationContext, cancellationToken As CancellationToken) As Task(Of Stream)Parameters
- 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
A Task<TResult> object of type Stream that represents the asynchronous operation.
- Attributes
Remarks
On the Stream object returned by this method, the EndRead(IAsyncResult) method must be called exactly once for every BeginRead(Byte[], Int32, Int32, AsyncCallback, Object) call. Failing to end the read process before beginning another read process can cause unexpected behavior.
Note that this method always makes a call to the FetchAttributesAsync(AccessCondition, BlobRequestOptions, OperationContext, CancellationToken) method under the covers.
Set the StreamMinimumReadSizeInBytes property before calling this method to specify the minimum number of bytes to buffer when reading from the stream. The value must be at least 16 KB.
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