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 من سلسلة الاتصال.

الخصائص

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

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

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

الأساليب

abortCopyFromURL(string, BlobAbortCopyFromURLOptions)	إحباط عملية نسخ Blob غير متزامنة معلقة، وترك كائن ثنائي كبير الحجم وجهة مع صفر طول وبيانات تعريف كاملة. الإصدار 2012-02-12 والأحدث. راجع https://docs.microsoft.com/en-us/rest/api/storageservices/abort-copy-blob
beginCopyFromURL(string, BlobBeginCopyFromURLOptions)	ينسخ كائن ثنائي كبير الحجم بشكل غير متزامن إلى وجهة داخل حساب التخزين. يقوم هذا الأسلوب بإرجاع استقصاء عملية طويلة الأمد يسمح لك بالانتظار إلى أجل غير مسمى حتى تكتمل النسخة. يمكنك أيضا إلغاء نسخة قبل اكتمالها عن طريق الاتصال `cancelOperation` بأداة الاستقصاء. لاحظ أنه لن يتم استدعاء رد الاتصال onProgress إذا اكتملت العملية في الطلب الأول، وستؤدي محاولة إلغاء نسخة مكتملة إلى ظهور خطأ. في الإصدار 2012-02-12 والإصدارات الأحدث، يمكن أن يكون مصدر عملية Copy Blob كائنا ثنائيا كبير الحجم ملتزما في أي حساب تخزين Azure. بدءا من الإصدار 2015-02-21، يمكن أن يكون مصدر عملية نسخ كائن ثنائي كبير الحجم ملف Azure في أي حساب تخزين Azure. تسمح حسابات التخزين التي تم إنشاؤها في 7 يونيو 2012 أو بعد ذلك بعملية نسخ كائن ثنائي كبير الحجم بالنسخ من حساب تخزين آخر. راجع https://docs.microsoft.com/en-us/rest/api/storageservices/copy-blob مثال على استخدام الاستقصاء التلقائي: `const copyPoller = await blobClient.beginCopyFromURL('url'); const result = await copyPoller.pollUntilDone();` مثال على استخدام الاستقصاء اليدوي: `const copyPoller = await blobClient.beginCopyFromURL('url'); while (!poller.isDone()) { await poller.poll(); } const result = copyPoller.getResult();` مثال على استخدام تحديثات التقدم: const copyPoller = await blobClient.beginCopyFromURL('url', { onProgress(state) { console.log(`Progress: ${state.copyProgress}`); } }); const result = await copyPoller.pollUntilDone(); مثال باستخدام فاصل زمني متغير للاستقصاء (افتراضي 15 ثانية): `const copyPoller = await blobClient.beginCopyFromURL('url', { intervalInMs: 1000 // poll blob every 1 second for copy progress }); const result = await copyPoller.pollUntilDone();` مثال على استخدام إلغاء النسخ: `const copyPoller = await blobClient.beginCopyFromURL('url'); // cancel operation after starting it. try { await copyPoller.cancelOperation(); // calls to get the result now throw PollerCancelledError await copyPoller.getResult(); } catch (err) { if (err.name === 'PollerCancelledError') { console.log('The copy was cancelled.'); } }`
createSnapshot(BlobCreateSnapshotOptions)	إنشاء لقطة للقراءة فقط لكائن ثنائي كبير الحجم. راجع https://docs.microsoft.com/en-us/rest/api/storageservices/snapshot-blob
delete(BlobDeleteOptions)	وضع علامة على الكائن الثنائي كبير الحجم أو اللقطة المحددة للحذف. يتم حذف الكائن الثنائي كبير الحجم لاحقا أثناء تجميع البيانات المهملة. لاحظ أنه لحذف كائن ثنائي كبير الحجم، يجب حذف جميع اللقطات الخاصة به. يمكنك حذف كليهما في نفس الوقت باستخدام عملية حذف كائن ثنائي كبير الحجم. راجع https://docs.microsoft.com/en-us/rest/api/storageservices/delete-blob
deleteIfExists(BlobDeleteOptions)	وضع علامة على الكائن الثنائي كبير الحجم أو اللقطة المحددة للحذف إذا كانت موجودة. يتم حذف الكائن الثنائي كبير الحجم لاحقا أثناء تجميع البيانات المهملة. لاحظ أنه لحذف كائن ثنائي كبير الحجم، يجب حذف جميع اللقطات الخاصة به. يمكنك حذف كليهما في نفس الوقت باستخدام عملية حذف كائن ثنائي كبير الحجم. راجع https://docs.microsoft.com/en-us/rest/api/storageservices/delete-blob
deleteImmutabilityPolicy(BlobDeleteImmutabilityPolicyOptions)	احذف نهج immutablility على الكائن الثنائي كبير الحجم.
download(number, number, BlobDownloadOptions)	يقرأ أو يقوم بتنزيل كائن ثنائي كبير الحجم من النظام، بما في ذلك بيانات التعريف والخصائص الخاصة به. يمكنك أيضا استدعاء Get Blob لقراءة لقطة. في Node.js، ترجع البيانات في دفق قابل للقراءةStreamBody في المستعرضات، ترجع البيانات في blobBody وعد راجع https://docs.microsoft.com/en-us/rest/api/storageservices/get-blob
downloadToBuffer(Buffer, number, number, BlobDownloadToBufferOptions)	متوفر فقط في وقت تشغيل NODE.JS. تنزيل Azure Blob بالتوازي مع مخزن مؤقت. تعد الإزاحة والعد اختيارية، وتنزيل الكائن الثنائي كبير الحجم بأكمله إذا لم يتم توفيرهما. تحذير: يمكن أن تدعم المخازن المؤقتة الملفات التي تصل إلى حوالي غيغابايت واحد فقط على أنظمة 32 بت أو حوالي غيغابايت على أنظمة 64 بت بسبب قيود Node.js/V8. بالنسبة للكائنات الثنائية كبيرة الحجم أكبر من هذا الحجم، ضع في اعتبارك downloadToFile.
downloadToBuffer(number, number, BlobDownloadToBufferOptions)	متوفر فقط في وقت تشغيل NODE.JS. تنزيل Azure Blob بالتوازي مع مخزن مؤقت. تعد الإزاحة والعد اختيارية، وتنزيل الكائن الثنائي كبير الحجم بأكمله إذا لم يتم توفيرهما. تحذير: يمكن أن تدعم المخازن المؤقتة الملفات التي تصل إلى حوالي غيغابايت واحد فقط على أنظمة 32 بت أو حوالي غيغابايت على أنظمة 64 بت بسبب قيود Node.js/V8. بالنسبة للكائنات الثنائية كبيرة الحجم أكبر من هذا الحجم، ضع في اعتبارك downloadToFile.
downloadToFile(string, number, number, BlobDownloadOptions)	متوفر فقط في وقت تشغيل NODE.JS. تنزيل Azure Blob إلى ملف محلي. يفشل إذا تم إنهاء مسار الملف المحدد بالفعل. الإزاحة والعد اختيارية، وتمرير 0 وغير محددة على التوالي لتنزيل الكائن الثنائي كبير الحجم بأكمله.
exists(BlobExistsOptions)	إرجاع true إذا كان مورد Azure blob الذي يمثله هذا العميل موجودا؛ خطأ خلاف ذلك. ملاحظة: استخدم هذه الدالة بعناية حيث قد يتم حذف كائن ثنائي كبير الحجم موجود من قبل عملاء أو تطبيقات أخرى. العكس بالعكس قد تتم إضافة كائنات ثنائية كبيرة الحجم جديدة من قبل عملاء أو تطبيقات أخرى بعد اكتمال هذه الوظيفة.
generateSasUrl(BlobGenerateSasUrlOptions)	متوفر فقط ل BlobClient الذي تم إنشاؤه باستخدام بيانات اعتماد مفتاح مشترك. إنشاء عنوان URI لتوقيع الوصول المشترك لخدمة Blob (SAS) استنادا إلى خصائص العميل والمعلمات التي تم تمريرها. يتم توقيع SAS بواسطة بيانات اعتماد المفتاح المشترك للعميل. راجع https://docs.microsoft.com/en-us/rest/api/storageservices/constructing-a-service-sas
getAppendBlobClient()	إنشاء كائن AppendBlobClient.
getBlobLeaseClient(string)	احصل على BlobLeaseClient الذي يدير عقود الإيجار على الكائن الثنائي كبير الحجم.
getBlockBlobClient()	إنشاء كائن BlockBlobClient.
getPageBlobClient()	إنشاء كائن PageBlobClient.
getProperties(BlobGetPropertiesOptions)	إرجاع جميع بيانات التعريف المعرفة من قبل المستخدم وخصائص HTTP القياسية وخصائص النظام للكائن الثنائي كبير الحجم. لا يرجع محتوى الكائن الثنائي كبير الحجم. راجع https://docs.microsoft.com/en-us/rest/api/storageservices/get-blob-properties تحذير: `metadata` سيكون للكائن الذي تم إرجاعه في الاستجابة مفاتيحه بأحرف صغيرة، حتى لو كانت تحتوي في الأصل على أحرف كبيرة. يختلف هذا عن مفاتيح بيانات التعريف التي يتم إرجاعها بواسطة أساليب ContainerClient التي تسرد الكائنات الثنائية كبيرة الحجم باستخدام `includeMetadata` الخيار ، والتي ستحتفظ بأحرفها الأصلية.
getTags(BlobGetTagsOptions)	يحصل على العلامات المقترنة بكائن ثنائي كبير الحجم الأساسي.
setAccessTier(string, BlobSetTierOptions)	تعيين الطبقة على كائن ثنائي كبير الحجم. يسمح بالعملية على كائن ثنائي كبير الحجم للصفحة في حساب تخزين متميز وعلى كائن ثنائي كبير الحجم للكتلة في حساب تخزين كائن ثنائي كبير الحجم (تخزين متكرر محليا فقط). تحدد طبقة الكائن الثنائي كبير الحجم للصفحة المتميزة الحجم المسموح به، وIOPS، والنطاق الترددي للكائن الثنائي كبير الحجم. تحدد طبقة كائن ثنائي كبير الحجم للكتلة نوع التخزين Hot/Cool/Archive. لا تقوم هذه العملية بتحديث ETag للكائن الثنائي كبير الحجم. راجع https://docs.microsoft.com/en-us/rest/api/storageservices/set-blob-tier
setHTTPHeaders(BlobHTTPHeaders, BlobSetHTTPHeadersOptions)	تعيين خصائص النظام على الكائن الثنائي كبير الحجم. إذا لم يتم توفير قيمة، أو لم يتم توفير قيمة لرؤوس HTTP للكائن الثنائي كبير الحجم المحددة، فسيتم مسح رؤوس HTTP للكائن الثنائي كبير الحجم هذه بدون قيمة. راجع https://docs.microsoft.com/en-us/rest/api/storageservices/set-blob-properties
setImmutabilityPolicy(BlobImmutabilityPolicy, BlobSetImmutabilityPolicyOptions)	تعيين نهج الثبات على الكائن الثنائي كبير الحجم.
setLegalHold(boolean, BlobSetLegalHoldOptions)	تعيين تعليق قانوني على الكائن الثنائي كبير الحجم.
setMetadata(Metadata, BlobSetMetadataOptions)	تعيين بيانات التعريف المعرفة من قبل المستخدم للكائن الثنائي كبير الحجم المحدد كزوج واحد أو أكثر من أزواج قيمة الاسم. إذا لم يتم توفير أي خيار، أو لم يتم تحديد بيانات تعريف في المعلمة، فستتم إزالة بيانات تعريف الكائن الثنائي كبير الحجم. راجع https://docs.microsoft.com/en-us/rest/api/storageservices/set-blob-metadata
setTags(Tags, BlobSetTagsOptions)	تعيين العلامات على الكائن الثنائي كبير الحجم الأساسي. يمكن أن يحتوي الكائن الثنائي كبير الحجم على ما يصل إلى 10 علامات. يجب أن تتراوح مفاتيح العلامات بين 1 و128 حرفا. يجب أن تتراوح قيم العلامة بين 0 و256 حرفا. تتضمن أحرف مفتاح العلامة والقيمة الصالحة أحرفا صغيرة وعلوية وأرقاما (0-9) ومسافة (' ') وعلامة الجمع ('+') والطرح ('-') والنقطة ('.') والشرطة المائلة للأمام ('/') وعلامة النقطتين (':') وتساوي ('=') وتسطير أسفل السطر ('_') .
syncCopyFromURL(string, BlobSyncCopyFromURLOptions)	تنسخ عملية Copy From URL المتزامنة كائنا ثنائيا كبير الحجم أو مورد إنترنت إلى كائن ثنائي كبير الحجم جديد. لن ترجع استجابة حتى تكتمل النسخة. راجع https://docs.microsoft.com/en-us/rest/api/storageservices/copy-blob-from-url
undelete(BlobUndeleteOptions)	استعادة محتويات وبيانات التعريف للكائن الثنائي كبير الحجم المحذوف مبدئيا وأي لقطات محذوفة مبدئيا مقترنة. يتم دعم إلغاء حذف Blob فقط في الإصدار 2017-07-29 أو أحدث. راجع https://docs.microsoft.com/en-us/rest/api/storageservices/undelete-blob
withSnapshot(string)	إنشاء كائن BlobClient جديد مطابق للمصدر ولكن مع الطابع الزمني للقطة المحددة. توفير "" سيؤدي إلى إزالة اللقطة وإرجاع عميل إلى الكائن الثنائي كبير الحجم الأساسي.
withVersion(string)	إنشاء كائن BlobClient جديد يشير إلى إصدار من هذا الكائن الثنائي كبير الحجم. سيؤدي توفير "" إلى إزالة versionId وإرجاع عميل إلى الكائن الثنائي كبير الحجم الأساسي.

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

BlobClient(string, PipelineLike)

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

new BlobClient(url: string, pipeline: PipelineLike)

المعلمات

url: string

سلسلة URL تشير إلى Azure Storage blob، مثل "https://myaccount.blob.core.windows.net/mycontainer/blob". يمكنك إلحاق SAS إذا كنت تستخدم AnonymousCredential، مثل "https://myaccount.blob.core.windows.net/mycontainer/blob?sasString". يقبل هذا الأسلوب عنوان URL مشفرا أو عنوان URL غير مشفر يشير إلى كائن ثنائي كبير الحجم. لن يتم إلغاء سلسلة URL المشفرة مرتين، وسيتم إلغاء الأحرف الخاصة فقط في مسار URL. ومع ذلك، إذا كان اسم كائن ثنائي كبير الحجم يتضمن ؟ أو ٪، يجب ترميز اسم الكائن الثنائي كبير الحجم في عنوان URL. مثل كائن ثنائي كبير الحجم يسمى "my?blob٪"، يجب أن يكون عنوان URL "https://myaccount.blob.core.windows.net/mycontainer/my%3Fblob%25".

pipeline: PipelineLike

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

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

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.

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

containerName

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

string containerName

قيمة الخاصية

string

name

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

string name

قيمة الخاصية

string

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

accountName

accountName: string

قيمة الخاصية

string

موروث من StorageClient.accountName

credential

credential: StorageSharedKeyCredential | AnonymousCredential | TokenCredential

قيمة الخاصية

StorageSharedKeyCredential | AnonymousCredential | TokenCredential

موروث من StorageClient.credential

url

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

url: string

قيمة الخاصية

string

موروث من StorageClient.url

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

abortCopyFromURL(string, BlobAbortCopyFromURLOptions)

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

راجع https://docs.microsoft.com/en-us/rest/api/storageservices/abort-copy-blob

function abortCopyFromURL(copyId: string, options?: BlobAbortCopyFromURLOptions): Promise<BlobAbortCopyFromURLResponse>

المعلمات

copyId: string

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

options: BlobAbortCopyFromURLOptions

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

المرتجعات

Promise<BlobAbortCopyFromURLResponse>

beginCopyFromURL(string, BlobBeginCopyFromURLOptions)

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

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

راجع https://docs.microsoft.com/en-us/rest/api/storageservices/copy-blob

مثال على استخدام الاستقصاء التلقائي:

const copyPoller = await blobClient.beginCopyFromURL('url');
const result = await copyPoller.pollUntilDone();

مثال على استخدام الاستقصاء اليدوي:

const copyPoller = await blobClient.beginCopyFromURL('url');
while (!poller.isDone()) {
   await poller.poll();
}
const result = copyPoller.getResult();

مثال على استخدام تحديثات التقدم:

const copyPoller = await blobClient.beginCopyFromURL('url', {
  onProgress(state) {
    console.log(`Progress: ${state.copyProgress}`);
  }
});
const result = await copyPoller.pollUntilDone();

مثال باستخدام فاصل زمني متغير للاستقصاء (افتراضي 15 ثانية):

const copyPoller = await blobClient.beginCopyFromURL('url', {
  intervalInMs: 1000 // poll blob every 1 second for copy progress
});
const result = await copyPoller.pollUntilDone();

مثال على استخدام إلغاء النسخ:

const copyPoller = await blobClient.beginCopyFromURL('url');
// cancel operation after starting it.
try {
  await copyPoller.cancelOperation();
  // calls to get the result now throw PollerCancelledError
  await copyPoller.getResult();
} catch (err) {
  if (err.name === 'PollerCancelledError') {
    console.log('The copy was cancelled.');
  }
}

function beginCopyFromURL(copySource: string, options?: BlobBeginCopyFromURLOptions): Promise<PollerLikeWithCancellation<PollOperationState<BlobBeginCopyFromURLResponse>, BlobBeginCopyFromURLResponse>>

المعلمات

copySource: string

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

options: BlobBeginCopyFromURLOptions

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

المرتجعات

Promise<PollerLikeWithCancellation<PollOperationState<BlobBeginCopyFromURLResponse>, BlobBeginCopyFromURLResponse>>

createSnapshot(BlobCreateSnapshotOptions)

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

راجع https://docs.microsoft.com/en-us/rest/api/storageservices/snapshot-blob

function createSnapshot(options?: BlobCreateSnapshotOptions): Promise<BlobCreateSnapshotResponse>

المعلمات

options: BlobCreateSnapshotOptions

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

المرتجعات

Promise<BlobCreateSnapshotResponse>

delete(BlobDeleteOptions)

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

راجع https://docs.microsoft.com/en-us/rest/api/storageservices/delete-blob

function delete(options?: BlobDeleteOptions): Promise<BlobDeleteResponse>

المعلمات

options: BlobDeleteOptions

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

المرتجعات

Promise<BlobDeleteResponse>

deleteIfExists(BlobDeleteOptions)

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

راجع https://docs.microsoft.com/en-us/rest/api/storageservices/delete-blob

function deleteIfExists(options?: BlobDeleteOptions): Promise<BlobDeleteIfExistsResponse>

المعلمات

options: BlobDeleteOptions

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

المرتجعات

Promise<BlobDeleteIfExistsResponse>

deleteImmutabilityPolicy(BlobDeleteImmutabilityPolicyOptions)

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

function deleteImmutabilityPolicy(options?: BlobDeleteImmutabilityPolicyOptions): Promise<BlobDeleteImmutabilityPolicyResponse>

المعلمات

options: BlobDeleteImmutabilityPolicyOptions

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

المرتجعات

Promise<BlobDeleteImmutabilityPolicyResponse>

download(number, number, BlobDownloadOptions)

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

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

راجع https://docs.microsoft.com/en-us/rest/api/storageservices/get-blob

function download(offset?: number, count?: number, options?: BlobDownloadOptions): Promise<BlobDownloadResponseParsed>

المعلمات

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. بالنسبة للكائنات الثنائية كبيرة الحجم أكبر من هذا الحجم، ضع في اعتبارك downloadToFile.

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

المعلمات

buffer: Buffer

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

offset: number

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

count: number

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

options: BlobDownloadToBufferOptions

BlobDownloadToBufferOptions

المرتجعات

Promise<Buffer>

downloadToBuffer(number, number, BlobDownloadToBufferOptions)

متوفر فقط في وقت تشغيل NODE.JS.

function downloadToBuffer(offset?: number, count?: number, options?: BlobDownloadToBufferOptions): Promise<Buffer>

المعلمات

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): Promise<BlobDownloadResponseParsed>

المعلمات

filePath: string

offset: number

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

count: number

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

options: BlobDownloadOptions

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

المرتجعات

Promise<BlobDownloadResponseParsed>

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

exists(BlobExistsOptions)

إرجاع true إذا كان مورد Azure blob الذي يمثله هذا العميل موجودا؛ خطأ خلاف ذلك.

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

function exists(options?: BlobExistsOptions): Promise<boolean>

المعلمات

options: BlobExistsOptions

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

المرتجعات

Promise<boolean>

generateSasUrl(BlobGenerateSasUrlOptions)

متوفر فقط ل BlobClient الذي تم إنشاؤه باستخدام بيانات اعتماد مفتاح مشترك.

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

راجع https://docs.microsoft.com/en-us/rest/api/storageservices/constructing-a-service-sas

function generateSasUrl(options: BlobGenerateSasUrlOptions): Promise<string>

المعلمات

options: BlobGenerateSasUrlOptions

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

المرتجعات

Promise<string>

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

getAppendBlobClient()

إنشاء كائن AppendBlobClient.

function getAppendBlobClient(): AppendBlobClient

المرتجعات

AppendBlobClient

getBlobLeaseClient(string)

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

function getBlobLeaseClient(proposeLeaseId?: string): BlobLeaseClient

المعلمات

proposeLeaseId: string

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

المرتجعات

BlobLeaseClient

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

getBlockBlobClient()

إنشاء كائن BlockBlobClient.

function getBlockBlobClient(): BlockBlobClient

المرتجعات

BlockBlobClient

getPageBlobClient()

إنشاء كائن PageBlobClient.

function getPageBlobClient(): PageBlobClient

المرتجعات

PageBlobClient

getProperties(BlobGetPropertiesOptions)

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

راجع https://docs.microsoft.com/en-us/rest/api/storageservices/get-blob-properties

تحذير: metadata سيكون للكائن الذي تم إرجاعه في الاستجابة مفاتيحه بأحرف صغيرة، حتى لو كانت تحتوي في الأصل على أحرف كبيرة. يختلف هذا عن مفاتيح بيانات التعريف التي يتم إرجاعها بواسطة أساليب ContainerClient التي تسرد الكائنات الثنائية كبيرة الحجم باستخدام includeMetadata الخيار ، والتي ستحتفظ بأحرفها الأصلية.

function getProperties(options?: BlobGetPropertiesOptions): Promise<BlobGetPropertiesResponse>

المعلمات

options: BlobGetPropertiesOptions

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

المرتجعات

Promise<BlobGetPropertiesResponse>

getTags(BlobGetTagsOptions)

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

function getTags(options?: BlobGetTagsOptions): Promise<BlobGetTagsResponse>

المعلمات

options: BlobGetTagsOptions

المرتجعات

Promise<BlobGetTagsResponse>

setAccessTier(string, BlobSetTierOptions)

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

راجع https://docs.microsoft.com/en-us/rest/api/storageservices/set-blob-tier

function setAccessTier(tier: string, options?: BlobSetTierOptions): Promise<BlobSetTierResponse>

المعلمات

tier: string

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

options: BlobSetTierOptions

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

المرتجعات

Promise<BlobSetTierResponse>

setHTTPHeaders(BlobHTTPHeaders, BlobSetHTTPHeadersOptions)

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

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

راجع https://docs.microsoft.com/en-us/rest/api/storageservices/set-blob-properties

function setHTTPHeaders(blobHTTPHeaders?: BlobHTTPHeaders, options?: BlobSetHTTPHeadersOptions): Promise<BlobSetHTTPHeadersResponse>

المعلمات

blobHTTPHeaders: BlobHTTPHeaders

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

options: BlobSetHTTPHeadersOptions

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

المرتجعات

Promise<BlobSetHTTPHeadersResponse>

setImmutabilityPolicy(BlobImmutabilityPolicy, BlobSetImmutabilityPolicyOptions)

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

function setImmutabilityPolicy(immutabilityPolicy: BlobImmutabilityPolicy, options?: BlobSetImmutabilityPolicyOptions): Promise<BlobSetImmutabilityPolicyResponse>

المعلمات

immutabilityPolicy: BlobImmutabilityPolicy

options: BlobSetImmutabilityPolicyOptions

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

المرتجعات

Promise<BlobSetImmutabilityPolicyResponse>

setLegalHold(boolean, BlobSetLegalHoldOptions)

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

function setLegalHold(legalHoldEnabled: boolean, options?: BlobSetLegalHoldOptions): Promise<BlobSetLegalHoldResponse>

المعلمات

legalHoldEnabled: boolean

options: BlobSetLegalHoldOptions

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

المرتجعات

Promise<BlobSetLegalHoldResponse>

setMetadata(Metadata, BlobSetMetadataOptions)

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

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

راجع https://docs.microsoft.com/en-us/rest/api/storageservices/set-blob-metadata

function setMetadata(metadata?: Metadata, options?: BlobSetMetadataOptions): Promise<BlobSetMetadataResponse>

المعلمات

metadata: Metadata

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

options: BlobSetMetadataOptions

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

المرتجعات

Promise<BlobSetMetadataResponse>

setTags(Tags, BlobSetTagsOptions)

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

function setTags(tags: Tags, options?: BlobSetTagsOptions): Promise<BlobSetTagsResponse>

المعلمات

tags: Tags

options: BlobSetTagsOptions

المرتجعات

Promise<BlobSetTagsResponse>

syncCopyFromURL(string, BlobSyncCopyFromURLOptions)

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

راجع https://docs.microsoft.com/en-us/rest/api/storageservices/copy-blob-from-url

function syncCopyFromURL(copySource: string, options?: BlobSyncCopyFromURLOptions): Promise<BlobCopyFromURLResponse>

المعلمات

copySource: string

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

options: BlobSyncCopyFromURLOptions

المرتجعات

Promise<BlobCopyFromURLResponse>

undelete(BlobUndeleteOptions)

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

راجع https://docs.microsoft.com/en-us/rest/api/storageservices/undelete-blob

function undelete(options?: BlobUndeleteOptions): Promise<BlobUndeleteResponse>

المعلمات

options: BlobUndeleteOptions

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

المرتجعات

Promise<BlobUndeleteResponse>

withSnapshot(string)

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

function withSnapshot(snapshot: string): BlobClient

المعلمات

snapshot: string

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

المرتجعات

BlobClient

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

withVersion(string)

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

function withVersion(versionId: string): BlobClient

المعلمات

versionId: string

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

المرتجعات

BlobClient

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

مشاركة عبر

BlobClient class

المنشئون

الخصائص

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

الأساليب

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

BlobClient(string, PipelineLike)

المعلمات

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

المعلمات

BlobClient(string, string, string, StoragePipelineOptions)

المعلمات

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

containerName

قيمة الخاصية

name

قيمة الخاصية

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

accountName

قيمة الخاصية

credential

قيمة الخاصية

url

قيمة الخاصية

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

abortCopyFromURL(string, BlobAbortCopyFromURLOptions)

المعلمات

المرتجعات

beginCopyFromURL(string, BlobBeginCopyFromURLOptions)

المعلمات

المرتجعات

createSnapshot(BlobCreateSnapshotOptions)

المعلمات

المرتجعات

delete(BlobDeleteOptions)

المعلمات

المرتجعات

deleteIfExists(BlobDeleteOptions)

المعلمات

المرتجعات

deleteImmutabilityPolicy(BlobDeleteImmutabilityPolicyOptions)

المعلمات

المرتجعات

download(number, number, BlobDownloadOptions)

المعلمات

المرتجعات

downloadToBuffer(Buffer, number, number, BlobDownloadToBufferOptions)

المعلمات

المرتجعات

downloadToBuffer(number, number, BlobDownloadToBufferOptions)

المعلمات

المرتجعات

downloadToFile(string, number, number, BlobDownloadOptions)

المعلمات

المرتجعات

exists(BlobExistsOptions)

المعلمات

المرتجعات

generateSasUrl(BlobGenerateSasUrlOptions)

المعلمات

المرتجعات

getAppendBlobClient()

المرتجعات

getBlobLeaseClient(string)

المعلمات

المرتجعات

getBlockBlobClient()

المرتجعات

getPageBlobClient()

المرتجعات

getProperties(BlobGetPropertiesOptions)

المعلمات

المرتجعات

getTags(BlobGetTagsOptions)

المعلمات

المرتجعات

setAccessTier(string, BlobSetTierOptions)

المعلمات

المرتجعات