ShareLeaseClient class
Um cliente que gere 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
| Share |
Cria uma instância do ShareLeaseClient. |
Propriedades
| lease |
Obtém o ID de concessão. |
| url | Obtém o URL. |
Métodos
| acquire |
Estabelece e gere um bloqueio num ficheiro, partilha ou partilha instantâneo para operações de escrita e eliminação. |
| break |
Para forçar o fim da concessão. |
| change |
Para alterar o ID de uma concessão existente. |
| release |
Para libertar a concessão se já não for necessária, para que outro cliente possa adquirir imediatamente uma concessão. |
| renew |
Para renovar a concessão. Disponível apenas para concessão em instantâneo de partilha ou partilha. Tenha em atenção que a concessão pode ser renovada mesmo que tenha expirado desde que a ação não tenha sido novamente arrendada desde a expiração dessa concessão. Quando renova uma concessão, o relógio de duração da concessão é reposto. |
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 os pedidos de operação de concessão.
- leaseId
-
string
ID de concessão proposto inicial.
Detalhes de Propriedade
leaseId
Obtém o ID de concessão.
string leaseIdValor de Propriedade
string
url
Obtém o URL.
string urlValor de Propriedade
string
Detalhes de Método
acquireLease(number, LeaseOperationOptions)
Estabelece e gere um bloqueio num ficheiro, partilha ou partilha instantâneo para operações de escrita e eliminação.
function acquireLease(duration?: number, options?: LeaseOperationOptions): Promise<LeaseOperationResponse>Parâmetros
- duration
-
number
Especifica a duração da concessão em segundos. Para o ficheiro, o único valor permitido é -1 para uma concessão que nunca expira. Para partilhar, tem de ser -1 ou entre 15 e 60.
- options
- LeaseOperationOptions
Opções para a operação de gestão de concessões.
Devoluções
Promise<LeaseOperationResponse>
Dados de resposta para a operação de aquisição de concessã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 gestão de concessões.
Devoluções
Promise<LeaseOperationResponse>
Dados de resposta para a operação de concessão de interrupção.
changeLease(string, LeaseOperationOptions)
Para alterar o ID de uma concessão existente.
function changeLease(proposedLeaseId: string, options?: LeaseOperationOptions): Promise<LeaseOperationResponse>Parâmetros
- proposedLeaseId
-
string
o novo ID de concessão proposto.
- options
- LeaseOperationOptions
Opções para a operação de gestão de concessões.
Devoluções
Promise<LeaseOperationResponse>
Dados de resposta para a operação de concessão de alterações.
releaseLease(LeaseOperationOptions)
Para libertar a concessão se já não for 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 gestão de concessões.
Devoluções
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 instantâneo de partilha ou partilha. Tenha em atenção que a concessão pode ser renovada mesmo que tenha expirado desde que a ação não tenha sido novamente arrendada desde a expiração dessa concessão. Quando renova uma concessão, o relógio de duração da concessão é reposto.
function renewLease(options?: LeaseOperationOptions): Promise<LeaseOperationResponse>Parâmetros
- options
- LeaseOperationOptions
Opções para a operação de gestão de concessões.
Devoluções
Promise<LeaseOperationResponse>
Dados de resposta para a operação de renovação da concessão.