CloudBlob.Delete Method (BlobRequestOptions)

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

Deletes the blob, 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 CloudBlob
Dim options As BlobRequestOptions

instance.Delete(options)

Syntax

Visual Basic
Public Sub Delete ( _
	options As BlobRequestOptions _
)
C#
public void Delete (
	BlobRequestOptions options
)
C++
public:
void Delete (
	BlobRequestOptions^ options
)
J#
JScript

Parameters

options

Type: Microsoft.WindowsAzure.StorageClient.BlobRequestOptions

An object that specifies any additional options for the request.

Example

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

C# Copy Code
static void DeleteBlobsAndSnapshots2(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

A blob that has snapshots cannot be deleted unless the snapshots are also deleted. If a blob has snapshots, use the DeleteSnapshotsOption property to specify how the snapshots should be handled when the blob is deleted.

The Delete method will fail if the blob does not exist. To delete the blob only if it exists, use the DeleteIfExists method.


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