Class ShareLeaseClient

Package version

A client that manages leases for a ShareFileClient.

export

Hierarchy

ShareLeaseClient

Index

Constructors

constructor

Accessors

leaseId
url

Methods

Constructors

constructor

new ShareLeaseClient(client: ShareFileClient, leaseId?: undefined | string): ShareLeaseClient

- Defined in ShareFileClient.ts:2899
Creates an instance of ShareLeaseClient.

memberof

ShareLeaseClient

Parameters
- client: ShareFileClient
  
  The client to make the lease operation requests.
- Optional leaseId: undefined | string
  
  Initial proposed lease id.
Returns ShareLeaseClient

Accessors

leaseId

get leaseId(): string

- Defined in ShareFileClient.ts:2886
Gets the lease Id.

readonly

memberof

ShareLeaseClient

Returns string

url

get url(): string

- Defined in ShareFileClient.ts:2897
Gets the url.

readonly

memberof

ShareLeaseClient

Returns string

Methods

acquireLease

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

- Defined in ShareFileClient.ts:2931
The Lease File operation establishes and manages a lock on a file for write and delete operations.

memberof

ShareLeaseClient

Parameters
- Default value duration: number = -1
  
  Specifies the duration of lease. The only allowed value is -1, for a lease that never expires.
- Default value options: LeaseOperationOptions = {}
Returns Promise<LeaseOperationResponse>

Response data for acquire lease operation.

breakLease

breakLease(options?: LeaseOperationOptions): Promise<LeaseOperationResponse>

- Defined in ShareFileClient.ts:3028
To force end the lease.

memberof

ShareLeaseClient

Parameters
- Default value options: LeaseOperationOptions = {}
Returns Promise<LeaseOperationResponse>

Response data for break lease operation.

changeLease

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

- Defined in ShareFileClient.ts:2965
To change the ID of an existing lease.

memberof

ShareLeaseClient

Parameters
- proposedLeaseId: string
  
  the proposed new lease Id.
- Default value options: LeaseOperationOptions = {}
Returns Promise<LeaseOperationResponse>

Response data for change lease operation.

releaseLease

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

- Defined in ShareFileClient.ts:3000
To free the lease if it is no longer needed so that another client may immediately acquire a lease against the file.

memberof

ShareLeaseClient

Parameters
- Default value options: LeaseOperationOptions = {}
Returns Promise<LeaseOperationResponse>

Response data for release lease operation.

Generated using TypeDoc