BlobLeaseClient class

  • Reference
Balíček:
@azure/storage-blob

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

Konstruktory

BlobLeaseClient(BlobClient | ContainerClient, 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 v kontejneru pro operace odstranění nebo v objektu 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á.

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

Chcete-li ukončit zapůjčení, ale zajistit, aby jiný klient nemohl získat nové zapůjčení, dokud neuplyne aktuální doba zapůjčení.

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

Změna ID zapůjčení

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

Uvolnit zapůjčení, pokud už není potřeba, aby jiný klient mohl okamžitě získat zapůjčení kontejneru nebo objektu blob.

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

Prodloužení zapůjčení.

Zobrazit https://docs.microsoft.com/en-us/rest/api/storageservices/lease-container a zobrazit https://docs.microsoft.com/en-us/rest/api/storageservices/lease-blob

Podrobnosti konstruktoru

BlobLeaseClient(BlobClient | ContainerClient, string)

Vytvoří instanci BlobLeaseClient.

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

Parametry

client

BlobClient | ContainerClient

Klient, který má provést žá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 v kontejneru pro operace odstranění nebo v objektu 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á.

Zobrazit https://docs.microsoft.com/en-us/rest/api/storageservices/lease-container a zobrazit https://docs.microsoft.com/en-us/rest/api/storageservices/lease-blob

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

Parametry

duration

number

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

options
LeaseOperationOptions

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

Návraty

Promise<LeaseOperationResponse>

Data odpovědí na operaci získání 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 neuplyne aktuální doba zapůjčení.

Zobrazit https://docs.microsoft.com/en-us/rest/api/storageservices/lease-container a zobrazit https://docs.microsoft.com/en-us/rest/api/storageservices/lease-blob

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

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ědí na operaci přerušení zapůjčení.

changeLease(string, LeaseOperationOptions)

Změna ID zapůjčení

Zobrazit https://docs.microsoft.com/en-us/rest/api/storageservices/lease-container a zobrazit https://docs.microsoft.com/en-us/rest/api/storageservices/lease-blob

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

Parametry

proposedLeaseId

string

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

options
LeaseOperationOptions

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

Návraty

Promise<LeaseOperationResponse>

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

releaseLease(LeaseOperationOptions)

Uvolnit zapůjčení, pokud už není potřeba, aby jiný klient mohl okamžitě získat zapůjčení kontejneru nebo objektu blob.

Zobrazit https://docs.microsoft.com/en-us/rest/api/storageservices/lease-container a zobrazit https://docs.microsoft.com/en-us/rest/api/storageservices/lease-blob

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

Parametry

options
LeaseOperationOptions

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

Návraty

Promise<LeaseOperationResponse>

Data odpovědí na operaci zapůjčení verze.

renewLease(LeaseOperationOptions)

Prodloužení zapůjčení.

Zobrazit https://docs.microsoft.com/en-us/rest/api/storageservices/lease-container a zobrazit https://docs.microsoft.com/en-us/rest/api/storageservices/lease-blob

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

Parametry

options
LeaseOperationOptions

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

Návraty

Promise<Lease>

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