DataLakeDirectoryClient class

Erstellt eine Instanz von DataLakePathClient aus url und Pipeline.

new DataLakeDirectoryClient(url: string, pipeline: Pipeline)

Parameter

Erstellt eine Instanz von DataLakePathClient aus URL und Anmeldeinformationen.

new DataLakeDirectoryClient(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 vonDataLakePathClient.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

vonDataLakePathClient.credential

Codierter URL-Zeichenfolgenwert.

url: string

Eigenschaftswert

vonDataLakePathClient.url geerbt

Erstellen Sie ein Verzeichnis.

Siehe https://docs.microsoft.com/en-us/rest/api/storageservices/datalakestoragegen2/path/create

function create(options?: DirectoryCreateOptions): Promise<DirectoryCreateResponse>

Parameter

Gibt zurück

Erstellen Sie ein Verzeichnis.

Siehe https://docs.microsoft.com/en-us/rest/api/storageservices/datalakestoragegen2/path/create

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

Parameter

Gibt zurück

Erstellen Sie ein Verzeichnis, wenn es noch nicht vorhanden ist.

Siehe https://docs.microsoft.com/en-us/rest/api/storageservices/datalakestoragegen2/path/create

function createIfNotExists(options?: DirectoryCreateIfNotExistsOptions): Promise<DirectoryCreateIfNotExistsResponse>

Parameter

Gibt zurück

Erstellen Sie ein Verzeichnis, wenn es noch nicht vorhanden ist.

Siehe https://docs.microsoft.com/en-us/rest/api/storageservices/datalakestoragegen2/path/create

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

Parameter

Gibt zurück

Generiert Zeichenfolge zum Signieren für einen SAS-URI (Service Shared Access Signature) basierend auf den Clienteigenschaften und Parametern, die übergeben werden.

Siehe https://docs.microsoft.com/en-us/rest/api/storageservices/constructing-a-service-sas

function generateSasStringToSign(options: DirectoryGenerateSasUrlOptions): string

Parameter

Gibt zurück

Der SAS-URI, der aus dem URI für die Ressource besteht, die von diesem Client dargestellt wird, gefolgt vom generierten SAS-Token.

Nur für Clients verfügbar, die mit freigegebenen Schlüsselanmeldeinformationen erstellt wurden.

Generiert einen SAS-URI (Service Shared Access Signature) basierend auf den Clienteigenschaften und Parametern, die übergeben werden. Die SAS wird von den freigegebenen Schlüsselanmeldeinformationen des Clients signiert.

Siehe https://docs.microsoft.com/en-us/rest/api/storageservices/constructing-a-service-sas

function generateSasUrl(options: DirectoryGenerateSasUrlOptions): Promise<string>

Parameter

Gibt zurück

Der SAS-URI, der aus dem URI für die Ressource besteht, die von diesem Client dargestellt wird, gefolgt vom generierten SAS-Token.

Generiert Zeichenfolge zum Signieren für einen SAS-URI (Service Shared Access Signature) basierend auf den Clienteigenschaften und Parametern, die in The SAS übergeben werden, wird vom Eingabebenutzerdelegierungsschlüssel signiert.

Siehe https://docs.microsoft.com/en-us/rest/api/storageservices/constructing-a-service-sas

function generateUserDelegationSasStringToSign(options: DirectoryGenerateSasUrlOptions, userDelegationKey: UserDelegationKey): string

Parameter

Gibt zurück

Der SAS-URI, der aus dem URI für die Ressource besteht, die von diesem Client dargestellt wird, gefolgt vom generierten SAS-Token.

Generiert einen SAS-URI (Service Shared Access Signature) basierend auf den Clienteigenschaften und Parametern, die übergeben werden. Die SAS wird vom Eingabebenutzerdelegierungsschlüssel signiert.

Siehe https://docs.microsoft.com/en-us/rest/api/storageservices/constructing-a-service-sas

function generateUserDelegationSasUrl(options: DirectoryGenerateSasUrlOptions, userDelegationKey: UserDelegationKey): Promise<string>

Parameter

Gibt zurück

Der SAS-URI, der aus dem URI für die Ressource besteht, die von diesem Client dargestellt wird, gefolgt vom generierten SAS-Token.

Erstellt ein DataLakeFileClient- -Objekt unter dem aktuellen Verzeichnis.

function getFileClient(fileName: string): DataLakeFileClient

Parameter

Gibt zurück

Erstellt ein DataLakeDirectoryClient -Objekt unter dem aktuellen Verzeichnis.

function getSubdirectoryClient(subdirectoryName: string): DataLakeDirectoryClient

Parameter

Gibt zurück

Aktuellen Pfad löschen (Verzeichnis oder Datei).

Siehe https://docs.microsoft.com/en-us/rest/api/storageservices/datalakestoragegen2/path/delete

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

Parameter

Gibt zurück

vonDataLakePathClient.delete geerbt

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

Siehe https://docs.microsoft.com/en-us/rest/api/storageservices/datalakestoragegen2/path/delete

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

Parameter

Gibt zurück

geerbt vonDataLakePathClient.deleteIfExists

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

VonDataLakePathClient geerbt.exists

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

Siehe https://docs.microsoft.com/en-us/rest/api/storageservices/datalakestoragegen2/path/getproperties

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

Parameter

Gibt zurück

geerbt vonDataLakePathClient.getAccessControl-

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

function getDataLakeLeaseClient(proposeLeaseId?: string): DataLakeLeaseClient

Parameter

Gibt zurück

Geerbt vonDataLakePathClient.getDataLakeLeaseClient

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://docs.microsoft.com/en-us/rest/api/storageservices/get-blob-properties

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

Parameter

Gibt zurück

geerbt vonDataLakePathClient.getProperties

Verschieben sie das Verzeichnis oder die Datei innerhalb desselben Dateisystems.

Siehe https://docs.microsoft.com/en-us/rest/api/storageservices/datalakestoragegen2/path/create

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

Parameter

Gibt zurück

geerbt vonDataLakePathClient.move

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

Siehe https://docs.microsoft.com/en-us/rest/api/storageservices/datalakestoragegen2/path/create

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

Parameter

Gibt zurück

geerbt vonDataLakePathClient.move

Entfernt die Zugriffssteuerung für einen Pfad und Unterpfad.

Siehe https://docs.microsoft.com/en-us/rest/api/storageservices/datalakestoragegen2/path/update

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

Parameter

Gibt zurück

geerbt vonDataLakePathClient.removeAccessControlRecursive

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

Siehe https://docs.microsoft.com/en-us/rest/api/storageservices/datalakestoragegen2/path/update

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

Parameter

Gibt zurück

Geerbt vonDataLakePathClient.setAccessControl

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

Siehe https://docs.microsoft.com/en-us/rest/api/storageservices/datalakestoragegen2/path/update

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

Parameter

Gibt zurück

geerbt vonDataLakePathClient.setAccessControlRecursive

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://docs.microsoft.com/en-us/rest/api/storageservices/set-blob-properties

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

Parameter

Gibt zurück

geerbt vonDataLakePathClient.setHttpHeaders

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://docs.microsoft.com/en-us/rest/api/storageservices/set-blob-metadata

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

Parameter

Gibt zurück

geerbt vonDataLakePathClient.setMetadata-

Legt die Dateiberechtigungen für einen Pfad fest.

Siehe https://docs.microsoft.com/en-us/rest/api/storageservices/datalakestoragegen2/path/update

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

Parameter

Gibt zurück

geerbt vonDataLakePathClient.setPermissions-

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

function toDirectoryClient(): DataLakeDirectoryClient

Gibt zurück

geerbt vonDataLakePathClient.toDirectoryClient

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

function toFileClient(): DataLakeFileClient

Gibt zurück

geerbt vonDataLakePathClient.toFileClient-

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

Siehe https://docs.microsoft.com/en-us/rest/api/storageservices/datalakestoragegen2/path/update

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

Parameter

Gibt zurück

vonDataLakePathClient.updateAccessControlRecursive