DataLakeFileSystemClient class

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

new DataLakeFileSystemClient(url: string, pipeline: Pipeline)

Параметры

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

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

Параметры

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

string name

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

accountName: string

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

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

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

credential: StorageSharedKeyCredential | AnonymousCredential | TokenCredential

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

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

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

url: string

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

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

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

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

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

Параметры

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

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

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

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

Параметры

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

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

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

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

Параметры

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

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

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

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

Параметры

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

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

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

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

Параметры

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

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

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

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

function generateSasStringToSign(options: FileSystemGenerateSasUrlOptions): string

Параметры

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

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

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

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

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

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

Параметры

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

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

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

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

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

Параметры

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

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

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

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

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

Параметры

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

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

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

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

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

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

Параметры

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

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

function getDataLakeLeaseClient(proposeLeaseId?: string): DataLakeLeaseClient

Параметры

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

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

function getDirectoryClient(directoryName: string): DataLakeDirectoryClient

Параметры

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

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

function getFileClient(fileName: string): DataLakeFileClient

Параметры

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

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

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

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

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

Параметры

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

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

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

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

import { DataLakeServiceClient } from "@azure/storage-file-datalake";
import { DefaultAzureCredential } from "@azure/identity";

const account = "<account>";
const datalakeServiceClient = new DataLakeServiceClient(
  `https://${account}.dfs.core.windows.net`,
  new DefaultAzureCredential(),
);

const fileSystemName = "<file system name>";
const fileSystemClient = datalakeServiceClient.getFileSystemClient(fileSystemName);

let i = 1;
const deletedPaths = fileSystemClient.listDeletedPaths();
for await (const deletedPath of deletedPaths) {
  console.log(`Deleted path ${i++}: ${deletedPath.name}, deleted on: ${deletedPath.deletedOn}`);
}

Пример, использующий среду iter.next():

import { DataLakeServiceClient } from "@azure/storage-file-datalake";
import { DefaultAzureCredential } from "@azure/identity";

const account = "<account>";
const datalakeServiceClient = new DataLakeServiceClient(
  `https://${account}.dfs.core.windows.net`,
  new DefaultAzureCredential(),
);

const fileSystemName = "<file system name>";
const fileSystemClient = datalakeServiceClient.getFileSystemClient(fileSystemName);

let i = 1;
const deletedPaths = fileSystemClient.listDeletedPaths();
let { value, done } = await deletedPaths.next();
while (!done) {
  console.log(`Deleted path ${i++}: ${value.name}, deleted on: ${value.deletedOn}`);
  ({ value, done } = await deletedPaths.next());
}

Пример, использующий среду byPage():

import { DataLakeServiceClient } from "@azure/storage-file-datalake";
import { DefaultAzureCredential } from "@azure/identity";

const account = "<account>";
const datalakeServiceClient = new DataLakeServiceClient(
  `https://${account}.dfs.core.windows.net`,
  new DefaultAzureCredential(),
);

const fileSystemName = "<file system name>";
const fileSystemClient = datalakeServiceClient.getFileSystemClient(fileSystemName);

let i = 1;
for await (const response of fileSystemClient.listDeletedPaths().byPage({ maxPageSize: 20 })) {
  if (response.pathItems) {
    for (const deletedPath of response.pathItems) {
      console.log(`Deleted path ${i++}: ${deletedPath.name}, deleted on: ${deletedPath.deletedOn}`);
    }
  }
}

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

import { DataLakeServiceClient } from "@azure/storage-file-datalake";
import { DefaultAzureCredential } from "@azure/identity";

const account = "<account>";
const datalakeServiceClient = new DataLakeServiceClient(
  `https://${account}.dfs.core.windows.net`,
  new DefaultAzureCredential(),
);

const fileSystemName = "<file system name>";
const fileSystemClient = datalakeServiceClient.getFileSystemClient(fileSystemName);

let i = 1;
let deletedPaths = fileSystemClient.listDeletedPaths().byPage({ maxPageSize: 2 });
let response = (await deletedPaths.next()).value;
// Prints 2 deleted paths
if (response.deletedPathItems) {
  for (const deletedPath of response.deletedPathItems) {
    console.log(`Deleted path ${i++}: ${deletedPath.name}, deleted on: ${deletedPath.deletedOn}`);
  }
}
// Gets next marker
let marker = response.continuationToken;
// Passing next marker as continuationToken
deletedPaths = fileSystemClient
  .listDeletedPaths()
  .byPage({ continuationToken: marker, maxPageSize: 10 });
response = (await deletedPaths.next()).value;
// Prints 10 deleted paths
if (response.deletedPathItems) {
  for (const deletedPath of response.deletedPathItems) {
    console.log(`Deleted path ${i++}: ${deletedPath.name}, deleted on: ${deletedPath.deletedOn}`);
  }
}

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

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

Параметры

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

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

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

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

import { DataLakeServiceClient } from "@azure/storage-file-datalake";
import { DefaultAzureCredential } from "@azure/identity";

const account = "<account>";
const datalakeServiceClient = new DataLakeServiceClient(
  `https://${account}.dfs.core.windows.net`,
  new DefaultAzureCredential(),
);

const fileSystemName = "<file system name>";
const fileSystemClient = datalakeServiceClient.getFileSystemClient(fileSystemName);

let i = 1;
const paths = fileSystemClient.listPaths();
for await (const path of paths) {
  console.log(`Path ${i++}: ${path.name}, is directory: ${path.isDirectory}`);
}

Пример, использующий среду iter.next():

import { DataLakeServiceClient } from "@azure/storage-file-datalake";
import { DefaultAzureCredential } from "@azure/identity";

const account = "<account>";
const datalakeServiceClient = new DataLakeServiceClient(
  `https://${account}.dfs.core.windows.net`,
  new DefaultAzureCredential(),
);

const fileSystemName = "<file system name>";
const fileSystemClient = datalakeServiceClient.getFileSystemClient(fileSystemName);

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

Пример, использующий среду byPage():

import { DataLakeServiceClient } from "@azure/storage-file-datalake";
import { DefaultAzureCredential } from "@azure/identity";

const account = "<account>";
const datalakeServiceClient = new DataLakeServiceClient(
  `https://${account}.dfs.core.windows.net`,
  new DefaultAzureCredential(),
);

const fileSystemName = "<file system name>";
const fileSystemClient = datalakeServiceClient.getFileSystemClient(fileSystemName);

let i = 1;
for await (const response of fileSystemClient.listPaths().byPage({ maxPageSize: 20 })) {
  if (response.pathItems) {
    for (const path of response.pathItems) {
      console.log(`Path ${i++}: ${path.name}, is directory: ${path.isDirectory}`);
    }
  }
}

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

import { DataLakeServiceClient } from "@azure/storage-file-datalake";
import { DefaultAzureCredential } from "@azure/identity";

const account = "<account>";
const datalakeServiceClient = new DataLakeServiceClient(
  `https://${account}.dfs.core.windows.net`,
  new DefaultAzureCredential(),
);

const fileSystemName = "<file system name>";
const fileSystemClient = datalakeServiceClient.getFileSystemClient(fileSystemName);

let i = 1;
let paths = fileSystemClient.listPaths().byPage({ maxPageSize: 2 });
let response = (await paths.next()).value;
// Prints 2 paths
if (response.pathItems) {
  for (const path of response.pathItems) {
    console.log(`Path ${i++}: ${path.name}, is directory: ${path.isDirectory}`);
  }
}
// Gets next marker
let marker = response.continuationToken;
// Passing next marker as continuationToken
paths = fileSystemClient.listPaths().byPage({ continuationToken: marker, maxPageSize: 10 });
response = (await paths.next()).value;
// Prints 10 paths
if (response.pathItems) {
  for (const path of response.pathItems) {
    console.log(`Path ${i++}: ${path.name}, is directory: ${path.isDirectory}`);
  }
}

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

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

Параметры

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

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

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

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

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

Параметры

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

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

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

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

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

Параметры

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

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

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

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

Параметры

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