ShareLeaseClient class

Csomag:

@azure/storage-file-share

Egy ShareFileClient vagy ShareClientbérleteit kezelő ügyfél.

Lásd: https://learn.microsoft.com/rest/api/storageservices/lease-file és lásd: https://learn.microsoft.com/rest/api/storageservices/lease-share

Konstruktorok

ShareLeaseClient(ShareClient | ShareFileClient, string)

Létrehozza a ShareLeaseClient egy példányát.

Tulajdonságok

leaseId	Lekéri a bérlet azonosítóját.
url	Lekéri az URL-címet.

Metódusok

acquireLease(number, LeaseOperationOptions)	Létrehozza és kezeli a fájl zárolását, megoszthatja vagy megoszthatja a pillanatképet írási és törlési műveletekhez.
breakLease(LeaseOperationOptions)	A bérlet megszüntetésének kényszerítése.
changeLease(string, LeaseOperationOptions)	Meglévő bérlet azonosítójának módosítása.
releaseLease(LeaseOperationOptions)	A bérlet felszabadítása, ha már nincs rá szükség, hogy egy másik ügyfél azonnal megszerezhesse a bérletet.
renewLease(LeaseOperationOptions)	A bérlet megújításához. Csak megosztási vagy megosztási pillanatképek bérletéhez érhető el. Vegye figyelembe, hogy a bérlet akkor is megújítható, ha lejárt, feltéve, hogy a részvényt a bérlet lejárta óta nem adták ki újra. Amikor megújít egy bérletet, a bérlet időtartama visszaáll.

Konstruktor adatai

ShareLeaseClient(ShareClient | ShareFileClient, string)

Létrehozza a ShareLeaseClient egy példányát.

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

Paraméterek

client

ShareClient | ShareFileClient

A bérletműveleti kérelmeket intéző ügyfél.

leaseId

string

Kezdeti javasolt bérletazonosító.

Tulajdonság adatai

leaseId

Lekéri a bérlet azonosítóját.

string leaseId

Tulajdonság értéke

string

url

Lekéri az URL-címet.

string url

Tulajdonság értéke

string

Metódus adatai

acquireLease(number, LeaseOperationOptions)

Létrehozza és kezeli a fájl zárolását, megoszthatja vagy megoszthatja a pillanatképet írási és törlési műveletekhez.

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

Paraméterek

duration

number

A bérlet időtartamát adja meg másodpercben. Fájl esetében az egyetlen engedélyezett érték -1 olyan bérlet esetén, amely soha nem jár le. Megosztás esetén -1 vagy 15–60 közöttinek kell lennie.

options

LeaseOperationOptions

A bérletkezelési művelet beállításai.

Válaszok

Promise<LeaseOperationResponse>

Válaszadatok a bérlet beszerzéséhez.

breakLease(LeaseOperationOptions)

A bérlet megszüntetésének kényszerítése.

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

Paraméterek

options

LeaseOperationOptions

A bérletkezelési művelet beállításai.

Válaszok

Promise<LeaseOperationResponse>

Válaszadatok a törésbérleti művelethez.

changeLease(string, LeaseOperationOptions)

Meglévő bérlet azonosítójának módosítása.

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

Paraméterek

proposedLeaseId

string

a javasolt új bérletazonosító.

options

LeaseOperationOptions

A bérletkezelési művelet beállításai.

Válaszok

Promise<LeaseOperationResponse>

Válaszadatok a változásbérleti művelethez.

releaseLease(LeaseOperationOptions)

A bérlet felszabadítása, ha már nincs rá szükség, hogy egy másik ügyfél azonnal megszerezhesse a bérletet.

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

Paraméterek

options

LeaseOperationOptions

A bérletkezelési művelet beállításai.

Válaszok

Promise<LeaseOperationResponse>

Válaszadatok a kiadásbérleti művelethez.

renewLease(LeaseOperationOptions)

A bérlet megújításához. Csak megosztási vagy megosztási pillanatképek bérletéhez érhető el. Vegye figyelembe, hogy a bérlet akkor is megújítható, ha lejárt, feltéve, hogy a részvényt a bérlet lejárta óta nem adták ki újra. Amikor megújít egy bérletet, a bérlet időtartama visszaáll.

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

Paraméterek

options

LeaseOperationOptions

A bérletkezelési művelet beállításai.

Válaszok

Promise<LeaseOperationResponse>

Válaszadatok a megújítási bérlet műveletéhez.