IfMatch Property

Specifies the condition for which the operation should be performed.

Syntax

 azureblob.getIfMatch([callback])
 azureblob.setIfMatch( ifMatch, [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 getIfMatch([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 setIfMatch([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

The IfMatch property may be set to an ETag value when performing any of the operations listed below. If the ETag matches the current ETag of the object on which the action is performed it will succeed. Otherwise if the ETag value specified in this property does not match the ETag value of the object on the server the operation will fail. Since the ETag will be updated each time there is a change to the object on the server, this allows you to verify that no changes have occurred to the object since you stored the ETag value.

This property applies to the following methods:

Note, for CopyBlob, you may also set SourceIfMatch.

Data Type

String