[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
) |
Parameters
- options
Type: Microsoft.WindowsAzure.StorageClient.BlobRequestOptions
An object that specifies any additional options for the request.
Return Value
Type:
System.Booleantrue
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
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
Change History
See Also