AdlsClient Klasse

Definition

Namespace:

Microsoft.Azure.DataLake.Store

Assembly:

Microsoft.Azure.DataLake.Store.dll

Paket:

Microsoft.Azure.DataLake.Store v1.1.24

Client von Azure Data Lake Store. Es enthält die öffentlichen APIs zum Ausführen von Vorgängen der REST-API, die einfacher aufzurufen und besser als Core-APIs verwendet werden können. Kern-APIs bieten mehr Freiheit, aber ADLSClient bietet häufiger verwendete Formulare. Es kapselt das Autorisierungstoken und die Tokenaktualisierung. Enthält Factorymethoden, die ein ServiceClientCredential- oder ein Zeichenfolgenauthentifizierungstoken akzeptiert und instance dieser Klasse zurückgibt. Für jeden Vorgang wird eine asynchrone und eine Synchronisierungsversion bereitgestellt. Jede Synchronisierungsmethode ist eine Wait on async-Methode mit Ausnahme von Create und Concurrent append. Alle APIs sind threadsicher, mit einigen Ausnahmen in CreateFile und GetAppendStream. CreateFile und GetAppendStream können nicht für denselben Pfad aus verschiedenen Threads aufgerufen werden, da das Schreiben mit einer Lease erfolgt, sodass Leasekonflikte auftreten. Wenn eine Anwendung Multithreadvorgänge mit diesem SDK ausführen möchte, wird dringend empfohlen, ServicePointManager.DefaultConnectionLimit auf die Anzahl der Threads festzulegen, die das SDK verwenden soll, bevor eine instance von AdlsClient erstellt wird. Standardmäßig ist ServicePointManager.DefaultConnectionLimit auf 2 festgelegt. Adls verwenden NLog für die Protokollierung. adls.dotnet.* ist der Name der Protokollierung, um alle Protokolle abzurufen.

public class AdlsClient

type AdlsClient = class

Public Class AdlsClient

Vererbung

Object

AdlsClient

Abgeleitet

Microsoft.Azure.DataLake.Store.MockAdlsFileSystem.MockAdlsClient

Konstruktoren

AdlsClient()

Geschützter Konstruktor für Moq-Tests

Felder

ClientLogger

Protokollierung für Protokollinformationen (Debug/Fehler/Ablaufverfolgung) in Bezug auf den Client

Eigenschaften

AccountFQDN	Kontoname des Azure Data Lake-Speicherkontos einschließlich des vollständigen Domänennamens
ClientId	Clientobjekt-ID
DefaultNumThreads	Standardmäßige Anzahl von Threads, die von Tools wie Uploader/Downloader, rekursiven ACL-Änderungen und anderen Multithreadtools verwendet werden, die das SDK verwenden. Kann verwendet werden, um ServicePointManager.DefaultConnectionLimit festzulegen, wenn das SDK die Anzahl der Threads festlegen soll, die es für Multithreadtools verwendet.

Methoden

AddUserAgentSuffix(String)	Fügt das Suffix des Benutzer-Agents hinzu.
BulkDownload(String, String, Int32, IfExists, Boolean, IProgress<TransferStatus>, Boolean, Boolean, CancellationToken)	Laden Sie das Verzeichnis oder die Datei vom Remoteserver auf lokal herunter. Überträgt den Inhalt unter dem Quellverzeichnis unter das Zielverzeichnis. Überträgt die Quelldatei und speichert sie als Zielpfad. Diese Methode löst keine Ausnahme für den Übertragungsfehler eines Eintrags aus. Lesen Sie den RückgabewertTransferStatus, um die status/Ausnahme der Übertragung jedes Eintrags abzurufen. Standardmäßig protokolliert den Übertragungsfortschritt im temporären Pfad des Systems, sodass der Benutzer mit resume wiederherstellen kann, wenn der Upload abgestürzt ist. Diese Statusprotokollierung kann mit disableTransferLoggingdeaktiviert werden. Es wird dringend empfohlen, ServicePointManager.DefaultConnectionLimit auf die Anzahl der Threads festzulegen, die die Anwendung verwenden soll, bevor Sie instance von AdlsClient erstellen. Standardmäßig ist ServicePointManager.DefaultConnectionLimit auf 2 festgelegt.
BulkDownload(String, String, Int32, IfExists, IProgress<TransferStatus>, Boolean, Boolean, CancellationToken)	Laden Sie das Verzeichnis oder die Datei vom Remoteserver auf lokal herunter. Überträgt den Inhalt unter dem Quellverzeichnis unter das Zielverzeichnis. Überträgt die Quelldatei und speichert sie als Zielpfad. Diese Methode löst keine Ausnahme für den Übertragungsfehler eines Eintrags aus. Lesen Sie den RückgabewertTransferStatus, um die status/Ausnahme der Übertragung jedes Eintrags abzurufen. Es wird dringend empfohlen, ServicePointManager.DefaultConnectionLimit auf die Anzahl der Threads festzulegen, die die Anwendung verwenden soll, bevor Sie instance von AdlsClient erstellen. Standardmäßig ist ServicePointManager.DefaultConnectionLimit auf 2 festgelegt.
BulkUpload(String, String, Int32, IfExists, Boolean, IProgress<TransferStatus>, Boolean, Boolean, Boolean, CancellationToken)	Laden Sie das Verzeichnis oder die Datei von lokal in die Remotedatei hoch. Überträgt den Inhalt unter dem Quellverzeichnis unter das Zielverzeichnis. Überträgt die Quelldatei und speichert sie als Zielpfad. Diese Methode löst keine Ausnahme für den Übertragungsfehler eines Eintrags aus. Lesen Sie den RückgabewertTransferStatus, um die status/Ausnahme der Übertragung jedes Eintrags abzurufen. Standardmäßig protokolliert den Übertragungsfortschritt im temporären Pfad des Systems, sodass der Benutzer mit resume wiederherstellen kann, wenn der Upload abgestürzt ist. Diese Statusprotokollierung kann mit disableTransferLoggingdeaktiviert werden. Es wird dringend empfohlen, ServicePointManager.DefaultConnectionLimit auf die Anzahl der Threads festzulegen, die die Anwendung verwenden soll, bevor Sie instance von AdlsClient erstellen. Standardmäßig ist ServicePointManager.DefaultConnectionLimit auf 2 festgelegt. Standardmäßig werden Dateien an neuen Zeilengrenzen hochgeladen. Wenn Dateien jedoch keinen Zeilenumbruch innerhalb von 4 MB-Blöcken aufweisen, schlägt die Übertragung fehl. In diesem Fall muss true an übergeben werden, isBinary um Uploads an Zeilenumbruchgrenzen zu vermeiden.
BulkUpload(String, String, Int32, IfExists, IProgress<TransferStatus>, Boolean, Boolean, Boolean, CancellationToken)	Laden Sie das Verzeichnis oder die Datei von lokal in die Remotedatei hoch. Überträgt den Inhalt unter dem Quellverzeichnis unter das Zielverzeichnis. Überträgt die Quelldatei und speichert sie als Zielpfad. Diese Methode löst keine Ausnahme für den Übertragungsfehler eines Eintrags aus. Lesen Sie den RückgabewertTransferStatus, um die status/Ausnahme der Übertragung jedes Eintrags abzurufen. Es wird dringend empfohlen, ServicePointManager.DefaultConnectionLimit auf die Anzahl der Threads festzulegen, die die Anwendung verwenden soll, bevor Sie instance von AdlsClient erstellen. Standardmäßig ist ServicePointManager.DefaultConnectionLimit auf 2 festgelegt. Standardmäßig werden Dateien an neuen Zeilengrenzen hochgeladen. Wenn Dateien jedoch keinen Zeilenumbruch innerhalb von 4 MB-Blöcken aufweisen, schlägt die Übertragung fehl. In diesem Fall muss true an übergeben werden, isBinary um Uploads an Zeilenumbruchgrenzen zu vermeiden.
ChangeAcl(String, List<AclEntry>, RequestedAclType, Int32, IProgress<AclProcessorStats>, CancellationToken)	Ändern sie Acl (Ändern, Festlegen und Entfernen) rekursiv in einer Verzeichnisstruktur Es wird dringend empfohlen, ServicePointManager.DefaultConnectionLimit auf die Anzahl der Threads festzulegen, die die Anwendung verwenden möchte, bevor Sie instance von AdlsClient erstellen. Standardmäßig ist ServicePointManager.DefaultConnectionLimit auf 2 festgelegt.
ChangeAcl(String, List<AclEntry>, RequestedAclType, Int32)	Ändern sie Acl (Ändern, Festlegen und Entfernen) rekursiv in einer Verzeichnisstruktur Es wird dringend empfohlen, ServicePointManager.DefaultConnectionLimit auf die Anzahl der Threads festzulegen, die die Anwendung verwenden möchte, bevor Sie instance von AdlsClient erstellen. Standardmäßig ist ServicePointManager.DefaultConnectionLimit auf 2 festgelegt.
CheckAccess(String, String, CancellationToken)	Überprüft, ob der Benutzer/die Gruppe den Zugriff auf den angegebenen Pfad angegeben hat.
CheckAccessAsync(String, String, CancellationToken)	Überprüft asynchron, ob der Benutzer/die Gruppe den Zugriff auf den angegebenen Pfad angegeben hat.
CheckExists(String)	Überprüft, ob die Datei oder das Verzeichnis vorhanden ist
ConcatenateFiles(String, List<String>, Boolean, CancellationToken)	Synchrone API zum Verketten von Quelldateien mit einer Zieldatei
ConcatenateFilesAsync(String, List<String>, Boolean, CancellationToken)	Asynchrone API zum Verketten von Quelldateien mit einer Zieldatei
ConcurrentAppend(String, Boolean, Byte[], Int32, Int32)	Synchrone API zum Ausführen des gleichzeitigen Anfügens auf dem Server. Der Offset, an dem das Anfüge ausgeführt wird, wird vom Server bestimmt. Es wird dringend empfohlen, diese API mit einer Datengröße von weniger als 4 MB aufzurufen. Back-End-Gurantees 4 MB atomare Anhänge.
ConcurrentAppendAsync(String, Boolean, Byte[], Int32, Int32, CancellationToken)	Asynchrone API zum Ausführen des gleichzeitigen Anfügevorgangs auf dem Server. Der Offset, an dem das Anfüge ausgeführt wird, wird vom Server bestimmt. Asynchroner Vorgang. Es wird dringend empfohlen, diese API mit einer Datengröße von weniger als 4 MB aufzurufen. Back-End-Gurantees 4 MB atomare Anhänge.
CreateClient(String, ServiceClientCredentials)	Factory-Methode, die mithilfe von ServiceClientCredential eine instance von AdlsClient erstellt. Wenn eine Anwendung Multithreadvorgänge mit diesem SDK ausführen möchte, wird dringend empfohlen, ServicePointManager.DefaultConnectionLimit auf die Anzahl von Threads festzulegen, die die Anwendung verwenden möchte, bevor Sie instance von AdlsClient erstellen. Standardmäßig ist ServicePointManager.DefaultConnectionLimit auf 2 festgelegt.
CreateClient(String, String)	Factorymethode, die mithilfe des Tokenschlüssels einen instance AdlsClient erstellt. Wenn eine Anwendung Multithreadvorgänge mit diesem SDK ausführen möchte, wird dringend empfohlen, ServicePointManager.DefaultConnectionLimit auf die Anzahl der Threads festzulegen, die das SDK verwenden soll, bevor instance von AdlsClient erstellt wird. Standardmäßig ist ServicePointManager.DefaultConnectionLimit auf 2 festgelegt.
CreateDirectory(String, String, CancellationToken)	Synchrone API zum Erstellen eines Verzeichnisses
CreateDirectoryAsync(String, String, CancellationToken)	Asynchrone API zum Erstellen eines Verzeichnisses.
CreateFile(String, IfExists, String, Boolean)	Synchrone API, die eine Datei erstellt und den Stream zum Schreiben von Daten in diese Datei in ADLS zurückgibt. Die Datei wird mit exklusivem Zugriff geöffnet. Jeder Versuch, dieselbe Datei für das Anfügen zu öffnen, schlägt fehl, während dieser Stream geöffnet ist. Threading: Der zurückgegebene Stream ist nicht threadsicher.
CreateFileAsync(String, IfExists, String, Boolean, CancellationToken)	Asynchrone API, die eine Datei erstellt und den Datenstrom zum Schreiben von Daten in diese Datei in ADLS zurückgibt. Die Datei wird mit exklusivem Zugriff geöffnet. Jeder Versuch, dieselbe Datei für das Anfügen zu öffnen, schlägt fehl, während dieser Stream geöffnet ist. Threading: Der zurückgegebene Stream ist nicht threadsicher.
Delete(String, CancellationToken)	Synchrone API zum Löschen einer Datei oder eines Verzeichnisses. Für das Verzeichnis wird nur gelöscht, wenn es leer ist.
DeleteAsync(String, CancellationToken)	Asynchrone API zum Löschen einer Datei oder eines Verzeichnisses. Für das Verzeichnis wird nur gelöscht, wenn es leer ist.
DeleteRecursive(String, CancellationToken)	Synchrone API zum rekursiven Löschen einer Datei oder eines Verzeichnisses. Wenn es sich um ein nicht leeres Verzeichnis handelt, werden die Unterverzeichnisse oder Dateien gelöscht.
DeleteRecursiveAsync(String, CancellationToken)	Asynchrone API zum rekursiven Löschen einer Datei oder eines Verzeichnisses
EnumerateDeletedItems(String, String, Int32, IProgress<EnumerateDeletedItemsProgress>, CancellationToken)	Durchsuchen Sie den Papierkorb unter einem Konto mit Einem Hinweis und einem Ausgangspunkt. Dies ist ein lang andauernder Vorgang, und der Benutzer wird in regelmäßigen Abständen mit dem Status aktualisiert. Achtung: Das Wiederherstellen von Dateien ist ein optimaler Vorgang. Es gibt keine Garantie dafür, dass eine Datei wiederhergestellt werden kann, nachdem sie gelöscht wurde. Die Verwendung dieser API wird über whitelisting aktiviert. Wenn Ihr ADL-Konto nicht in der Whitelist aufgeführt ist, löst die Verwendung dieser API die Ausnahme Not immplemented aus. Wenden Sie sich an den Microsoft-Support, um weitere Informationen und Unterstützung zu erhalten.
EnumerateDeletedItemsAsync(String, String, Int32, IProgress<EnumerateDeletedItemsProgress>, CancellationToken)	Ruft die Papierkorbeinträge asynchron ab Vorsicht: Das Wiederherstellen von Dateien ist ein Best-Effort-Vorgang. Es gibt keine Garantie dafür, dass eine Datei wiederhergestellt werden kann, nachdem sie gelöscht wurde. Die Verwendung dieser API wird über whitelisting aktiviert. Wenn Ihr ADL-Konto nicht in der Whitelist aufgeführt ist, löst die Verwendung dieser API die Ausnahme Not immplemented aus. Wenden Sie sich an den Microsoft-Support, um weitere Informationen und Unterstützung zu erhalten.
EnumerateDirectory(String, UserGroupRepresentation, CancellationToken)	Gibt eine Aufzählung zurück, die die in einem Verzeichnis enthaltenen Unterverzeichnisse oder Dateien aufzählt. Standardmäßig sind listAfter und listBefore leer, und alle Verzeichniseinträge werden aufgelistet.
GetAclStatus(String, UserGroupRepresentation, CancellationToken)	Ruft die ACL-Eintragsliste, Besitzer-ID, Gruppen-ID, oktale Berechtigung und sticky Bit (nur für ein Verzeichnis) der Datei/des Verzeichnisses ab.
GetAclStatusAsync(String, UserGroupRepresentation, CancellationToken)	Ruft asynchron die ACL-Eintragsliste, die Besitzer-ID, die Gruppen-ID, die oktale Berechtigung und das persistente Bit (nur für ein Verzeichnis) der Datei/des Verzeichnisses ab.
GetAppendStream(String, CancellationToken)	Synchrone API, die den Datenstrom zurückgibt, um Daten in eine Datei in ADLS zu schreiben. Die Datei wird mit exklusivem Zugriff geöffnet. Jeder Versuch, dieselbe Datei für das Anfügen zu öffnen, schlägt fehl, während dieser Stream geöffnet ist. Threading: Der zurückgegebene Stream ist nicht threadsicher.
GetAppendStreamAsync(String, CancellationToken)	Asynchrone API, die den Datenstrom zurückgibt, um Daten in eine Datei in ADLS zu schreiben. Die Datei wird mit exklusivem Zugriff geöffnet. Jeder Versuch, dieselbe Datei für das Anfügen zu öffnen, schlägt fehl, während dieser Stream geöffnet ist. Threading: Der zurückgegebene Stream ist nicht threadsicher.
GetContentSummary(String, Int32, CancellationToken)	Ruft eine Inhaltszusammenfassung einer Datei oder eines Verzeichnisses ab. Es wird dringend empfohlen, ServicePointManager.DefaultConnectionLimit auf die Anzahl der Threads festzulegen, die das SDK verwenden soll, bevor instance von AdlsClient erstellt werden. Standardmäßig ist ServicePointManager.DefaultConnectionLimit auf 2 festgelegt.
GetDirectoryEntry(String, UserGroupRepresentation, CancellationToken)	Ruft synchron Metadaten wie vollständiger Pfad, Typ (Datei oder Verzeichnis), Gruppe, Benutzer, Berechtigung, Länge, letzte Zugriffszeit, Letzte Änderungszeit, Ablaufzeit, acl Bit, Replikationsfaktor ab.
GetDirectoryEntryAsync(String, UserGroupRepresentation, CancellationToken)	Ruft asynchron Metadaten wie vollständiger Pfad, Typ (Datei oder Verzeichnis), Gruppe, Benutzer, Berechtigung, Länge, letzte Zugriffszeit, Letzte Änderungszeit, Ablaufzeit, acl Bit, Replikationsfaktor ab.
GetExceptionFromResponse(OperationResponse, String)	Gibt eine ADLS-Ausnahme basierend auf der Antwort vom Server zurück.
GetFileProperties(String, Boolean, String, Boolean, Boolean, Int32, Boolean, Boolean, Int64, CancellationToken)	Speicheret die Dateieigenschaft aller Verzeichnisse oder/und Dateien unter dem angegebenen Pfad zu einer lokalen oder adl-Datei rekursiv ab. Die Dateieigenschaft kann die Datenträgerverwendung oder Acl oder beides sein. Es wird dringend empfohlen, ServicePointManager.DefaultConnectionLimit auf die Anzahl der Threads festzulegen, die das SDK verwenden soll, bevor instance von AdlsClient erstellt werden. Standardmäßig ist ServicePointManager.DefaultConnectionLimit auf 2 festgelegt.
GetReadStream(String, CancellationToken)	Synchrone API, die den Datenstrom zum Lesen von Daten aus der Datei in ADLS zurückgibt
GetReadStream(String, Int32, CancellationToken)	Synchrone API, die den Datenstrom zum Lesen von Daten aus der Datei in ADLS zurückgibt
GetReadStreamAsync(String, CancellationToken)	Asynchrone API, die den Datenstrom zum Lesen von Daten aus der Datei in ADLS zurückgibt
GetReadStreamAsync(String, Int32, CancellationToken)	Asynchrone API, die den Datenstrom zum Lesen von Daten aus der Datei in ADLS zurückgibt
ModifyAclEntries(String, List<AclEntry>, CancellationToken)	Ändert ACL-Einträge einer Datei oder eines Verzeichnisses mit der angegebenen ACL-Liste. Es führt die exisitng-ACL-Liste mit der angegebenen Liste zusammen.
ModifyAclEntriesAsync(String, List<AclEntry>, CancellationToken)	Ändert acl-Einträge einer Datei oder eines Verzeichnisses mit der angegebenen ACL-Liste asynchron. Es führt die exisitng-ACL-Liste mit der angegebenen Liste zusammen.
RemoveAclEntries(String, List<AclEntry>, CancellationToken)	Entfernt die angegebenen Acl-Einträge für eine Datei oder ein Verzeichnis.
RemoveAclEntriesAsync(String, List<AclEntry>, CancellationToken)	Entfernt die angegebenen Acl-Einträge für eine Datei oder ein Verzeichnis asynchron.
RemoveAllAcls(String, CancellationToken)	Entfernt alle Acl-Einträge für eine Datei oder ein Verzeichnis.
RemoveAllAclsAsync(String, CancellationToken)	Entfernt asynchron alle Acl-Einträge für eine Datei oder ein Verzeichnis.
RemoveDefaultAcls(String, CancellationToken)	Entfernt alle Acl-Einträge der Standardeinstellung AclScope für eine Datei oder ein Verzeichnis.
RemoveDefaultAclsAsync(String, CancellationToken)	Entfernt asynchron alle Acl-Einträge der Standardeinstellung AclScope für eine Datei oder ein Verzeichnis.
Rename(String, String, Boolean, CancellationToken)	Synchrone API zum Umbenennen einer Datei oder eines Verzeichnisses. Umbenennungsverzeichnis: Wenn das Ziel vorhanden ist, wird das Quellverzeichnis um eine Ebene unter dem Ziel platziert.
RenameAsync(String, String, Boolean, CancellationToken)	Asynchrone API zum Umbenennen einer Datei oder eines Verzeichnisses. Umbenennungsverzeichnis: Wenn das Ziel vorhanden ist, wird das Quellverzeichnis um eine Ebene unter dem Ziel platziert.
RestoreDeletedItems(String, String, String, String, CancellationToken)	Synchrones Wiederherstellen des Papierkorbeintrags Vorsicht: Das Wiederherstellen von Dateien ist ein optimaler Vorgang. Es gibt keine Garantie dafür, dass eine Datei wiederhergestellt werden kann, nachdem sie gelöscht wurde. Die Verwendung dieser API wird über whitelisting aktiviert. Wenn Ihr ADL-Konto nicht in der Whitelist aufgeführt ist, löst die Verwendung dieser API die Ausnahme Not immplemented aus. Wenden Sie sich an den Microsoft-Support, um weitere Informationen und Unterstützung zu erhalten.
RestoreDeletedItemsAsync(String, String, String, String, CancellationToken)	Wiederherstellen des Papierkorbeintrags asynchron Vorsicht: Das Wiederherstellen von Dateien ist ein optimaler Vorgang. Es gibt keine Garantie dafür, dass eine Datei wiederhergestellt werden kann, nachdem sie gelöscht wurde. Die Verwendung dieser API wird über whitelisting aktiviert. Wenn Ihr ADL-Konto nicht in der Whitelist aufgeführt ist, löst die Verwendung dieser API die Ausnahme Not immplemented aus. Wenden Sie sich an den Microsoft-Support, um weitere Informationen und Unterstützung zu erhalten.
SetAcl(String, List<AclEntry>, CancellationToken)	Legt Acl-Einträge für eine Datei oder ein Verzeichnis fest. Die vorhandenen Acl-Einträge für den Pfad werden gelöscht.
SetAclAsync(String, List<AclEntry>, CancellationToken)	Legt Acl-Einträge für eine Datei oder ein Verzeichnis asynchron fest. Die vorhandenen Acl-Einträge für den Pfad werden gelöscht.
SetConditionalCreateWithOverwrite(Boolean)	Legt fest, ob die bedingte Erstellung mit Überschreibung ausgeführt werden soll. Hilft beim Beheben von atomischen Problemen mit Wiederholungsversuchen
SetExpiryTime(String, ExpiryOption, Int64, CancellationToken)	Synchrones Festlegen der Ablaufzeit
SetExpiryTimeAsync(String, ExpiryOption, Int64, CancellationToken)	Legt die Ablaufzeit asynchron fest
SetOwner(String, String, String, CancellationToken)	Legt den Besitzer oder/und die Gruppe des Pfads fest.
SetOwnerAsync(String, String, String, CancellationToken)	Legt den Besitzer oder/und die Gruppe des Pfads asynchron fest.
SetPermission(String, String, CancellationToken)	Legt die Berechtigung des angegebenen Pfads fest.
SetPermissionAsync(String, String, CancellationToken)	Legt die Berechtigung des angegebenen Pfads asynchron fest.
SetPerRequestTimeout(TimeSpan)	Legt das Timeout pro Anforderung fest. Es wird dringend empfohlen, ihn nach dem Erstellen eines Clients festzulegen. Es wird nicht empfohlen, sie festzulegen, während Anforderungen aus einem anderen Thread ausgeführt werden.
SetToken(String)	Legt das Authentifizierungstoken fest.