مشاركة عبر


@azure/storage-file-datalake package

الفصول

AccountSASPermissions

متوفر فقط في وقت تشغيل NODE.JS.

هذه فئة مساعدة لإنشاء سلسلة تمثل الأذونات الممنوحة من قبل AccountSAS. يعني تعيين قيمة إلى true أن أي SAS يستخدم هذه الأذونات سيمنح أذونات لتلك العملية. بمجرد تعيين كافة القيم، يجب إجراء تسلسل مع toString وتعيينه كحقل الأذونات على كائن AccountSASSignatureValues. من الممكن إنشاء سلسلة الأذونات بدون هذه الفئة، ولكن ترتيب الأذونات خاص وتضمن هذه الفئة الصحة.

AccountSASResourceTypes

متوفر فقط في وقت تشغيل NODE.JS.

هذه فئة مساعدة لإنشاء سلسلة تمثل الموارد التي يمكن الوصول إليها بواسطة AccountSAS. يعني تعيين قيمة إلى true أن أي SAS يستخدم هذه الأذونات سيمنح حق الوصول إلى نوع المورد هذا. بمجرد تعيين كافة القيم، يجب تسلسل هذا مع toString وتعيينه كحقل الموارد على كائن AccountSASSignatureValues. من الممكن إنشاء سلسلة الموارد دون هذه الفئة، ولكن ترتيب الموارد خاص وتضمن هذه الفئة الصحة.

AccountSASServices

متوفر فقط في وقت تشغيل NODE.JS.

هذه فئة مساعدة لإنشاء سلسلة تمثل الخدمات التي يمكن الوصول إليها بواسطة AccountSAS. يعني تعيين قيمة إلى true أن أي SAS يستخدم هذه الأذونات سيمنح حق الوصول إلى تلك الخدمة. بمجرد تعيين كافة القيم، يجب تسلسل هذا مع toString وتعيينه كحقل الخدمات على كائن AccountSASSignatureValues. من الممكن إنشاء سلسلة الخدمات دون هذه الفئة، ولكن ترتيب الخدمات خاص وتضمن هذه الفئة الصحة.

AnonymousCredential

يوفر AnonymousCredential عضو credentialPolicyCreator المستخدم لإنشاء كائنات AnonymousCredentialPolicy. يتم استخدام AnonymousCredentialPolicy مع طلبات HTTP (S) التي تقرأ الموارد العامة أو للاستخدام مع توقيعات الوصول المشترك (SAS).

AnonymousCredentialPolicy

يتم استخدام AnonymousCredentialPolicy مع طلبات HTTP (S) التي تقرأ الموارد العامة أو للاستخدام مع توقيعات الوصول المشترك (SAS).

BaseRequestPolicy

الفئة الأساسية التي تستمد منها كافة نهج الطلب.

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 وتعيينه كحقل أذونات على كائن DataLakeSASSignatureValues. من الممكن إنشاء سلسلة الأذونات بدون هذه الفئة، ولكن ترتيب الأذونات خاص وتضمن هذه الفئة الصحة.

DataLakeServiceClient

يسمح لك DataLakeServiceClient بمعالجة موارد خدمة Azure Data Lake وأنظمة الملفات. يوفر حساب التخزين مساحة الاسم ذات المستوى الأعلى لخدمة Data Lake.

DirectorySASPermissions

هذه فئة مساعد لإنشاء سلسلة تمثل الأذونات الممنوحة من قبل ServiceSAS إلى دليل. يعني تعيين قيمة إلى true أن أي SAS يستخدم هذه الأذونات سيمنح أذونات لتلك العملية. بمجرد تعيين كافة القيم، يجب إجراء تسلسل مع toString وتعيينه كحقل أذونات على كائن DataLakeSASSignatureValues. من الممكن إنشاء سلسلة الأذونات بدون هذه الفئة، ولكن ترتيب الأذونات خاص وتضمن هذه الفئة الصحة.

FileSystemSASPermissions

هذه فئة مساعد لإنشاء سلسلة تمثل الأذونات الممنوحة من قبل ServiceSAS إلى حاوية. يعني تعيين قيمة إلى true أن أي SAS يستخدم هذه الأذونات سيمنح أذونات لتلك العملية. بمجرد تعيين كافة القيم، يجب إجراء تسلسل مع toString وتعيينه كحقل أذونات على كائن DataLakeSASSignatureValues. من الممكن إنشاء سلسلة الأذونات بدون هذه الفئة، ولكن ترتيب الأذونات خاص وتضمن هذه الفئة الصحة.

Pipeline

فئة البنية الأساسية لبرنامج ربط العمليات التجارية تحتوي على نهج طلب HTTP. يمكنك إنشاء مسار افتراضي عن طريق استدعاء newPipeline. أو يمكنك إنشاء البنية الأساسية لبرنامج ربط العمليات التجارية مع النهج الخاصة بك بواسطة منشئ البنية الأساسية لبرنامج ربط العمليات التجارية.

راجع newPipeline والنهج المقدمة قبل تنفيذ البنية الأساسية لبرنامج ربط العمليات التجارية المخصصة.

SASQueryParameters

يمثل المكونات التي تشكل معلمات استعلام AZURE Storage SAS. لا يتم إنشاء هذا النوع مباشرة من قبل المستخدم؛ يتم إنشاؤه فقط بواسطة AccountSASSignatureValues وأنواع <xref:BlobSASSignatureValues>. بمجرد إنشائه، يمكن ترميزه في toString() وإلحاقه بعنوان URL مباشرة (على الرغم من أنه يجب توخي الحذر هنا في حالة وجود معلمات استعلام، والتي قد تؤثر على الوسائل المناسبة لإلحاق معلمات الاستعلام هذه).

ملاحظة: مثيلات هذه الفئة غير قابلة للتغيير.

StorageBrowserPolicy

سيتعامل StorageBrowserPolicy مع الاختلافات بين Node.js ووقت تشغيل المستعرض، بما في ذلك:

  1. تقوم المستعرضات بتخزين طلبات GET/HEAD مؤقتا عن طريق إضافة عناوين شرطية مثل "IF_MODIFIED_SINCE". StorageBrowserPolicy هو نهج يستخدم لإضافة استعلام طابع زمني إلى عنوان URL لطلب GET/HEAD وبالتالي تجنب ذاكرة التخزين المؤقت للمستعرض.

  2. إزالة رأس ملف تعريف الارتباط للأمان

  3. إزالة رأس طول المحتوى لتجنب تحذير المستعرضات

StorageBrowserPolicyFactory

StorageBrowserPolicyFactory هي فئة مصنع تساعد في إنشاء كائنات StorageBrowserPolicy.

StorageRetryPolicy

نهج إعادة المحاولة مع تنفيذ إعادة المحاولة الأسية وإعادة المحاولة الخطية.

StorageRetryPolicyFactory

StorageRetryPolicyFactory هي فئة مصنع تساعد على إنشاء كائنات StorageRetryPolicy.

StorageSharedKeyCredential

متوفر فقط في وقت تشغيل NODE.JS.

StorageSharedKeyCredential لتخويل مفتاح الحساب لخدمة Azure Storage.

StorageSharedKeyCredentialPolicy

StorageSharedKeyCredentialPolicy هو نهج يستخدم لتوقيع طلب HTTP باستخدام مفتاح مشترك.

الواجهات

AccessControlChangeCounters

يحتوي AccessControlChangeCounters على عدد العمليات التي تغير قوائم التحكم في الوصول بشكل متكرر.

AccessControlChangeError

يمثل إدخالا فشل في تحديث قائمة التحكم بالوصول أثناء setAccessControlRecursiveupdateAccessControlRecursiveremoveAccessControlRecursive.

AccessControlChanges

يحتوي AccessControlChanges على عدد مجمع وتراكمي للعمليات التي تغير قوائم التحكم في الوصول بشكل متكرر. بالإضافة إلى ذلك فإنه يعرض إدخالات المسار التي فشلت في التحديث أثناء تقدم هذه العمليات.

AccessPolicy
AccountSASSignatureValues

متوفر فقط في وقت تشغيل NODE.JS.

يتم استخدام AccountSASSignatureValues لإنشاء توقيع الوصول المشترك (SAS) لحساب Azure Storage. بمجرد تعيين جميع القيم هنا بشكل مناسب، قم باستدعاء generateAccountSASQueryParameters للحصول على تمثيل SAS الذي يمكن تطبيقه فعليا على عناوين URL لبحيرة البيانات. ملاحظة: وجود كل من هذه الفئة SASQueryParameters لأن الأول قابل للتغيير وتمثيل منطقي بينما يكون الأخير غير قابل للتغيير ويستخدم لإنشاء طلبات REST الفعلية.

راجع https://learn.microsoft.com/azure/storage/common/storage-dotnet-shared-access-signature-part-1 لمزيد من المعلومات المفاهيمية حول SAS راجع https://learn.microsoft.com/rest/api/storageservices/constructing-an-account-sas لأوصاف المعلمات، بما في ذلك المطلوبة

BlobHierarchyListSegment
BlobItemModel

كائن ثنائي كبير الحجم ل Azure Storage

BlobPrefix
BlobPropertiesModel

خصائص كائن ثنائي كبير الحجم

CommonGenerateSasUrlOptions

الخيارات الشائعة FileSystemGenerateSasUrlOptionsDirectoryGenerateSasUrlOptions وFilyGenerateSasUrlOptions .

CommonOptions

واجهة للخيارات الشائعة لكل عملية بعيدة.

CpkInfo

مجموعة المعلمات

DataLakeRequestConditions

مجموعة المعلمات

DataLakeSASSignatureValues

متوفر فقط في وقت تشغيل NODE.JS.

يتم استخدام DataLakeSASSignatureValues للمساعدة في إنشاء رموز SAS المميزة لخدمة Blob وDataLake للحاويات والكائنات الثنائية كبيرة الحجم ونظام الملفات والدلائل والملفات.

DataLakeServiceProperties

خصائص خدمة التخزين.

DeletedPath
DeletedPathList
DirectoryCreateIfNotExistsOptions

واجهة للخيارات الشائعة لكل عملية بعيدة.

DirectoryCreateIfNotExistsResponse

يحتوي على بيانات استجابة لعملية createIfNotExists.

DirectoryCreateOptions
DirectoryCreateResponse
DirectoryGenerateSasUrlOptions

خيارات لتكوين إنشاء عملية SasUrl.

FileAppendOptions

واجهة للخيارات الشائعة لكل عملية بعيدة.

FileCreateIfNotExistsOptions

واجهة للخيارات الشائعة لكل عملية بعيدة.

FileCreateIfNotExistsResponse

يحتوي على بيانات استجابة لعملية createIfNotExists.

FileCreateOptions

واجهة للخيارات الشائعة لكل عملية بعيدة.

FileCreateResponse
FileFlushOptions

واجهة للخيارات الشائعة لكل عملية بعيدة.

FileGenerateSasUrlOptions

خيارات لتكوين إنشاء عملية SasUrl.

FileParallelUploadOptions

واجهة الخيار لملف Data Lake - عمليات التحميل

See:

FileQueryCsvTextConfiguration

خيارات الاستعلام عن الملف بتنسيق CSV.

FileQueryError

نوع خطأ استعلام الملف.

FileQueryJsonTextConfiguration

خيارات الاستعلام عن الملف بتنسيق JSON.

FileQueryOptions

واجهة الخيار لملف Data Lake - عمليات الاستعلام

See:

FileQueryParquetConfiguration

خيارات الاستعلام عن الملف بتنسيق Parquet.

FileReadHeaders
FileReadOptions
FileReadToBufferOptions

واجهة الخيار لملف Data Lake - عمليات readToBuffer

See:

FileSetExpiryHeaders

تعريف الرؤوس لعملية Path_setExpiry.

FileSetExpiryOptions

واجهة الخيار لعملية setExpiry.

FileSystemCreateHeaders
FileSystemCreateIfNotExistsResponse

يحتوي على بيانات استجابة لعملية createIfNotExists.

FileSystemCreateOptions
FileSystemDeleteHeaders
FileSystemDeleteIfExistsResponse

يحتوي على بيانات استجابة لعملية deleteIfExists.

FileSystemDeleteOptions

واجهة للخيارات الشائعة لكل عملية بعيدة.

FileSystemEncryptionScope

خيارات لتحديد نطاق التشفير على نظام الملفات.

FileSystemExistsOptions

واجهة الخيار لعمليات نظام ملفات Data Lake موجودة

See:

FileSystemGenerateSasUrlOptions

خيارات لتكوين إنشاء عملية SasUrl.

FileSystemGetAccessPolicyHeaders
FileSystemGetAccessPolicyOptions

واجهة للخيارات الشائعة لكل عملية بعيدة.

FileSystemGetPropertiesHeaders
FileSystemGetPropertiesOptions

واجهة للخيارات الشائعة لكل عملية بعيدة.

FileSystemItem
FileSystemListBlobHierarchySegmentHeaders

تعريف الرؤوس لعملية FileSystem_listBlobHierarchySegment.

FileSystemListPathsHeaders

تعريف الرؤوس لعملية FileSystem_listPaths.

FileSystemProperties
FileSystemSetAccessPolicyHeaders
FileSystemSetAccessPolicyOptions

واجهة للخيارات الشائعة لكل عملية بعيدة.

FileSystemSetMetadataHeaders
FileSystemSetMetadataOptions

واجهة للخيارات الشائعة لكل عملية بعيدة.

FileSystemUndeletePathOption

واجهة للخيارات الشائعة لكل عملية بعيدة.

HttpHeaders

مجموعة من أزواج مفتاح/قيمة عنوان HTTP.

HttpOperationResponse

استجابة Http المتوافقة مع core-v1(core-http).

Lease

تفاصيل عقد إيجار محدد.

LeaseAccessConditions

مجموعة المعلمات

LeaseOperationOptions

تكوين عمليات التأجير.

ListBlobsHierarchySegmentResponse

تعداد الكائنات الثنائية كبيرة الحجم

ListDeletedPathsOptions

واجهة للخيارات الشائعة لكل عملية بعيدة.

ListDeletedPathsSegmentOptions

واجهة للخيارات الشائعة لكل عملية بعيدة.

ListFileSystemsSegmentResponse
ListPathsOptions

واجهة للخيارات الشائعة لكل عملية بعيدة.

ListPathsSegmentOptions

واجهة للخيارات الشائعة لكل عملية بعيدة.

Metadata
Path
PathAccessControl
PathAccessControlItem
PathAppendDataHeaders

تعريف الرؤوس لعملية Path_appendData.

PathChangeAccessControlRecursiveOptions

نوع الخيارات setAccessControlRecursiveupdateAccessControlRecursiveremoveAccessControlRecursive.

PathChangeAccessControlRecursiveResponse

نوع الاستجابة setAccessControlRecursiveupdateAccessControlRecursiveremoveAccessControlRecursive.

PathCreateHeaders

تعريف الرؤوس لعملية Path_create.

PathCreateHttpHeaders
PathCreateIfNotExistsOptions

واجهة للخيارات الشائعة لكل عملية بعيدة.

PathCreateIfNotExistsResponse

يحتوي على بيانات استجابة لعملية createIfNotExists.

PathCreateOptions

واجهة للخيارات الشائعة لكل عملية بعيدة.

PathDeleteHeaders

تعريف الرؤوس لعملية Path_delete.

PathDeleteIfExistsResponse

يحتوي على بيانات استجابة لعملية deleteIfExists.

PathDeleteOptions

واجهة للخيارات الشائعة لكل عملية بعيدة.

PathExistsOptions

واجهة الخيار لعمليات الدليل/الملف في Data Lake

See:

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.

PipelineLike

واجهة لفئة Pipeline تحتوي على نهج طلب HTTP. يمكنك إنشاء مسار افتراضي عن طريق استدعاء newPipeline. أو يمكنك إنشاء البنية الأساسية لبرنامج ربط العمليات التجارية مع النهج الخاصة بك بواسطة منشئ البنية الأساسية لبرنامج ربط العمليات التجارية.

راجع newPipeline والنهج المقدمة قبل تنفيذ البنية الأساسية لبرنامج ربط العمليات التجارية المخصصة.

PipelineOptions

واجهة الخيار لمنشئ البنية الأساسية لبرنامج ربط العمليات التجارية.

RawAccessPolicy
RemovePathAccessControlItem
RequestPolicy

واجهة متوافقة لنهج طلب core-http

RequestPolicyFactory

واجهة للتوافق مع RequestPolicyFactory ل core-http

RequestPolicyOptions

واجهة للتوافق مع RequestPolicy

RolePermissions
SASQueryParametersOptions

خيارات لإنشاء SASQueryParameters.

SasIPRange

نطاق IP المسموح به ل SAS.

ServiceClientOptions

مجموعة فرعية من @azure/core-http ServiceClientOptions

ServiceGenerateAccountSasUrlOptions

خيارات لتكوين عملية generateAccountSasUrl.

ServiceGetUserDelegationKeyHeaders
ServiceGetUserDelegationKeyOptions
ServiceListFileSystemsOptions

واجهة للخيارات الشائعة لكل عملية بعيدة.

ServiceListFileSystemsSegmentHeaders
ServiceUndeleteFileSystemOptions

خيارات لتكوين undeleteFileSystem.

SignedIdentifier
StoragePipelineOptions

واجهة الخيارات لدالة newPipeline.

StorageRetryOptions

واجهة خيارات إعادة محاولة Storage Blob.

UserDelegationKey

مفتاح تفويض المستخدم.

UserDelegationKeyModel

مفتاح تفويض المستخدم

WebResource

وصف لطلب HTTP الذي سيتم إجراؤه إلى خادم بعيد.

النوع أسماء مستعارة

AccessControlType
CopyStatusType
CredentialPolicyCreator

دالة مصنع تنشئ نهج بيانات اعتماد جديد يستخدم النهج التالي المتوفر.

DataLakeServiceGetPropertiesResponse

يحتوي على بيانات الاستجابة لعملية getProperties.

EncryptionAlgorithmType

تعريف قيم EncryptionAlgorithmType.
يمكن استخدام <xref:KnownEncryptionAlgorithmType> بالتبادل مع EncryptionAlgorithmType، يحتوي هذا التعداد على القيم المعروفة التي تدعمها الخدمة.

القيم المعروفة التي تدعمها الخدمة

None
AES256

FileAppendResponse
FileExpiryMode

تعريف قيم PathExpiryOptions.

FileFlushResponse
FileQueryArrowConfiguration

خيارات الاستعلام عن الملف بتنسيق Apache سهم. صالح فقط outputTextConfiguration.

FileReadResponse
FileSetExpiryResponse
FileSystemCreateResponse
FileSystemDeleteResponse
FileSystemGetAccessPolicyResponse
FileSystemGetPropertiesResponse
FileSystemListDeletedPathsResponse
FileSystemListPathsResponse
FileSystemRenameResponse

يحتوي على بيانات استجابة لعملية <xref:DataLakeServiceClient.renameFileSystem>.

FileSystemSetAccessPolicyResponse
FileSystemSetMetadataResponse
FileSystemUndeletePathResponse
FileSystemUndeleteResponse

يحتوي على بيانات استجابة لعملية undeleteFileSystem.

FileUploadResponse
HttpRequestBody

أنواع الهيئات المدعومة بناء على الطلب. NodeJS.ReadableStream و () => NodeJS.ReadableStream هي Node only. Blob وReadableStream<Uint8Array> و() => ReadableStream<Uint8Array> هي مستعرض فقط.

LeaseDurationType
LeaseOperationResponse

يحتوي على بيانات الاستجابة للعمليات التي تنشئ عقد تأجير أو تعدله أو تحذفه.

راجع <xref:BlobLeaseClient>.

LeaseStateType
LeaseStatusType
ModifiedAccessConditions
PathCreateResponse
PathDeleteResponse
PathGetAccessControlResponse
PathGetPropertiesActionModel

تعريف قيم PathGetPropertiesAction.

PathGetPropertiesResponse
PathMoveResponse
PathRenameModeModel

تعريف قيم PathRenameMode.

PathResourceTypeModel

تعريف قيم PathResourceType.

PathSetAccessControlResponse
PathSetHttpHeadersResponse
PathSetMetadataResponse
PathSetPermissionsResponse
PublicAccessType
ServiceGetUserDelegationKeyResponse
ServiceListContainersSegmentResponse

يحتوي على بيانات الاستجابة لعملية listContainersSegment.

ServiceListFileSystemsSegmentResponse
ServiceRenameFileSystemOptions

خيارات لتكوين <xref:DataLakeServiceClient.renameFileSystem>.

التعدادات

PathGetPropertiesAction

تعريف قيم PathGetPropertiesAction. تتضمن القيم المحتملة: "getAccessControl" و"getStatus"

PathRenameMode

تعريف قيم PathRenameMode. تتضمن القيم المحتملة: "legacy"، و"posix"

PathResourceType

تعريف قيم PathResourceType. تتضمن القيم المحتملة: "الدليل"، و"الملف"

SASProtocol

بروتوكولات SAS التي تم إنشاؤها.

StorageDataLakeAudience

يحدد جمهور السحابة المعروف ل Storage.

StorageRetryPolicyType

أنواع RetryPolicy.

الوظائف

generateAccountSASQueryParameters(AccountSASSignatureValues, StorageSharedKeyCredential)

متوفر فقط في وقت تشغيل NODE.JS.

إنشاء SASQueryParameters الكائن الذي يحتوي على جميع معلمات استعلام SAS اللازمة لتقديم طلب REST فعلي.

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

generateDataLakeSASQueryParameters(DataLakeSASSignatureValues, StorageSharedKeyCredential)

متوفر فقط في وقت تشغيل NODE.JS.

إنشاء مثيل SASQueryParameters.

يقبل فقط الإعدادات المطلوبة اللازمة لإنشاء SAS. بالنسبة للإعدادات الاختيارية، يرجى تعيين الخصائص المقابلة مباشرة، مثل الأذونات و startsOn والمعرف.

تحذير: عند عدم توفير المعرف، تكون الأذونات وانتهاء الصلاحية مطلوبة. يجب تعيين قيمة للمعرف أو انتهاء الصلاحيةعلى أذونات & يدويا إذا قمت بالأحرف الأولى باستخدام الدالة الإنشائية هذه.

املأ التفاصيل المطلوبة قبل تشغيل القصاصات البرمجية التالية.

Example

// Generate service level SAS for a file system
const containerSAS = generateDataLakeSASQueryParameters({
    fileSystemName, // Required
    permissions: ContainerSASPermissions.parse("racwdl"), // Required
    startsOn: new Date(), // Optional
    expiresOn: new Date(new Date().valueOf() + 86400), // Required. Date type
    ipRange: { start: "0.0.0.0", end: "255.255.255.255" }, // Optional
    protocol: SASProtocol.HttpsAndHttp, // Optional
    version: "2016-05-31" // Optional
  },
  sharedKeyCredential // StorageSharedKeyCredential - `new StorageSharedKeyCredential(account, accountKey)`
).toString();

املأ التفاصيل المطلوبة قبل تشغيل القصاصة البرمجية.

Example

// Generate service level SAS for a file
const fileSAS = generateDataLakeSASQueryParameters({
    fileSystemName, // Required
    fileName, // Required
    permissions: DataLakeSASPermissions.parse("racwd"), // Required
    startsOn: new Date(), // Optional
    expiresOn: new Date(new Date().valueOf() + 86400), // Required. Date type
    cacheControl: "cache-control-override", // Optional
    contentDisposition: "content-disposition-override", // Optional
    contentEncoding: "content-encoding-override", // Optional
    contentLanguage: "content-language-override", // Optional
    contentType: "content-type-override", // Optional
    ipRange: { start: "0.0.0.0", end: "255.255.255.255" }, // Optional
    protocol: SASProtocol.HttpsAndHttp, // Optional
    version: "2016-05-31" // Optional
  },
  sharedKeyCredential // StorageSharedKeyCredential - `new StorageSharedKeyCredential(account, accountKey)`
).toString();
generateDataLakeSASQueryParameters(DataLakeSASSignatureValues, UserDelegationKey, string)

متوفر فقط في وقت تشغيل NODE.JS.

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

Example

// Generate user delegation SAS for a file system
const userDelegationKey = await dataLakeServiceClient.getUserDelegationKey(startsOn, expiresOn);
const fileSystemSAS = generateDataLakeSASQueryParameters({
    fileSystemName, // Required
    permissions: FileSystemSASPermissions.parse("racwdl"), // Required
    startsOn, // Optional. Date type
    expiresOn, // Required. Date type
    ipRange: { start: "0.0.0.0", end: "255.255.255.255" }, // Optional
    protocol: SASProtocol.HttpsAndHttp, // Optional
    version: "2018-11-09" // Must greater than or equal to 2018-11-09 to generate user delegation SAS
  },
  userDelegationKey, // UserDelegationKey
  accountName
).toString();
getDataLakeServiceAccountAudience(string)

للحصول على جمهور OAuth لحساب تخزين لخدمة datalake.

isPipelineLike(unknown)

مساعد لتحديد ما إذا كانت وسيطة معينة تفي بعقد البنية الأساسية لبرنامج ربط العمليات التجارية

newPipeline(StorageSharedKeyCredential | AnonymousCredential | TokenCredential, StoragePipelineOptions)

إنشاء كائن مسار جديد مع توفير بيانات الاعتماد.

المتغيرات

RestError

نوع خطأ مخصص لطلبات البنية الأساسية لبرنامج ربط العمليات التجارية الفاشلة.

StorageOAuthScopes

نطاق OAuth المستخدم مع Azure Storage.

ToBlobEndpointHostMappings
ToDfsEndpointHostMappings
logger

@azure/logger تكوين هذه الحزمة.

تفاصيل الوظيفة

generateAccountSASQueryParameters(AccountSASSignatureValues, StorageSharedKeyCredential)

متوفر فقط في وقت تشغيل NODE.JS.

إنشاء SASQueryParameters الكائن الذي يحتوي على جميع معلمات استعلام SAS اللازمة لتقديم طلب REST فعلي.

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

function generateAccountSASQueryParameters(accountSASSignatureValues: AccountSASSignatureValues, sharedKeyCredential: StorageSharedKeyCredential): SASQueryParameters

المعلمات

accountSASSignatureValues
AccountSASSignatureValues
sharedKeyCredential
StorageSharedKeyCredential

المرتجعات

generateDataLakeSASQueryParameters(DataLakeSASSignatureValues, StorageSharedKeyCredential)

متوفر فقط في وقت تشغيل NODE.JS.

إنشاء مثيل SASQueryParameters.

يقبل فقط الإعدادات المطلوبة اللازمة لإنشاء SAS. بالنسبة للإعدادات الاختيارية، يرجى تعيين الخصائص المقابلة مباشرة، مثل الأذونات و startsOn والمعرف.

تحذير: عند عدم توفير المعرف، تكون الأذونات وانتهاء الصلاحية مطلوبة. يجب تعيين قيمة للمعرف أو انتهاء الصلاحيةعلى أذونات & يدويا إذا قمت بالأحرف الأولى باستخدام الدالة الإنشائية هذه.

املأ التفاصيل المطلوبة قبل تشغيل القصاصات البرمجية التالية.

Example

// Generate service level SAS for a file system
const containerSAS = generateDataLakeSASQueryParameters({
    fileSystemName, // Required
    permissions: ContainerSASPermissions.parse("racwdl"), // Required
    startsOn: new Date(), // Optional
    expiresOn: new Date(new Date().valueOf() + 86400), // Required. Date type
    ipRange: { start: "0.0.0.0", end: "255.255.255.255" }, // Optional
    protocol: SASProtocol.HttpsAndHttp, // Optional
    version: "2016-05-31" // Optional
  },
  sharedKeyCredential // StorageSharedKeyCredential - `new StorageSharedKeyCredential(account, accountKey)`
).toString();

املأ التفاصيل المطلوبة قبل تشغيل القصاصة البرمجية.

Example

// Generate service level SAS for a file
const fileSAS = generateDataLakeSASQueryParameters({
    fileSystemName, // Required
    fileName, // Required
    permissions: DataLakeSASPermissions.parse("racwd"), // Required
    startsOn: new Date(), // Optional
    expiresOn: new Date(new Date().valueOf() + 86400), // Required. Date type
    cacheControl: "cache-control-override", // Optional
    contentDisposition: "content-disposition-override", // Optional
    contentEncoding: "content-encoding-override", // Optional
    contentLanguage: "content-language-override", // Optional
    contentType: "content-type-override", // Optional
    ipRange: { start: "0.0.0.0", end: "255.255.255.255" }, // Optional
    protocol: SASProtocol.HttpsAndHttp, // Optional
    version: "2016-05-31" // Optional
  },
  sharedKeyCredential // StorageSharedKeyCredential - `new StorageSharedKeyCredential(account, accountKey)`
).toString();
function generateDataLakeSASQueryParameters(dataLakeSASSignatureValues: DataLakeSASSignatureValues, sharedKeyCredential: StorageSharedKeyCredential): SASQueryParameters

المعلمات

dataLakeSASSignatureValues
DataLakeSASSignatureValues
sharedKeyCredential
StorageSharedKeyCredential

المرتجعات

generateDataLakeSASQueryParameters(DataLakeSASSignatureValues, UserDelegationKey, string)

متوفر فقط في وقت تشغيل NODE.JS.

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

Example

// Generate user delegation SAS for a file system
const userDelegationKey = await dataLakeServiceClient.getUserDelegationKey(startsOn, expiresOn);
const fileSystemSAS = generateDataLakeSASQueryParameters({
    fileSystemName, // Required
    permissions: FileSystemSASPermissions.parse("racwdl"), // Required
    startsOn, // Optional. Date type
    expiresOn, // Required. Date type
    ipRange: { start: "0.0.0.0", end: "255.255.255.255" }, // Optional
    protocol: SASProtocol.HttpsAndHttp, // Optional
    version: "2018-11-09" // Must greater than or equal to 2018-11-09 to generate user delegation SAS
  },
  userDelegationKey, // UserDelegationKey
  accountName
).toString();
function generateDataLakeSASQueryParameters(dataLakeSASSignatureValues: DataLakeSASSignatureValues, userDelegationKey: UserDelegationKey, accountName: string): SASQueryParameters

المعلمات

dataLakeSASSignatureValues
DataLakeSASSignatureValues
userDelegationKey
UserDelegationKey

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

accountName

string

المرتجعات

getDataLakeServiceAccountAudience(string)

للحصول على جمهور OAuth لحساب تخزين لخدمة datalake.

function getDataLakeServiceAccountAudience(storageAccountName: string): string

المعلمات

storageAccountName

string

المرتجعات

string

isPipelineLike(unknown)

مساعد لتحديد ما إذا كانت وسيطة معينة تفي بعقد البنية الأساسية لبرنامج ربط العمليات التجارية

function isPipelineLike(pipeline: unknown): pipeline

المعلمات

pipeline

unknown

وسيطة قد تكون مسارا

المرتجعات

pipeline

صواب عندما تفي الوسيطة بعقد البنية الأساسية لبرنامج ربط العمليات التجارية

newPipeline(StorageSharedKeyCredential | AnonymousCredential | TokenCredential, StoragePipelineOptions)

إنشاء كائن مسار جديد مع توفير بيانات الاعتماد.

function newPipeline(credential?: StorageSharedKeyCredential | AnonymousCredential | TokenCredential, pipelineOptions?: StoragePipelineOptions): Pipeline

المعلمات

credential

StorageSharedKeyCredential | AnonymousCredential | TokenCredential

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

pipelineOptions
StoragePipelineOptions

Optional. Options.

المرتجعات

كائن مسار جديد.

Variable Details

RestError

نوع خطأ مخصص لطلبات البنية الأساسية لبرنامج ربط العمليات التجارية الفاشلة.

RestError: RestErrorConstructor

النوع

StorageOAuthScopes

نطاق OAuth المستخدم مع Azure Storage.

StorageOAuthScopes: string | string[]

النوع

string | string[]

ToBlobEndpointHostMappings

ToBlobEndpointHostMappings: string[][]

النوع

string[][]

ToDfsEndpointHostMappings

ToDfsEndpointHostMappings: string[][]

النوع

string[][]

logger

@azure/logger تكوين هذه الحزمة.

logger: AzureLogger

النوع