مشاركة عبر

DataLakeFileSystemClient class

الحزمة:
@azure/storage-file-datalake

يمثل DataLakeFileSystemClient عنوان URL لنظام ملفات Azure Storage مما يسمح لك بمعالجة الدلائل والملفات الخاصة به.

يمتد

StorageClient

المنشئون

DataLakeFileSystemClient(string, Pipeline)

إنشاء مثيل DataLakeFileSystemClient من عنوان url والمسار.
DataLakeFileSystemClient(string, StorageSharedKeyCredential | AnonymousCredential | TokenCredential, StoragePipelineOptions)

إنشاء مثيل DataLakeFileSystemClient من url وبيانات الاعتماد.

الخصائص

name

اسم نظام الملفات الحالي.

الخصائص الموروثة

accountName
credential

مثل AnonymousCredential أو StorageSharedKeyCredential أو أي بيانات اعتماد من حزمة @azure/identity لمصادقة الطلبات إلى الخدمة. يمكنك أيضا توفير كائن ينفذ واجهة TokenCredential. إذا لم يتم تحديده، يتم استخدام AnonymousCredential.
url

قيمة سلسلة URL المرمزة.

الأساليب

create(FileSystemCreateOptions)

إنشاء نظام ملفات جديد ضمن الحساب المحدد. إذا كان نظام الملفات بنفس الاسم موجودا بالفعل، تفشل العملية.

راجع https://learn.microsoft.com/rest/api/storageservices/create-container
createIfNotExists(FileSystemCreateOptions)

إنشاء نظام ملفات جديد ضمن الحساب المحدد. إذا كان نظام الملفات بنفس الاسم موجودا بالفعل، فلن يتم تغييره.

راجع https://learn.microsoft.com/rest/api/storageservices/create-container
delete(FileSystemDeleteOptions)

حذف نظام الملفات الحالي.

راجع https://learn.microsoft.com/rest/api/storageservices/delete-container
deleteIfExists(FileSystemDeleteOptions)

احذف نظام الملفات الحالي إذا كان موجودا.

راجع https://learn.microsoft.com/rest/api/storageservices/delete-container
exists(FileSystemExistsOptions)

إرجاع true إذا كان نظام الملفات الذي يمثله هذا العميل موجودا؛ خطأ خلاف ذلك.

ملاحظة: استخدم هذه الدالة بعناية حيث قد يتم حذف نظام ملفات موجود من قبل عملاء أو تطبيقات أخرى. قد تتم إضافة نظام الملفات الجديد بنفس الاسم بواسطة عملاء أو تطبيقات أخرى بعد اكتمال هذه الدالة.
generateSasStringToSign(FileSystemGenerateSasUrlOptions)

متوفر فقط ل DataLakeFileSystemClient الذي تم إنشاؤه باستخدام بيانات اعتماد مفتاح مشترك.

إنشاء سلسلة لتوقيع URI توقيع الوصول المشترك للخدمة (SAS) استنادا إلى خصائص العميل والمعلمات التي تم تمريرها. يتم توقيع SAS بواسطة بيانات اعتماد المفتاح المشترك للعميل.

راجع https://learn.microsoft.com/rest/api/storageservices/constructing-a-service-sas
generateSasUrl(FileSystemGenerateSasUrlOptions)

متوفر فقط ل DataLakeFileSystemClient الذي تم إنشاؤه باستخدام بيانات اعتماد مفتاح مشترك.

إنشاء عنوان URI لتوقيع الوصول المشترك للخدمة (SAS) استنادا إلى خصائص العميل والمعلمات التي تم تمريرها. يتم توقيع SAS بواسطة بيانات اعتماد المفتاح المشترك للعميل.

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

إنشاء سلسلة لتوقيع URI توقيع الوصول المشترك للخدمة (SAS) استنادا إلى خصائص العميل والمعلمات التي تم تمريرها. يتم توقيع SAS بواسطة مفتاح تفويض مستخدم الإدخال.

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

إنشاء عنوان URI لتوقيع الوصول المشترك للخدمة (SAS) استنادا إلى خصائص العميل والمعلمات التي تم تمريرها. يتم توقيع SAS بواسطة مفتاح تفويض مستخدم الإدخال.

راجع https://learn.microsoft.com/rest/api/storageservices/constructing-a-service-sas
getAccessPolicy(FileSystemGetAccessPolicyOptions)

الحصول على أذونات نظام الملفات المحدد. تشير الأذونات إلى ما إذا كان يمكن الوصول إلى بيانات نظام الملفات بشكل عام.

تحذير: من المحتمل أن يفقد تاريخ JavaScript الدقة عند تحليل startsOn وانتهاء صلاحية سلاسلOn. على سبيل المثال، التاريخ الجديد("2018-12-31T03:44:23.8827891Z").toISOString() سيحصل على "2018-12-31T03:44:23.882Z".

راجع https://learn.microsoft.com/rest/api/storageservices/get-container-acl
getDataLakeLeaseClient(string)

احصل على DataLakeLeaseClient الذي يدير عقود الإيجار على نظام الملفات.
getDirectoryClient(string)

إنشاء كائن DataLakeDirectoryClient ضمن نظام الملفات الحالي.
getFileClient(string)

إنشاء كائن DataLakeFileClient ضمن نظام الملفات الحالي.
getProperties(FileSystemGetPropertiesOptions)

إرجاع كافة بيانات التعريف المعرفة من قبل المستخدم وخصائص النظام لنظام الملفات المحدد.

تحذير: سيكون للكائن metadata الذي تم إرجاعه في الاستجابة مفاتيحه بأحرف صغيرة، حتى لو احتوت في الأصل على أحرف كبيرة. يختلف هذا عن مفاتيح بيانات التعريف التي تم إرجاعها بواسطة الأسلوب listFileSystemsDataLakeServiceClient باستخدام خيار includeMetadata، والذي سيحتفظ بأحرفها الأصلية.

راجع https://learn.microsoft.com/rest/api/storageservices/get-container-properties
listDeletedPaths(ListDeletedPathsOptions)

إرجاع مكرر غير متزامن قابل للتكدير لسرد كافة المسارات (الدلائل والملفات) ضمن نظام الملفات المحدد.

يقوم .byPage() بإرجاع مكرر غير متزامن قابل للتكريب لسرد المسارات في الصفحات.

مثال على استخدام بناء جملة for await:

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

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

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

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

مثال على استخدام iter.next():

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

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

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

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

مثال على استخدام byPage():

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

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

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

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

مثال على استخدام الترحيل مع علامة:

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

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

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

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

راجع https://learn.microsoft.com/rest/api/storageservices/list-blobs
listPaths(ListPathsOptions)

إرجاع مكرر غير متزامن قابل للتكدير لسرد كافة المسارات (الدلائل والملفات) ضمن نظام الملفات المحدد.

يقوم .byPage() بإرجاع مكرر غير متزامن قابل للتكريب لسرد المسارات في الصفحات.

مثال على استخدام بناء جملة for await:

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

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

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

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

مثال على استخدام iter.next():

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

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

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

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

مثال على استخدام byPage():

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

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

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

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

مثال على استخدام الترحيل مع علامة:

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

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

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

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

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

تعيين الأذونات لنظام الملفات المحدد. تشير الأذونات إلى ما إذا كان يمكن الوصول إلى الدلائل أو الملفات في نظام الملفات بشكل عام.

عند تعيين أذونات لنظام ملفات، يتم استبدال الأذونات الموجودة. إذا لم يتم توفير وصول أو containerAcl، فستتم إزالة ACL لنظام الملفات الموجود.

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

تعيين زوج واحد أو أكثر من أزواج قيمة الاسم المعرفة من قبل المستخدم لنظام الملفات المحدد.

إذا لم يتم توفير أي خيار، أو لم يتم تحديد بيانات تعريف في المعلمة، فستتم إزالة بيانات تعريف نظام الملفات.

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

استعادة مسار محذوف مبدئيا.

راجع https://learn.microsoft.com/rest/api/storageservices/undelete-blob

تفاصيل المنشئ

DataLakeFileSystemClient(string, Pipeline)

إنشاء مثيل DataLakeFileSystemClient من عنوان url والمسار.

new DataLakeFileSystemClient(url: string, pipeline: Pipeline)

المعلمات

url

string

سلسلة عميل تشير إلى نظام ملفات مستودع بيانات Azure Storage، مثل "https://myaccount.dfs.core.windows.net/filesystem". يمكنك إلحاق SAS إذا كنت تستخدم AnonymousCredential، مثل "https://myaccount.dfs.core.windows.net/filesystem?sasString".

pipeline
Pipeline

استدعاء newPipeline() لإنشاء مسار افتراضي، أو توفير مسار مخصص.

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

إنشاء مثيل DataLakeFileSystemClient من url وبيانات الاعتماد.

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

المعلمات

url

string

سلسلة عميل تشير إلى نظام ملفات مستودع بيانات Azure Storage، مثل "https://myaccount.dfs.core.windows.net/filesystem". يمكنك إلحاق SAS إذا كنت تستخدم AnonymousCredential، مثل "https://myaccount.dfs.core.windows.net/filesystem?sasString".

credential

StorageSharedKeyCredential | AnonymousCredential | TokenCredential

مثل AnonymousCredential أو StorageSharedKeyCredential أو أي بيانات اعتماد من حزمة @azure/identity لمصادقة الطلبات إلى الخدمة. يمكنك أيضا توفير كائن ينفذ واجهة TokenCredential. إذا لم يتم تحديده، يتم استخدام AnonymousCredential.

options
StoragePipelineOptions

Optional. خيارات لتكوين البنية الأساسية لبرنامج ربط العمليات التجارية HTTP.

تفاصيل الخاصية

name

اسم نظام الملفات الحالي.

string name

قيمة الخاصية

string

تفاصيل الخاصية الموروثة

accountName 

accountName: string

قيمة الخاصية

string

موروث من StorageClient.accountName

credential

مثل AnonymousCredential أو StorageSharedKeyCredential أو أي بيانات اعتماد من حزمة @azure/identity لمصادقة الطلبات إلى الخدمة. يمكنك أيضا توفير كائن ينفذ واجهة TokenCredential. إذا لم يتم تحديده، يتم استخدام AnonymousCredential.

credential: StorageSharedKeyCredential | AnonymousCredential | TokenCredential

قيمة الخاصية

StorageSharedKeyCredential | AnonymousCredential | TokenCredential

موروث من StorageClient.credential

url

قيمة سلسلة URL المرمزة.

url: string

قيمة الخاصية

string

موروث من StorageClient.url

تفاصيل الأسلوب

create(FileSystemCreateOptions)

إنشاء نظام ملفات جديد ضمن الحساب المحدد. إذا كان نظام الملفات بنفس الاسم موجودا بالفعل، تفشل العملية.

راجع https://learn.microsoft.com/rest/api/storageservices/create-container

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

المعلمات

options
FileSystemCreateOptions

Optional. الخيارات عند إنشاء نظام الملفات.

المرتجعات

Promise<FileSystemCreateResponse>

createIfNotExists(FileSystemCreateOptions)

إنشاء نظام ملفات جديد ضمن الحساب المحدد. إذا كان نظام الملفات بنفس الاسم موجودا بالفعل، فلن يتم تغييره.

راجع https://learn.microsoft.com/rest/api/storageservices/create-container

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

المعلمات

options
FileSystemCreateOptions

المرتجعات

Promise<FileSystemCreateIfNotExistsResponse>

delete(FileSystemDeleteOptions)

حذف نظام الملفات الحالي.

راجع https://learn.microsoft.com/rest/api/storageservices/delete-container

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

المعلمات

options
FileSystemDeleteOptions

Optional. خيارات عند حذف نظام الملفات.

المرتجعات

Promise<FileSystemDeleteResponse>

deleteIfExists(FileSystemDeleteOptions)

احذف نظام الملفات الحالي إذا كان موجودا.

راجع https://learn.microsoft.com/rest/api/storageservices/delete-container

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

المعلمات

options
FileSystemDeleteOptions

المرتجعات

Promise<FileSystemDeleteIfExistsResponse>

exists(FileSystemExistsOptions)

إرجاع true إذا كان نظام الملفات الذي يمثله هذا العميل موجودا؛ خطأ خلاف ذلك.

ملاحظة: استخدم هذه الدالة بعناية حيث قد يتم حذف نظام ملفات موجود من قبل عملاء أو تطبيقات أخرى. قد تتم إضافة نظام الملفات الجديد بنفس الاسم بواسطة عملاء أو تطبيقات أخرى بعد اكتمال هذه الدالة.

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

المعلمات

options
FileSystemExistsOptions

المرتجعات

Promise<boolean>

generateSasStringToSign(FileSystemGenerateSasUrlOptions)

متوفر فقط ل DataLakeFileSystemClient الذي تم إنشاؤه باستخدام بيانات اعتماد مفتاح مشترك.

إنشاء سلسلة لتوقيع URI توقيع الوصول المشترك للخدمة (SAS) استنادا إلى خصائص العميل والمعلمات التي تم تمريرها. يتم توقيع SAS بواسطة بيانات اعتماد المفتاح المشترك للعميل.

راجع https://learn.microsoft.com/rest/api/storageservices/constructing-a-service-sas

function generateSasStringToSign(options: FileSystemGenerateSasUrlOptions): string

المعلمات

options
FileSystemGenerateSasUrlOptions

المعلمات الاختيارية.

المرتجعات

string

SAS URI الذي يتكون من URI للمورد الذي يمثله هذا العميل، متبوعا بالرمز المميز SAS الذي تم إنشاؤه.

generateSasUrl(FileSystemGenerateSasUrlOptions)

متوفر فقط ل DataLakeFileSystemClient الذي تم إنشاؤه باستخدام بيانات اعتماد مفتاح مشترك.

إنشاء عنوان URI لتوقيع الوصول المشترك للخدمة (SAS) استنادا إلى خصائص العميل والمعلمات التي تم تمريرها. يتم توقيع SAS بواسطة بيانات اعتماد المفتاح المشترك للعميل.

راجع https://learn.microsoft.com/rest/api/storageservices/constructing-a-service-sas

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

المعلمات

options
FileSystemGenerateSasUrlOptions

المعلمات الاختيارية.

المرتجعات

Promise<string>

SAS URI الذي يتكون من URI للمورد الذي يمثله هذا العميل، متبوعا بالرمز المميز SAS الذي تم إنشاؤه.

generateUserDelegationSasStringToSign(FileSystemGenerateSasUrlOptions, UserDelegationKey)

إنشاء سلسلة لتوقيع URI توقيع الوصول المشترك للخدمة (SAS) استنادا إلى خصائص العميل والمعلمات التي تم تمريرها. يتم توقيع SAS بواسطة مفتاح تفويض مستخدم الإدخال.

راجع https://learn.microsoft.com/rest/api/storageservices/constructing-a-service-sas

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

المعلمات

options
FileSystemGenerateSasUrlOptions

المعلمات الاختيارية.

userDelegationKey
UserDelegationKey

القيمة المرجعة blobServiceClient.getUserDelegationKey()

المرتجعات

string

SAS URI الذي يتكون من URI للمورد الذي يمثله هذا العميل، متبوعا بالرمز المميز SAS الذي تم إنشاؤه.

generateUserDelegationSasUrl(FileSystemGenerateSasUrlOptions, UserDelegationKey)

إنشاء عنوان URI لتوقيع الوصول المشترك للخدمة (SAS) استنادا إلى خصائص العميل والمعلمات التي تم تمريرها. يتم توقيع SAS بواسطة مفتاح تفويض مستخدم الإدخال.

راجع https://learn.microsoft.com/rest/api/storageservices/constructing-a-service-sas

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

المعلمات

options
FileSystemGenerateSasUrlOptions

المعلمات الاختيارية.

userDelegationKey
UserDelegationKey

القيمة المرجعة blobServiceClient.getUserDelegationKey()

المرتجعات

Promise<string>

SAS URI الذي يتكون من URI للمورد الذي يمثله هذا العميل، متبوعا بالرمز المميز SAS الذي تم إنشاؤه.

getAccessPolicy(FileSystemGetAccessPolicyOptions)

الحصول على أذونات نظام الملفات المحدد. تشير الأذونات إلى ما إذا كان يمكن الوصول إلى بيانات نظام الملفات بشكل عام.

تحذير: من المحتمل أن يفقد تاريخ JavaScript الدقة عند تحليل startsOn وانتهاء صلاحية سلاسلOn. على سبيل المثال، التاريخ الجديد("2018-12-31T03:44:23.8827891Z").toISOString() سيحصل على "2018-12-31T03:44:23.882Z".

راجع https://learn.microsoft.com/rest/api/storageservices/get-container-acl

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

المعلمات

options
FileSystemGetAccessPolicyOptions

Optional. الخيارات عند الحصول على نهج الوصول إلى نظام الملفات.

المرتجعات

Promise<FileSystemGetAccessPolicyResponse>

getDataLakeLeaseClient(string)

احصل على DataLakeLeaseClient الذي يدير عقود الإيجار على نظام الملفات.

function getDataLakeLeaseClient(proposeLeaseId?: string): DataLakeLeaseClient

المعلمات

proposeLeaseId

string

Optional. معرف التأجير المقترح الأولي.

المرتجعات

DataLakeLeaseClient

getDirectoryClient(string)

إنشاء كائن DataLakeDirectoryClient ضمن نظام الملفات الحالي.

function getDirectoryClient(directoryName: string): DataLakeDirectoryClient

المعلمات

directoryName

string

المرتجعات

DataLakeDirectoryClient

getFileClient(string)

إنشاء كائن DataLakeFileClient ضمن نظام الملفات الحالي.

function getFileClient(fileName: string): DataLakeFileClient

المعلمات

fileName

string

المرتجعات

DataLakeFileClient

getProperties(FileSystemGetPropertiesOptions)

إرجاع كافة بيانات التعريف المعرفة من قبل المستخدم وخصائص النظام لنظام الملفات المحدد.

تحذير: سيكون للكائن metadata الذي تم إرجاعه في الاستجابة مفاتيحه بأحرف صغيرة، حتى لو احتوت في الأصل على أحرف كبيرة. يختلف هذا عن مفاتيح بيانات التعريف التي تم إرجاعها بواسطة الأسلوب listFileSystemsDataLakeServiceClient باستخدام خيار includeMetadata، والذي سيحتفظ بأحرفها الأصلية.

راجع https://learn.microsoft.com/rest/api/storageservices/get-container-properties

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

المعلمات

options
FileSystemGetPropertiesOptions

Optional. الخيارات عند الحصول على خصائص نظام الملفات.

المرتجعات

Promise<FileSystemGetPropertiesResponse>

listDeletedPaths(ListDeletedPathsOptions)

إرجاع مكرر غير متزامن قابل للتكدير لسرد كافة المسارات (الدلائل والملفات) ضمن نظام الملفات المحدد.

يقوم .byPage() بإرجاع مكرر غير متزامن قابل للتكريب لسرد المسارات في الصفحات.

مثال على استخدام بناء جملة for await:

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

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

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

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

مثال على استخدام iter.next():

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

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

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

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

مثال على استخدام byPage():

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

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

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

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

مثال على استخدام الترحيل مع علامة:

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

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

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

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

راجع https://learn.microsoft.com/rest/api/storageservices/list-blobs

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

المعلمات

options
ListDeletedPathsOptions

Optional. خيارات عند سرد المسارات المحذوفة.

المرتجعات

PagedAsyncIterableIterator<DeletedPath, FileSystemListDeletedPathsResponse, PageSettings>

listPaths(ListPathsOptions)

إرجاع مكرر غير متزامن قابل للتكدير لسرد كافة المسارات (الدلائل والملفات) ضمن نظام الملفات المحدد.

يقوم .byPage() بإرجاع مكرر غير متزامن قابل للتكريب لسرد المسارات في الصفحات.

مثال على استخدام بناء جملة for await:

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

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

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

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

مثال على استخدام iter.next():

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

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

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

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

مثال على استخدام byPage():

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

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

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

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

مثال على استخدام الترحيل مع علامة:

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

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

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

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

راجع https://learn.microsoft.com/rest/api/storageservices/list-blobs

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

المعلمات

options
ListPathsOptions

Optional. الخيارات عند سرد المسارات.

المرتجعات

PagedAsyncIterableIterator<Path, FileSystemListPathsResponse, PageSettings>

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

تعيين الأذونات لنظام الملفات المحدد. تشير الأذونات إلى ما إذا كان يمكن الوصول إلى الدلائل أو الملفات في نظام الملفات بشكل عام.

عند تعيين أذونات لنظام ملفات، يتم استبدال الأذونات الموجودة. إذا لم يتم توفير وصول أو containerAcl، فستتم إزالة ACL لنظام الملفات الموجود.

راجع https://learn.microsoft.com/rest/api/storageservices/set-container-acl

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

المعلمات

access
PublicAccessType

Optional. مستوى الوصول العام إلى البيانات في نظام الملفات.

fileSystemAcl

SignedIdentifier<AccessPolicy>[]

Optional. صفيف من العناصر التي تحتوي كل منها على معرف فريد وتفاصيل نهج الوصول.

options
FileSystemSetAccessPolicyOptions

Optional. الخيارات عند تعيين نهج الوصول إلى نظام الملفات.

المرتجعات

Promise<FileSystemSetAccessPolicyResponse>

setMetadata(Metadata, FileSystemSetMetadataOptions)

تعيين زوج واحد أو أكثر من أزواج قيمة الاسم المعرفة من قبل المستخدم لنظام الملفات المحدد.

إذا لم يتم توفير أي خيار، أو لم يتم تحديد بيانات تعريف في المعلمة، فستتم إزالة بيانات تعريف نظام الملفات.

راجع https://learn.microsoft.com/rest/api/storageservices/set-container-metadata

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

المعلمات

metadata
Metadata

استبدل بيانات التعريف الموجودة بهذه القيمة. إذا لم يتم توفير أي قيمة، فستتم إزالة بيانات التعريف الموجودة.

options
FileSystemSetMetadataOptions

Optional. خيارات عند تعيين بيانات تعريف نظام الملفات.

المرتجعات

Promise<FileSystemSetMetadataResponse>

undeletePath(string, string, FileSystemUndeletePathOption)

استعادة مسار محذوف مبدئيا.

راجع https://learn.microsoft.com/rest/api/storageservices/undelete-blob

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

المعلمات

deletedPath

string

Required. مسار المسار المحذوف.

deletionId

string

Required. معرف الحذف المقترن بالمسار المحذوف مبدئيا.

options
FileSystemUndeletePathOption

المرتجعات

Promise<FileSystemUndeletePathResponse>