Udostępnij za pośrednictwem

BlobLeaseClient class

  • Odwołanie
Pakiet:
@azure/storage-blob

Klient zarządzający dzierżawami ContainerClient lub BlobClient.

Konstruktory

BlobLeaseClient(BlobClient | ContainerClient, 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 w 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.

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

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

Aby zmienić identyfikator dzierżawy.

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

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

Aby odnowić dzierżawę.

Zobacz https://docs.microsoft.com/en-us/rest/api/storageservices/lease-container i Zobacz https://docs.microsoft.com/en-us/rest/api/storageservices/lease-blob

Szczegóły konstruktora

BlobLeaseClient(BlobClient | ContainerClient, string)

Tworzy wystąpienie obiektu BlobLeaseClient.

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

Parametry

client

BlobClient | ContainerClient

Klient, który 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 w 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.

Zobacz https://docs.microsoft.com/en-us/rest/api/storageservices/lease-container i Zobacz https://docs.microsoft.com/en-us/rest/api/storageservices/lease-blob

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

Parametry

duration

number

Musi należeć od 15 do 60 sekund lub nieskończonych (-1)

options
LeaseOperationOptions

opcja konfigurowania operacji zarządzania dzierżawami.

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.

Zobacz https://docs.microsoft.com/en-us/rest/api/storageservices/lease-container i Zobacz https://docs.microsoft.com/en-us/rest/api/storageservices/lease-blob

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

Parametry

breakPeriod

number

Okres przerwania

options
LeaseOperationOptions

Opcjonalne opcje konfigurowania operacji zarządzania dzierżawą.

Zwraca

Promise<LeaseOperationResponse>

Dane odpowiedzi dotyczące operacji przerwania dzierżawy.

changeLease(string, LeaseOperationOptions)

Aby zmienić identyfikator dzierżawy.

Zobacz https://docs.microsoft.com/en-us/rest/api/storageservices/lease-container i Zobacz https://docs.microsoft.com/en-us/rest/api/storageservices/lease-blob

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

Parametry

proposedLeaseId

string

proponowany nowy identyfikator dzierżawy.

options
LeaseOperationOptions

opcja konfigurowania operacji zarządzania dzierżawami.

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.

Zobacz https://docs.microsoft.com/en-us/rest/api/storageservices/lease-container i Zobacz https://docs.microsoft.com/en-us/rest/api/storageservices/lease-blob

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

Parametry

options
LeaseOperationOptions

opcja konfigurowania operacji zarządzania dzierżawami.

Zwraca

Promise<LeaseOperationResponse>

Dane odpowiedzi dotyczące operacji dzierżawy wydania.

renewLease(LeaseOperationOptions)

Aby odnowić dzierżawę.

Zobacz https://docs.microsoft.com/en-us/rest/api/storageservices/lease-container i Zobacz https://docs.microsoft.com/en-us/rest/api/storageservices/lease-blob

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

Parametry

options
LeaseOperationOptions

Opcjonalna opcja konfigurowania operacji zarządzania dzierżawami.

Zwraca

Promise<Lease>

Dane odpowiedzi dotyczące operacji odnawiania dzierżawy.