BlobLeaseClient class

Pacote:

@azure/storage-blob

Um cliente que gere as concessões de um <xref:ContainerClient> ou um <xref:BlobClient>.

Construtores

BlobLeaseClient(ContainerClient | BlobClient, 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.
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.
changeLease(string, LeaseOperationOptions)	Para alterar o ID da concessão.
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.
renewLease(LeaseOperationOptions)	Para renovar a concessão.

Detalhes do Construtor

BlobLeaseClient(ContainerClient | BlobClient, string)

Cria uma instância de BlobLeaseClient.

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

Parâmetros

client

ContainerClient | BlobClient

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.

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

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.

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

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.

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

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.

function releaseLease(options?: LeaseOperationOptions)

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.

function renewLease(options?: LeaseOperationOptions)

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.