Class BlobLeaseClient

Package version

Hierarchy

BlobLeaseClient

Index

Constructors

constructor

Accessors

leaseId
url

Methods

Constructors

constructor

new BlobLeaseClient(client: ContainerClient | BlobClient, leaseId: undefined | string): BlobLeaseClient

- Defined in Clients.ts:4784
Parameters
- client: ContainerClient | BlobClient
- Optional leaseId: undefined | string
Returns BlobLeaseClient

Accessors

leaseId

leaseId:

url

url:

Methods

acquireLease

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

- Defined in Clients.ts:4824
Parameters
- duration: number
- Default value options: LeaseOperationOptions = {}
Returns Promise<LeaseOperationResponse>

Response data for acquire lease operation.

breakLease

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

- Defined in Clients.ts:4965
Parameters
- breakPeriod: number
- Default value options: LeaseOperationOptions = {}
Returns Promise<LeaseOperationResponse>

Response data for break lease operation.

changeLease

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

- Defined in Clients.ts:4862
Parameters
- proposedLeaseId: string
- Default value options: LeaseOperationOptions = {}
Returns Promise<LeaseOperationResponse>

Response data for change lease operation.

releaseLease

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

- Defined in Clients.ts:4901
Parameters
- Default value options: LeaseOperationOptions = {}
Returns Promise<LeaseOperationResponse>

Response data for release lease operation.

renewLease

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

- Defined in Clients.ts:4933
Parameters
- Default value options: LeaseOperationOptions = {}
Returns Promise<Lease>

Response data for renew lease operation.

Generated using TypeDoc