CloudBlobClient.ListBlobsSegmented 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

ListBlobsSegmented(String, BlobContinuationToken)	Returns a result segment containing a collection of blob items in the container.
ListBlobsSegmented(String, Boolean, BlobListingDetails, Nullable<Int32>, BlobContinuationToken, BlobRequestOptions, OperationContext)	Returns a result segment containing a collection of blob items in the container.

ListBlobsSegmented(String, BlobContinuationToken)

Returns a result segment containing a collection of blob items in the container.

[Microsoft.Azure.Storage.DoesServiceRequest]
public virtual Microsoft.Azure.Storage.Blob.BlobResultSegment ListBlobsSegmented (string prefix, Microsoft.Azure.Storage.Blob.BlobContinuationToken currentToken);

[<Microsoft.Azure.Storage.DoesServiceRequest>]
abstract member ListBlobsSegmented : string * Microsoft.Azure.Storage.Blob.BlobContinuationToken -> Microsoft.Azure.Storage.Blob.BlobResultSegment
override this.ListBlobsSegmented : string * Microsoft.Azure.Storage.Blob.BlobContinuationToken -> Microsoft.Azure.Storage.Blob.BlobResultSegment

Public Overridable Function ListBlobsSegmented (prefix As String, currentToken As BlobContinuationToken) As BlobResultSegment

Parameters

prefix: String

A string containing the blob name prefix, including the container name.

currentToken: BlobContinuationToken

A BlobContinuationToken object returned by a previous listing operation.

Returns

BlobResultSegment

A BlobResultSegment object.

Attributes: DoesServiceRequestAttribute

Applies to

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

Returns a result segment containing a collection of blob items in the container.

[Microsoft.Azure.Storage.DoesServiceRequest]
public virtual Microsoft.Azure.Storage.Blob.BlobResultSegment ListBlobsSegmented (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 ListBlobsSegmented : string * bool * Microsoft.Azure.Storage.Blob.BlobListingDetails * Nullable<int> * Microsoft.Azure.Storage.Blob.BlobContinuationToken * Microsoft.Azure.Storage.Blob.BlobRequestOptions * Microsoft.Azure.Storage.OperationContext -> Microsoft.Azure.Storage.Blob.BlobResultSegment
override this.ListBlobsSegmented : string * bool * Microsoft.Azure.Storage.Blob.BlobListingDetails * Nullable<int> * Microsoft.Azure.Storage.Blob.BlobContinuationToken * Microsoft.Azure.Storage.Blob.BlobRequestOptions * Microsoft.Azure.Storage.OperationContext -> Microsoft.Azure.Storage.Blob.BlobResultSegment

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

Parameters

prefix: String

A string containing the blob name prefix, including the container name.

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.