BlobLeaseClient class

Balíček:

@azure/storage-blob

Klient, který spravuje zapůjčení pro <xref:ContainerClient> nebo <xref:BlobClient>.

Konstruktory

BlobLeaseClient(ContainerClient | BlobClient, string)

Vytvoří instanci BlobLeaseClient.

Vlastnosti

leaseId	Získá ID zapůjčení.
url	Získá adresu URL.

Metody

acquireLease(number, LeaseOperationOptions)	Vytvoří a spravuje zámek kontejneru pro operace odstranění nebo objekt blob pro operace zápisu a odstranění. Doba trvání zámku může být 15 až 60 sekund nebo může být nekonečná.
breakLease(number, LeaseOperationOptions)	Chcete-li ukončit zapůjčení, ale zajistit, aby jiný klient nemohl získat nové zapůjčení, dokud nevypršela platnost aktuálního období zapůjčení.
changeLease(string, LeaseOperationOptions)	Změna ID zapůjčení
releaseLease(LeaseOperationOptions)	Pokud už zapůjčení nepotřebujete, aby mohl jiný klient okamžitě získat zapůjčení proti kontejneru nebo objektu blob.
renewLease(LeaseOperationOptions)	Prodloužení zapůjčení

Podrobnosti konstruktoru

BlobLeaseClient(ContainerClient | BlobClient, string)

Vytvoří instanci BlobLeaseClient.

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

Parametry

client

ContainerClient | BlobClient

Klient pro provedení žádostí o operaci zapůjčení.

leaseId

string

Počáteční navrhované ID zapůjčení

Podrobnosti vlastnosti

leaseId

Získá ID zapůjčení.

string leaseId

Hodnota vlastnosti

string

url

Získá adresu URL.

string url

Hodnota vlastnosti

string

Podrobnosti metody

acquireLease(number, LeaseOperationOptions)

Vytvoří a spravuje zámek kontejneru pro operace odstranění nebo objekt blob pro operace zápisu a odstranění. Doba trvání zámku může být 15 až 60 sekund nebo může být nekonečná.

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

Parametry

duration

number

Musí být v rozmezí 15 až 60 sekund nebo nekonečné (-1)

options

LeaseOperationOptions

konfigurace operací správy zapůjčení

Návraty

Promise<LeaseOperationResponse>

Data odpovědí pro získání operace zapůjčení

breakLease(number, LeaseOperationOptions)

Chcete-li ukončit zapůjčení, ale zajistit, aby jiný klient nemohl získat nové zapůjčení, dokud nevypršela platnost aktuálního období zapůjčení.

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

Parametry

breakPeriod

number

Období přerušení

options

LeaseOperationOptions

Volitelné možnosti konfigurace operací správy zapůjčení

Návraty

Promise<LeaseOperationResponse>

Data odpovědi pro operaci přerušení zapůjčení

changeLease(string, LeaseOperationOptions)

Změna ID zapůjčení

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

Parametry

proposedLeaseId

string

navrhované nové ID zapůjčení.

options

LeaseOperationOptions

konfigurace operací správy zapůjčení

Návraty

Promise<LeaseOperationResponse>

Data odpovědi na operaci zapůjčení změn

releaseLease(LeaseOperationOptions)

Pokud už zapůjčení nepotřebujete, aby mohl jiný klient okamžitě získat zapůjčení proti kontejneru nebo objektu blob.

function releaseLease(options?: LeaseOperationOptions)

Parametry

options

LeaseOperationOptions

konfigurace operací správy zapůjčení

Návraty

Promise<LeaseOperationResponse>

Data odpovědi na operaci zapůjčení uvolnění.

renewLease(LeaseOperationOptions)

Prodloužení zapůjčení

function renewLease(options?: LeaseOperationOptions)

Parametry

options

LeaseOperationOptions

Volitelná možnost konfigurace operací správy zapůjčení

Návraty

Promise<Lease>

Data odpovědi na operaci prodloužení zapůjčení