ShareLeaseClient class

Paquete:

@azure/storage-file-share

Un cliente que administra concesiones de un shareFileClient o ShareClient.

Consulte https://learn.microsoft.com/rest/api/storageservices/lease-file y Consulte https://learn.microsoft.com/rest/api/storageservices/lease-share

Constructores

ShareLeaseClient(ShareClient | ShareFileClient, string)

Crea una instancia de ShareLeaseClient.

Propiedades

leaseId	Obtiene el identificador de concesión.
url	Obtiene la dirección URL.

Métodos

acquireLease(number, LeaseOperationOptions)	Establece y administra un bloqueo en un archivo, un recurso compartido o una instantánea de recurso compartido para las operaciones de escritura y eliminación.
breakLease(LeaseOperationOptions)	Para forzar la finalización del contrato de arrendamiento.
changeLease(string, LeaseOperationOptions)	Para cambiar el identificador de una concesión existente.
releaseLease(LeaseOperationOptions)	Para liberar la concesión si ya no es necesaria para que otro cliente pueda adquirir inmediatamente una concesión.
renewLease(LeaseOperationOptions)	Para renovar la concesión. Solo está disponible para la concesión en el recurso compartido o la instantánea de recurso compartido. Tenga en cuenta que la concesión puede renovarse incluso si ha expirado siempre que la acción no se haya concedido de nuevo desde la expiración de esa concesión. Al renovar una concesión, el reloj de duración de la concesión se restablece.

Detalles del constructor

ShareLeaseClient(ShareClient | ShareFileClient, string)

Crea una instancia de ShareLeaseClient.

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

Parámetros

client

ShareClient | ShareFileClient

El cliente para realizar las solicitudes de operación de concesión.

leaseId

string

Identificador de concesión propuesto inicial.

Detalles de las propiedades

leaseId

Obtiene el identificador de concesión.

string leaseId

Valor de propiedad

string

url

Obtiene la dirección URL.

string url

Valor de propiedad

string

Detalles del método

acquireLease(number, LeaseOperationOptions)

Establece y administra un bloqueo en un archivo, un recurso compartido o una instantánea de recurso compartido para las operaciones de escritura y eliminación.

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

Parámetros

duration

number

Especifica la duración de la concesión en segundos. En el caso del archivo, el único valor permitido es -1 para una concesión que nunca expira. Para compartir, debe ser -1 o entre 15 y 60.

options

LeaseOperationOptions

Opciones para la operación de administración de concesiones.

Devoluciones

Promise<LeaseOperationResponse>

Datos de respuesta para la operación de concesión de adquisición.

breakLease(LeaseOperationOptions)

Para forzar la finalización del contrato de arrendamiento.

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

Parámetros

options

LeaseOperationOptions

Opciones para la operación de administración de concesiones.

Devoluciones

Promise<LeaseOperationResponse>

Datos de respuesta para la operación de concesión de interrupción.

changeLease(string, LeaseOperationOptions)

Para cambiar el identificador de una concesión existente.

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

Parámetros

proposedLeaseId

string

el nuevo identificador de concesión propuesto.

options

LeaseOperationOptions

Opciones para la operación de administración de concesiones.

Devoluciones

Promise<LeaseOperationResponse>

Datos de respuesta para la operación de concesión de cambios.

releaseLease(LeaseOperationOptions)

Para liberar la concesión si ya no es necesaria para que otro cliente pueda adquirir inmediatamente una concesión.

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

Parámetros

options

LeaseOperationOptions

Opciones para la operación de administración de concesiones.

Devoluciones

Promise<LeaseOperationResponse>

Datos de respuesta para la operación de concesión de versión.

renewLease(LeaseOperationOptions)

Para renovar la concesión. Solo está disponible para la concesión en el recurso compartido o la instantánea de recurso compartido. Tenga en cuenta que la concesión puede renovarse incluso si ha expirado siempre que la acción no se haya concedido de nuevo desde la expiración de esa concesión. Al renovar una concesión, el reloj de duración de la concesión se restablece.

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

Parámetros

options

LeaseOperationOptions

Opciones para la operación de administración de concesiones.

Devoluciones

Promise<LeaseOperationResponse>

Datos de respuesta para la operación de concesión de renovación.