BlobLeaseClient class

  • Referenz
Paket:
@azure/storage-blob

Ein Client, der Leases für ein <xref:ContainerClient> oder verwaltet <xref:BlobClient>.

Konstruktoren

BlobLeaseClient(ContainerClient | BlobClient, string)

Erstellt eine Instanz von BlobLeaseClient.

Eigenschaften

leaseId

Ruft die Lease-ID ab.
url

Ruft die URL ab.

Methoden

acquireLease(number, LeaseOperationOptions)

Richtet eine Sperre für einen Container für Löschvorgänge oder für ein Blob für Schreib- und Löschvorgänge ein und verwaltet diese. Die Sperrdauer kann 15 bis 60 Sekunden betragen oder unendlich sein.
breakLease(number, LeaseOperationOptions)

Um die Lease zu beenden, aber sicherstellen, dass ein anderer Client keine neue Lease erwerben kann, bis der aktuelle Leasezeitraum abgelaufen ist.
changeLease(string, LeaseOperationOptions)

So ändern Sie die ID der Lease.
releaseLease(LeaseOperationOptions)

So geben Sie die Lease frei, wenn sie nicht mehr benötigt wird, damit ein anderer Client sofort eine Lease für den Container oder das Blob erwerben kann.
renewLease(LeaseOperationOptions)

So verlängern Sie die Lease.

Details zum Konstruktor

BlobLeaseClient(ContainerClient | BlobClient, string)

Erstellt eine Instanz von BlobLeaseClient.

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

Parameter

client

ContainerClient | BlobClient

Der Client, der den Leasevorgang anfordert.

leaseId

string

Anfängliche vorgeschlagene Lease-ID.

Details zur Eigenschaft

leaseId

Ruft die Lease-ID ab.

string leaseId

Eigenschaftswert

string

url

Ruft die URL ab.

string url

Eigenschaftswert

string

Details zur Methode

acquireLease(number, LeaseOperationOptions)

Richtet eine Sperre für einen Container für Löschvorgänge oder für ein Blob für Schreib- und Löschvorgänge ein und verwaltet diese. Die Sperrdauer kann 15 bis 60 Sekunden betragen oder unendlich sein.

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

Parameter

duration

number

Muss zwischen 15 und 60 Sekunden oder unendlich sein (-1)

options
LeaseOperationOptions

Option zum Konfigurieren von Leaseverwaltungsvorgängen.

Gibt zurück

Promise<LeaseOperationResponse>

Antwortdaten für den Leasevorgang abrufen.

breakLease(number, LeaseOperationOptions)

Um die Lease zu beenden, aber sicherstellen, dass ein anderer Client keine neue Lease erwerben kann, bis der aktuelle Leasezeitraum abgelaufen ist.

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

Parameter

breakPeriod

number

Pausenzeit

options
LeaseOperationOptions

Optionale Optionen zum Konfigurieren von Leaseverwaltungsvorgängen.

Gibt zurück

Promise<LeaseOperationResponse>

Antwortdaten für den Unterbrechungsleasingvorgang.

changeLease(string, LeaseOperationOptions)

So ändern Sie die ID der Lease.

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

Parameter

proposedLeaseId

string

die vorgeschlagene neue Lease-ID.

options
LeaseOperationOptions

Option zum Konfigurieren von Leaseverwaltungsvorgängen.

Gibt zurück

Promise<LeaseOperationResponse>

Antwortdaten für den Änderungsleasingvorgang.

releaseLease(LeaseOperationOptions)

So geben Sie die Lease frei, wenn sie nicht mehr benötigt wird, damit ein anderer Client sofort eine Lease für den Container oder das Blob erwerben kann.

function releaseLease(options?: LeaseOperationOptions)

Parameter

options
LeaseOperationOptions

Option zum Konfigurieren von Leaseverwaltungsvorgängen.

Gibt zurück

Promise<LeaseOperationResponse>

Antwortdaten für den Releaseleasingvorgang.

renewLease(LeaseOperationOptions)

So verlängern Sie die Lease.

function renewLease(options?: LeaseOperationOptions)

Parameter

options
LeaseOperationOptions

Optionale Option zum Konfigurieren von Leaseverwaltungsvorgängen.

Gibt zurück

Promise<Lease>

Antwortdaten für den Lease-Verlängerungsvorgang.