ShareLeaseClient Clase

Crea un objeto ShareLeaseClient.

Este cliente proporciona operaciones de concesión en shareClient o ShareFileClient.

Herencia

builtins.object

ShareLeaseClient

Constructor

ShareLeaseClient(client: ShareFileClient | ShareClient, lease_id: str | None = None)

Parámetros

client

ShareFileClient o ShareClient

Requerido

El cliente del archivo o recurso compartido que se va a conceder.

lease_id

str

valor predeterminado: None

Cadena que representa el identificador de concesión de una concesión existente. No es necesario especificar este valor para adquirir una nueva concesión o interrumpir una.

Variables

id

str

Identificador de la concesión que se está manteniendo actualmente. Esta será Ninguna si aún no se ha adquirido ninguna concesión.

etag

str

ETag de la concesión que se está manteniendo actualmente. Esta será Ninguna si aún no se ha adquirido o modificado ninguna concesión.

last_modified

datetime

Marca de tiempo de la última modificación de la concesión que se está manteniendo actualmente. Esta será Ninguna si aún no se ha adquirido o modificado ninguna concesión.

Métodos

acquire	Solicita una nueva concesión. Esta operación establece y administra un bloqueo en un archivo o recurso compartido para las operaciones de escritura y eliminación. Si el archivo o recurso compartido no tiene una concesión activa, el servicio Archivo o Recurso compartido crea una concesión en el archivo o recurso compartido. Si el archivo tiene una concesión activa, solo puede solicitar una nueva concesión mediante el identificador de concesión activo. Si el archivo o recurso compartido no tiene una concesión activa, el servicio Archivo o Recurso compartido crea una concesión en el archivo y devuelve un nuevo identificador de concesión.
break_lease	Forzar interrumpe la concesión si el archivo o recurso compartido tiene una concesión activa. Cualquier solicitud autorizada puede interrumpir la concesión; no es necesario que la solicitud especifique un identificador de concesión que coincida. Una concesión infinita se interrumpe inmediatamente. Una vez que se interrumpe una concesión, no se puede cambiar. Cualquier solicitud autorizada puede interrumpir la concesión; no es necesario que la solicitud especifique un identificador de concesión que coincida. Cuando una concesión se interrumpe correctamente, la respuesta indica el intervalo en segundos que debe transcurrir hasta que se pueda obtener una nueva concesión.
change	Cambia el identificador de concesión de una concesión activa. Un cambio debe incluir el identificador de concesión actual en x-ms-lease-id y un nuevo identificador de concesión en x-ms-proposed-lease-id.
release	Libera la concesión. La concesión se puede liberar si el identificador de concesión especificado en la solicitud coincide con el recurso compartido o el archivo. La liberación de la concesión permite a otro cliente adquirir inmediatamente la concesión del recurso compartido o archivo en cuanto se complete la versión.
renew	Renueva la concesión de recursos compartidos. La concesión de recurso compartido se puede renovar si el identificador de concesión especificado en el cliente de concesión coincide con el asociado al recurso compartido. Tenga en cuenta que la concesión se puede renovar incluso si ha expirado siempre y cuando el recurso compartido no se haya concedido de nuevo desde la expiración de esa concesión. Cuando se renueva una concesión, el reloj que controla su duración se reinicia. Novedad de la versión 12.6.0.

acquire

Solicita una nueva concesión. Esta operación establece y administra un bloqueo en un archivo o recurso compartido para las operaciones de escritura y eliminación. Si el archivo o recurso compartido no tiene una concesión activa, el servicio Archivo o Recurso compartido crea una concesión en el archivo o recurso compartido. Si el archivo tiene una concesión activa, solo puede solicitar una nueva concesión mediante el identificador de concesión activo.

Si el archivo o recurso compartido no tiene una concesión activa, el servicio Archivo o Recurso compartido crea una concesión en el archivo y devuelve un nuevo identificador de concesión.

acquire(**kwargs: Any) -> None

Parámetros

lease_duration

int

Especifica la duración de la concesión, en segundos, o bien un valor negativo (-1) para una concesión que no expira nunca. Las concesiones de archivos nunca expiran. Una concesión de recurso compartido no infinito puede estar entre 15 y 60 segundos. No se puede cambiar la duración de una concesión de recurso compartido mediante renovación o cambio. El valor predeterminado es -1 (concesión infinita de recursos compartidos).

timeout

int

Establece el tiempo de espera del lado servidor para la operación en segundos. Para más información, consulte https://learn.microsoft.com/rest/api/storageservices/setting-timeouts-for-file-service-operations. Este valor no se realiza ni se valida en el cliente. Para configurar los tiempos de espera de red del lado cliente, consulte aquí.

Tipo de valor devuelto

None

break_lease

Forzar interrumpe la concesión si el archivo o recurso compartido tiene una concesión activa. Cualquier solicitud autorizada puede interrumpir la concesión; no es necesario que la solicitud especifique un identificador de concesión que coincida. Una concesión infinita se interrumpe inmediatamente.

Una vez que se interrumpe una concesión, no se puede cambiar. Cualquier solicitud autorizada puede interrumpir la concesión; no es necesario que la solicitud especifique un identificador de concesión que coincida. Cuando una concesión se interrumpe correctamente, la respuesta indica el intervalo en segundos que debe transcurrir hasta que se pueda obtener una nueva concesión.

break_lease(**kwargs: Any) -> int

Parámetros

lease_break_period

int

Esta es la duración propuesta de segundos que la concesión de recursos compartidos debe continuar antes de que se rompa, entre 0 y 60 segundos. Este período de interrupción solo se usa si es menor que el tiempo restante en la concesión de recurso compartido. Si es más largo, se usa el tiempo restante en la concesión de recursos compartidos. Una nueva concesión de recurso compartido no estará disponible antes de que haya expirado el período de interrupción, pero la concesión de recurso compartido puede mantenerse durante más tiempo que el período de interrupción. Si este encabezado no aparece con una operación de interrupción, se interrumpe inmediatamente una concesión de recurso compartido de duración fija después de que transcurre el período de concesión del recurso compartido restante y se interrumpe inmediatamente una concesión de recurso compartido infinito.

Novedad de la versión 12.6.0.

timeout

int

Establece el tiempo de espera del lado servidor para la operación en segundos. Para más información, consulte https://learn.microsoft.com/rest/api/storageservices/setting-timeouts-for-file-service-operations. Este valor no se realiza ni se valida en el cliente. Para configurar los tiempos de espera de red del lado cliente, consulte aquí.

Devoluciones

Tiempo restante aproximado del período de concesión, en segundos.

Tipo de valor devuelto

int

change

Cambia el identificador de concesión de una concesión activa. Un cambio debe incluir el identificador de concesión actual en x-ms-lease-id y un nuevo identificador de concesión en x-ms-proposed-lease-id.

change(proposed_lease_id: str, **kwargs: Any) -> None

Parámetros

proposed_lease_id

str

Requerido

Identificador de concesión propuesto, con formato de cadena de GUID. El servicio Archivo o Recurso compartido generará un error (solicitud no válida) si el identificador de concesión propuesto no tiene el formato correcto.

timeout

int

Establece el tiempo de espera del lado servidor para la operación en segundos. Para más información, consulte https://learn.microsoft.com/rest/api/storageservices/setting-timeouts-for-file-service-operations. Este valor no se realiza ni se valida en el cliente. Para configurar los tiempos de espera de red del lado cliente, consulte aquí.

Devoluciones

None

release

Libera la concesión. La concesión se puede liberar si el identificador de concesión especificado en la solicitud coincide con el recurso compartido o el archivo. La liberación de la concesión permite a otro cliente adquirir inmediatamente la concesión del recurso compartido o archivo en cuanto se complete la versión.

release(**kwargs: Any) -> None

Parámetros

timeout

int

Establece el tiempo de espera del lado servidor para la operación en segundos. Para más información, consulte https://learn.microsoft.com/rest/api/storageservices/setting-timeouts-for-file-service-operations. Este valor no se realiza ni se valida en el cliente. Para configurar los tiempos de espera de red del lado cliente, consulte aquí.

Devoluciones

None

renew

Renueva la concesión de recursos compartidos.

La concesión de recurso compartido se puede renovar si el identificador de concesión especificado en el cliente de concesión coincide con el asociado al recurso compartido. Tenga en cuenta que la concesión se puede renovar incluso si ha expirado siempre y cuando el recurso compartido no se haya concedido de nuevo desde la expiración de esa concesión. Cuando se renueva una concesión, el reloj que controla su duración se reinicia.

Novedad de la versión 12.6.0.

renew(**kwargs: Any) -> None

Parámetros

timeout

int

Establece el tiempo de espera del lado servidor para la operación en segundos. Para más información, consulte https://learn.microsoft.com/rest/api/storageservices/setting-timeouts-for-file-service-operations. Este valor no se realiza ni se valida en el cliente. Para configurar los tiempos de espera de red del lado cliente, consulte aquí.

Devoluciones

None