BlobRequestOptions.DeleteSnapshotsOption Property

Storage Client Library NET API

previous page next page

[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 deleting snapshots when a blob is to be deleted.

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

Usage

Visual Basic
Dim instance As BlobRequestOptions Dim value As DeleteSnapshotsOption value = instance.DeleteSnapshotsOption instance.DeleteSnapshotsOption = value

Syntax

Visual Basic
Public Property DeleteSnapshotsOption As DeleteSnapshotsOption

C#
public DeleteSnapshotsOption DeleteSnapshotsOption { get; set; }

C++
public: property DeleteSnapshotsOption DeleteSnapshotsOption { DeleteSnapshotsOption get (); void set (DeleteSnapshotsOption value); }

J#

JScript

Property Value

Type: Microsoft.WindowsAzure.StorageClient.DeleteSnapshotsOption

One of the enumeration values that specifies whether to delete blobs and snapshots, delete blobs only, or delete snapshots only.

Example

The following code example enumerates through the blobs in a container and deletes each blob and its snapshots.

C#	Copy Code
static void DeleteBlobsAndSnapshots(Uri blobEndpoint, string accountName, string accountKey) { CloudBlobClient blobClient = new CloudBlobClient(blobEndpoint, new StorageCredentialsAccountAndKey(accountName, accountKey)); //Get a reference to the container. CloudBlobContainer container = blobClient.GetContainerReference("mycontainer"); //Indicate that any snapshots should be deleted. BlobRequestOptions options = new BlobRequestOptions(); options.DeleteSnapshotsOption = DeleteSnapshotsOption.IncludeSnapshots; //Specify a flat blob listing, so that only CloudBlob objects will be returned. //The Delete method exists only on CloudBlob, not on IListBlobItem. options.UseFlatBlobListing = true; //Enumerate through the blobs in the container, deleting both blobs and their snapshots. foreach (CloudBlob blob in container.ListBlobs(options)) { Console.WriteLine(blob.Uri); blob.Delete(options); } }

Copy Code

static void DeleteBlobsAndSnapshots(Uri blobEndpoint, string accountName, string accountKey)
{
    CloudBlobClient blobClient = new CloudBlobClient(blobEndpoint, new StorageCredentialsAccountAndKey(accountName, accountKey));

    //Get a reference to the container.
    CloudBlobContainer container = blobClient.GetContainerReference("mycontainer");

    //Indicate that any snapshots should be deleted.
    BlobRequestOptions options = new BlobRequestOptions();
    options.DeleteSnapshotsOption = DeleteSnapshotsOption.IncludeSnapshots;

    //Specify a flat blob listing, so that only CloudBlob objects will be returned.
    //The Delete method exists only on CloudBlob, not on IListBlobItem.
    options.UseFlatBlobListing = true;

    //Enumerate through the blobs in the container, deleting both blobs and their snapshots.
    foreach (CloudBlob blob in container.ListBlobs(options))
    {
        Console.WriteLine(blob.Uri);
        blob.Delete(options);
    }
}

Remarks

This property is applicable only to a request that will delete a blob.

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