Cloud Storage Integrator 2016 Node.js Edition
Cloud Storage Integrator 2016 Node.js Edition
Questions / Feedback?

DeleteBlob Method

Deletes a blob.

Syntax

azureblob.deleteBlob(blobName, deleteBlobAction, [callback])

Callback

The 'callback' parameter specifies a function which will be called when the operation completes (or an error is encountered). If the 'callback' parameter is not specified, then the method will block and will not return until the operation completes (or an error is encountered).

The callback for this method is defined as:

function(err){ }

'err' is the error that occurred. If there was no error, then 'err' is 'null'.

'err' has 2 properties which hold detailed information:

err.code
err.message

Remarks

This method will delete the blob specified by blobName that is stored within the container specified by ContainerName.

deleteBlobAction specifies

0 (BlobAndSnapshots)Delete the base blob and all of its snapshots (if any exist). Required if the blob has associated snapshots.
1 (SnapshotsOnly)Delete only the blob's snapshots and not the blob itself. Required if the blob has associated snapshots.
2 (Unspecified)Delete only the specified blob that does not have any associated snapshots. To delete a specific snapshot, BlobSnapshot can be set prior to calling DeleteBlob.

Note if BlobSnapshot is specified, deleteBlobAction will be ignored. Thus only the specified snapshot will be deleted (the base blob and any other associated snapshots will not be deleted).

If the blob has an active lease, LeaseId must be specified prior to calling DeleteBlob.

 
 
Copyright (c) 2019 /n software inc. - All rights reserved.
Cloud Storage Integrator 2016 Node.js Edition - Version 16.0 [Build 7239]