azure.storage.filedatalake.DataLakeFileClient class

Demande un nouveau bail. Si le fichier ou le répertoire n’a pas de bail actif, le service DataLake crée un bail sur le fichier/répertoire et retourne un nouvel ID de bail.

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

Paramètres

lease_duration: int

Obligatoire

Spécifie la durée de bail, en secondes, ou moins un (- 1) pour un bail qui n'expire jamais. Un bail qui n'est pas infini peut durer entre 15 et 60 secondes. La durée d’un bail ne peut pas être modifiée à l’aide du renouvellement ou de la modification. La valeur par défaut est -1 (bail infini).

lease_id: str

Obligatoire

ID de bail proposé, dans un format de chaîne GUID. Le service DataLake retourne 400 (requête non valide) si l’ID de bail proposé n’est pas au format correct.

if_modified_since: datetime

Valeur DateTime. Azure s’attend à ce que la valeur de date transmise soit UTC. Si le fuseau horaire est inclus, toutes les dates-heures non UTC seront converties en UTC. Si une date est transmise sans informations de fuseau horaire, elle est supposée être UTC. Spécifiez cet en-tête pour exécuter l'opération uniquement si la ressource a été modifiée depuis le temps indiqué.

if_unmodified_since: datetime

Valeur DateTime. Azure s’attend à ce que la valeur de date transmise soit UTC. Si le fuseau horaire est inclus, toutes les dates-heures non UTC seront converties en UTC. Si une date est transmise sans informations de fuseau horaire, elle est supposée être UTC. Spécifiez cet en-tête pour exécuter l'opération uniquement si la ressource n'a pas été modifiée depuis la date/l'heure indiquées.

etag: str

Spécifiez une valeur ETag ou le caractère générique *. Permet de case activée si la ressource a changé et d’agir en fonction de la condition spécifiée par le paramètre match_condition.

match_condition: MatchConditions

Condition de correspondance à utiliser sur l’etag.

timeout: int

Définit le délai d’attente côté serveur pour l’opération en secondes. Pour plus d’informations, consultez https://learn.microsoft.com/rest/api/storageservices/setting-timeouts-for-blob-service-operations. Cette valeur n’est pas suivie ou validée sur le client. Pour configurer les délais d’expiration du réseau côté client, consultez ici.

Retours

Objet DataLakeLeaseClient, qui peut être exécuté dans un gestionnaire de contexte.

Type de retour

DataLakeLeaseClient

Ajoutez des données au fichier.

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

Paramètres

data

Obligatoire

Contenu à ajouter au fichier

offset

Obligatoire

position de début des données à ajouter.

length

Obligatoire

Taille des données en octets.

flush: bool

Si la valeur est true, valide les données une fois qu’elles ont été ajoutées.

validate_content: bool

Si la valeur est true, calcule un hachage MD5 du contenu du bloc. Le service de stockage vérifie le hachage du contenu qui est arrivé avec le hachage envoyé. Cela est principalement utile pour la détection de bitflips sur le câble si l’utilisation de http au lieu de https comme https (la valeur par défaut) est déjà validée. Notez que ce hachage MD5 n’est pas stocké avec le fichier.

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

Utilisé pour effectuer des opérations de bail ainsi que l’ajout de données.

« acquérir » : acquérir un bail. « renouvellement automatique » : renouvelez un bail existant. « release » : libérez le bail une fois l’opération terminée. Nécessite flush=True. « acquire-release » : acquérir un bail et le libérer une fois les opérations terminées. Nécessite flush=True.

lease_duration: int

Valide si lease_action est défini sur « acquire » ou « acquire-release ».

Spécifie la durée de bail, en secondes, ou moins un (- 1) pour un bail qui n'expire jamais. Un bail qui n'est pas infini peut durer entre 15 et 60 secondes. La durée d’un bail ne peut pas être modifiée à l’aide du renouvellement ou de la modification. La valeur par défaut est -1 (bail infini).

lease: DataLakeLeaseClient ou str

Obligatoire si le fichier a un bail actif ou si lease_action est défini sur « acquire » ou « acquire-release ». Si le fichier a un bail existant, celui-ci sera utilisé pour accéder au fichier. En cas d’acquisition d’un nouveau bail, celui-ci sera utilisé comme nouvel ID de bail. La valeur peut être un objet DataLakeLeaseClient ou l’ID de bail sous forme de chaîne.

cpk: CustomerProvidedEncryptionKey

Chiffre les données côté service avec la clé donnée. L’utilisation des clés fournies par le client doit être effectuée via HTTPS.

Retours

dict de l’en-tête de réponse

Exemples

Ajoutez des données au fichier.


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

Cette méthode consiste à fermer les sockets ouverts par le client. Il n’a pas besoin d’être utilisé lors de l’utilisation avec un gestionnaire de contexte.

close() -> None

Créez un fichier.

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

Paramètres

content_settings: ContentSettings

Obligatoire

Objet ContentSettings utilisé pour définir les propriétés de chemin d’accès.

metadata: Optional[Dict[str, str]]

Obligatoire

Paires nom-valeur associées au fichier en tant que métadonnées.

lease: DataLakeLeaseClient ou str

Obligatoire si le fichier a un bail actif. La valeur peut être un objet DataLakeLeaseClient ou l’ID de bail sous forme de chaîne.

umask: str

Facultatif et valide uniquement si l’espace de noms hiérarchique est activé pour le compte. Lors de la création d’un fichier ou d’un répertoire et que le dossier parent n’a pas de liste de contrôle d’accès par défaut, l’umask limite les autorisations du fichier ou du répertoire à créer. L’autorisation résultante est donnée par p & ^u, où p est l’autorisation et vous êtes l’umask. Par exemple, si p est 0777 et que vous avez la valeur 0057, l’autorisation résultante est 0720. L’autorisation par défaut est 0777 pour un répertoire et 0666 pour un fichier. L’umask par défaut est 0027. L’umask doit être spécifié en notation octale à 4 chiffres (par exemple, 0766).

owner: str

Propriétaire du fichier ou du répertoire.

group: str

Groupe propriétaire du fichier ou du répertoire.

acl: str

Définit les droits de contrôle d’accès POSIX sur les fichiers et les répertoires. La valeur est une liste d’entrées de contrôle d’accès séparées par des virgules. Chaque entrée de contrôle d’accès (ACE) se compose d’une étendue, d’un type, d’un identificateur d’utilisateur ou de groupe et d’autorisations au format « [scope:][type]:[id]:[permissions] ».

lease_id: str

ID de bail proposé, dans un format de chaîne GUID. Le service DataLake retourne 400 (requête non valide) si l’ID de bail proposé n’est pas au format correct.

lease_duration: int

Spécifie la durée de bail, en secondes, ou moins un (- 1) pour un bail qui n'expire jamais. Un bail qui n'est pas infini peut durer entre 15 et 60 secondes. Une durée de bail ne peut pas être modifiée à l’aide du renouvellement ou de la modification.

expires_on: datetime ou int

Délai de définition de l’expiration du fichier. Si le type de expires_on est un int, l’heure d’expiration est définie comme le nombre de millisecondes écoulées à partir de l’heure de création. Si le type d’expires_on est datetime, l’heure d’expiration est définie comme absolue sur l’heure fournie. Si aucune information de fuseau horaire n’est fournie, cela sera interprété comme UTC.

permissions: str

Facultatif et valide uniquement si l’espace de noms hiérarchique est activé pour le compte. Définit les autorisations d’accès POSIX pour le propriétaire du fichier, le groupe propriétaire du fichier, etc. Chaque classe peut se voir accorder l’autorisation de lecture, d’écriture ou d’exécution. Le bit collant est également pris en charge. La notation symbolique (rwxrw-rw-) et la notation octal à 4 chiffres (par exemple, 0766) sont prises en charge.

if_modified_since: datetime

Valeur DateTime. Azure s’attend à ce que la valeur de date passée soit UTC. Si le fuseau horaire est inclus, toutes les datetimes non UTC sont converties en UTC. Si une date est passée sans informations de fuseau horaire, elle est supposée être UTC. Spécifiez cet en-tête pour exécuter l'opération uniquement si la ressource a été modifiée depuis le temps indiqué.

if_unmodified_since: datetime

Valeur DateTime. Azure s’attend à ce que la valeur de date passée soit UTC. Si le fuseau horaire est inclus, toutes les datetimes non UTC sont converties en UTC. Si une date est passée sans informations de fuseau horaire, elle est supposée être UTC. Spécifiez cet en-tête pour exécuter l'opération uniquement si la ressource n'a pas été modifiée depuis la date/l'heure indiquées.

etag: str

Spécifiez une valeur ETag ou le caractère générique *. Permet de case activée si la ressource a changé et d’agir selon la condition spécifiée par le paramètre match_condition.

match_condition: MatchConditions

Condition de correspondance à utiliser sur l’etag.

cpk: CustomerProvidedEncryptionKey

Chiffre les données côté service avec la clé donnée. L’utilisation des clés fournies par le client doit être effectuée via HTTPS.

timeout: int

Définit le délai d’expiration côté serveur pour l’opération en secondes. Pour plus d’informations, consultez https://learn.microsoft.com/rest/api/storageservices/setting-timeouts-for-blob-service-operations. Cette valeur n’est pas suivie ou validée sur le client. Pour configurer les délais d’expiration du réseau côté client, consultez ici.

encryption_context: str

Spécifie le contexte de chiffrement à définir sur le fichier.

Retours

dicté de réponse (Etag et dernière modification).

Exemples

Créez un fichier.


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

Marque le fichier spécifié pour suppression.

delete_file(**kwargs) -> None

Paramètres

lease: DataLakeLeaseClient ou str

Obligatoire si le fichier a un bail actif. La valeur peut être un objet LeaseClient ou l’ID de bail sous forme de chaîne.

if_modified_since: datetime

Valeur DateTime. Azure s’attend à ce que la valeur de date passée soit UTC. Si le fuseau horaire est inclus, toutes les datetimes non UTC sont converties en UTC. Si une date est passée sans informations de fuseau horaire, elle est supposée être UTC. Spécifiez cet en-tête pour exécuter l'opération uniquement si la ressource a été modifiée depuis le temps indiqué.

if_unmodified_since: datetime

Valeur DateTime. Azure s’attend à ce que la valeur de date passée soit UTC. Si le fuseau horaire est inclus, toutes les datetimes non UTC sont converties en UTC. Si une date est passée sans informations de fuseau horaire, elle est supposée être UTC. Spécifiez cet en-tête pour exécuter l'opération uniquement si la ressource n'a pas été modifiée depuis la date/l'heure indiquées.

etag: str

Spécifiez une valeur ETag ou le caractère générique *. Permet de case activée si la ressource a changé et d’agir selon la condition spécifiée par le paramètre match_condition.

match_condition: MatchConditions

Condition de correspondance à utiliser sur l’etag.

timeout: int

Définit le délai d’expiration côté serveur pour l’opération en secondes. Pour plus d’informations, consultez https://learn.microsoft.com/rest/api/storageservices/setting-timeouts-for-blob-service-operations. Cette valeur n’est pas suivie ou validée sur le client. Pour configurer les délais d’expiration du réseau côté client, consultez ici.

Retours

Aucun

Exemples

Supprimer le fichier.


   new_client.delete_file()

Télécharge un fichier dans StorageStreamDownloader. La méthode readall() doit être utilisée pour lire tout le contenu, ou readinto() doit être utilisée pour télécharger le fichier dans un flux. L’utilisation de chunks() retourne un itérateur qui permet à l’utilisateur d’itérer sur le contenu en blocs.

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

Paramètres

offset: int

Obligatoire

Début de la plage d’octets à utiliser pour télécharger une section du fichier. Doit être défini si la longueur est fournie.

length: int

Obligatoire

Nombre d’octets à lire à partir du flux. Cette option est facultative, mais doit être fournie pour des performances optimales.

lease: DataLakeLeaseClient ou str

S’il est spécifié, le téléchargement réussit uniquement si le bail du fichier est actif et correspond à cet ID. Obligatoire si le fichier a un bail actif.

if_modified_since: datetime

Valeur DateTime. Azure s’attend à ce que la valeur de date passée soit UTC. Si le fuseau horaire est inclus, toutes les datetimes non UTC sont converties en UTC. Si une date est passée sans informations de fuseau horaire, elle est supposée être UTC. Spécifiez cet en-tête pour exécuter l'opération uniquement si la ressource a été modifiée depuis le temps indiqué.

if_unmodified_since: datetime

Valeur DateTime. Azure s’attend à ce que la valeur de date passée soit UTC. Si le fuseau horaire est inclus, toutes les datetimes non UTC sont converties en UTC. Si une date est passée sans informations de fuseau horaire, elle est supposée être UTC. Spécifiez cet en-tête pour exécuter l'opération uniquement si la ressource n'a pas été modifiée depuis la date/l'heure indiquées.

etag: str

Spécifiez une valeur ETag ou le caractère générique *. Permet de case activée si la ressource a changé et d’agir selon la condition spécifiée par le paramètre match_condition.

match_condition: MatchConditions

Condition de correspondance à utiliser sur l’etag.

cpk: CustomerProvidedEncryptionKey

Déchiffre les données côté service avec la clé donnée. L’utilisation des clés fournies par le client doit être effectuée via HTTPS. Obligatoire si le fichier a été créé avec une clé Customer-Provided.

max_concurrency: int

Nombre de connexions parallèles à télécharger.

timeout: int

Définit le délai d’expiration côté serveur pour l’opération en secondes. Pour plus d’informations, consultez https://learn.microsoft.com/rest/api/storageservices/setting-timeouts-for-blob-service-operations. Cette valeur n’est pas suivie ou validée sur le client. Pour configurer les délais d’expiration du réseau côté client, consultez ici. Cette méthode peut effectuer plusieurs appels au service et le délai d’expiration s’applique à chaque appel individuellement.

Retours

Objet de diffusion en continu (StorageStreamDownloader)

Type de retour

StorageStreamDownloader

Exemples

Retourne les données téléchargées.


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

Retourne la valeur True si un fichier existe et la valeur False dans le cas contraire.

exists(**kwargs: Any) -> bool

Paramètres

timeout: int

Définit le délai d’expiration côté serveur pour l’opération en secondes. Pour plus d’informations, consultez https://learn.microsoft.com/rest/api/storageservices/setting-timeouts-for-blob-service-operations. Cette valeur n’est pas suivie ou validée sur le client. Pour configurer les délais d’expiration du réseau côté client, consultez ici.

Retours

True si un fichier existe, sinon retourne False.

Type de retour

bool

Commitez les données ajoutées précédentes.

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

Paramètres

offset

Obligatoire

offset est égal à la longueur du fichier après la validation des données ajoutées précédentes.

retain_uncommitted_data: bool

Obligatoire

Valide uniquement pour les opérations de vidage. Si « true », les données non validées sont conservées une fois l’opération de vidage terminée ; sinon, les données non validées sont supprimées après l’opération de vidage. La valeur par défaut est false. Les données à des décalages inférieurs à la position spécifiée sont écrites dans le fichier lorsque le vidage réussit, mais ce paramètre facultatif permet de conserver les données après la position de vidage pour une opération de vidage ultérieure.

content_settings: ContentSettings

Objet ContentSettings utilisé pour définir les propriétés de chemin d’accès.

close: bool

Les événements de stockage Azure permettent aux applications de recevoir des notifications lorsque les fichiers changent. Lorsque les événements de stockage Azure sont activés, un événement de modification de fichier est déclenché. Cet événement a une propriété indiquant s’il s’agit de la dernière modification pour distinguer la différence entre une vidage intermédiaire dans un flux de fichiers et la fermeture finale d’un flux de fichiers. Le paramètre de requête close est valide uniquement lorsque l’action est « vidage » et que les notifications de modification sont activées. Si la valeur de close est « true » et que l’opération de vidage se termine correctement, le service déclenche une notification de modification de fichier avec une propriété indiquant qu’il s’agit de la mise à jour finale (le flux de fichiers a été fermé). Si « false » une notification de modification est déclenchée indiquant que le fichier a changé. La valeur par défaut est false. Ce paramètre de requête est défini sur true par le pilote Hadoop ABFS pour indiquer que le flux de fichiers a été fermé. »

if_modified_since: datetime

Valeur DateTime. Azure s’attend à ce que la valeur de date transmise soit UTC. Si le fuseau horaire est inclus, toutes les dates-heures non UTC seront converties en UTC. Si une date est transmise sans informations de fuseau horaire, elle est supposée être UTC. Spécifiez cet en-tête pour exécuter l'opération uniquement si la ressource a été modifiée depuis le temps indiqué.

if_unmodified_since: datetime

Valeur DateTime. Azure s’attend à ce que la valeur de date transmise soit UTC. Si le fuseau horaire est inclus, toutes les dates-heures non UTC seront converties en UTC. Si une date est transmise sans informations de fuseau horaire, elle est supposée être UTC. Spécifiez cet en-tête pour exécuter l'opération uniquement si la ressource n'a pas été modifiée depuis la date/l'heure indiquées.

etag: str

Spécifiez une valeur ETag ou le caractère générique *. Permet de case activée si la ressource a changé et d’agir en fonction de la condition spécifiée par le paramètre match_condition.

match_condition: MatchConditions

Condition de correspondance à utiliser sur l’etag.

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

Utilisé pour effectuer des opérations de bail ainsi que l’ajout de données.

« acquérir » : acquérir un bail. « renouvellement automatique » : renouvelez un bail existant. « release » : libérez le bail une fois l’opération terminée. « acquire-release » : acquérir un bail et le libérer une fois les opérations terminées.

lease_duration: int

Valide si lease_action est défini sur « acquire » ou « acquire-release ».

Spécifie la durée de bail, en secondes, ou moins un (- 1) pour un bail qui n'expire jamais. Un bail qui n'est pas infini peut durer entre 15 et 60 secondes. La durée d’un bail ne peut pas être modifiée à l’aide du renouvellement ou de la modification. La valeur par défaut est -1 (bail infini).

lease: DataLakeLeaseClient ou str

Obligatoire si le fichier a un bail actif ou si lease_action est défini sur « acquire » ou « acquire-release ». Si le fichier a un bail existant, celui-ci sera utilisé pour accéder au fichier. En cas d’acquisition d’un nouveau bail, celui-ci sera utilisé comme nouvel ID de bail. La valeur peut être un objet DataLakeLeaseClient ou l’ID de bail sous forme de chaîne.

cpk: CustomerProvidedEncryptionKey

Chiffre les données côté service avec la clé donnée. L’utilisation des clés fournies par le client doit être effectuée via HTTPS.

Retours

en-tête de réponse dans dict

Exemples

Commitez les données ajoutées précédentes.


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

Créez DataLakeFileClient à partir d’une chaîne de connexion.

: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

Paramètres

conn_str: str

Obligatoire

Chaîne de connexion à un compte stockage Azure.

file_system_name: str

Obligatoire

Nom du système de fichiers avec lequel interagir.

file_path: str

Obligatoire

Chemin d’accès au fichier entier, afin d’interagir avec un fichier spécifique. par exemple « {répertoire}/{sous-répertoire}/{file} »

credential

valeur par défaut: None

Informations d’identification avec lesquelles s’authentifier. Cette option est facultative si l’URL du compte a déjà un jeton SAS ou si la chaîne de connexion a déjà des valeurs de clé d’accès partagé. La valeur peut être une chaîne de jeton SAS, une instance d’une classe AzureSasCredential ou AzureNamedKeyCredential à partir d’azure.core.credentials, une clé d’accès partagé de compte ou une instance d’une classe TokenCredentials d’azure.identity. Les informations d’identification fournies ici sont prioritaires sur celles de la chaîne de connexion. Si vous utilisez une instance d’AzureNamedKeyCredential, « name » doit être le nom du compte de stockage et « key » doit être la clé du compte de stockage.

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

Paramètres

upn: bool

Obligatoire

facultatif. Valide uniquement lorsque l’espace de noms hiérarchique est activé pour le compte. Si « true », les valeurs d’identité utilisateur retournées dans les en-têtes de réponse x-ms-owner, x-ms-group et x-ms-acl seront transformées des ID d’objet Azure Active Directory en noms d’utilisateur principal. Si « false », les valeurs sont retournées en tant qu’ID d’objet Azure Active Directory. La valeur par défaut est false. Notez que les ID d’objet de groupe et d’application ne sont pas traduits, car ils n’ont pas de noms conviviaux uniques.

lease: DataLakeLeaseClient ou str

Obligatoire si le fichier/répertoire a un bail actif. La valeur peut être un objet LeaseClient ou l’ID de bail sous forme de chaîne.

if_modified_since: datetime

Valeur DateTime. Azure s’attend à ce que la valeur de date transmise soit UTC. Si le fuseau horaire est inclus, toutes les dates-heures non UTC seront converties en UTC. Si une date est transmise sans informations de fuseau horaire, elle est supposée être UTC. Spécifiez cet en-tête pour exécuter l'opération uniquement si la ressource a été modifiée depuis le temps indiqué.

if_unmodified_since: datetime

Valeur DateTime. Azure s’attend à ce que la valeur de date transmise soit UTC. Si le fuseau horaire est inclus, toutes les dates-heures non UTC seront converties en UTC. Si une date est transmise sans informations de fuseau horaire, elle est supposée être UTC. Spécifiez cet en-tête pour exécuter l'opération uniquement si la ressource n'a pas été modifiée depuis la date/l'heure indiquées.

etag: str

Spécifiez une valeur ETag ou le caractère générique *. Permet de case activée si la ressource a changé et d’agir en fonction de la condition spécifiée par le paramètre match_condition.

match_condition: MatchConditions

Condition de correspondance à utiliser sur l’etag.

timeout: int

Définit le délai d’attente côté serveur pour l’opération en secondes. Pour plus d’informations, consultez https://learn.microsoft.com/rest/api/storageservices/setting-timeouts-for-blob-service-operations. Cette valeur n’est pas suivie ou validée sur le client. Pour configurer les délais d’expiration du réseau côté client, consultez ici.

response dict

dict de réponse.

Retourne toutes les métadonnées définies par l’utilisateur, les propriétés HTTP standard et les propriétés système du fichier. Elle ne retourne pas le contenu du fichier.

get_file_properties(**kwargs: Any) -> FileProperties

Paramètres

lease

Obligatoire si le répertoire ou le fichier a un bail actif. La valeur peut être un objet DataLakeLeaseClient ou l’ID de bail sous forme de chaîne.

if_modified_since: datetime

Valeur DateTime. Azure s’attend à ce que la valeur de date transmise soit UTC. Si le fuseau horaire est inclus, toutes les dates-heures non UTC seront converties en UTC. Si une date est transmise sans informations de fuseau horaire, elle est supposée être UTC. Spécifiez cet en-tête pour exécuter l'opération uniquement si la ressource a été modifiée depuis le temps indiqué.

if_unmodified_since: datetime

Valeur DateTime. Azure s’attend à ce que la valeur de date transmise soit UTC. Si le fuseau horaire est inclus, toutes les dates-heures non UTC seront converties en UTC. Si une date est transmise sans informations de fuseau horaire, elle est supposée être UTC. Spécifiez cet en-tête pour exécuter l'opération uniquement si la ressource n'a pas été modifiée depuis la date/l'heure indiquées.

etag: str

Spécifiez une valeur ETag ou le caractère générique *. Permet de case activée si la ressource a changé et d’agir selon la condition spécifiée par le paramètre match_condition.

match_condition: MatchConditions

Condition de correspondance à utiliser sur l’etag.

cpk: CustomerProvidedEncryptionKey

Déchiffre les données côté service avec la clé donnée. L’utilisation des clés fournies par le client doit être effectuée via HTTPS. Obligatoire si le fichier a été créé avec une clé fournie par le client.

timeout: int

Définit le délai d’expiration côté serveur pour l’opération en secondes. Pour plus d’informations, consultez https://learn.microsoft.com/rest/api/storageservices/setting-timeouts-for-blob-service-operations. Cette valeur n’est pas suivie ou validée sur le client. Pour configurer les délais d’expiration du réseau côté client, consultez ici.

Retours

Toutes les métadonnées définies par l’utilisateur, les propriétés HTTP standard et les propriétés système du fichier.

Type de retour

FileProperties

Exemples

Obtention des propriétés d’un fichier.


   properties = file_client.get_file_properties()

Permet aux utilisateurs de sélectionner/projeter des données de fichier datalake en fournissant des expressions de requête simples. Cette opération retourne un DataLakeFileQueryReader, les utilisateurs doivent utiliser readall() ou readinto() pour obtenir des données de requête.

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

Paramètres

query_expression: str

Obligatoire

Obligatoire. une instruction de requête. par exemple Sélectionnez * dans DataLakeStorage

on_error: Callable[DataLakeFileQueryError]

Fonction à appeler sur toutes les erreurs de traitement retournées par le service.

file_format: DelimitedTextDialect ou DelimitedJsonDialect ou QuickQueryDialect ou str

facultatif. Définit la sérialisation des données actuellement stockées dans le fichier. La valeur par défaut consiste à traiter les données de fichier comme des données CSV formatées dans le dialecte par défaut. Cela peut être remplacé par un DelimitedTextDialect personnalisé, ou DelimitedJsonDialect ou « ParquetDialect » (passé sous la forme d’une chaîne ou d’une énumération). Ces dialectes peuvent être transmis via leurs classes respectives, l’énumération QuickQueryDialect ou sous forme de chaîne.

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

facultatif. Définit la sérialisation de sortie pour le flux de données. Par défaut, les données sont retournées telles qu’elles sont représentées dans le fichier. En fournissant un format de sortie, les données du fichier sont reformatées en fonction de ce profil. Cette valeur peut être un DelimitedTextDialect ou un DelimitedJsonDialect ou ArrowDialect. Ces dialectes peuvent être transmis via leurs classes respectives, l’énumération QuickQueryDialect ou sous forme de chaîne.

lease: DataLakeLeaseClient ou str

Obligatoire si le fichier a un bail actif. La valeur peut être un objet DataLakeLeaseClient ou l’ID de bail sous forme de chaîne.

if_modified_since: datetime

Valeur DateTime. Azure s’attend à ce que la valeur de date passée soit UTC. Si le fuseau horaire est inclus, toutes les datetimes non UTC sont converties en UTC. Si une date est passée sans informations de fuseau horaire, elle est supposée être UTC. Spécifiez cet en-tête pour exécuter l'opération uniquement si la ressource a été modifiée depuis le temps indiqué.

if_unmodified_since: datetime

Valeur DateTime. Azure s’attend à ce que la valeur de date passée soit UTC. Si le fuseau horaire est inclus, toutes les datetimes non UTC sont converties en UTC. Si une date est passée sans informations de fuseau horaire, elle est supposée être UTC. Spécifiez cet en-tête pour exécuter l'opération uniquement si la ressource n'a pas été modifiée depuis la date/l'heure indiquées.

etag: str

Spécifiez une valeur ETag ou le caractère générique *. Permet de case activée si la ressource a changé et d’agir selon la condition spécifiée par le paramètre match_condition.

match_condition: MatchConditions

Condition de correspondance à utiliser sur l’etag.

cpk: CustomerProvidedEncryptionKey

Déchiffre les données côté service avec la clé donnée. L’utilisation des clés fournies par le client doit être effectuée via HTTPS. Obligatoire si le fichier a été créé avec une clé Customer-Provided.

timeout: int

Définit le délai d’expiration côté serveur pour l’opération en secondes. Pour plus d’informations, consultez https://learn.microsoft.com/rest/api/storageservices/setting-timeouts-for-blob-service-operations. Cette valeur n’est pas suivie ou validée sur le client. Pour configurer les délais d’expiration du réseau côté client, consultez ici.

Retours

Objet de diffusion en continu (DataLakeFileQueryReader)

Type de retour

<xref:azure.storage.filedatalake.DataLakeFileQueryReader>

Exemples

sélectionnez/projetez les données du fichier datalake en fournissant des expressions de requête simples.


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

Supprime le Access Control sur un chemin et des sous-chemins.

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

Paramètres

acl: str

Obligatoire

Supprime les droits de contrôle d’accès POSIX sur les fichiers et les répertoires. La valeur est une liste d’entrées de contrôle d’accès séparées par des virgules. Chaque entrée de contrôle d’accès (ACE) se compose d’une étendue, d’un type et d’un identificateur d’utilisateur ou de groupe au format « [scope:][type]:[id] ».

progress_hook: <xref:func>(AccessControlChanges)

Rappel dans lequel l’appelant peut suivre la progression de l’opération et collecter les chemins d’accès qui n’ont pas pu changer Access Control.

continuation_token: str

Jeton de continuation facultatif qui peut être utilisé pour reprendre l’opération précédemment arrêtée.

batch_size: int

facultatif. Si la taille du jeu de données dépasse la taille du lot, l’opération est divisée en plusieurs demandes afin que la progression puisse être suivie. La taille du lot doit être comprise entre 1 et 2000. La valeur par défaut quand elle n’est pas spécifiée est 2000.

max_batches: int

facultatif. Définit le nombre maximal de lots que Access Control opération de modification unique peut exécuter. Si le maximum est atteint avant le traitement de tous les sous-chemins d’accès, le jeton de continuation peut être utilisé pour reprendre l’opération. La valeur vide indique que le nombre maximal de lots dans les lots non liés et l’opération se poursuit jusqu’à la fin.

continue_on_failure: bool

Si la valeur est False, l’opération se termine rapidement en cas d’erreurs utilisateur (4XX). Si la valeur est True, l’opération ignore les erreurs utilisateur et poursuit l’opération sur d’autres sous-entités du répertoire. Le jeton de continuation est retourné uniquement quand continue_on_failure a la valeur True en cas d’erreurs utilisateur. Si ce n’est pas le cas, la valeur par défaut est False.

timeout: int

Définit le délai d’expiration côté serveur pour l’opération en secondes. Pour plus d’informations, consultez https://learn.microsoft.com/rest/api/storageservices/setting-timeouts-for-blob-service-operations. Cette valeur n’est pas suivie ou validée sur le client. Pour configurer les délais d’expiration du réseau côté client, consultez ici.

Retours

Résumé des opérations récursives, y compris le nombre de réussites et d’échecs, ainsi qu’un jeton de continuation au cas où l’opération s’arrêtait prématurément.

Type de retour

AccessControlChangeResult

Exceptions

AzureError

L’utilisateur peut redémarrer l’opération à l’aide de continuation_token champ d’AzureError si le jeton est disponible.

Renommez le fichier source.

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

Paramètres

new_name: str

Obligatoire

nouveau nom de fichier que l’utilisateur souhaite renommer. La valeur doit avoir le format suivant : « {filesystem}/{directory}/{subdirectory}/{file} ».

content_settings: ContentSettings

Objet ContentSettings utilisé pour définir les propriétés de chemin d’accès.

source_lease: DataLakeLeaseClient ou str

ID de bail pour le chemin d’accès source. S’il est spécifié, le chemin d’accès source doit avoir un bail actif et l’ID de bail doit correspondre.

lease

Obligatoire si le fichier/répertoire a un bail actif. La valeur peut être un objet LeaseClient ou l’ID de bail sous forme de chaîne.

if_modified_since: datetime

Valeur DateTime. Azure s’attend à ce que la valeur de date passée soit UTC. Si le fuseau horaire est inclus, toutes les datetimes non UTC sont converties en UTC. Si une date est passée sans informations de fuseau horaire, elle est supposée être UTC. Spécifiez cet en-tête pour exécuter l'opération uniquement si la ressource a été modifiée depuis le temps indiqué.

if_unmodified_since: datetime

Valeur DateTime. Azure s’attend à ce que la valeur de date passée soit UTC. Si le fuseau horaire est inclus, toutes les datetimes non UTC sont converties en UTC. Si une date est passée sans informations de fuseau horaire, elle est supposée être UTC. Spécifiez cet en-tête pour exécuter l'opération uniquement si la ressource n'a pas été modifiée depuis la date/l'heure indiquées.

etag: str

Spécifiez une valeur ETag ou le caractère générique *. Permet de case activée si la ressource a changé et d’agir selon la condition spécifiée par le paramètre match_condition.

match_condition: MatchConditions

Condition de correspondance à utiliser sur l’etag.

source_if_modified_since: datetime

Valeur DateTime. Azure s’attend à ce que la valeur de date passée soit UTC. Si le fuseau horaire est inclus, toutes les datetimes non UTC sont converties en UTC. Si une date est passée sans informations de fuseau horaire, elle est supposée être UTC. Spécifiez cet en-tête pour exécuter l'opération uniquement si la ressource a été modifiée depuis le temps indiqué.

source_if_unmodified_since: datetime

Valeur DateTime. Azure s’attend à ce que la valeur de date passée soit UTC. Si le fuseau horaire est inclus, toutes les datetimes non UTC sont converties en UTC. Si une date est passée sans informations de fuseau horaire, elle est supposée être UTC. Spécifiez cet en-tête pour exécuter l'opération uniquement si la ressource n'a pas été modifiée depuis la date/l'heure indiquées.

source_etag: str

Valeur ETag source ou caractère générique (*). Permet de case activée si la ressource a changé et d’agir selon la condition spécifiée par le paramètre match_condition.

source_match_condition: MatchConditions

Condition de correspondance source à utiliser sur l’etag.

timeout: int

Définit le délai d’expiration côté serveur pour l’opération en secondes. Pour plus d’informations, consultez https://learn.microsoft.com/rest/api/storageservices/setting-timeouts-for-blob-service-operations. Cette valeur n’est pas suivie ou validée sur le client. Pour configurer les délais d’expiration du réseau côté client, consultez ici.

Retours

le client de fichier renommé

Type de retour

DataLakeFileClient

Exemples

Renommez le fichier source.


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

Définissez le propriétaire, le groupe, les autorisations ou la liste de contrôle d’accès pour un chemin d’accès.

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

Paramètres

owner: str

Obligatoire

facultatif. Propriétaire du fichier ou du répertoire.

group: str

Obligatoire

facultatif. Groupe propriétaire du fichier ou du répertoire.

permissions: str

Obligatoire

Facultatif et valide uniquement si l’espace de noms hiérarchique est activé pour le compte. Définit les autorisations d’accès POSIX pour le propriétaire du fichier, le groupe propriétaire du fichier, etc. Chaque classe peut se voir accorder l’autorisation de lecture, d’écriture ou d’exécution. Le bit collant est également pris en charge. La notation symbolique (rwxrw-rw-) et la notation octal à 4 chiffres (par exemple, 0766) sont prises en charge. les autorisations et acl s’excluent mutuellement.

acl: str

Obligatoire

Définit les droits de contrôle d’accès POSIX sur les fichiers et les répertoires. La valeur est une liste d’entrées de contrôle d’accès séparées par des virgules. Chaque entrée de contrôle d’accès (ACE) se compose d’une étendue, d’un type, d’un identificateur d’utilisateur ou de groupe et d’autorisations au format « [scope:][type]:[id]:[permissions] ». les autorisations et acl s’excluent mutuellement.

lease: DataLakeLeaseClient ou str

Obligatoire si le fichier/répertoire a un bail actif. La valeur peut être un objet LeaseClient ou l’ID de bail sous forme de chaîne.

if_modified_since: datetime

Valeur DateTime. Azure s’attend à ce que la valeur de date passée soit UTC. Si le fuseau horaire est inclus, toutes les datetimes non UTC sont converties en UTC. Si une date est passée sans informations de fuseau horaire, elle est supposée être UTC. Spécifiez cet en-tête pour exécuter l'opération uniquement si la ressource a été modifiée depuis le temps indiqué.

if_unmodified_since: datetime

Valeur DateTime. Azure s’attend à ce que la valeur de date passée soit UTC. Si le fuseau horaire est inclus, toutes les datetimes non UTC sont converties en UTC. Si une date est passée sans informations de fuseau horaire, elle est supposée être UTC. Spécifiez cet en-tête pour exécuter l'opération uniquement si la ressource n'a pas été modifiée depuis la date/l'heure indiquées.

etag: str

Spécifiez une valeur ETag ou le caractère générique *. Permet de case activée si la ressource a changé et d’agir selon la condition spécifiée par le paramètre match_condition.

match_condition: MatchConditions

Condition de correspondance à utiliser sur l’etag.

timeout: int

Définit le délai d’expiration côté serveur pour l’opération en secondes. Pour plus d’informations, consultez https://learn.microsoft.com/rest/api/storageservices/setting-timeouts-for-blob-service-operations. Cette valeur n’est pas suivie ou validée sur le client. Pour configurer les délais d’expiration du réseau côté client, consultez ici.

response dict

dicté de réponse (Etag et dernière modification).

Définit le Access Control sur un chemin et des sous-chemins.

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

Paramètres

acl: str

Obligatoire

Définit les droits de contrôle d’accès POSIX sur les fichiers et les répertoires. La valeur est une liste d’entrées de contrôle d’accès séparées par des virgules. Chaque entrée de contrôle d’accès (ACE) se compose d’une étendue, d’un type, d’un identificateur d’utilisateur ou de groupe et d’autorisations au format « [scope:][type]:[id]:[permissions] ».

progress_hook: <xref:func>(AccessControlChanges)

Rappel dans lequel l’appelant peut suivre la progression de l’opération et collecter les chemins d’accès qui n’ont pas pu changer Access Control.

continuation_token: str

Jeton de continuation facultatif qui peut être utilisé pour reprendre l’opération précédemment arrêtée.

batch_size: int

facultatif. Si la taille du jeu de données dépasse la taille du lot, l’opération est divisée en plusieurs demandes afin que la progression puisse être suivie. La taille du lot doit être comprise entre 1 et 2000. La valeur par défaut quand elle n’est pas spécifiée est 2000.

max_batches: int

facultatif. Définit le nombre maximal de lots que Access Control opération de modification unique peut exécuter. Si le maximum est atteint avant le traitement de tous les sous-chemins, le jeton de continuation peut être utilisé pour reprendre l’opération. La valeur vide indique que le nombre maximal de lots dans les lots non liés et l’opération se poursuit jusqu’à la fin.

continue_on_failure: bool

Si la valeur est False, l’opération se termine rapidement en cas d’erreurs utilisateur (4XX). Si la valeur est True, l’opération ignore les erreurs utilisateur et poursuit l’opération sur d’autres sous-entités du répertoire. Le jeton de continuation est retourné uniquement quand continue_on_failure a la valeur True en cas d’erreurs utilisateur. Si ce n’est pas le cas, la valeur par défaut est False.

timeout: int

Définit le délai d’expiration côté serveur pour l’opération en secondes. Pour plus d’informations, consultez https://learn.microsoft.com/rest/api/storageservices/setting-timeouts-for-blob-service-operations. Cette valeur n’est pas suivie ou validée sur le client. Pour configurer les délais d’expiration du réseau côté client, consultez ici.

Retours

Résumé des opérations récursives, y compris le nombre de réussites et d’échecs, ainsi qu’un jeton de continuation au cas où l’opération s’arrêtait prématurément.

Type de retour

AccessControlChangeResult

Exceptions

AzureError

L’utilisateur peut redémarrer l’opération à l’aide de continuation_token champ d’AzureError si le jeton est disponible.

Définit l’heure d’expiration et de suppression d’un fichier.

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

Paramètres

expiry_options: str

Obligatoire

Obligatoire. Indique le mode de l’heure d’expiration. Les valeurs possibles sont les suivantes : « NeverExpire », « RelativeToCreation », « RelativeToNow », « Absolute »

expires_on: datetime ou int

Obligatoire

Délai de définition de l’expiration du fichier. Quand expiry_options a la valeur RelativeTo*, expires_on doit être un int en millisecondes. Si le type de expires_on est dateheure, il doit être en heure UTC.

timeout: int

Définit le délai d’expiration côté serveur pour l’opération en secondes. Pour plus d’informations, consultez https://learn.microsoft.com/rest/api/storageservices/setting-timeouts-for-blob-service-operations. Cette valeur n’est pas suivie ou validée sur le client. Pour configurer les délais d’expiration du réseau côté client, consultez ici.

Type de retour

None

Définit les propriétés système sur le fichier ou le répertoire.

Si une propriété est définie pour le content_settings, toutes les propriétés sont remplacées.

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

Paramètres

content_settings: ContentSettings

Obligatoire

Objet ContentSettings utilisé pour définir les propriétés de fichier/répertoire.

lease: DataLakeLeaseClient ou str

S’il est spécifié, set_file_system_metadata réussit uniquement si le bail du système de fichiers est actif et correspond à cet ID.

if_modified_since: datetime

Valeur DateTime. Azure s’attend à ce que la valeur de date passée soit UTC. Si le fuseau horaire est inclus, toutes les datetimes non UTC sont converties en UTC. Si une date est passée sans informations de fuseau horaire, elle est supposée être UTC. Spécifiez cet en-tête pour exécuter l'opération uniquement si la ressource a été modifiée depuis le temps indiqué.

if_unmodified_since: datetime

Valeur DateTime. Azure s’attend à ce que la valeur de date passée soit UTC. Si le fuseau horaire est inclus, toutes les datetimes non UTC sont converties en UTC. Si une date est passée sans informations de fuseau horaire, elle est supposée être UTC. Spécifiez cet en-tête pour exécuter l'opération uniquement si la ressource n'a pas été modifiée depuis la date/l'heure indiquées.

etag: str

Spécifiez une valeur ETag ou le caractère générique *. Permet de case activée si la ressource a changé et d’agir en fonction de la condition spécifiée par le paramètre match_condition.

match_condition: MatchConditions

Condition de correspondance à utiliser sur l’etag.

timeout: int

Définit le délai d’attente côté serveur pour l’opération en secondes. Pour plus d’informations, consultez https://learn.microsoft.com/rest/api/storageservices/setting-timeouts-for-blob-service-operations. Cette valeur n’est pas suivie ou validée sur le client. Pour configurer les délais d’expiration du réseau côté client, consultez ici.

Retours

Dict de propriété mise à jour de fichier/répertoire (Etag et dernière modification)

Type de retour

Dict[str, Any]

Définit une ou plusieurs paires nom-valeur définies par l’utilisateur pour le système de fichiers spécifié. Chaque appel à cette opération remplace toutes les métadonnées existantes attachées au système de fichiers. Pour supprimer toutes les métadonnées du système de fichiers, appelez cette opération sans dictée de métadonnées.

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

Paramètres

metadata: Dict[str, str]

Obligatoire

dict contenant des paires nom-valeur à associer au système de fichiers en tant que métadonnées. Exemple : {'category':'test'}

lease: DataLakeLeaseClient ou str

S’il est spécifié, set_file_system_metadata réussit uniquement si le bail du système de fichiers est actif et correspond à cet ID.

if_modified_since: datetime

Valeur DateTime. Azure s’attend à ce que la valeur de date transmise soit UTC. Si le fuseau horaire est inclus, toutes les dates-heures non UTC seront converties en UTC. Si une date est transmise sans informations de fuseau horaire, elle est supposée être UTC. Spécifiez cet en-tête pour exécuter l'opération uniquement si la ressource a été modifiée depuis le temps indiqué.

if_unmodified_since: datetime

Valeur DateTime. Azure s’attend à ce que la valeur de date transmise soit UTC. Si le fuseau horaire est inclus, toutes les dates-heures non UTC seront converties en UTC. Si une date est transmise sans informations de fuseau horaire, elle est supposée être UTC. Spécifiez cet en-tête pour exécuter l'opération uniquement si la ressource n'a pas été modifiée depuis la date/l'heure indiquées.

etag: str

Spécifiez une valeur ETag ou le caractère générique *. Permet de case activée si la ressource a changé et d’agir en fonction de la condition spécifiée par le paramètre match_condition.

match_condition: MatchConditions

Condition de correspondance à utiliser sur l’etag.

cpk: CustomerProvidedEncryptionKey

Chiffre les données côté service avec la clé donnée. L’utilisation des clés fournies par le client doit être effectuée via HTTPS.

timeout: int

Définit le délai d’attente côté serveur pour l’opération en secondes. Pour plus d’informations, consultez https://learn.microsoft.com/rest/api/storageservices/setting-timeouts-for-blob-service-operations. Cette valeur n’est pas suivie ou validée sur le client. Pour configurer les délais d’expiration du réseau côté client, consultez ici.

Retours

dict de propriété mise à jour par le système de fichiers (Etag et dernière modification).

Modifie le Access Control sur un chemin d’accès et des sous-chemins.

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

Paramètres

acl: str

Obligatoire

Modifie les droits de contrôle d’accès POSIX sur les fichiers et les répertoires. La valeur est une liste séparée par des virgules d’entrées de contrôle d’accès. Chaque entrée de contrôle d’accès (ACE) se compose d’une étendue, d’un type, d’un identificateur d’utilisateur ou de groupe et d’autorisations au format « [scope:][type]:[id]:[permissions] ».

progress_hook: <xref:func>(AccessControlChanges)

Rappel dans lequel l’appelant peut suivre la progression de l’opération et collecter les chemins qui n’ont pas pu changer Access Control.

continuation_token: str

Jeton de continuation facultatif qui peut être utilisé pour reprendre une opération précédemment arrêtée.

batch_size: int

facultatif. Si la taille du jeu de données dépasse la taille du lot, l’opération est fractionnée en plusieurs demandes afin que la progression puisse être suivie. La taille du lot doit être comprise entre 1 et 2000. La valeur par défaut quand elle n’est pas spécifiée est 2000.

max_batches: int

facultatif. Définit le nombre maximal de lots qu’une seule modification Access Control opération peut exécuter. Si le maximum est atteint avant que tous les sous-chemins ne soient traités, le jeton de continuation peut être utilisé pour reprendre l’opération. La valeur vide indique que le nombre maximal de lots non liés et l’opération se poursuit jusqu’à la fin.

continue_on_failure: bool

Si la valeur est False, l’opération s’arrête rapidement en cas d’erreurs utilisateur (4XX). Si la valeur est True, l’opération ignore les erreurs utilisateur et poursuit l’opération sur d’autres sous-entités du répertoire. Le jeton de continuation n’est retourné que lorsque continue_on_failure a la valeur True en cas d’erreurs utilisateur. S’il n’est pas défini, la valeur par défaut est False pour cela.

timeout: int

Définit le délai d’attente côté serveur pour l’opération en secondes. Pour plus d’informations, consultez https://learn.microsoft.com/rest/api/storageservices/setting-timeouts-for-blob-service-operations. Cette valeur n’est pas suivie ou validée sur le client. Pour configurer les délais d’expiration du réseau côté client, consultez ici.

Retours

Résumé des opérations récursives, y compris le nombre de réussites et d’échecs, ainsi qu’un jeton de continuation en cas de fin prématurée de l’opération.

Type de retour

AccessControlChangeResult

Exceptions

AzureError

L’utilisateur peut redémarrer l’opération à l’aide de continuation_token champ d’AzureError si le jeton est disponible.

Charger des données dans un fichier.

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

Paramètres

data

Obligatoire

Contenu à charger dans le fichier

length: int

Obligatoire

Taille des données en octets.

overwrite: bool

Obligatoire

pour remplacer ou non un fichier existant.

content_settings: ContentSettings

Objet ContentSettings utilisé pour définir les propriétés de chemin d’accès.

metadata: Optional[Dict[str, str]]

Paires nom-valeur associées à l'objet blob en tant que métadonnées.

lease: DataLakeLeaseClient ou str

Obligatoire si l'objet blob a un bail actif. La valeur peut être un objet DataLakeLeaseClient ou l’ID de bail sous forme de chaîne.

umask: str

Facultatif et valide uniquement si l’espace de noms hiérarchique est activé pour le compte. Lors de la création d’un fichier ou d’un répertoire et que le dossier parent n’a pas de liste de contrôle d’accès par défaut, l’umask limite les autorisations du fichier ou du répertoire à créer. L’autorisation résultante est donnée par p & ^u, où p est l’autorisation et vous êtes l’umask. Par exemple, si p est 0777 et que vous avez la valeur 0057, l’autorisation résultante est 0720. L’autorisation par défaut est 0777 pour un répertoire et 0666 pour un fichier. L’umask par défaut est 0027. L’umask doit être spécifié en notation octale à 4 chiffres (par exemple, 0766).

permissions: str

Facultatif et valide uniquement si l’espace de noms hiérarchique est activé pour le compte. Définit les autorisations d’accès POSIX pour le propriétaire du fichier, le groupe propriétaire du fichier et d’autres personnes. Chaque classe peut se voir accorder l’autorisation de lecture, d’écriture ou d’exécution. Le bit collant est également pris en charge. La notation symbolique (rwxrw-rw-) et la notation octale à 4 chiffres (par exemple, 0766) sont prises en charge.

if_modified_since: datetime

Valeur DateTime. Azure s’attend à ce que la valeur de date transmise soit UTC. Si le fuseau horaire est inclus, toutes les dates-heures non UTC seront converties en UTC. Si une date est transmise sans informations de fuseau horaire, elle est supposée être UTC. Spécifiez cet en-tête pour exécuter l'opération uniquement si la ressource a été modifiée depuis le temps indiqué.

if_unmodified_since: datetime

Valeur DateTime. Azure s’attend à ce que la valeur de date transmise soit UTC. Si le fuseau horaire est inclus, toutes les dates-heures non UTC seront converties en UTC. Si une date est transmise sans informations de fuseau horaire, elle est supposée être UTC. Spécifiez cet en-tête pour exécuter l'opération uniquement si la ressource n'a pas été modifiée depuis la date/l'heure indiquées.

validate_content: bool

Si la valeur est true, calcule un hachage MD5 pour chaque segment du fichier. Le service de stockage vérifie le hachage du contenu qui est arrivé avec le hachage envoyé. Cela est principalement utile pour la détection de bitflips sur le câble si l’utilisation de http au lieu de https, car https (la valeur par défaut) est déjà validée. Notez que ce hachage MD5 n'est pas stocké avec l'objet blob. Notez également que s’il est activé, l’algorithme de chargement à mémoire efficace ne sera pas utilisé, car le calcul du hachage MD5 nécessite la mise en mémoire tampon de blocs entiers, ce qui va à l’échec de l’objectif de l’algorithme d’efficacité de la mémoire.

etag: str

Spécifiez une valeur ETag ou le caractère générique *. Permet de case activée si la ressource a changé et d’agir en fonction de la condition spécifiée par le paramètre match_condition.

match_condition: MatchConditions

Condition de correspondance à utiliser sur l’etag.

cpk: CustomerProvidedEncryptionKey

Chiffre les données côté service avec la clé donnée. L’utilisation des clés fournies par le client doit être effectuée via HTTPS.

timeout: int

Définit le délai d’attente côté serveur pour l’opération en secondes. Pour plus d’informations, consultez https://learn.microsoft.com/rest/api/storageservices/setting-timeouts-for-blob-service-operations. Cette valeur n’est pas suivie ou validée sur le client. Pour configurer les délais d’expiration du réseau côté client, consultez ici. Cette méthode peut effectuer plusieurs appels au service et le délai d’expiration s’applique à chaque appel individuellement.

chunk_size: int

Taille de segment maximale pour le chargement d’un fichier en blocs. La valeur par défaut est 100*1024*1024 ou 100 Mo.

encryption_context: str

Spécifie le contexte de chiffrement à définir sur le fichier.

Retours

dict de réponse (Etag et dernière modification).

Version de l’API de stockage utilisée pour les requêtes.

Mode d’emplacement que le client utilise actuellement.

Par défaut, il s’agit de « primary ». Les options incluent « principal » et « secondaire ».

URL complète du point de terminaison principal.

Nom d’hôte du point de terminaison principal.

URL de point de terminaison secondaire complète si configurée.

S’il n’est pas disponible, un objet ValueError est déclenché. Pour spécifier explicitement un nom d’hôte secondaire, utilisez l’argument facultatif secondary_hostname mot clé lors de l’instanciation.

Exceptions

ValueError

Nom d’hôte du point de terminaison secondaire.

S’il n’est pas disponible, il s’agit de Aucun. Pour spécifier explicitement un nom d’hôte secondaire, utilisez l’argument facultatif secondary_hostname mot clé lors de l’instanciation.

URL de point de terminaison complète de cette entité, y compris le jeton SAP s’il est utilisé.

Il peut s’agir du point de terminaison principal ou du point de terminaison secondaire en fonction du actuel location_mode. :returns : URL de point de terminaison complète de cette entité, y compris le jeton SAP s’il est utilisé. :rtype: str

acquire_lease	Demande un nouveau bail. Si le fichier ou le répertoire n’a pas de bail actif, le service DataLake crée un bail sur le fichier/répertoire et retourne un nouvel ID de bail.
append_data	Ajoutez des données au fichier.
close	Cette méthode consiste à fermer les sockets ouverts par le client. Il n’a pas besoin d’être utilisé lors de l’utilisation avec un gestionnaire de contexte.
create_file	Créez un fichier.
delete_file	Marque le fichier spécifié pour suppression.
download_file	Télécharge un fichier dans StorageStreamDownloader. La méthode readall() doit être utilisée pour lire tout le contenu, ou readinto() doit être utilisée pour télécharger le fichier dans un flux. L’utilisation de chunks() retourne un itérateur qui permet à l’utilisateur d’itérer sur le contenu en blocs.
exists	Retourne la valeur True si un fichier existe et la valeur False dans le cas contraire.
flush_data	Commitez les données ajoutées précédentes.
from_connection_string	Créez DataLakeFileClient à partir d’une chaîne de connexion. :return a DataLakeFileClient :rtype ~azure.storage.filedatalake.DataLakeFileClient
get_access_control
get_file_properties	Retourne toutes les métadonnées définies par l’utilisateur, les propriétés HTTP standard et les propriétés système du fichier. Elle ne retourne pas le contenu du fichier.
query_file	Permet aux utilisateurs de sélectionner/projeter des données de fichier datalake en fournissant des expressions de requête simples. Cette opération retourne un DataLakeFileQueryReader, les utilisateurs doivent utiliser readall() ou readinto() pour obtenir des données de requête.
remove_access_control_recursive	Supprime le Access Control sur un chemin et des sous-chemins.
rename_file	Renommez le fichier source.
set_access_control	Définissez le propriétaire, le groupe, les autorisations ou la liste de contrôle d’accès pour un chemin d’accès.
set_access_control_recursive	Définit le Access Control sur un chemin et des sous-chemins.
set_file_expiry	Définit l’heure d’expiration et de suppression d’un fichier.
set_http_headers	Définit les propriétés système sur le fichier ou le répertoire. Si une propriété est définie pour le content_settings, toutes les propriétés sont remplacées.
set_metadata	Définit une ou plusieurs paires nom-valeur définies par l’utilisateur pour le système de fichiers spécifié. Chaque appel à cette opération remplace toutes les métadonnées existantes attachées au système de fichiers. Pour supprimer toutes les métadonnées du système de fichiers, appelez cette opération sans dictée de métadonnées.
update_access_control_recursive	Modifie le Access Control sur un chemin d’accès et des sous-chemins.
upload_data	Charger des données dans un fichier.

Partager via

DataLakeFileClient Classe

Constructeur

Paramètres

Exemples

Variables

Méthodes

acquire_lease

Paramètres

Retours

Type de retour

append_data

Paramètres

Retours

Exemples

close

create_file

Paramètres

Retours

Exemples

delete_file

Paramètres

Retours

Exemples

download_file

Paramètres

Retours

Type de retour

Exemples

exists

Paramètres

Retours

Type de retour

flush_data

Paramètres

Retours

Exemples

from_connection_string

Paramètres

get_access_control

Paramètres

get_file_properties

Paramètres

Retours

Type de retour

Exemples

query_file

Paramètres

Retours

Type de retour

Exemples

remove_access_control_recursive

Paramètres

Retours

Type de retour

Exceptions

rename_file

Paramètres

Retours

Type de retour

Exemples

set_access_control

Paramètres

set_access_control_recursive

Paramètres

Retours

Type de retour

Exceptions

set_file_expiry

Paramètres

Type de retour

set_http_headers

Paramètres

Retours

Type de retour

set_metadata

Paramètres

Retours

update_access_control_recursive

Paramètres