containerLeaseState (property)
The lease state of the container.
Syntax
- (int)containerLeaseState:(int)containerIndex;
/* Possible Values */
ACLS_AVAILABLE(0),
ACLS_LEASED(1),
ACLS_EXPIRED(2),
ACLS_BREAKING(3),
ACLS_BROKEN(4)
public func containerLeaseState(containerIndex: Int32) throws -> AzureblobContainerLeaseStates
public enum AzureblobContainerLeaseStates : Int32 { case aclsAvailable = 0 case aclsLeased = 1 case aclsExpired = 2 case aclsBreaking = 3 case aclsBroken = 4 }
Default Value
0
Remarks
The lease state of the container.
This property reflects the lease state of the container. Possible values are:
| aclsAvailable (0) | The container's lease is unlocked and can be acquired. |
| aclsLeased (1) | The container's lease is locked. |
| aclsExpired (2) | The lease duration has expired. |
| aclsBreaking (3) | The lease has been broken, but will continue to be locked until the break period expires. |
| aclsBroken (4) | The lease has been broken, and the break period has expired. |
This property is always aclsAvailable (0) when ContainerIsLeased is false.
The ContainerIndex 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.