BlobLeaseClient class

Pakiet:

@azure/storage-blob

Klient, który zarządza dzierżawami dla obiektu <xref:ContainerClient> lub .<xref:BlobClient>

Konstruktory

BlobLeaseClient(ContainerClient | BlobClient, string)

Tworzy wystąpienie obiektu BlobLeaseClient.

Właściwości

leaseId	Pobiera identyfikator dzierżawy.
url	Pobiera adres URL.

Metody

acquireLease(number, LeaseOperationOptions)	Ustanawia blokadę kontenera na potrzeby operacji usuwania lub na obiekcie blob na potrzeby operacji zapisu i usuwania oraz zarządza nim. Czas trwania blokady może wynosić od 15 do 60 sekund lub może być nieskończony.
breakLease(number, LeaseOperationOptions)	Aby zakończyć dzierżawę, ale upewnij się, że inny klient nie może uzyskać nowej dzierżawy do czasu wygaśnięcia bieżącego okresu dzierżawy.
changeLease(string, LeaseOperationOptions)	Aby zmienić identyfikator dzierżawy.
releaseLease(LeaseOperationOptions)	Aby zwolnić dzierżawę, jeśli nie jest już potrzebna, aby inny klient mógł natychmiast uzyskać dzierżawę względem kontenera lub obiektu blob.
renewLease(LeaseOperationOptions)	Aby odnowić dzierżawę.

Szczegóły konstruktora

BlobLeaseClient(ContainerClient | BlobClient, string)

Tworzy wystąpienie obiektu BlobLeaseClient.

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

Parametry

client

ContainerClient | BlobClient

Klient, aby wysyłać żądania operacji dzierżawy.

leaseId

string

Początkowy proponowany identyfikator dzierżawy.

Szczegóły właściwości

leaseId

Pobiera identyfikator dzierżawy.

string leaseId

Wartość właściwości

string

url

Pobiera adres URL.

string url

Wartość właściwości

string

Szczegóły metody

acquireLease(number, LeaseOperationOptions)

Ustanawia blokadę kontenera na potrzeby operacji usuwania lub na obiekcie blob na potrzeby operacji zapisu i usuwania oraz zarządza nim. Czas trwania blokady może wynosić od 15 do 60 sekund lub może być nieskończony.

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

Parametry

duration

number

Musi mieć od 15 do 60 sekund lub nieskończoność (-1)

options

LeaseOperationOptions

opcja konfigurowania operacji zarządzania dzierżawą.

Zwraca

Promise<LeaseOperationResponse>

Dane odpowiedzi dotyczące operacji pozyskiwania dzierżawy.

breakLease(number, LeaseOperationOptions)

Aby zakończyć dzierżawę, ale upewnij się, że inny klient nie może uzyskać nowej dzierżawy do czasu wygaśnięcia bieżącego okresu dzierżawy.

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

Parametry

breakPeriod

number

Okres przerwania

options

LeaseOperationOptions

Opcjonalne opcje konfigurowania operacji zarządzania dzierżawami.

Zwraca

Promise<LeaseOperationResponse>

Dane odpowiedzi dotyczące operacji przerwania dzierżawy.

changeLease(string, LeaseOperationOptions)

Aby zmienić identyfikator dzierżawy.

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

Parametry

proposedLeaseId

string

proponowany nowy identyfikator dzierżawy.

options

LeaseOperationOptions

opcja konfigurowania operacji zarządzania dzierżawą.

Zwraca

Promise<LeaseOperationResponse>

Dane odpowiedzi dotyczące operacji zmiany dzierżawy.

releaseLease(LeaseOperationOptions)

Aby zwolnić dzierżawę, jeśli nie jest już potrzebna, aby inny klient mógł natychmiast uzyskać dzierżawę względem kontenera lub obiektu blob.

function releaseLease(options?: LeaseOperationOptions)

Parametry

options

LeaseOperationOptions

opcja konfigurowania operacji zarządzania dzierżawą.

Zwraca

Promise<LeaseOperationResponse>

Dane odpowiedzi dotyczące operacji dzierżawy wydania.

renewLease(LeaseOperationOptions)

Aby odnowić dzierżawę.

function renewLease(options?: LeaseOperationOptions)

Parametry

options

LeaseOperationOptions

Opcjonalna opcja konfigurowania operacji zarządzania dzierżawami.

Zwraca

Promise<Lease>

Dane odpowiedzi dotyczące operacji odnawiania dzierżawy.