BlobLeaseClient class

Pacote:

@azure/storage-blob

Um cliente que gere arrendamentos para 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 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 terminar a locação, mas garantir que outro cliente não possa adquirir uma nova locação até que o período de locação atual tenha expirado.
changeLease(string, LeaseOperationOptions)	Para alterar o ID da concessão.
releaseLease(LeaseOperationOptions)	Libertar o arrendamento se já não for necessário para que outro cliente possa adquirir imediatamente um arrendamento contra o contentor ou o blob.
renewLease(LeaseOperationOptions)	Renovar o contrato de arrendamento.

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 leasing.

leaseId

string

Proposta inicial de arrendamento id.

Detalhes de Propriedade

leaseId

Obtém o ID da concessão.

string leaseId

Valor de Propriedade

string

url

Obtém a url.

string url

Valor de Propriedade

string

Detalhes de 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 ser entre 15 a 60 segundos, ou infinito (-1)

options

LeaseOperationOptions

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

Devoluções

Promise<LeaseOperationResponse>

Dados de resposta para operação de arrendamento de aquisição.

breakLease(number, LeaseOperationOptions)

Para terminar a locação, mas garantir que outro cliente não possa adquirir uma nova locação até que o período de locação atual tenha expirado.

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

Parâmetros

breakPeriod

number

Período de pausa

options

LeaseOperationOptions

Opções opcionais para configurar operações de gerenciamento de locação.

Devoluções

Promise<LeaseOperationResponse>

Dados de resposta para operação de break lease.

changeLease(string, LeaseOperationOptions)

Para alterar o ID da concessão.

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

Parâmetros

proposedLeaseId

string

o novo contrato de arrendamento proposto Id.

options

LeaseOperationOptions

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

Devoluções

Promise<LeaseOperationResponse>

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

releaseLease(LeaseOperationOptions)

Libertar o arrendamento se já não for necessário para que outro cliente possa adquirir imediatamente um arrendamento contra o contentor ou o blob.

function releaseLease(options?: LeaseOperationOptions)

Parâmetros

options

LeaseOperationOptions

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

Devoluções

Promise<LeaseOperationResponse>

Dados de resposta para operação de leasing de liberação.

renewLease(LeaseOperationOptions)

Renovar o contrato de arrendamento.

function renewLease(options?: LeaseOperationOptions)

Parâmetros

options

LeaseOperationOptions

Opção opcional para configurar operações de gerenciamento de locação.

Devoluções

Promise<Lease>

Dados de resposta para operação de renovação de leasing.