azure.storage.filedatalake.DataLakeFileClient class

Solicita una nueva concesión. Si el archivo o directorio no tiene una concesión activa, el servicio DataLake crea una concesión en el archivo o directorio y devuelve un nuevo identificador de concesión.

acquire_lease(lease_duration: int | None = -1, lease_id: str | None = None, **kwargs) -> DataLakeLeaseClient

Parámetros

lease_duration: int

Requerido

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).

lease_id: str

Requerido

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

Objeto DataLakeLeaseClient que se puede ejecutar en un administrador de contextos.

Tipo de valor devuelto

DataLakeLeaseClient

Anexe datos al archivo.

append_data(data: bytes | str | Iterable[AnyStr] | IO[AnyStr], offset: int, length: int | None = None, **kwargs) -> Dict[str, str | datetime | int]

Parámetros

data

Requerido

Contenido que se va a anexar al archivo

offset

Requerido

posición inicial de los datos a los que se va a anexar.

length

Requerido

Tamaño de los datos en bytes.

flush: bool

Si es true, confirmará los datos después de anexarlos.

validate_content: bool

Si es true, calcula un hash MD5 del contenido del bloque. El servicio de almacenamiento comprueba el hash del contenido que ha llegado con el hash que se envió. Esto es principalmente útil para detectar bitflips en la conexión si el uso de http en lugar de https como https (valor predeterminado) ya se validará. Tenga en cuenta que este hash MD5 no se almacena con el archivo .

lease_action: Literal["acquire", "auto-renew", "release", "acquire-release"]

Se usa para realizar operaciones de concesión junto con la anexión de datos.

"adquirir" - Adquirir un contrato de arrendamiento. "renovación automática": vuelva a crear una concesión existente. "release": libere la concesión una vez completada la operación. Requiere flush=True. "acquire-release": adquiera una concesión y la libere una vez completadas las operaciones. Requiere flush=True.

lease_duration: int

Válido si lease_action está establecido en "acquire" o "acquire-release".

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).

lease: DataLakeLeaseClient o str

Obligatorio si el archivo tiene una concesión activa o si lease_action está establecido en "acquire" o "acquire-release". Si el archivo tiene una concesión existente, se usará para acceder al archivo. Si adquiere una nueva concesión, se usará como el nuevo identificador de concesión. El valor puede ser un objeto DataLakeLeaseClient o el identificador de concesión como una cadena.

cpk: CustomerProvidedEncryptionKey

Cifra los datos en el lado del servicio con la clave especificada. El uso de claves proporcionadas por el cliente debe realizarse a través de HTTPS.

Devoluciones

dict del encabezado de respuesta

Ejemplos

Anexe datos al archivo.


   file_client.append_data(data=file_content[2048:3072], offset=2048, length=1024)

Este método consiste en cerrar los sockets abiertos por el cliente. No es necesario usarse cuando se usa con un administrador de contextos.

close() -> None

Cree un archivo.

create_file(content_settings: ContentSettings | None = None, metadata: Dict[str, str] | None = None, **kwargs) -> Dict[str, str | datetime]

Parámetros

content_settings: ContentSettings

Requerido

Objeto ContentSettings usado para establecer propiedades de ruta de acceso.

metadata: Optional[Dict[str, str]]

Requerido

Pares nombre-valor asociados al archivo como metadatos.

lease: DataLakeLeaseClient o str

Requerido si el archivo tiene una concesión activa. El valor puede ser un objeto DataLakeLeaseClient o el identificador de concesión como una cadena.

umask: str

Opcional y solo válido si el espacio de nombres jerárquico está habilitado para la cuenta. Al crear un archivo o directorio y la carpeta primaria no tiene una ACL predeterminada, el umask restringe los permisos del archivo o directorio que se va a crear. P ^u concede & el permiso resultante, donde p es el permiso y usted es el umask. Por ejemplo, si p es 0777 y es 0057, el permiso resultante es 0720. El permiso predeterminado es 0777 para un directorio y 0666 para un archivo. El umask predeterminado es 0027. El umask debe especificarse en notación octal de 4 dígitos (por ejemplo, 0766).

owner: str

Propietario del archivo o directorio.

group: str

Grupo propietario del archivo o directorio.

acl: str

Establece los derechos de control de acceso POSIX en archivos y directorios. El valor es una lista separada por comas de entradas de control de acceso. Cada entrada de control de acceso (ACE) consta de un ámbito, un tipo, un identificador de usuario o grupo y permisos con el formato "[ámbito:][tipo]:[id]:[permisos]".

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.

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. Una duración de concesión no se puede cambiar mediante renovación o cambio.

expires_on: datetime o int

Hora a la que se va a establecer el archivo en expiración. Si el tipo de expires_on es un valor int, la hora de expiración se establecerá como el número de milisegundos transcurridos desde la hora de creación. Si el tipo de expires_on es datetime, la hora de expiración se establecerá absoluta en la hora proporcionada. Si no se proporciona información de zona horaria, se interpretará como UTC.

permissions: str

Opcional y solo válido si el espacio de nombres jerárquico está habilitado para la cuenta. Establece los permisos de acceso POSIX para el propietario del archivo, el grupo propietario de archivos y otros. Se puede conceder permiso de lectura, escritura o ejecución a cada clase. También se admite el bit pegajoso. Se admiten tanto la notación simbólica (rwxrw-rw-) como la notación octal de 4 dígitos (por ejemplo, 0766).

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 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 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.

cpk: CustomerProvidedEncryptionKey

Cifra los datos en el lado del servicio con la clave especificada. El uso de claves proporcionadas por el cliente debe realizarse a través de HTTPS.

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í.

encryption_context: str

Especifica el contexto de cifrado que se va a establecer en el archivo.

Devoluciones

dict de respuesta (Etag y última modificación).

Ejemplos

Crear archivo.


   file_client = filesystem_client.get_file_client(file_name)
   file_client.create_file()

Marca el archivo especificado para su eliminación.

delete_file(**kwargs) -> None

Parámetros

lease: DataLakeLeaseClient o str

Obligatorio si el archivo tiene una concesión activa. El valor puede ser un objeto LeaseClient o el identificador de concesión como una cadena.

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 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 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

Ninguno

Ejemplos

Eliminar archivo.


   new_client.delete_file()

Descarga un archivo en StorageStreamDownloader. El método readall() debe usarse para leer todo el contenido, o readinto() debe usarse para descargar el archivo en una secuencia. El uso de chunks() devuelve un iterador que permite al usuario iterar el contenido en fragmentos.

download_file(offset: int | None = None, length: int | None = None, **kwargs: Any) -> StorageStreamDownloader

Parámetros

offset: int

Requerido

Inicio del intervalo de bytes que se va a usar para descargar una sección del archivo. Debe establecerse si se proporciona longitud.

length: int

Requerido

Número de bytes que se van a leer de la secuencia. Esto es opcional, pero debe proporcionarse para obtener un rendimiento óptimo.

lease: DataLakeLeaseClient o str

Si se especifica, la descarga solo se realiza correctamente si la concesión del archivo está activa y coincide con este identificador. Obligatorio si el archivo tiene una concesión activa.

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 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 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.

cpk: CustomerProvidedEncryptionKey

Descifra los datos en el lado del servicio con la clave especificada. El uso de claves proporcionadas por el cliente debe realizarse a través de HTTPS. Obligatorio si el archivo se creó con una clave de Customer-Provided.

max_concurrency: int

Número de conexiones paralelas con las que se va a descargar.

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í. Este método puede realizar varias llamadas al servicio y el tiempo de espera se aplicará a cada llamada individualmente.

Devoluciones

Un objeto de streaming (StorageStreamDownloader)

Tipo de valor devuelto

StorageStreamDownloader

Ejemplos

Devuelve los datos descargados.


   download = file_client.download_file()
   downloaded_bytes = download.readall()

Devuelve True si existe un archivo y devuelve False de lo contrario.

exists(**kwargs: Any) -> bool

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-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

True si existe un archivo; de lo contrario, devuelve False.

Tipo de valor devuelto

bool

Confirme los datos anexados anteriores.

flush_data(offset: int, retain_uncommitted_data: bool | None = False, **kwargs) -> Dict[str, str | datetime]

Parámetros

offset

Requerido

offset es igual a la longitud del archivo después de confirmar los datos anexados anteriores.

retain_uncommitted_data: bool

Requerido

Válido solo para operaciones de vaciado. Si es "true", los datos no confirmados se conservan una vez completada la operación de vaciado; de lo contrario, los datos no confirmados se eliminan después de la operación de vaciado. El valor predeterminado es false. Los datos en desplazamientos inferiores a la posición especificada se escriben en el archivo cuando el vaciado se realiza correctamente, pero este parámetro opcional permite que los datos después de la posición de vaciado se conserven para una operación de vaciado futura.

content_settings: ContentSettings

Objeto ContentSettings usado para establecer propiedades de ruta de acceso.

close: bool

Los eventos de Azure Storage permiten a las aplicaciones recibir notificaciones cuando cambian los archivos. Cuando se habilitan los eventos de Azure Storage, se genera un evento cambiado de archivo. Este evento tiene una propiedad que indica si este es el cambio final para distinguir la diferencia entre un vaciado intermedio a una secuencia de archivos y el cierre final de una secuencia de archivos. El parámetro close query solo es válido cuando la acción es "vaciada" y las notificaciones de cambio están habilitadas. Si el valor de close es "true" y la operación de vaciado se completa correctamente, el servicio genera una notificación de cambio de archivo con una propiedad que indica que se trata de la actualización final (se ha cerrado la secuencia de archivos). Si se genera una notificación de cambio "false" que indica que el archivo ha cambiado. El valor predeterminado es false. El controlador ABFS de Hadoop establece este parámetro de consulta en true para indicar que se ha cerrado la secuencia de archivos".

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.

lease_action: Literal["acquire", "auto-renew", "release", "acquire-release"]

Se usa para realizar operaciones de concesión junto con la anexión de datos.

"adquirir" - Adquirir un contrato de arrendamiento. "renovación automática": vuelva a crear una concesión existente. "release": libere la concesión una vez completada la operación. "acquire-release": adquiera una concesión y la libere una vez completadas las operaciones.

lease_duration: int

Válido si lease_action está establecido en "acquire" o "acquire-release".

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).

lease: DataLakeLeaseClient o str

Obligatorio si el archivo tiene una concesión activa o si lease_action está establecido en "acquire" o "acquire-release". Si el archivo tiene una concesión existente, se usará para acceder al archivo. Si adquiere una nueva concesión, se usará como el nuevo identificador de concesión. El valor puede ser un objeto DataLakeLeaseClient o el identificador de concesión como una cadena.

cpk: CustomerProvidedEncryptionKey

Cifra los datos en el lado del servicio con la clave especificada. El uso de claves proporcionadas por el cliente debe realizarse a través de HTTPS.

Devoluciones

encabezado de respuesta en dict

Ejemplos

Confirme los datos anexados anteriores.


   with open(SOURCE_FILE, "rb") as data:
       file_client = file_system_client.get_file_client("myfile")
       file_client.create_file()
       file_client.append_data(data, 0)
       file_client.flush_data(data.tell())

Cree DataLakeFileClient a partir de una cadena de conexión.

:return a DataLakeFileClient :rtype ~azure.storage.filedatalake.DataLakeFileClient

from_connection_string(conn_str: str, file_system_name: str, file_path: str, credential: str | Dict[str, str] | AzureNamedKeyCredential | AzureSasCredential | TokenCredential | None = None, **kwargs: Any) -> Self

Parámetros

conn_str: str

Requerido

Cadena de conexión a una cuenta de Azure Storage.

file_system_name: str

Requerido

Nombre del sistema de archivos con el que interactuar.

file_path: str

Requerido

Ruta de acceso completa del archivo para que interactúe con un archivo específico. P. ej. "{directory}/{subdirectory}/{file}"

credential

valor predeterminado: None

Credenciales con las que se va a autenticar. Esto es opcional si la dirección URL de la cuenta ya tiene un token de SAS o la cadena de conexión ya tiene valores de clave de acceso compartido. El valor puede ser una cadena de token de SAS, una instancia de AzureSasCredential o AzureNamedKeyCredential de azure.core.credentials, una clave de acceso compartido de cuenta o una instancia de una clase TokenCredentials de azure.identity. Las credenciales proporcionadas aquí tendrán prioridad sobre las de la cadena de conexión. Si usa una instancia de AzureNamedKeyCredential, "name" debe ser el nombre de la cuenta de almacenamiento y "key" debe ser la clave de la cuenta de almacenamiento.

get_access_control(upn: bool | None = None, **kwargs) -> Dict[str, Any]

Parámetros

upn: bool

Requerido

Opcional. Válido solo cuando el espacio de nombres jerárquico está habilitado para la cuenta. Si es "true", los valores de identidad de usuario devueltos en los encabezados de respuesta x-ms-owner, x-ms-group y x-ms-acl se transformarán de identificadores de objeto de Azure Active Directory a nombres principales de usuario. Si es "false", los valores se devolverán como identificadores de objeto de Azure Active Directory. El valor predeterminado es false. Tenga en cuenta que los identificadores de objeto de grupo y aplicación no se traducen porque no tienen nombres descriptivos únicos.

lease: DataLakeLeaseClient o str

Obligatorio si el archivo o directorio tiene una concesión activa. El valor puede ser un objeto LeaseClient o el identificador de concesión como una cadena.

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í.

response dict

dict de respuesta.

Devuelve todos los metadatos definidos por el usuario, las propiedades HTTP estándar y las propiedades del sistema para el archivo. No devuelve el contenido del archivo.

get_file_properties(**kwargs: Any) -> FileProperties

Parámetros

lease

Obligatorio si el directorio o archivo tiene una concesión activa. El valor puede ser un objeto DataLakeLeaseClient o el identificador de concesión como una cadena.

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 la etiqueta electrónica.

cpk: CustomerProvidedEncryptionKey

Descifra los datos en el lado del servicio con la clave especificada. El uso de claves proporcionadas por el cliente debe realizarse a través de HTTPS. Obligatorio si el archivo se creó con una clave proporcionada por el cliente.

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

Todos los metadatos definidos por el usuario, las propiedades HTTP estándar y las propiedades del sistema para el archivo.

Tipo de valor devuelto

FileProperties

Ejemplos

Obtención de las propiedades de un archivo.


   properties = file_client.get_file_properties()

Permite a los usuarios seleccionar o proyectar en los datos del archivo datalake proporcionando expresiones de consulta simples. Esta operación devuelve un DataLakeFileQueryReader, los usuarios deben usar readall() o readinto() para obtener datos de consulta.

query_file(query_expression: str, **kwargs: Any) -> DataLakeFileQueryReader

Parámetros

query_expression: str

Requerido

Necesario. una instrucción de consulta. P. ej. Seleccione * en DataLakeStorage.

on_error: Callable[DataLakeFileQueryError]

Función a la que se llamará en los errores de procesamiento devueltos por el servicio.

file_format: DelimitedTextDialect o DelimitedJsonDialect o QuickQueryDialect o str

Opcional. Define la serialización de los datos almacenados actualmente en el archivo. El valor predeterminado es tratar los datos de archivo como datos CSV con formato en el dialecto predeterminado. Esto se puede invalidar con un DelimitedTextDialect personalizado o DelimitedJsonDialect o "ParquetDialect" (pasado como una cadena o enumeración). Estos dialectos se pueden pasar a través de sus respectivas clases, la enumeración QuickQueryDialect o como una cadena.

output_format: DelimitedTextDialect o DelimitedJsonDialect o list[ArrowDialect] o QuickQueryDialect o str

Opcional. Define la serialización de salida para el flujo de datos. De forma predeterminada, los datos se devolverán tal como se representan en el archivo. Al proporcionar un formato de salida, los datos del archivo se volverán a formatear según ese perfil. Este valor puede ser DelimitedTextDialect o DelimitedJsonDialect o ArrowDialect. Estos dialectos se pueden pasar a través de sus respectivas clases, la enumeración QuickQueryDialect o como una cadena.

lease: DataLakeLeaseClient o str

Obligatorio si el archivo tiene una concesión activa. El valor puede ser un objeto DataLakeLeaseClient o el identificador de concesión como una cadena.

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 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 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.

cpk: CustomerProvidedEncryptionKey

Descifra los datos en el lado del servicio con la clave especificada. El uso de claves proporcionadas por el cliente debe realizarse a través de HTTPS. Obligatorio si el archivo se creó con una clave de Customer-Provided.

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

Objeto de streaming (DataLakeFileQueryReader)

Tipo de valor devuelto

<xref:azure.storage.filedatalake.DataLakeFileQueryReader>

Ejemplos

select/project on datalake file data by providing simple query expressions.


   errors = []
   def on_error(error):
       errors.append(error)

   # upload the csv file
   file_client = datalake_service_client.get_file_client(filesystem_name, "csvfile")
   file_client.upload_data(CSV_DATA, overwrite=True)

   # select the second column of the csv file
   query_expression = "SELECT _2 from DataLakeStorage"
   input_format = DelimitedTextDialect(delimiter=',', quotechar='"', lineterminator='\n', escapechar="", has_header=False)
   output_format = DelimitedJsonDialect(delimiter='\n')
   reader = file_client.query_file(query_expression, on_error=on_error, file_format=input_format, output_format=output_format)
   content = reader.readall()

Quita el Access Control en una ruta de acceso y subrutas.

remove_access_control_recursive(acl: str, **kwargs: Any) -> AccessControlChangeResult

Parámetros

acl: str

Requerido

Quita los derechos de control de acceso POSIX en archivos y directorios. El valor es una lista separada por comas de entradas de control de acceso. Cada entrada de control de acceso (ACE) consta de un ámbito, un tipo y un identificador de usuario o grupo con el formato "[scope:][type]:[id]".

progress_hook: <xref:func>(AccessControlChanges)

Devolución de llamada en la que el autor de la llamada puede realizar un seguimiento del progreso de la operación, así como recopilar rutas de acceso que no pudieron cambiar Access Control.

continuation_token: str

Token de continuación opcional que se puede usar para reanudar la operación detenida anteriormente.

batch_size: int

Opcional. Si el tamaño del conjunto de datos supera el tamaño del lote, la operación se dividirá en varias solicitudes para que se pueda realizar un seguimiento del progreso. El tamaño del lote debe estar comprendido entre 1 y 2000. El valor predeterminado cuando no se especifica es 2000.

max_batches: int

Opcional. Define el número máximo de lotes que se pueden ejecutar Access Control operación de cambio único. Si se alcanza el máximo antes de que se procesen todas las subdirecciones, el token de continuación se puede usar para reanudar la operación. El valor vacío indica que el número máximo de lotes en un enlace y la operación continúa hasta el final.

continue_on_failure: bool

Si se establece en False, la operación finalizará rápidamente al encontrar errores de usuario (4XX). Si es True, la operación omitirá los errores de usuario y continuará con la operación en otras subentidades del directorio. El token de continuación solo se devolverá cuando continue_on_failure sea True en caso de errores de usuario. Si no se establece el valor predeterminado es False para esto.

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

Resumen de las operaciones recursivas, incluido el recuento de éxitos y errores, así como un token de continuación en caso de que la operación se finalizara prematuramente.

Tipo de valor devuelto

AccessControlChangeResult

Excepciones

AzureError

El usuario puede reiniciar la operación mediante continuation_token campo azureError si el token está disponible.

Cambie el nombre del archivo de origen.

rename_file(new_name: str, **kwargs: Any) -> DataLakeFileClient

Parámetros

new_name: str

Requerido

el nuevo nombre de archivo al que el usuario desea cambiar el nombre. El valor debe tener el siguiente formato: "{filesystem}/{directory}/{subdirectory}/{file}".

content_settings: ContentSettings

Objeto ContentSettings usado para establecer propiedades de ruta de acceso.

source_lease: DataLakeLeaseClient o str

Identificador de concesión para la ruta de acceso de origen. Si se especifica, la ruta de acceso de origen debe tener una concesión activa y el identificador de concesión debe coincidir.

lease

Obligatorio si el archivo o directorio tiene una concesión activa. El valor puede ser un objeto LeaseClient o el identificador de concesión como una cadena.

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 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 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.

source_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 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 se ha modificado el recurso desde la hora especificada.

source_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.

source_etag: str

Valor ETag de origen o 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 .

source_match_condition: MatchConditions

Condición de coincidencia de origen 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 ni se valida en el cliente. Para configurar los tiempos de espera de red del lado cliente, consulte aquí.

Devoluciones

el cliente de archivo cuyo nombre ha cambiado

Tipo de valor devuelto

DataLakeFileClient

Ejemplos

Cambie el nombre del archivo de origen.


   new_client = file_client.rename_file(file_client.file_system_name + '/' + 'newname')

Establezca el propietario, el grupo, los permisos o la lista de control de acceso para una ruta de acceso.

set_access_control(owner: str | None = None, group: str | None = None, permissions: str | None = None, acl: str | None = None, **kwargs) -> Dict[str, str | datetime]

Parámetros

owner: str

Requerido

Opcional. Propietario del archivo o directorio.

group: str

Requerido

Opcional. Grupo propietario del archivo o directorio.

permissions: str

Requerido

Opcional y solo válido si el espacio de nombres jerárquico está habilitado para la cuenta. Establece los permisos de acceso POSIX para el propietario del archivo, el grupo propietario de archivos y otros. Se puede conceder permiso de lectura, escritura o ejecución a cada clase. También se admite el bit pegajoso. Se admiten tanto la notación simbólica (rwxrw-rw-) como la notación octal de 4 dígitos (por ejemplo, 0766). los permisos y la acl son mutuamente excluyentes.

acl: str

Requerido

Establece los derechos de control de acceso POSIX en archivos y directorios. El valor es una lista separada por comas de entradas de control de acceso. Cada entrada de control de acceso (ACE) consta de un ámbito, un tipo, un identificador de usuario o grupo y permisos con el formato "[ámbito:][tipo]:[id]:[permisos]". los permisos y la acl son mutuamente excluyentes.

lease: DataLakeLeaseClient o str

Obligatorio si el archivo o directorio tiene una concesión activa. El valor puede ser un objeto LeaseClient o el identificador de concesión como una cadena.

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 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 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í.

response dict

dict de respuesta (Etag y última modificación).

Establece el Access Control en una ruta de acceso y subrutas.

set_access_control_recursive(acl: str, **kwargs: Any) -> AccessControlChangeResult

Parámetros

acl: str

Requerido

Establece los derechos de control de acceso POSIX en archivos y directorios. El valor es una lista separada por comas de entradas de control de acceso. Cada entrada de control de acceso (ACE) consta de un ámbito, un tipo, un identificador de usuario o grupo y permisos con el formato "[ámbito:][tipo]:[id]:[permisos]".

progress_hook: <xref:func>(AccessControlChanges)

Devolución de llamada en la que el autor de la llamada puede realizar un seguimiento del progreso de la operación, así como recopilar rutas de acceso que no pudieron cambiar Access Control.

continuation_token: str

Token de continuación opcional que se puede usar para reanudar la operación detenida anteriormente.

batch_size: int

Opcional. Si el tamaño del conjunto de datos supera el tamaño del lote, la operación se dividirá en varias solicitudes para que se pueda realizar un seguimiento del progreso. El tamaño del lote debe estar comprendido entre 1 y 2000. El valor predeterminado cuando no se especifica es 2000.

max_batches: int

Opcional. Define el número máximo de lotes que se pueden ejecutar Access Control operación de cambio único. Si se alcanza el máximo antes de que se procesen todas las subdirecciones, se puede usar el token de continuación para reanudar la operación. El valor vacío indica que el número máximo de lotes en un enlace y la operación continúa hasta el final.

continue_on_failure: bool

Si se establece en False, la operación finalizará rápidamente al encontrar errores de usuario (4XX). Si es True, la operación omitirá los errores de usuario y continuará con la operación en otras subentidades del directorio. El token de continuación solo se devolverá cuando continue_on_failure sea True en caso de errores de usuario. Si no se establece el valor predeterminado es False para esto.

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

Resumen de las operaciones recursivas, incluido el recuento de éxitos y errores, así como un token de continuación en caso de que la operación se finalizara prematuramente.

Tipo de valor devuelto

AccessControlChangeResult

Excepciones

AzureError

El usuario puede reiniciar la operación mediante continuation_token campo azureError si el token está disponible.

Establece la hora en que expirará un archivo y se eliminará.

set_file_expiry(expiry_options: str, expires_on: datetime | int | None = None, **kwargs) -> None

Parámetros

expiry_options: str

Requerido

Necesario. Indica el modo de la hora de expiración. Entre los valores posibles se incluyen: 'NeverExpire', 'RelativeToCreation', 'RelativeToNow', 'Absolute'

expires_on: datetime o int

Requerido

Hora a la que se va a establecer el archivo en expiración. Cuando expiry_options es RelativeTo*, expires_on debe ser un valor int en milisegundos. Si el tipo de expires_on es datetime, debe estar en hora UTC.

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í.

Tipo de valor devuelto

None

Establece las propiedades del sistema en el archivo o directorio.

Si se establece una propiedad para el content_settings, se invalidarán todas las propiedades.

set_http_headers(content_settings: ContentSettings | None = None, **kwargs) -> Dict[str, Any]

Parámetros

content_settings: ContentSettings

Requerido

Objeto ContentSettings usado para establecer propiedades de archivo o directorio.

lease: DataLakeLeaseClient o str

Si se especifica, set_file_system_metadata solo se realiza correctamente si la concesión del sistema de archivos está activa y coincide con este identificador.

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 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 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

file/directory-updated property dict (Etag y last modified)

Tipo de valor devuelto

Dict[str, Any]

Establece uno o varios pares nombre-valor definidos por el usuario para el sistema de archivos especificado. Cada llamada a esta operación reemplaza todos los metadatos existentes adjuntos al sistema de archivos. Para quitar todos los metadatos del sistema de archivos, llame a esta operación sin dict de metadatos.

set_metadata(metadata: Dict[str, str], **kwargs) -> Dict[str, str | datetime]

Parámetros

metadata: Dict[str, str]

Requerido

Un dict que contiene pares nombre-valor que se van a asociar al sistema de archivos como metadatos. Ejemplo: {'category':'test'}

lease: DataLakeLeaseClient o str

Si se especifica, set_file_system_metadata solo se realiza correctamente si la concesión del sistema de archivos está activa y coincide con este identificador.

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 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 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.

cpk: CustomerProvidedEncryptionKey

Cifra los datos en el lado del servicio con la clave especificada. El uso de claves proporcionadas por el cliente debe realizarse a través de HTTPS.

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

dict de propiedad actualizada por el sistema de archivos (Etag y última modificación).

Modifica el Access Control en una ruta de acceso y subrutas.

update_access_control_recursive(acl: str, **kwargs: Any) -> AccessControlChangeResult

Parámetros

acl: str

Requerido

Modifica los derechos de control de acceso POSIX en archivos y directorios. El valor es una lista separada por comas de entradas de control de acceso. Cada entrada de control de acceso (ACE) consta de un ámbito, un tipo, un identificador de usuario o grupo y permisos con el formato "[ámbito:][tipo]:[id]:[permisos]".

progress_hook: <xref:func>(AccessControlChanges)

Devolución de llamada en la que el autor de la llamada puede realizar un seguimiento del progreso de la operación, así como recopilar rutas de acceso que no pudieron cambiar Access Control.

continuation_token: str

Token de continuación opcional que se puede usar para reanudar la operación detenida anteriormente.

batch_size: int

Opcional. Si el tamaño del conjunto de datos supera el tamaño del lote, la operación se dividirá en varias solicitudes para que se pueda realizar un seguimiento del progreso. El tamaño del lote debe estar comprendido entre 1 y 2000. El valor predeterminado cuando no se especifica es 2000.

max_batches: int

Opcional. Define el número máximo de lotes que se pueden ejecutar Access Control operación de cambio único. Si se alcanza el máximo antes de que se procesen todas las subdirecciones, se puede usar el token de continuación para reanudar la operación. El valor vacío indica que el número máximo de lotes en un enlace y la operación continúa hasta el final.

continue_on_failure: bool

Si se establece en False, la operación finalizará rápidamente al encontrar errores de usuario (4XX). Si es True, la operación omitirá los errores de usuario y continuará con la operación en otras subentidades del directorio. El token de continuación solo se devolverá cuando continue_on_failure sea True en caso de errores de usuario. Si no se establece el valor predeterminado es False para esto.

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

Resumen de las operaciones recursivas, incluido el recuento de éxitos y errores, así como un token de continuación en caso de que la operación se finalizara prematuramente.

Tipo de valor devuelto

AccessControlChangeResult

Excepciones

AzureError

El usuario puede reiniciar la operación mediante continuation_token campo azureError si el token está disponible.

Cargar datos en un archivo.

upload_data(data: bytes | str | Iterable | IO, length: int | None = None, overwrite: bool | None = False, **kwargs) -> Dict[str, Any]

Parámetros

data

Requerido

Contenido que se va a cargar en el archivo

length: int

Requerido

Tamaño de los datos en bytes.

overwrite: bool

Requerido

para sobrescribir un archivo existente o no.

content_settings: ContentSettings

Objeto ContentSettings usado para establecer propiedades de ruta de acceso.

metadata: Optional[Dict[str, str]]

Pares nombre-valor asociados al blob como metadatos.

lease: DataLakeLeaseClient o str

Obligatorio si el blob tiene una concesión activa. El valor puede ser un objeto DataLakeLeaseClient o el identificador de concesión como una cadena.

umask: str

Opcional y solo válido si el espacio de nombres jerárquico está habilitado para la cuenta. Al crear un archivo o directorio y la carpeta primaria no tiene una ACL predeterminada, el umask restringe los permisos del archivo o directorio que se va a crear. El permiso resultante se concede mediante p & ^u, donde p es el permiso y usted es el umask. Por ejemplo, si p es 0777 y es 0057, el permiso resultante es 0720. El permiso predeterminado es 0777 para un directorio y 0666 para un archivo. El umask predeterminado es 0027. El umask debe especificarse en notación octal de 4 dígitos (por ejemplo, 0766).

permissions: str

Opcional y solo válido si el espacio de nombres jerárquico está habilitado para la cuenta. Establece los permisos de acceso POSIX para el propietario del archivo, el grupo propietario de archivos y otros. Se puede conceder permiso de lectura, escritura o ejecución a cada clase. También se admite el bit pegajoso. Se admiten tanto la notación simbólica (rwxrw-rw-) como la notación octal de 4 dígitos (por ejemplo, 0766).

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 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 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.

validate_content: bool

Si es true, calcula un hash MD5 para cada fragmento del archivo. El servicio de almacenamiento comprueba el hash del contenido que ha llegado con el hash que se envió. Esto es principalmente útil para detectar bitflips en la conexión si se usa http en lugar de https, como https (el valor predeterminado), ya se validará. Tenga en cuenta que este hash MD5 no se almacena con el blob. Tenga en cuenta también que si está habilitado, el algoritmo de carga eficaz para memoria no se usará porque calcular el hash MD5 requiere almacenar en búfer bloques completos y, al hacerlo, se anula el propósito del algoritmo eficiente en memoria.

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.

cpk: CustomerProvidedEncryptionKey

Cifra los datos en el lado del servicio con la clave especificada. El uso de claves proporcionadas por el cliente debe realizarse a través de HTTPS.

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í. Este método puede realizar varias llamadas al servicio y el tiempo de espera se aplicará a cada llamada individualmente.

chunk_size: int

Tamaño máximo del fragmento para cargar un archivo en fragmentos. El valor predeterminado es100 10241024 o 100 MB.

encryption_context: str

Especifica el contexto de cifrado que se va a establecer en el archivo.

Devoluciones

dict de respuesta (Etag y última modificación).

La versión de la API de storage que se usa para las solicitudes.

Modo de ubicación que el cliente está usando actualmente.

De forma predeterminada, será "principal". Entre las opciones se incluyen "primary" y "secondary".

Dirección URL completa del punto de conexión principal.

Nombre de host del punto de conexión principal.

Dirección URL completa del punto de conexión secundario si está configurada.

Si no está disponible, se generará un valor ValueError. Para especificar explícitamente un nombre de host secundario, use el argumento opcional secondary_hostname palabra clave en la creación de instancias.

Excepciones

ValueError

El nombre de host del punto de conexión secundario.

Si no está disponible, será Ninguno. Para especificar explícitamente un nombre de host secundario, use el argumento opcional secondary_hostname palabra clave en la creación de instancias.

Dirección URL completa del punto de conexión a esta entidad, incluido el token de SAS si se usa.

Puede ser el punto de conexión principal o el punto de conexión secundario en función del actual location_mode. :returns: la dirección URL completa del punto de conexión a esta entidad, incluido el token de SAS si se usa. :rtype: str

acquire_lease	Solicita una nueva concesión. Si el archivo o directorio no tiene una concesión activa, el servicio DataLake crea una concesión en el archivo o directorio y devuelve un nuevo identificador de concesión.
append_data	Anexe datos al archivo.
close	Este método consiste en cerrar los sockets abiertos por el cliente. No es necesario usarse cuando se usa con un administrador de contextos.
create_file	Cree un archivo.
delete_file	Marca el archivo especificado para su eliminación.
download_file	Descarga un archivo en StorageStreamDownloader. El método readall() debe usarse para leer todo el contenido, o readinto() debe usarse para descargar el archivo en una secuencia. El uso de chunks() devuelve un iterador que permite al usuario iterar el contenido en fragmentos.
exists	Devuelve True si existe un archivo y devuelve False de lo contrario.
flush_data	Confirme los datos anexados anteriores.
from_connection_string	Cree DataLakeFileClient a partir de una cadena de conexión. :return a DataLakeFileClient :rtype ~azure.storage.filedatalake.DataLakeFileClient
get_access_control
get_file_properties	Devuelve todos los metadatos definidos por el usuario, las propiedades HTTP estándar y las propiedades del sistema para el archivo. No devuelve el contenido del archivo.
query_file	Permite a los usuarios seleccionar o proyectar en los datos del archivo datalake proporcionando expresiones de consulta simples. Esta operación devuelve un DataLakeFileQueryReader, los usuarios deben usar readall() o readinto() para obtener datos de consulta.
remove_access_control_recursive	Quita el Access Control en una ruta de acceso y subrutas.
rename_file	Cambie el nombre del archivo de origen.
set_access_control	Establezca el propietario, el grupo, los permisos o la lista de control de acceso para una ruta de acceso.
set_access_control_recursive	Establece el Access Control en una ruta de acceso y subrutas.
set_file_expiry	Establece la hora en que expirará un archivo y se eliminará.
set_http_headers	Establece las propiedades del sistema en el archivo o directorio. Si se establece una propiedad para el content_settings, se invalidarán todas las propiedades.
set_metadata	Establece uno o varios pares nombre-valor definidos por el usuario para el sistema de archivos especificado. Cada llamada a esta operación reemplaza todos los metadatos existentes adjuntos al sistema de archivos. Para quitar todos los metadatos del sistema de archivos, llame a esta operación sin dict de metadatos.
update_access_control_recursive	Modifica el Access Control en una ruta de acceso y subrutas.
upload_data	Cargar datos en un archivo.

Compartir a través de

DataLakeFileClient Clase

Constructor

Parámetros

Ejemplos

Variables

Métodos

acquire_lease

Parámetros

Devoluciones

Tipo de valor devuelto

append_data

Parámetros

Devoluciones

Ejemplos

close

create_file

Parámetros

Devoluciones

Ejemplos

delete_file

Parámetros

Devoluciones

Ejemplos

download_file

Parámetros

Devoluciones

Tipo de valor devuelto

Ejemplos

exists

Parámetros

Devoluciones

Tipo de valor devuelto

flush_data

Parámetros

Devoluciones

Ejemplos

from_connection_string

Parámetros

get_access_control

Parámetros

get_file_properties

Parámetros

Devoluciones

Tipo de valor devuelto

Ejemplos

query_file

Parámetros

Devoluciones

Tipo de valor devuelto

Ejemplos

remove_access_control_recursive

Parámetros

Devoluciones

Tipo de valor devuelto

Excepciones

rename_file

Parámetros

Devoluciones

Tipo de valor devuelto

Ejemplos

set_access_control

Parámetros

set_access_control_recursive

Parámetros

Devoluciones

Tipo de valor devuelto

Excepciones

set_file_expiry

Parámetros

Tipo de valor devuelto

set_http_headers

Parámetros

Devoluciones

Tipo de valor devuelto

set_metadata

Parámetros

Devoluciones

update_access_control_recursive

Parámetros