Bagikan melalui

DataLakeFileSystemClient class

Paket:
@azure/storage-file-datalake

DataLakeFileSystemClient mewakili URL ke sistem file Azure Storage yang memungkinkan Anda memanipulasi direktori dan filenya.

Memperluas

StorageClient

Konstruktor

DataLakeFileSystemClient(string, Pipeline)

Membuat instans DataLakeFileSystemClient dari url dan alur.
DataLakeFileSystemClient(string, StorageSharedKeyCredential | AnonymousCredential | TokenCredential, StoragePipelineOptions)

Membuat instans DataLakeFileSystemClient dari url dan kredensial.

Properti

name

Nama sistem file saat ini.

Properti yang Diwariskan

accountName
credential

Seperti AnonymousCredential, StorageSharedKeyCredential atau kredensial apa pun dari paket @azure/identity untuk mengautentikasi permintaan ke layanan. Anda juga dapat menyediakan objek yang mengimplementasikan antarmuka TokenCredential. Jika tidak ditentukan, AnonymousCredential digunakan.
url

Nilai string URL yang dikodekan.

Metode

create(FileSystemCreateOptions)

Membuat sistem file baru di bawah akun yang ditentukan. Jika sistem file dengan nama yang sama sudah ada, operasi gagal.

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

Membuat sistem file baru di bawah akun yang ditentukan. Jika sistem file dengan nama yang sama sudah ada, sistem tersebut tidak diubah.

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

Hapus sistem file saat ini.

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

Hapus sistem file saat ini jika ada.

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

Mengembalikan true jika sistem File yang diwakili oleh klien ini ada; false jika tidak.

CATATAN: gunakan fungsi ini dengan hati-hati karena sistem file yang ada mungkin dihapus oleh klien atau aplikasi lain. Sebaliknya sistem file baru dengan nama yang sama mungkin ditambahkan oleh klien atau aplikasi lain setelah fungsi ini selesai.
generateSasStringToSign(FileSystemGenerateSasUrlOptions)

Hanya tersedia untuk DataLakeFileSystemClient yang dibangun dengan kredensial kunci bersama.

Menghasilkan string untuk masuk ke URI Tanda Tangan Akses Bersama Layanan (SAS) berdasarkan properti klien dan parameter yang diteruskan. SAS ditandatangani oleh kredensial kunci bersama klien.

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

Hanya tersedia untuk DataLakeFileSystemClient yang dibangun dengan kredensial kunci bersama.

Menghasilkan URI Tanda Tangan Akses Bersama Layanan (SAS) berdasarkan properti klien dan parameter yang diteruskan. SAS ditandatangani oleh kredensial kunci bersama klien.

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

Menghasilkan string untuk masuk ke URI Tanda Tangan Akses Bersama Layanan (SAS) berdasarkan properti klien dan parameter yang diteruskan. SAS ditandatangani oleh kunci delegasi pengguna input.

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

Menghasilkan URI Tanda Tangan Akses Bersama Layanan (SAS) berdasarkan properti klien dan parameter yang diteruskan. SAS ditandatangani oleh kunci delegasi pengguna input.

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

Mendapatkan izin untuk sistem file yang ditentukan. Izin menunjukkan apakah data sistem file dapat diakses secara publik.

PERINGATAN: Tanggal JavaScript berpotensi kehilangan presisi saat mengurai string startsOn dan expiresOn. Misalnya, Tanggal baru("2018-12-31T03:44:23.8827891Z").toISOString() akan mendapatkan "2018-12-31T03:44:23.882Z".

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

Dapatkan DataLakeLeaseClient yang mengelola sewa pada sistem file.
getDirectoryClient(string)

Membuat objek DataLakeDirectoryClient di bawah sistem file saat ini.
getFileClient(string)

Membuat objek DataLakeFileClient di bawah sistem file saat ini.
getProperties(FileSystemGetPropertiesOptions)

Mengembalikan semua metadata dan properti sistem yang ditentukan pengguna untuk sistem file yang ditentukan.

PERINGATAN: Objek metadata yang dikembalikan dalam respons akan memiliki kuncinya dalam huruf kecil, bahkan jika awalnya berisi karakter huruf besar. Ini berbeda dari kunci metadata yang dikembalikan oleh metode listFileSystemsDataLakeServiceClient menggunakan opsi includeMetadata, yang akan mempertahankan casing aslinya.

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

Mengembalikan iterator yang dapat diulang asinkron untuk mencantumkan semua jalur (direktori dan file) di bawah sistem file yang ditentukan.

.byPage() mengembalikan iterator yang dapat diulang asinkron untuk mencantumkan jalur di halaman.

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

Contoh menggunakan 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());
}

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

Contoh menggunakan halaman dengan penanda:

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

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

Mengembalikan iterator yang dapat diulang asinkron untuk mencantumkan semua jalur (direktori dan file) di bawah sistem file yang ditentukan.

.byPage() mengembalikan iterator yang dapat diulang asinkron untuk mencantumkan jalur di halaman.

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

Contoh menggunakan 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());
}

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

Contoh menggunakan halaman dengan penanda:

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

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

Mengatur izin untuk sistem file yang ditentukan. Izin menunjukkan apakah direktori atau file dalam sistem file dapat diakses secara publik.

Ketika Anda mengatur izin untuk sistem file, izin yang ada akan diganti. Jika tidak ada akses atau containerAcl yang disediakan, ACL sistem file yang ada akan dihapus.

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

Mengatur satu atau beberapa pasangan nilai nama yang ditentukan pengguna untuk sistem file yang ditentukan.

Jika tidak ada opsi yang disediakan, atau tidak ada metadata yang ditentukan dalam parameter, metadata sistem file akan dihapus.

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

Memulihkan jalur yang dihapus sementara.

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

Detail Konstruktor

DataLakeFileSystemClient(string, Pipeline)

Membuat instans DataLakeFileSystemClient dari url dan alur.

new DataLakeFileSystemClient(url: string, pipeline: Pipeline)

Parameter

url

string

String Klien yang menunjuk ke sistem file data lake Azure Storage, seperti "https://myaccount.dfs.core.windows.net/filesystem". Anda dapat menambahkan SAS jika menggunakan AnonymousCredential, seperti "https://myaccount.dfs.core.windows.net/filesystem?sasString".

pipeline
Pipeline

Panggil newPipeline() untuk membuat alur default, atau sediakan alur yang disesuaikan.

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

Membuat instans DataLakeFileSystemClient dari url dan kredensial.

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

Parameter

url

string

String Klien yang menunjuk ke sistem file data lake Azure Storage, seperti "https://myaccount.dfs.core.windows.net/filesystem". Anda dapat menambahkan SAS jika menggunakan AnonymousCredential, seperti "https://myaccount.dfs.core.windows.net/filesystem?sasString".

credential

StorageSharedKeyCredential | AnonymousCredential | TokenCredential

Seperti AnonymousCredential, StorageSharedKeyCredential atau kredensial apa pun dari paket @azure/identity untuk mengautentikasi permintaan ke layanan. Anda juga dapat menyediakan objek yang mengimplementasikan antarmuka TokenCredential. Jika tidak ditentukan, AnonymousCredential digunakan.

options
StoragePipelineOptions

Optional. Opsi untuk mengonfigurasi alur HTTP.

Detail Properti

name

Nama sistem file saat ini.

string name

Nilai Properti

string

Detail Properti yang Diwariskan

accountName 

accountName: string

Nilai Properti

string

Diwarisi Dari StorageClient.accountName

credential

Seperti AnonymousCredential, StorageSharedKeyCredential atau kredensial apa pun dari paket @azure/identity untuk mengautentikasi permintaan ke layanan. Anda juga dapat menyediakan objek yang mengimplementasikan antarmuka TokenCredential. Jika tidak ditentukan, AnonymousCredential digunakan.

credential: StorageSharedKeyCredential | AnonymousCredential | TokenCredential

Nilai Properti

StorageSharedKeyCredential | AnonymousCredential | TokenCredential

Diwarisi Dari StorageClient.credential

url

Nilai string URL yang dikodekan.

url: string

Nilai Properti

string

Diwariskan Dari StorageClient.url

Detail Metode

create(FileSystemCreateOptions)

Membuat sistem file baru di bawah akun yang ditentukan. Jika sistem file dengan nama yang sama sudah ada, operasi gagal.

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

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

Parameter

options
FileSystemCreateOptions

Optional. Opsi saat membuat sistem file.

Mengembalikan

Promise<FileSystemCreateResponse>

createIfNotExists(FileSystemCreateOptions)

Membuat sistem file baru di bawah akun yang ditentukan. Jika sistem file dengan nama yang sama sudah ada, sistem tersebut tidak diubah.

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

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

Parameter

options
FileSystemCreateOptions

Mengembalikan

Promise<FileSystemCreateIfNotExistsResponse>

delete(FileSystemDeleteOptions)

Hapus sistem file saat ini.

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

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

Parameter

options
FileSystemDeleteOptions

Optional. Opsi saat menghapus sistem file.

Mengembalikan

Promise<FileSystemDeleteResponse>

deleteIfExists(FileSystemDeleteOptions)

Hapus sistem file saat ini jika ada.

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

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

Parameter

options
FileSystemDeleteOptions

Mengembalikan

Promise<FileSystemDeleteIfExistsResponse>

exists(FileSystemExistsOptions)

Mengembalikan true jika sistem File yang diwakili oleh klien ini ada; false jika tidak.

CATATAN: gunakan fungsi ini dengan hati-hati karena sistem file yang ada mungkin dihapus oleh klien atau aplikasi lain. Sebaliknya sistem file baru dengan nama yang sama mungkin ditambahkan oleh klien atau aplikasi lain setelah fungsi ini selesai.

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

Parameter

options
FileSystemExistsOptions

Mengembalikan

Promise<boolean>

generateSasStringToSign(FileSystemGenerateSasUrlOptions)

Hanya tersedia untuk DataLakeFileSystemClient yang dibangun dengan kredensial kunci bersama.

Menghasilkan string untuk masuk ke URI Tanda Tangan Akses Bersama Layanan (SAS) berdasarkan properti klien dan parameter yang diteruskan. SAS ditandatangani oleh kredensial kunci bersama klien.

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

function generateSasStringToSign(options: FileSystemGenerateSasUrlOptions): string

Parameter

options
FileSystemGenerateSasUrlOptions

Parameter opsional.

Mengembalikan

string

URI SAS yang terdiri dari URI ke sumber daya yang diwakili oleh klien ini, diikuti dengan token SAS yang dihasilkan.

generateSasUrl(FileSystemGenerateSasUrlOptions)

Hanya tersedia untuk DataLakeFileSystemClient yang dibangun dengan kredensial kunci bersama.

Menghasilkan URI Tanda Tangan Akses Bersama Layanan (SAS) berdasarkan properti klien dan parameter yang diteruskan. SAS ditandatangani oleh kredensial kunci bersama klien.

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

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

Parameter

options
FileSystemGenerateSasUrlOptions

Parameter opsional.

Mengembalikan

Promise<string>

URI SAS yang terdiri dari URI ke sumber daya yang diwakili oleh klien ini, diikuti dengan token SAS yang dihasilkan.

generateUserDelegationSasStringToSign(FileSystemGenerateSasUrlOptions, UserDelegationKey)

Menghasilkan string untuk masuk ke URI Tanda Tangan Akses Bersama Layanan (SAS) berdasarkan properti klien dan parameter yang diteruskan. SAS ditandatangani oleh kunci delegasi pengguna input.

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

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

Parameter

options
FileSystemGenerateSasUrlOptions

Parameter opsional.

userDelegationKey
UserDelegationKey

Mengembalikan nilai blobServiceClient.getUserDelegationKey()

Mengembalikan

string

URI SAS yang terdiri dari URI ke sumber daya yang diwakili oleh klien ini, diikuti dengan token SAS yang dihasilkan.

generateUserDelegationSasUrl(FileSystemGenerateSasUrlOptions, UserDelegationKey)

Menghasilkan URI Tanda Tangan Akses Bersama Layanan (SAS) berdasarkan properti klien dan parameter yang diteruskan. SAS ditandatangani oleh kunci delegasi pengguna input.

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

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

Parameter

options
FileSystemGenerateSasUrlOptions

Parameter opsional.

userDelegationKey
UserDelegationKey

Mengembalikan nilai blobServiceClient.getUserDelegationKey()

Mengembalikan

Promise<string>

URI SAS yang terdiri dari URI ke sumber daya yang diwakili oleh klien ini, diikuti dengan token SAS yang dihasilkan.

getAccessPolicy(FileSystemGetAccessPolicyOptions)

Mendapatkan izin untuk sistem file yang ditentukan. Izin menunjukkan apakah data sistem file dapat diakses secara publik.

PERINGATAN: Tanggal JavaScript berpotensi kehilangan presisi saat mengurai string startsOn dan expiresOn. Misalnya, Tanggal baru("2018-12-31T03:44:23.8827891Z").toISOString() akan mendapatkan "2018-12-31T03:44:23.882Z".

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

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

Parameter

options
FileSystemGetAccessPolicyOptions

Optional. Opsi saat mendapatkan kebijakan akses sistem file.

Mengembalikan

Promise<FileSystemGetAccessPolicyResponse>

getDataLakeLeaseClient(string)

Dapatkan DataLakeLeaseClient yang mengelola sewa pada sistem file.

function getDataLakeLeaseClient(proposeLeaseId?: string): DataLakeLeaseClient

Parameter

proposeLeaseId

string

Optional. Id sewa awal yang diusulkan.

Mengembalikan

DataLakeLeaseClient

getDirectoryClient(string)

Membuat objek DataLakeDirectoryClient di bawah sistem file saat ini.

function getDirectoryClient(directoryName: string): DataLakeDirectoryClient

Parameter

directoryName

string

Mengembalikan

DataLakeDirectoryClient

getFileClient(string)

Membuat objek DataLakeFileClient di bawah sistem file saat ini.

function getFileClient(fileName: string): DataLakeFileClient

Parameter

fileName

string

Mengembalikan

DataLakeFileClient

getProperties(FileSystemGetPropertiesOptions)

Mengembalikan semua metadata dan properti sistem yang ditentukan pengguna untuk sistem file yang ditentukan.

PERINGATAN: Objek metadata yang dikembalikan dalam respons akan memiliki kuncinya dalam huruf kecil, bahkan jika awalnya berisi karakter huruf besar. Ini berbeda dari kunci metadata yang dikembalikan oleh metode listFileSystemsDataLakeServiceClient menggunakan opsi includeMetadata, yang akan mempertahankan casing aslinya.

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

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

Parameter

options
FileSystemGetPropertiesOptions

Optional. Opsi saat mendapatkan properti sistem file.

Mengembalikan

Promise<FileSystemGetPropertiesResponse>

listDeletedPaths(ListDeletedPathsOptions)

Mengembalikan iterator yang dapat diulang asinkron untuk mencantumkan semua jalur (direktori dan file) di bawah sistem file yang ditentukan.

.byPage() mengembalikan iterator yang dapat diulang asinkron untuk mencantumkan jalur di halaman.

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

Contoh menggunakan 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());
}

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

Contoh menggunakan halaman dengan penanda:

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

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

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

Parameter

options
ListDeletedPathsOptions

Optional. Opsi saat mencantumkan jalur yang dihapus.

Mengembalikan

PagedAsyncIterableIterator<DeletedPath, FileSystemListDeletedPathsResponse, PageSettings>

listPaths(ListPathsOptions)

Mengembalikan iterator yang dapat diulang asinkron untuk mencantumkan semua jalur (direktori dan file) di bawah sistem file yang ditentukan.

.byPage() mengembalikan iterator yang dapat diulang asinkron untuk mencantumkan jalur di halaman.

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

Contoh menggunakan 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());
}

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

Contoh menggunakan halaman dengan penanda:

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

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

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

Parameter

options
ListPathsOptions

Optional. Opsi saat mencantumkan jalur.

Mengembalikan

PagedAsyncIterableIterator<Path, FileSystemListPathsResponse, PageSettings>

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

Mengatur izin untuk sistem file yang ditentukan. Izin menunjukkan apakah direktori atau file dalam sistem file dapat diakses secara publik.

Ketika Anda mengatur izin untuk sistem file, izin yang ada akan diganti. Jika tidak ada akses atau containerAcl yang disediakan, ACL sistem file yang ada akan dihapus.

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

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

Parameter

access
PublicAccessType

Optional. Tingkat akses publik ke data dalam sistem file.

fileSystemAcl

SignedIdentifier<AccessPolicy>[]

Optional. Array elemen masing-masing memiliki Id unik dan detail kebijakan akses.

options
FileSystemSetAccessPolicyOptions

Optional. Opsi saat mengatur kebijakan akses sistem file.

Mengembalikan

Promise<FileSystemSetAccessPolicyResponse>

setMetadata(Metadata, FileSystemSetMetadataOptions)

Mengatur satu atau beberapa pasangan nilai nama yang ditentukan pengguna untuk sistem file yang ditentukan.

Jika tidak ada opsi yang disediakan, atau tidak ada metadata yang ditentukan dalam parameter, metadata sistem file akan dihapus.

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

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

Parameter

metadata
Metadata

Ganti metadata yang ada dengan nilai ini. Jika tidak ada nilai yang disediakan, metadata yang ada akan dihapus.

options
FileSystemSetMetadataOptions

Optional. Opsi saat mengatur metadata sistem file.

Mengembalikan

Promise<FileSystemSetMetadataResponse>

undeletePath(string, string, FileSystemUndeletePathOption)

Memulihkan jalur yang dihapus sementara.

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

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

Parameter

deletedPath

string

Required. Jalur jalur yang dihapus.

deletionId

string

Required. ID penghapusan yang terkait dengan jalur yang dihapus sementara.

options
FileSystemUndeletePathOption

Mengembalikan

Promise<FileSystemUndeletePathResponse>