DataLakePathClient class

Erstellt eine Instanz von DataLakePathClient aus url und Pipeline.

new DataLakePathClient(url: string, pipeline: Pipeline)

Parameter

Erstellt eine Instanz von DataLakePathClient aus URL und Anmeldeinformationen.

new DataLakePathClient(url: string, credential?: StorageSharedKeyCredential | AnonymousCredential | TokenCredential, options?: StoragePipelineOptions)

Parameter

Name des aktuellen Dateisystems.

string fileSystemName

Eigenschaftswert

Name des aktuellen Pfads (Verzeichnis oder Datei).

string name

Eigenschaftswert

accountName: string

Eigenschaftswert

geerbt von StorageClient.accountName

Wie anonyme Anmeldeinformationen, StorageSharedKeyCredential oder anmeldeinformationen aus dem @azure/identity-Paket zum Authentifizieren von Anforderungen an den Dienst. Sie können auch ein Objekt bereitstellen, das die TokenCredential-Schnittstelle implementiert. Wenn nicht angegeben, wird AnonymousCredential verwendet.

credential: StorageSharedKeyCredential | AnonymousCredential | TokenCredential

Eigenschaftswert

von StorageClient.credential geerbt

Codierter URL-Zeichenfolgenwert.

url: string

Eigenschaftswert

geerbt von StorageClient.url

Erstellen Eines Verzeichnisses oder Pfads.

Siehe https://learn.microsoft.com/rest/api/storageservices/datalakestoragegen2/path/create

function create(resourceType: PathResourceType, options?: PathCreateOptions): Promise<PathCreateResponse>

Parameter

Gibt zurück

Erstellen Sie ein Verzeichnis oder eine Datei. Wenn die Ressource bereits vorhanden ist, wird sie nicht geändert.

Siehe https://learn.microsoft.com/rest/api/storageservices/datalakestoragegen2/path/create

function createIfNotExists(resourceType: PathResourceType, options?: PathCreateIfNotExistsOptions): Promise<PathCreateIfNotExistsResponse>

Parameter

Gibt zurück

Aktuellen Pfad löschen (Verzeichnis oder Datei).

Siehe https://learn.microsoft.com/rest/api/storageservices/datalakestoragegen2/path/delete

function delete(recursive?: boolean, options?: PathDeleteOptions): Promise<PathDeleteResponse>

Parameter

Gibt zurück

Löschen Sie den aktuellen Pfad (Verzeichnis oder Datei), falls vorhanden.

Siehe https://learn.microsoft.com/rest/api/storageservices/datalakestoragegen2/path/delete

function deleteIfExists(recursive?: boolean, options?: PathDeleteOptions): Promise<PathDeleteIfExistsResponse>

Parameter

Gibt zurück

Gibt true zurück, wenn die Data Lake-Datei, die durch diesen Client dargestellt wird, vorhanden ist; andernfalls "false".

HINWEIS: Verwenden Sie diese Funktion sorgfältig, da eine vorhandene Datei möglicherweise von anderen Clients oder Anwendungen gelöscht wird. Umgekehrt können neue Dateien von anderen Clients oder Anwendungen hinzugefügt werden, nachdem diese Funktion abgeschlossen wurde.

function exists(options?: PathExistsOptions): Promise<boolean>

Parameter

Gibt zurück

Gibt die Zugriffssteuerungsdaten für einen Pfad (Verzeichnis der Datei) zurück.

Siehe https://learn.microsoft.com/rest/api/storageservices/datalakestoragegen2/path/getproperties

function getAccessControl(options?: PathGetAccessControlOptions): Promise<PathGetAccessControlResponse>

Parameter

Gibt zurück

Rufen Sie eine DataLakeLeaseClient- ab, die Leases für den Pfad (Verzeichnis oder Datei) verwaltet.

function getDataLakeLeaseClient(proposeLeaseId?: string): DataLakeLeaseClient

Parameter

Gibt zurück

Gibt alle benutzerdefinierten Metadaten, Standard-HTTP-Eigenschaften und Systemeigenschaften für den Pfad (Verzeichnis oder Datei) zurück.

WARNUNG: Das in der Antwort zurückgegebene metadata-Objekt weist die Schlüssel in Kleinbuchstaben auf, auch wenn sie ursprünglich Großbuchstaben enthielten. Dies unterscheidet sich von den Metadatenschlüsseln, die von den Methoden von DataLakeFileSystemClient, die Pfade mithilfe der Option includeMetadata auflisten, die ihre ursprüngliche Groß-/Kleinschreibung beibehalten.

Siehe https://learn.microsoft.com/rest/api/storageservices/get-blob-properties

function getProperties(options?: PathGetPropertiesOptions): Promise<PathGetPropertiesResponse>

Parameter

Gibt zurück

Verschieben sie das Verzeichnis oder die Datei innerhalb desselben Dateisystems.

Siehe https://learn.microsoft.com/rest/api/storageservices/datalakestoragegen2/path/create

function move(destinationPath: string, options?: PathMoveOptions): Promise<PathMoveResponse>

Parameter

Gibt zurück

Verschieben sie das Verzeichnis oder die Datei in ein anderes Dateisystem.

Siehe https://learn.microsoft.com/rest/api/storageservices/datalakestoragegen2/path/create

function move(destinationFileSystem: string, destinationPath: string, options?: PathMoveOptions): Promise<PathMoveResponse>

Parameter

Gibt zurück

Entfernt die Zugriffssteuerung für einen Pfad und Unterpfad.

Siehe https://learn.microsoft.com/rest/api/storageservices/datalakestoragegen2/path/update

function removeAccessControlRecursive(acl: RemovePathAccessControlItem[], options?: PathChangeAccessControlRecursiveOptions): Promise<PathChangeAccessControlRecursiveResponse>

Parameter

Gibt zurück

Legen Sie die Zugriffssteuerungsdaten für einen Pfad (Verzeichnis der Datei) fest.

Siehe https://learn.microsoft.com/rest/api/storageservices/datalakestoragegen2/path/update

function setAccessControl(acl: PathAccessControlItem[], options?: PathSetAccessControlOptions): Promise<PathSetAccessControlResponse>

Parameter

Gibt zurück

Legt die Zugriffssteuerung für einen Pfad und Unterpfad fest.

Siehe https://learn.microsoft.com/rest/api/storageservices/datalakestoragegen2/path/update

function setAccessControlRecursive(acl: PathAccessControlItem[], options?: PathChangeAccessControlRecursiveOptions): Promise<PathChangeAccessControlRecursiveResponse>

Parameter

Gibt zurück

Legt Systemeigenschaften für den Pfad (Verzeichnis oder Datei) fest.

Wenn kein Wert angegeben oder kein Wert für die angegebenen BLOB-HTTP-Header bereitgestellt wird, werden diese BLOB-HTTP-Header ohne einen Wert gelöscht.

Siehe https://learn.microsoft.com/rest/api/storageservices/set-blob-properties

function setHttpHeaders(httpHeaders: PathHttpHeaders, options?: PathSetHttpHeadersOptions): Promise<PathSetHttpHeadersResponse>

Parameter

Gibt zurück

Legt benutzerdefinierte Metadaten für den angegebenen Pfad (Verzeichnis der Datei) als ein oder mehrere Name-Wert-Paare fest.

Wenn im Parameter keine Option angegeben oder keine Metadaten definiert sind, werden die Pfadmetadaten entfernt.

Siehe https://learn.microsoft.com/rest/api/storageservices/set-blob-metadata

function setMetadata(metadata?: Metadata, options?: PathSetMetadataOptions): Promise<PathSetMetadataResponse>

Parameter

Gibt zurück

Legt die Dateiberechtigungen für einen Pfad fest.

Siehe https://learn.microsoft.com/rest/api/storageservices/datalakestoragegen2/path/update

function setPermissions(permissions: PathPermissions, options?: PathSetPermissionsOptions): Promise<PathSetPermissionsResponse>

Parameter

Gibt zurück

Konvertieren Sie den aktuellen DataLakePathClient in DataLakeDirectoryClient, wenn der aktuelle Pfad ein Verzeichnis ist.

function toDirectoryClient(): DataLakeDirectoryClient

Gibt zurück

Konvertieren Sie den aktuellen DataLakePathClient in DataLakeFileClient, wenn der aktuelle Pfad eine Datei ist.

function toFileClient(): DataLakeFileClient

Gibt zurück

Ändert die Zugriffssteuerung für einen Pfad und Unterpfad.

Siehe https://learn.microsoft.com/rest/api/storageservices/datalakestoragegen2/path/update

function updateAccessControlRecursive(acl: PathAccessControlItem[], options?: PathChangeAccessControlRecursiveOptions): Promise<PathChangeAccessControlRecursiveResponse>

Parameter

Gibt zurück