BlobLeaseClient class

Paket:

@azure/storage-blob

En klient som hanterar lån för en <xref:ContainerClient> eller en <xref:BlobClient>.

Konstruktorer

BlobLeaseClient(ContainerClient | BlobClient, string)

Skapar en instans av BlobLeaseClient.

Egenskaper

leaseId	Hämtar låne-ID:t.
url	Hämtar url:en.

Metoder

acquireLease(number, LeaseOperationOptions)	Upprättar och hanterar ett lås på en container för borttagningsåtgärder eller på en blob för skriv- och borttagningsåtgärder. Låsvaraktigheten kan vara mellan 15 och 60 sekunder, eller så kan den vara oändlig.
breakLease(number, LeaseOperationOptions)	Avsluta lånet men se till att en annan klient inte kan skaffa ett nytt lån förrän den aktuella låneperioden har upphört att gälla.
changeLease(string, LeaseOperationOptions)	Ändra ID:t för lånet.
releaseLease(LeaseOperationOptions)	Frigör lånet om det inte längre behövs så att en annan klient omedelbart kan skaffa ett lån mot containern eller bloben.
renewLease(LeaseOperationOptions)	Förnya lånet.

Konstruktorinformation

BlobLeaseClient(ContainerClient | BlobClient, string)

Skapar en instans av BlobLeaseClient.

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

Parametrar

client

ContainerClient | BlobClient

Klienten som ska göra låneåtgärdsbegäranden.

leaseId

string

Ursprungligt föreslaget låne-ID.

Egenskapsinformation

leaseId

Hämtar låne-ID:t.

string leaseId

Egenskapsvärde

string

url

Hämtar url:en.

string url

Egenskapsvärde

string

Metodinformation

acquireLease(number, LeaseOperationOptions)

Upprättar och hanterar ett lås på en container för borttagningsåtgärder eller på en blob för skriv- och borttagningsåtgärder. Låsvaraktigheten kan vara mellan 15 och 60 sekunder, eller så kan den vara oändlig.

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

Parametrar

duration

number

Måste vara mellan 15 och 60 sekunder eller oändligt (-1)

options

LeaseOperationOptions

alternativ för att konfigurera lånehanteringsåtgärder.

Returer

Promise<LeaseOperationResponse>

Svarsdata för att hämta låneåtgärd.

breakLease(number, LeaseOperationOptions)

Avsluta lånet men se till att en annan klient inte kan skaffa ett nytt lån förrän den aktuella låneperioden har upphört att gälla.

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

Parametrar

breakPeriod

number

Brytperiod

options

LeaseOperationOptions

Valfria alternativ för att konfigurera lånehanteringsåtgärder.

Returer

Promise<LeaseOperationResponse>

Svarsdata för break lease-åtgärd.

changeLease(string, LeaseOperationOptions)

Ändra ID:t för lånet.

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

Parametrar

proposedLeaseId

string

det föreslagna nya låne-ID:t.

options

LeaseOperationOptions

alternativ för att konfigurera lånehanteringsåtgärder.

Returer

Promise<LeaseOperationResponse>

Svarsdata för ändringslåneåtgärd.

releaseLease(LeaseOperationOptions)

Frigör lånet om det inte längre behövs så att en annan klient omedelbart kan skaffa ett lån mot containern eller bloben.

function releaseLease(options?: LeaseOperationOptions)

Parametrar

options

LeaseOperationOptions

alternativ för att konfigurera lånehanteringsåtgärder.

Returer

Promise<LeaseOperationResponse>

Svarsdata för versionslåneåtgärd.

renewLease(LeaseOperationOptions)

Förnya lånet.

function renewLease(options?: LeaseOperationOptions)

Parametrar

options

LeaseOperationOptions

Valfritt alternativ för att konfigurera lånehanteringsåtgärder.

Returer

Promise<Lease>

Svarsdata för förnyelse av låneåtgärd.