Поделиться через

DataLakeFileSystemClient class

  • Ссылка
Пакет:
@azure/storage-file-datalake

DataLakeFileSystemClient представляет URL-адрес файловой системы службы хранилища Azure, позволяя управлять каталогами и файлами.

Extends

StorageClient

Конструкторы

DataLakeFileSystemClient(string, Pipeline)

Создает экземпляр DataLakeFileSystemClient из URL-адреса и конвейера.
DataLakeFileSystemClient(string, StorageSharedKeyCredential | AnonymousCredential | TokenCredential, StoragePipelineOptions)

Создает экземпляр DataLakeFileSystemClient из URL-адреса и учетных данных.

Свойства

name

Имя текущей файловой системы.

Унаследованные свойства

accountName
credential

Например, AnonymousCredential, StorageSharedKeyCredential или любые учетные данные из пакета @azure/identity для проверки подлинности запросов к службе. Можно также предоставить объект, реализующий интерфейс TokenCredential. Если не указано, используется AnonymousCredential.
url

Закодированное строковое значение URL-адреса.

Методы

create(FileSystemCreateOptions)

Создает файловую систему под указанной учетной записью. Если файловая система с тем же именем уже существует, операция завершается ошибкой.

См. раздел https://docs.microsoft.com/en-us/rest/api/storageservices/create-container.
createIfNotExists(FileSystemCreateOptions)

Создает файловую систему под указанной учетной записью. Если файловая система с тем же именем уже существует, она не изменяется.

См. раздел https://docs.microsoft.com/en-us/rest/api/storageservices/create-container.
delete(FileSystemDeleteOptions)

Удалите текущую файловую систему.

См. раздел https://docs.microsoft.com/en-us/rest/api/storageservices/delete-container.
deleteIfExists(FileSystemDeleteOptions)

Удалите текущую файловую систему, если она существует.

См. раздел https://docs.microsoft.com/en-us/rest/api/storageservices/delete-container.
exists(FileSystemExistsOptions)

Возвращает значение true, если файловая система, представленная этим клиентом; False в противном случае.

ПРИМЕЧАНИЕ. Используйте эту функцию с осторожностью, так как существующая файловая система может быть удалена другими клиентами или приложениями. Наоборот, новая файловая система с тем же именем может быть добавлена другими клиентами или приложениями после завершения этой функции.
generateSasStringToSign(FileSystemGenerateSasUrlOptions)

Доступно только для DataLakeFileSystemClient, созданного с использованием учетных данных общего ключа.

Создает строку для входа в универсальный код ресурса (SAS) службы на основе свойств и параметров клиента, переданных. SAS подписан учетными данными общего ключа клиента.

См. раздел https://docs.microsoft.com/en-us/rest/api/storageservices/constructing-a-service-sas.
generateSasUrl(FileSystemGenerateSasUrlOptions)

Доступно только для DataLakeFileSystemClient, созданного с использованием учетных данных общего ключа.

Создает универсальный код ресурса (SAS) подписанного URL-адреса службы на основе свойств и параметров клиента, переданных. SAS подписан учетными данными общего ключа клиента.

См. раздел https://docs.microsoft.com/en-us/rest/api/storageservices/constructing-a-service-sas.
generateUserDelegationSasStringToSign(FileSystemGenerateSasUrlOptions, UserDelegationKey)

Создает строку для входа в универсальный код ресурса (SAS) службы на основе свойств и параметров клиента, переданных. SAS подписан ключом делегирования входных пользователей.

См. раздел https://docs.microsoft.com/en-us/rest/api/storageservices/constructing-a-service-sas.
generateUserDelegationSasUrl(FileSystemGenerateSasUrlOptions, UserDelegationKey)

Создает универсальный код ресурса (SAS) подписанного URL-адреса службы на основе свойств и параметров клиента, переданных. SAS подписан ключом делегирования входных пользователей.

См. раздел https://docs.microsoft.com/en-us/rest/api/storageservices/constructing-a-service-sas.
getAccessPolicy(FileSystemGetAccessPolicyOptions)

Получает разрешения для указанной файловой системы. Разрешения указывают, могут ли данные файловой системы получать общедоступный доступ.

ПРЕДУПРЕЖДЕНИЕ. Дата JavaScript потенциально потеряет точность при синтаксическом анализе начинается и истекает срок действия строкOn. Например, new Date("2018-12-31T03:44:23.8827891Z").toISOString() получит "2018-12-31T03:44:23.882Z".

См. раздел https://docs.microsoft.com/en-us/rest/api/storageservices/get-container-acl.
getDataLakeLeaseClient(string)

Получите DataLakeLeaseClient, которая управляет арендой файловой системы.
getDirectoryClient(string)

Создает объект DataLakeDirectoryClient в текущей файловой системе.
getFileClient(string)

Создает объект DataLakeFileClient в текущей файловой системе.
getProperties(FileSystemGetPropertiesOptions)

Возвращает все пользовательские метаданные и системные свойства для указанной файловой системы.

ПРЕДУПРЕЖДЕНИЕ. Объект metadata, возвращенный в ответе, будет иметь свои ключи в нижнем регистре, даже если они первоначально содержали прописные символы. Это отличается от ключей метаданных, возвращаемых методом listFileSystemsDataLakeServiceClient с помощью параметра includeMetadata, который будет хранить исходную регистру.

См. раздел https://docs.microsoft.com/en-us/rest/api/storageservices/get-container-properties.
listDeletedPaths(ListDeletedPathsOptions)

Возвращает асинхронный итератор для перечисления всех путей (каталогов и файлов) в указанной файловой системе.

.byPage() возвращает асинхронный итератор для перечисления путей на страницах.

Пример использования синтаксиса 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}`);
}

Пример, использующий среду 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();
}

Пример, использующий среду 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}`);
  }
}

Пример использования разбиения по страницам с маркером:

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

См. раздел https://docs.microsoft.com/rest/api/storageservices/list-blobs.
listPaths(ListPathsOptions)

Возвращает асинхронный итератор для перечисления всех путей (каталогов и файлов) в указанной файловой системе.

.byPage() возвращает асинхронный итератор для перечисления путей на страницах.

Пример использования синтаксиса 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}`);
}

Пример, использующий среду 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();
}

Пример, использующий среду 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}`);
  }
}

Пример использования разбиения по страницам с маркером:

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

См. раздел https://docs.microsoft.com/rest/api/storageservices/list-blobs.
setAccessPolicy(PublicAccessType, SignedIdentifier<AccessPolicy>[], FileSystemSetAccessPolicyOptions)

Задает разрешения для указанной файловой системы. Разрешения указывают, доступны ли каталоги или файлы в файловой системе общедоступным образом.

При установке разрешений для файловой системы существующие разрешения заменяются. Если доступ или контейнерAcl не указан, доступ к существующей файловой системе будет удален.

См. раздел https://docs.microsoft.com/en-us/rest/api/storageservices/set-container-acl.
setMetadata(Metadata, FileSystemSetMetadataOptions)

Задает одну или несколько определяемых пользователем пар name-value для указанной файловой системы.

Если в параметре не указан параметр или метаданные, определенные в параметре, метаданные файловой системы будут удалены.

См. раздел https://docs.microsoft.com/en-us/rest/api/storageservices/set-container-metadata.
undeletePath(string, string, FileSystemUndeletePathOption)

Восстанавливает обратимый удаленный путь.

См. раздел https://docs.microsoft.com/en-us/rest/api/storageservices/undelete-blob.

Сведения о конструкторе

DataLakeFileSystemClient(string, Pipeline)

Создает экземпляр DataLakeFileSystemClient из URL-адреса и конвейера.

new DataLakeFileSystemClient(url: string, pipeline: Pipeline)

Параметры

url

string

Строка клиента, указывающая на файловую систему озера данных службы хранилища Azure, например "https://myaccount.dfs.core.windows.net/filesystem". При использовании AnonymousCredential можно добавить SAS, например "https://myaccount.dfs.core.windows.net/filesystem?sasString".

pipeline
Pipeline

Вызовите newPipeline() для создания конвейера по умолчанию или предоставления настраиваемого конвейера.

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

Создает экземпляр DataLakeFileSystemClient из URL-адреса и учетных данных.

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

Параметры

url

string

Строка клиента, указывающая на файловую систему озера данных службы хранилища Azure, например "https://myaccount.dfs.core.windows.net/filesystem". При использовании AnonymousCredential можно добавить SAS, например "https://myaccount.dfs.core.windows.net/filesystem?sasString".

credential

StorageSharedKeyCredential | AnonymousCredential | TokenCredential

Например, AnonymousCredential, StorageSharedKeyCredential или любые учетные данные из пакета @azure/identity для проверки подлинности запросов к службе. Можно также предоставить объект, реализующий интерфейс TokenCredential. Если не указано, используется AnonymousCredential.

options
StoragePipelineOptions

Необязательный. Параметры настройки конвейера HTTP.

Сведения о свойстве

name

Имя текущей файловой системы.

string name

Значение свойства

string

Сведения об унаследованном свойстве

accountName 

accountName: string

Значение свойства

string

наследуется от storageClient.accountName

credential

Например, AnonymousCredential, StorageSharedKeyCredential или любые учетные данные из пакета @azure/identity для проверки подлинности запросов к службе. Можно также предоставить объект, реализующий интерфейс TokenCredential. Если не указано, используется AnonymousCredential.

credential: StorageSharedKeyCredential | AnonymousCredential | TokenCredential

Значение свойства

StorageSharedKeyCredential | AnonymousCredential | TokenCredential

наследуется от StorageClient.credential

url

Закодированное строковое значение URL-адреса.

url: string

Значение свойства

string

наследуется от StorageClient.url

Сведения о методе

create(FileSystemCreateOptions)

Создает файловую систему под указанной учетной записью. Если файловая система с тем же именем уже существует, операция завершается ошибкой.

См. раздел https://docs.microsoft.com/en-us/rest/api/storageservices/create-container.

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

Параметры

options
FileSystemCreateOptions

Необязательный. Параметры при создании файловой системы.

Возвращаемое значение

Promise<FileSystemCreateResponse>

createIfNotExists(FileSystemCreateOptions)

Создает файловую систему под указанной учетной записью. Если файловая система с тем же именем уже существует, она не изменяется.

См. раздел https://docs.microsoft.com/en-us/rest/api/storageservices/create-container.

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

Параметры

options
FileSystemCreateOptions

Возвращаемое значение

Promise<FileSystemCreateIfNotExistsResponse>

delete(FileSystemDeleteOptions)

Удалите текущую файловую систему.

См. раздел https://docs.microsoft.com/en-us/rest/api/storageservices/delete-container.

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

Параметры

options
FileSystemDeleteOptions

Необязательный. Параметры при удалении файловой системы.

Возвращаемое значение

Promise<FileSystemDeleteResponse>

deleteIfExists(FileSystemDeleteOptions)

Удалите текущую файловую систему, если она существует.

См. раздел https://docs.microsoft.com/en-us/rest/api/storageservices/delete-container.

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

Параметры

options
FileSystemDeleteOptions

Возвращаемое значение

Promise<FileSystemDeleteIfExistsResponse>

exists(FileSystemExistsOptions)

Возвращает значение true, если файловая система, представленная этим клиентом; False в противном случае.

ПРИМЕЧАНИЕ. Используйте эту функцию с осторожностью, так как существующая файловая система может быть удалена другими клиентами или приложениями. Наоборот, новая файловая система с тем же именем может быть добавлена другими клиентами или приложениями после завершения этой функции.

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

Параметры

options
FileSystemExistsOptions

Возвращаемое значение

Promise<boolean>

generateSasStringToSign(FileSystemGenerateSasUrlOptions)

Доступно только для DataLakeFileSystemClient, созданного с использованием учетных данных общего ключа.

Создает строку для входа в универсальный код ресурса (SAS) службы на основе свойств и параметров клиента, переданных. SAS подписан учетными данными общего ключа клиента.

См. раздел https://docs.microsoft.com/en-us/rest/api/storageservices/constructing-a-service-sas.

function generateSasStringToSign(options: FileSystemGenerateSasUrlOptions): string

Параметры

options
FileSystemGenerateSasUrlOptions

Необязательные параметры.

Возвращаемое значение

string

URI SAS, состоящий из URI ресурса, представленного этим клиентом, за которым следует созданный маркер SAS.

generateSasUrl(FileSystemGenerateSasUrlOptions)

Доступно только для DataLakeFileSystemClient, созданного с использованием учетных данных общего ключа.

Создает универсальный код ресурса (SAS) подписанного URL-адреса службы на основе свойств и параметров клиента, переданных. SAS подписан учетными данными общего ключа клиента.

См. раздел https://docs.microsoft.com/en-us/rest/api/storageservices/constructing-a-service-sas.

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

Параметры

options
FileSystemGenerateSasUrlOptions

Необязательные параметры.

Возвращаемое значение

Promise<string>

URI SAS, состоящий из URI ресурса, представленного этим клиентом, за которым следует созданный маркер SAS.

generateUserDelegationSasStringToSign(FileSystemGenerateSasUrlOptions, UserDelegationKey)

Создает строку для входа в универсальный код ресурса (SAS) службы на основе свойств и параметров клиента, переданных. SAS подписан ключом делегирования входных пользователей.

См. раздел https://docs.microsoft.com/en-us/rest/api/storageservices/constructing-a-service-sas.

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

Параметры

options
FileSystemGenerateSasUrlOptions

Необязательные параметры.

userDelegationKey
UserDelegationKey

Возвращаемое значение blobServiceClient.getUserDelegationKey()

Возвращаемое значение

string

URI SAS, состоящий из URI ресурса, представленного этим клиентом, за которым следует созданный маркер SAS.

generateUserDelegationSasUrl(FileSystemGenerateSasUrlOptions, UserDelegationKey)

Создает универсальный код ресурса (SAS) подписанного URL-адреса службы на основе свойств и параметров клиента, переданных. SAS подписан ключом делегирования входных пользователей.

См. раздел https://docs.microsoft.com/en-us/rest/api/storageservices/constructing-a-service-sas.

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

Параметры

options
FileSystemGenerateSasUrlOptions

Необязательные параметры.

userDelegationKey
UserDelegationKey

Возвращаемое значение blobServiceClient.getUserDelegationKey()

Возвращаемое значение

Promise<string>

URI SAS, состоящий из URI ресурса, представленного этим клиентом, за которым следует созданный маркер SAS.

getAccessPolicy(FileSystemGetAccessPolicyOptions)

Получает разрешения для указанной файловой системы. Разрешения указывают, могут ли данные файловой системы получать общедоступный доступ.

ПРЕДУПРЕЖДЕНИЕ. Дата JavaScript потенциально потеряет точность при синтаксическом анализе начинается и истекает срок действия строкOn. Например, new Date("2018-12-31T03:44:23.8827891Z").toISOString() получит "2018-12-31T03:44:23.882Z".

См. раздел https://docs.microsoft.com/en-us/rest/api/storageservices/get-container-acl.

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

Параметры

options
FileSystemGetAccessPolicyOptions

Необязательный. Параметры при получении политики доступа к файловой системе.

Возвращаемое значение

Promise<FileSystemGetAccessPolicyResponse>

getDataLakeLeaseClient(string)

Получите DataLakeLeaseClient, которая управляет арендой файловой системы.

function getDataLakeLeaseClient(proposeLeaseId?: string): DataLakeLeaseClient

Параметры

proposeLeaseId

string

Необязательный. Первоначальный предлагаемый идентификатор аренды.

Возвращаемое значение

DataLakeLeaseClient

getDirectoryClient(string)

Создает объект DataLakeDirectoryClient в текущей файловой системе.

function getDirectoryClient(directoryName: string): DataLakeDirectoryClient

Параметры

directoryName

string

Возвращаемое значение

DataLakeDirectoryClient

getFileClient(string)

Создает объект DataLakeFileClient в текущей файловой системе.

function getFileClient(fileName: string): DataLakeFileClient

Параметры

fileName

string

Возвращаемое значение

DataLakeFileClient

getProperties(FileSystemGetPropertiesOptions)

Возвращает все пользовательские метаданные и системные свойства для указанной файловой системы.

ПРЕДУПРЕЖДЕНИЕ. Объект metadata, возвращенный в ответе, будет иметь свои ключи в нижнем регистре, даже если они первоначально содержали прописные символы. Это отличается от ключей метаданных, возвращаемых методом listFileSystemsDataLakeServiceClient с помощью параметра includeMetadata, который будет хранить исходную регистру.

См. раздел https://docs.microsoft.com/en-us/rest/api/storageservices/get-container-properties.

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

Параметры

options
FileSystemGetPropertiesOptions

Необязательный. Параметры при получении свойств файловой системы.

Возвращаемое значение

Promise<FileSystemGetPropertiesResponse>

listDeletedPaths(ListDeletedPathsOptions)

Возвращает асинхронный итератор для перечисления всех путей (каталогов и файлов) в указанной файловой системе.

.byPage() возвращает асинхронный итератор для перечисления путей на страницах.

Пример использования синтаксиса 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}`);
}

Пример, использующий среду 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();
}

Пример, использующий среду 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}`);
  }
}

Пример использования разбиения по страницам с маркером:

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

См. раздел https://docs.microsoft.com/rest/api/storageservices/list-blobs.

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

Параметры

options
ListDeletedPathsOptions

Необязательный. Параметры при перечислении удаленных путей.

Возвращаемое значение

PagedAsyncIterableIterator<DeletedPath, FileSystemListDeletedPathsResponse, PageSettings>

listPaths(ListPathsOptions)

Возвращает асинхронный итератор для перечисления всех путей (каталогов и файлов) в указанной файловой системе.

.byPage() возвращает асинхронный итератор для перечисления путей на страницах.

Пример использования синтаксиса 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}`);
}

Пример, использующий среду 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();
}

Пример, использующий среду 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}`);
  }
}

Пример использования разбиения по страницам с маркером:

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

См. раздел https://docs.microsoft.com/rest/api/storageservices/list-blobs.

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

Параметры

options
ListPathsOptions

Необязательный. Параметры при перечислении путей.

Возвращаемое значение

PagedAsyncIterableIterator<Path, FileSystemListPathsResponse, PageSettings>

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

Задает разрешения для указанной файловой системы. Разрешения указывают, доступны ли каталоги или файлы в файловой системе общедоступным образом.

При установке разрешений для файловой системы существующие разрешения заменяются. Если доступ или контейнерAcl не указан, доступ к существующей файловой системе будет удален.

См. раздел https://docs.microsoft.com/en-us/rest/api/storageservices/set-container-acl.

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

Параметры

access
PublicAccessType

Необязательный. Уровень общедоступного доступа к данным в файловой системе.

fileSystemAcl

SignedIdentifier<AccessPolicy>[]

Необязательный. Массив элементов, каждый из которых имеет уникальный идентификатор и сведения о политике доступа.

options
FileSystemSetAccessPolicyOptions

Необязательный. Параметры при настройке политики доступа к файловой системе.

Возвращаемое значение

Promise<FileSystemSetAccessPolicyResponse>

setMetadata(Metadata, FileSystemSetMetadataOptions)

Задает одну или несколько определяемых пользователем пар name-value для указанной файловой системы.

Если в параметре не указан параметр или метаданные, определенные в параметре, метаданные файловой системы будут удалены.

См. раздел https://docs.microsoft.com/en-us/rest/api/storageservices/set-container-metadata.

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

Параметры

metadata
Metadata

Замените существующие метаданные этим значением. Если значение, предоставленное существующими метаданными, не будет удалено.

options
FileSystemSetMetadataOptions

Необязательный. Параметры при настройке метаданных файловой системы.

Возвращаемое значение

Promise<FileSystemSetMetadataResponse>

undeletePath(string, string, FileSystemUndeletePathOption)

Восстанавливает обратимый удаленный путь.

См. раздел https://docs.microsoft.com/en-us/rest/api/storageservices/undelete-blob.

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

Параметры

deletedPath

string

Обязательно. Путь к удаленному пути.

deletionId

string

Обязательно. Идентификатор удаления, связанный с обратимым удаленным путем.

options
FileSystemUndeletePathOption

Возвращаемое значение

Promise<FileSystemUndeletePathResponse>