BlobLeaseClient class

Pacchetto:

@azure/storage-blob

Client che gestisce i lease per un <xref:ContainerClient> oggetto o .<xref:BlobClient>

Costruttori

BlobLeaseClient(ContainerClient | BlobClient, string)

Crea un'istanza di BlobLeaseClient.

Proprietà

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

Metodi

acquireLease(number, LeaseOperationOptions)	Stabilisce e gestisce un blocco in un contenitore per le operazioni di eliminazione o in un BLOB per le operazioni di scrittura ed eliminazione. La durata del blocco può variare da 15 a 60 secondi o può essere infinita.
breakLease(number, LeaseOperationOptions)	Per terminare il lease, ma assicurarsi che un altro client non possa acquisire un nuovo lease fino alla scadenza del periodo di lease corrente.
changeLease(string, LeaseOperationOptions)	Per modificare l'ID del lease.
releaseLease(LeaseOperationOptions)	Per liberare il lease se non è più necessario, in modo che un altro client possa acquisire immediatamente un lease sul contenitore o sul BLOB.
renewLease(LeaseOperationOptions)	Per rinnovare il lease.

Dettagli costruttore

BlobLeaseClient(ContainerClient | BlobClient, string)

Crea un'istanza di BlobLeaseClient.

new BlobLeaseClient(client: ContainerClient | BlobClient, leaseId?: string)

Parametri

client

ContainerClient | BlobClient

Client per effettuare le richieste dell'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 contenitore per le operazioni di eliminazione o in un BLOB per le operazioni di scrittura ed eliminazione. La durata del blocco può variare da 15 a 60 secondi o può essere infinita.

function acquireLease(duration: number, options?: LeaseOperationOptions)

Parametri

duration

number

Deve essere compreso tra 15 e 60 secondi o infinito (-1)

options

LeaseOperationOptions

opzione per configurare le operazioni di gestione del lease.

Restituisce

Promise<LeaseOperationResponse>

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

breakLease(number, LeaseOperationOptions)

Per terminare il lease, ma assicurarsi che un altro client non possa acquisire un nuovo lease fino alla scadenza del periodo di lease corrente.

function breakLease(breakPeriod: number, options?: LeaseOperationOptions)

Parametri

breakPeriod

number

Periodo di interruzione

options

LeaseOperationOptions

Opzioni facoltative per configurare le operazioni di gestione del lease.

Restituisce

Promise<LeaseOperationResponse>

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

changeLease(string, LeaseOperationOptions)

Per modificare l'ID del lease.

function changeLease(proposedLeaseId: string, options?: LeaseOperationOptions)

Parametri

proposedLeaseId

string

il nuovo ID lease proposto.

options

LeaseOperationOptions

opzione per configurare le operazioni 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 sul contenitore o sul BLOB.

function releaseLease(options?: LeaseOperationOptions)

Parametri

options

LeaseOperationOptions

opzione per configurare le operazioni di gestione del lease.

Restituisce

Promise<LeaseOperationResponse>

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

renewLease(LeaseOperationOptions)

Per rinnovare il lease.

function renewLease(options?: LeaseOperationOptions)

Parametri

options

LeaseOperationOptions

Opzione facoltativa per configurare le operazioni di gestione del lease.

Restituisce

Promise<Lease>

Dati di risposta per l'operazione di rinnovo del lease.