BlobRequestOptions.BlobListingDetails Property

Storage Client Library NET API

[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.]

Gets or sets options for listing blobs.

Namespace: Microsoft.WindowsAzure.StorageClient
Assembly: Microsoft.WindowsAzure.StorageClient (in Microsoft.WindowsAzure.StorageClient.dll)

Usage

Visual Basic
Dim instance As BlobRequestOptions
Dim value As BlobListingDetails

value = instance.BlobListingDetails

instance.BlobListingDetails = value

Syntax

Visual Basic
Public Property BlobListingDetails As BlobListingDetails
C#
public BlobListingDetails BlobListingDetails { get; set; }
C++
public:
property BlobListingDetails BlobListingDetails {
	BlobListingDetails get ();
	void set (BlobListingDetails value);
}
J#
JScript

Property Value

Type: Microsoft.WindowsAzure.StorageClient.BlobListingDetails

One of the enumeration values that indicates what items a listing operation will return.

Example

The following code example lists blobs in a container, including snapshots.

C# Copy Code
static void ListBlobsInContainer(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 the container.
    CloudBlobContainer container = blobClient.GetContainerReference("mycontainer");

    //List blobs in this container using a flat listing.
    BlobRequestOptions options = new BlobRequestOptions();
    options.UseFlatBlobListing = true;

    //List snapshots, which requires a flat blob listing.
    options.BlobListingDetails = BlobListingDetails.Snapshots;
            
    foreach (var blobItem in container.ListBlobs(options))
    {
        Console.WriteLine(blobItem.Uri);
    }
}

Remarks

This property is applicable only to a request to list blobs.


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.

Platforms

Development Platforms

Windows Vista, Windows 7, Windows Server 2008, Windows 8.1, Windows Server 2012 R2, Windows 8 and Windows Server 2012

Change History

See Also