ShareLeaseClient class

Pacote:

@azure/storage-file-share

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

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

Construtores

ShareLeaseClient(ShareClient | ShareFileClient, string)

Cria uma instância de ShareLeaseClient.

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 arquivo, compartilhamento ou compartilhamento de instantâneo para operações de gravação e exclusão.
breakLease(LeaseOperationOptions)	Para forçar o fim do contrato de arrendamento.
changeLease(string, LeaseOperationOptions)	Para alterar a ID de uma concessão existente.
releaseLease(LeaseOperationOptions)	Libertar o arrendamento caso já não seja necessário para que outro cliente possa adquirir imediatamente um contrato de arrendamento.
renewLease(LeaseOperationOptions)	Renovar o contrato de arrendamento. Disponível apenas para concessão em compartilhamento ou instantâneo de compartilhamento. Note-se que o contrato de arrendamento pode ser renovado mesmo que tenha expirado, desde que a quota não tenha sido novamente arrendada desde o termo desse contrato. Quando você renova uma locação, o relógio de duração da concessão é redefinido.

Detalhes do Construtor

ShareLeaseClient(ShareClient | ShareFileClient, string)

Cria uma instância de ShareLeaseClient.

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

Parâmetros

client

ShareClient | ShareFileClient

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 arquivo, compartilhamento ou compartilhamento de instantâneo 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 arquivo, o único valor permitido é -1 para uma concessão que nunca expira. Para a ação, deve ser -1 ou entre 15 a 60.

options

LeaseOperationOptions

Opções para a operação de gestão de arrendamento.

Devoluções

Promise<LeaseOperationResponse>

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

breakLease(LeaseOperationOptions)

Para forçar o fim do contrato de arrendamento.

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

Parâmetros

options

LeaseOperationOptions

Opções para a operação de gestão de arrendamento.

Devoluções

Promise<LeaseOperationResponse>

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

changeLease(string, LeaseOperationOptions)

Para alterar a ID de uma concessão existente.

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

Parâmetros

proposedLeaseId

string

o novo contrato de arrendamento proposto Id.

options

LeaseOperationOptions

Opções para a operação de gestão de arrendamento.

Devoluções

Promise<LeaseOperationResponse>

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

releaseLease(LeaseOperationOptions)

Libertar o arrendamento caso já não seja necessário para que outro cliente possa adquirir imediatamente um contrato de arrendamento.

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

Parâmetros

options

LeaseOperationOptions

Opções para a operação de gestão de arrendamento.

Devoluções

Promise<LeaseOperationResponse>

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

renewLease(LeaseOperationOptions)

Renovar o contrato de arrendamento. Disponível apenas para concessão em compartilhamento ou instantâneo de compartilhamento. Note-se que o contrato de arrendamento pode ser renovado mesmo que tenha expirado, desde que a quota não tenha sido novamente arrendada desde o termo desse contrato. Quando você renova uma locação, o relógio de duração da concessão é redefinido.

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

Parâmetros

options

LeaseOperationOptions

Opções para a operação de gestão de arrendamento.

Devoluções

Promise<LeaseOperationResponse>

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