CreateSnapshot Method

Creates a read-only snapshot of a blob.

Syntax

azureblob.createSnapshot(blobName, [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 create a read-only snapshot of the blob specified by blobName and stored within the container specified by ContainerName.

Any metadata specified in Metadata will be set for the created snapshot.

Optionally, LeaseId can be set in which case the operation will only be performed if the following two conditions are met;

• The blob's lease is currently active.
• The lease ID specified in the request matches that of the blob.

IfMatch can be set to an ETag value to perform an operation only if the specified ETag matches that of blobName. If the ETag values do not match, a 412 (Precondition Failed) error is returned.

The following headers can be specified within OtherHeaders if needed: