AdlsClient Classe

Définition

Espace de noms:

Microsoft.Azure.DataLake.Store

Assembly:

Microsoft.Azure.DataLake.Store.dll

Paquet:

Microsoft.Azure.DataLake.Store v1.1.24

Client d’Azure Data Lake Store. Il contient les API publiques pour effectuer des opérations d’API REST qui sont plus faciles à appeler et plus utilisables que les API core. Les API principales offrent plus de liberté, mais ADLSClient fournit des formulaires plus couramment utilisés. Il encapsule le jeton d’autorisation et l’actualisation du jeton. Contient des méthodes de fabrique qui acceptent un jeton d’authentification ServiceClientCredential ou de chaîne et retourne instance de cette classe. Pour chaque opération, il fournit une version asynchrone et de synchronisation. Chaque méthode de synchronisation est une méthode d’attente sur async, à l’exception de Create et De l’ajout simultané. Toutes les API sont thread safe avec quelques exceptions dans CreateFile et GetAppendStream. CreateFile et GetAppendStream ne peuvent pas être appelés pour le même chemin d’accès à partir de threads différents, car l’écriture est effectuée avec un bail, il y aura donc des conflits de bail Si une application souhaite effectuer des opérations multithread à l’aide de ce KIT de développement logiciel (SDK), il est vivement recommandé de définir ServicePointManager.DefaultConnectionLimit sur le nombre de threads que l’application souhaite utiliser avant de créer un instance d’AdlsClient. Par défaut, ServicePointManager.DefaultConnectionLimit a la valeur 2. Adls utilise NLog pour la journalisation. adls.dotnet.* est le nom de l’enregistreur d’événements permettant d’obtenir tous les journaux.

public class AdlsClient

type AdlsClient = class

Public Class AdlsClient

Héritage

Object

AdlsClient

Dérivé

Microsoft.Azure.DataLake.Store.MockAdlsFileSystem.MockAdlsClient

Constructeurs

AdlsClient()

Constructeur protégé pour les tests moq

Champs

ClientLogger

Journalisation des informations (débogage/erreur/trace) concernant le client

Propriétés

AccountFQDN	Nom du compte Azure Data Lake Store, y compris le nom de domaine complet
ClientId	ID d’objet client
DefaultNumThreads	Nombre par défaut de threads utilisés par des outils tels que le téléchargeur/téléchargeur, la modification acl récursive et d’autres outils multithreads à l’aide du Kit de développement logiciel (SDK). Peut être utilisé pour définir ServicePointManager.DefaultConnectionLimit si vous souhaitez que le SDK décide du nombre de threads qu’il utilise pour les outils multithreads.

Méthodes

AddUserAgentSuffix(String)	Ajoute le suffixe de l’agent utilisateur
BulkDownload(String, String, Int32, IfExists, Boolean, IProgress<TransferStatus>, Boolean, Boolean, CancellationToken)	Téléchargez le répertoire ou le fichier à partir d’un serveur distant vers un emplacement local. Transfère le contenu sous le répertoire source sous le répertoire de destination. Transfère le fichier source et l’enregistre en tant que chemin d’accès de destination. Cette méthode ne lève aucune exception pour l’échec de transfert d’une entrée. Reportez-vous à la valeur TransferStatus de retour pour obtenir le status/exception du transfert de chaque entrée. Par défaut, journalise la progression du transfert dans le chemin d’accès temporaire du système, afin que l’utilisateur puisse récupérer à l’aide resume d’un blocage du chargement. Cette journalisation de progression peut être désactivée à l’aide de disableTransferLogging. Il est vivement recommandé de définir ServicePointManager.DefaultConnectionLimit sur le nombre de threads que l’application souhaite que le sdk utilise avant de créer un instance d’AdlsClient. Par défaut, ServicePointManager.DefaultConnectionLimit a la valeur 2.
BulkDownload(String, String, Int32, IfExists, IProgress<TransferStatus>, Boolean, Boolean, CancellationToken)	Téléchargez le répertoire ou le fichier à partir d’un serveur distant vers un emplacement local. Transfère le contenu sous le répertoire source sous le répertoire de destination. Transfère le fichier source et l’enregistre en tant que chemin d’accès de destination. Cette méthode ne lève aucune exception pour l’échec de transfert d’une entrée. Reportez-vous à la valeur TransferStatus de retour pour obtenir le status/exception du transfert de chaque entrée. Il est vivement recommandé de définir ServicePointManager.DefaultConnectionLimit sur le nombre de threads que l’application souhaite que le sdk utilise avant de créer un instance d’AdlsClient. Par défaut, ServicePointManager.DefaultConnectionLimit a la valeur 2.
BulkUpload(String, String, Int32, IfExists, Boolean, IProgress<TransferStatus>, Boolean, Boolean, Boolean, CancellationToken)	Chargez le répertoire ou le fichier de local à distant. Transfère le contenu sous le répertoire source sous le répertoire de destination. Transfère le fichier source et l’enregistre en tant que chemin d’accès de destination. Cette méthode ne lève aucune exception pour l’échec de transfert d’une entrée. Reportez-vous à la valeur TransferStatus de retour pour obtenir le status/exception du transfert de chaque entrée. Par défaut, journalise la progression du transfert dans le chemin d’accès temporaire du système, afin que l’utilisateur puisse récupérer à l’aide resume d’un blocage du chargement. Cette journalisation de progression peut être désactivée à l’aide de disableTransferLogging. Il est vivement recommandé de définir ServicePointManager.DefaultConnectionLimit sur le nombre de threads que l’application souhaite que le sdk utilise avant de créer un instance d’AdlsClient. Par défaut, ServicePointManager.DefaultConnectionLimit a la valeur 2. Par défaut, les fichiers sont chargés aux nouvelles limites de ligne. Toutefois, si les fichiers n’ont pas de nouvelle ligne dans des segments de 4 Mo, le transfert échoue. Dans ce cas, il est nécessaire de passer true à isBinary pour éviter les chargements aux limites de nouvelle ligne.
BulkUpload(String, String, Int32, IfExists, IProgress<TransferStatus>, Boolean, Boolean, Boolean, CancellationToken)	Chargez le répertoire ou le fichier de local à distant. Transfère le contenu sous le répertoire source sous le répertoire de destination. Transfère le fichier source et l’enregistre en tant que chemin d’accès de destination. Cette méthode ne lève aucune exception pour l’échec de transfert d’une entrée. Reportez-vous à la valeur TransferStatus de retour pour obtenir le status/exception du transfert de chaque entrée. Il est vivement recommandé de définir ServicePointManager.DefaultConnectionLimit sur le nombre de threads que l’application souhaite que le sdk utilise avant de créer un instance d’AdlsClient. Par défaut, ServicePointManager.DefaultConnectionLimit a la valeur 2. Par défaut, les fichiers sont chargés aux nouvelles limites de ligne. Toutefois, si les fichiers n’ont pas de nouvelle ligne dans des segments de 4 Mo, le transfert échoue. Dans ce cas, il est nécessaire de passer true à isBinary pour éviter les chargements aux limites de nouvelle ligne.
ChangeAcl(String, List<AclEntry>, RequestedAclType, Int32)	Modifier Acl (Modifier, définir et supprimer) de manière récursive dans une arborescence de répertoires Il est vivement recommandé de définir ServicePointManager.DefaultConnectionLimit sur le nombre de threads que l’application souhaite que le sdk utilise avant de créer un instance d’AdlsClient. Par défaut, ServicePointManager.DefaultConnectionLimit a la valeur 2.
ChangeAcl(String, List<AclEntry>, RequestedAclType, Int32, IProgress<AclProcessorStats>, CancellationToken)	Modifier Acl (Modifier, définir et supprimer) de manière récursive dans une arborescence de répertoires Il est vivement recommandé de définir ServicePointManager.DefaultConnectionLimit sur le nombre de threads que l’application souhaite que le sdk utilise avant de créer un instance d’AdlsClient. Par défaut, ServicePointManager.DefaultConnectionLimit a la valeur 2.
CheckAccess(String, String, CancellationToken)	Vérifie si l’utilisateur/groupe a spécifié l’accès du chemin donné
CheckAccessAsync(String, String, CancellationToken)	Vérifie de manière asynchrone si l’utilisateur/groupe a spécifié l’accès du chemin donné
CheckExists(String)	Vérifie si le fichier ou le répertoire existe
ConcatenateFiles(String, List<String>, Boolean, CancellationToken)	API synchrone pour concaténer des fichiers sources dans un fichier de destination
ConcatenateFilesAsync(String, List<String>, Boolean, CancellationToken)	API asynchrone pour concaténer des fichiers sources dans un fichier de destination
ConcurrentAppend(String, Boolean, Byte[], Int32, Int32)	API synchrone pour effectuer une ajout simultané sur le serveur. Le décalage auquel l’ajout se produit est déterminé par le serveur. Il est vivement recommandé d’appeler cette API avec une taille de données inférieure à 4 Mo. Le back-end génère des ajouts atomiques de 4 Mo.
ConcurrentAppendAsync(String, Boolean, Byte[], Int32, Int32, CancellationToken)	API asynchrone pour effectuer une ajout simultané sur le serveur. Le décalage auquel l’ajout se produit est déterminé par le serveur. Opération asynchrone. Il est vivement recommandé d’appeler cette API avec une taille de données inférieure à 4 Mo. Le back-end génère des ajouts atomiques de 4 Mo.
CreateClient(String, ServiceClientCredentials)	Méthode de fabrique qui crée un instance d’AdlsClient à l’aide de ServiceClientCredential. Si une application souhaite effectuer des opérations multithread à l’aide de ce Kit de développement logiciel (SDK), il est vivement recommandé de définir ServicePointManager.DefaultConnectionLimit sur le nombre de threads que l’application souhaite que le sdk utilise avant de créer un instance d’AdlsClient. Par défaut, ServicePointManager.DefaultConnectionLimit a la valeur 2.
CreateClient(String, String)	Méthode de fabrique qui crée un instance AdlsClient à l’aide de la clé de jeton. Si une application souhaite effectuer des opérations multithread à l’aide de ce Kit de développement logiciel (SDK), il est vivement recommandé de définir ServicePointManager.DefaultConnectionLimit sur le nombre de threads que l’application souhaite que le sdk utilise avant de créer un instance d’AdlsClient. Par défaut, ServicePointManager.DefaultConnectionLimit a la valeur 2.
CreateDirectory(String, String, CancellationToken)	API synchrone pour créer un répertoire
CreateDirectoryAsync(String, String, CancellationToken)	API asynchrone pour créer un répertoire.
CreateFile(String, IfExists, String, Boolean)	API synchrone qui crée un fichier et retourne le flux pour écrire des données dans ce fichier dans ADLS. Le fichier est ouvert avec un accès exclusif : toute tentative d’ouverture du même fichier pour ajout échoue pendant l’ouverture de ce flux. Threading : le flux retourné n’est pas thread-safe.
CreateFileAsync(String, IfExists, String, Boolean, CancellationToken)	API asynchrone qui crée un fichier et retourne le flux pour écrire des données dans ce fichier dans ADLS. Le fichier est ouvert avec un accès exclusif : toute tentative d’ouverture du même fichier pour ajout échoue pendant l’ouverture de ce flux. Threading : le flux retourné n’est pas thread-safe.
Delete(String, CancellationToken)	API synchrone pour supprimer un fichier ou un répertoire. Pour le répertoire, il est supprimé uniquement s’il est vide.
DeleteAsync(String, CancellationToken)	API asynchrone pour supprimer un fichier ou un répertoire. Pour le répertoire, il est supprimé uniquement s’il est vide.
DeleteRecursive(String, CancellationToken)	API synchrone pour supprimer un fichier ou un répertoire de manière récursive. S’il s’agit d’un répertoire non vide, il supprime les sous-répertoires ou fichiers.
DeleteRecursiveAsync(String, CancellationToken)	API asynchrone pour supprimer un fichier ou un répertoire de manière récursive
EnumerateDeletedItems(String, String, Int32, IProgress<EnumerateDeletedItemsProgress>, CancellationToken)	Recherchez dans la corbeille sous un compte avec un indicateur et un point de départ. Il s’agit d’une opération de longue durée, et l’utilisateur est mis à jour régulièrement avec la progression. Attention : Annuler la suppression des fichiers est une opération de la meilleure façon. Il n’existe aucune garantie qu’un fichier peut être restauré une fois qu’il est supprimé. L’utilisation de cette API est activée via la liste verte. Si votre compte ADL ne figure pas dans la liste verte, l’utilisation de cette API lève l’exception Non implémentée. Pour plus d’informations et d’assistance, contactez le support Microsoft.
EnumerateDeletedItemsAsync(String, String, Int32, IProgress<EnumerateDeletedItemsProgress>, CancellationToken)	Obtient de manière asynchrone les entrées de la corbeille Attention : Annuler la suppression des fichiers est une opération de meilleur effort. Il n’existe aucune garantie qu’un fichier peut être restauré une fois qu’il est supprimé. L’utilisation de cette API est activée via la liste verte. Si votre compte ADL ne figure pas dans la liste verte, l’utilisation de cette API lève l’exception Non implémentée. Pour plus d’informations et d’assistance, contactez le support Microsoft.
EnumerateDirectory(String, UserGroupRepresentation, CancellationToken)	Retourne un énumérable qui énumère les sous-répertoires ou fichiers contenus dans un répertoire. Par défaut, listAfter et listBefore sont vides et nous énumérons toutes les entrées de répertoire.
GetAclStatus(String, UserGroupRepresentation, CancellationToken)	Obtient la liste d’entrée ACL, l’ID de propriétaire, l’ID de groupe, l’autorisation octal et le bit collant (uniquement pour un répertoire) du fichier/répertoire
GetAclStatusAsync(String, UserGroupRepresentation, CancellationToken)	Obtient de façon asynchrone la liste d’entrée de liste de contrôle d’accès, l’ID de propriétaire, l’ID de groupe, l’autorisation octal et le bit collant (uniquement pour un répertoire) du fichier/répertoire
GetAppendStream(String, CancellationToken)	API synchrone qui retourne le flux pour écrire des données dans un fichier dans ADLS. Le fichier est ouvert avec un accès exclusif : toute tentative d’ouverture du même fichier pour ajout échoue pendant l’ouverture de ce flux. Threading : le flux retourné n’est pas thread-safe.
GetAppendStreamAsync(String, CancellationToken)	API asynchrone qui retourne le flux pour écrire des données dans un fichier dans ADLS. Le fichier est ouvert avec un accès exclusif : toute tentative d’ouverture du même fichier pour ajout échoue pendant l’ouverture de ce flux. Threading : le flux retourné n’est pas thread-safe.
GetContentSummary(String, Int32, CancellationToken)	Obtient le résumé du contenu d’un fichier ou d’un répertoire. Il est vivement recommandé de définir ServicePointManager.DefaultConnectionLimit sur le nombre de threads que l’application doit utiliser par le sdk avant de créer une instance d’AdlsClient. Par défaut, ServicePointManager.DefaultConnectionLimit a la valeur 2.
GetDirectoryEntry(String, UserGroupRepresentation, CancellationToken)	Obtient de façon synchrone des métadonnées telles que le chemin complet, le type (fichier ou répertoire), le groupe, l’utilisateur, l’autorisation, la longueur, l’heure de la dernière modification, l’heure de la dernière modification, l’heure d’expiration, le bit acl, le facteur de réplication
GetDirectoryEntryAsync(String, UserGroupRepresentation, CancellationToken)	Obtient de manière asynchrone des métadonnées comme le chemin complet, le type (fichier ou répertoire), le groupe, l’utilisateur, l’autorisation, la longueur, l’heure de la dernière modification, l’heure de la dernière modification, l’heure d’expiration, le bit acl, le facteur de réplication
GetExceptionFromResponse(OperationResponse, String)	Retourne une exception ADLS en fonction de la réponse du serveur
GetFileProperties(String, Boolean, String, Boolean, Boolean, Int32, Boolean, Boolean, Int64, CancellationToken)	Vide de manière récursive la propriété de fichier de tous les répertoires ou/et fichiers sous le chemin d’accès donné à un fichier local ou adl. La propriété de fichier peut être utilisation du disque, Acl ou les deux. Il est vivement recommandé de définir ServicePointManager.DefaultConnectionLimit sur le nombre de threads que l’application doit utiliser par le sdk avant de créer une instance d’AdlsClient. Par défaut, ServicePointManager.DefaultConnectionLimit a la valeur 2.
GetReadStream(String, CancellationToken)	API synchrone qui retourne le flux pour lire les données à partir d’un fichier dans ADLS
GetReadStream(String, Int32, CancellationToken)	API synchrone qui retourne le flux pour lire les données à partir d’un fichier dans ADLS
GetReadStreamAsync(String, CancellationToken)	API asynchrone qui retourne le flux pour lire les données du fichier dans ADLS
GetReadStreamAsync(String, Int32, CancellationToken)	API asynchrone qui retourne le flux pour lire les données du fichier dans ADLS
ModifyAclEntries(String, List<AclEntry>, CancellationToken)	Modifie les entrées acl d’un fichier ou d’un répertoire avec une liste ACL donnée. Il fusionne la liste de listes de contrôle d’accès exisitng avec la liste donnée.
ModifyAclEntriesAsync(String, List<AclEntry>, CancellationToken)	Modifie de façon asynchrone les entrées acl d’un fichier ou d’un répertoire avec une liste ACL donnée. Il fusionne la liste de listes de contrôle d’accès exisitng avec la liste donnée.
RemoveAclEntries(String, List<AclEntry>, CancellationToken)	Supprime les entrées Acl spécifiées pour un fichier ou un répertoire.
RemoveAclEntriesAsync(String, List<AclEntry>, CancellationToken)	Supprime de façon asynchrone les entrées Acl spécifiées pour un fichier ou un répertoire.
RemoveAllAcls(String, CancellationToken)	Supprime toutes les entrées Acl d’un fichier ou d’un répertoire.
RemoveAllAclsAsync(String, CancellationToken)	Supprime de manière asynchrone toutes les entrées Acl pour un fichier ou un répertoire.
RemoveDefaultAcls(String, CancellationToken)	Supprime toutes les entrées Acl d’AclScope par défaut pour un fichier ou un répertoire.
RemoveDefaultAclsAsync(String, CancellationToken)	Supprime de façon asynchrone toutes les entrées Acl d’AclScope par défaut pour un fichier ou un répertoire.
Rename(String, String, Boolean, CancellationToken)	API synchrone pour renommer un fichier ou un répertoire. Pour renommer le répertoire : si la destination existe, il place le répertoire source d’un niveau sous la destination.
RenameAsync(String, String, Boolean, CancellationToken)	API asynchrone pour renommer un fichier ou un répertoire. Pour renommer le répertoire : si la destination existe, il place le répertoire source d’un niveau sous la destination.
RestoreDeletedItems(String, String, String, String, CancellationToken)	Restaurer de manière synchrone l’entrée de la corbeille Attention : annuler la suppression de fichiers est une opération de meilleur effort. Il n’existe aucune garantie qu’un fichier peut être restauré une fois qu’il est supprimé. L’utilisation de cette API est activée via la liste verte. Si votre compte ADL ne figure pas dans la liste verte, l’utilisation de cette API lève l’exception Non implémentée. Pour plus d’informations et d’assistance, contactez le support Microsoft.
RestoreDeletedItemsAsync(String, String, String, String, CancellationToken)	Restaure de manière asynchrone l’entrée de la corbeille Attention : annuler la suppression de fichiers est une opération de meilleur effort. Il n’existe aucune garantie qu’un fichier peut être restauré une fois qu’il est supprimé. L’utilisation de cette API est activée via la liste verte. Si votre compte ADL ne figure pas dans la liste verte, l’utilisation de cette API lève l’exception Non implémentée. Pour plus d’informations et d’assistance, contactez le support Microsoft.
SetAcl(String, List<AclEntry>, CancellationToken)	Définit les entrées Acl pour un fichier ou un répertoire. Il efface les entrées Acl existantes pour le chemin d’accès.
SetAclAsync(String, List<AclEntry>, CancellationToken)	Définit de façon asynchrone les entrées Acl pour un fichier ou un répertoire. Il efface les entrées Acl existantes pour le chemin d’accès.
SetConditionalCreateWithOverwrite(Boolean)	Définit s’il faut effectuer une création conditionnelle avec remplacement. Aide à résoudre les problèmes atomiques liés aux nouvelles tentatives
SetExpiryTime(String, ExpiryOption, Int64, CancellationToken)	Définit de manière synchrone l’heure d’expiration
SetExpiryTimeAsync(String, ExpiryOption, Int64, CancellationToken)	Définit de façon asynchrone l’heure d’expiration
SetOwner(String, String, String, CancellationToken)	Définit le propriétaire ou/et le groupe du chemin d’accès
SetOwnerAsync(String, String, String, CancellationToken)	Définit de façon asynchrone le propriétaire ou/et le groupe du chemin d’accès
SetPermission(String, String, CancellationToken)	Définit l’autorisation du chemin d’accès spécifié
SetPermissionAsync(String, String, CancellationToken)	Définit de manière asynchrone l’autorisation du chemin d’accès spécifié
SetPerRequestTimeout(TimeSpan)	Définit le délai d’expiration par requête. Nous vous recommandons vivement de le définir après la création du client. Il n’est pas recommandé de la définir pendant que les demandes sont en cours à partir d’un thread différent.
SetToken(String)	Définit le jeton d’authentification.