CloudBlockBlob.DownloadBlockListAsync 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
| DownloadBlockListAsync() |
Initiates an asynchronous operation to return an enumerable collection of the blob's blocks, using the specified block list filter. |
| DownloadBlockListAsync(CancellationToken) |
Initiates an asynchronous operation to return an enumerable collection of the blob's blocks, using the specified block list filter. |
| DownloadBlockListAsync(BlockListingFilter, AccessCondition, BlobRequestOptions, OperationContext) |
Initiates an asynchronous operation to return an enumerable collection of the blob's blocks, using the specified block list filter. |
| DownloadBlockListAsync(BlockListingFilter, AccessCondition, BlobRequestOptions, OperationContext, CancellationToken) |
Initiates an asynchronous operation to return an enumerable collection of the blob's blocks, using the specified block list filter. |
DownloadBlockListAsync()
Initiates an asynchronous operation to return an enumerable collection of the blob's blocks, using the specified block list filter.
[Microsoft.Azure.Storage.DoesServiceRequest]
public virtual System.Threading.Tasks.Task<System.Collections.Generic.IEnumerable<Microsoft.Azure.Storage.Blob.ListBlockItem>> DownloadBlockListAsync ();[<Microsoft.Azure.Storage.DoesServiceRequest>]
abstract member DownloadBlockListAsync : unit -> System.Threading.Tasks.Task<seq<Microsoft.Azure.Storage.Blob.ListBlockItem>>
override this.DownloadBlockListAsync : unit -> System.Threading.Tasks.Task<seq<Microsoft.Azure.Storage.Blob.ListBlockItem>>Public Overridable Function DownloadBlockListAsync () As Task(Of IEnumerable(Of ListBlockItem))Returns
A Task<TResult> object that is an enumerable collection of type ListBlockItem that represents the asynchronous operation.
- Attributes
Applies to
DownloadBlockListAsync(CancellationToken)
Initiates an asynchronous operation to return an enumerable collection of the blob's blocks, using the specified block list filter.
[Microsoft.Azure.Storage.DoesServiceRequest]
public virtual System.Threading.Tasks.Task<System.Collections.Generic.IEnumerable<Microsoft.Azure.Storage.Blob.ListBlockItem>> DownloadBlockListAsync (System.Threading.CancellationToken cancellationToken);[<Microsoft.Azure.Storage.DoesServiceRequest>]
abstract member DownloadBlockListAsync : System.Threading.CancellationToken -> System.Threading.Tasks.Task<seq<Microsoft.Azure.Storage.Blob.ListBlockItem>>
override this.DownloadBlockListAsync : System.Threading.CancellationToken -> System.Threading.Tasks.Task<seq<Microsoft.Azure.Storage.Blob.ListBlockItem>>Public Overridable Function DownloadBlockListAsync (cancellationToken As CancellationToken) As Task(Of IEnumerable(Of ListBlockItem))Parameters
- cancellationToken
- CancellationToken
A CancellationToken to observe while waiting for a task to complete.
Returns
A Task<TResult> object that is an enumerable collection of type ListBlockItem that represents the asynchronous operation.
- Attributes
Applies to
DownloadBlockListAsync(BlockListingFilter, AccessCondition, BlobRequestOptions, OperationContext)
Initiates an asynchronous operation to return an enumerable collection of the blob's blocks, using the specified block list filter.
[Microsoft.Azure.Storage.DoesServiceRequest]
public virtual System.Threading.Tasks.Task<System.Collections.Generic.IEnumerable<Microsoft.Azure.Storage.Blob.ListBlockItem>> DownloadBlockListAsync (Microsoft.Azure.Storage.Blob.BlockListingFilter blockListingFilter, Microsoft.Azure.Storage.AccessCondition accessCondition, Microsoft.Azure.Storage.Blob.BlobRequestOptions options, Microsoft.Azure.Storage.OperationContext operationContext);[<Microsoft.Azure.Storage.DoesServiceRequest>]
abstract member DownloadBlockListAsync : Microsoft.Azure.Storage.Blob.BlockListingFilter * Microsoft.Azure.Storage.AccessCondition * Microsoft.Azure.Storage.Blob.BlobRequestOptions * Microsoft.Azure.Storage.OperationContext -> System.Threading.Tasks.Task<seq<Microsoft.Azure.Storage.Blob.ListBlockItem>>
override this.DownloadBlockListAsync : Microsoft.Azure.Storage.Blob.BlockListingFilter * Microsoft.Azure.Storage.AccessCondition * Microsoft.Azure.Storage.Blob.BlobRequestOptions * Microsoft.Azure.Storage.OperationContext -> System.Threading.Tasks.Task<seq<Microsoft.Azure.Storage.Blob.ListBlockItem>>Public Overridable Function DownloadBlockListAsync (blockListingFilter As BlockListingFilter, accessCondition As AccessCondition, options As BlobRequestOptions, operationContext As OperationContext) As Task(Of IEnumerable(Of ListBlockItem))Parameters
- blockListingFilter
- BlockListingFilter
A BlockListingFilter enumeration value that indicates whether to return committed blocks, uncommitted blocks, or both.
- 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 that is an enumerable collection of type ListBlockItem that represents the asynchronous operation.
- Attributes
Applies to
DownloadBlockListAsync(BlockListingFilter, AccessCondition, BlobRequestOptions, OperationContext, CancellationToken)
Initiates an asynchronous operation to return an enumerable collection of the blob's blocks, using the specified block list filter.
[Microsoft.Azure.Storage.DoesServiceRequest]
public virtual System.Threading.Tasks.Task<System.Collections.Generic.IEnumerable<Microsoft.Azure.Storage.Blob.ListBlockItem>> DownloadBlockListAsync (Microsoft.Azure.Storage.Blob.BlockListingFilter blockListingFilter, 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 DownloadBlockListAsync : Microsoft.Azure.Storage.Blob.BlockListingFilter * Microsoft.Azure.Storage.AccessCondition * Microsoft.Azure.Storage.Blob.BlobRequestOptions * Microsoft.Azure.Storage.OperationContext * System.Threading.CancellationToken -> System.Threading.Tasks.Task<seq<Microsoft.Azure.Storage.Blob.ListBlockItem>>
override this.DownloadBlockListAsync : Microsoft.Azure.Storage.Blob.BlockListingFilter * Microsoft.Azure.Storage.AccessCondition * Microsoft.Azure.Storage.Blob.BlobRequestOptions * Microsoft.Azure.Storage.OperationContext * System.Threading.CancellationToken -> System.Threading.Tasks.Task<seq<Microsoft.Azure.Storage.Blob.ListBlockItem>>Public Overridable Function DownloadBlockListAsync (blockListingFilter As BlockListingFilter, accessCondition As AccessCondition, options As BlobRequestOptions, operationContext As OperationContext, cancellationToken As CancellationToken) As Task(Of IEnumerable(Of ListBlockItem))Parameters
- blockListingFilter
- BlockListingFilter
A BlockListingFilter enumeration value that indicates whether to return committed blocks, uncommitted blocks, or both.
- 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 that is an enumerable collection of type ListBlockItem that represents the asynchronous operation.
- Attributes
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