BlobLeaseClient class

الحزمة:

@azure/storage-blob

عميل يدير عقود الإيجار ل ContainerClient أو BlobClient.

المنشئون

BlobLeaseClient(BlobClient | ContainerClient, string)

إنشاء مثيل BlobLeaseClient.

الخصائص

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

الأساليب

acquireLease(number, LeaseOperationOptions)	إنشاء تأمين على حاوية وإدارته لعمليات الحذف، أو على كائن ثنائي كبير الحجم لعمليات الكتابة والحذف. يمكن أن تتراوح مدة التأمين من 15 إلى 60 ثانية، أو يمكن أن تكون غير محدودة. عرض https://docs.microsoft.com/en-us/rest/api/storageservices/lease-container ورؤية https://docs.microsoft.com/en-us/rest/api/storageservices/lease-blob
breakLease(number, LeaseOperationOptions)	لإنهاء عقد الإيجار ولكن تأكد من أن عميلا آخر لا يمكنه الحصول على عقد إيجار جديد حتى انتهاء فترة الإيجار الحالية. عرض https://docs.microsoft.com/en-us/rest/api/storageservices/lease-container ورؤية https://docs.microsoft.com/en-us/rest/api/storageservices/lease-blob
changeLease(string, LeaseOperationOptions)	لتغيير معرف عقد الإيجار. عرض https://docs.microsoft.com/en-us/rest/api/storageservices/lease-container ورؤية https://docs.microsoft.com/en-us/rest/api/storageservices/lease-blob
releaseLease(LeaseOperationOptions)	لتحرير عقد الإيجار إذا لم تعد هناك حاجة إليه بحيث يمكن لعميل آخر الحصول على عقد إيجار على الفور مقابل الحاوية أو الكائن الثنائي كبير الحجم. عرض https://docs.microsoft.com/en-us/rest/api/storageservices/lease-container ورؤية https://docs.microsoft.com/en-us/rest/api/storageservices/lease-blob
renewLease(LeaseOperationOptions)	لتجديد عقد الإيجار. عرض https://docs.microsoft.com/en-us/rest/api/storageservices/lease-container ورؤية https://docs.microsoft.com/en-us/rest/api/storageservices/lease-blob

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

BlobLeaseClient(BlobClient | ContainerClient, string)

إنشاء مثيل BlobLeaseClient.

new BlobLeaseClient(client: BlobClient | ContainerClient, leaseId?: string)

المعلمات

client

BlobClient | ContainerClient

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

leaseId

string

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

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

leaseId

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

string leaseId

قيمة الخاصية

string

url

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

string url

قيمة الخاصية

string

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

acquireLease(number, LeaseOperationOptions)

إنشاء تأمين على حاوية وإدارته لعمليات الحذف، أو على كائن ثنائي كبير الحجم لعمليات الكتابة والحذف. يمكن أن تتراوح مدة التأمين من 15 إلى 60 ثانية، أو يمكن أن تكون غير محدودة.

عرض https://docs.microsoft.com/en-us/rest/api/storageservices/lease-container ورؤية https://docs.microsoft.com/en-us/rest/api/storageservices/lease-blob

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

المعلمات

duration

number

يجب أن يتراوح بين 15 إلى 60 ثانية، أو لا نهائي (-1)

options

LeaseOperationOptions

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

المرتجعات

Promise<LeaseOperationResponse>

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

breakLease(number, LeaseOperationOptions)

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

عرض https://docs.microsoft.com/en-us/rest/api/storageservices/lease-container ورؤية https://docs.microsoft.com/en-us/rest/api/storageservices/lease-blob

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

المعلمات

breakPeriod

number

فترة التوقف

options

LeaseOperationOptions

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

المرتجعات

Promise<LeaseOperationResponse>

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

changeLease(string, LeaseOperationOptions)

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

عرض https://docs.microsoft.com/en-us/rest/api/storageservices/lease-container ورؤية https://docs.microsoft.com/en-us/rest/api/storageservices/lease-blob

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

المعلمات

proposedLeaseId

string

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

options

LeaseOperationOptions

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

المرتجعات

Promise<LeaseOperationResponse>

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

releaseLease(LeaseOperationOptions)

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

عرض https://docs.microsoft.com/en-us/rest/api/storageservices/lease-container ورؤية https://docs.microsoft.com/en-us/rest/api/storageservices/lease-blob

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

المعلمات

options

LeaseOperationOptions

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

المرتجعات

Promise<LeaseOperationResponse>

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

renewLease(LeaseOperationOptions)

لتجديد عقد الإيجار.

عرض https://docs.microsoft.com/en-us/rest/api/storageservices/lease-container ورؤية https://docs.microsoft.com/en-us/rest/api/storageservices/lease-blob

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

المعلمات

options

LeaseOperationOptions

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

المرتجعات

Promise<Lease>

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