Export (0) Print
Expand All

CloudBlob.BeginDelete Method (BlobRequestOptions, AsyncCallback, Object)

Updated: April 24, 2013

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

Begins an asynchronous operation to delete a 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
Dim instance As CloudBlob
Dim options As BlobRequestOptions
Dim callback As AsyncCallback
Dim state As Object
Dim returnValue As IAsyncResult

returnValue = instance.BeginDelete(options, callback, state)

public IAsyncResult BeginDelete (
	BlobRequestOptions options,
	AsyncCallback callback,
	Object state
)

Parameters

options

Type: Microsoft.WindowsAzure.StorageClient.BlobRequestOptions

An object that specifies any additional options for the request.

callback

Type: System.AsyncCallback

The callback delegate that will receive notification when the asynchronous operation completes.

state

Type: System.Object

A user-defined object that will be passed to the callback delegate.

Return Value

Type: System.IAsyncResult

An IAsyncResult that references the asynchronous operation.

The following code example creates a blob reference, then instantiates it in the cloud by uploading the contents of a local text file to it, and finally deletes it —using a conditional, asynchronous request.


static void Eg_BeginDeleteBlob2(Uri blobEndpoint, string accountName, string accountKey)
{
    // Create a service client for credentialed access to the Blob service.
    CloudBlobClient blobClient =
        new CloudBlobClient(blobEndpoint,
            new StorageCredentialsAccountAndKey(accountName, accountKey));

    // Create a blob reference.
    CloudBlob myBlob = blobClient.GetBlobReference("mycontainer/myblob.txt");

    // Use the blob reference to create and initialize an actual blob in the cloud.
    myBlob.UploadFile("C:\\somefile.txt");

    // Set options for the request.
    BlobRequestOptions options = new BlobRequestOptions();

    // If the blob is a snapshot, then Delete would fail without setting this option.
    options.DeleteSnapshotsOption = DeleteSnapshotsOption.IncludeSnapshots;
 
    // Delete the blob only if it's contents have changed during the past week.
    System.TimeSpan interval = new TimeSpan(7, 0, 0, 0);
    options.CopySourceAccessCondition = AccessCondition.IfModifiedSince(DateTime.UtcNow.Subtract(interval));

    // Delete the blob using an asynchronous call.
    myBlob.BeginDelete(options, Eg_DeleteCallback, myBlob);
}

private void Eg_DeleteCallback(IAsyncResult result)
{
    CloudBlob blobToDelete = (CloudBlob)result.AsyncState;
    blobToDelete.EndDelete(result);
}

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 BeginDelete method will fail if the blob does not exist. To delete the blob only if it exists, use the BeginDeleteIfExists method.


Any public static (Shared in Visual Basic) members of this type are thread safe. Any instance members are not guaranteed to be thread safe.

Development Platforms

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

 

Show:
© 2014 Microsoft