ShareLeaseClient class

Pacote:

@azure/storage-file-share

Um cliente que gerencia concessões para um ShareFileClient ou ShareClient.

Ver https://docs.microsoft.com/rest/api/storageservices/lease-file e Ver https://docs.microsoft.com/rest/api/storageservices/lease-share

Construtores

ShareLeaseClient(ShareFileClient, string)

Cria uma instância do ShareLeaseClient.

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 arquivo, compartilhamento ou instantâneo de compartilhamento para operações de gravação e exclusão.
breakLease(LeaseOperationOptions)	Para forçar o fim da concessão.
changeLease(string, LeaseOperationOptions)	Para alterar a ID de uma concessão existente.
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.
renewLease(LeaseOperationOptions)	Para renovar a concessão. Disponível apenas para concessão em compartilhamento ou instantâneo de compartilhamento. Observe que a concessão pode ser renovada mesmo que tenha expirado desde que a ação não tenha sido alugada novamente desde a expiração dessa concessão. Quando você renova uma concessão, o relógio de duração é redefinido.

Detalhes do construtor

ShareLeaseClient(ShareFileClient, string)

Cria uma instância do ShareLeaseClient.

new ShareLeaseClient(client: ShareFileClient, leaseId?: string)

Parâmetros

client

ShareFileClient

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 arquivo, compartilhamento ou instantâneo de compartilhamento para operações de gravação e exclusão.

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

Parâmetros

duration

number

Especifica a duração da concessão em segundos. Para o arquivo, o único valor permitido é -1 para uma concessão que nunca expira. Para compartilhamento, deve ser -1 ou entre 15 e 60.

options

LeaseOperationOptions

Opções para a operação de gerenciamento de concessão.

Retornos

Promise<LeaseOperationResponse>

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

breakLease(LeaseOperationOptions)

Para forçar o fim da concessão.

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

Parâmetros

options

LeaseOperationOptions

Opções para a operação 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 de uma concessão existente.

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

Parâmetros

proposedLeaseId

string

a nova ID de concessão proposta.

options

LeaseOperationOptions

Opções para a operação 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.

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

Parâmetros

options

LeaseOperationOptions

Opções para a operação 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. Disponível apenas para concessão em compartilhamento ou instantâneo de compartilhamento. Observe que a concessão pode ser renovada mesmo que tenha expirado desde que a ação não tenha sido alugada novamente desde a expiração dessa concessão. Quando você renova uma concessão, o relógio de duração é redefinido.

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

Parâmetros

options

LeaseOperationOptions

Opções para a operação de gerenciamento de concessão.

Retornos

Promise<LeaseOperationResponse>

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