ContainerHasLegalHold Property

Whether there are any legal holds on the container.

Syntax

 azureblob.getContainerHasLegalHold(index, [callback])

Default Value

FALSE

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 getContainerHasLegalHold([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 setContainerHasLegalHold([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

Whether there are any legal holds on the container.

This property indicates whether there are any legal holds on the container.

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

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

Data Type

Boolean