ShareLeaseClient class

الحزمة:

@azure/storage-file-share

عميل يدير عقود الإيجار ShareFileClient أو ShareClient.

راجع https://learn.microsoft.com/rest/api/storageservices/lease-file وشاهد https://learn.microsoft.com/rest/api/storageservices/lease-share

المنشئون

ShareLeaseClient(ShareClient | ShareFileClient, string)

إنشاء مثيل ShareLeaseClient.

الخصائص

leaseId	يحصل على معرف التأجير.
url	الحصول على عنوان url.

الأساليب

acquireLease(number, LeaseOperationOptions)	إنشاء تأمين على ملف وإدارته، ومشاركة لقطة أو مشاركتها لعمليات الكتابة والحذف.
breakLease(LeaseOperationOptions)	لفرض إنهاء عقد الإيجار.
changeLease(string, LeaseOperationOptions)	لتغيير معرف عقد إيجار موجود.
releaseLease(LeaseOperationOptions)	لتحرير عقد الإيجار إذا لم تعد هناك حاجة إليه بحيث يمكن لعميل آخر الحصول على عقد إيجار على الفور.
renewLease(LeaseOperationOptions)	لتجديد عقد الإيجار. متوفر فقط للتأجير على لقطة المشاركة أو المشاركة. لاحظ أنه قد يتم تجديد عقد الإيجار حتى إذا انتهت صلاحيته طالما لم يتم تأجير السهم مرة أخرى منذ انتهاء عقد الإيجار هذا. عند تجديد عقد إيجار، يتم إعادة تعيين ساعة مدة التأجير.

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

ShareLeaseClient(ShareClient | ShareFileClient, string)

إنشاء مثيل ShareLeaseClient.

new ShareLeaseClient(client: ShareClient | ShareFileClient, leaseId?: string)

المعلمات

client

ShareClient | ShareFileClient

العميل لتقديم طلبات عملية التأجير.

leaseId

string

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

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

leaseId

يحصل على معرف التأجير.

string leaseId

قيمة الخاصية

string

url

الحصول على عنوان url.

string url

قيمة الخاصية

string

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

acquireLease(number, LeaseOperationOptions)

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

function acquireLease(duration?: number, options?: LeaseOperationOptions): Promise<LeaseOperationResponse>

المعلمات

duration

number

تحديد مدة التأجير بالثوان. بالنسبة للملف، القيمة الوحيدة المسموح بها هي -1 لإيجار لا تنتهي صلاحيته أبدا. للمشاركة، يجب أن يكون -1 أو بين 15 إلى 60.

options

LeaseOperationOptions

خيارات لعملية إدارة التأجير.

المرتجعات

Promise<LeaseOperationResponse>

بيانات الاستجابة للحصول على عملية تأجير.

breakLease(LeaseOperationOptions)

لفرض إنهاء عقد الإيجار.

function breakLease(options?: LeaseOperationOptions): Promise<LeaseOperationResponse>

المعلمات

options

LeaseOperationOptions

خيارات لعملية إدارة التأجير.

المرتجعات

Promise<LeaseOperationResponse>

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

changeLease(string, LeaseOperationOptions)

لتغيير معرف عقد إيجار موجود.

function changeLease(proposedLeaseId: string, options?: LeaseOperationOptions): Promise<LeaseOperationResponse>

المعلمات

proposedLeaseId

string

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

options

LeaseOperationOptions

خيارات لعملية إدارة التأجير.

المرتجعات

Promise<LeaseOperationResponse>

بيانات الاستجابة لعملية تأجير التغيير.

releaseLease(LeaseOperationOptions)

لتحرير عقد الإيجار إذا لم تعد هناك حاجة إليه بحيث يمكن لعميل آخر الحصول على عقد إيجار على الفور.

function releaseLease(options?: LeaseOperationOptions): Promise<LeaseOperationResponse>

المعلمات

options

LeaseOperationOptions

خيارات لعملية إدارة التأجير.

المرتجعات

Promise<LeaseOperationResponse>

بيانات الاستجابة لعملية تأجير الإصدار.

renewLease(LeaseOperationOptions)

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

function renewLease(options?: LeaseOperationOptions): Promise<LeaseOperationResponse>

المعلمات

options

LeaseOperationOptions

خيارات لعملية إدارة التأجير.

المرتجعات

Promise<LeaseOperationResponse>

بيانات الاستجابة لعملية تجديد الإيجار.