azure.storage.filedatalake.DataLakeDirectoryClient 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. Una duración de concesión no se puede cambiar 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 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

Un objeto DataLakeLeaseClient, que se puede ejecutar en un administrador de contexto.

Tipo de valor devuelto

DataLakeLeaseClient

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

close() -> None

Cree un nuevo directorio.

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

Parámetros

metadata: dict(str, str)

Requerido

Pares nombre-valor asociados al archivo como metadatos.

content_settings: ContentSettings

Objeto ContentSettings usado para establecer propiedades de ruta de acceso.

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.

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

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.

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

Devoluciones

Diccionario de encabezados de respuesta.

Tipo de valor devuelto

Dict[str, Union[str, datetime]]

Ejemplos

Cree un directorio.


   directory_client.create_directory()

Cree un nuevo archivo y devuelva el cliente de archivos con el que se va a interactuar.

create_file(file: FileProperties | str, **kwargs) -> DataLakeFileClient

Parámetros

file: str o FileProperties

Requerido

Archivo con el que se va a interactuar. Puede ser el nombre del archivo o una instancia de FileProperties.

content_settings: ContentSettings

Objeto ContentSettings usado para establecer propiedades de ruta de acceso.

metadata

Pares nombre-valor asociados al archivo como metadatos.

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.

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

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

Devoluciones

DataLakeFileClient

Cree un subdirectorio y devuelva el cliente de subdirectorio con el que se va a interactuar.

create_sub_directory(sub_directory: DirectoryProperties | str, metadata: Dict[str, str] | None = None, **kwargs) -> DataLakeDirectoryClient

Parámetros

sub_directory: str o DirectoryProperties

Requerido

Directorio con el que se va a interactuar. Puede ser el nombre del directorio o una instancia de DirectoryProperties.

metadata: dict(str, str)

Requerido

Pares nombre-valor asociados al archivo como metadatos.

content_settings: ContentSettings

Objeto ContentSettings usado para establecer propiedades de ruta de acceso.

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.

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

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.

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

Devoluciones

DataLakeDirectoryClient para el subdirectorio.

Marca el directorio especificado para su eliminación.

delete_directory(**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 directorio.


   new_directory.delete_directory()

Marca el subdirectorio especificado para su eliminación.

delete_sub_directory(sub_directory: DirectoryProperties | str, **kwargs) -> DataLakeDirectoryClient

Parámetros

sub_directory: str o DirectoryProperties

Requerido

Directorio con el que se va a interactuar. Puede ser el nombre del directorio o una instancia de DirectoryProperties.

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

DataLakeDirectoryClient para el subdirectorio

Devuelve True si existe un directorio 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 ni se valida en el cliente. Para configurar los tiempos de espera de red del lado cliente, consulte aquí.

Devoluciones

True si existe un directorio, False en caso contrario.

Tipo de valor devuelto

bool

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

from_connection_string(conn_str: str, file_system_name: str, directory_name: 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 se va a interactuar.

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. 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. Si el URI del recurso ya contiene un token de SAS, se omitirá en favor de una credencial explícita.

excepto en el caso de AzureSasCredential, donde los tokens de SAS en conflicto generarán un valor ValueError. 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.

directory_name: str

Requerido

Nombre del directorio con el que se va a interactuar. El directorio está en el sistema de archivos.

credential

Requerido

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.

Devoluciones

dataLakeDirectoryClient

Tipo de valor devuelto

DataLakeDirectoryClient

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

response dict.

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

get_directory_properties(**kwargs: Any) -> DirectoryProperties

Parámetros

lease: DataLakeLeaseClient o str

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

Tipo de valor devuelto

DirectoryProperties

Ejemplos

Obtener las propiedades de un archivo o directorio.


   props = new_directory.get_directory_properties()

Obtener un cliente para interactuar con el archivo especificado.

El archivo aún no existe.

get_file_client(file: FileProperties | str) -> DataLakeFileClient

Parámetros

file: str o FileProperties

Requerido

Archivo con el que se va a interactuar. Puede ser el nombre del archivo o una instancia de FileProperties. Eg. directory/subdirectory/file

Devoluciones

A DataLakeFileClient.

Tipo de valor devuelto

DataLakeFileClient

Obtenga un cliente para interactuar con el subdirectorio especificado del directorio actual.

El subdirectorio secundario aún no debe existir.

get_sub_directory_client(sub_directory: DirectoryProperties | str) -> DataLakeDirectoryClient

Parámetros

sub_directory: str o DirectoryProperties

Requerido

Directorio con el que se va a interactuar. Puede ser el nombre del directorio o una instancia de DirectoryProperties.

Devoluciones

A DataLakeDirectoryClient.

Tipo de valor devuelto

DataLakeDirectoryClient

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 directorio de origen.

rename_directory(new_name: str, **kwargs: Any) -> DataLakeDirectoryClient

Parámetros

new_name: str

Requerido

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

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

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 un seguimiento ni se valida en el cliente. Para configurar tiempos de espera de red del lado cliente, consulte aquí.

Devoluciones

DataLakeDirectoryClient

Ejemplos

Cambie el nombre del directorio de origen.


   new_dir_name = "testdir2"
   print("Renaming the directory named '{}' to '{}'.".format(dir_name, new_dir_name))
   new_directory = directory_client\
       .rename_directory(new_name=directory_client.file_system_name + '/' + new_dir_name)

Establezca la lista de propietarios, grupos, permisos o 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 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 (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 previamente.

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 especificado 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 unbound 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 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 un seguimiento ni se valida en el cliente. Para configurar 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 las propiedades del sistema en el archivo o directorio.

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

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

archivo/directorio-actualizado propiedad dict (Etag y última modificación)

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

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

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

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 especificado 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 unbound 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 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 un seguimiento ni se valida en el cliente. Para configurar 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.

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". Las opciones 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

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 según el 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.
close	Este método es cerrar los sockets abiertos por el cliente. No es necesario usarse cuando se usa con un administrador de contexto.
create_directory	Cree un nuevo directorio.
create_file	Cree un nuevo archivo y devuelva el cliente de archivos con el que se va a interactuar.
create_sub_directory	Cree un subdirectorio y devuelva el cliente de subdirectorio con el que se va a interactuar.
delete_directory	Marca el directorio especificado para su eliminación.
delete_sub_directory	Marca el subdirectorio especificado para su eliminación.
exists	Devuelve True si existe un directorio y devuelve False de lo contrario.
from_connection_string	Cree DataLakeDirectoryClient a partir de una cadena de conexión.
get_access_control
get_directory_properties	Devuelve todos los metadatos definidos por el usuario, las propiedades HTTP estándar y las propiedades del sistema para el directorio. No devuelve el contenido del directorio.
get_file_client	Obtener un cliente para interactuar con el archivo especificado. El archivo aún no existe.
get_sub_directory_client	Obtenga un cliente para interactuar con el subdirectorio especificado del directorio actual. El subdirectorio secundario aún no debe existir.
remove_access_control_recursive	Quita el Access Control en una ruta de acceso y subrutas.
rename_directory	Cambie el nombre del directorio de origen.
set_access_control	Establezca la lista de propietarios, grupos, permisos o control de acceso para una ruta de acceso.
set_access_control_recursive	Establece el Access Control en una ruta de acceso y subrutas.
set_http_headers	Establece las propiedades del sistema en el archivo o directorio. Si se establece una propiedad para el content_settings, todas las propiedades se invalidarán.
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.

Compartir a través de

DataLakeDirectoryClient Clase

Constructor

Parámetros

Ejemplos

Variables

Métodos

acquire_lease

Parámetros

Devoluciones

Tipo de valor devuelto

close

create_directory

Parámetros

Devoluciones

Tipo de valor devuelto

Ejemplos

create_file

Parámetros

Devoluciones

create_sub_directory

Parámetros

Devoluciones

delete_directory

Parámetros

Devoluciones

Ejemplos

delete_sub_directory

Parámetros

Devoluciones

exists

Parámetros

Devoluciones

Tipo de valor devuelto

from_connection_string

Parámetros

Devoluciones

Tipo de valor devuelto

get_access_control

Parámetros

get_directory_properties

Parámetros

Tipo de valor devuelto

Ejemplos

get_file_client

Parámetros

Devoluciones

Tipo de valor devuelto

get_sub_directory_client

Parámetros

Devoluciones

Tipo de valor devuelto

remove_access_control_recursive

Parámetros

Devoluciones

Tipo de valor devuelto

Excepciones

rename_directory

Parámetros

Devoluciones

Ejemplos

set_access_control

Parámetros

set_access_control_recursive

Parámetros

Devoluciones

Tipo de valor devuelto

Excepciones

set_http_headers

Parámetros

Devoluciones

Tipo de valor devuelto

set_metadata

Parámetros

Devoluciones

update_access_control_recursive

Parámetros

Devoluciones

Tipo de valor devuelto

Excepciones