LeaseShareRequest interface

Lease Share request schema.

Properties

action

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

breakPeriod

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

leaseDuration

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

leaseId

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

proposedLeaseId

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

Property Details

action

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

action: string

Property Value

string

breakPeriod

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

breakPeriod?: number

Property Value

number

leaseDuration

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

leaseDuration?: number

Property Value

number

leaseId

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

leaseId?: string

Property Value

string

proposedLeaseId

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

proposedLeaseId?: string

Property Value

string