BlobLeaseClient class

  • Referenz
Paket:
@azure/storage-blob

Ein Client, der Leases für einen ContainerClient oder einen BlobClient verwaltet.

Konstruktoren

BlobLeaseClient(BlobClient | ContainerClient, 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 sie. Die Sperrdauer kann 15 bis 60 Sekunden betragen oder unendlich sein.

Anzeigen https://docs.microsoft.com/en-us/rest/api/storageservices/lease-container und Anzeigen https://docs.microsoft.com/en-us/rest/api/storageservices/lease-blob
breakLease(number, LeaseOperationOptions)

Um die Lease zu beenden, stellen Sie jedoch sicher, dass ein anderer Client erst dann eine neue Lease erwerben kann, wenn der aktuelle Leasezeitraum abgelaufen ist.

Anzeigen https://docs.microsoft.com/en-us/rest/api/storageservices/lease-container und Anzeigen https://docs.microsoft.com/en-us/rest/api/storageservices/lease-blob
changeLease(string, LeaseOperationOptions)

So ändern Sie die ID der Lease.

Anzeigen https://docs.microsoft.com/en-us/rest/api/storageservices/lease-container und Anzeigen https://docs.microsoft.com/en-us/rest/api/storageservices/lease-blob
releaseLease(LeaseOperationOptions)

Freigeben der Lease, wenn sie nicht mehr benötigt wird, damit ein anderer Client sofort eine Lease für den Container oder das Blob erwerben kann.

Anzeigen https://docs.microsoft.com/en-us/rest/api/storageservices/lease-container und Anzeigen https://docs.microsoft.com/en-us/rest/api/storageservices/lease-blob
renewLease(LeaseOperationOptions)

So verlängern Sie die Lease.

Anzeigen https://docs.microsoft.com/en-us/rest/api/storageservices/lease-container und Anzeigen https://docs.microsoft.com/en-us/rest/api/storageservices/lease-blob

Details zum Konstruktor

BlobLeaseClient(BlobClient | ContainerClient, string)

Erstellt eine Instanz von BlobLeaseClient.

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

Parameter

client

BlobClient | ContainerClient

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 sie. Die Sperrdauer kann 15 bis 60 Sekunden betragen oder unendlich sein.

Anzeigen https://docs.microsoft.com/en-us/rest/api/storageservices/lease-container und Anzeigen https://docs.microsoft.com/en-us/rest/api/storageservices/lease-blob

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

Parameter

duration

number

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

options
LeaseOperationOptions

Option zum Konfigurieren von Leaseverwaltungsvorgängen.

Gibt zurück

Promise<LeaseOperationResponse>

Antwortdaten für den Leasevorgang zum Abrufen.

breakLease(number, LeaseOperationOptions)

Um die Lease zu beenden, stellen Sie jedoch sicher, dass ein anderer Client erst dann eine neue Lease erwerben kann, wenn der aktuelle Leasezeitraum abgelaufen ist.

Anzeigen https://docs.microsoft.com/en-us/rest/api/storageservices/lease-container und Anzeigen https://docs.microsoft.com/en-us/rest/api/storageservices/lease-blob

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

Parameter

breakPeriod

number

Pausenzeitraum

options
LeaseOperationOptions

Optionale Optionen zum Konfigurieren von Leaseverwaltungsvorgängen.

Gibt zurück

Promise<LeaseOperationResponse>

Antwortdaten für Unterbrechungsleasingvorgänge.

changeLease(string, LeaseOperationOptions)

So ändern Sie die ID der Lease.

Anzeigen https://docs.microsoft.com/en-us/rest/api/storageservices/lease-container und Anzeigen https://docs.microsoft.com/en-us/rest/api/storageservices/lease-blob

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

Parameter

proposedLeaseId

string

die vorgeschlagene neue Lease-ID.

options
LeaseOperationOptions

Option zum Konfigurieren von Leaseverwaltungsvorgängen.

Gibt zurück

Promise<LeaseOperationResponse>

Antwortdaten für Change Lease-Vorgänge.

releaseLease(LeaseOperationOptions)

Freigeben der Lease, wenn sie nicht mehr benötigt wird, damit ein anderer Client sofort eine Lease für den Container oder das Blob erwerben kann.

Anzeigen https://docs.microsoft.com/en-us/rest/api/storageservices/lease-container und Anzeigen https://docs.microsoft.com/en-us/rest/api/storageservices/lease-blob

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

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.

Anzeigen https://docs.microsoft.com/en-us/rest/api/storageservices/lease-container und Anzeigen https://docs.microsoft.com/en-us/rest/api/storageservices/lease-blob

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

Parameter

options
LeaseOperationOptions

Optionale Option zum Konfigurieren von Leaseverwaltungsvorgängen.

Gibt zurück

Promise<Lease>

Antwortdaten für den Lease-Verlängerungsvorgang.