DataLakePathClient class

Paket:

@azure/storage-file-datalake

Ein DataLakePathClient stellt eine URL zum Azure Storage-Pfad (Verzeichnis oder Datei) dar.

Extends

StorageClient

Konstruktoren

DataLakePathClient(string, Pipeline)	Erstellt eine Instanz von DataLakePathClient aus URL und Pipeline.
DataLakePathClient(string, StorageSharedKeyCredential | AnonymousCredential | TokenCredential, StoragePipelineOptions)	Erstellt eine Instanz von DataLakePathClient aus URL und Anmeldeinformationen.

Eigenschaften

fileSystemName	Name des aktuellen Dateisystems.
name	Name des aktuellen Pfads (Verzeichnis oder Datei).

Geerbte Eigenschaften

accountName
credential	z. B. AnonymousCredential, StorageSharedKeyCredential oder alle Anmeldeinformationen aus dem @azure/identity Paket, um Anforderungen an den Dienst zu authentifizieren. Sie können auch ein -Objekt bereitstellen, das die TokenCredential-Schnittstelle implementiert. Falls nicht angegeben, wird AnonymousCredential verwendet.
url	Codierter URL-Zeichenfolgenwert.

Methoden

create(PathResourceTypeModel, PathCreateOptions)	Erstellen Sie ein Verzeichnis oder einen Pfad. Siehe https://docs.microsoft.com/en-us/rest/api/storageservices/datalakestoragegen2/path/create
createIfNotExists(PathResourceTypeModel, PathCreateIfNotExistsOptions)	Erstellen Sie ein Verzeichnis oder eine Datei. Wenn die Ressource bereits vorhanden ist, wird sie nicht geändert. Siehe https://docs.microsoft.com/en-us/rest/api/storageservices/datalakestoragegen2/path/create.
delete(boolean, PathDeleteOptions)	Löschen Sie den aktuellen Pfad (Verzeichnis oder Datei). Siehe https://docs.microsoft.com/en-us/rest/api/storageservices/datalakestoragegen2/path/delete.
deleteIfExists(boolean, PathDeleteOptions)	Löschen Sie den aktuellen Pfad (Verzeichnis oder Datei), falls vorhanden. Siehe https://docs.microsoft.com/en-us/rest/api/storageservices/datalakestoragegen2/path/delete
exists(PathExistsOptions)	Gibt true zurück, wenn die von diesem Client dargestellte Data Lake-Datei vorhanden ist. false andernfalls. HINWEIS: Verwenden Sie diese Funktion mit Sorgfalt, 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 ist.
getAccessControl(PathGetAccessControlOptions)	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.
getDataLakeLeaseClient(string)	Rufen Sie eine ab DataLakeLeaseClient , die Leases für den Pfad (Verzeichnis oder Datei) verwaltet.
getProperties(PathGetPropertiesOptions)	Gibt alle benutzerdefinierten Metadaten, HTTP-Standardeigenschaften und Systemeigenschaften für den Pfad (Verzeichnis oder Datei) zurück. WARNUNG: Das metadata in der Antwort zurückgegebene Objekt weist seine Schlüssel in Kleinbuchstaben auf, auch wenn sie ursprünglich Großbuchstaben enthielten. Dies unterscheidet sich von den Metadatenschlüsseln, die von den Methoden dieser DataLakeFileSystemClient Listenpfade mithilfe der includeMetadata Option zurückgegeben werden, die ihre ursprüngliche Groß- und Kleinschreibung beibehält. Siehe https://docs.microsoft.com/en-us/rest/api/storageservices/get-blob-properties
move(string, PathMoveOptions)	Verschieben Sie das Verzeichnis oder die Datei innerhalb desselben Dateisystems. Siehe https://docs.microsoft.com/en-us/rest/api/storageservices/datalakestoragegen2/path/create
move(string, string, PathMoveOptions)	Verschieben Sie das Verzeichnis oder die Datei in ein anderes Dateisystem. Siehe https://docs.microsoft.com/en-us/rest/api/storageservices/datalakestoragegen2/path/create
removeAccessControlRecursive(RemovePathAccessControlItem[], PathChangeAccessControlRecursiveOptions)	Entfernt die Access Control in einem Pfad und Unterpfaden. Siehe https://docs.microsoft.com/en-us/rest/api/storageservices/datalakestoragegen2/path/update
setAccessControl(PathAccessControlItem[], PathSetAccessControlOptions)	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.
setAccessControlRecursive(PathAccessControlItem[], PathChangeAccessControlRecursiveOptions)	Legt die Access Control für einen Pfad und untere Pfade fest. Siehe https://docs.microsoft.com/en-us/rest/api/storageservices/datalakestoragegen2/path/update
setHttpHeaders(PathHttpHeaders, PathSetHttpHeadersOptions)	Legt Systemeigenschaften für den Pfad (Verzeichnis oder Datei) fest. Wenn kein Wert oder kein Wert für die angegebenen Blob-HTTP-Header bereitgestellt wird, werden diese Blob-HTTP-Header ohne Wert gelöscht. Siehe https://docs.microsoft.com/en-us/rest/api/storageservices/set-blob-properties.
setMetadata(Metadata, PathSetMetadataOptions)	Legt benutzerdefinierte Metadaten für den angegebenen Pfad (Verzeichnis der Datei) als mindestens ein Name-Wert-Paar fest. Wenn keine Option oder keine im Parameter definierten Metadaten angegeben sind, werden die Pfadmetadaten entfernt. Siehe https://docs.microsoft.com/en-us/rest/api/storageservices/set-blob-metadata.
setPermissions(PathPermissions, PathSetPermissionsOptions)	Legt die Dateiberechtigungen für einen Pfad fest. Siehe https://docs.microsoft.com/en-us/rest/api/storageservices/datalakestoragegen2/path/update.
toDirectoryClient()	Konvertieren Sie den aktuellen DataLakePathClient in DataLakeDirectoryClient, wenn der aktuelle Pfad ein Verzeichnis ist.
toFileClient()	Konvertieren Sie den aktuellen DataLakePathClient in DataLakeFileClient, wenn der aktuelle Pfad eine Datei ist.
updateAccessControlRecursive(PathAccessControlItem[], PathChangeAccessControlRecursiveOptions)	Ändert die Access Control für einen Pfad und untere Pfade. Siehe https://docs.microsoft.com/en-us/rest/api/storageservices/datalakestoragegen2/path/update.

Details zum Konstruktor

DataLakePathClient(string, Pipeline)

Erstellt eine Instanz von DataLakePathClient aus URL und Pipeline.

new DataLakePathClient(url: string, pipeline: Pipeline)

Parameter

url

string

Eine Clientzeichenfolge, die auf den Azure Storage Data Lake-Pfad (Verzeichnis oder Datei) verweist, z. B. "https://myaccount.dfs.core.windows.net/filesystem/directory" oder "https://myaccount.dfs.core.windows.net/filesystem/file". Sie können eine SAS anfügen, wenn Sie AnonymousCredential verwenden, z. B. "https://myaccount.dfs.core.windows.net/filesystem/directory?sasString"".

pipeline

Pipeline

Rufen Sie newPipeline() auf, um eine Standardpipeline zu erstellen oder eine angepasste Pipeline bereitzustellen.

DataLakePathClient(string, StorageSharedKeyCredential | AnonymousCredential | TokenCredential, StoragePipelineOptions)

Erstellt eine Instanz von DataLakePathClient aus URL und Anmeldeinformationen.

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

Parameter

url

string

Eine Clientzeichenfolge, die auf den Azure Storage Data Lake-Pfad (Verzeichnis oder Datei) verweist, z. B. "https://myaccount.dfs.core.windows.net/filesystem/directory" oder "https://myaccount.dfs.core.windows.net/filesystem/file". Sie können eine SAS anfügen, wenn Sie AnonymousCredential verwenden, z. B. "https://myaccount.dfs.core.windows.net/filesystem/directory?sasString"".

credential

StorageSharedKeyCredential | AnonymousCredential | TokenCredential

z. B. AnonymousCredential, StorageSharedKeyCredential oder alle Anmeldeinformationen aus dem @azure/identity Paket, um Anforderungen an den Dienst zu authentifizieren. Sie können auch ein -Objekt bereitstellen, das die TokenCredential-Schnittstelle implementiert. Falls nicht angegeben, wird AnonymousCredential verwendet.

options

StoragePipelineOptions

Dies ist optional. Optionen zum Konfigurieren der HTTP-Pipeline.

Details zur Eigenschaft

fileSystemName

Name des aktuellen Dateisystems.

string fileSystemName

Eigenschaftswert

string

name

Name des aktuellen Pfads (Verzeichnis oder Datei).

string name

Eigenschaftswert

string

Geerbte Eigenschaftsdetails

accountName

accountName: string

Eigenschaftswert

string

Geerbt vonStorageClient.accountName

credential

z. B. AnonymousCredential, StorageSharedKeyCredential oder alle Anmeldeinformationen aus dem @azure/identity Paket, um Anforderungen an den Dienst zu authentifizieren. Sie können auch ein -Objekt bereitstellen, das die TokenCredential-Schnittstelle implementiert. Falls nicht angegeben, wird AnonymousCredential verwendet.

credential: StorageSharedKeyCredential | AnonymousCredential | TokenCredential

Eigenschaftswert

StorageSharedKeyCredential | AnonymousCredential | TokenCredential

Geerbt vonStorageClient.credential

url

Codierter URL-Zeichenfolgenwert.

url: string

Eigenschaftswert

string

Geerbt vonStorageClient.url

Details zur Methode

create(PathResourceTypeModel, PathCreateOptions)

Erstellen Sie ein Verzeichnis oder einen Pfad.

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

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

Parameter

resourceType

PathResourceTypeModel

Ressourcentyp: "Verzeichnis" oder "Datei".

options

PathCreateOptions

Dies ist optional. Optionen beim Erstellen des Pfads.

Gibt zurück

Promise<PathCreateResponse>

createIfNotExists(PathResourceTypeModel, PathCreateIfNotExistsOptions)

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

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

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

Parameter

resourceType

PathResourceTypeModel

Ressourcentyp: "Verzeichnis" oder "Datei".

options

PathCreateIfNotExistsOptions

Gibt zurück

Promise<PathCreateIfNotExistsResponse>

delete(boolean, PathDeleteOptions)

Löschen Sie den aktuellen Pfad (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

recursive

boolean

Erforderlich und nur gültig, wenn es sich bei der Ressource um ein Verzeichnis handelt. Wenn "true" ist, werden alle Pfade unter dem Verzeichnis gelöscht.

options

PathDeleteOptions

Dies ist optional. Optionen beim Löschen des Pfads.

Gibt zurück

Promise<PathDeleteResponse>

deleteIfExists(boolean, PathDeleteOptions)

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

recursive

boolean

Erforderlich und nur gültig, wenn es sich bei der Ressource um ein Verzeichnis handelt. Wenn "true" ist, werden alle Pfade unter dem Verzeichnis gelöscht.

options

PathDeleteOptions

Gibt zurück

Promise<PathDeleteIfExistsResponse>

exists(PathExistsOptions)

Gibt true zurück, wenn die von diesem Client dargestellte Data Lake-Datei vorhanden ist. false andernfalls. HINWEIS: Verwenden Sie diese Funktion mit Sorgfalt, 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 ist.

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

Parameter

options

PathExistsOptions

Options to Exists-Vorgang.

Gibt zurück

Promise<boolean>

getAccessControl(PathGetAccessControlOptions)

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

options

PathGetAccessControlOptions

Dies ist optional. Optionen beim Abrufen der Dateizugriffssteuerung.

Gibt zurück

Promise<PathGetAccessControlResponse>

getDataLakeLeaseClient(string)

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

function getDataLakeLeaseClient(proposeLeaseId?: string): DataLakeLeaseClient

Parameter

proposeLeaseId

string

Dies ist optional. Anfänglich vorgeschlagene Lease-ID.

Gibt zurück

DataLakeLeaseClient

getProperties(PathGetPropertiesOptions)

Gibt alle benutzerdefinierten Metadaten, HTTP-Standardeigenschaften und Systemeigenschaften für den Pfad (Verzeichnis oder Datei) zurück. WARNUNG: Das metadata in der Antwort zurückgegebene Objekt weist seine Schlüssel in Kleinbuchstaben auf, auch wenn sie ursprünglich Großbuchstaben enthielten. Dies unterscheidet sich von den Metadatenschlüsseln, die von den Methoden dieser DataLakeFileSystemClient Listenpfade mithilfe der includeMetadata Option zurückgegeben werden, die ihre ursprüngliche Groß- und Kleinschreibung beibehält.

Siehe https://docs.microsoft.com/en-us/rest/api/storageservices/get-blob-properties

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

Parameter

options

PathGetPropertiesOptions

Dies ist optional. Optionen beim Abrufen von Pfadeigenschaften.

Gibt zurück

Promise<PathGetPropertiesResponse>

move(string, PathMoveOptions)

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

destinationPath

string

Zielverzeichnispfad wie "verzeichnis" oder Dateipfad "verzeichnis/datei". Wenn der destinationPath mit SAS authentifiziert ist, fügen Sie die SAS dem Zielpfad wie "directory/file?sasToken" hinzu.

options

PathMoveOptions

Dies ist optional. Optionen beim Verschieben von Verzeichnis oder Datei.

Gibt zurück

Promise<PathMoveResponse>

move(string, string, PathMoveOptions)

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

destinationFileSystem

string

Zieldateisystem wie "Dateisystem".

destinationPath

string

Zielverzeichnispfad wie "directory" oder Dateipfad "directory/file" Wenn der destinationPath mit SAS authentifiziert ist, fügen Sie die SAS dem Zielpfad wie "directory/file?sasToken" hinzu.

options

PathMoveOptions

Dies ist optional. Optionen beim Verschieben von Verzeichnis oder Datei.

Gibt zurück

Promise<PathMoveResponse>

removeAccessControlRecursive(RemovePathAccessControlItem[], PathChangeAccessControlRecursiveOptions)

Entfernt die Access Control in einem Pfad und Unterpfaden.

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

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

Parameter

acl

RemovePathAccessControlItem[]

Die POSIX-Zugriffssteuerungsliste für die Datei oder das Verzeichnis.

options

PathChangeAccessControlRecursiveOptions

Dies ist optional. Tastatur

Gibt zurück

Promise<PathChangeAccessControlRecursiveResponse>

setAccessControl(PathAccessControlItem[], PathSetAccessControlOptions)

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

acl

PathAccessControlItem[]

Die POSIX-Zugriffssteuerungsliste für die Datei oder das Verzeichnis.

options

PathSetAccessControlOptions

Dies ist optional. Optionen beim Festlegen der Pfadzugriffssteuerung.

Gibt zurück

Promise<PathSetAccessControlResponse>

setAccessControlRecursive(PathAccessControlItem[], PathChangeAccessControlRecursiveOptions)

Legt die Access Control für einen Pfad und untere Pfade fest.

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

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

Parameter

acl

PathAccessControlItem[]

Die POSIX-Zugriffssteuerungsliste für die Datei oder das Verzeichnis.

options

PathChangeAccessControlRecursiveOptions

Dies ist optional. Tastatur

Gibt zurück

Promise<PathChangeAccessControlRecursiveResponse>

setHttpHeaders(PathHttpHeaders, PathSetHttpHeadersOptions)

Legt Systemeigenschaften für den Pfad (Verzeichnis oder Datei) fest. Wenn kein Wert oder kein Wert für die angegebenen Blob-HTTP-Header bereitgestellt wird, werden diese Blob-HTTP-Header ohne 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

httpHeaders

PathHttpHeaders

options

PathSetHttpHeadersOptions

Gibt zurück

Promise<PathSetHttpHeadersResponse>

setMetadata(Metadata, PathSetMetadataOptions)

Legt benutzerdefinierte Metadaten für den angegebenen Pfad (Verzeichnis der Datei) als mindestens ein Name-Wert-Paar fest. Wenn keine Option oder keine im Parameter definierten Metadaten angegeben 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

metadata

Metadata

Dies ist optional. Ersetzen Sie vorhandene Metadaten durch diesen Wert. Wenn kein Wert angegeben ist, werden die vorhandenen Metadaten entfernt.

options

PathSetMetadataOptions

Dies ist optional. Optionen beim Festlegen von Pfadmetadaten.

Gibt zurück

Promise<PathSetMetadataResponse>

setPermissions(PathPermissions, PathSetPermissionsOptions)

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<PathSetAccessControlResponse>

Parameter

permissions

PathPermissions

Die POSIX-Zugriffsberechtigungen für den Dateibesitzer, die Dateibesitzergruppe und andere.

options

PathSetPermissionsOptions

Dies ist optional. Optionen beim Festlegen von Pfadberechtigungen.

Gibt zurück

Promise<PathSetAccessControlResponse>

toDirectoryClient()

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

function toDirectoryClient(): DataLakeDirectoryClient

Gibt zurück

DataLakeDirectoryClient

toFileClient()

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

function toFileClient(): DataLakeFileClient

Gibt zurück

DataLakeFileClient

updateAccessControlRecursive(PathAccessControlItem[], PathChangeAccessControlRecursiveOptions)

Ändert die Access Control für einen Pfad und untere Pfade.

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

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

Parameter

acl

PathAccessControlItem[]

Die POSIX-Zugriffssteuerungsliste für die Datei oder das Verzeichnis.

options

PathChangeAccessControlRecursiveOptions

Dies ist optional. Tastatur

Gibt zurück

Promise<PathChangeAccessControlRecursiveResponse>