DataLakeLeaseClient Clase
Crea un nuevo DataLakeLeaseClient.
Este cliente proporciona operaciones de concesión en fileSystemClient, DataLakeDirectoryClient o DataLakeFileClient.
- Herencia
-
builtins.objectDataLakeLeaseClient
Constructor
DataLakeLeaseClient(client: FileSystemClient | DataLakeDirectoryClient | DataLakeFileClient, lease_id: str | None = None)
Parámetros
Cliente del sistema de archivos, directorio o archivo que se va a conceder.
- lease_id
- str
Cadena que representa el identificador de concesión de una concesión existente. Este valor no es necesario especificar 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. Si el sistema de archivos o archivos no tiene una concesión activa, el servicio DataLake crea una concesión en el sistema de archivos o archivos y devuelve un nuevo identificador de concesión. |
break_lease |
Interrumpa la concesión, si el sistema de archivos o el archivo tienen una concesión activa. Una vez que se interrumpe una concesión, no es posible renovarla. Cualquier solicitud autorizada puede interrumpir la concesión; no es necesario que la solicitud especifique un identificador de concesión que coincida. Cuando se interrumpe una concesión, el período de interrupción de la concesión puede transcurrir, durante el cual no se puede realizar ninguna operación de concesión excepto interrupción y liberación en el sistema de archivos o en el archivo. 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 |
Cambie el identificador de concesión de una concesión activa. |
release |
Liberar la concesión. La concesión se puede liberar si el identificador de concesión de cliente especificado coincide con el asociado al sistema de archivos o al archivo. Liberar la concesión permite a otro cliente adquirir inmediatamente la concesión para el sistema de archivos o archivo en cuanto se complete la versión. |
renew |
Renueva la concesión. La concesión se puede renovar si el identificador de concesión especificado en el cliente de concesión coincide con el asociado al sistema de archivos o al archivo. Tenga en cuenta que la concesión puede renovarse incluso si ha expirado siempre que el sistema de archivos o el archivo no se hayan 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. |
acquire
Solicita una nueva concesión.
Si el sistema de archivos o archivos no tiene una concesión activa, el servicio DataLake crea una concesión en el sistema de archivos o archivos y devuelve un nuevo identificador de concesión.
acquire(lease_duration: int = -1, **kwargs: int | None) -> 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. Un concesión no infinita puede durar entre 15 y 60 segundos. No se puede cambiar una duración de concesión mediante renovación o cambio. El valor predeterminado es -1 (concesión infinita).
- if_modified_since
- datetime
Un valor DateTime. Azure espera que el valor de fecha pasado sea UTC. Si se incluye la zona horaria, las fechas no UTC se convertirán a UTC. Si se pasa una fecha sin información de zona horaria, se supone que es UTC. Especifique este encabezado para realizar la operación solo si se ha modificado el recurso desde la hora especificada.
- if_unmodified_since
- datetime
Un valor DateTime. Azure espera que el valor de fecha pasado sea UTC. Si se incluye la zona horaria, las fechas no UTC se convertirán a UTC. Si se pasa una fecha sin información de zona horaria, se supone que es UTC. Especifique este encabezado para realizar la operación solo si no se ha modificado el recurso desde la fecha u hora especificada.
- etag
- str
Valor ETag o el carácter comodín (*). Se usa para comprobar si el recurso ha cambiado y actuar según la condición especificada por el parámetro match_condition .
- match_condition
- MatchConditions
Condición de coincidencia que se va a usar en el etag.
- 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-blob-service-operations. Este valor no se realiza un seguimiento ni se valida en el cliente. Para configurar tiempos de espera de red del lado cliente, consulte aquí.
Tipo de valor devuelto
break_lease
Interrumpa la concesión, si el sistema de archivos o el archivo tienen una concesión activa.
Una vez que se interrumpe una concesión, no es posible renovarla. Cualquier solicitud autorizada puede interrumpir la concesión; no es necesario que la solicitud especifique un identificador de concesión que coincida. Cuando se interrumpe una concesión, el período de interrupción de la concesión puede transcurrir, durante el cual no se puede realizar ninguna operación de concesión excepto interrupción y liberación en el sistema de archivos o en el archivo. 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(lease_break_period: int | None = None, **kwargs: Any) -> int
Parámetros
- lease_break_period
- int
Esta es la duración propuesta de segundos que la concesión debe continuar antes de que se rompa, entre 0 y 60 segundos. Este período de interrupción solo se utiliza si es menor que el tiempo restante de la concesión. Si es más largo, se utiliza el tiempo restante de la concesión. Hasta que no haya expirado el período de interrupción no habrá disponible una nueva concesión, pero la concesión se puede mantener durante un tiempo más largo que el período de interrupción. Si este encabezado no aparece con una operación de interrupción, se interrumpe una concesión de duración fija después de que transcurre el período de concesión restante y se interrumpe inmediatamente una concesión infinita.
- if_modified_since
- datetime
Un valor DateTime. Azure espera que el valor de fecha pasado sea UTC. Si se incluye la zona horaria, las fechas no UTC se convertirán a UTC. Si se pasa una fecha sin información de zona horaria, se supone que es UTC. Especifique este encabezado para realizar la operación solo si se ha modificado el recurso desde la hora especificada.
- if_unmodified_since
- datetime
Un valor DateTime. Azure espera que el valor de fecha pasado sea UTC. Si se incluye la zona horaria, las fechas no UTC se convertirán a UTC. Si se pasa una fecha sin información de zona horaria, se supone que es UTC. Especifique este encabezado para realizar la operación solo si no se ha modificado el recurso desde la fecha u hora especificada.
- 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-blob-service-operations. Este valor no se realiza un seguimiento ni se valida en el cliente. Para configurar 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
change
Cambie el identificador de concesión de una concesión activa.
change(proposed_lease_id: str, **kwargs: Any) -> None
Parámetros
- proposed_lease_id
- str
Identificador de concesión propuesto, con formato de cadena de GUID. El servicio DataLake devuelve 400 (solicitud no válida) si el identificador de concesión propuesto no tiene el formato correcto.
- if_modified_since
- datetime
Un valor DateTime. Azure espera que el valor de fecha pasado sea UTC. Si se incluye la zona horaria, las fechas no UTC se convertirán a UTC. Si se pasa una fecha sin información de zona horaria, se supone que es UTC. Especifique este encabezado para realizar la operación solo si se ha modificado el recurso desde la hora especificada.
- if_unmodified_since
- datetime
Un valor DateTime. Azure espera que el valor de fecha pasado sea UTC. Si se incluye la zona horaria, las fechas no UTC se convertirán a UTC. Si se pasa una fecha sin información de zona horaria, se supone que es UTC. Especifique este encabezado para realizar la operación solo si no se ha modificado el recurso desde la fecha u hora especificada.
- etag
- str
Valor ETag o el carácter comodín (*). Se usa para comprobar si el recurso ha cambiado y actuar según la condición especificada por el parámetro match_condition .
- match_condition
- MatchConditions
Condición de coincidencia que se va a usar en el etag.
- 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-blob-service-operations. Este valor no se realiza un seguimiento ni se valida en el cliente. Para configurar tiempos de espera de red del lado cliente, consulte aquí.
Devoluciones
None
release
Liberar la concesión.
La concesión se puede liberar si el identificador de concesión de cliente especificado coincide con el asociado al sistema de archivos o al archivo. Liberar la concesión permite a otro cliente adquirir inmediatamente la concesión para el sistema de archivos o archivo en cuanto se complete la versión.
release(**kwargs: Any) -> None
Parámetros
- if_modified_since
- datetime
Un valor DateTime. Azure espera que el valor de fecha pasado sea UTC. Si se incluye la zona horaria, las fechas no UTC se convertirán a UTC. Si se pasa una fecha sin información de zona horaria, se supone que es UTC. Especifique este encabezado para realizar la operación solo si se ha modificado el recurso desde la hora especificada.
- if_unmodified_since
- datetime
Un valor DateTime. Azure espera que el valor de fecha pasado sea UTC. Si se incluye la zona horaria, las fechas no UTC se convertirán a UTC. Si se pasa una fecha sin información de zona horaria, se supone que es UTC. Especifique este encabezado para realizar la operación solo si no se ha modificado el recurso desde la fecha u hora especificada.
- etag
- str
Valor ETag o el carácter comodín (*). Se usa para comprobar si el recurso ha cambiado y actuar según la condición especificada por el parámetro match_condition .
- match_condition
- MatchConditions
Condición de coincidencia que se va a usar en el etag.
- 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-blob-service-operations. Este valor no se realiza un seguimiento ni se valida en el cliente. Para configurar tiempos de espera de red del lado cliente, consulte aquí.
Devoluciones
None
renew
Renueva la concesión.
La concesión se puede renovar si el identificador de concesión especificado en el cliente de concesión coincide con el asociado al sistema de archivos o al archivo. Tenga en cuenta que la concesión puede renovarse incluso si ha expirado siempre que el sistema de archivos o el archivo no se hayan 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.
renew(**kwargs: Any) -> None
Parámetros
- if_modified_since
- datetime
Un valor DateTime. Azure espera que el valor de fecha pasado sea UTC. Si se incluye la zona horaria, las fechas no UTC se convertirán a UTC. Si se pasa una fecha sin información de zona horaria, se supone que es UTC. Especifique este encabezado para realizar la operación solo si se ha modificado el recurso desde la hora especificada.
- if_unmodified_since
- datetime
Un valor DateTime. Azure espera que el valor de fecha pasado sea UTC. Si se incluye la zona horaria, las fechas y horas no UTC se convertirán a UTC. Si se pasa una fecha sin información de zona horaria, se supone que es UTC. Especifique este encabezado para realizar la operación solo si no se ha modificado el recurso desde la fecha u hora especificada.
- etag
- str
Valor ETag o el carácter comodín (*). Se usa para comprobar si el recurso ha cambiado y actuar según la condición especificada por el parámetro match_condition .
- match_condition
- MatchConditions
Condición de coincidencia que se va a usar en la etiqueta electrónica.
- 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-blob-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
Azure SDK for Python