DataLakeDirectoryClient class
Ein DataLakeDirectoryClient stellt eine URL zum Azure Storage-Verzeichnis dar.
- Extends
Konstruktoren
| Data |
Erstellt eine Instanz von DataLakePathClient aus URL und Pipeline. |
| Data |
Erstellt eine Instanz von DataLakePathClient aus URL und Anmeldeinformationen. |
Eigenschaften
| file |
Name des aktuellen Dateisystems. |
| name | Name des aktuellen Pfads (Verzeichnis oder Datei). |
Geerbte Eigenschaften
| account |
|
| credential | Beispielsweise AnonymousCredential, StorageSharedKeyCredential oder alle Anmeldeinformationen aus dem |
| url | Codierter URL-Zeichenfolgenwert. |
Methoden
Geerbte Methoden
| delete(boolean, Path |
Löschen Sie den aktuellen Pfad (Verzeichnis oder Datei). Siehe https://docs.microsoft.com/en-us/rest/api/storageservices/datalakestoragegen2/path/delete. |
| delete |
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(Path |
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. |
| get |
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. |
| get |
Rufen Sie einen DataLakeLeaseClient ab, der Leases für den Pfad (Verzeichnis oder Datei) verwaltet. |
| get |
Gibt alle benutzerdefinierten Metadaten, HTTP-Standardeigenschaften und Systemeigenschaften für den Pfad (Verzeichnis oder Datei) zurück. WARNUNG: Das Siehe https://docs.microsoft.com/en-us/rest/api/storageservices/get-blob-properties. |
| move(string, Path |
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, Path |
Verschieben Sie das Verzeichnis oder die Datei in ein anderes Dateisystem. Siehe https://docs.microsoft.com/en-us/rest/api/storageservices/datalakestoragegen2/path/create. |
| remove |
Entfernt die Access Control in einem Pfad und Unterpfaden. Siehe https://docs.microsoft.com/en-us/rest/api/storageservices/datalakestoragegen2/path/update. |
| set |
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. |
| set |
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. |
| set |
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. |
| set |
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. |
| set |
Legt die Dateiberechtigungen für einen Pfad fest. Siehe https://docs.microsoft.com/en-us/rest/api/storageservices/datalakestoragegen2/path/update. |
| to |
Konvertieren Sie den aktuellen DataLakePathClient in DataLakeDirectoryClient, wenn der aktuelle Pfad ein Verzeichnis ist. |
| to |
Konvertieren Sie den aktuellen DataLakePathClient in DataLakeFileClient, wenn der aktuelle Pfad eine Datei ist. |
| update |
Ä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
DataLakeDirectoryClient(string, Pipeline)
Erstellt eine Instanz von DataLakePathClient aus URL und Pipeline.
new DataLakeDirectoryClient(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.
DataLakeDirectoryClient(string, StorageSharedKeyCredential | AnonymousCredential | TokenCredential, StoragePipelineOptions)
Erstellt eine Instanz von DataLakePathClient aus URL und Anmeldeinformationen.
new DataLakeDirectoryClient(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
Optional. Optionen zum Konfigurieren der HTTP-Pipeline.
Details zur Eigenschaft
fileSystemName
Name des aktuellen Dateisystems.
string fileSystemNameEigenschaftswert
string
name
Name des aktuellen Pfads (Verzeichnis oder Datei).
string nameEigenschaftswert
string
Geerbte Eigenschaftsdetails
accountName
credential
Beispielsweise 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. Wenn nicht angegeben, wird AnonymousCredential verwendet.
credential: StorageSharedKeyCredential | AnonymousCredential | TokenCredentialEigenschaftswert
Geerbt vonDataLakePathClient.credential
url
Codierter URL-Zeichenfolgenwert.
url: stringEigenschaftswert
string
Geerbt vonDataLakePathClient.url
Details zur Methode
create(DirectoryCreateOptions)
Erstellen Sie ein Verzeichnis.
Siehe https://docs.microsoft.com/en-us/rest/api/storageservices/datalakestoragegen2/path/create.
function create(options?: DirectoryCreateOptions): Promise<DirectoryCreateResponse>Parameter
- options
- DirectoryCreateOptions
Optional. Optionen beim Erstellen eines Verzeichnisses.
Gibt zurück
Promise<DirectoryCreateResponse>
create(PathResourceTypeModel, PathCreateOptions)
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
- resourceType
- PathResourceTypeModel
Der Ressourcentyp muss für DataLakeDirectoryClient "directory" sein.
- options
- PathCreateOptions
Optional. Optionen beim Erstellen eines Verzeichnisses.
Gibt zurück
Promise<PathCreateResponse>
createIfNotExists(DirectoryCreateIfNotExistsOptions)
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
Promise<DirectoryCreateIfNotExistsResponse>
createIfNotExists(PathResourceTypeModel, PathCreateIfNotExistsOptions)
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
- resourceType
- PathResourceTypeModel
Der Ressourcentyp muss für DataLakeDirectoryClient "directory" sein.
- options
- PathCreateIfNotExistsOptions
Gibt zurück
Promise<PathCreateIfNotExistsResponse>
generateSasUrl(DirectoryGenerateSasUrlOptions)
Nur für Clients verfügbar, die mit Anmeldeinformationen mit gemeinsam genutzten Schlüsseln erstellt wurden.
Generiert einen SAS-URI (Service Shared Access Signature) basierend auf den übergebenen Clienteigenschaften und Parametern. Die SAS wird von den Anmeldeinformationen für gemeinsam genutzte Schlüssel des Clients signiert.
Siehe https://docs.microsoft.com/en-us/rest/api/storageservices/constructing-a-service-sas.
function generateSasUrl(options: DirectoryGenerateSasUrlOptions): Promise<string>Parameter
- options
- DirectoryGenerateSasUrlOptions
Optionale Parameter.
Gibt zurück
Promise<string>
Der SAS-URI, der aus dem URI für die von diesem Client dargestellte Ressource besteht, gefolgt vom generierten SAS-Token.
getFileClient(string)
Erstellt ein DataLakeFileClient-Objekt unter dem aktuellen Verzeichnis.
function getFileClient(fileName: string): DataLakeFileClientParameter
- fileName
-
string
Gibt zurück
getSubdirectoryClient(string)
Erstellt ein DataLakeDirectoryClient-Objekt unter dem aktuellen Verzeichnis.
function getSubdirectoryClient(subdirectoryName: string): DataLakeDirectoryClientParameter
- subdirectoryName
-
string
Name des Unterverzeichnisses.
Gibt zurück
Details zur geerbten Methode
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
Optional. Optionen beim Löschen des Pfads.
Gibt zurück
Promise<PathDeleteResponse>
Geerbt vonDataLakePathClient.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.
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>
Geerbt vonDataLakePathClient.deleteIfExists
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>
Geerbt vonDataLakePathClient.exists
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
Optional. Optionen beim Abrufen der Dateizugriffssteuerung.
Gibt zurück
Promise<PathGetAccessControlResponse>
Geerbt vonDataLakePathClient.getAccessControl
getDataLakeLeaseClient(string)
Rufen Sie einen DataLakeLeaseClient ab, der Leases für den Pfad (Verzeichnis oder Datei) verwaltet.
function getDataLakeLeaseClient(proposeLeaseId?: string): DataLakeLeaseClientParameter
- proposeLeaseId
-
string
Optional. Anfänglich vorgeschlagene Lease-ID.
Gibt zurück
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 von DataLakeFileSystemClient zurückgegeben werden, die Pfade mit der includeMetadata Option auflisten, die ihre ursprüngliche Groß- und Kleinschreibung beibehalten.
Siehe https://docs.microsoft.com/en-us/rest/api/storageservices/get-blob-properties.
function getProperties(options?: PathGetPropertiesOptions): Promise<PathGetPropertiesResponse>Parameter
- options
- PathGetPropertiesOptions
Optional. Optionen beim Abrufen von Pfadeigenschaften.
Gibt zurück
Promise<PathGetPropertiesResponse>
Geerbt vonDataLakePathClient.getProperties
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
Optional. Optionen beim Verschieben von Verzeichnis oder Datei.
Gibt zurück
Promise<PathMoveResponse>
Geerbt vonDataLakePathClient.move
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
Optional. Optionen beim Verschieben von Verzeichnis oder Datei.
Gibt zurück
Promise<PathMoveResponse>
Geerbt vonDataLakePathClient.move
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
Die POSIX-Zugriffssteuerungsliste für die Datei oder das Verzeichnis.
Optional. Tastatur
Gibt zurück
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
Die POSIX-Zugriffssteuerungsliste für die Datei oder das Verzeichnis.
- options
- PathSetAccessControlOptions
Optional. Optionen beim Festlegen der Pfadzugriffssteuerung.
Gibt zurück
Promise<PathSetAccessControlResponse>
Geerbt vonDataLakePathClient.setAccessControl
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
Die POSIX-Zugriffssteuerungsliste für die Datei oder das Verzeichnis.
Optional. Tastatur
Gibt zurück
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>
Geerbt vonDataLakePathClient.setHttpHeaders
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
Optional. Ersetzen Sie vorhandene Metadaten durch diesen Wert. Wenn kein Wert angegeben ist, werden die vorhandenen Metadaten entfernt.
- options
- PathSetMetadataOptions
Optional. Optionen beim Festlegen von Pfadmetadaten.
Gibt zurück
Promise<PathSetMetadataResponse>
Geerbt vonDataLakePathClient.setMetadata
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
Optional. Optionen beim Festlegen von Pfadberechtigungen.
Gibt zurück
Promise<PathSetAccessControlResponse>
Geerbt vonDataLakePathClient.setPermissions
toDirectoryClient()
Konvertieren Sie den aktuellen DataLakePathClient in DataLakeDirectoryClient, wenn der aktuelle Pfad ein Verzeichnis ist.
function toDirectoryClient(): DataLakeDirectoryClientGibt zurück
Geerbt vonDataLakePathClient.toDirectoryClient
toFileClient()
Konvertieren Sie den aktuellen DataLakePathClient in DataLakeFileClient, wenn der aktuelle Pfad eine Datei ist.
function toFileClient(): DataLakeFileClientGibt zurück
Geerbt vonDataLakePathClient.toFileClient
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
Die POSIX-Zugriffssteuerungsliste für die Datei oder das Verzeichnis.
Optional. Tastatur