ShareLeaseClient class

Paket:

@azure/storage-file-share

En klient som hanterar lån för en ShareFileClient- eller ShareClient.

Se https://learn.microsoft.com/rest/api/storageservices/lease-file och Se https://learn.microsoft.com/rest/api/storageservices/lease-share

Konstruktorer

ShareLeaseClient(ShareClient | ShareFileClient, string)

Skapar en instans av ShareLeaseClient.

Egenskaper

leaseId	Hämtar låne-ID:t.
url	Hämtar url:en.

Metoder

acquireLease(number, LeaseOperationOptions)	Upprättar och hanterar ett lås på en fil, resurs eller resursögonblicksbild för skriv- och borttagningsåtgärder.
breakLease(LeaseOperationOptions)	För att tvinga fram ett slut på lånet.
changeLease(string, LeaseOperationOptions)	Ändra ID:t för ett befintligt lån.
releaseLease(LeaseOperationOptions)	För att frigöra lånet om det inte längre behövs så att en annan klient omedelbart kan skaffa ett lån.
renewLease(LeaseOperationOptions)	Förnya lånet. Endast tillgängligt för lån på resurs- eller resursögonblicksbild. Observera att lånet kan förnyas även om det har upphört att gälla så länge som aktien inte har hyrts igen sedan lånet löpte ut. När du förnyar ett lån återställs lånetiden.

Konstruktorinformation

ShareLeaseClient(ShareClient | ShareFileClient, string)

Skapar en instans av ShareLeaseClient.

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

Parametrar

client

ShareClient | ShareFileClient

Klienten som ska göra låneåtgärdsbegäranden.

leaseId

string

Ursprungligt föreslaget låne-ID.

Egenskapsinformation

leaseId

Hämtar låne-ID:t.

string leaseId

Egenskapsvärde

string

url

Hämtar url:en.

string url

Egenskapsvärde

string

Metodinformation

acquireLease(number, LeaseOperationOptions)

Upprättar och hanterar ett lås på en fil, resurs eller resursögonblicksbild för skriv- och borttagningsåtgärder.

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

Parametrar

duration

number

Anger varaktigheten för lånet i sekunder. För filen är det enda tillåtna värdet -1 för ett lån som aldrig upphör att gälla. För resurs måste vara -1 eller mellan 15 och 60.

options

LeaseOperationOptions

Alternativ för lånehanteringsåtgärden.

Returer

Promise<LeaseOperationResponse>

Svarsdata för att hämta låneåtgärd.

breakLease(LeaseOperationOptions)

För att tvinga fram ett slut på lånet.

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

Parametrar

options

LeaseOperationOptions

Alternativ för lånehanteringsåtgärden.

Returer

Promise<LeaseOperationResponse>

Svarsdata för break lease-åtgärd.

changeLease(string, LeaseOperationOptions)

Ändra ID:t för ett befintligt lån.

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

Parametrar

proposedLeaseId

string

det föreslagna nya låne-ID:t.

options

LeaseOperationOptions

Alternativ för lånehanteringsåtgärden.

Returer

Promise<LeaseOperationResponse>

Svarsdata för ändringslåneåtgärd.

releaseLease(LeaseOperationOptions)

För att frigöra lånet om det inte längre behövs så att en annan klient omedelbart kan skaffa ett lån.

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

Parametrar

options

LeaseOperationOptions

Alternativ för lånehanteringsåtgärden.

Returer

Promise<LeaseOperationResponse>

Svarsdata för versionslåneåtgärd.

renewLease(LeaseOperationOptions)

Förnya lånet. Endast tillgängligt för lån på resurs- eller resursögonblicksbild. Observera att lånet kan förnyas även om det har upphört att gälla så länge som aktien inte har hyrts igen sedan lånet löpte ut. När du förnyar ett lån återställs lånetiden.

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

Parametrar

options

LeaseOperationOptions

Alternativ för lånehanteringsåtgärden.

Returer

Promise<LeaseOperationResponse>

Svarsdata för förnyelse av låneåtgärd.