Share via

DataLakeLeaseClient class

  • Reference
Package:
@azure/storage-file-datalake

Constructors

DataLakeLeaseClient(BlobLeaseClient)

Properties

leaseId
url

Methods

acquireLease(number, LeaseOperationOptions)
breakLease(number, LeaseOperationOptions)
changeLease(string, LeaseOperationOptions)
releaseLease(LeaseOperationOptions)
renewLease(LeaseOperationOptions)

Constructor Details

DataLakeLeaseClient(BlobLeaseClient) 

new DataLakeLeaseClient(client: BlobLeaseClient)

Parameters

client
BlobLeaseClient

Property Details

leaseId 

string leaseId

Property Value

string

url 

string url

Property Value

string

Method Details

acquireLease(number, LeaseOperationOptions) 

function acquireLease(duration: number, options?: LeaseOperationOptions): Promise<LeaseOperationResponse>

Parameters

duration

number

options
LeaseOperationOptions

Returns

Promise<LeaseOperationResponse>

breakLease(number, LeaseOperationOptions) 

function breakLease(breakPeriod: number, options?: LeaseOperationOptions): Promise<LeaseOperationResponse>

Parameters

breakPeriod

number

options
LeaseOperationOptions

Returns

Promise<LeaseOperationResponse>

changeLease(string, LeaseOperationOptions) 

function changeLease(proposedLeaseId: string, options?: LeaseOperationOptions): Promise<LeaseOperationResponse>

Parameters

proposedLeaseId

string

options
LeaseOperationOptions

Returns

Promise<LeaseOperationResponse>

releaseLease(LeaseOperationOptions) 

function releaseLease(options?: LeaseOperationOptions): Promise<LeaseOperationResponse>

Parameters

options
LeaseOperationOptions

Returns

Promise<LeaseOperationResponse>

renewLease(LeaseOperationOptions) 

function renewLease(options?: LeaseOperationOptions): Promise<Lease>

Parameters

options
LeaseOperationOptions

Returns

Promise<Lease>