[This topic is part of the Microsoft Azure Storage Client Library 1.7, which has been deprecated. See Storage Client Library for the latest version.]
Returns an enumerable collection of blob items in this blob directory that is lazily retrieved, either as a flat listing or by blob subdirectory, using a conditional request based on the BlobRequestOptions that you specify. Namespace: Microsoft.WindowsAzure.StorageClient
Assembly: Microsoft.WindowsAzure.StorageClient (in Microsoft.WindowsAzure.StorageClient.dll)
Returns an enumerable collection of blob items in this blob directory that is lazily retrieved, either as a flat listing or by blob subdirectory, using a conditional request based on the BlobRequestOptions that you specify. Namespace: Microsoft.WindowsAzure.StorageClient
Assembly: Microsoft.WindowsAzure.StorageClient (in Microsoft.WindowsAzure.StorageClient.dll)
Usage
| Visual Basic |
|---|
Dim instance As CloudBlobDirectory Dim options As BlobRequestOptions Dim returnValue As IEnumerable(Of IListBlobItem) returnValue = instance.ListBlobs(options) |
Syntax
| Visual Basic |
|---|
Public Function ListBlobs ( _ options As BlobRequestOptions _ ) As IEnumerable(Of IListBlobItem) |
| C# |
|---|
public IEnumerable<IListBlobItem> ListBlobs ( BlobRequestOptions options ) |
| C++ |
|---|
public: IEnumerable<IListBlobItem^>^ ListBlobs ( BlobRequestOptions^ options ) |
| J# |
|---|
| JScript |
|---|
Parameters
- options
An object that specifies any additional options for the request.
Return Value
An enumerable collection of objects that implement IListBlobItem and are retrieved lazily.Example
This code example lists blobs in a blob directory, first hierarchically and then as a flat listing.
| Copy Code | |
|---|---|
static void ListBlobsInDirectory(Uri blobEndpoint, string accountName, string accountKey)
{
//Create service client for credentialed access to the Blob service.
CloudBlobClient blobClient = new CloudBlobClient(blobEndpoint, new StorageCredentialsAccountAndKey(accountName, accountKey));
//Get a reference to a blob directory in a container named 'mycontainer'.
CloudBlobDirectory blobDir = blobClient.GetBlobDirectoryReference("mycontainer/a/b/");
//List blobs and directories in this blob directory hierarchically.
foreach (var blobItem in blobDir.ListBlobs())
{
Console.WriteLine(blobItem.Uri);
}
Console.WriteLine();
//List blobs in this blob directory using a flat listing.
BlobRequestOptions options = new BlobRequestOptions();
options.UseFlatBlobListing = true;
foreach (var blobItem in blobDir.ListBlobs(options))
{
Console.WriteLine(blobItem.Uri);
}
}
| |
Remarks
The types of objects returned by the ListBlobs method depend on the type of listing that is being performed. If the UseFlatBlobListing property is set to true, the listing will return an enumerable collection of CloudBlob objects. If UseFlatBlobListing is set to false (the default value), the listing may return a collection containing CloudBlob objects and CloudBlobDirectory objects. The latter case provides a convenience for subsequent enumerations over a virtual blob hierarchy.
Thread Safety
Any public static (Shared in Visual Basic) members of this type are thread safe. Any instance members are not guaranteed to be thread safe.