CloudBlob.DeleteIfExists 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 if it exists, 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
Dim returnValue As Boolean

returnValue = instance.DeleteIfExists(options)

Syntax

Visual Basic
Public Function DeleteIfExists ( _
	options As BlobRequestOptions _
) As Boolean
C#
public bool DeleteIfExists (
	BlobRequestOptions options
)
C++
public:
bool DeleteIfExists (
	BlobRequestOptions^ options
)
J#
JScript

Parameters

options

Type: Microsoft.WindowsAzure.StorageClient.BlobRequestOptions

An object that specifies any additional options for the request.

Return Value

Type: System.Boolean

true if the blob was deleted; otherwise, false.

Example

The following code example deletes a blob if it already exists.

C# Copy Code
static void UploadTextToBlob2(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));

    // Return a reference to the blob.
    CloudBlob blob = blobClient.GetBlobReference("mycontainer/myblob.txt");

    // Delete the blob if it already exists, also deleting any snapshots.
    BlobRequestOptions options = new BlobRequestOptions();

    options.DeleteSnapshotsOption = DeleteSnapshotsOption.IncludeSnapshots;

    blob.DeleteIfExists(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.


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