Freigeben über

DataLakeFileSystemClient class

  • Referenz
Paket:
@azure/storage-file-datalake

Ein DataLakeFileSystemClient stellt eine URL zum Azure Storage-Dateisystem dar, mit der Sie seine Verzeichnisse und Dateien bearbeiten können.

Extends

StorageClient

Konstruktoren

DataLakeFileSystemClient(string, Pipeline)

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

Erstellt eine Instanz von DataLakeFileSystemClient aus URL und Anmeldeinformationen.

Eigenschaften

name

Name des aktuellen Dateisystems.

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(FileSystemCreateOptions)

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

Siehe https://docs.microsoft.com/en-us/rest/api/storageservices/create-container.
createIfNotExists(FileSystemCreateOptions)

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

Siehe https://docs.microsoft.com/en-us/rest/api/storageservices/create-container.
delete(FileSystemDeleteOptions)

Löschen Sie das aktuelle Dateisystem.

Siehe https://docs.microsoft.com/en-us/rest/api/storageservices/delete-container.
deleteIfExists(FileSystemDeleteOptions)

Löschen Sie das aktuelle Dateisystem, sofern vorhanden.

Siehe https://docs.microsoft.com/en-us/rest/api/storageservices/delete-container.
exists(FileSystemExistsOptions)

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

HINWEIS: Verwenden Sie diese Funktion mit Sorgfalt, da ein vorhandenes Dateisystem möglicherweise von anderen Clients oder Anwendungen gelöscht wird. Umgekehrt kann nach Abschluss dieser Funktion von anderen Clients oder Anwendungen ein neues Dateisystem mit demselben Namen hinzugefügt werden.
generateSasUrl(FileSystemGenerateSasUrlOptions)

Nur für DataLakeFileSystemClient verfügbar, der mit anmeldeinformationen für gemeinsam genutzte Schlüssel erstellt wurde.

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.
getAccessPolicy(FileSystemGetAccessPolicyOptions)

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

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

Siehe https://docs.microsoft.com/en-us/rest/api/storageservices/get-container-acl.
getDataLakeLeaseClient(string)

Rufen Sie einen DataLakeLeaseClient ab, der Leases im Dateisystem verwaltet.
getDirectoryClient(string)

Erstellt ein DataLakeDirectoryClient-Objekt unter dem aktuellen Dateisystem.
getFileClient(string)

Erstellt ein DataLakeFileClient-Objekt unter dem aktuellen Dateisystem.
getProperties(FileSystemGetPropertiesOptions)

Gibt alle benutzerdefinierten Metadaten und Systemeigenschaften für das angegebene Dateisystem 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 der listFileSystemsDataLakeServiceClient-Methode mit 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-container-properties.
listDeletedPaths(ListDeletedPathsOptions)

Gibt einen asynchronen iterierbaren Iterator zurück, um alle Pfade (Verzeichnisse und Dateien) unter dem angegebenen Dateisystem aufzulisten.

.byPage() gibt einen asynchronen iterierbaren Iterator zurück, um die Pfade in Seiten aufzulisten.

Beispiel für die Verwendung von 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 die Verwendung von Paging mit einem Marker:

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}`);
}

Siehe https://docs.microsoft.com/rest/api/storageservices/list-blobs.
listPaths(ListPathsOptions)

Gibt einen asynchronen iterierbaren Iterator zurück, um alle Pfade (Verzeichnisse und Dateien) unter dem angegebenen Dateisystem aufzulisten.

.byPage() gibt einen asynchronen iterierbaren Iterator zurück, um die Pfade in Seiten aufzulisten.

Beispiel für die Verwendung von 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 die Verwendung von Paging mit einem Marker:

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}`);
}

Siehe https://docs.microsoft.com/rest/api/storageservices/list-blobs.
setAccessPolicy(PublicAccessType, SignedIdentifier<AccessPolicy>[], FileSystemSetAccessPolicyOptions)

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

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.

Siehe https://docs.microsoft.com/en-us/rest/api/storageservices/set-container-acl.
setMetadata(Metadata, FileSystemSetMetadataOptions)

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

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

Siehe https://docs.microsoft.com/en-us/rest/api/storageservices/set-container-metadata.
undeletePath(string, string, FileSystemUndeletePathOption)

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

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

Details zum Konstruktor

DataLakeFileSystemClient(string, Pipeline)

Erstellt eine Instanz von DataLakeFileSystemClient aus URL und Pipeline.

new DataLakeFileSystemClient(url: string, pipeline: Pipeline)

Parameter

url

string

Eine Clientzeichenfolge, die auf das Data Lake-Dateisystem von Azure Storage verweist, z. B. "https://myaccount.dfs.core.windows.net/filesystem"". Sie können eine SAS anfügen, wenn Sie AnonymousCredential verwenden, z. B. "https://myaccount.dfs.core.windows.net/filesystem?sasString"".

pipeline
Pipeline

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

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

Erstellt eine Instanz von DataLakeFileSystemClient aus URL und Anmeldeinformationen.

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

Parameter

url

string

Eine Clientzeichenfolge, die auf das Data Lake-Dateisystem von Azure Storage verweist, z. B. "https://myaccount.dfs.core.windows.net/filesystem"". Sie können eine SAS anfügen, wenn Sie AnonymousCredential verwenden, z. B. "https://myaccount.dfs.core.windows.net/filesystem?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

name

Name des aktuellen Dateisystems.

string name

Eigenschaftswert

string

Geerbte Eigenschaftsdetails

accountName 

accountName: string

Eigenschaftswert

string

Geerbt von StorageClient.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 von StorageClient.credential

url

Codierter URL-Zeichenfolgenwert.

url: string

Eigenschaftswert

string

Geerbt von StorageClient.url

Details zur Methode

create(FileSystemCreateOptions)

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

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

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

Parameter

options
FileSystemCreateOptions

Optional. Optionen beim Erstellen eines Dateisystems.

Gibt zurück

Promise<FileSystemCreateResponse>

createIfNotExists(FileSystemCreateOptions)

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

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

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

Parameter

options
FileSystemCreateOptions

Gibt zurück

Promise<FileSystemCreateIfNotExistsResponse>

delete(FileSystemDeleteOptions)

Löschen Sie das aktuelle Dateisystem.

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

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

Parameter

options
FileSystemDeleteOptions

Optional. Optionen beim Löschen des Dateisystems.

Gibt zurück

Promise<FileSystemDeleteResponse>

deleteIfExists(FileSystemDeleteOptions)

Löschen Sie das aktuelle Dateisystem, sofern vorhanden.

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

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

Parameter

options
FileSystemDeleteOptions

Gibt zurück

Promise<FileSystemDeleteIfExistsResponse>

exists(FileSystemExistsOptions)

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

HINWEIS: Verwenden Sie diese Funktion mit Sorgfalt, da ein vorhandenes Dateisystem möglicherweise von anderen Clients oder Anwendungen gelöscht wird. Umgekehrt kann nach Abschluss dieser Funktion von anderen Clients oder Anwendungen ein neues Dateisystem mit demselben Namen hinzugefügt werden.

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

Parameter

options
FileSystemExistsOptions

Gibt zurück

Promise<boolean>

generateSasUrl(FileSystemGenerateSasUrlOptions)

Nur für DataLakeFileSystemClient verfügbar, der mit anmeldeinformationen für gemeinsam genutzte Schlüssel erstellt wurde.

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: FileSystemGenerateSasUrlOptions): Promise<string>

Parameter

options
FileSystemGenerateSasUrlOptions

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.

getAccessPolicy(FileSystemGetAccessPolicyOptions)

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

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

Siehe https://docs.microsoft.com/en-us/rest/api/storageservices/get-container-acl.

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

Parameter

options
FileSystemGetAccessPolicyOptions

Optional. Optionen beim Abrufen der Dateisystemzugriffsrichtlinie.

Gibt zurück

Promise<FileSystemGetAccessPolicyResponse>

getDataLakeLeaseClient(string)

Rufen Sie einen DataLakeLeaseClient ab, der Leases im Dateisystem verwaltet.

function getDataLakeLeaseClient(proposeLeaseId?: string): DataLakeLeaseClient

Parameter

proposeLeaseId

string

Optional. Anfänglich vorgeschlagene Lease-ID.

Gibt zurück

DataLakeLeaseClient

getDirectoryClient(string)

Erstellt ein DataLakeDirectoryClient-Objekt unter dem aktuellen Dateisystem.

function getDirectoryClient(directoryName: string): DataLakeDirectoryClient

Parameter

directoryName

string

Gibt zurück

DataLakeDirectoryClient

getFileClient(string)

Erstellt ein DataLakeFileClient-Objekt unter dem aktuellen Dateisystem.

function getFileClient(fileName: string): DataLakeFileClient

Parameter

fileName

string

Gibt zurück

DataLakeFileClient

getProperties(FileSystemGetPropertiesOptions)

Gibt alle benutzerdefinierten Metadaten und Systemeigenschaften für das angegebene Dateisystem 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 der listFileSystemsDataLakeServiceClient-Methode mit 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-container-properties.

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

Parameter

options
FileSystemGetPropertiesOptions

Optional. Optionen beim Abrufen von Dateisystemeigenschaften.

Gibt zurück

Promise<FileSystemGetPropertiesResponse>

listDeletedPaths(ListDeletedPathsOptions)

Gibt einen asynchronen iterierbaren Iterator zurück, um alle Pfade (Verzeichnisse und Dateien) unter dem angegebenen Dateisystem aufzulisten.

.byPage() gibt einen asynchronen iterierbaren Iterator zurück, um die Pfade in Seiten aufzulisten.

Beispiel für die Verwendung von 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 die Verwendung von Paging mit einem Marker:

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}`);
}

Siehe https://docs.microsoft.com/rest/api/storageservices/list-blobs.

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

Parameter

options
ListDeletedPathsOptions

Optional. Optionen beim Auflisten gelöschter Pfade.

Gibt zurück

PagedAsyncIterableIterator<DeletedPath, FileSystemListDeletedPathsResponse, PageSettings>

listPaths(ListPathsOptions)

Gibt einen asynchronen iterierbaren Iterator zurück, um alle Pfade (Verzeichnisse und Dateien) unter dem angegebenen Dateisystem aufzulisten.

.byPage() gibt einen asynchronen iterierbaren Iterator zurück, um die Pfade in Seiten aufzulisten.

Beispiel für die Verwendung von 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 die Verwendung von Paging mit einem Marker:

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}`);
}

Siehe https://docs.microsoft.com/rest/api/storageservices/list-blobs.

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

Parameter

options
ListPathsOptions

Optional. Optionen beim Auflisten von Pfaden.

Gibt zurück

PagedAsyncIterableIterator<Path, FileSystemListPathsResponse, PageSettings>

setAccessPolicy(PublicAccessType, SignedIdentifier<AccessPolicy>[], FileSystemSetAccessPolicyOptions)

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

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.

Siehe https://docs.microsoft.com/en-us/rest/api/storageservices/set-container-acl.

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

Parameter

access
PublicAccessType

Optional. Die Ebene des öffentlichen Zugriffs auf Daten im Dateisystem.

fileSystemAcl

SignedIdentifier<AccessPolicy>[]

Optional. Array von Elementen, die jeweils über eine eindeutige ID und Details der Zugriffsrichtlinie verfügen.

options
FileSystemSetAccessPolicyOptions

Optional. Optionen beim Festlegen der Dateisystemzugriffsrichtlinie.

Gibt zurück

Promise<FileSystemSetAccessPolicyResponse>

setMetadata(Metadata, FileSystemSetMetadataOptions)

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

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

Siehe https://docs.microsoft.com/en-us/rest/api/storageservices/set-container-metadata.

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

Parameter

metadata
Metadata

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

options
FileSystemSetMetadataOptions

Optional. Optionen beim Festlegen von Dateisystemmetadaten.

Gibt zurück

Promise<FileSystemSetMetadataResponse>

undeletePath(string, string, FileSystemUndeletePathOption)

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

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

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

Parameter

deletedPath

string

Erforderlich. Der Pfad des gelöschten Pfads.

deletionId

string

Erforderlich. Die Lösch-ID, die dem vorläufig gelöschten Pfad zugeordnet ist.

options
FileSystemUndeletePathOption

Gibt zurück

Promise<FileSystemUndeletePathResponse>