Partilhar via

BlobLeaseClient class

  • Referência
Pacote:
@azure/storage-blob

Um cliente que gere concessões para um ContainerClient ou um BlobClient.

Construtores

BlobLeaseClient(BlobClient | ContainerClient, string)

Cria uma instância de BlobLeaseClient.

Propriedades

leaseId

Obtém o ID da concessão.
url

Obtém o URL.

Métodos

acquireLease(number, LeaseOperationOptions)

Estabelece e gere um bloqueio num contentor para operações de eliminação ou num blob para operações de escrita e eliminação. A duração do bloqueio pode ser de 15 a 60 segundos ou pode ser infinita.

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

Para terminar a concessão, mas certifique-se de que outro cliente não pode adquirir uma nova concessão até que o período de concessão atual expire.

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

Para alterar o ID da concessão.

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

Para libertar a concessão, se já não for necessária, para que outro cliente possa adquirir imediatamente uma concessão no contentor ou no blob.

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

Para renovar a concessão.

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

Detalhes do Construtor

BlobLeaseClient(BlobClient | ContainerClient, string)

Cria uma instância de BlobLeaseClient.

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

Parâmetros

client

BlobClient | ContainerClient

O cliente para fazer os pedidos de operação de concessão.

leaseId

string

ID de concessão proposto inicial.

Detalhes de Propriedade

leaseId

Obtém o ID da concessão.

string leaseId

Valor de Propriedade

string

url

Obtém o URL.

string url

Valor de Propriedade

string

Detalhes de Método

acquireLease(number, LeaseOperationOptions)

Estabelece e gere um bloqueio num contentor para operações de eliminação ou num blob para operações de escrita e eliminação. A duração do bloqueio pode ser de 15 a 60 segundos ou pode ser infinita.

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

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

Parâmetros

duration

number

Tem de estar entre 15 a 60 segundos ou infinito (-1)

options
LeaseOperationOptions

para configurar operações de gestão de concessões.

Devoluções

Promise<LeaseOperationResponse>

Dados de resposta para a operação de aquisição de concessão.

breakLease(number, LeaseOperationOptions)

Para terminar a concessão, mas certifique-se de que outro cliente não pode adquirir uma nova concessão até que o período de concessão atual expire.

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

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

Parâmetros

breakPeriod

number

Período de interrupção

options
LeaseOperationOptions

Opções opcionais para configurar operações de gestão de concessões.

Devoluções

Promise<LeaseOperationResponse>

Dados de resposta para a operação de concessão de interrupção.

changeLease(string, LeaseOperationOptions)

Para alterar o ID da concessão.

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

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

Parâmetros

proposedLeaseId

string

o novo ID de concessão proposto.

options
LeaseOperationOptions

para configurar operações de gestão de concessões.

Devoluções

Promise<LeaseOperationResponse>

Dados de resposta para a operação de concessão de alterações.

releaseLease(LeaseOperationOptions)

Para libertar a concessão, se já não for necessária, para que outro cliente possa adquirir imediatamente uma concessão no contentor ou no blob.

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

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

Parâmetros

options
LeaseOperationOptions

para configurar operações de gestão de concessões.

Devoluções

Promise<LeaseOperationResponse>

Dados de resposta para a operação de concessão de versão.

renewLease(LeaseOperationOptions)

Para renovar a concessão.

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

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

Parâmetros

options
LeaseOperationOptions

Opção opcional para configurar operações de gestão de concessões.

Devoluções

Promise<Lease>

Dados de resposta para a operação de renovação da concessão.