CloudBlobContainer.ListBlobsSegmentedAsync 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

ListBlobsSegmentedAsync(BlobContinuationToken)	Initiates an asynchronous operation that returns a result segment containing a collection of blob items in the container.
ListBlobsSegmentedAsync(BlobContinuationToken, CancellationToken)	Initiates an asynchronous operation that returns a result segment containing a collection of blob items in the container.
ListBlobsSegmentedAsync(String, BlobContinuationToken)	Initiates an asynchronous operation that returns a result segment containing a collection of blob items in the container.
ListBlobsSegmentedAsync(String, BlobContinuationToken, CancellationToken)	Initiates an asynchronous operation that returns a result segment containing a collection of blob items in the container.
ListBlobsSegmentedAsync(String, Boolean, BlobListingDetails, Nullable<Int32>, BlobContinuationToken, BlobRequestOptions, OperationContext)	Initiates an asynchronous operation that returns a result segment containing a collection of blob items in the container.
ListBlobsSegmentedAsync(String, Boolean, BlobListingDetails, Nullable<Int32>, BlobContinuationToken, BlobRequestOptions, OperationContext, CancellationToken)	Initiates an asynchronous operation that returns a result segment containing a collection of blob items in the container.

ListBlobsSegmentedAsync(BlobContinuationToken)

Initiates an asynchronous operation that returns a result segment containing a collection of blob items in the container.

[Microsoft.Azure.Storage.DoesServiceRequest]
public virtual System.Threading.Tasks.Task<Microsoft.Azure.Storage.Blob.BlobResultSegment> ListBlobsSegmentedAsync (Microsoft.Azure.Storage.Blob.BlobContinuationToken currentToken);

[<Microsoft.Azure.Storage.DoesServiceRequest>]
abstract member ListBlobsSegmentedAsync : Microsoft.Azure.Storage.Blob.BlobContinuationToken -> System.Threading.Tasks.Task<Microsoft.Azure.Storage.Blob.BlobResultSegment>
override this.ListBlobsSegmentedAsync : Microsoft.Azure.Storage.Blob.BlobContinuationToken -> System.Threading.Tasks.Task<Microsoft.Azure.Storage.Blob.BlobResultSegment>

Public Overridable Function ListBlobsSegmentedAsync (currentToken As BlobContinuationToken) As Task(Of BlobResultSegment)

Parameters

currentToken: BlobContinuationToken

A continuation token returned by a previous listing operation.

Returns

Task<BlobResultSegment>

Attributes: DoesServiceRequestAttribute

Applies to

ListBlobsSegmentedAsync(BlobContinuationToken, CancellationToken)

Initiates an asynchronous operation that returns a result segment containing a collection of blob items in the container.

[Microsoft.Azure.Storage.DoesServiceRequest]
public virtual System.Threading.Tasks.Task<Microsoft.Azure.Storage.Blob.BlobResultSegment> ListBlobsSegmentedAsync (Microsoft.Azure.Storage.Blob.BlobContinuationToken currentToken, System.Threading.CancellationToken cancellationToken);

[<Microsoft.Azure.Storage.DoesServiceRequest>]
abstract member ListBlobsSegmentedAsync : Microsoft.Azure.Storage.Blob.BlobContinuationToken * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Microsoft.Azure.Storage.Blob.BlobResultSegment>
override this.ListBlobsSegmentedAsync : Microsoft.Azure.Storage.Blob.BlobContinuationToken * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Microsoft.Azure.Storage.Blob.BlobResultSegment>

Public Overridable Function ListBlobsSegmentedAsync (currentToken As BlobContinuationToken, cancellationToken As CancellationToken) As Task(Of BlobResultSegment)

Parameters

currentToken: BlobContinuationToken

A continuation token returned by a previous listing operation.

cancellationToken: CancellationToken

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

Returns

Task<BlobResultSegment>

Attributes: DoesServiceRequestAttribute

Applies to

ListBlobsSegmentedAsync(String, BlobContinuationToken)

Initiates an asynchronous operation that returns a result segment containing a collection of blob items in the container.

[Microsoft.Azure.Storage.DoesServiceRequest]
public virtual System.Threading.Tasks.Task<Microsoft.Azure.Storage.Blob.BlobResultSegment> ListBlobsSegmentedAsync (string prefix, Microsoft.Azure.Storage.Blob.BlobContinuationToken currentToken);

[<Microsoft.Azure.Storage.DoesServiceRequest>]
abstract member ListBlobsSegmentedAsync : string * Microsoft.Azure.Storage.Blob.BlobContinuationToken -> System.Threading.Tasks.Task<Microsoft.Azure.Storage.Blob.BlobResultSegment>
override this.ListBlobsSegmentedAsync : string * Microsoft.Azure.Storage.Blob.BlobContinuationToken -> System.Threading.Tasks.Task<Microsoft.Azure.Storage.Blob.BlobResultSegment>

Public Overridable Function ListBlobsSegmentedAsync (prefix As String, currentToken As BlobContinuationToken) As Task(Of BlobResultSegment)

Parameters

prefix: String

A string containing the blob name prefix.

currentToken: BlobContinuationToken

A continuation token returned by a previous listing operation.

Returns

Task<BlobResultSegment>

Attributes: DoesServiceRequestAttribute

Applies to

ListBlobsSegmentedAsync(String, BlobContinuationToken, CancellationToken)

Initiates an asynchronous operation that returns a result segment containing a collection of blob items in the container.

[Microsoft.Azure.Storage.DoesServiceRequest]
public virtual System.Threading.Tasks.Task<Microsoft.Azure.Storage.Blob.BlobResultSegment> ListBlobsSegmentedAsync (string prefix, Microsoft.Azure.Storage.Blob.BlobContinuationToken currentToken, System.Threading.CancellationToken cancellationToken);

[<Microsoft.Azure.Storage.DoesServiceRequest>]
abstract member ListBlobsSegmentedAsync : string * Microsoft.Azure.Storage.Blob.BlobContinuationToken * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Microsoft.Azure.Storage.Blob.BlobResultSegment>
override this.ListBlobsSegmentedAsync : string * Microsoft.Azure.Storage.Blob.BlobContinuationToken * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Microsoft.Azure.Storage.Blob.BlobResultSegment>

Public Overridable Function ListBlobsSegmentedAsync (prefix As String, currentToken As BlobContinuationToken, cancellationToken As CancellationToken) As Task(Of BlobResultSegment)

Parameters

prefix: String

A string containing the blob name prefix.

currentToken: BlobContinuationToken

A continuation token returned by a previous listing operation.

cancellationToken: CancellationToken

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

Returns

Task<BlobResultSegment>

Attributes: DoesServiceRequestAttribute

Applies to

ListBlobsSegmentedAsync(String, Boolean, BlobListingDetails, Nullable<Int32>, BlobContinuationToken, BlobRequestOptions, OperationContext)

Initiates an asynchronous operation that returns a result segment containing a collection of blob items in the container.

[Microsoft.Azure.Storage.DoesServiceRequest]
public virtual System.Threading.Tasks.Task<Microsoft.Azure.Storage.Blob.BlobResultSegment> ListBlobsSegmentedAsync (string prefix, bool useFlatBlobListing, Microsoft.Azure.Storage.Blob.BlobListingDetails blobListingDetails, int? maxResults, Microsoft.Azure.Storage.Blob.BlobContinuationToken currentToken, Microsoft.Azure.Storage.Blob.BlobRequestOptions options, Microsoft.Azure.Storage.OperationContext operationContext);

[<Microsoft.Azure.Storage.DoesServiceRequest>]
abstract member ListBlobsSegmentedAsync : string * bool * Microsoft.Azure.Storage.Blob.BlobListingDetails * Nullable<int> * Microsoft.Azure.Storage.Blob.BlobContinuationToken * Microsoft.Azure.Storage.Blob.BlobRequestOptions * Microsoft.Azure.Storage.OperationContext -> System.Threading.Tasks.Task<Microsoft.Azure.Storage.Blob.BlobResultSegment>
override this.ListBlobsSegmentedAsync : string * bool * Microsoft.Azure.Storage.Blob.BlobListingDetails * Nullable<int> * Microsoft.Azure.Storage.Blob.BlobContinuationToken * Microsoft.Azure.Storage.Blob.BlobRequestOptions * Microsoft.Azure.Storage.OperationContext -> System.Threading.Tasks.Task<Microsoft.Azure.Storage.Blob.BlobResultSegment>

Public Overridable Function ListBlobsSegmentedAsync (prefix As String, useFlatBlobListing As Boolean, blobListingDetails As BlobListingDetails, maxResults As Nullable(Of Integer), currentToken As BlobContinuationToken, options As BlobRequestOptions, operationContext As OperationContext) As Task(Of BlobResultSegment)

Parameters

prefix: String

A string containing the blob name prefix.

useFlatBlobListing: Boolean

A boolean value that specifies whether to list blobs in a flat listing, or whether to list blobs hierarchically, by virtual directory.

blobListingDetails: BlobListingDetails

A BlobListingDetails enumeration describing which items to include in the listing.

maxResults: Nullable<Int32>

A non-negative integer value that indicates the maximum number of results to be returned at a time, up to the per-operation limit of 5000. If this value is null, the maximum possible number of results will be returned, up to 5000.

currentToken: BlobContinuationToken

A continuation token returned by a previous listing operation.

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<BlobResultSegment>

A Task<TResult> object that represents the asynchronous operation.

Attributes: DoesServiceRequestAttribute

Applies to

ListBlobsSegmentedAsync(String, Boolean, BlobListingDetails, Nullable<Int32>, BlobContinuationToken, BlobRequestOptions, OperationContext, CancellationToken)

Initiates an asynchronous operation that returns a result segment containing a collection of blob items in the container.

[Microsoft.Azure.Storage.DoesServiceRequest]
public virtual System.Threading.Tasks.Task<Microsoft.Azure.Storage.Blob.BlobResultSegment> ListBlobsSegmentedAsync (string prefix, bool useFlatBlobListing, Microsoft.Azure.Storage.Blob.BlobListingDetails blobListingDetails, int? maxResults, Microsoft.Azure.Storage.Blob.BlobContinuationToken currentToken, Microsoft.Azure.Storage.Blob.BlobRequestOptions options, Microsoft.Azure.Storage.OperationContext operationContext, System.Threading.CancellationToken cancellationToken);

[<Microsoft.Azure.Storage.DoesServiceRequest>]
abstract member ListBlobsSegmentedAsync : string * bool * Microsoft.Azure.Storage.Blob.BlobListingDetails * Nullable<int> * Microsoft.Azure.Storage.Blob.BlobContinuationToken * Microsoft.Azure.Storage.Blob.BlobRequestOptions * Microsoft.Azure.Storage.OperationContext * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Microsoft.Azure.Storage.Blob.BlobResultSegment>
override this.ListBlobsSegmentedAsync : string * bool * Microsoft.Azure.Storage.Blob.BlobListingDetails * Nullable<int> * Microsoft.Azure.Storage.Blob.BlobContinuationToken * Microsoft.Azure.Storage.Blob.BlobRequestOptions * Microsoft.Azure.Storage.OperationContext * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Microsoft.Azure.Storage.Blob.BlobResultSegment>

Public Overridable Function ListBlobsSegmentedAsync (prefix As String, useFlatBlobListing As Boolean, blobListingDetails As BlobListingDetails, maxResults As Nullable(Of Integer), currentToken As BlobContinuationToken, options As BlobRequestOptions, operationContext As OperationContext, cancellationToken As CancellationToken) As Task(Of BlobResultSegment)

Parameters

prefix: String

A string containing the blob name prefix.

useFlatBlobListing: Boolean

A boolean value that specifies whether to list blobs in a flat listing, or whether to list blobs hierarchically, by virtual directory.

blobListingDetails: BlobListingDetails

A BlobListingDetails enumeration describing which items to include in the listing.

maxResults: Nullable<Int32>

currentToken: BlobContinuationToken

A continuation token returned by a previous listing operation.

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<BlobResultSegment>

A Task<TResult> object that represents the asynchronous operation.

Attributes: DoesServiceRequestAttribute

Applies to

Share via

CloudBlobContainer.ListBlobsSegmentedAsync Method

Definition

Overloads

ListBlobsSegmentedAsync(BlobContinuationToken)

Parameters

Returns

Applies to

ListBlobsSegmentedAsync(BlobContinuationToken, CancellationToken)

Parameters

Returns

Applies to

ListBlobsSegmentedAsync(String, BlobContinuationToken)

Parameters

Returns

Applies to

ListBlobsSegmentedAsync(String, BlobContinuationToken, CancellationToken)

Parameters

Returns

Applies to

ListBlobsSegmentedAsync(String, Boolean, BlobListingDetails, Nullable<Int32>, BlobContinuationToken, BlobRequestOptions, OperationContext)

Parameters

Returns

Applies to

ListBlobsSegmentedAsync(String, Boolean, BlobListingDetails, Nullable<Int32>, BlobContinuationToken, BlobRequestOptions, OperationContext, CancellationToken)

Parameters

Returns

Applies to

Additional resources