CloudBlobContainer.ListBlobs 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.
Returns an enumerable collection of the blobs in the container that are retrieved lazily.
[Microsoft.Azure.Storage.DoesServiceRequest]
public virtual System.Collections.Generic.IEnumerable<Microsoft.Azure.Storage.Blob.IListBlobItem> ListBlobs (string prefix = default, bool useFlatBlobListing = false, Microsoft.Azure.Storage.Blob.BlobListingDetails blobListingDetails = Microsoft.Azure.Storage.Blob.BlobListingDetails.None, Microsoft.Azure.Storage.Blob.BlobRequestOptions options = default, Microsoft.Azure.Storage.OperationContext operationContext = default);
[<Microsoft.Azure.Storage.DoesServiceRequest>]
abstract member ListBlobs : string * bool * Microsoft.Azure.Storage.Blob.BlobListingDetails * Microsoft.Azure.Storage.Blob.BlobRequestOptions * Microsoft.Azure.Storage.OperationContext -> seq<Microsoft.Azure.Storage.Blob.IListBlobItem>
override this.ListBlobs : string * bool * Microsoft.Azure.Storage.Blob.BlobListingDetails * Microsoft.Azure.Storage.Blob.BlobRequestOptions * Microsoft.Azure.Storage.OperationContext -> seq<Microsoft.Azure.Storage.Blob.IListBlobItem>
Public Overridable Function ListBlobs (Optional prefix As String = Nothing, Optional useFlatBlobListing As Boolean = false, Optional blobListingDetails As BlobListingDetails = Microsoft.Azure.Storage.Blob.BlobListingDetails.None, Optional options As BlobRequestOptions = Nothing, Optional operationContext As OperationContext = Nothing) As IEnumerable(Of IListBlobItem)
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.
- options
- BlobRequestOptions
A BlobRequestOptions object that specifies additional options for the request. If null
, default options are applied to the request.
- operationContext
- OperationContext
An OperationContext object that represents the context for the current operation.
Returns
An enumerable collection of objects that implement IListBlobItem and are retrieved lazily.
- Attributes