Package version:

Interface LeaseContainerRequest

Lease Container request schema.

interface LeaseContainerRequest {
    action: string;
    breakPeriod?: number;
    leaseDuration?: number;
    leaseId?: string;
    proposedLeaseId?: string;
}

Properties

action: string

Specifies the lease action. Can be one of the available actions.

breakPeriod?: number

Optional. For a break action, proposed duration the lease should continue before it is broken, in seconds, between 0 and 60.

leaseDuration?: number

Required for acquire. Specifies the duration of the lease, in seconds, or negative one (-1) for a lease that never expires.

leaseId?: string

Identifies the lease. Can be specified in any valid GUID string format.

proposedLeaseId?: string

Optional for acquire, required for change. Proposed lease ID, in a GUID string format.