DirectoryRenameOptions interface

الحزمة:

@azure/storage-file-share

خيارات لتكوين عملية إعادة تسمية.

يمتد

CommonOptions

الخصائص

abortSignal	تنفيذ واجهة AbortSignalLike للإشارة إلى طلب إلغاء العملية. على سبيل المثال، استخدم وحدة التحكم @azure/abort لإنشاء AbortSignal.
copyFileSmbInfo	Optional. تحديد خيار نسخ واصف أمان الملف من الملف المصدر أو تعيينه باستخدام القيمة التي يتم تعريفها بواسطة قيمة العنوان x-ms-file-permission أو x-ms-file-permission-key.
destinationLeaseAccessConditions	شرط الوصول إلى التأجير لملف الوجهة. مطلوب إذا كان ملف الوجهة يحتوي على عقد إيجار لا نهائي نشط.
filePermission	Optional. إذا تم تحديد الإذن (واصف الأمان) يجب تعيينه للدليل/الملف.
filePermissionFormat	Optional. متوفر للإصدار 2023-06-01 والإصدارات الأحدث. تحديد التنسيق الذي يتم إرجاع الإذن به. القيم المقبولة هي SDDL أو ثنائية. إذا كان x-ms-file-permission-format غير محدد أو تم تعيينه بشكل صريح إلى SDDL، يتم إرجاع الإذن بتنسيق SDDL. إذا تم تعيين x-ms-file-permission-format بشكل صريح إلى ثنائي، يتم إرجاع الإذن كسلسلة base64 تمثل الترميز الثنائي للإذن
filePermissionKey	Optional. مفتاح الإذن الذي سيتم تعيينه للدليل/الملف. ملاحظة: يجب تحديد ملف واحد فقط من filePermission أو filePermissionKey.
ignoreReadOnly	Optional. قيمة منطقية تحدد ما إذا كان يجب احترام السمة ReadOnly في ملف وجهة موجود مسبقا. إذا كان صحيحا، فستنجح إعادة التسمية، وإلا، فسيتسبب ملف سابق في الوجهة مع مجموعة السمات ReadOnly في فشل إعادة التسمية.
metadata	Optional. زوج قيمة الاسم لإقرانه بعنصر تخزين ملف.
replaceIfExists	Optional. قيمة منطقية ل إذا كان الملف الوجهة موجودا بالفعل، سواء كان هذا الطلب سيستبدل الملف أم لا. إذا كان صحيحا، فستنجح إعادة التسمية وستستبدل الملف الوجهة. إذا لم يتم توفيره أو إذا كان خطأ وكان الملف الوجهة موجودا، فلن يقوم الطلب بالكتابة فوق الملف الوجهة. إذا تم توفير الملف الوجهة ولم يكن موجودا، فستنجح إعادة التسمية. ملاحظة: لا تتجاوز هذه القيمة قيمة العنوان x-ms-file-copy-ignore-read-only.
sourceLeaseAccessConditions	شرط الوصول إلى التأجير للملف المصدر. مطلوب إذا كان الملف المصدر لديه عقد إيجار لا نهائي نشط.
timeoutInSeconds	Optional. يتم التعبير عن معلمة المهلة بالثوان. لمزيد من المعلومات، راجع تعيين المهلات لعمليات خدمة الملفات.

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

tracingOptions

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

abortSignal

تنفيذ واجهة AbortSignalLike للإشارة إلى طلب إلغاء العملية. على سبيل المثال، استخدم وحدة التحكم @azure/abort لإنشاء AbortSignal.

abortSignal?: AbortSignalLike

قيمة الخاصية

AbortSignalLike

copyFileSmbInfo

Optional. تحديد خيار نسخ واصف أمان الملف من الملف المصدر أو تعيينه باستخدام القيمة التي يتم تعريفها بواسطة قيمة العنوان x-ms-file-permission أو x-ms-file-permission-key.

copyFileSmbInfo?: CopyFileSmbInfo

قيمة الخاصية

CopyFileSmbInfo

destinationLeaseAccessConditions

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

destinationLeaseAccessConditions?: LeaseAccessConditions

قيمة الخاصية

LeaseAccessConditions

filePermission

Optional. إذا تم تحديد الإذن (واصف الأمان) يجب تعيينه للدليل/الملف.

filePermission?: string

قيمة الخاصية

string

filePermissionFormat

Optional. متوفر للإصدار 2023-06-01 والإصدارات الأحدث. تحديد التنسيق الذي يتم إرجاع الإذن به. القيم المقبولة هي SDDL أو ثنائية. إذا كان x-ms-file-permission-format غير محدد أو تم تعيينه بشكل صريح إلى SDDL، يتم إرجاع الإذن بتنسيق SDDL. إذا تم تعيين x-ms-file-permission-format بشكل صريح إلى ثنائي، يتم إرجاع الإذن كسلسلة base64 تمثل الترميز الثنائي للإذن

filePermissionFormat?: FilePermissionFormat

قيمة الخاصية

FilePermissionFormat

filePermissionKey

Optional. مفتاح الإذن الذي سيتم تعيينه للدليل/الملف. ملاحظة: يجب تحديد ملف واحد فقط من filePermission أو filePermissionKey.

filePermissionKey?: string

قيمة الخاصية

string

ignoreReadOnly

Optional. قيمة منطقية تحدد ما إذا كان يجب احترام السمة ReadOnly في ملف وجهة موجود مسبقا. إذا كان صحيحا، فستنجح إعادة التسمية، وإلا، فسيتسبب ملف سابق في الوجهة مع مجموعة السمات ReadOnly في فشل إعادة التسمية.

ignoreReadOnly?: boolean

قيمة الخاصية

boolean

metadata

Optional. زوج قيمة الاسم لإقرانه بعنصر تخزين ملف.

metadata?: Metadata

قيمة الخاصية

Metadata

replaceIfExists

Optional. قيمة منطقية ل إذا كان الملف الوجهة موجودا بالفعل، سواء كان هذا الطلب سيستبدل الملف أم لا. إذا كان صحيحا، فستنجح إعادة التسمية وستستبدل الملف الوجهة. إذا لم يتم توفيره أو إذا كان خطأ وكان الملف الوجهة موجودا، فلن يقوم الطلب بالكتابة فوق الملف الوجهة. إذا تم توفير الملف الوجهة ولم يكن موجودا، فستنجح إعادة التسمية. ملاحظة: لا تتجاوز هذه القيمة قيمة العنوان x-ms-file-copy-ignore-read-only.

replaceIfExists?: boolean

قيمة الخاصية

boolean

sourceLeaseAccessConditions

شرط الوصول إلى التأجير للملف المصدر. مطلوب إذا كان الملف المصدر لديه عقد إيجار لا نهائي نشط.

sourceLeaseAccessConditions?: LeaseAccessConditions

قيمة الخاصية

LeaseAccessConditions

timeoutInSeconds

Optional. يتم التعبير عن معلمة المهلة بالثوان. لمزيد من المعلومات، راجع تعيين المهلات لعمليات خدمة الملفات.

timeoutInSeconds?: number

قيمة الخاصية

number

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

tracingOptions

tracingOptions?: OperationTracingOptions

قيمة الخاصية

OperationTracingOptions

موروثة منCommonOptions.tracingOptions