Share via

BlobLeaseClient class

  • Referens
Paket:
@azure/storage-blob

En klient som hanterar lån för en ContainerClient eller en BlobClient.

Konstruktorer

BlobLeaseClient(BlobClient | ContainerClient, 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åsets varaktighet kan vara mellan 15 och 60 sekunder eller oändlig.

Se https://docs.microsoft.com/en-us/rest/api/storageservices/lease-container och se https://docs.microsoft.com/en-us/rest/api/storageservices/lease-blob
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.

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

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

Se https://docs.microsoft.com/en-us/rest/api/storageservices/lease-container och se https://docs.microsoft.com/en-us/rest/api/storageservices/lease-blob
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.

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

Förnya lånet.

Se https://docs.microsoft.com/en-us/rest/api/storageservices/lease-container och se https://docs.microsoft.com/en-us/rest/api/storageservices/lease-blob

Konstruktorinformation

BlobLeaseClient(BlobClient | ContainerClient, string)

Skapar en instans av BlobLeaseClient.

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

Parametrar

client

BlobClient | ContainerClient

Klienten som begär låneåtgärden.

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åsets varaktighet kan vara mellan 15 och 60 sekunder eller oändlig.

Se https://docs.microsoft.com/en-us/rest/api/storageservices/lease-container och se https://docs.microsoft.com/en-us/rest/api/storageservices/lease-blob

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

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.

Se https://docs.microsoft.com/en-us/rest/api/storageservices/lease-container och se https://docs.microsoft.com/en-us/rest/api/storageservices/lease-blob

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

Parametrar

breakPeriod

number

Brytperiod

options
LeaseOperationOptions

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

Returer

Promise<LeaseOperationResponse>

Svarsdata för avbrottslån.

changeLease(string, LeaseOperationOptions)

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

Se https://docs.microsoft.com/en-us/rest/api/storageservices/lease-container och se https://docs.microsoft.com/en-us/rest/api/storageservices/lease-blob

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

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ån.

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.

Se https://docs.microsoft.com/en-us/rest/api/storageservices/lease-container och se https://docs.microsoft.com/en-us/rest/api/storageservices/lease-blob

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

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.

Se https://docs.microsoft.com/en-us/rest/api/storageservices/lease-container och se https://docs.microsoft.com/en-us/rest/api/storageservices/lease-blob

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

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.