BlobLeaseClient class

Pacote:

@azure/storage-blob

Um cliente que gerencia concessões para um <xref:ContainerClient> ou um <xref:BlobClient>.

Construtores

BlobLeaseClient(ContainerClient | BlobClient, string)

Cria uma instância de BlobLeaseClient.

Propriedades

leaseId	Obtém a ID de concessão.
url	Obtém a URL.

Métodos

acquireLease(number, LeaseOperationOptions)	Estabelece e gerencia um bloqueio em um contêiner para operações de exclusão ou em um blob para operações de gravação e exclusão. A duração do bloqueio pode ser de 15 a 60 segundos, ou pode ser infinita.
breakLease(number, LeaseOperationOptions)	Para encerrar a concessão, mas verifique se 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 a ID da concessão.
releaseLease(LeaseOperationOptions)	Para liberar a concessão se ela não for mais necessária para que outro cliente possa adquirir imediatamente uma concessão no contêiner 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 as solicitações de operação de concessão.

leaseId

string

ID de concessão proposta inicial.

Detalhes da propriedade

leaseId

Obtém a ID de concessão.

string leaseId

Valor da propriedade

string

url

Obtém a URL.

string url

Valor da propriedade

string

Detalhes do método

acquireLease(number, LeaseOperationOptions)

Estabelece e gerencia um bloqueio em um contêiner para operações de exclusão ou em um blob para operações de gravação e exclusã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

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

options

LeaseOperationOptions

opção para configurar operações de gerenciamento de concessão.

Retornos

Promise<LeaseOperationResponse>

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

breakLease(number, LeaseOperationOptions)

Para encerrar a concessão, mas verifique se 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 gerenciamento de concessão.

Retornos

Promise<LeaseOperationResponse>

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

changeLease(string, LeaseOperationOptions)

Para alterar a ID da concessão.

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

Parâmetros

proposedLeaseId

string

a nova ID de concessão proposta.

options

LeaseOperationOptions

opção para configurar operações de gerenciamento de concessão.

Retornos

Promise<LeaseOperationResponse>

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

releaseLease(LeaseOperationOptions)

Para liberar a concessão se ela não for mais necessária para que outro cliente possa adquirir imediatamente uma concessão no contêiner ou no blob.

function releaseLease(options?: LeaseOperationOptions)

Parâmetros

options

LeaseOperationOptions

opção para configurar operações de gerenciamento de concessão.

Retornos

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 gerenciamento de concessão.

Retornos

Promise<Lease>

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