DataLakeFileSystemClient class

Csomag:
@azure/storage-file-datalake

A DataLakeFileSystemClient az Azure Storage fájlrendszer url-címét jelöli, amely lehetővé teszi a címtárak és fájlok manipulálását.

Extends

StorageClient

Konstruktorok

DataLakeFileSystemClient(string, Pipeline)

Létrehozza a DataLakeFileSystemClient egy példányát az URL-címből és a folyamatból.
DataLakeFileSystemClient(string, StorageSharedKeyCredential | AnonymousCredential | TokenCredential, StoragePipelineOptions)

Létrehoz egy DataLakeFileSystemClient-példányt AZ URL-címből és a hitelesítő adatokból.

Tulajdonságok

name

Az aktuális fájlrendszer neve.

Örökölt tulajdonságok

accountName
credential

Ilyen például az AnonymousCredential, a StorageSharedKeyCredential vagy a @azure/identity csomag bármely hitelesítő adata a szolgáltatás felé irányuló kérések hitelesítéséhez. Olyan objektumot is megadhat, amely implementálja a TokenCredential interfészt. Ha nincs megadva, az AnonymousCredential lesz használva.
url

Kódolt URL-sztringérték.

Metódusok

create(FileSystemCreateOptions)

Létrehoz egy új fájlrendszert a megadott fiók alatt. Ha az azonos nevű fájlrendszer már létezik, a művelet meghiúsul.

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

Létrehoz egy új fájlrendszert a megadott fiók alatt. Ha az azonos nevű fájlrendszer már létezik, az nem módosul.

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

Törölje az aktuális fájlrendszert.

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

Ha létezik, törölje az aktuális fájlrendszert.

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

Igaz értéket ad vissza, ha az ügyfél által képviselt fájlrendszer létezik; máskülönben hamis.

MEGJEGYZÉS: Ezt a függvényt körültekintően használja, mivel előfordulhat, hogy egy meglévő fájlrendszert más ügyfelek vagy alkalmazások törölnek. Fordítva, az azonos nevű új fájlrendszert más ügyfelek vagy alkalmazások is hozzáadhatják a függvény befejeződése után.
generateSasStringToSign(FileSystemGenerateSasUrlOptions)

Csak megosztott kulcsú hitelesítő adatokkal létrehozott DataLakeFileSystemClient esetén érhető el.

Sztringet hoz létre a szolgáltatás megosztott hozzáférésű jogosultságkódjának (SAS) URI-jának aláírásához a megadott ügyféltulajdonságok és paraméterek alapján. Az SAS-t az ügyfél megosztott kulcsú hitelesítő adatai írták alá.

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

Csak megosztott kulcsú hitelesítő adatokkal létrehozott DataLakeFileSystemClient esetén érhető el.

Szolgáltatásmegosztási jogosultságkód (SAS) URI-t hoz létre a megadott ügyféltulajdonságok és paraméterek alapján. Az SAS-t az ügyfél megosztott kulcsú hitelesítő adatai írták alá.

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

Sztringet hoz létre a szolgáltatás megosztott hozzáférésű jogosultságkódjának (SAS) URI-jának aláírásához a megadott ügyféltulajdonságok és paraméterek alapján. Az SAS-t a bemeneti felhasználó delegálási kulcsa írja alá.

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

Szolgáltatásmegosztási jogosultságkód (SAS) URI-t hoz létre a megadott ügyféltulajdonságok és paraméterek alapján. Az SAS-t a bemeneti felhasználó delegálási kulcsa írja alá.

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

Lekéri a megadott fájlrendszer engedélyeit. Az engedélyek azt jelzik, hogy a fájlrendszer adatai nyilvánosan elérhetők-e.

FIGYELMEZTETÉS: A JavaScript-dátum valószínűleg elveszíti a pontosságot a startsOn és a expiresOn sztringek elemzésekor. Például az új Date("2018-12-31T03:44:23.8827891Z").toISOString() a következőt kapja: "2018-12-31T03:44:23.882Z".

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

Szerezzen be egy DataLakeLeaseClient, amely a fájlrendszerbeli bérleteket kezeli.
getDirectoryClient(string)

Létrehoz egy DataLakeDirectoryClient objektumot az aktuális fájlrendszerben.
getFileClient(string)

Létrehoz egy DataLakeFileClient objektumot az aktuális fájlrendszerben.
getProperties(FileSystemGetPropertiesOptions)

A megadott fájlrendszer összes felhasználó által definiált metaadatait és rendszertulajdonságait adja vissza.

FIGYELMEZTETÉS: A válaszban visszaadott metadata objektumnak kisbetűs kulcsai lesznek, még akkor is, ha eredetileg nagybetűket tartalmaztak. Ez eltér a DataLakeServiceClient metódusa által visszaadott metaadatkulcsoktól a beállítással, amely megőrzi az eredeti burkolatot.

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

Egy aszinkron iterátort ad vissza, amely felsorolja a megadott fájlrendszer összes elérési útját (könyvtárát és fájlját).

A .byPage() egy aszinkron iterátort ad vissza a lapok elérési útjainak listázásához.

Példa for await szintaxis használatára:

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élda a 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élda a 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élda jelölővel ellátott lapozásra:

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

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

Egy aszinkron iterátort ad vissza, amely felsorolja a megadott fájlrendszer összes elérési útját (könyvtárát és fájlját).

A .byPage() egy aszinkron iterátort ad vissza a lapok elérési útjainak listázásához.

Példa for await szintaxis használatára:

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élda a 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élda a 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élda jelölővel ellátott lapozásra:

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

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

Beállítja a megadott fájlrendszer engedélyeit. Az engedélyek azt jelzik, hogy a fájlrendszer címtárai vagy fájljai nyilvánosan elérhetők-e.

A fájlrendszer engedélyeinek beállításakor a rendszer lecseréli a meglévő engedélyeket. Ha nincs megadva hozzáférés vagy tárolóAcl, a rendszer eltávolítja a meglévő fájlrendszerbeli ACL-t.

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

Beállít egy vagy több felhasználó által definiált név-érték párot a megadott fájlrendszerhez.

Ha nincs megadva lehetőség, vagy nincs megadva metaadat a paraméterben, a rendszer eltávolítja a fájlrendszer metaadatait.

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

Helyreállíthatóan törölt elérési utat állít vissza.

Lásd: https://learn.microsoft.com/rest/api/storageservices/undelete-blob

Konstruktor adatai

DataLakeFileSystemClient(string, Pipeline)

Létrehozza a DataLakeFileSystemClient egy példányát az URL-címből és a folyamatból.

new DataLakeFileSystemClient(url: string, pipeline: Pipeline)

Paraméterek

url

string

Az Azure Storage data lake fájlrendszerére mutató ügyfélsztring, például "https://myaccount.dfs.core.windows.net/filesystem". Az SAS hozzáfűzhető, ha AnonymousCredentialt használ, például "https://myaccount.dfs.core.windows.net/filesystem?sasString".

pipeline
Pipeline

A newPipeline() hívása egy alapértelmezett folyamat létrehozásához vagy egy testreszabott folyamat megadásához.

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

Létrehoz egy DataLakeFileSystemClient-példányt AZ URL-címből és a hitelesítő adatokból.

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

Paraméterek

url

string

Az Azure Storage data lake fájlrendszerére mutató ügyfélsztring, például "https://myaccount.dfs.core.windows.net/filesystem". Az SAS hozzáfűzhető, ha AnonymousCredentialt használ, például "https://myaccount.dfs.core.windows.net/filesystem?sasString".

credential

StorageSharedKeyCredential | AnonymousCredential | TokenCredential

Ilyen például az AnonymousCredential, a StorageSharedKeyCredential vagy a @azure/identity csomag bármely hitelesítő adata a szolgáltatás felé irányuló kérések hitelesítéséhez. Olyan objektumot is megadhat, amely implementálja a TokenCredential interfészt. Ha nincs megadva, az AnonymousCredential lesz használva.

options
StoragePipelineOptions

Optional. A HTTP-folyamat konfigurálására vonatkozó beállítások.

Tulajdonság adatai

name

Az aktuális fájlrendszer neve.

string name

Tulajdonság értéke

string

Örökölt tulajdonság részletei

accountName 

accountName: string

Tulajdonság értéke

string

örökölt StorageClient.accountName

credential

Ilyen például az AnonymousCredential, a StorageSharedKeyCredential vagy a @azure/identity csomag bármely hitelesítő adata a szolgáltatás felé irányuló kérések hitelesítéséhez. Olyan objektumot is megadhat, amely implementálja a TokenCredential interfészt. Ha nincs megadva, az AnonymousCredential lesz használva.

credential: StorageSharedKeyCredential | AnonymousCredential | TokenCredential

Tulajdonság értéke

StorageSharedKeyCredential | AnonymousCredential | TokenCredential

örökölt StorageClient.credential

url

Kódolt URL-sztringérték.

url: string

Tulajdonság értéke

string

örökölt StorageClient.url-címről

Metódus adatai

create(FileSystemCreateOptions)

Létrehoz egy új fájlrendszert a megadott fiók alatt. Ha az azonos nevű fájlrendszer már létezik, a művelet meghiúsul.

Lásd: https://learn.microsoft.com/rest/api/storageservices/create-container

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

Paraméterek

options
FileSystemCreateOptions

Optional. A fájlrendszer létrehozásakor elérhető beállítások.

Válaszok

Promise<FileSystemCreateResponse>

createIfNotExists(FileSystemCreateOptions)

Létrehoz egy új fájlrendszert a megadott fiók alatt. Ha az azonos nevű fájlrendszer már létezik, az nem módosul.

Lásd: https://learn.microsoft.com/rest/api/storageservices/create-container

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

Paraméterek

options
FileSystemCreateOptions

Válaszok

Promise<FileSystemCreateIfNotExistsResponse>

delete(FileSystemDeleteOptions)

Törölje az aktuális fájlrendszert.

Lásd: https://learn.microsoft.com/rest/api/storageservices/delete-container

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

Paraméterek

options
FileSystemDeleteOptions

Optional. Beállítások a fájlrendszer törlésekor.

Válaszok

Promise<FileSystemDeleteResponse>

deleteIfExists(FileSystemDeleteOptions)

Ha létezik, törölje az aktuális fájlrendszert.

Lásd: https://learn.microsoft.com/rest/api/storageservices/delete-container

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

Paraméterek

options
FileSystemDeleteOptions

Válaszok

Promise<FileSystemDeleteIfExistsResponse>

exists(FileSystemExistsOptions)

Igaz értéket ad vissza, ha az ügyfél által képviselt fájlrendszer létezik; máskülönben hamis.

MEGJEGYZÉS: Ezt a függvényt körültekintően használja, mivel előfordulhat, hogy egy meglévő fájlrendszert más ügyfelek vagy alkalmazások törölnek. Fordítva, az azonos nevű új fájlrendszert más ügyfelek vagy alkalmazások is hozzáadhatják a függvény befejeződése után.

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

Paraméterek

options
FileSystemExistsOptions

Válaszok

Promise<boolean>

generateSasStringToSign(FileSystemGenerateSasUrlOptions)

Csak megosztott kulcsú hitelesítő adatokkal létrehozott DataLakeFileSystemClient esetén érhető el.

Sztringet hoz létre a szolgáltatás megosztott hozzáférésű jogosultságkódjának (SAS) URI-jának aláírásához a megadott ügyféltulajdonságok és paraméterek alapján. Az SAS-t az ügyfél megosztott kulcsú hitelesítő adatai írták alá.

Lásd: https://learn.microsoft.com/rest/api/storageservices/constructing-a-service-sas

function generateSasStringToSign(options: FileSystemGenerateSasUrlOptions): string

Paraméterek

options
FileSystemGenerateSasUrlOptions

Nem kötelező paraméterek.

Válaszok

string

Az ügyfél által képviselt erőforrás URI-ját tartalmazó SAS URI, amelyet a létrehozott SAS-jogkivonat követ.

generateSasUrl(FileSystemGenerateSasUrlOptions)

Csak megosztott kulcsú hitelesítő adatokkal létrehozott DataLakeFileSystemClient esetén érhető el.

Szolgáltatásmegosztási jogosultságkód (SAS) URI-t hoz létre a megadott ügyféltulajdonságok és paraméterek alapján. Az SAS-t az ügyfél megosztott kulcsú hitelesítő adatai írták alá.

Lásd: https://learn.microsoft.com/rest/api/storageservices/constructing-a-service-sas

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

Paraméterek

options
FileSystemGenerateSasUrlOptions

Nem kötelező paraméterek.

Válaszok

Promise<string>

Az ügyfél által képviselt erőforrás URI-ját tartalmazó SAS URI, amelyet a létrehozott SAS-jogkivonat követ.

generateUserDelegationSasStringToSign(FileSystemGenerateSasUrlOptions, UserDelegationKey)

Sztringet hoz létre a szolgáltatás megosztott hozzáférésű jogosultságkódjának (SAS) URI-jának aláírásához a megadott ügyféltulajdonságok és paraméterek alapján. Az SAS-t a bemeneti felhasználó delegálási kulcsa írja alá.

Lásd: https://learn.microsoft.com/rest/api/storageservices/constructing-a-service-sas

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

Paraméterek

options
FileSystemGenerateSasUrlOptions

Nem kötelező paraméterek.

userDelegationKey
UserDelegationKey

A blobServiceClient.getUserDelegationKey() visszaadott értéke

Válaszok

string

Az ügyfél által képviselt erőforrás URI-ját tartalmazó SAS URI, amelyet a létrehozott SAS-jogkivonat követ.

generateUserDelegationSasUrl(FileSystemGenerateSasUrlOptions, UserDelegationKey)

Szolgáltatásmegosztási jogosultságkód (SAS) URI-t hoz létre a megadott ügyféltulajdonságok és paraméterek alapján. Az SAS-t a bemeneti felhasználó delegálási kulcsa írja alá.

Lásd: https://learn.microsoft.com/rest/api/storageservices/constructing-a-service-sas

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

Paraméterek

options
FileSystemGenerateSasUrlOptions

Nem kötelező paraméterek.

userDelegationKey
UserDelegationKey

A blobServiceClient.getUserDelegationKey() visszaadott értéke

Válaszok

Promise<string>

Az ügyfél által képviselt erőforrás URI-ját tartalmazó SAS URI, amelyet a létrehozott SAS-jogkivonat követ.

getAccessPolicy(FileSystemGetAccessPolicyOptions)

Lekéri a megadott fájlrendszer engedélyeit. Az engedélyek azt jelzik, hogy a fájlrendszer adatai nyilvánosan elérhetők-e.

FIGYELMEZTETÉS: A JavaScript-dátum valószínűleg elveszíti a pontosságot a startsOn és a expiresOn sztringek elemzésekor. Például az új Date("2018-12-31T03:44:23.8827891Z").toISOString() a következőt kapja: "2018-12-31T03:44:23.882Z".

Lásd: https://learn.microsoft.com/rest/api/storageservices/get-container-acl

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

Paraméterek

options
FileSystemGetAccessPolicyOptions

Optional. A fájlrendszer hozzáférési szabályzatának lekéréséhez szükséges beállítások.

Válaszok

Promise<FileSystemGetAccessPolicyResponse>

getDataLakeLeaseClient(string)

Szerezzen be egy DataLakeLeaseClient, amely a fájlrendszerbeli bérleteket kezeli.

function getDataLakeLeaseClient(proposeLeaseId?: string): DataLakeLeaseClient

Paraméterek

proposeLeaseId

string

Optional. Kezdeti javasolt bérletazonosító.

Válaszok

DataLakeLeaseClient

getDirectoryClient(string)

Létrehoz egy DataLakeDirectoryClient objektumot az aktuális fájlrendszerben.

function getDirectoryClient(directoryName: string): DataLakeDirectoryClient

Paraméterek

directoryName

string

Válaszok

DataLakeDirectoryClient

getFileClient(string)

Létrehoz egy DataLakeFileClient objektumot az aktuális fájlrendszerben.

function getFileClient(fileName: string): DataLakeFileClient

Paraméterek

fileName

string

Válaszok

DataLakeFileClient

getProperties(FileSystemGetPropertiesOptions)

A megadott fájlrendszer összes felhasználó által definiált metaadatait és rendszertulajdonságait adja vissza.

FIGYELMEZTETÉS: A válaszban visszaadott metadata objektumnak kisbetűs kulcsai lesznek, még akkor is, ha eredetileg nagybetűket tartalmaztak. Ez eltér a DataLakeServiceClient metódusa által visszaadott metaadatkulcsoktól a beállítással, amely megőrzi az eredeti burkolatot.

Lásd: https://learn.microsoft.com/rest/api/storageservices/get-container-properties

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

Paraméterek

options
FileSystemGetPropertiesOptions

Optional. Beállítások a fájlrendszer tulajdonságainak lekérésekor.

Válaszok

Promise<FileSystemGetPropertiesResponse>

listDeletedPaths(ListDeletedPathsOptions)

Egy aszinkron iterátort ad vissza, amely felsorolja a megadott fájlrendszer összes elérési útját (könyvtárát és fájlját).

A .byPage() egy aszinkron iterátort ad vissza a lapok elérési útjainak listázásához.

Példa for await szintaxis használatára:

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élda a 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élda a 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élda jelölővel ellátott lapozásra:

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

Lásd: https://learn.microsoft.com/rest/api/storageservices/list-blobs

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

Paraméterek

options
ListDeletedPathsOptions

Optional. A törölt elérési utak felsorolásának beállításai.

Válaszok

PagedAsyncIterableIterator<DeletedPath, FileSystemListDeletedPathsResponse, PageSettings>

listPaths(ListPathsOptions)

Egy aszinkron iterátort ad vissza, amely felsorolja a megadott fájlrendszer összes elérési útját (könyvtárát és fájlját).

A .byPage() egy aszinkron iterátort ad vissza a lapok elérési útjainak listázásához.

Példa for await szintaxis használatára:

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élda a 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élda a 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élda jelölővel ellátott lapozásra:

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

Lásd: https://learn.microsoft.com/rest/api/storageservices/list-blobs

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

Paraméterek

options
ListPathsOptions

Optional. Lehetőségek az elérési utak listázásakor.

Válaszok

PagedAsyncIterableIterator<Path, FileSystemListPathsResponse, PageSettings>

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

Beállítja a megadott fájlrendszer engedélyeit. Az engedélyek azt jelzik, hogy a fájlrendszer címtárai vagy fájljai nyilvánosan elérhetők-e.

A fájlrendszer engedélyeinek beállításakor a rendszer lecseréli a meglévő engedélyeket. Ha nincs megadva hozzáférés vagy tárolóAcl, a rendszer eltávolítja a meglévő fájlrendszerbeli ACL-t.

Lásd: https://learn.microsoft.com/rest/api/storageservices/set-container-acl

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

Paraméterek

access
PublicAccessType

Optional. A fájlrendszer adataihoz való nyilvános hozzáférés szintje.

fileSystemAcl

SignedIdentifier<AccessPolicy>[]

Optional. Egyedi azonosítóval és a hozzáférési szabályzat részleteivel rendelkező elemek tömbje.

options
FileSystemSetAccessPolicyOptions

Optional. Beállítások a fájlrendszer hozzáférési szabályzatának beállításához.

Válaszok

Promise<FileSystemSetAccessPolicyResponse>

setMetadata(Metadata, FileSystemSetMetadataOptions)

Beállít egy vagy több felhasználó által definiált név-érték párot a megadott fájlrendszerhez.

Ha nincs megadva lehetőség, vagy nincs megadva metaadat a paraméterben, a rendszer eltávolítja a fájlrendszer metaadatait.

Lásd: https://learn.microsoft.com/rest/api/storageservices/set-container-metadata

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

Paraméterek

metadata
Metadata

Cserélje le a meglévő metaadatokat erre az értékre. Ha nincs megadva érték, a meglévő metaadatok el lesznek távolítva.

options
FileSystemSetMetadataOptions

Optional. Beállítások a fájlrendszer metaadatainak beállításához.

Válaszok

Promise<FileSystemSetMetadataResponse>

undeletePath(string, string, FileSystemUndeletePathOption)

Helyreállíthatóan törölt elérési utat állít vissza.

Lásd: https://learn.microsoft.com/rest/api/storageservices/undelete-blob

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

Paraméterek

deletedPath

string

Required. A törölt elérési út elérési útja.

deletionId

string

Required. A helyreállíthatóan törölt elérési úthoz társított törlési azonosító.

options
FileSystemUndeletePathOption

Válaszok

Promise<FileSystemUndeletePathResponse>