LeaseId Property

The unique Lease ID of a blob.

Syntax

 azureblob.getLeaseId([callback])
 azureblob.setLeaseId( leaseId, [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 getLeaseId([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 setLeaseId([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 contains the unique Lease ID of a blob and is populated after a successful LeaseBlob call.

When a lease is active on a blob, LeaseId must be set when you write to the blob using CreateBlob and when renewing or releasing the lease using LeaseBlob.

Optionally, you can set this property prior to a GetBlobMetadata call in which the operation will be performed only if both the blob's lease is currently active and the lease ID specified matches that of the blob. If either of these conditions fail, a 412 (Precondition Failed) error will be returned.

Data Type

String