Sdílet prostřednictvím


DataLakeFileSystemClient class

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 @azure/identity balíčku k ověřování požadavků na službu. Můžete také zadat objekt, který implementuje rozhraní TokenCredential. 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ů pod zadaným účtem. Pokud již systém souborů se stejným názvem existuje, operace selže.

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

createIfNotExists(FileSystemCreateOptions)

Vytvoří nový systém souborů pod zadaným účtem. Pokud již systém souborů se stejným názvem existuje, nezmění se.

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

delete(FileSystemDeleteOptions)

Odstranit aktuální systém souborů.

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

deleteIfExists(FileSystemDeleteOptions)

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

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

exists(FileSystemExistsOptions)

Vrátí hodnotu true, pokud systém souborů reprezentovaný tímto klientem existuje; v opačném případě false.

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

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 služby (SAS) na základě předaných vlastností a parametrů klienta. Sas je podepsaný přihlašovacími údaji sdíleného klíče klienta.

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

getAccessPolicy(FileSystemGetAccessPolicyOptions)

Získá oprávnění pro zadaný systém souborů. Oprávnění označují, jestli je možné veřejně přistupovat k datům systému souborů.

UPOZORNĚNÍ: JavaScript Date potenciálně ztratí přesnost při parsování startsOn a expiresOn řetězců. Například nový Date("2018-12-31T03:44:23.8827891Z").toISOString() získá "2018-12-31T03:44:23.882Z".

Viz https://docs.microsoft.com/en-us/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živatelem definovaná metadata a systémové vlastnosti pro zadaný systém souborů.

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

Viz https://docs.microsoft.com/en-us/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í for await syntaxe:

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

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

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

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

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

Viz https://docs.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í for await syntaxe:

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

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

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

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

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

Viz https://docs.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řístupový seznam nebo seznam containerAcl, stávající seznam ACL systému souborů se odebere.

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

setMetadata(Metadata, FileSystemSetMetadataOptions)

Nastaví jeden nebo více uživatelsky definovaných dvojic název-hodnota pro zadaný systém souborů.

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

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

undeletePath(string, string, FileSystemUndeletePathOption)

Obnoví obnovitelně odstraněnou cestu.

Viz https://docs.microsoft.com/en-us/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

Řetězec klienta 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 příkazu newPipeline() vytvořte výchozí kanál nebo zadejte vlastní 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

Řetězec klienta 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 @azure/identity balíčku k ověřování požadavků na službu. Můžete také zadat objekt, který implementuje rozhraní TokenCredential. Pokud není zadáno, použije se AnonymníCredential.

options
StoragePipelineOptions

Nepovinný parametr. 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 z StorageClient.accountName

credential

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

credential: StorageSharedKeyCredential | AnonymousCredential | TokenCredential

Hodnota vlastnosti

Zděděno z StorageClient.credential

url

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

url: string

Hodnota vlastnosti

string

Zděděno z StorageClient.url

Podrobnosti metody

create(FileSystemCreateOptions)

Vytvoří nový systém souborů pod zadaným účtem. Pokud již systém souborů se stejným názvem existuje, operace selže.

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

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

Parametry

options
FileSystemCreateOptions

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

Návraty

createIfNotExists(FileSystemCreateOptions)

Vytvoří nový systém souborů pod zadaným účtem. Pokud již systém souborů se stejným názvem existuje, nezmění se.

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

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

Parametry

Návraty

delete(FileSystemDeleteOptions)

Odstranit aktuální systém souborů.

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

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

Parametry

options
FileSystemDeleteOptions

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

Návraty

deleteIfExists(FileSystemDeleteOptions)

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

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

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

Parametry

Návraty

exists(FileSystemExistsOptions)

Vrátí hodnotu true, pokud systém souborů reprezentovaný tímto klientem existuje; v opačném případě false.

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

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

Parametry

Návraty

Promise<boolean>

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 služby (SAS) na základě předaných vlastností a parametrů klienta. Sas je podepsaný přihlašovacími údaji sdíleného klíče klienta.

Viz https://docs.microsoft.com/en-us/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 sestávající z identifikátoru URI prostředku reprezentovaného tímto klientem a následně z vygenerovaného tokenu SAS.

getAccessPolicy(FileSystemGetAccessPolicyOptions)

Získá oprávnění pro zadaný systém souborů. Oprávnění označují, jestli je možné veřejně přistupovat k datům systému souborů.

UPOZORNĚNÍ: JavaScript Date potenciálně ztratí přesnost při parsování startsOn a expiresOn řetězců. Například nový Date("2018-12-31T03:44:23.8827891Z").toISOString() získá "2018-12-31T03:44:23.882Z".

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

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

Parametry

options
FileSystemGetAccessPolicyOptions

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

Návraty

getDataLakeLeaseClient(string)

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

function getDataLakeLeaseClient(proposeLeaseId?: string): DataLakeLeaseClient

Parametry

proposeLeaseId

string

Nepovinný parametr. Počáteční navrhované ID zapůjčení

Návraty

getDirectoryClient(string)

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

function getDirectoryClient(directoryName: string): DataLakeDirectoryClient

Parametry

directoryName

string

Návraty

getFileClient(string)

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

function getFileClient(fileName: string): DataLakeFileClient

Parametry

fileName

string

Návraty

getProperties(FileSystemGetPropertiesOptions)

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

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

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

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

Parametry

options
FileSystemGetPropertiesOptions

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

Návraty

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í for await syntaxe:

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

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

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

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

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

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

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

Parametry

options
ListDeletedPathsOptions

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

Návraty

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í for await syntaxe:

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

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

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

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

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

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

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

Parametry

options
ListPathsOptions

Nepovinný parametr. Možnosti při výpisu cest

Návraty

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řístupový seznam nebo seznam containerAcl, stávající seznam ACL systému souborů se odebere.

Viz 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

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

fileSystemAcl

SignedIdentifier<AccessPolicy>[]

Nepovinný parametr. Pole prvků, z nichž každý má jedinečné ID a podrobnosti o zásadách přístupu.

options
FileSystemSetAccessPolicyOptions

Nepovinný parametr. Možnosti při nastavení zásad přístupu k systému souborů

Návraty

setMetadata(Metadata, FileSystemSetMetadataOptions)

Nastaví jeden nebo více uživatelsky definovaných dvojic název-hodnota pro zadaný systém souborů.

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

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

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

Parametry

metadata
Metadata

Nahraďte existující metadata touto hodnotou. Pokud není zadaná žádná hodnota, stávající metadata budou odebrána.

options
FileSystemSetMetadataOptions

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

Návraty

undeletePath(string, string, FileSystemUndeletePathOption)

Obnoví obnovitelně odstraněnou cestu.

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

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

Parametry

deletedPath

string

Povinná hodnota. Cesta odstraněné cesty.

deletionId

string

Povinná hodnota. ID odstranění přidružené k obnovitelné odstraněné cestě.

Návraty