BlobLeaseState Property

The lease state of the blob.

Syntax

 azureblob.getBlobLeaseState(index, [callback])

Possible Values

  0 (ablsAvailable), 
  1 (ablsLeased), 
  2 (ablsExpired), 
  3 (ablsBreaking), 
  4 (ablsBroken)

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 getBlobLeaseState([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 setBlobLeaseState([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 lease state of the blob.

This property reflects the lease state of the blob. Possible values are:


`ablsAvailable (0)`	The blob's lease is unlocked and can be acquired.
`ablsLeased (1)`	The blob's lease is locked.
`ablsExpired (2)`	The lease duration has expired.
`ablsBreaking (3)`	The lease has been broken, but will continue to be locked until the break period expires.
`ablsBroken (4)`	The lease has been broken, and the break period has expired.

This property is always ablsAvailable (0) when BlobIsLeased is false.

The index parameter specifies the index of the item in the array. The size of the array is controlled by the BlobCount property.

This property is read-only and not available at design time.

Data Type

Integer