BlobLeaseClient class

Paquete:

@azure/storage-blob

Cliente que administra concesiones para o <xref:ContainerClient> .<xref:BlobClient>

Constructores

BlobLeaseClient(ContainerClient | BlobClient, string)

Crea una instancia de BlobLeaseClient.

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 contenedor para las operaciones de eliminación, o en un blob para operaciones de escritura y eliminación. La duración del bloqueo puede ser de 15 a 60 segundos, o puede ser infinita.
breakLease(number, LeaseOperationOptions)	Para finalizar la concesión, pero asegúrese de que otro cliente no puede adquirir una nueva concesión hasta que haya expirado el período de concesión actual.
changeLease(string, LeaseOperationOptions)	Para cambiar el identificador de la concesión.
releaseLease(LeaseOperationOptions)	Para liberar la concesión si ya no es necesaria para que otro cliente pueda adquirir inmediatamente una concesión en el contenedor o el blob.
renewLease(LeaseOperationOptions)	Para renovar la concesión.

Detalles del constructor

BlobLeaseClient(ContainerClient | BlobClient, string)

Crea una instancia de BlobLeaseClient.

new BlobLeaseClient(client: ContainerClient | BlobClient, leaseId?: string)

Parámetros

client

ContainerClient | BlobClient

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 contenedor para las operaciones de eliminación, o en un blob para operaciones de escritura y eliminación. La duración del bloqueo puede ser de 15 a 60 segundos, o puede ser infinita.

function acquireLease(duration: number, options?: LeaseOperationOptions)

Parámetros

duration

number

Debe tener entre 15 y 60 segundos o infinito (-1)

options

LeaseOperationOptions

opción para configurar las operaciones de administración de concesiones.

Devoluciones

Promise<LeaseOperationResponse>

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

breakLease(number, LeaseOperationOptions)

Para finalizar la concesión, pero asegúrese de que otro cliente no puede adquirir una nueva concesión hasta que haya expirado el período de concesión actual.

function breakLease(breakPeriod: number, options?: LeaseOperationOptions)

Parámetros

breakPeriod

number

Período de interrupción

options

LeaseOperationOptions

Opciones opcionales para configurar las operaciones 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 la concesión.

function changeLease(proposedLeaseId: string, options?: LeaseOperationOptions)

Parámetros

proposedLeaseId

string

el nuevo identificador de concesión propuesto.

options

LeaseOperationOptions

opción para configurar las operaciones 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 en el contenedor o el blob.

function releaseLease(options?: LeaseOperationOptions)

Parámetros

options

LeaseOperationOptions

opción para configurar las operaciones 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.

function renewLease(options?: LeaseOperationOptions)

Parámetros

options

LeaseOperationOptions

Opción opcional para configurar las operaciones de administración de concesiones.

Devoluciones

Promise<Lease>

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