DataLakeFileSystemClient class

Erstellt eine Instanz von DataLakeFileSystemClient aus url und Pipeline.

new DataLakeFileSystemClient(url: string, pipeline: Pipeline)

Parameter

Erstellt eine Instanz von DataLakeFileSystemClient aus URL und Anmeldeinformationen.

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

Parameter

Name des aktuellen Dateisystems.

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

Erstellt ein neues Dateisystem unter dem angegebenen Konto. Wenn das Dateisystem mit demselben Namen bereits vorhanden ist, schlägt der Vorgang fehl.

Informationen finden Sie unter https://docs.microsoft.com/en-us/rest/api/storageservices/create-container.

function create(options?: FileSystemCreateOptions): Promise<FileSystemCreateResponse>

Parameter

Gibt zurück

Erstellt ein neues Dateisystem unter dem angegebenen Konto. Wenn das Dateisystem mit demselben Namen bereits vorhanden ist, wird es nicht geändert.

Informationen finden Sie unter https://docs.microsoft.com/en-us/rest/api/storageservices/create-container.

function createIfNotExists(options?: FileSystemCreateOptions): Promise<FileSystemCreateIfNotExistsResponse>

Parameter

Gibt zurück

Aktuelles Dateisystem löschen.

Informationen finden Sie unter https://docs.microsoft.com/en-us/rest/api/storageservices/delete-container.

function delete(options?: FileSystemDeleteOptions): Promise<FileSystemDeleteResponse>

Parameter

Gibt zurück

Löschen Sie das aktuelle Dateisystem, falls vorhanden.

Informationen finden Sie unter https://docs.microsoft.com/en-us/rest/api/storageservices/delete-container.

function deleteIfExists(options?: FileSystemDeleteOptions): Promise<FileSystemDeleteIfExistsResponse>

Parameter

Gibt zurück

Gibt true zurück, wenn das von diesem Client dargestellte Dateisystem vorhanden ist; andernfalls "false".

HINWEIS: Verwenden Sie diese Funktion sorgfältig, da ein vorhandenes Dateisystem möglicherweise von anderen Clients oder Anwendungen gelöscht wird. Umgekehrt kann ein neues Dateisystem mit demselben Namen von anderen Clients oder Anwendungen hinzugefügt werden, nachdem diese Funktion abgeschlossen wurde.

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

Parameter

Gibt zurück

Nur für DataLakeFileSystemClient verfügbar, der mit freigegebenen Schlüsselanmeldeinformationen erstellt wurde.

Generiert Zeichenfolge zum Signieren für 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.

Informationen finden Sie unter https://docs.microsoft.com/en-us/rest/api/storageservices/constructing-a-service-sas.

function generateSasStringToSign(options: FileSystemGenerateSasUrlOptions): 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 DataLakeFileSystemClient verfügbar, der mit freigegebenen Schlüsselanmeldeinformationen erstellt wurde.

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.

Informationen finden Sie unter https://docs.microsoft.com/en-us/rest/api/storageservices/constructing-a-service-sas.

function generateSasUrl(options: FileSystemGenerateSasUrlOptions): 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 übergeben werden. Die SAS wird vom Eingabebenutzerdelegierungsschlüssel signiert.

Informationen finden Sie unter https://docs.microsoft.com/en-us/rest/api/storageservices/constructing-a-service-sas.

function generateUserDelegationSasStringToSign(options: FileSystemGenerateSasUrlOptions, 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.

Informationen finden Sie unter https://docs.microsoft.com/en-us/rest/api/storageservices/constructing-a-service-sas.

function generateUserDelegationSasUrl(options: FileSystemGenerateSasUrlOptions, 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.

Ruft die Berechtigungen für das angegebene Dateisystem ab. Die Berechtigungen geben an, ob auf Dateisystemdaten öffentlich zugegriffen werden kann.

WARNUNG: Das JavaScript-Datum verliert möglicherweise die Genauigkeit, wenn die Analyse beginntOn und läuftOn-Zeichenfolgen ab. Beispiel: "New Date("2018-12-31T03:44:23.8827891Z"). toISOString() erhält beispielsweise "2018-12-31T03:44:23.882Z".

Informationen finden Sie unter https://docs.microsoft.com/en-us/rest/api/storageservices/get-container-acl.

function getAccessPolicy(options?: FileSystemGetAccessPolicyOptions): Promise<FileSystemGetAccessPolicyResponse>

Parameter

Gibt zurück

Rufen Sie eine DataLakeLeaseClient- ab, die Leases im Dateisystem verwaltet.

function getDataLakeLeaseClient(proposeLeaseId?: string): DataLakeLeaseClient

Parameter

Gibt zurück

Erstellt ein DataLakeDirectoryClient- -Objekt unter dem aktuellen Dateisystem.

function getDirectoryClient(directoryName: string): DataLakeDirectoryClient

Parameter

Gibt zurück

Erstellt ein DataLakeFileClient- -Objekt unter dem aktuellen Dateisystem.

function getFileClient(fileName: string): DataLakeFileClient

Parameter

Gibt zurück

Gibt alle benutzerdefinierten Metadaten und Systemeigenschaften für das angegebene Dateisystem 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 der listFileSystems Methode von DataLakeServiceClient unter Verwendung der Option includeMetadata zurückgegeben werden, wodurch die ursprüngliche Groß-/Kleinschreibung beibehalten wird.

Informationen finden Sie unter https://docs.microsoft.com/en-us/rest/api/storageservices/get-container-properties.

function getProperties(options?: FileSystemGetPropertiesOptions): Promise<FileSystemGetPropertiesResponse>

Parameter

Gibt zurück

Gibt einen asynchronen iterierbaren Iterator zurück, um alle Pfade (Verzeichnisse und Dateien) unter dem angegebenen Dateisystem auflisten zu können.

.byPage() gibt einen asynchronen iterablen Iterator zurück, um die Pfade auf Seiten auflisten zu können.

Beispiel mit for await Syntax:

// Get the fileSystemClient before you run these snippets,
// Can be obtained from `serviceClient.getFileSystemClient("<your-filesystem-name>");`
let i = 1;
for await (const deletePath of fileSystemClient.listDeletedPaths()) {
  console.log(`Path ${i++}: ${deletePath.name}`);
}

Beispiel für die Verwendung von iter.next():

let i = 1;
let iter = fileSystemClient.listDeletedPaths();
let deletedPathItem = await iter.next();
while (!deletedPathItem.done) {
  console.log(`Path ${i++}: ${deletedPathItem.value.name}`);
  pathItem = await iter.next();
}

Beispiel für die Verwendung von byPage():

// passing optional maxPageSize in the page settings
let i = 1;
for await (const response of fileSystemClient.listDeletedPaths().byPage({ maxPageSize: 20 })) {
  for (const deletePath of response.pathItems) {
    console.log(`Path ${i++}: ${deletePath.name}`);
  }
}

Beispiel für das Paging mit einer Markierung:

let i = 1;
let iterator = fileSystemClient.listDeletedPaths().byPage({ maxPageSize: 2 });
let response = (await iterator.next()).value;

// Prints 2 path names
for (const path of response.pathItems) {
  console.log(`Path ${i++}: ${path.name}}`);
}

// Gets next marker
let marker = response.continuationToken;

// Passing next marker as continuationToken

iterator = fileSystemClient.listDeletedPaths().byPage({ continuationToken: marker, maxPageSize: 10 });
response = (await iterator.next()).value;

// Prints 10 path names
for (const deletePath of response.deletedPathItems) {
  console.log(`Path ${i++}: ${deletePath.name}`);
}

Informationen finden Sie unter https://docs.microsoft.com/rest/api/storageservices/list-blobs.

function listDeletedPaths(options?: ListDeletedPathsOptions): PagedAsyncIterableIterator<DeletedPath, FileSystemListDeletedPathsResponse, PageSettings>

Parameter

Gibt zurück

Gibt einen asynchronen iterierbaren Iterator zurück, um alle Pfade (Verzeichnisse und Dateien) unter dem angegebenen Dateisystem auflisten zu können.

.byPage() gibt einen asynchronen iterablen Iterator zurück, um die Pfade auf Seiten auflisten zu können.

Beispiel mit for await Syntax:

// Get the fileSystemClient before you run these snippets,
// Can be obtained from `serviceClient.getFileSystemClient("<your-filesystem-name>");`
let i = 1;
for await (const path of fileSystemClient.listPaths()) {
  console.log(`Path ${i++}: ${path.name}, isDirectory?: ${path.isDirectory}`);
}

Beispiel für die Verwendung von iter.next():

let i = 1;
let iter = fileSystemClient.listPaths();
let pathItem = await iter.next();
while (!pathItem.done) {
  console.log(`Path ${i++}: ${pathItem.value.name}, isDirectory?: ${pathItem.value.isDirectory}`);
  pathItem = await iter.next();
}

Beispiel für die Verwendung von byPage():

// passing optional maxPageSize in the page settings
let i = 1;
for await (const response of fileSystemClient.listPaths().byPage({ maxPageSize: 20 })) {
  for (const path of response.pathItems) {
    console.log(`Path ${i++}: ${path.name}, isDirectory?: ${path.isDirectory}`);
  }
}

Beispiel für das Paging mit einer Markierung:

let i = 1;
let iterator = fileSystemClient.listPaths().byPage({ maxPageSize: 2 });
let response = (await iterator.next()).value;

// Prints 2 path names
for (const path of response.pathItems) {
  console.log(`Path ${i++}: ${path.name}, isDirectory?: ${path.isDirectory}`);
}

// Gets next marker
let marker = response.continuationToken;

// Passing next marker as continuationToken

iterator = fileSystemClient.listPaths().byPage({ continuationToken: marker, maxPageSize: 10 });
response = (await iterator.next()).value;

// Prints 10 path names
for (const path of response.pathItems) {
  console.log(`Path ${i++}: ${path.name}, isDirectory?: ${path.isDirectory}`);
}

Informationen finden Sie unter https://docs.microsoft.com/rest/api/storageservices/list-blobs.

function listPaths(options?: ListPathsOptions): PagedAsyncIterableIterator<Path, FileSystemListPathsResponse, PageSettings>

Parameter

Gibt zurück

Legt die Berechtigungen für das angegebene Dateisystem fest. Die Berechtigungen geben an, ob auf Verzeichnisse oder Dateien in einem Dateisystem öffentlich zugegriffen werden kann.

Wenn Sie Berechtigungen für ein Dateisystem festlegen, werden die vorhandenen Berechtigungen ersetzt. Wenn kein Zugriff oder containerAcl bereitgestellt wird, wird die vorhandene Dateisystem-ACL entfernt.

Informationen finden Sie unter https://docs.microsoft.com/en-us/rest/api/storageservices/set-container-acl.

function setAccessPolicy(access?: PublicAccessType, fileSystemAcl?: SignedIdentifier<AccessPolicy>[], options?: FileSystemSetAccessPolicyOptions): Promise<FileSystemSetAccessPolicyResponse>

Parameter

Gibt zurück

Legt mindestens ein benutzerdefiniertes Name-Wert-Paar für das angegebene Dateisystem fest.

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

Informationen finden Sie unter https://docs.microsoft.com/en-us/rest/api/storageservices/set-container-metadata.

function setMetadata(metadata?: Metadata, options?: FileSystemSetMetadataOptions): Promise<FileSystemSetMetadataResponse>

Parameter

Gibt zurück

Stellt einen vorläufig gelöschten Pfad wieder her.

Informationen finden Sie unter https://docs.microsoft.com/en-us/rest/api/storageservices/undelete-blob.

function undeletePath(deletedPath: string, deletionId: string, options?: FileSystemUndeletePathOption): Promise<FileSystemUndeletePathResponse>

Parameter

Gibt zurück