Udostępnij za pośrednictwem

DataLakeFileSystemClient class

  • Odwołanie
Pakiet:
@azure/storage-file-datalake

Obiekt DataLakeFileSystemClient reprezentuje adres URL systemu plików usługi Azure Storage, który umożliwia manipulowanie jego katalogami i plikami.

Rozszerzenie

StorageClient

Konstruktory

DataLakeFileSystemClient(string, Pipeline)

Tworzy wystąpienie elementu DataLakeFileSystemClient z adresu URL i potoku.
DataLakeFileSystemClient(string, StorageSharedKeyCredential | AnonymousCredential | TokenCredential, StoragePipelineOptions)

Tworzy wystąpienie elementu DataLakeFileSystemClient na podstawie adresu URL i poświadczeń.

Właściwości

name

Nazwa bieżącego systemu plików.

Właściwości dziedziczone

accountName
credential

Takie jak AnonymousCredential, StorageSharedKeyCredential lub dowolne poświadczenia z pakietu @azure/identity do uwierzytelniania żądań do usługi. Można również podać obiekt, który implementuje interfejs TokenCredential. Jeśli nie zostanie określony, zostanie użyty parametr AnonymousCredential.
url

Wartość zakodowanego ciągu adresu URL.

Metody

create(FileSystemCreateOptions)

Tworzy nowy system plików na określonym koncie. Jeśli system plików o tej samej nazwie już istnieje, operacja zakończy się niepowodzeniem.

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

Tworzy nowy system plików na określonym koncie. Jeśli system plików o tej samej nazwie już istnieje, nie zostanie zmieniony.

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

Usuń bieżący system plików.

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

Usuń bieżący system plików, jeśli istnieje.

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

Zwraca wartość true, jeśli system plików reprezentowany przez tego klienta istnieje; w przeciwnym razie wartość false.

UWAGA: użyj tej funkcji z ostrożnością, ponieważ istniejący system plików może zostać usunięty przez innych klientów lub aplikacje. Na odwrót nowy system plików o tej samej nazwie może zostać dodany przez innych klientów lub aplikacje po zakończeniu tej funkcji.
generateSasStringToSign(FileSystemGenerateSasUrlOptions)

Dostępne tylko dla elementu DataLakeFileSystemClient skonstruowanego przy użyciu poświadczeń klucza współużytkowanego.

Generuje ciąg do logowania dla identyfikatora URI sygnatury dostępu współdzielonego (SAS) usługi na podstawie właściwości i parametrów klienta przekazanych. Sygnatura dostępu współdzielonego jest podpisana przez poświadczenia klucza wspólnego klienta.

Zobacz https://docs.microsoft.com/en-us/rest/api/storageservices/constructing-a-service-sas
generateSasUrl(FileSystemGenerateSasUrlOptions)

Dostępne tylko dla elementu DataLakeFileSystemClient skonstruowanego przy użyciu poświadczeń klucza współużytkowanego.

Generuje identyfikator URI sygnatury dostępu współdzielonego (SAS) usługi na podstawie właściwości i parametrów klienta przekazanych. Sygnatura dostępu współdzielonego jest podpisana przez poświadczenia klucza wspólnego klienta.

Zobacz https://docs.microsoft.com/en-us/rest/api/storageservices/constructing-a-service-sas
generateUserDelegationSasStringToSign(FileSystemGenerateSasUrlOptions, UserDelegationKey)

Generuje ciąg do logowania dla identyfikatora URI sygnatury dostępu współdzielonego (SAS) usługi na podstawie właściwości i parametrów klienta przekazanych. Sygnatura dostępu współdzielonego jest podpisana przez wejściowy klucz delegowania użytkownika.

Zobacz https://docs.microsoft.com/en-us/rest/api/storageservices/constructing-a-service-sas
generateUserDelegationSasUrl(FileSystemGenerateSasUrlOptions, UserDelegationKey)

Generuje identyfikator URI sygnatury dostępu współdzielonego (SAS) usługi na podstawie właściwości i parametrów klienta przekazanych. Sygnatura dostępu współdzielonego jest podpisana przez wejściowy klucz delegowania użytkownika.

Zobacz https://docs.microsoft.com/en-us/rest/api/storageservices/constructing-a-service-sas
getAccessPolicy(FileSystemGetAccessPolicyOptions)

Pobiera uprawnienia dla określonego systemu plików. Uprawnienia wskazują, czy dane systemu plików mogą być dostępne publicznie.

OSTRZEŻENIE: Data języka JavaScript potencjalnie utraci precyzję podczas analizowania wartości startOn i wygasa w ciągach. Na przykład nowa data("2018-12-31T03:44:23.8827891Z").toISOString() otrzyma wartość "2018-12-31T03:44:23.882Z".

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

Pobierz DataLakeLeaseClient, który zarządza dzierżawami w systemie plików.
getDirectoryClient(string)

Tworzy obiekt DataLakeDirectoryClient w bieżącym systemie plików.
getFileClient(string)

Tworzy obiekt DataLakeFileClient w bieżącym systemie plików.
getProperties(FileSystemGetPropertiesOptions)

Zwraca wszystkie metadane zdefiniowane przez użytkownika i właściwości systemu dla określonego systemu plików.

OSTRZEŻENIE: Obiekt metadata zwrócony w odpowiedzi będzie miał klucze w małych literach, nawet jeśli pierwotnie zawierał wielkie litery. Różni się to od kluczy metadanych zwracanych przez metodę listFileSystemsDataLakeServiceClient przy użyciu opcji includeMetadata, która zachowa oryginalną wielkość liter.

Zobacz https://docs.microsoft.com/en-us/rest/api/storageservices/get-container-properties
listDeletedPaths(ListDeletedPathsOptions)

Zwraca iterator asynchroniczny, aby wyświetlić listę wszystkich ścieżek (katalogów i plików) w określonym systemie plików.

Funkcja .byPage() zwraca iterator asynchroniczny, aby wyświetlić listę ścieżek na stronach.

Przykład użycia składni for await:

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

Przykład użycia polecenia 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();
}

Przykład użycia polecenia 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}`);
  }
}

Przykład użycia stronicowania ze znacznikiem:

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

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

Zwraca iterator asynchroniczny, aby wyświetlić listę wszystkich ścieżek (katalogów i plików) w określonym systemie plików.

Funkcja .byPage() zwraca iterator asynchroniczny, aby wyświetlić listę ścieżek na stronach.

Przykład użycia składni for await:

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

Przykład użycia polecenia 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();
}

Przykład użycia polecenia 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}`);
  }
}

Przykład użycia stronicowania ze znacznikiem:

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

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

Ustawia uprawnienia dla określonego systemu plików. Uprawnienia wskazują, czy katalogi lub pliki w systemie plików mogą być dostępne publicznie.

Po ustawieniu uprawnień dla systemu plików istniejące uprawnienia zostaną zastąpione. Jeśli nie podano dostępu lub kontenerAcl, istniejąca lista ACL systemu plików zostanie usunięta.

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

Ustawia co najmniej jedną parę nazwa-wartość zdefiniowaną przez użytkownika dla określonego systemu plików.

Jeśli nie podano żadnej opcji lub żadne metadane zdefiniowane w parametrze, metadane systemu plików zostaną usunięte.

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

Przywraca nietrwałą ścieżkę usuniętą.

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

Szczegóły konstruktora

DataLakeFileSystemClient(string, Pipeline)

Tworzy wystąpienie elementu DataLakeFileSystemClient z adresu URL i potoku.

new DataLakeFileSystemClient(url: string, pipeline: Pipeline)

Parametry

url

string

Ciąg klienta wskazujący system plików typu data lake usługi Azure Storage, taki jak "https://myaccount.dfs.core.windows.net/filesystem". Sygnaturę dostępu współdzielonego można dołączyć, jeśli jest używana funkcja AnonymousCredential, na przykład "https://myaccount.dfs.core.windows.net/filesystem?sasString".

pipeline
Pipeline

Wywołaj metodę newPipeline(), aby utworzyć domyślny potok lub podaj dostosowany potok.

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

Tworzy wystąpienie elementu DataLakeFileSystemClient na podstawie adresu URL i poświadczeń.

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

Parametry

url

string

Ciąg klienta wskazujący system plików typu data lake usługi Azure Storage, taki jak "https://myaccount.dfs.core.windows.net/filesystem". Sygnaturę dostępu współdzielonego można dołączyć, jeśli jest używana funkcja AnonymousCredential, na przykład "https://myaccount.dfs.core.windows.net/filesystem?sasString".

credential

StorageSharedKeyCredential | AnonymousCredential | TokenCredential

Takie jak AnonymousCredential, StorageSharedKeyCredential lub dowolne poświadczenia z pakietu @azure/identity do uwierzytelniania żądań do usługi. Można również podać obiekt, który implementuje interfejs TokenCredential. Jeśli nie zostanie określony, zostanie użyty parametr AnonymousCredential.

options
StoragePipelineOptions

Fakultatywny. Opcje konfigurowania potoku HTTP.

Szczegóły właściwości

name

Nazwa bieżącego systemu plików.

string name

Wartość właściwości

string

Szczegóły właściwości dziedziczonej

accountName 

accountName: string

Wartość właściwości

string

dziedziczone z StorageClient.accountName

credential

Takie jak AnonymousCredential, StorageSharedKeyCredential lub dowolne poświadczenia z pakietu @azure/identity do uwierzytelniania żądań do usługi. Można również podać obiekt, który implementuje interfejs TokenCredential. Jeśli nie zostanie określony, zostanie użyty parametr AnonymousCredential.

credential: StorageSharedKeyCredential | AnonymousCredential | TokenCredential

Wartość właściwości

StorageSharedKeyCredential | AnonymousCredential | TokenCredential

dziedziczone z StorageClient.credential

url

Wartość zakodowanego ciągu adresu URL.

url: string

Wartość właściwości

string

dziedziczone z StorageClient.url

Szczegóły metody

create(FileSystemCreateOptions)

Tworzy nowy system plików na określonym koncie. Jeśli system plików o tej samej nazwie już istnieje, operacja zakończy się niepowodzeniem.

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

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

Parametry

options
FileSystemCreateOptions

Fakultatywny. Opcje podczas tworzenia systemu plików.

Zwraca

Promise<FileSystemCreateResponse>

createIfNotExists(FileSystemCreateOptions)

Tworzy nowy system plików na określonym koncie. Jeśli system plików o tej samej nazwie już istnieje, nie zostanie zmieniony.

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

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

Parametry

options
FileSystemCreateOptions

Zwraca

Promise<FileSystemCreateIfNotExistsResponse>

delete(FileSystemDeleteOptions)

Usuń bieżący system plików.

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

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

Parametry

options
FileSystemDeleteOptions

Fakultatywny. Opcje podczas usuwania systemu plików.

Zwraca

Promise<FileSystemDeleteResponse>

deleteIfExists(FileSystemDeleteOptions)

Usuń bieżący system plików, jeśli istnieje.

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

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

Parametry

options
FileSystemDeleteOptions

Zwraca

Promise<FileSystemDeleteIfExistsResponse>

exists(FileSystemExistsOptions)

Zwraca wartość true, jeśli system plików reprezentowany przez tego klienta istnieje; w przeciwnym razie wartość false.

UWAGA: użyj tej funkcji z ostrożnością, ponieważ istniejący system plików może zostać usunięty przez innych klientów lub aplikacje. Na odwrót nowy system plików o tej samej nazwie może zostać dodany przez innych klientów lub aplikacje po zakończeniu tej funkcji.

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

Parametry

options
FileSystemExistsOptions

Zwraca

Promise<boolean>

generateSasStringToSign(FileSystemGenerateSasUrlOptions)

Dostępne tylko dla elementu DataLakeFileSystemClient skonstruowanego przy użyciu poświadczeń klucza współużytkowanego.

Generuje ciąg do logowania dla identyfikatora URI sygnatury dostępu współdzielonego (SAS) usługi na podstawie właściwości i parametrów klienta przekazanych. Sygnatura dostępu współdzielonego jest podpisana przez poświadczenia klucza wspólnego klienta.

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

function generateSasStringToSign(options: FileSystemGenerateSasUrlOptions): string

Parametry

options
FileSystemGenerateSasUrlOptions

Parametry opcjonalne.

Zwraca

string

Identyfikator URI sygnatury dostępu współdzielonego składający się z identyfikatora URI do zasobu reprezentowanego przez tego klienta, a następnie wygenerowany token SAS.

generateSasUrl(FileSystemGenerateSasUrlOptions)

Dostępne tylko dla elementu DataLakeFileSystemClient skonstruowanego przy użyciu poświadczeń klucza współużytkowanego.

Generuje identyfikator URI sygnatury dostępu współdzielonego (SAS) usługi na podstawie właściwości i parametrów klienta przekazanych. Sygnatura dostępu współdzielonego jest podpisana przez poświadczenia klucza wspólnego klienta.

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

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

Parametry

options
FileSystemGenerateSasUrlOptions

Parametry opcjonalne.

Zwraca

Promise<string>

Identyfikator URI sygnatury dostępu współdzielonego składający się z identyfikatora URI do zasobu reprezentowanego przez tego klienta, a następnie wygenerowany token SAS.

generateUserDelegationSasStringToSign(FileSystemGenerateSasUrlOptions, UserDelegationKey)

Generuje ciąg do logowania dla identyfikatora URI sygnatury dostępu współdzielonego (SAS) usługi na podstawie właściwości i parametrów klienta przekazanych. Sygnatura dostępu współdzielonego jest podpisana przez wejściowy klucz delegowania użytkownika.

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

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

Parametry

options
FileSystemGenerateSasUrlOptions

Parametry opcjonalne.

userDelegationKey
UserDelegationKey

Wartość zwracana blobServiceClient.getUserDelegationKey()

Zwraca

string

Identyfikator URI sygnatury dostępu współdzielonego składający się z identyfikatora URI do zasobu reprezentowanego przez tego klienta, a następnie wygenerowany token SAS.

generateUserDelegationSasUrl(FileSystemGenerateSasUrlOptions, UserDelegationKey)

Generuje identyfikator URI sygnatury dostępu współdzielonego (SAS) usługi na podstawie właściwości i parametrów klienta przekazanych. Sygnatura dostępu współdzielonego jest podpisana przez wejściowy klucz delegowania użytkownika.

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

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

Parametry

options
FileSystemGenerateSasUrlOptions

Parametry opcjonalne.

userDelegationKey
UserDelegationKey

Wartość zwracana blobServiceClient.getUserDelegationKey()

Zwraca

Promise<string>

Identyfikator URI sygnatury dostępu współdzielonego składający się z identyfikatora URI do zasobu reprezentowanego przez tego klienta, a następnie wygenerowany token SAS.

getAccessPolicy(FileSystemGetAccessPolicyOptions)

Pobiera uprawnienia dla określonego systemu plików. Uprawnienia wskazują, czy dane systemu plików mogą być dostępne publicznie.

OSTRZEŻENIE: Data języka JavaScript potencjalnie utraci precyzję podczas analizowania wartości startOn i wygasa w ciągach. Na przykład nowa data("2018-12-31T03:44:23.8827891Z").toISOString() otrzyma wartość "2018-12-31T03:44:23.882Z".

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

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

Parametry

options
FileSystemGetAccessPolicyOptions

Fakultatywny. Opcje podczas pobierania zasad dostępu systemu plików.

Zwraca

Promise<FileSystemGetAccessPolicyResponse>

getDataLakeLeaseClient(string)

Pobierz DataLakeLeaseClient, który zarządza dzierżawami w systemie plików.

function getDataLakeLeaseClient(proposeLeaseId?: string): DataLakeLeaseClient

Parametry

proposeLeaseId

string

Fakultatywny. Początkowy proponowany identyfikator dzierżawy.

Zwraca

DataLakeLeaseClient

getDirectoryClient(string)

Tworzy obiekt DataLakeDirectoryClient w bieżącym systemie plików.

function getDirectoryClient(directoryName: string): DataLakeDirectoryClient

Parametry

directoryName

string

Zwraca

DataLakeDirectoryClient

getFileClient(string)

Tworzy obiekt DataLakeFileClient w bieżącym systemie plików.

function getFileClient(fileName: string): DataLakeFileClient

Parametry

fileName

string

Zwraca

DataLakeFileClient

getProperties(FileSystemGetPropertiesOptions)

Zwraca wszystkie metadane zdefiniowane przez użytkownika i właściwości systemu dla określonego systemu plików.

OSTRZEŻENIE: Obiekt metadata zwrócony w odpowiedzi będzie miał klucze w małych literach, nawet jeśli pierwotnie zawierał wielkie litery. Różni się to od kluczy metadanych zwracanych przez metodę listFileSystemsDataLakeServiceClient przy użyciu opcji includeMetadata, która zachowa oryginalną wielkość liter.

Zobacz https://docs.microsoft.com/en-us/rest/api/storageservices/get-container-properties

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

Parametry

options
FileSystemGetPropertiesOptions

Fakultatywny. Opcje podczas pobierania właściwości systemu plików.

Zwraca

Promise<FileSystemGetPropertiesResponse>

listDeletedPaths(ListDeletedPathsOptions)

Zwraca iterator asynchroniczny, aby wyświetlić listę wszystkich ścieżek (katalogów i plików) w określonym systemie plików.

Funkcja .byPage() zwraca iterator asynchroniczny, aby wyświetlić listę ścieżek na stronach.

Przykład użycia składni for await:

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

Przykład użycia polecenia 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();
}

Przykład użycia polecenia 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}`);
  }
}

Przykład użycia stronicowania ze znacznikiem:

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

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

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

Parametry

options
ListDeletedPathsOptions

Fakultatywny. Opcje podczas wyświetlania listy usuniętych ścieżek.

Zwraca

PagedAsyncIterableIterator<DeletedPath, FileSystemListDeletedPathsResponse, PageSettings>

listPaths(ListPathsOptions)

Zwraca iterator asynchroniczny, aby wyświetlić listę wszystkich ścieżek (katalogów i plików) w określonym systemie plików.

Funkcja .byPage() zwraca iterator asynchroniczny, aby wyświetlić listę ścieżek na stronach.

Przykład użycia składni for await:

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

Przykład użycia polecenia 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();
}

Przykład użycia polecenia 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}`);
  }
}

Przykład użycia stronicowania ze znacznikiem:

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

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

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

Parametry

options
ListPathsOptions

Fakultatywny. Opcje podczas wyświetlania listy ścieżek.

Zwraca

PagedAsyncIterableIterator<Path, FileSystemListPathsResponse, PageSettings>

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

Ustawia uprawnienia dla określonego systemu plików. Uprawnienia wskazują, czy katalogi lub pliki w systemie plików mogą być dostępne publicznie.

Po ustawieniu uprawnień dla systemu plików istniejące uprawnienia zostaną zastąpione. Jeśli nie podano dostępu lub kontenerAcl, istniejąca lista ACL systemu plików zostanie usunięta.

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

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

Parametry

access
PublicAccessType

Fakultatywny. Poziom publicznego dostępu do danych w systemie plików.

fileSystemAcl

SignedIdentifier<AccessPolicy>[]

Fakultatywny. Tablica elementów o unikatowym identyfikatorze i szczegółach zasad dostępu.

options
FileSystemSetAccessPolicyOptions

Fakultatywny. Opcje podczas ustawiania zasad dostępu systemu plików.

Zwraca

Promise<FileSystemSetAccessPolicyResponse>

setMetadata(Metadata, FileSystemSetMetadataOptions)

Ustawia co najmniej jedną parę nazwa-wartość zdefiniowaną przez użytkownika dla określonego systemu plików.

Jeśli nie podano żadnej opcji lub żadne metadane zdefiniowane w parametrze, metadane systemu plików zostaną usunięte.

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

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

Parametry

metadata
Metadata

Zastąp istniejące metadane tą wartością. Jeśli żadna wartość nie zostanie podana, istniejące metadane zostaną usunięte.

options
FileSystemSetMetadataOptions

Fakultatywny. Opcje podczas ustawiania metadanych systemu plików.

Zwraca

Promise<FileSystemSetMetadataResponse>

undeletePath(string, string, FileSystemUndeletePathOption)

Przywraca nietrwałą ścieżkę usuniętą.

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

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

Parametry

deletedPath

string

Wymagane. Ścieżka usuniętej ścieżki.

deletionId

string

Wymagane. Identyfikator usunięcia skojarzony ze ścieżką usunięcia nietrwałego.

options
FileSystemUndeletePathOption

Zwraca

Promise<FileSystemUndeletePathResponse>