ShareLeaseClient class

Pacchetto:

@azure/storage-file-share

Client che gestisce i lease per shareFileClient o ShareClient.

Vedere https://docs.microsoft.com/rest/api/storageservices/lease-file e vedere https://docs.microsoft.com/rest/api/storageservices/lease-share

Costruttori

ShareLeaseClient(ShareFileClient, string)

Crea un'istanza di ShareLeaseClient.

Proprietà

leaseId	Ottiene l'ID lease.
url	Ottiene l'URL.

Metodi

acquireLease(number, LeaseOperationOptions)	Stabilisce e gestisce un blocco in un file, una condivisione o uno snapshot di condivisione per operazioni di scrittura ed eliminazione.
breakLease(LeaseOperationOptions)	Per forzare la fine del lease.
changeLease(string, LeaseOperationOptions)	Per modificare l'ID di un lease esistente.
releaseLease(LeaseOperationOptions)	Per liberare il lease se non è più necessario in modo che un altro client possa acquisire immediatamente un lease.
renewLease(LeaseOperationOptions)	Per rinnovare il lease. Disponibile solo per lease in condivisione o snapshot di condivisione. Si noti che il lease può essere rinnovato anche se è scaduto fino a quando la condivisione non è stata nuovamente lease dopo la scadenza del lease. Quando si rinnova un lease, la durata del lease viene reimpostata.

Dettagli costruttore

ShareLeaseClient(ShareFileClient, string)

Crea un'istanza di ShareLeaseClient.

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

Parametri

client

ShareFileClient

Client per effettuare le richieste di operazione di lease.

leaseId

string

ID lease proposto iniziale.

Dettagli proprietà

leaseId

Ottiene l'ID lease.

string leaseId

Valore della proprietà

string

url

Ottiene l'URL.

string url

Valore della proprietà

string

Dettagli metodo

acquireLease(number, LeaseOperationOptions)

Stabilisce e gestisce un blocco in un file, una condivisione o uno snapshot di condivisione per operazioni di scrittura ed eliminazione.

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

Parametri

duration

number

Specifica la durata del lease in secondi. Per il file, l'unico valore consentito è -1 per un lease che non scade mai. Per la condivisione, deve essere -1 o compreso tra 15 e 60.

options

LeaseOperationOptions

Opzioni per l'operazione di gestione del lease.

Restituisce

Promise<LeaseOperationResponse>

Dati di risposta per l'acquisizione dell'operazione di lease.

breakLease(LeaseOperationOptions)

Per forzare la fine del lease.

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

Parametri

options

LeaseOperationOptions

Opzioni per l'operazione di gestione del lease.

Restituisce

Promise<LeaseOperationResponse>

Dati di risposta per l'operazione di lease di interruzione.

changeLease(string, LeaseOperationOptions)

Per modificare l'ID di un lease esistente.

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

Parametri

proposedLeaseId

string

il nuovo ID lease proposto.

options

LeaseOperationOptions

Opzioni per l'operazione di gestione del lease.

Restituisce

Promise<LeaseOperationResponse>

Dati di risposta per l'operazione di lease delle modifiche.

releaseLease(LeaseOperationOptions)

Per liberare il lease se non è più necessario in modo che un altro client possa acquisire immediatamente un lease.

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

Parametri

options

LeaseOperationOptions

Opzioni per l'operazione di gestione del lease.

Restituisce

Promise<LeaseOperationResponse>

Dati di risposta per l'operazione di lease di rilascio.

renewLease(LeaseOperationOptions)

Per rinnovare il lease. Disponibile solo per lease in condivisione o snapshot di condivisione. Si noti che il lease può essere rinnovato anche se è scaduto fino a quando la condivisione non è stata nuovamente lease dopo la scadenza del lease. Quando si rinnova un lease, la durata del lease viene reimpostata.

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

Parametri

options

LeaseOperationOptions

Opzioni per l'operazione di gestione del lease.

Restituisce

Promise<LeaseOperationResponse>

Dati di risposta per rinnovare l'operazione di lease.