Sdílet prostřednictvím

DataLakeFileSystemClient class

Balíček:
@azure/storage-file-datalake

DataLakeFileSystemClient představuje adresu URL systému souborů Azure Storage, který umožňuje manipulovat s jeho adresáři a soubory.

Extends

StorageClient

Konstruktory

DataLakeFileSystemClient(string, Pipeline)

Vytvoří instanci DataLakeFileSystemClient z adresy URL a kanálu.
DataLakeFileSystemClient(string, StorageSharedKeyCredential | AnonymousCredential | TokenCredential, StoragePipelineOptions)

Vytvoří instanci DataLakeFileSystemClient z adresy URL a přihlašovacích údajů.

Vlastnosti

name

Název aktuálního systému souborů

Zděděné vlastnosti

accountName
credential

Například AnonymousCredential, StorageSharedKeyCredential nebo jakékoli přihlašovací údaje z balíčku @azure/identity k ověření požadavků na službu. Můžete také poskytnout objekt, který implementuje TokenCredential rozhraní. Pokud není zadáno, použije se anonymnícredential.
url

Zakódovaná hodnota řetězce adresy URL.

Metody

create(FileSystemCreateOptions)

Vytvoří nový systém souborů v rámci zadaného účtu. Pokud již systém souborů se stejným názvem existuje, operace selže.

Viz https://learn.microsoft.com/rest/api/storageservices/create-container
createIfNotExists(FileSystemCreateOptions)

Vytvoří nový systém souborů v rámci zadaného účtu. Pokud již systém souborů se stejným názvem existuje, nezmění se.

Viz https://learn.microsoft.com/rest/api/storageservices/create-container
delete(FileSystemDeleteOptions)

Odstraňte aktuální systém souborů.

Viz https://learn.microsoft.com/rest/api/storageservices/delete-container
deleteIfExists(FileSystemDeleteOptions)

Pokud existuje, odstraňte aktuální systém souborů.

Viz https://learn.microsoft.com/rest/api/storageservices/delete-container
exists(FileSystemExistsOptions)

Vrátí hodnotu true, pokud systém souborů reprezentovaný tímto klientem existuje; jinak nepravda.

POZNÁMKA: Tuto funkci používejte opatrně, protože existující systém souborů může být odstraněn jinými klienty nebo aplikacemi. Po dokončení této funkce může být nový systém souborů se stejným názvem přidán jinými klienty nebo aplikacemi.
generateSasStringToSign(FileSystemGenerateSasUrlOptions)

K dispozici pouze pro DataLakeFileSystemClient vytvořený s přihlašovacími údaji sdíleného klíče.

Vygeneruje řetězec pro podepsání identifikátoru URI sdíleného přístupového podpisu služby (SAS) na základě vlastností klienta a parametrů předaných. Sas je podepsán přihlašovacími údaji sdíleného klíče klienta.

Viz https://learn.microsoft.com/rest/api/storageservices/constructing-a-service-sas
generateSasUrl(FileSystemGenerateSasUrlOptions)

K dispozici pouze pro DataLakeFileSystemClient vytvořený s přihlašovacími údaji sdíleného klíče.

Vygeneruje identifikátor URI sdíleného přístupového podpisu (SAS) služby na základě vlastností klienta a parametrů předaných. Sas je podepsán přihlašovacími údaji sdíleného klíče klienta.

Viz https://learn.microsoft.com/rest/api/storageservices/constructing-a-service-sas
generateUserDelegationSasStringToSign(FileSystemGenerateSasUrlOptions, UserDelegationKey)

Vygeneruje řetězec pro podepsání identifikátoru URI sdíleného přístupového podpisu služby (SAS) na základě vlastností klienta a parametrů předaných. SAS je podepsán vstupním klíčem delegování uživatele.

Viz https://learn.microsoft.com/rest/api/storageservices/constructing-a-service-sas
generateUserDelegationSasUrl(FileSystemGenerateSasUrlOptions, UserDelegationKey)

Vygeneruje identifikátor URI sdíleného přístupového podpisu (SAS) služby na základě vlastností klienta a parametrů předaných. SAS je podepsán vstupním klíčem delegování uživatele.

Viz https://learn.microsoft.com/rest/api/storageservices/constructing-a-service-sas
getAccessPolicy(FileSystemGetAccessPolicyOptions)

Získá oprávnění pro zadaný systém souborů. Oprávnění indikují, jestli se k datům systému souborů může přistupovat veřejně.

UPOZORNĚNÍ: JavaScript Date může přijít o přesnost při analýze startOn a vypršení platnosti řetězcůOn. Například nové datum("2018-12-31T03:44:23.8827891Z"). toISOString() získá "2018-12-31T03:44:23.882Z".

Viz https://learn.microsoft.com/rest/api/storageservices/get-container-acl
getDataLakeLeaseClient(string)

Získejte DataLakeLeaseClient, který spravuje zapůjčení v systému souborů.
getDirectoryClient(string)

Vytvoří objekt DataLakeDirectoryClient v aktuálním systému souborů.
getFileClient(string)

Vytvoří objekt DataLakeFileClient v aktuálním systému souborů.
getProperties(FileSystemGetPropertiesOptions)

Vrátí všechna uživatelsky definovaná metadata a systémové vlastnosti pro zadaný systém souborů.

UPOZORNĚNÍ: Objekt metadata vrácený v odpovědi bude mít klíče malými písmeny, i když původně obsahovaly velké znaky. To se liší od klíčů metadat vrácených metodou listFileSystemsDataLakeServiceClient pomocí možnosti includeMetadata, která zachová původní velikost skříně.

Viz https://learn.microsoft.com/rest/api/storageservices/get-container-properties
listDeletedPaths(ListDeletedPathsOptions)

Vrátí asynchronní iterátor pro výpis všech cest (adresářů a souborů) v zadaném systému souborů.

.byPage() vrátí asynchronní iterátor pro výpis cest na stránkách.

Příklad použití syntaxe 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}`);
}

Příklad použití 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());
}

Příklad použití 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}`);
    }
  }
}

Příklad použití stránkování se značkou:

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

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

Vrátí asynchronní iterátor pro výpis všech cest (adresářů a souborů) v zadaném systému souborů.

.byPage() vrátí asynchronní iterátor pro výpis cest na stránkách.

Příklad použití syntaxe 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}`);
}

Příklad použití 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());
}

Příklad použití 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}`);
    }
  }
}

Příklad použití stránkování se značkou:

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

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

Nastaví oprávnění pro zadaný systém souborů. Oprávnění označují, jestli se k adresářům nebo souborům v systému souborů může přistupovat veřejně.

Když nastavíte oprávnění pro systém souborů, nahradí se stávající oprávnění. Pokud není k dispozici žádný přístup nebo seznam ContainerAcl, odebere se stávající seznam ACL systému souborů.

Viz https://learn.microsoft.com/rest/api/storageservices/set-container-acl
setMetadata(Metadata, FileSystemSetMetadataOptions)

Nastaví jeden nebo více uživatelsky definovaných párů name-value pro zadaný systém souborů.

Pokud není k dispozici žádná možnost nebo v parametru nejsou definována žádná metadata, odeberou se metadata systému souborů.

Viz https://learn.microsoft.com/rest/api/storageservices/set-container-metadata
undeletePath(string, string, FileSystemUndeletePathOption)

Obnoví obnovitelně odstraněnou cestu.

Viz https://learn.microsoft.com/rest/api/storageservices/undelete-blob

Podrobnosti konstruktoru

DataLakeFileSystemClient(string, Pipeline)

Vytvoří instanci DataLakeFileSystemClient z adresy URL a kanálu.

new DataLakeFileSystemClient(url: string, pipeline: Pipeline)

Parametry

url

string

Klientský řetězec odkazující na systém souborů Azure Storage Data Lake, například "https://myaccount.dfs.core.windows.net/filesystem". Sas můžete připojit, pokud používáte AnonymousCredential, například "https://myaccount.dfs.core.windows.net/filesystem?sasString".

pipeline
Pipeline

Voláním metody newPipeline() vytvořte výchozí kanál nebo zadejte přizpůsobený kanál.

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

Vytvoří instanci DataLakeFileSystemClient z adresy URL a přihlašovacích údajů.

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

Parametry

url

string

Klientský řetězec odkazující na systém souborů Azure Storage Data Lake, například "https://myaccount.dfs.core.windows.net/filesystem". Sas můžete připojit, pokud používáte AnonymousCredential, například "https://myaccount.dfs.core.windows.net/filesystem?sasString".

credential

StorageSharedKeyCredential | AnonymousCredential | TokenCredential

Například AnonymousCredential, StorageSharedKeyCredential nebo jakékoli přihlašovací údaje z balíčku @azure/identity k ověření požadavků na službu. Můžete také poskytnout objekt, který implementuje TokenCredential rozhraní. Pokud není zadáno, použije se anonymnícredential.

options
StoragePipelineOptions

Optional. Možnosti konfigurace kanálu HTTP

Podrobnosti vlastnosti

name

Název aktuálního systému souborů

string name

Hodnota vlastnosti

string

Podrobnosti zděděných vlastností

accountName 

accountName: string

Hodnota vlastnosti

string

zděděno ze StorageClient.accountName

credential

Například AnonymousCredential, StorageSharedKeyCredential nebo jakékoli přihlašovací údaje z balíčku @azure/identity k ověření požadavků na službu. Můžete také poskytnout objekt, který implementuje TokenCredential rozhraní. Pokud není zadáno, použije se anonymnícredential.

credential: StorageSharedKeyCredential | AnonymousCredential | TokenCredential

Hodnota vlastnosti

StorageSharedKeyCredential | AnonymousCredential | TokenCredential

zděděné z StorageClient.credential

url

Zakódovaná hodnota řetězce adresy URL.

url: string

Hodnota vlastnosti

string

zděděno ze StorageClient.url

Podrobnosti metody

create(FileSystemCreateOptions)

Vytvoří nový systém souborů v rámci zadaného účtu. Pokud již systém souborů se stejným názvem existuje, operace selže.

Viz https://learn.microsoft.com/rest/api/storageservices/create-container

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

Parametry

options
FileSystemCreateOptions

Optional. Možnosti při vytváření systému souborů

Návraty

Promise<FileSystemCreateResponse>

createIfNotExists(FileSystemCreateOptions)

Vytvoří nový systém souborů v rámci zadaného účtu. Pokud již systém souborů se stejným názvem existuje, nezmění se.

Viz https://learn.microsoft.com/rest/api/storageservices/create-container

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

Parametry

options
FileSystemCreateOptions

Návraty

Promise<FileSystemCreateIfNotExistsResponse>

delete(FileSystemDeleteOptions)

Odstraňte aktuální systém souborů.

Viz https://learn.microsoft.com/rest/api/storageservices/delete-container

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

Parametry

options
FileSystemDeleteOptions

Optional. Možnosti při odstraňování systému souborů

Návraty

Promise<FileSystemDeleteResponse>

deleteIfExists(FileSystemDeleteOptions)

Pokud existuje, odstraňte aktuální systém souborů.

Viz https://learn.microsoft.com/rest/api/storageservices/delete-container

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

Parametry

options
FileSystemDeleteOptions

Návraty

Promise<FileSystemDeleteIfExistsResponse>

exists(FileSystemExistsOptions)

Vrátí hodnotu true, pokud systém souborů reprezentovaný tímto klientem existuje; jinak nepravda.

POZNÁMKA: Tuto funkci používejte opatrně, protože existující systém souborů může být odstraněn jinými klienty nebo aplikacemi. Po dokončení této funkce může být nový systém souborů se stejným názvem přidán jinými klienty nebo aplikacemi.

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

Parametry

options
FileSystemExistsOptions

Návraty

Promise<boolean>

generateSasStringToSign(FileSystemGenerateSasUrlOptions)

K dispozici pouze pro DataLakeFileSystemClient vytvořený s přihlašovacími údaji sdíleného klíče.

Vygeneruje řetězec pro podepsání identifikátoru URI sdíleného přístupového podpisu služby (SAS) na základě vlastností klienta a parametrů předaných. Sas je podepsán přihlašovacími údaji sdíleného klíče klienta.

Viz https://learn.microsoft.com/rest/api/storageservices/constructing-a-service-sas

function generateSasStringToSign(options: FileSystemGenerateSasUrlOptions): string

Parametry

options
FileSystemGenerateSasUrlOptions

Volitelné parametry.

Návraty

string

Identifikátor URI SAS, který se skládá z identifikátoru URI pro prostředek reprezentovaný tímto klientem, následovaný vygenerovaným tokenem SAS.

generateSasUrl(FileSystemGenerateSasUrlOptions)

K dispozici pouze pro DataLakeFileSystemClient vytvořený s přihlašovacími údaji sdíleného klíče.

Vygeneruje identifikátor URI sdíleného přístupového podpisu (SAS) služby na základě vlastností klienta a parametrů předaných. Sas je podepsán přihlašovacími údaji sdíleného klíče klienta.

Viz https://learn.microsoft.com/rest/api/storageservices/constructing-a-service-sas

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

Parametry

options
FileSystemGenerateSasUrlOptions

Volitelné parametry.

Návraty

Promise<string>

Identifikátor URI SAS, který se skládá z identifikátoru URI pro prostředek reprezentovaný tímto klientem, následovaný vygenerovaným tokenem SAS.

generateUserDelegationSasStringToSign(FileSystemGenerateSasUrlOptions, UserDelegationKey)

Vygeneruje řetězec pro podepsání identifikátoru URI sdíleného přístupového podpisu služby (SAS) na základě vlastností klienta a parametrů předaných. SAS je podepsán vstupním klíčem delegování uživatele.

Viz https://learn.microsoft.com/rest/api/storageservices/constructing-a-service-sas

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

Parametry

options
FileSystemGenerateSasUrlOptions

Volitelné parametry.

userDelegationKey
UserDelegationKey

Návratová hodnota blobServiceClient.getUserDelegationKey()

Návraty

string

Identifikátor URI SAS, který se skládá z identifikátoru URI pro prostředek reprezentovaný tímto klientem, následovaný vygenerovaným tokenem SAS.

generateUserDelegationSasUrl(FileSystemGenerateSasUrlOptions, UserDelegationKey)

Vygeneruje identifikátor URI sdíleného přístupového podpisu (SAS) služby na základě vlastností klienta a parametrů předaných. SAS je podepsán vstupním klíčem delegování uživatele.

Viz https://learn.microsoft.com/rest/api/storageservices/constructing-a-service-sas

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

Parametry

options
FileSystemGenerateSasUrlOptions

Volitelné parametry.

userDelegationKey
UserDelegationKey

Návratová hodnota blobServiceClient.getUserDelegationKey()

Návraty

Promise<string>

Identifikátor URI SAS, který se skládá z identifikátoru URI pro prostředek reprezentovaný tímto klientem, následovaný vygenerovaným tokenem SAS.

getAccessPolicy(FileSystemGetAccessPolicyOptions)

Získá oprávnění pro zadaný systém souborů. Oprávnění indikují, jestli se k datům systému souborů může přistupovat veřejně.

UPOZORNĚNÍ: JavaScript Date může přijít o přesnost při analýze startOn a vypršení platnosti řetězcůOn. Například nové datum("2018-12-31T03:44:23.8827891Z"). toISOString() získá "2018-12-31T03:44:23.882Z".

Viz https://learn.microsoft.com/rest/api/storageservices/get-container-acl

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

Parametry

options
FileSystemGetAccessPolicyOptions

Optional. Možnosti při získávání zásad přístupu k systému souborů

Návraty

Promise<FileSystemGetAccessPolicyResponse>

getDataLakeLeaseClient(string)

Získejte DataLakeLeaseClient, který spravuje zapůjčení v systému souborů.

function getDataLakeLeaseClient(proposeLeaseId?: string): DataLakeLeaseClient

Parametry

proposeLeaseId

string

Optional. Počáteční navrhované ID zapůjčení

Návraty

DataLakeLeaseClient

getDirectoryClient(string)

Vytvoří objekt DataLakeDirectoryClient v aktuálním systému souborů.

function getDirectoryClient(directoryName: string): DataLakeDirectoryClient

Parametry

directoryName

string

Návraty

DataLakeDirectoryClient

getFileClient(string)

Vytvoří objekt DataLakeFileClient v aktuálním systému souborů.

function getFileClient(fileName: string): DataLakeFileClient

Parametry

fileName

string

Návraty

DataLakeFileClient

getProperties(FileSystemGetPropertiesOptions)

Vrátí všechna uživatelsky definovaná metadata a systémové vlastnosti pro zadaný systém souborů.

UPOZORNĚNÍ: Objekt metadata vrácený v odpovědi bude mít klíče malými písmeny, i když původně obsahovaly velké znaky. To se liší od klíčů metadat vrácených metodou listFileSystemsDataLakeServiceClient pomocí možnosti includeMetadata, která zachová původní velikost skříně.

Viz https://learn.microsoft.com/rest/api/storageservices/get-container-properties

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

Parametry

options
FileSystemGetPropertiesOptions

Optional. Možnosti při získávání vlastností systému souborů

Návraty

Promise<FileSystemGetPropertiesResponse>

listDeletedPaths(ListDeletedPathsOptions)

Vrátí asynchronní iterátor pro výpis všech cest (adresářů a souborů) v zadaném systému souborů.

.byPage() vrátí asynchronní iterátor pro výpis cest na stránkách.

Příklad použití syntaxe 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}`);
}

Příklad použití 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());
}

Příklad použití 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}`);
    }
  }
}

Příklad použití stránkování se značkou:

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

Viz https://learn.microsoft.com/rest/api/storageservices/list-blobs

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

Parametry

options
ListDeletedPathsOptions

Optional. Možnosti při výpisu odstraněných cest

Návraty

PagedAsyncIterableIterator<DeletedPath, FileSystemListDeletedPathsResponse, PageSettings>

listPaths(ListPathsOptions)

Vrátí asynchronní iterátor pro výpis všech cest (adresářů a souborů) v zadaném systému souborů.

.byPage() vrátí asynchronní iterátor pro výpis cest na stránkách.

Příklad použití syntaxe 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}`);
}

Příklad použití 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());
}

Příklad použití 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}`);
    }
  }
}

Příklad použití stránkování se značkou:

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

Viz https://learn.microsoft.com/rest/api/storageservices/list-blobs

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

Parametry

options
ListPathsOptions

Optional. Možnosti při výpisu cest

Návraty

PagedAsyncIterableIterator<Path, FileSystemListPathsResponse, PageSettings>

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

Nastaví oprávnění pro zadaný systém souborů. Oprávnění označují, jestli se k adresářům nebo souborům v systému souborů může přistupovat veřejně.

Když nastavíte oprávnění pro systém souborů, nahradí se stávající oprávnění. Pokud není k dispozici žádný přístup nebo seznam ContainerAcl, odebere se stávající seznam ACL systému souborů.

Viz https://learn.microsoft.com/rest/api/storageservices/set-container-acl

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

Parametry

access
PublicAccessType

Optional. Úroveň veřejného přístupu k datům v systému souborů.

fileSystemAcl

SignedIdentifier<AccessPolicy>[]

Optional. Pole prvků, které mají jedinečné ID a podrobnosti o zásadách přístupu.

options
FileSystemSetAccessPolicyOptions

Optional. Možnosti při nastavování zásad přístupu k systému souborů

Návraty

Promise<FileSystemSetAccessPolicyResponse>

setMetadata(Metadata, FileSystemSetMetadataOptions)

Nastaví jeden nebo více uživatelsky definovaných párů name-value pro zadaný systém souborů.

Pokud není k dispozici žádná možnost nebo v parametru nejsou definována žádná metadata, odeberou se metadata systému souborů.

Viz https://learn.microsoft.com/rest/api/storageservices/set-container-metadata

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

Parametry

metadata
Metadata

Nahraďte stávající metadata touto hodnotou. Pokud není zadaná žádná hodnota, stávající metadata se odeberou.

options
FileSystemSetMetadataOptions

Optional. Možnosti při nastavování metadat systému souborů

Návraty

Promise<FileSystemSetMetadataResponse>

undeletePath(string, string, FileSystemUndeletePathOption)

Obnoví obnovitelně odstraněnou cestu.

Viz https://learn.microsoft.com/rest/api/storageservices/undelete-blob

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

Parametry

deletedPath

string

Required. Cesta odstraněné cesty.

deletionId

string

Required. ID odstranění přidružené k obnovitelně odstraněné cestě.

options
FileSystemUndeletePathOption

Návraty

Promise<FileSystemUndeletePathResponse>