@azure/storage-file-datalake package
الفصول
| AccountSASPermissions |
متوفر فقط في وقت تشغيل NODE.JS. هذه فئة مساعدة لإنشاء سلسلة تمثل الأذونات الممنوحة من قبل AccountSAS. يعني تعيين قيمة إلى true أن أي SAS يستخدم هذه الأذونات سيمنح أذونات لتلك العملية. بمجرد تعيين كافة القيم، يجب إجراء تسلسل مع toString وتعيينه ك حقل الأذونات على كائن <xref:AccountSASSignatureValues>. من الممكن إنشاء سلسلة الأذونات بدون هذه الفئة، ولكن ترتيب الأذونات خاص وتضمن هذه الفئة الصحة. |
| AccountSASResourceTypes |
متوفر فقط في وقت تشغيل NODE.JS. هذه فئة مساعدة لإنشاء سلسلة تمثل الموارد التي يمكن الوصول إليها بواسطة AccountSAS. يعني تعيين قيمة إلى true أن أي SAS يستخدم هذه الأذونات سيمنح حق الوصول إلى نوع المورد هذا. بمجرد تعيين كافة القيم، يجب إجراء تسلسل مع toString وتعيينه ك حقل الموارد على كائن <xref:AccountSASSignatureValues>. من الممكن إنشاء سلسلة الموارد دون هذه الفئة، ولكن ترتيب الموارد خاص وتضمن هذه الفئة الصحة. |
| AccountSASServices |
متوفر فقط في وقت تشغيل NODE.JS. هذه فئة مساعدة لإنشاء سلسلة تمثل الخدمات التي يمكن الوصول إليها بواسطة AccountSAS. يعني تعيين قيمة إلى true أن أي SAS يستخدم هذه الأذونات سيمنح حق الوصول إلى تلك الخدمة. بمجرد تعيين كافة القيم، يجب إجراء تسلسل مع toString وتعيينه ك حقل الخدمات على كائن <xref:AccountSASSignatureValues>. من الممكن إنشاء سلسلة الخدمات دون هذه الفئة، ولكن ترتيب الخدمات خاص وتضمن هذه الفئة الصحة. |
| AnonymousCredential |
يوفر AnonymousCredential عضو credentialPolicyCreator المستخدم لإنشاء كائنات AnonymousCredentialPolicy. يتم استخدام AnonymousCredentialPolicy مع طلبات HTTP (S) التي تقرأ الموارد العامة أو للاستخدام مع توقيعات الوصول المشترك (SAS). |
| AnonymousCredentialPolicy |
يتم استخدام AnonymousCredentialPolicy مع طلبات HTTP (S) التي تقرأ الموارد العامة أو للاستخدام مع توقيعات الوصول المشترك (SAS). |
| Credential |
بيانات الاعتماد هي فئة مجردة لتوقيع طلبات AZURE Storage HTTP. ستستضيف هذه الفئة مصنع credentialPolicyCreator الذي ينشئ CredentialPolicy. |
| CredentialPolicy |
نهج بيانات الاعتماد المستخدم لتوقيع طلبات HTTP(S) قبل الإرسال. هذه فئة مجردة. |
| DataLakeAclChangeFailedError |
حدث خطأ عند مقاطعة عملية ويمكن المتابعة لاحقا. |
| DataLakeDirectoryClient |
يمثل DataLakeDirectoryClient عنوان URL لدليل Azure Storage. |
| DataLakeFileClient |
يمثل DataLakeFileClient عنوان URL لملف Azure Storage. |
| DataLakeFileSystemClient |
يمثل DataLakeFileSystemClient عنوان URL لنظام ملفات Azure Storage مما يسمح لك بمعالجة الدلائل والملفات الخاصة به. |
| DataLakeLeaseClient | |
| DataLakePathClient |
يمثل DataLakePathClient عنوان URL لمسار Azure Storage (الدليل أو الملف). |
| DataLakeSASPermissions |
متوفر فقط في وقت تشغيل NODE.JS. هذه فئة مساعد لإنشاء سلسلة تمثل الأذونات الممنوحة من قبل ServiceSAS. يعني تعيين قيمة إلى true أن أي SAS يستخدم هذه الأذونات سيمنح أذونات لتلك العملية. بمجرد تعيين كافة القيم، يجب إجراء تسلسل مع toString وتعيينه كخانة أذونات على كائن <xref:DataLakeSASSignatureValues>. من الممكن إنشاء سلسلة الأذونات بدون هذه الفئة، ولكن ترتيب الأذونات خاص وتضمن هذه الفئة الصحة. |
| DataLakeServiceClient |
يسمح لك DataLakeServiceClient بمعالجة موارد خدمة Azure Data Lake وأنظمة الملفات. يوفر حساب التخزين مساحة الاسم ذات المستوى الأعلى لخدمة Data Lake. |
| DirectorySASPermissions |
هذه فئة مساعد لإنشاء سلسلة تمثل الأذونات الممنوحة من قبل ServiceSAS إلى دليل. يعني تعيين قيمة إلى true أن أي SAS يستخدم هذه الأذونات سيمنح أذونات لتلك العملية. بمجرد تعيين كافة القيم، يجب إجراء تسلسل مع toString وتعيينه كخانة أذونات على كائن <xref:DataLakeSASSignatureValues>. من الممكن إنشاء سلسلة الأذونات بدون هذه الفئة، ولكن ترتيب الأذونات خاص وتضمن هذه الفئة الصحة. |
| FileSystemSASPermissions |
هذه فئة مساعد لإنشاء سلسلة تمثل الأذونات الممنوحة من قبل ServiceSAS إلى حاوية. يعني تعيين قيمة إلى true أن أي SAS يستخدم هذه الأذونات سيمنح أذونات لتلك العملية. بمجرد تعيين كافة القيم، يجب إجراء تسلسل مع toString وتعيينه كخانة أذونات على كائن <xref:DataLakeSASSignatureValues>. من الممكن إنشاء سلسلة الأذونات بدون هذه الفئة، ولكن ترتيب الأذونات خاص وتضمن هذه الفئة الصحة. |
| Pipeline |
فئة البنية الأساسية لبرنامج ربط العمليات التجارية تحتوي على نهج طلب HTTP. يمكنك إنشاء مسار افتراضي عن طريق استدعاء <xref:newPipeline>. أو يمكنك إنشاء البنية الأساسية لبرنامج ربط العمليات التجارية مع النهج الخاصة بك بواسطة منشئ البنية الأساسية لبرنامج ربط العمليات التجارية. راجع <xref:newPipeline> والنهج المقدمة قبل تنفيذ البنية الأساسية لبرنامج ربط العمليات التجارية المخصصة. |
| SASQueryParameters |
يمثل المكونات التي تشكل معلمات استعلام AZURE Storage SAS. لا يتم إنشاء هذا النوع مباشرة من قبل المستخدم؛ يتم إنشاؤه فقط بواسطة أنواع <xref:AccountSASSignatureValues><xref:BlobSASSignatureValues>. بمجرد إنشائه، يمكن ترميزه في <xref:String> وإلحاقه بعنوان URL مباشرة (على الرغم من أنه يجب توخي الحذر هنا في حالة وجود معلمات استعلام، والتي قد تؤثر على الوسائل المناسبة لإلحاق معلمات الاستعلام هذه). ملاحظة: مثيلات هذه الفئة غير قابلة للتغيير. |
| StorageBrowserPolicy |
سيتعامل StorageBrowserPolicy مع الاختلافات بين Node.js ووقت تشغيل المستعرض، بما في ذلك:
|
| StorageBrowserPolicyFactory |
StorageBrowserPolicyFactory هي فئة مصنع تساعد في إنشاء كائنات StorageBrowserPolicy. |
| StorageClient |
يمثل StorageClient فئة URL تستند إلى <xref:BlobServiceClient><xref:ContainerClient> وما إلى ذلك. |
| StorageClientContext | |
| StorageRetryPolicy |
نهج إعادة المحاولة مع تنفيذ إعادة المحاولة الأسية وإعادة المحاولة الخطية. |
| StorageRetryPolicyFactory |
StorageRetryPolicyFactory هي فئة مصنع تساعد على إنشاء كائنات <xref:StorageRetryPolicy>. |
| StorageSharedKeyCredential |
متوفر فقط في وقت تشغيل NODE.JS. StorageSharedKeyCredential لتخويل مفتاح الحساب لخدمة Azure Storage. |
| StorageSharedKeyCredentialPolicy |
StorageSharedKeyCredentialPolicy هو نهج يستخدم لتوقيع طلب HTTP باستخدام مفتاح مشترك. |
الواجهات
| AccessControlChangeCounters |
يحتوي AccessControlChangeCounters على عدد العمليات التي تغير قوائم التحكم في الوصول بشكل متكرر. |
| AccessControlChangeError |
يمثل إدخالا فشل في تحديث قائمة التحكم بالوصول أثناء |
| AccessControlChanges |
يحتوي AccessControlChanges على عدد مجمع وتراكمي للعمليات التي تغير قوائم التحكم في الوصول بشكل متكرر. بالإضافة إلى ذلك فإنه يعرض إدخالات المسار التي فشلت في التحديث أثناء تقدم هذه العمليات. |
| AccessPolicy | |
| AccountSASSignatureValues |
متوفر فقط في وقت تشغيل NODE.JS. يتم استخدام AccountSASSignatureValues لإنشاء توقيع الوصول المشترك (SAS) لحساب Azure Storage. بمجرد تعيين جميع القيم هنا بشكل مناسب، قم باستدعاء <xref:generateAccountSASQueryParameters> للحصول على تمثيل SAS الذي يمكن تطبيقه فعليا على عناوين URL ل مستودع البيانات. ملاحظة: أن كلا من هذه الفئة <xref:SASQueryParameters> موجودة لأن الأول قابل للتغيير وتمثيل منطقي بينما الأخير غير قابل للتغيير ويستخدم لإنشاء طلبات REST الفعلية. |
| BlobHierarchyListSegment | |
| BlobItemModel |
كائن ثنائي كبير الحجم ل Azure Storage |
| BlobPrefix | |
| BlobPropertiesModel |
خصائص كائن ثنائي كبير الحجم |
| CommonGenerateSasUrlOptions |
الخيارات الشائعة <xref:FileSystemGenerateSasUrlOptions><xref:DirectoryGenerateSasUrlOptions><xref:FileGenerateSasUrlOptions>. |
| CommonOptions |
واجهة للخيارات الشائعة لكل عملية بعيدة. |
| DataLakeRequestConditions | |
| DataLakeSASSignatureValues |
متوفر فقط في وقت تشغيل NODE.JS. يتم استخدام DataLakeSASSignatureValues للمساعدة في إنشاء رموز SAS المميزة لخدمة Blob وDataLake للحاويات والكائنات الثنائية كبيرة الحجم ونظام الملفات والدلائل والملفات. |
| DeletedPath | |
| DeletedPathList | |
| DirectoryCreateIfNotExistsOptions | |
| DirectoryCreateIfNotExistsResponse | |
| DirectoryCreateOptions | |
| DirectoryCreateResponse | |
| DirectoryGenerateSasUrlOptions |
خيارات لتكوين عملية <xref:DataLakeDirectoryClient.generateSasUrl>. |
| FileAppendOptions | |
| FileCreateIfNotExistsOptions | |
| FileCreateIfNotExistsResponse | |
| FileCreateOptions | |
| FileCreateResponse | |
| FileFlushOptions | |
| FileGenerateSasUrlOptions |
خيارات لتكوين عملية <xref:DataLakeFileClient.generateSasUrl>. |
| FileParallelUploadOptions |
واجهة الخيار لملف Data Lake - عمليات التحميل راجع:
|
| FileQueryCsvTextConfiguration |
خيارات الاستعلام عن الملف بتنسيق CSV. |
| FileQueryError |
نوع خطأ استعلام الملف. |
| FileQueryJsonTextConfiguration |
خيارات الاستعلام عن الملف بتنسيق JSON. |
| FileQueryOptions |
واجهة الخيار لملف Data Lake - عمليات الاستعلام راجع:
|
| FileQueryParquetConfiguration |
خيارات الاستعلام عن الملف بتنسيق Parquet. |
| FileReadHeaders | |
| FileReadOptions | |
| FileReadToBufferOptions |
واجهة الخيار لملف Data Lake - عمليات readToBuffer راجع:
|
| FileSetExpiryHeaders |
تعريف الرؤوس لعملية Path_setExpiry. |
| FileSetExpiryOptions |
واجهة الخيار لعملية <xref:DataLakeFileClient.setExpiry>. |
| FileSystemCreateHeaders | |
| FileSystemCreateIfNotExistsResponse |
يحتوي على بيانات استجابة لعملية <xref:DataLakeFileSystemClient.createIfNotExists>. |
| FileSystemCreateOptions | |
| FileSystemDeleteHeaders | |
| FileSystemDeleteIfExistsResponse |
يحتوي على بيانات استجابة لعملية <xref:DataLakeFileSystemClient.deleteIfExists>. |
| FileSystemDeleteOptions | |
| FileSystemExistsOptions |
واجهة الخيار لنظام ملفات Data Lake موجودة عمليات راجع:
|
| FileSystemGenerateSasUrlOptions |
خيارات لتكوين عملية <xref:DataLakeFileSystemClient.generateSasUrl>. |
| FileSystemGetAccessPolicyHeaders | |
| FileSystemGetAccessPolicyOptions | |
| FileSystemGetPropertiesHeaders | |
| FileSystemGetPropertiesOptions | |
| FileSystemItem | |
| FileSystemListBlobHierarchySegmentHeaders |
تعريف الرؤوس لعملية FileSystem_listBlobHierarchySegment. |
| FileSystemListPathsHeaders |
تعريف الرؤوس لعملية FileSystem_listPaths. |
| FileSystemProperties | |
| FileSystemSetAccessPolicyHeaders | |
| FileSystemSetAccessPolicyOptions | |
| FileSystemSetMetadataHeaders | |
| FileSystemSetMetadataOptions | |
| FileSystemUndeletePathOption | |
| ListBlobsHierarchySegmentResponse |
تعداد الكائنات الثنائية كبيرة الحجم |
| ListDeletedPathsOptions | |
| ListDeletedPathsSegmentOptions | |
| ListFileSystemsSegmentResponse | |
| ListPathsOptions | |
| ListPathsSegmentOptions | |
| Metadata | |
| Path | |
| PathAccessControl | |
| PathAccessControlItem | |
| PathAppendDataHeaders |
تعريف الرؤوس لعملية Path_appendData. |
| PathChangeAccessControlRecursiveOptions |
نوع الخيارات |
| PathChangeAccessControlRecursiveResponse |
نوع الاستجابة |
| PathCreateHeaders |
تعريف الرؤوس لعملية Path_create. |
| PathCreateHttpHeaders | |
| PathCreateIfNotExistsOptions | |
| PathCreateIfNotExistsResponse |
يحتوي على بيانات استجابة لعملية <xref:DataLakePathClient.createIfNotExists>. |
| PathCreateOptions | |
| PathDeleteHeaders |
تعريف الرؤوس لعملية Path_delete. |
| PathDeleteIfExistsResponse |
يحتوي على بيانات استجابة لعملية <xref:DataLakePathClient.deleteIfExists>. |
| PathDeleteOptions | |
| PathExistsOptions |
واجهة الخيار لدليل/ملف Data Lake موجود العمليات راجع:
|
| PathFlushDataHeaders |
تعريف الرؤوس لعملية Path_flushData. |
| PathGetAccessControlHeaders | |
| PathGetAccessControlOptions | |
| PathGetPropertiesHeaders | |
| PathGetPropertiesHeadersModel |
تعريف الرؤوس لعملية Path_getProperties. |
| PathGetPropertiesOptions | |
| PathHttpHeaders | |
| PathList | |
| PathListModel | |
| PathModel | |
| PathMoveOptions | |
| PathPermissions | |
| PathRemoveHeaders | |
| PathSetAccessControlHeaders |
تعريف رؤوس عملية Path_setAccessControl. |
| PathSetAccessControlOptions | |
| PathSetHttpHeadersHeaders | |
| PathSetHttpHeadersOptions | |
| PathSetMetadataHeaders | |
| PathSetMetadataOptions | |
| PathSetPermissionsOptions | |
| PathUndeleteHeaders |
تعريف الرؤوس لعملية Path_undelete. |
| PathUpdateHeaders |
تعريف الرؤوس لعملية Path_update. |
| PipelineOptions |
واجهة الخيار لمنشئ البنية الأساسية لبرنامج ربط العمليات التجارية. |
| RawAccessPolicy | |
| RemovePathAccessControlItem | |
| RolePermissions | |
| SASQueryParametersOptions |
خيارات لإنشاء <xref:SASQueryParameters>. |
| SasIPRange |
نطاق IP المسموح به ل SAS. |
| ServiceGenerateAccountSasUrlOptions |
خيارات لتكوين عملية <xref:DataLakeServiceClient.generateAccountSasUrl>. |
| ServiceGetUserDelegationKeyHeaders | |
| ServiceGetUserDelegationKeyOptions | |
| ServiceListFileSystemsOptions | |
| ServiceListFileSystemsSegmentHeaders | |
| ServiceUndeleteFileSystemOptions |
خيارات لتكوين <xref:DataLakeServiceClient.undeleteFileSystem>. |
| SignedIdentifier | |
| StorageClientOptionalParams |
المعلمات الاختيارية. |
| StoragePipelineOptions |
واجهة الخيارات للدالة <xref:newPipeline>. |
| StorageRetryOptions |
واجهة خيارات إعادة محاولة Storage Blob. |
| UserDelegationKey | |
النوع أسماء مستعارة
التعدادات
| PathGetPropertiesAction |
تعريف قيم PathGetPropertiesAction. تتضمن القيم المحتملة: "getAccessControl" و"getStatus" |
| PathRenameMode |
تعريف قيم PathRenameMode. تتضمن القيم المحتملة: "legacy"، و"posix" |
| PathResourceType |
تعريف قيم PathResourceType. تتضمن القيم المحتملة: "الدليل"، و"الملف" |
| SASProtocol |
بروتوكولات SAS التي تم إنشاؤها. |
| StorageRetryPolicyType |
أنواع نهج إعادة المحاولة. |
الوظائف
| generate |
متوفر فقط في وقت تشغيل NODE.JS. ينشئ كائن <xref:SASQueryParameters> يحتوي على جميع معلمات استعلام SAS اللازمة لتقديم طلب REST فعلي. |
| generate |
متوفر فقط في وقت تشغيل NODE.JS. إنشاء مثيل SASQueryParameters. يقبل فقط الإعدادات المطلوبة اللازمة لإنشاء SAS. بالنسبة للإعدادات الاختيارية، يرجى تعيين الخصائص المقابلة مباشرة، مثل الأذونات و startsOn والمعرف. تحذير: عند عدم توفير المعرف، تكون الأذونات وانتهاء الصلاحية مطلوبة. يجب تعيين قيمة للمعرف أو انتهاء الصلاحيةعلى أذونات & يدويا إذا قمت بالأحرف الأولى باستخدام الدالة الإنشائية هذه. املأ التفاصيل المطلوبة قبل تشغيل القصاصات البرمجية التالية. |
| generate |
متوفر فقط في وقت تشغيل NODE.JS. إنشاء مثيل SASQueryParameters. تحذير: سيتم تجاهل المعرف عند إنشاء توقيعات الوصول المشترك لتفويض المستخدم، والأذونات وانتهاء الصلاحية مطلوبة. |
| new |
إنشاء كائن مسار جديد مع توفير بيانات الاعتماد. |
تفاصيل الوظيفة
generateAccountSASQueryParameters(AccountSASSignatureValues, StorageSharedKeyCredential)
متوفر فقط في وقت تشغيل NODE.JS. ينشئ كائن <xref:SASQueryParameters> يحتوي على جميع معلمات استعلام SAS اللازمة لتقديم طلب REST فعلي.
function generateAccountSASQueryParameters(accountSASSignatureValues: AccountSASSignatureValues, sharedKeyCredential: StorageSharedKeyCredential)
المعلمات
- accountSASSignatureValues
- AccountSASSignatureValues
- sharedKeyCredential
- StorageSharedKeyCredential
المرتجعات
generateDataLakeSASQueryParameters(DataLakeSASSignatureValues, StorageSharedKeyCredential)
متوفر فقط في وقت تشغيل NODE.JS. إنشاء مثيل SASQueryParameters.
يقبل فقط الإعدادات المطلوبة اللازمة لإنشاء SAS. بالنسبة للإعدادات الاختيارية، يرجى تعيين الخصائص المقابلة مباشرة، مثل الأذونات و startsOn والمعرف.
تحذير: عند عدم توفير المعرف، تكون الأذونات وانتهاء الصلاحية مطلوبة. يجب تعيين قيمة للمعرف أو انتهاء الصلاحيةعلى أذونات & يدويا إذا قمت بالأحرف الأولى باستخدام الدالة الإنشائية هذه.
املأ التفاصيل المطلوبة قبل تشغيل القصاصات البرمجية التالية.
function generateDataLakeSASQueryParameters(dataLakeSASSignatureValues: DataLakeSASSignatureValues, sharedKeyCredential: StorageSharedKeyCredential)
المعلمات
- dataLakeSASSignatureValues
- DataLakeSASSignatureValues
- sharedKeyCredential
- StorageSharedKeyCredential
المرتجعات
generateDataLakeSASQueryParameters(DataLakeSASSignatureValues, UserDelegationKey, string)
متوفر فقط في وقت تشغيل NODE.JS. إنشاء مثيل SASQueryParameters. تحذير: سيتم تجاهل المعرف عند إنشاء توقيعات الوصول المشترك لتفويض المستخدم، والأذونات وانتهاء الصلاحية مطلوبة.
function generateDataLakeSASQueryParameters(dataLakeSASSignatureValues: DataLakeSASSignatureValues, userDelegationKey: UserDelegationKey, accountName: string)
المعلمات
- dataLakeSASSignatureValues
- DataLakeSASSignatureValues
- userDelegationKey
- UserDelegationKey
القيمة المرجعة blobServiceClient.getUserDelegationKey()
- accountName
-
string
المرتجعات
newPipeline(StorageSharedKeyCredential | AnonymousCredential | TokenCredential, StoragePipelineOptions)
إنشاء كائن مسار جديد مع توفير بيانات الاعتماد.
function newPipeline(credential?: StorageSharedKeyCredential | AnonymousCredential | TokenCredential, pipelineOptions?: StoragePipelineOptions)
المعلمات
- credential
-
StorageSharedKeyCredential | AnonymousCredential | TokenCredential
مثل AnonymousCredential أو StorageSharedKeyCredential أو أي بيانات اعتماد من حزمة @azure/identity لمصادقة الطلبات إلى الخدمة. يمكنك أيضا توفير كائن ينفذ واجهة TokenCredential. إذا لم يتم تحديده، يتم استخدام AnonymousCredential.
- pipelineOptions
- StoragePipelineOptions
اختياري. خيارات.
المرتجعات
كائن مسار جديد.