BlobLeaseClient class

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

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

Construtores

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

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 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 tenha expirado.

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

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

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

Deve estar entre 15 e 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 tenha expirado.

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

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

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çã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.

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

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.

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

Retornos

Promise<Lease>

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