DataLakePathClient class
يمثل DataLakePathClient عنوان URL لمسار Azure Storage (الدليل أو الملف).
- يمتد
-
StorageClient
المنشئون
| Data |
إنشاء مثيل DataLakePathClient من عنوان URL والمسار. |
| Data |
إنشاء مثيل DataLakePathClient من عنوان URL وبيانات الاعتماد. |
الخصائص
| file |
اسم نظام الملفات الحالي. |
| name | اسم المسار الحالي (دليل أو ملف). |
الخصائص الموروثة
| account |
|
| credential | مثل AnonymousCredential أو StorageSharedKeyCredential أو أي بيانات اعتماد من حزمة |
| url | قيمة سلسلة URL المرمزة. |
الأساليب
تفاصيل المنشئ
DataLakePathClient(string, Pipeline)
إنشاء مثيل DataLakePathClient من عنوان URL والمسار.
new DataLakePathClient(url: string, pipeline: Pipeline)المعلمات
- url
-
string
سلسلة عميل تشير إلى مسار مستودع بيانات Azure Storage (دليل أو ملف)، مثل "https://myaccount.dfs.core.windows.net/filesystem/directory"؛ أو "https://myaccount.dfs.core.windows.net/filesystem/file". يمكنك إلحاق SAS إذا كنت تستخدم AnonymousCredential، مثل "https://myaccount.dfs.core.windows.net/filesystem/directory?sasString".
- pipeline
- Pipeline
استدعاء newPipeline() لإنشاء مسار افتراضي، أو توفير مسار مخصص.
DataLakePathClient(string, StorageSharedKeyCredential | AnonymousCredential | TokenCredential, StoragePipelineOptions)
إنشاء مثيل DataLakePathClient من عنوان URL وبيانات الاعتماد.
new DataLakePathClient(url: string, credential?: StorageSharedKeyCredential | AnonymousCredential | TokenCredential, options?: StoragePipelineOptions)المعلمات
- url
-
string
سلسلة عميل تشير إلى مسار مستودع بيانات Azure Storage (دليل أو ملف)، مثل "https://myaccount.dfs.core.windows.net/filesystem/directory"؛ أو "https://myaccount.dfs.core.windows.net/filesystem/file". يمكنك إلحاق SAS إذا كنت تستخدم AnonymousCredential، مثل "https://myaccount.dfs.core.windows.net/filesystem/directory?sasString".
- credential
-
StorageSharedKeyCredential | AnonymousCredential | TokenCredential
مثل AnonymousCredential أو StorageSharedKeyCredential أو أي بيانات اعتماد من حزمة @azure/identity لمصادقة الطلبات إلى الخدمة. يمكنك أيضا توفير كائن ينفذ واجهة TokenCredential. إذا لم يتم تحديده، يتم استخدام AnonymousCredential.
- options
- StoragePipelineOptions
Optional. خيارات لتكوين البنية الأساسية لبرنامج ربط العمليات التجارية HTTP.
تفاصيل الخاصية
fileSystemName
اسم نظام الملفات الحالي.
string fileSystemNameقيمة الخاصية
string
name
اسم المسار الحالي (دليل أو ملف).
string nameقيمة الخاصية
string
تفاصيل الخاصية الموروثة
accountName
accountName: stringقيمة الخاصية
string
موروث من StorageClient.accountName
credential
مثل AnonymousCredential أو StorageSharedKeyCredential أو أي بيانات اعتماد من حزمة @azure/identity لمصادقة الطلبات إلى الخدمة. يمكنك أيضا توفير كائن ينفذ واجهة TokenCredential. إذا لم يتم تحديده، يتم استخدام AnonymousCredential.
credential: StorageSharedKeyCredential | AnonymousCredential | TokenCredentialقيمة الخاصية
موروث من StorageClient.credential
url
قيمة سلسلة URL المرمزة.
url: stringقيمة الخاصية
string
موروث من StorageClient.url
تفاصيل الأسلوب
create(PathResourceType, PathCreateOptions)
إنشاء دليل أو مسار.
راجع https://learn.microsoft.com/rest/api/storageservices/datalakestoragegen2/path/create
function create(resourceType: PathResourceType, options?: PathCreateOptions): Promise<PathCreateResponse>المعلمات
- resourceType
- PathResourceTypeModel
نوع المورد أو "الدليل" أو "الملف".
- options
- PathCreateOptions
Optional. الخيارات عند إنشاء المسار.
المرتجعات
Promise<PathCreateResponse>
createIfNotExists(PathResourceType, PathCreateIfNotExistsOptions)
إنشاء دليل أو ملف. إذا كان المورد موجودا بالفعل، فلن يتم تغييره.
راجع https://learn.microsoft.com/rest/api/storageservices/datalakestoragegen2/path/create
function createIfNotExists(resourceType: PathResourceType, options?: PathCreateIfNotExistsOptions): Promise<PathCreateIfNotExistsResponse>المعلمات
- resourceType
- PathResourceTypeModel
نوع المورد أو "الدليل" أو "الملف".
- options
- PathCreateIfNotExistsOptions
المرتجعات
Promise<PathCreateIfNotExistsResponse>
delete(boolean, PathDeleteOptions)
حذف المسار الحالي (دليل أو ملف).
راجع https://learn.microsoft.com/rest/api/storageservices/datalakestoragegen2/path/delete
function delete(recursive?: boolean, options?: PathDeleteOptions): Promise<PathDeleteResponse>المعلمات
- recursive
-
boolean
مطلوب وصالح فقط عندما يكون المورد دليلا. إذا كانت "true"، حذف كافة المسارات الموجودة أسفل الدليل.
- options
- PathDeleteOptions
Optional. خيارات عند حذف المسار.
المرتجعات
Promise<PathDeleteResponse>
deleteIfExists(boolean, PathDeleteOptions)
حذف المسار الحالي (الدليل أو الملف) إذا كان موجودا.
راجع https://learn.microsoft.com/rest/api/storageservices/datalakestoragegen2/path/delete
function deleteIfExists(recursive?: boolean, options?: PathDeleteOptions): Promise<PathDeleteIfExistsResponse>المعلمات
- recursive
-
boolean
مطلوب وصالح فقط عندما يكون المورد دليلا. إذا كانت "true"، حذف كافة المسارات الموجودة أسفل الدليل.
- options
- PathDeleteOptions
المرتجعات
Promise<PathDeleteIfExistsResponse>
exists(PathExistsOptions)
إرجاع true إذا كان ملف Data Lake الذي يمثله هذا العميل موجودا؛ خطأ خلاف ذلك.
ملاحظة: استخدم هذه الدالة بعناية حيث قد يتم حذف ملف موجود من قبل عملاء أو تطبيقات أخرى. قد تتم إضافة الملفات الجديدة بالعكس بواسطة عملاء أو تطبيقات أخرى بعد اكتمال هذه الدالة.
function exists(options?: PathExistsOptions): Promise<boolean>المعلمات
- options
- PathExistsOptions
خيارات لعملية Exists.
المرتجعات
Promise<boolean>
getAccessControl(PathGetAccessControlOptions)
إرجاع بيانات التحكم بالوصول لمسار (دليل الملف).
راجع https://learn.microsoft.com/rest/api/storageservices/datalakestoragegen2/path/getproperties
function getAccessControl(options?: PathGetAccessControlOptions): Promise<PathGetAccessControlResponse>المعلمات
- options
- PathGetAccessControlOptions
Optional. الخيارات عند الحصول على التحكم في الوصول إلى الملفات.
المرتجعات
Promise<PathGetAccessControlResponse>
getDataLakeLeaseClient(string)
احصل على DataLakeLeaseClient الذي يدير عقود الإيجار على المسار (الدليل أو الملف).
function getDataLakeLeaseClient(proposeLeaseId?: string): DataLakeLeaseClientالمعلمات
- proposeLeaseId
-
string
Optional. معرف التأجير المقترح الأولي.
المرتجعات
getProperties(PathGetPropertiesOptions)
إرجاع كافة بيانات التعريف المعرفة من قبل المستخدم وخصائص HTTP القياسية وخصائص النظام للمسار (الدليل أو الملف).
تحذير: سيكون للكائن metadata الذي تم إرجاعه في الاستجابة مفاتيحه بأحرف صغيرة، حتى لو احتوت في الأصل على أحرف كبيرة. يختلف هذا عن مفاتيح بيانات التعريف التي تم إرجاعها بواسطة أساليب DataLakeFileSystemClient التي تسرد المسارات باستخدام خيار includeMetadata، والتي ستحتفظ بأحرفها الأصلية.
راجع https://learn.microsoft.com/rest/api/storageservices/get-blob-properties
function getProperties(options?: PathGetPropertiesOptions): Promise<PathGetPropertiesResponse>المعلمات
- options
- PathGetPropertiesOptions
Optional. الخيارات عند الحصول على خصائص المسار.
المرتجعات
Promise<PathGetPropertiesResponse>
move(string, PathMoveOptions)
نقل الدليل أو الملف داخل نفس نظام الملفات.
راجع https://learn.microsoft.com/rest/api/storageservices/datalakestoragegen2/path/create
function move(destinationPath: string, options?: PathMoveOptions): Promise<PathMoveResponse>المعلمات
- destinationPath
-
string
مسار الدليل الوجهة مثل "الدليل" أو مسار الملف "الدليل/الملف". إذا تمت مصادقة destinationPath باستخدام SAS، أضف SAS إلى مسار الوجهة مثل "directory/file?sasToken".
- options
- PathMoveOptions
Optional. خيارات عند نقل الدليل أو الملف.
المرتجعات
Promise<PathMoveResponse>
move(string, string, PathMoveOptions)
نقل الدليل أو الملف إلى نظام ملفات آخر.
راجع https://learn.microsoft.com/rest/api/storageservices/datalakestoragegen2/path/create
function move(destinationFileSystem: string, destinationPath: string, options?: PathMoveOptions): Promise<PathMoveResponse>المعلمات
- destinationFileSystem
-
string
نظام الملفات الوجهة مثل "نظام الملفات".
- destinationPath
-
string
مسار الدليل الوجهة مثل "الدليل" أو مسار الملف "الدليل/الملف" إذا تمت مصادقة destinationPath باستخدام SAS، أضف SAS إلى مسار الوجهة مثل "directory/file?sasToken".
- options
- PathMoveOptions
Optional. خيارات عند نقل الدليل أو الملف.
المرتجعات
Promise<PathMoveResponse>
removeAccessControlRecursive(RemovePathAccessControlItem[], PathChangeAccessControlRecursiveOptions)
إزالة التحكم بالوصول على مسار ومسارات فرعية.
راجع https://learn.microsoft.com/rest/api/storageservices/datalakestoragegen2/path/update
function removeAccessControlRecursive(acl: RemovePathAccessControlItem[], options?: PathChangeAccessControlRecursiveOptions): Promise<PathChangeAccessControlRecursiveResponse>المعلمات
قائمة التحكم بالوصول إلى POSIX للملف أو الدليل.
Optional. Options
المرتجعات
setAccessControl(PathAccessControlItem[], PathSetAccessControlOptions)
تعيين بيانات التحكم في الوصول لمسار (دليل الملف).
راجع https://learn.microsoft.com/rest/api/storageservices/datalakestoragegen2/path/update
function setAccessControl(acl: PathAccessControlItem[], options?: PathSetAccessControlOptions): Promise<PathSetAccessControlResponse>المعلمات
- acl
قائمة التحكم بالوصول إلى POSIX للملف أو الدليل.
- options
- PathSetAccessControlOptions
Optional. الخيارات عند تعيين التحكم في الوصول إلى المسار.
المرتجعات
Promise<PathSetAccessControlResponse>
setAccessControlRecursive(PathAccessControlItem[], PathChangeAccessControlRecursiveOptions)
تعيين Access Control على مسار ومسارات فرعية.
راجع https://learn.microsoft.com/rest/api/storageservices/datalakestoragegen2/path/update
function setAccessControlRecursive(acl: PathAccessControlItem[], options?: PathChangeAccessControlRecursiveOptions): Promise<PathChangeAccessControlRecursiveResponse>المعلمات
- acl
قائمة التحكم بالوصول إلى POSIX للملف أو الدليل.
Optional. Options
المرتجعات
setHttpHeaders(PathHttpHeaders, PathSetHttpHeadersOptions)
تعيين خصائص النظام على المسار (الدليل أو الملف).
إذا لم يتم توفير أي قيمة، أو لم يتم توفير قيمة لرؤوس كائن ثنائي كبير الحجم HTTP المحددة، مسح رؤوس HTTP للكائن الثنائي كبير الحجم هذه بدون قيمة.
راجع https://learn.microsoft.com/rest/api/storageservices/set-blob-properties
function setHttpHeaders(httpHeaders: PathHttpHeaders, options?: PathSetHttpHeadersOptions): Promise<PathSetHttpHeadersResponse>المعلمات
- httpHeaders
- PathHttpHeaders
- options
- PathSetHttpHeadersOptions
المرتجعات
Promise<PathSetHttpHeadersResponse>
setMetadata(Metadata, PathSetMetadataOptions)
تعيين بيانات التعريف المعرفة من قبل المستخدم للمسار المحدد (دليل الملف) كزوج واحد أو أكثر من أزواج قيمة الاسم.
إذا لم يتم توفير أي خيار، أو لم يتم تحديد بيانات تعريف في المعلمة، فستتم إزالة بيانات تعريف المسار.
راجع https://learn.microsoft.com/rest/api/storageservices/set-blob-metadata
function setMetadata(metadata?: Metadata, options?: PathSetMetadataOptions): Promise<PathSetMetadataResponse>المعلمات
- metadata
- Metadata
Optional. استبدل بيانات التعريف الموجودة بهذه القيمة. إذا لم يتم توفير أي قيمة، فستتم إزالة بيانات التعريف الموجودة.
- options
- PathSetMetadataOptions
Optional. خيارات عند تعيين بيانات تعريف المسار.
المرتجعات
Promise<PathSetMetadataResponse>
setPermissions(PathPermissions, PathSetPermissionsOptions)
تعيين أذونات الملف على مسار.
راجع https://learn.microsoft.com/rest/api/storageservices/datalakestoragegen2/path/update
function setPermissions(permissions: PathPermissions, options?: PathSetPermissionsOptions): Promise<PathSetPermissionsResponse>المعلمات
- permissions
- PathPermissions
أذونات الوصول إلى POSIX لمالك الملف ومجموعة امتلاك الملف وغيرها.
- options
- PathSetPermissionsOptions
Optional. الخيارات عند تعيين أذونات المسار.
المرتجعات
Promise<PathSetPermissionsResponse>
toDirectoryClient()
تحويل DataLakePathClient الحالي إلى DataLakeDirectoryClient إذا كان المسار الحالي دليلا.
function toDirectoryClient(): DataLakeDirectoryClientالمرتجعات
toFileClient()
تحويل DataLakePathClient الحالي إلى DataLakeFileClient إذا كان المسار الحالي ملفا.
function toFileClient(): DataLakeFileClientالمرتجعات
updateAccessControlRecursive(PathAccessControlItem[], PathChangeAccessControlRecursiveOptions)
يعدل Access Control على مسار ومسارات فرعية.
راجع https://learn.microsoft.com/rest/api/storageservices/datalakestoragegen2/path/update
function updateAccessControlRecursive(acl: PathAccessControlItem[], options?: PathChangeAccessControlRecursiveOptions): Promise<PathChangeAccessControlRecursiveResponse>المعلمات
- acl
قائمة التحكم بالوصول إلى POSIX للملف أو الدليل.
Optional. Options