ShareLeaseClient class

Balíček:

@azure/storage-file-share

Klient, který spravuje zapůjčení pro ShareFileClient nebo ShareClient.

Viz https://learn.microsoft.com/rest/api/storageservices/lease-file a viz https://learn.microsoft.com/rest/api/storageservices/lease-share

Konstruktory

ShareLeaseClient(ShareClient | ShareFileClient, string)

Vytvoří instanci ShareLeaseClient.

Vlastnosti

leaseId	Získá ID zapůjčení.
url	Získá adresu URL.

Metody

acquireLease(number, LeaseOperationOptions)	Vytvoří a spravuje zámek u souboru, sdílené složky nebo snímku sdílené složky pro operace zápisu a odstranění.
breakLease(LeaseOperationOptions)	Vynucení ukončení zapůjčení
changeLease(string, LeaseOperationOptions)	Změna ID existujícího zapůjčení
releaseLease(LeaseOperationOptions)	Pokud už zapůjčení nepotřebujete, aby mohl zapůjčení okamžitě získat jiný klient.
renewLease(LeaseOperationOptions)	Prodloužení zapůjčení K dispozici pouze pro zapůjčení snímku sdílené složky nebo sdílené složky. Mějte na paměti, že zapůjčení může být obnoveno i v případě, že vypršela jeho platnost, pokud od vypršení platnosti tohoto zapůjčení nebyla sdílená složka znovu zapůjčena. Když prodloužíte zapůjčení, doba trvání zapůjčení se resetuje.

Podrobnosti konstruktoru

ShareLeaseClient(ShareClient | ShareFileClient, string)

Vytvoří instanci ShareLeaseClient.

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

Parametry

client

ShareClient | ShareFileClient

Klient pro provedení žádostí o operaci zapůjčení.

leaseId

string

Počáteční navrhované ID zapůjčení

Podrobnosti vlastnosti

leaseId

Získá ID zapůjčení.

string leaseId

Hodnota vlastnosti

string

url

Získá adresu URL.

string url

Hodnota vlastnosti

string

Podrobnosti metody

acquireLease(number, LeaseOperationOptions)

Vytvoří a spravuje zámek u souboru, sdílené složky nebo snímku sdílené složky pro operace zápisu a odstranění.

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

Parametry

duration

number

Určuje dobu zapůjčení v sekundách. U souboru je jediná povolená hodnota -1 pro zapůjčení, které nikdy nevyprší platnost. Pro sdílenou složku musí být -1 nebo mezi 15 a 60.

options

LeaseOperationOptions

Možnosti operace správy zapůjčení

Návraty

Promise<LeaseOperationResponse>

Data odpovědí pro získání operace zapůjčení

breakLease(LeaseOperationOptions)

Vynucení ukončení zapůjčení

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

Parametry

options

LeaseOperationOptions

Možnosti operace správy zapůjčení

Návraty

Promise<LeaseOperationResponse>

Data odpovědi pro operaci přerušení zapůjčení

changeLease(string, LeaseOperationOptions)

Změna ID existujícího zapůjčení

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

Parametry

proposedLeaseId

string

navrhované nové ID zapůjčení.

options

LeaseOperationOptions

Možnosti operace správy zapůjčení

Návraty

Promise<LeaseOperationResponse>

Data odpovědi na operaci zapůjčení změn

releaseLease(LeaseOperationOptions)

Pokud už zapůjčení nepotřebujete, aby mohl zapůjčení okamžitě získat jiný klient.

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

Parametry

options

LeaseOperationOptions

Možnosti operace správy zapůjčení

Návraty

Promise<LeaseOperationResponse>

Data odpovědi na operaci zapůjčení uvolnění.

renewLease(LeaseOperationOptions)

Prodloužení zapůjčení K dispozici pouze pro zapůjčení snímku sdílené složky nebo sdílené složky. Mějte na paměti, že zapůjčení může být obnoveno i v případě, že vypršela jeho platnost, pokud od vypršení platnosti tohoto zapůjčení nebyla sdílená složka znovu zapůjčena. Když prodloužíte zapůjčení, doba trvání zapůjčení se resetuje.

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

Parametry

options

LeaseOperationOptions

Možnosti operace správy zapůjčení

Návraty

Promise<LeaseOperationResponse>

Data odpovědi na operaci prodloužení zapůjčení