FileSystemClient Clase

Referencia

Un cliente para interactuar con un sistema de archivos específico, incluso si es posible que ese sistema de archivos aún no exista.

Para las operaciones relacionadas con un directorio o archivo específicos dentro de este sistema de archivos, se puede recuperar un cliente de directorio o un cliente de archivos mediante las get_directory_client funciones o get_file_client .

Herencia: azure.storage.filedatalake._shared.base_client.StorageAccountHostsMixin

FileSystemClient

Constructor

FileSystemClient(account_url: str, file_system_name: str, credential: str | Dict[str, str] | AzureNamedKeyCredential | AzureSasCredential | TokenCredential | None = None, **kwargs: Any)

Parámetros

account_url: str

Requerido

Identificador URI de la cuenta de almacenamiento.

file_system_name: str

Requerido

Sistema de archivos para el directorio o los archivos.

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.

api_version: str

La versión de la API de storage que se va a usar para las solicitudes. El valor predeterminado es la versión de servicio más reciente que es compatible con el SDK actual. Establecer en una versión anterior puede dar lugar a una compatibilidad de características reducida.

Ejemplos

Obtenga un objeto FileSystemClient de un dataLakeServiceClient existente.


   # Instantiate a DataLakeServiceClient using a connection string
   from azure.storage.filedatalake import DataLakeServiceClient
   datalake_service_client = DataLakeServiceClient.from_connection_string(self.connection_string)

   # Instantiate a FileSystemClient
   file_system_client = datalake_service_client.get_file_system_client("mynewfilesystem")

Variables

url: str

Dirección URL completa del punto de conexión al sistema de archivos, incluido el token de SAS si se usa.

primary_endpoint: str

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

primary_hostname: str

Nombre de host del punto de conexión principal.

Métodos

acquire_lease	Solicita una nueva concesión. Si el sistema de archivos no tiene una concesión activa, el servicio DataLake crea una concesión en el sistema de archivos y devuelve un nuevo identificador de concesión.
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_directory	Creación del directorio
create_file	Crear archivo
create_file_system	Crea un nuevo sistema de archivos en la cuenta especificada. Si el sistema de archivos con el mismo nombre ya existe, se generará un resourceExistsError. Este método devuelve un cliente con el que interactuar con el sistema de archivos recién creado.
delete_directory	Marca la ruta de acceso especificada para su eliminación.
delete_file	Marca el archivo especificado para su eliminación.
delete_file_system	Marca el sistema de archivos especificado para su eliminación. El sistema de archivos y los archivos contenidos en él se eliminan posteriormente durante la recolección de elementos no utilizados. Si no se encuentra el sistema de archivos, se generará un resourceNotFoundError.
exists	Devuelve True si existe un sistema de archivos y devuelve False de lo contrario.
from_connection_string	Cree FileSystemClient a partir de una cadena de conexión. :return a FileSystemClient :rtype ~azure.storage.filedatalake.FileSystemClient
get_directory_client	Obtener un cliente para interactuar con el directorio especificado. El directorio aún no necesita existir.
get_file_client	Obtener un cliente para interactuar con el archivo especificado. El archivo aún no necesita existir.
get_file_system_access_policy	Obtiene los permisos para el sistema de archivos especificado. Los permisos indican si se puede acceder a los datos del sistema de archivos públicamente.
get_file_system_properties	Devuelve todos los metadatos definidos por el usuario y las propiedades del sistema para el sistema de archivos especificado. Los datos devueltos no incluyen la lista de rutas de acceso del sistema de archivos.
get_paths	Devuelve un generador para enumerar las rutas de acceso (podrían ser archivos o directorios) en el sistema de archivos especificado. El generador seguirá de forma diferida los tokens de continuación devueltos por el servicio.
list_deleted_paths	Devuelve un generador para enumerar las rutas de acceso eliminadas (archivo o directorio) en el sistema de archivos especificado. El generador seguirá de forma diferida los tokens de continuación devueltos por el servicio. Novedad de la versión 12.4.0: esta operación se introdujo en la versión de API "2020-06-12".
set_file_system_access_policy	Establece los permisos para el sistema de archivos especificado o las directivas de acceso almacenadas que se pueden usar con firmas de acceso compartido. Los permisos indican si se puede acceder a los archivos de un sistema de archivos públicamente.
set_file_system_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.

acquire_lease

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

acquire_lease(lease_duration: int = -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

Ejemplos

Adquirir una concesión en el sistema de archivos.


   # Acquire a lease on the file system
   lease = file_system_client.acquire_lease()

   # Delete file system by passing in the lease
   file_system_client.delete_file_system(lease=lease)

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.

close() -> None

create_directory

Creación del directorio

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

Parámetros

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

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 valor predeterminado de umask 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

lease_duration: int

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

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.

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

Ejemplos

Cree un directorio en el sistema de archivos.


   directory_client = file_system_client.create_directory("mydirectory")

create_file

Crear archivo

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

Requerido

Objeto ContentSettings usado para establecer propiedades de ruta de acceso.

metadata: dict(str, str)

Requerido

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

lease_id: str

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

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

DataLakeFileClient

Ejemplos

Cree un archivo en el sistema de archivos.


   file_client = file_system_client.create_file("myfile")

create_file_system

Crea un nuevo sistema de archivos en la cuenta especificada.

Si el sistema de archivos con el mismo nombre ya existe, se generará un resourceExistsError. Este método devuelve un cliente con el que interactuar con el sistema de archivos recién creado.

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

Parámetros

metadata: dict(str, str)

Requerido

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

public_access: PublicAccess

Requerido

Para especificar si se puede acceder a los datos del sistema de archivos públicamente y el nivel de acceso.

encryption_scope_options: dict o EncryptionScopeOptions

Especifica el ámbito de cifrado predeterminado que se va a establecer en el sistema de archivos y usarlo para todas las escrituras futuras.

Novedad de la versión 12.9.0.

timeout: int

Establece el tiempo de espera del lado servidor para la operación en segundos. Para más información, consulte https://learn.microsoft.com/rest/api/storageservices/setting-timeouts-for-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

Creación de un sistema de archivos en el servicio datalake.


   file_system_client.create_file_system()

delete_directory

Marca la ruta de acceso especificada para su eliminación.

delete_directory(directory: DirectoryProperties | str, **kwargs) -> DataLakeDirectoryClient

Parámetros

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

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

Ejemplos

Elimine el directorio en el sistema de archivos.


   file_system_client.delete_directory("mydirectory")

delete_file

Marca el archivo especificado para su eliminación.

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

lease: DataLakeLeaseClient o str

Requerido 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

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

Devoluciones

DataLakeFileClient

Ejemplos

Elimine el archivo en el sistema de archivos.


   file_system_client.delete_file("myfile")

delete_file_system

Marca el sistema de archivos especificado para su eliminación.

El sistema de archivos y los archivos contenidos en él se eliminan posteriormente durante la recolección de elementos no utilizados. Si no se encuentra el sistema de archivos, se generará un resourceNotFoundError.

delete_file_system(**kwargs: Any) -> None

Parámetros

lease: str o DataLakeLeaseClient

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

if_modified_since: datetime

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

Tipo de valor devuelto

None

Ejemplos

Eliminación de un sistema de archivos en el servicio datalake.


   file_system_client.delete_file_system()

exists

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

exists(**kwargs: Any) -> bool

Parámetros

timeout: int

Devoluciones

True si existe un sistema de archivos, False en caso contrario.

Tipo de valor devuelto

bool

from_connection_string

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

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

from_connection_string(conn_str: str, file_system_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 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 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.

Ejemplos

Creación de FileSystemClient a partir de la cadena de conexión


   from azure.storage.filedatalake import FileSystemClient
   file_system_client = FileSystemClient.from_connection_string(self.connection_string, "filesystem")

get_directory_client

Obtener un cliente para interactuar con el directorio especificado.

El directorio aún no necesita existir.

get_directory_client(directory: DirectoryProperties | str) -> DataLakeDirectoryClient

Parámetros

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

Ejemplos

Obtener el cliente de directorio para interactuar con un directorio específico.


   # Get the DataLakeDirectoryClient from the FileSystemClient to interact with a specific file
   directory_client = file_system_client.get_directory_client("mynewdirectory")

get_file_client

Obtener un cliente para interactuar con el archivo especificado.

El archivo aún no necesita existir.

get_file_client(file_path: FileProperties | str) -> DataLakeFileClient

Parámetros

file_path: str o FileProperties

Requerido

Archivo con el que se va a interactuar. Puede ser la ruta de acceso del archivo (desde el directorio raíz) o una instancia de FileProperties. Eg. directory/subdirectory/file

Devoluciones

A DataLakeFileClient.

Tipo de valor devuelto

DataLakeFileClient

Ejemplos

Obtención del cliente de archivos para interactuar con un archivo específico.


   # Get the FileClient from the FileSystemClient to interact with a specific file
   file_client = file_system_client.get_file_client("mynewfile")

get_file_system_access_policy

Obtiene los permisos para el sistema de archivos especificado. Los permisos indican si se puede acceder a los datos del sistema de archivos públicamente.

get_file_system_access_policy(**kwargs: Any) -> Dict[str, Any]

Parámetros

lease: DataLakeLeaseClient o str

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

timeout: int

Devoluciones

Información de la directiva de acceso en un dict.

Tipo de valor devuelto

dict[str, Any]

get_file_system_properties

Devuelve todos los metadatos definidos por el usuario y las propiedades del sistema para el sistema de archivos especificado. Los datos devueltos no incluyen la lista de rutas de acceso del sistema de archivos.

get_file_system_properties(**kwargs: Any) -> FileSystemProperties

Parámetros

lease: str o DataLakeLeaseClient

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

timeout: int

Devoluciones

Propiedades del sistema de archivos especificado dentro de un objeto de sistema de archivos.

Tipo de valor devuelto

FileSystemProperties

Ejemplos

Obtención de propiedades en el sistema de archivos.


   properties = file_system_client.get_file_system_properties()

get_paths

Devuelve un generador para enumerar las rutas de acceso (podrían ser archivos o directorios) en el sistema de archivos especificado. El generador seguirá de forma diferida los tokens de continuación devueltos por el servicio.

get_paths(path: str | None = None, recursive: bool | None = True, max_results: int | None = None, **kwargs) -> ItemPaged[PathProperties]

Parámetros

path: str

Requerido

Filtra los resultados para devolver solo las rutas de acceso en la ruta de acceso especificada.

recursive: Optional[bool]

Requerido

Opcional. Establezca True para recursivo, False para iterativo.

max_results: int

Requerido

Valor opcional que especifica el número máximo de elementos que se van a devolver por página. Si se omite o mayor que 5000, la respuesta incluirá hasta 5000 elementos por página.

upn

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.

timeout: int

Devoluciones

Respuesta iterable (paginación automática) de PathProperties.

Tipo de valor devuelto

ItemPaged[PathProperties]

Ejemplos

Enumere las rutas de acceso en el sistema de archivos.


   path_list = file_system_client.get_paths()
   for path in path_list:
       print(path.name + '\n')

list_deleted_paths

Devuelve un generador para enumerar las rutas de acceso eliminadas (archivo o directorio) en el sistema de archivos especificado. El generador seguirá de forma diferida los tokens de continuación devueltos por el servicio.

Novedad de la versión 12.4.0: esta operación se introdujo en la versión de API "2020-06-12".

list_deleted_paths(**kwargs: Any) -> ItemPaged[DeletedPathProperties]

Parámetros

path_prefix: str

Filtra los resultados para devolver solo las rutas de acceso en la ruta de acceso especificada.

results_per_page: int

Valor opcional que especifica el número máximo de elementos que se van a devolver por página. Si se omite o mayor que 5000, la respuesta incluirá hasta 5000 elementos por página.

timeout: int

Devoluciones

Respuesta iterable (paginación automática) de DeletedPathProperties.

Tipo de valor devuelto

ItemPaged[DeletedPathProperties]

set_file_system_access_policy

Establece los permisos para el sistema de archivos especificado o las directivas de acceso almacenadas que se pueden usar con firmas de acceso compartido. Los permisos indican si se puede acceder a los archivos de un sistema de archivos públicamente.

set_file_system_access_policy(signed_identifiers: Dict[str, AccessPolicy], public_access: str | PublicAccess | None = None, **kwargs) -> Dict[str, str | datetime]

Parámetros

signed_identifiers: dict[str, AccessPolicy]

Requerido

Diccionario de directivas de acceso que se van a asociar al sistema de archivos. El diccionario puede contener hasta 5 elementos. Un diccionario vacío borrará las directivas de acceso establecidas en el servicio.

public_access: PublicAccess

Requerido

Para especificar si se puede acceder a los datos del sistema de archivos públicamente y el nivel de acceso.

lease: DataLakeLeaseClient o str

Necesario si el sistema de archivos 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

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 el recurso se ha modificado desde la fecha y hora especificadas.

if_unmodified_since: datetime

Valor datetime. Azure espera que el valor de fecha pasado sea UTC. Si se incluye la zona horaria, las fechas no UTC se convertirán a UTC. Si se pasa una fecha sin información de zona horaria, se supone que es UTC. Especifique este encabezado para realizar la operación solo si no se ha modificado el recurso desde la fecha u hora especificada.

timeout: int

Devoluciones

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

Tipo de valor devuelto

dict[str, str,

datetime]

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

set_file_system_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: str o DataLakeLeaseClient

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

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

Devoluciones

filesystem-updated property dict (Etag y last modified).

Tipo de valor devuelto

Dict[str, str]

Ejemplos

Establecer metadatos en el sistema de archivos.


   # Create key, value pairs for metadata
   metadata = {'type': 'test'}

   # Set metadata on the file system
   file_system_client.set_file_system_metadata(metadata=metadata)

Atributos

api_version

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

location_mode

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

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

primary_endpoint

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

primary_hostname

Nombre de host del punto de conexión principal.

secondary_endpoint

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

secondary_hostname

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.

url

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

Compartir a través de

FileSystemClient Clase

Constructor

Parámetros

Ejemplos

Variables

Métodos

acquire_lease

Parámetros

Devoluciones

Tipo de valor devuelto

Ejemplos

close

create_directory

Parámetros

Devoluciones

Ejemplos

create_file

Parámetros

Devoluciones

Ejemplos

create_file_system

Parámetros

Devoluciones

Tipo de valor devuelto

Ejemplos

delete_directory

Parámetros

Devoluciones

Ejemplos

delete_file

Parámetros

Devoluciones

Ejemplos

delete_file_system

Parámetros

Tipo de valor devuelto

Ejemplos

exists

Parámetros

Devoluciones

Tipo de valor devuelto

from_connection_string

Parámetros

Ejemplos

get_directory_client

Parámetros

Devoluciones

Tipo de valor devuelto

Ejemplos

get_file_client

Parámetros

Devoluciones

Tipo de valor devuelto

Ejemplos

get_file_system_access_policy

Parámetros

Devoluciones

Tipo de valor devuelto

get_file_system_properties

Parámetros

Devoluciones

Tipo de valor devuelto

Ejemplos

get_paths

Parámetros

Devoluciones

Tipo de valor devuelto

Ejemplos

list_deleted_paths

Parámetros

Devoluciones

Tipo de valor devuelto

set_file_system_access_policy

Parámetros

Devoluciones

Tipo de valor devuelto

set_file_system_metadata

Parámetros

Devoluciones