ShareLeaseClient class
Client che gestisce i lease per un ShareFileClient o ShareClient.
Vedere https://learn.microsoft.com/rest/api/storageservices/lease-file e Vedere https://learn.microsoft.com/rest/api/storageservices/lease-share
Costruttori
| Share |
Crea un'istanza di ShareLeaseClient. |
Metodi
| acquire |
Stabilisce e gestisce un blocco su un file, una condivisione o uno snapshot di condivisione per operazioni di scrittura ed eliminazione. |
| break |
Per forzare la fine del lease. |
| change |
Per modificare l'ID di un lease esistente. |
| release |
Per liberare il lease se non è più necessario, in modo che un altro client possa acquisire immediatamente un lease. |
| renew |
Per rinnovare il lease. Disponibile solo per il 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 leasedata dopo la scadenza del lease. Quando si rinnova un lease, il clock della durata del lease viene reimpostato. |
Dettagli costruttore
ShareLeaseClient(ShareClient | ShareFileClient, string)
Crea un'istanza di ShareLeaseClient.
new ShareLeaseClient(client: ShareClient | ShareFileClient, leaseId?: string)Parametri
- client
Client per effettuare le richieste dell'operazione di lease.
- leaseId
-
string
ID lease proposto iniziale.
Dettagli proprietà
leaseId
Ottiene l'ID lease.
string leaseIdValore della proprietà
string
url
Ottiene l'URL.
string urlValore della proprietà
string
Dettagli metodo
acquireLease(number, LeaseOperationOptions)
Stabilisce e gestisce un blocco su 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'operazione di acquisizione del 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 interruzione del lease.
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 rilascio lease.
renewLease(LeaseOperationOptions)
Per rinnovare il lease. Disponibile solo per il 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 leasedata dopo la scadenza del lease. Quando si rinnova un lease, il clock della durata del lease viene reimpostato.
function renewLease(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 rinnovo del lease.