BlobClient class

الحزمة:

@azure/storage-blob

يمثل BlobClient عنوان URL لكائن ثنائي كبير الحجم لتخزين Azure؛ قد يكون الكائن الثنائي كبير الحجم كتلة أو إلحاق كائن ثنائي كبير الحجم أو كائن ثنائي كبير الحجم للصفحة.

Extends

StorageClient

المنشئون

BlobClient(string, PipelineLike)	إنشاء مثيل BlobClient. يقبل هذا الأسلوب عنوان URL مشفرا أو عنوان URL غير مشفر يشير إلى كائن ثنائي كبير الحجم. لن يتم إلغاء سلسلة URL المشفرة مرتين، وسيتم إلغاء الأحرف الخاصة فقط في مسار URL. إذا كان اسم كائن ثنائي كبير الحجم يتضمن ؟ أو ٪، يجب ترميز اسم الكائن الثنائي كبير الحجم في عنوان URL.
BlobClient(string, StorageSharedKeyCredential | AnonymousCredential | TokenCredential, StoragePipelineOptions)	إنشاء مثيل BlobClient. يقبل هذا الأسلوب عنوان URL مشفرا أو عنوان URL غير مشفر يشير إلى كائن ثنائي كبير الحجم. لن يتم إلغاء سلسلة URL المشفرة مرتين، وسيتم إلغاء الأحرف الخاصة فقط في مسار URL. إذا كان اسم كائن ثنائي كبير الحجم يتضمن ؟ أو ٪، يجب ترميز اسم الكائن الثنائي كبير الحجم في عنوان URL.
BlobClient(string, string, string, StoragePipelineOptions)	إنشاء مثيل BlobClient من سلسلة الاتصال.

الخصائص

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

الأساليب

abortCopyFromURL(string, BlobAbortCopyFromURLOptions)	يقوم بإجهاض عملية نسخ Blob غير متزامنة معلقة، ويترك كائن ثنائي كبير الحجم وجهة مع صفر طول وبيانات تعريف كاملة. الإصدار 2012-02-12 والأحدث.
beginCopyFromURL(string, BlobBeginCopyFromURLOptions)	ينسخ كائن ثنائي كبير الحجم بشكل غير متزامن إلى وجهة داخل حساب التخزين. يقوم هذا الأسلوب بإرجاع استقصاء عملية طويلة الأمد يسمح لك بالانتظار إلى أجل غير مسمى حتى تكتمل النسخة. يمكنك أيضا إلغاء نسخة قبل اكتمالها عن طريق الاتصال cancelOperation بالناقص. لاحظ أنه لن يتم استدعاء رد اتصال onProgress إذا اكتملت العملية في الطلب الأول، وستؤدي محاولة إلغاء نسخة مكتملة إلى ظهور خطأ. في الإصدار 2012-02-12 والإصدارات الأحدث، يمكن أن يكون مصدر عملية نسخ كائن ثنائي كبير الحجم كائن ثنائي كبير الحجم ملتزما في أي حساب تخزين Azure. بدءا من الإصدار 2015-02-21، يمكن أن يكون مصدر عملية نسخ كائن ثنائي كبير الحجم ملف Azure في أي حساب تخزين Azure. تسمح حسابات التخزين التي تم إنشاؤها في 7 يونيو 2012 أو بعد ذلك بعملية نسخ كائن ثنائي كبير الحجم للنسخ من حساب تخزين آخر.
createSnapshot(BlobCreateSnapshotOptions)	إنشاء لقطة للقراءة فقط لكائن ثنائي كبير الحجم.
delete(BlobDeleteOptions)	وضع علامة على الكائن الثنائي كبير الحجم أو اللقطة المحددة للحذف. يتم حذف الكائن الثنائي كبير الحجم لاحقا أثناء تجميع البيانات المهملة. لاحظ أنه من أجل حذف كائن ثنائي كبير الحجم، يجب حذف جميع لقطاته. يمكنك حذف كليهما في نفس الوقت باستخدام عملية حذف كائن ثنائي كبير الحجم.
deleteIfExists(BlobDeleteOptions)	وضع علامة على الكائن الثنائي كبير الحجم أو اللقطة المحددة للحذف إذا كانت موجودة. يتم حذف الكائن الثنائي كبير الحجم لاحقا أثناء تجميع البيانات المهملة. لاحظ أنه من أجل حذف كائن ثنائي كبير الحجم، يجب حذف جميع لقطاته. يمكنك حذف كليهما في نفس الوقت باستخدام عملية حذف كائن ثنائي كبير الحجم.
deleteImmutabilityPolicy(BlobDeleteImmutabilityPolicyOptions)	احذف نهج immutablility على الكائن الثنائي كبير الحجم.
download(number, number, BlobDownloadOptions)	يقرأ أو يقوم بتنزيل كائن ثنائي كبير الحجم من النظام، بما في ذلك بيانات التعريف والخصائص الخاصة به. يمكنك أيضا استدعاء Get Blob لقراءة لقطة. في Node.js، ترجع البيانات في دفق قابل للقراءةStreamBody في المستعرضات، ترجع البيانات في blobBody وعد
downloadToBuffer(Buffer, number, number, BlobDownloadToBufferOptions)	متوفر فقط في وقت تشغيل NODE.JS. تنزيل Azure Blob بالتوازي مع مخزن مؤقت. الإزاحة والعد اختياريان، وينزلان الكائن الثنائي كبير الحجم بأكمله إذا لم يتم توفيرهما. تحذير: يمكن أن تدعم المخازن المؤقتة الملفات التي تصل إلى حوالي غيغابايت واحد فقط على أنظمة 32 بت أو حوالي غيغابايت على أنظمة 64 بت بسبب قيود Node.js/V8. بالنسبة للكائنات الثنائية كبيرة الحجم أكبر من هذا الحجم، ضع في اعتبارك <xref:downloadToFile>.
downloadToBuffer(number, number, BlobDownloadToBufferOptions)	متوفر فقط في وقت تشغيل NODE.JS. تنزيل Azure Blob بالتوازي مع مخزن مؤقت. الإزاحة والعد اختياريان، وينزلان الكائن الثنائي كبير الحجم بأكمله إذا لم يتم توفيرهما. تحذير: يمكن أن تدعم المخازن المؤقتة الملفات التي تصل إلى حوالي غيغابايت واحد فقط على أنظمة 32 بت أو حوالي غيغابايت على أنظمة 64 بت بسبب قيود Node.js/V8. بالنسبة للكائنات الثنائية كبيرة الحجم أكبر من هذا الحجم، ضع في اعتبارك <xref:downloadToFile>.
downloadToFile(string, number, number, BlobDownloadOptions)	متوفر فقط في وقت تشغيل NODE.JS. تنزيل Azure Blob إلى ملف محلي. يفشل إذا تم إنهاء مسار الملف المحدد بالفعل. الإزاحة والعد اختيارية، وتمرير 0 وغير معرفة على التوالي لتنزيل الكائن الثنائي كبير الحجم بأكمله.
exists(BlobExistsOptions)	إرجاع true إذا كان مورد Azure blob الذي يمثله هذا العميل موجودا؛ خطأ خلاف ذلك. ملاحظة: استخدم هذه الدالة بعناية حيث قد يتم حذف كائن ثنائي كبير الحجم موجود من قبل عملاء أو تطبيقات أخرى. العكس بالعكس قد تتم إضافة الكائنات الثنائية كبيرة الحجم الجديدة من قبل عملاء أو تطبيقات أخرى بعد اكتمال هذه الدالة.
generateSasUrl(BlobGenerateSasUrlOptions)	متوفر فقط ل BlobClient الذي تم إنشاؤه باستخدام بيانات اعتماد مفتاح مشترك. ينشئ عنوان URI لتوقيع الوصول المشترك لخدمة Blob (SAS) استنادا إلى خصائص العميل والمعلمات التي تم تمريرها. يتم توقيع SAS بواسطة بيانات اعتماد المفتاح المشترك للعميل.
getAppendBlobClient()	إنشاء كائن AppendBlobClient.
getBlobLeaseClient(string)	<xref:BlobLeaseClient> احصل على الذي يدير عقود الإيجار على الكائن الثنائي كبير الحجم.
getBlockBlobClient()	إنشاء كائن BlockBlobClient.
getPageBlobClient()	إنشاء كائن PageBlobClient.
getProperties(BlobGetPropertiesOptions)	إرجاع جميع بيانات التعريف المعرفة من قبل المستخدم وخصائص HTTP القياسية وخصائص النظام للكائن الثنائي كبير الحجم. لا يرجع محتوى الكائن الثنائي كبير الحجم.
getTags(BlobGetTagsOptions)	يحصل على العلامات المقترنة بالكائنات الثنائية كبيرة الحجم الأساسية.
setAccessTier(BlockBlobTier | PremiumPageBlobTier | string, BlobSetTierOptions)	تعيين الطبقة على كائن ثنائي كبير الحجم. يسمح بالعملية على كائن ثنائي كبير الحجم للصفحة في حساب تخزين متميز وعلى كائن ثنائي كبير الحجم للكتلة في حساب تخزين كائن ثنائي كبير الحجم (تخزين متكرر محليا فقط). تحدد طبقة الكائن الثنائي كبير الحجم للصفحة المتميزة الحجم المسموح به وIOPS وعرض النطاق الترددي للكائن الثنائي كبير الحجم. تحدد طبقة كائن ثنائي كبير الحجم للكتلة نوع التخزين Hot/Cool/Archive. لا تقوم هذه العملية بتحديث ETag للكائن الثنائي كبير الحجم.
setHTTPHeaders(BlobHTTPHeaders, BlobSetHTTPHeadersOptions)	تعيين خصائص النظام على الكائن الثنائي كبير الحجم. إذا لم يتم توفير قيمة، أو لم يتم توفير قيمة لرؤوس كائن ثنائي كبير الحجم HTTP المحددة، فسيتم مسح رؤوس كائن ثنائي كبير الحجم HTTP هذه بدون قيمة.
setImmutabilityPolicy(BlobImmutabilityPolicy, BlobSetImmutabilityPolicyOptions)	تعيين نهج immutablility على الكائن الثنائي كبير الحجم.
setLegalHold(boolean, BlobSetLegalHoldOptions)	تعيين تعليق قانوني على الكائن الثنائي كبير الحجم.
setMetadata(Metadata, BlobSetMetadataOptions)	تعيين بيانات التعريف المعرفة من قبل المستخدم للكائن الثنائي كبير الحجم المحدد كزوج واحد أو أكثر من أزواج قيمة الاسم. إذا لم يتم توفير أي خيار، أو لم يتم تعريف بيانات التعريف في المعلمة، فستتم إزالة بيانات تعريف الكائن الثنائي كبير الحجم.
setTags(Tags, BlobSetTagsOptions)	تعيين العلامات على الكائن الثنائي كبير الحجم الأساسي. يمكن أن يحتوي الكائن الثنائي كبير الحجم على ما يصل إلى 10 علامات. يجب أن تتراوح أحرف مفاتيح العلامات بين 1 و128 حرفا. يجب أن تتراوح قيم العلامة بين 0 و256 حرفا. تتضمن أحرف مفتاح العلامة والقيمة الصالحة أحرفا صغيرة وعليا، وأرقاما (0-9)، ومساحة (' ')، بالإضافة إلى ('+')، وطرح ('-')، ونقطة ('.')، وشرطة مائلة للأمام ('/')، ونقاط النقطتين (':')، وتساوي ('=')، وتسطير سفلي ('_') .
syncCopyFromURL(string, BlobSyncCopyFromURLOptions)	تقوم عملية Copy From URL المتزامنة بنسخ كائن ثنائي كبير الحجم أو مورد إنترنت إلى كائن ثنائي كبير الحجم جديد. لن يرجع استجابة حتى تكتمل النسخة.
undelete(BlobUndeleteOptions)	استعادة محتويات وبيانات التعريف للكائن الثنائي كبير الحجم المحذوف مبدئيا وأي لقطات محذوفة مبدئية مقترنة. يتم دعم إلغاء حذف Blob فقط في الإصدار 2017-07-29 أو أحدث.
withSnapshot(string)	إنشاء كائن BlobClient جديد مطابق للمصدر ولكن مع الطابع الزمني للقطة المحددة. توفير "" سيؤدي إلى إزالة اللقطة وإرجاع عميل إلى الكائن الثنائي كبير الحجم الأساسي.
withVersion(string)	إنشاء كائن BlobClient جديد يشير إلى إصدار من هذا الكائن الثنائي كبير الحجم. سيؤدي توفير "" إلى إزالة versionId وإرجاع عميل إلى الكائن الثنائي كبير الحجم الأساسي.

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

BlobClient(string, PipelineLike)

إنشاء مثيل BlobClient. يقبل هذا الأسلوب عنوان URL مشفرا أو عنوان URL غير مشفر يشير إلى كائن ثنائي كبير الحجم. لن يتم إلغاء سلسلة URL المشفرة مرتين، وسيتم إلغاء الأحرف الخاصة فقط في مسار URL. إذا كان اسم كائن ثنائي كبير الحجم يتضمن ؟ أو ٪، يجب ترميز اسم الكائن الثنائي كبير الحجم في عنوان URL.

new BlobClient(url: string, pipeline: PipelineLike)

المعلمات

url

string

سلسلة عميل تشير إلى خدمة Azure Storage blob، مثل "https://myaccount.blob.core.windows.net". يمكنك إلحاق SAS إذا كنت تستخدم AnonymousCredential، مثل "https://myaccount.blob.core.windows.net?sasString".

pipeline

PipelineLike

استدعاء newPipeline() لإنشاء مسار افتراضي، أو توفير مسار مخصص.

BlobClient(string, StorageSharedKeyCredential | AnonymousCredential | TokenCredential, StoragePipelineOptions)

إنشاء مثيل BlobClient. يقبل هذا الأسلوب عنوان URL مشفرا أو عنوان URL غير مشفر يشير إلى كائن ثنائي كبير الحجم. لن يتم إلغاء سلسلة URL المشفرة مرتين، وسيتم إلغاء الأحرف الخاصة فقط في مسار URL. إذا كان اسم كائن ثنائي كبير الحجم يتضمن ؟ أو ٪، يجب ترميز اسم الكائن الثنائي كبير الحجم في عنوان URL.

new BlobClient(url: string, credential?: StorageSharedKeyCredential | AnonymousCredential | TokenCredential, options?: StoragePipelineOptions)

المعلمات

url

string

سلسلة عميل تشير إلى خدمة Azure Storage blob، مثل "https://myaccount.blob.core.windows.net". يمكنك إلحاق SAS إذا كنت تستخدم AnonymousCredential، مثل "https://myaccount.blob.core.windows.net?sasString".

credential

StorageSharedKeyCredential | AnonymousCredential | TokenCredential

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

options

StoragePipelineOptions

‏‏اختياري. خيارات لتكوين البنية الأساسية لبرنامج ربط العمليات التجارية HTTP.

BlobClient(string, string, string, StoragePipelineOptions)

إنشاء مثيل BlobClient من سلسلة الاتصال.

new BlobClient(connectionString: string, containerName: string, blobName: string, options?: StoragePipelineOptions)

المعلمات

connectionString

string

سلسلة اتصال الحساب أو سلسلة اتصال SAS لحساب تخزين Azure. [ ملاحظة - لا يمكن استخدام سلسلة اتصال الحساب إلا في وقت تشغيل NODE.JS. ] مثال سلسلة اتصال الحساب -DefaultEndpointsProtocol=https;AccountName=myaccount;AccountKey=accountKey;EndpointSuffix=core.windows.net مثال على سلسلة اتصال SAS - BlobEndpoint=https://myaccount.blob.core.windows.net/;QueueEndpoint=https://myaccount.queue.core.windows.net/;FileEndpoint=https://myaccount.file.core.windows.net/;TableEndpoint=https://myaccount.table.core.windows.net/;SharedAccessSignature=sasString

containerName

string

اسم الحاوية.

blobName

string

اسم الكائن الثنائي كبير الحجم.

options

StoragePipelineOptions

‏‏اختياري. خيارات لتكوين البنية الأساسية لبرنامج ربط العمليات التجارية HTTP.

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

accountName

accountName: string

قيمة الخاصية

string

containerName

اسم حاوية التخزين التي يرتبط بها الكائن الثنائي كبير الحجم.

string containerName

قيمة الخاصية

string

credential

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

credential: StorageSharedKeyCredential | AnonymousCredential | TokenCredential

قيمة الخاصية

StorageSharedKeyCredential | AnonymousCredential | TokenCredential

name

اسم الكائن الثنائي كبير الحجم.

string name

قيمة الخاصية

string

url

قيمة سلسلة URL المشفرة.

url: string

قيمة الخاصية

string

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

abortCopyFromURL(string, BlobAbortCopyFromURLOptions)

يقوم بإجهاض عملية نسخ Blob غير متزامنة معلقة، ويترك كائن ثنائي كبير الحجم وجهة مع صفر طول وبيانات تعريف كاملة. الإصدار 2012-02-12 والأحدث.

function abortCopyFromURL(copyId: string, options?: BlobAbortCopyFromURLOptions)

المعلمات

copyId

string

معرف عملية Copy From URL.

options

BlobAbortCopyFromURLOptions

خيارات اختيارية لعملية Blob Abort Copy From URL.

المرتجعات

Promise<BlobAbortCopyFromURLResponse>

beginCopyFromURL(string, BlobBeginCopyFromURLOptions)

ينسخ كائن ثنائي كبير الحجم بشكل غير متزامن إلى وجهة داخل حساب التخزين. يقوم هذا الأسلوب بإرجاع استقصاء عملية طويلة الأمد يسمح لك بالانتظار إلى أجل غير مسمى حتى تكتمل النسخة. يمكنك أيضا إلغاء نسخة قبل اكتمالها عن طريق الاتصال cancelOperation بالناقص. لاحظ أنه لن يتم استدعاء رد اتصال onProgress إذا اكتملت العملية في الطلب الأول، وستؤدي محاولة إلغاء نسخة مكتملة إلى ظهور خطأ. في الإصدار 2012-02-12 والإصدارات الأحدث، يمكن أن يكون مصدر عملية نسخ كائن ثنائي كبير الحجم كائن ثنائي كبير الحجم ملتزما في أي حساب تخزين Azure. بدءا من الإصدار 2015-02-21، يمكن أن يكون مصدر عملية نسخ كائن ثنائي كبير الحجم ملف Azure في أي حساب تخزين Azure. تسمح حسابات التخزين التي تم إنشاؤها في 7 يونيو 2012 أو بعد ذلك بعملية نسخ كائن ثنائي كبير الحجم للنسخ من حساب تخزين آخر.

function beginCopyFromURL(copySource: string, options?: BlobBeginCopyFromURLOptions)

المعلمات

copySource

string

url إلى مصدر Azure Blob/File.

options

BlobBeginCopyFromURLOptions

خيارات اختيارية لعملية Blob Start Copy From URL.

المرتجعات

Promise<PollerLike<PollOperationState<BlobBeginCopyFromURLResponse>, BlobBeginCopyFromURLResponse>>

createSnapshot(BlobCreateSnapshotOptions)

إنشاء لقطة للقراءة فقط لكائن ثنائي كبير الحجم.

function createSnapshot(options?: BlobCreateSnapshotOptions)

المعلمات

options

BlobCreateSnapshotOptions

خيارات اختيارية لعملية Blob Create Snapshot.

المرتجعات

Promise<BlobCreateSnapshotResponse>

delete(BlobDeleteOptions)

وضع علامة على الكائن الثنائي كبير الحجم أو اللقطة المحددة للحذف. يتم حذف الكائن الثنائي كبير الحجم لاحقا أثناء تجميع البيانات المهملة. لاحظ أنه من أجل حذف كائن ثنائي كبير الحجم، يجب حذف جميع لقطاته. يمكنك حذف كليهما في نفس الوقت باستخدام عملية حذف كائن ثنائي كبير الحجم.

function delete(options?: BlobDeleteOptions)

المعلمات

options

BlobDeleteOptions

خيارات اختيارية لعملية حذف كائن ثنائي كبير الحجم.

المرتجعات

Promise<BlobDeleteResponse>

deleteIfExists(BlobDeleteOptions)

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

function deleteIfExists(options?: BlobDeleteOptions)

المعلمات

options

BlobDeleteOptions

خيارات اختيارية لعملية حذف كائن ثنائي كبير الحجم.

المرتجعات

Promise<BlobDeleteIfExistsResponse>

deleteImmutabilityPolicy(BlobDeleteImmutabilityPolicyOptions)

احذف نهج immutablility على الكائن الثنائي كبير الحجم.

function deleteImmutabilityPolicy(options?: BlobDeleteImmutabilityPolicyOptions)

المعلمات

options

BlobDeleteImmutabilityPolicyOptions

خيارات اختيارية لحذف نهج الثبات على الكائن الثنائي كبير الحجم.

المرتجعات

Promise<BlobDeleteImmutabilityPolicyResponse>

download(number, number, BlobDownloadOptions)

يقرأ أو يقوم بتنزيل كائن ثنائي كبير الحجم من النظام، بما في ذلك بيانات التعريف والخصائص الخاصة به. يمكنك أيضا استدعاء Get Blob لقراءة لقطة.

• في Node.js، ترجع البيانات في دفق قابل للقراءةStreamBody
• في المستعرضات، ترجع البيانات في blobBody وعد

function download(offset?: number, count?: number, options?: BlobDownloadOptions)

المعلمات

offset

number

من أي موضع للكائن الثنائي كبير الحجم لتنزيله، أكبر من أو يساوي 0

count

number

مقدار البيانات التي سيتم تنزيلها، أكبر من 0. سيتم تنزيله إلى النهاية عند عدم تحديده

options

BlobDownloadOptions

خيارات اختيارية لعملية تنزيل كائن ثنائي كبير الحجم.

مثال على الاستخدام (Node.js):

// Download and convert a blob to a string
const downloadBlockBlobResponse = await blobClient.download();
const downloaded = await streamToBuffer(downloadBlockBlobResponse.readableStreamBody);
console.log("Downloaded blob content:", downloaded.toString());

async function streamToBuffer(readableStream) {
return new Promise((resolve, reject) => {
const chunks = [];
readableStream.on("data", (data) => {
chunks.push(data instanceof Buffer ? data : Buffer.from(data));
});
readableStream.on("end", () => {
resolve(Buffer.concat(chunks));
});
readableStream.on("error", reject);
});
}

مثال على الاستخدام (المتصفح):

// Download and convert a blob to a string
const downloadBlockBlobResponse = await blobClient.download();
const downloaded = await blobToString(await downloadBlockBlobResponse.blobBody);
console.log(
  "Downloaded blob content",
  downloaded
);

async function blobToString(blob: Blob): Promise<string> {
  const fileReader = new FileReader();
  return new Promise<string>((resolve, reject) => {
    fileReader.onloadend = (ev: any) => {
      resolve(ev.target!.result);
    };
    fileReader.onerror = reject;
    fileReader.readAsText(blob);
  });
}

المرتجعات

Promise<BlobDownloadResponseParsed>

downloadToBuffer(Buffer, number, number, BlobDownloadToBufferOptions)

متوفر فقط في وقت تشغيل NODE.JS. تنزيل Azure Blob بالتوازي مع مخزن مؤقت. الإزاحة والعد اختياريان، وينزلان الكائن الثنائي كبير الحجم بأكمله إذا لم يتم توفيرهما.

تحذير: يمكن أن تدعم المخازن المؤقتة الملفات التي تصل إلى حوالي غيغابايت واحد فقط على أنظمة 32 بت أو حوالي غيغابايت على أنظمة 64 بت بسبب قيود Node.js/V8. بالنسبة للكائنات الثنائية كبيرة الحجم أكبر من هذا الحجم، ضع في اعتبارك <xref:downloadToFile>.

function downloadToBuffer(buffer: Buffer, offset?: number, count?: number, options?: BlobDownloadToBufferOptions)

المعلمات

buffer

Buffer

المخزن المؤقت المطلوب تعبئته، يجب أن يكون طوله أكبر من العدد

offset

number

من أي موضع للكتلة الثنائية كبيرة الحجم للتنزيل (بالبايت)

count

number

مقدار البيانات (بالبايت) التي سيتم تنزيلها. سيتم تنزيله إلى النهاية عند تمرير غير معرف

options

BlobDownloadToBufferOptions

BlobDownloadToBufferOptions

المرتجعات

Promise<Buffer>

downloadToBuffer(number, number, BlobDownloadToBufferOptions)

متوفر فقط في وقت تشغيل NODE.JS. تنزيل Azure Blob بالتوازي مع مخزن مؤقت. الإزاحة والعد اختياريان، وينزلان الكائن الثنائي كبير الحجم بأكمله إذا لم يتم توفيرهما.

تحذير: يمكن أن تدعم المخازن المؤقتة الملفات التي تصل إلى حوالي غيغابايت واحد فقط على أنظمة 32 بت أو حوالي غيغابايت على أنظمة 64 بت بسبب قيود Node.js/V8. بالنسبة للكائنات الثنائية كبيرة الحجم أكبر من هذا الحجم، ضع في اعتبارك <xref:downloadToFile>.

function downloadToBuffer(offset?: number, count?: number, options?: BlobDownloadToBufferOptions)

المعلمات

offset

number

من أي موضع للكتلة الثنائية كبيرة الحجم للتنزيل (بالبايت)

count

number

مقدار البيانات (بالبايت) التي سيتم تنزيلها. سيتم تنزيله إلى النهاية عند تمرير غير معرف

options

BlobDownloadToBufferOptions

BlobDownloadToBufferOptions

المرتجعات

Promise<Buffer>

downloadToFile(string, number, number, BlobDownloadOptions)

متوفر فقط في وقت تشغيل NODE.JS. تنزيل Azure Blob إلى ملف محلي. يفشل إذا تم إنهاء مسار الملف المحدد بالفعل. الإزاحة والعد اختيارية، وتمرير 0 وغير معرفة على التوالي لتنزيل الكائن الثنائي كبير الحجم بأكمله.

function downloadToFile(filePath: string, offset?: number, count?: number, options?: BlobDownloadOptions)

المعلمات

filePath

string

offset

number

من أي موضع للكتلة الثنائية كبيرة الحجم لتنزيلها.

count

number

مقدار البيانات التي سيتم تنزيلها. سيتم تنزيله إلى النهاية عند تمرير غير معرف.

options

BlobDownloadOptions

خيارات تنزيل كائن ثنائي كبير الحجم.

المرتجعات

Promise<BlobDownloadResponseParsed>

بيانات الاستجابة لعملية تنزيل الكائن الثنائي كبير الحجم، ولكن مع تعيين readableStreamBody إلى غير معرف نظرا لأن محتواه تمت قراءته وكتابته بالفعل في ملف محلي في المسار المحدد.

exists(BlobExistsOptions)

إرجاع true إذا كان مورد Azure blob الذي يمثله هذا العميل موجودا؛ خطأ خلاف ذلك. ملاحظة: استخدم هذه الدالة بعناية حيث قد يتم حذف كائن ثنائي كبير الحجم موجود من قبل عملاء أو تطبيقات أخرى. العكس بالعكس قد تتم إضافة الكائنات الثنائية كبيرة الحجم الجديدة من قبل عملاء أو تطبيقات أخرى بعد اكتمال هذه الدالة.

function exists(options?: BlobExistsOptions)

المعلمات

options

BlobExistsOptions

خيارات لعملية Exists.

المرتجعات

Promise<boolean>

generateSasUrl(BlobGenerateSasUrlOptions)

متوفر فقط ل BlobClient الذي تم إنشاؤه باستخدام بيانات اعتماد مفتاح مشترك. ينشئ عنوان URI لتوقيع الوصول المشترك لخدمة Blob (SAS) استنادا إلى خصائص العميل والمعلمات التي تم تمريرها. يتم توقيع SAS بواسطة بيانات اعتماد المفتاح المشترك للعميل.

function generateSasUrl(options: BlobGenerateSasUrlOptions)

المعلمات

options

BlobGenerateSasUrlOptions

المعلمات الاختيارية.

المرتجعات

Promise<string>

SAS URI الذي يتكون من URI إلى المورد الذي يمثله هذا العميل، متبوعا بالرمز المميز SAS الذي تم إنشاؤه.

getAppendBlobClient()

إنشاء كائن AppendBlobClient.

function getAppendBlobClient()

المرتجعات

AppendBlobClient

getBlobLeaseClient(string)

<xref:BlobLeaseClient> احصل على الذي يدير عقود الإيجار على الكائن الثنائي كبير الحجم.

function getBlobLeaseClient(proposeLeaseId?: string)

المعلمات

proposeLeaseId

string

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

المرتجعات

BlobLeaseClient

كائن BlobLeaseClient جديد لإدارة عقود الإيجار على الكائن الثنائي كبير الحجم.

getBlockBlobClient()

إنشاء كائن BlockBlobClient.

function getBlockBlobClient()

المرتجعات

BlockBlobClient

getPageBlobClient()

إنشاء كائن PageBlobClient.

function getPageBlobClient()

المرتجعات

PageBlobClient

getProperties(BlobGetPropertiesOptions)

إرجاع جميع بيانات التعريف المعرفة من قبل المستخدم وخصائص HTTP القياسية وخصائص النظام للكائن الثنائي كبير الحجم. لا يرجع محتوى الكائن الثنائي كبير الحجم.

function getProperties(options?: BlobGetPropertiesOptions)

المعلمات

options

BlobGetPropertiesOptions

خيارات اختيارية لعملية الحصول على الخصائص.

المرتجعات

Promise<BlobGetPropertiesResponse>

getTags(BlobGetTagsOptions)

يحصل على العلامات المقترنة بالكائنات الثنائية كبيرة الحجم الأساسية.

function getTags(options?: BlobGetTagsOptions)

المعلمات

options

BlobGetTagsOptions

المرتجعات

Promise<BlobGetTagsResponse>

setAccessTier(BlockBlobTier | PremiumPageBlobTier | string, BlobSetTierOptions)

تعيين الطبقة على كائن ثنائي كبير الحجم. يسمح بالعملية على كائن ثنائي كبير الحجم للصفحة في حساب تخزين متميز وعلى كائن ثنائي كبير الحجم للكتلة في حساب تخزين كائن ثنائي كبير الحجم (تخزين متكرر محليا فقط). تحدد طبقة الكائن الثنائي كبير الحجم للصفحة المتميزة الحجم المسموح به وIOPS وعرض النطاق الترددي للكائن الثنائي كبير الحجم. تحدد طبقة كائن ثنائي كبير الحجم للكتلة نوع التخزين Hot/Cool/Archive. لا تقوم هذه العملية بتحديث ETag للكائن الثنائي كبير الحجم.

function setAccessTier(tier: BlockBlobTier | PremiumPageBlobTier | string, options?: BlobSetTierOptions)

المعلمات

tier

BlockBlobTier | PremiumPageBlobTier | string

الطبقة التي سيتم تعيينها على الكائن الثنائي كبير الحجم. القيم الصالحة هي Hot أو Cool أو Archive.

options

BlobSetTierOptions

خيارات اختيارية لعملية Blob Set Tier.

المرتجعات

Promise<BlobSetTierResponse>

setHTTPHeaders(BlobHTTPHeaders, BlobSetHTTPHeadersOptions)

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

function setHTTPHeaders(blobHTTPHeaders?: BlobHTTPHeaders, options?: BlobSetHTTPHeadersOptions)

المعلمات

blobHTTPHeaders

BlobHTTPHeaders

إذا لم يتم توفير قيمة، أو لم يتم توفير قيمة لرؤوس كائن ثنائي كبير الحجم HTTP المحددة، فسيتم مسح رؤوس كائن ثنائي كبير الحجم HTTP هذه بدون قيمة. يمكن العنوان الشائع الذي يجب تعيينه blobContentType المستعرض من توفير وظائف استنادا إلى نوع الملف.

options

BlobSetHTTPHeadersOptions

خيارات اختيارية لعملية Blob Set HTTP Headers.

المرتجعات

Promise<BlobSetHTTPHeadersResponse>

setImmutabilityPolicy(BlobImmutabilityPolicy, BlobSetImmutabilityPolicyOptions)

تعيين نهج immutablility على الكائن الثنائي كبير الحجم.

function setImmutabilityPolicy(immutabilityPolicy: BlobImmutabilityPolicy, options?: BlobSetImmutabilityPolicyOptions)

المعلمات

immutabilityPolicy

BlobImmutabilityPolicy

options

BlobSetImmutabilityPolicyOptions

خيارات اختيارية لتعيين نهج الثبات على الكائن الثنائي كبير الحجم.

المرتجعات

Promise<BlobSetImmutabilityPolicyResponse>

setLegalHold(boolean, BlobSetLegalHoldOptions)

تعيين تعليق قانوني على الكائن الثنائي كبير الحجم.

function setLegalHold(legalHoldEnabled: boolean, options?: BlobSetLegalHoldOptions)

المعلمات

legalHoldEnabled

boolean

options

BlobSetLegalHoldOptions

خيارات اختيارية لتعيين الاحتجاز القانوني على الكائن الثنائي كبير الحجم.

المرتجعات

Promise<BlobSetLegalHoldResponse>

setMetadata(Metadata, BlobSetMetadataOptions)

تعيين بيانات التعريف المعرفة من قبل المستخدم للكائن الثنائي كبير الحجم المحدد كزوج واحد أو أكثر من أزواج قيمة الاسم. إذا لم يتم توفير أي خيار، أو لم يتم تعريف بيانات التعريف في المعلمة، فستتم إزالة بيانات تعريف الكائن الثنائي كبير الحجم.

function setMetadata(metadata?: Metadata, options?: BlobSetMetadataOptions)

المعلمات

metadata

Metadata

استبدل بيانات التعريف الموجودة بهذه القيمة. إذا لم يتم توفير أي قيمة، فستتم إزالة بيانات التعريف الموجودة.

options

BlobSetMetadataOptions

خيارات اختيارية لتعيين عملية بيانات التعريف.

المرتجعات

Promise<BlobSetMetadataResponse>

setTags(Tags, BlobSetTagsOptions)

تعيين العلامات على الكائن الثنائي كبير الحجم الأساسي. يمكن أن يحتوي الكائن الثنائي كبير الحجم على ما يصل إلى 10 علامات. يجب أن تتراوح أحرف مفاتيح العلامات بين 1 و128 حرفا. يجب أن تتراوح قيم العلامة بين 0 و256 حرفا. تتضمن أحرف مفتاح العلامة والقيمة الصالحة أحرفا صغيرة وعليا، وأرقاما (0-9)، ومساحة (' ')، بالإضافة إلى ('+')، وطرح ('-')، ونقطة ('.')، وشرطة مائلة للأمام ('/')، ونقاط النقطتين (':')، وتساوي ('=')، وتسطير سفلي ('_') .

function setTags(tags: Tags, options?: BlobSetTagsOptions)

المعلمات

tags

Tags

options

BlobSetTagsOptions

المرتجعات

Promise<BlobSetTagsResponse>

syncCopyFromURL(string, BlobSyncCopyFromURLOptions)

تقوم عملية Copy From URL المتزامنة بنسخ كائن ثنائي كبير الحجم أو مورد إنترنت إلى كائن ثنائي كبير الحجم جديد. لن يرجع استجابة حتى تكتمل النسخة.

function syncCopyFromURL(copySource: string, options?: BlobSyncCopyFromURLOptions)

المعلمات

copySource

string

عنوان URL المصدر للنسخ منه، ربما كان توقيع الوصول المشترك (SAS) مطلوبا للمصادقة

options

BlobSyncCopyFromURLOptions

المرتجعات

Promise<BlobCopyFromURLResponse>

undelete(BlobUndeleteOptions)

استعادة محتويات وبيانات التعريف للكائن الثنائي كبير الحجم المحذوف مبدئيا وأي لقطات محذوفة مبدئية مقترنة. يتم دعم إلغاء حذف Blob فقط في الإصدار 2017-07-29 أو أحدث.

function undelete(options?: BlobUndeleteOptions)

المعلمات

options

BlobUndeleteOptions

خيارات اختيارية لعملية إلغاء حذف كائن ثنائي كبير الحجم.

المرتجعات

Promise<BlobUndeleteResponse>

withSnapshot(string)

إنشاء كائن BlobClient جديد مطابق للمصدر ولكن مع الطابع الزمني للقطة المحددة. توفير "" سيؤدي إلى إزالة اللقطة وإرجاع عميل إلى الكائن الثنائي كبير الحجم الأساسي.

function withSnapshot(snapshot: string)

المعلمات

snapshot

string

الطابع الزمني للقطة.

المرتجعات

BlobClient

كائن BlobClient جديد مطابق للمصدر ولكن مع الطابع الزمني للقطة المحددة

withVersion(string)

إنشاء كائن BlobClient جديد يشير إلى إصدار من هذا الكائن الثنائي كبير الحجم. سيؤدي توفير "" إلى إزالة versionId وإرجاع عميل إلى الكائن الثنائي كبير الحجم الأساسي.

function withVersion(versionId: string)

المعلمات

versionId

string

معرف الإصدار.

المرتجعات

BlobClient

كائن BlobClient جديد يشير إلى إصدار هذا الكائن الثنائي كبير الحجم.