Snapshot Property

The blob snapshot to make requests against.

Syntax

 azureblob.getSnapshot([callback])
 azureblob.setSnapshot( snapshot, [callback])

Default Value

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 the getSnapshot([callback]) method is defined as:

function(err, data){ }

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

'data' is the value returned by the method.

The callback for the setSnapshot([callback]) 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 property can be set to the opaque DateTime value used to identify a particular blob snapshot before calling the following methods in order to make requests against the specified blob snapshot instead of the base blob:

CopyBlob (to copy from a blob snapshot)
DeleteBlob
GetBlob
GetBlobInfo
GetLink (to build a link for a specific blob snapshot)
ListPageRanges
SendCustomRequest

Refer to the documentation of the methods listed above for more information.

This property is not available at design time.

Data Type

String