BlockBlobClient class

‏‏المرجع

الحزمة:: @azure/storage-blob

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

يمتد: BlobClient

المنشئون

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

الخصائص

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

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

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

الأساليب

commitBlockList(string[], BlockBlobCommitBlockListOptions)	يكتب كائن ثنائي كبير الحجم عن طريق تحديد قائمة معرفات الكتلة التي تشكل الكائن الثنائي كبير الحجم. لكي تتم كتابتها كجزء من كائن ثنائي كبير الحجم، يجب أن تكون كتلة قد تمت كتابتها بنجاح إلى الخادم في عملية stageBlock سابقة. يمكنك استدعاء commitBlockList لتحديث كائن ثنائي كبير الحجم عن طريق تحميل الكتل التي تغيرت فقط، ثم تثبيت الكتل الجديدة والحالية معا. أي كتل غير محددة في قائمة الكتل ويتم حذفها نهائيا. راجع https://docs.microsoft.com/rest/api/storageservices/put-block-list
getBlockList(BlockListType, BlockBlobGetBlockListOptions)	إرجاع قائمة الكتل التي تم تحميلها كجزء من كائن ثنائي كبير الحجم للكتلة باستخدام عامل تصفية قائمة الكتل المحدد. راجع https://docs.microsoft.com/rest/api/storageservices/get-block-list
query(string, BlockBlobQueryOptions)	متوفر فقط في وقت تشغيل NODE.JS. استعلام سريع لكائن ثنائي كبير الحجم بتنسيق JSON أو CSV. مثال على الاستخدام (Node.js): // Query and convert a blob to a string const queryBlockBlobResponse = await blockBlobClient.query("select * from BlobStorage"); const downloaded = (await streamToBuffer(queryBlockBlobResponse.readableStreamBody)).toString(); console.log("Query blob content:", downloaded); 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); }); }
stageBlock(string, RequestBodyType, number, BlockBlobStageBlockOptions)	تحميل الكتلة المحددة إلى "منطقة التقسيم المرحلي" للكتلة الثنائية كبيرة الحجم ليتم تثبيتها لاحقا عن طريق استدعاء إلى commitBlockList. راجع https://docs.microsoft.com/rest/api/storageservices/put-block
stageBlockFromURL(string, string, number, number, BlockBlobStageBlockFromURLOptions)	تنشئ عملية Stage Block From URL كتلة جديدة ليتم تثبيتها كجزء من كائن ثنائي كبير الحجم حيث تتم قراءة المحتويات من عنوان URL. تتوفر واجهة برمجة التطبيقات هذه بدءا من الإصدار 2018-03-28. راجع https://docs.microsoft.com/en-us/rest/api/storageservices/put-block-from-url
syncUploadFromURL(string, BlockBlobSyncUploadFromURLOptions)	إنشاء كائن ثنائي كبير الحجم جديد للكتلة حيث تتم قراءة محتويات الكائن الثنائي كبير الحجم من عنوان URL معين. يتم دعم واجهة برمجة التطبيقات هذه بدءا من إصدار 2020-04-08. التحديثات الجزئية غير مدعومة مع Put Blob من عنوان URL؛ تتم الكتابة فوق محتوى كائن ثنائي كبير الحجم موجود بمحتوى الكائن الثنائي كبير الحجم الجديد. لإجراء تحديثات جزئية لمحتويات كائن ثنائي كبير الحجم للكتلة باستخدام عنوان URL المصدر، استخدم stageBlockFromURL و commitBlockList.
upload(RequestBodyType, number, BlockBlobUploadOptions)	إنشاء كائن ثنائي كبير الحجم جديد للكتلة، أو تحديث محتوى كائن ثنائي كبير الحجم للكتلة موجود. يؤدي تحديث كائن ثنائي كبير الحجم للكتلة موجود إلى الكتابة فوق أي بيانات تعريف موجودة على الكائن الثنائي كبير الحجم. التحديثات الجزئية غير مدعومة؛ تتم الكتابة فوق محتوى الكائن الثنائي كبير الحجم الموجود بالمحتوى الجديد. لإجراء تحديث جزئي لكائن ثنائي كبير الحجم للكتلة، استخدم stageBlock و commitBlockList. هذه طريقة تحميل غير متوازية، يرجى استخدام uploadFile أو uploadStream أو uploadBrowserData للحصول على أداء أفضل مع تحميل التزامن. راجع https://docs.microsoft.com/rest/api/storageservices/put-blob
uploadBrowserData(Blob \| ArrayBuffer \| ArrayBufferView, BlockBlobParallelUploadOptions)	متوفر فقط في المستعرضات. تحميل كائن Blob/File/ArrayBuffer/ArrayBufferView لحظر الكائن الثنائي كبير الحجم. عندما يكون طول المخزن المؤقت أقل من أو يساوي 256 ميغابايت، سيستخدم هذا الأسلوب استدعاء تحميل 1 لإنهاء التحميل. وإلا، سيستدعي هذا الأسلوب stageBlock لتحميل الكتل، وأخيرا استدعاء commitBlockList لتثبيت قائمة الحظر. خيار blobHTTPHeaders الشائع لتعيينه هو `blobContentType`، ما يمكن المستعرض من توفير وظائف استنادا إلى نوع الملف.
uploadData(Blob \| ArrayBuffer \| ArrayBufferView \| Buffer, BlockBlobParallelUploadOptions)	تحميل مخزن مؤقت (Node.js)/كائن Blob (المتصفحات)/ArrayBuffer/ArrayBufferView إلى BlockBlob. عندما لا يزيد طول البيانات عن maxSingleShotSize المحدد (الافتراضي هو <xref:BLOCK_BLOB_MAX_UPLOAD_BLOB_BYTES>)، سيستخدم هذا الأسلوب استدعاء تحميل واحد لإنهاء التحميل. وإلا، سيستدعي هذا الأسلوب stageBlock لتحميل الكتل، وأخيرا استدعاء commitBlockList لتثبيت قائمة الحظر. خيار blobHTTPHeaders الشائع لتعيينه هو `blobContentType`، ما يمكن المستعرض من توفير وظائف استنادا إلى نوع الملف.
uploadFile(string, BlockBlobParallelUploadOptions)	متوفر فقط في وقت تشغيل NODE.JS. تحميل ملف محلي في كتل إلى كائن ثنائي كبير الحجم للكتلة. عندما يكون حجم الملف أقل من أو يساوي 256 ميغابايت، سيستخدم هذا الأسلوب استدعاء تحميل 1 لإنهاء التحميل. وإلا، سيستدعي هذا الأسلوب stageBlock لتحميل الكتل، وأخيرا استدعاء commitBlockList لتثبيت قائمة الحظر.
uploadStream(Readable, number, number, BlockBlobUploadStreamOptions)	متوفر فقط في وقت تشغيل NODE.JS. تحميل دفق Node.js قابل للقراءة إلى كائن ثنائي كبير الحجم للكتلة. تلميحات تحسين الأداء: تدفق الإدخال highWaterMark من الأفضل تعيين نفس القيمة باستخدام معلمة bufferSize، والتي ستتجنب عمليات Buffer.concat().
withSnapshot(string)	إنشاء كائن BlockBlobClient جديد مطابق للمصدر ولكن مع الطابع الزمني للقطة المحددة. سيؤدي توفير "" إلى إزالة اللقطة وإرجاع عنوان 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 والإصدارات الأحدث، يمكن أن يكون مصدر عملية نسخ كائن ثنائي كبير الحجم كائن ثنائي كبير الحجم ملتزما في أي حساب تخزين 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
withVersion(string)	إنشاء كائن BlobClient جديد يشير إلى إصدار من هذا الكائن الثنائي كبير الحجم. سيؤدي توفير "" إلى إزالة versionId وإرجاع عميل إلى الكائن الثنائي كبير الحجم الأساسي.

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

BlockBlobClient(string, PipelineLike)

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

new BlockBlobClient(url: string, pipeline: PipelineLike)

المعلمات

url: string

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

pipeline: PipelineLike

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

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

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

المعلمات

url: string

credential: StorageSharedKeyCredential | AnonymousCredential | TokenCredential

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

options: StoragePipelineOptions

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

BlockBlobClient(string, string, string, StoragePipelineOptions)

إنشاء مثيل BlockBlobClient.

new BlockBlobClient(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

موروث منBlobClient.accountName

credential

credential: StorageSharedKeyCredential | AnonymousCredential | TokenCredential

قيمة الخاصية

StorageSharedKeyCredential | AnonymousCredential | TokenCredential

موروث منBlobClient.credential

url

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

url: string

قيمة الخاصية

string

موروث منBlobClient.url

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

commitBlockList(string[], BlockBlobCommitBlockListOptions)

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

راجع https://docs.microsoft.com/rest/api/storageservices/put-block-list

function commitBlockList(blocks: string[], options?: BlockBlobCommitBlockListOptions): Promise<BlockBlobCommitBlockListResponse>

المعلمات

blocks: string[]

صفيف من قيمة 64 بايت مرمزة ب base64

options: BlockBlobCommitBlockListOptions

خيارات لعملية Block Blob Commit Block List.

المرتجعات

Promise<BlockBlobCommitBlockListResponse>

بيانات الاستجابة لعملية Block Blob Commit Block List.

getBlockList(BlockListType, BlockBlobGetBlockListOptions)

إرجاع قائمة الكتل التي تم تحميلها كجزء من كائن ثنائي كبير الحجم للكتلة باستخدام عامل تصفية قائمة الكتل المحدد.

راجع https://docs.microsoft.com/rest/api/storageservices/get-block-list

function getBlockList(listType: BlockListType, options?: BlockBlobGetBlockListOptions): Promise<BlockBlobGetBlockListResponse>

المعلمات

listType: BlockListType

يحدد ما إذا كان يجب إرجاع قائمة الكتل الملتزم بها أو قائمة الكتل غير الملتزم بها أو كلتا القائمتين معا.

options: BlockBlobGetBlockListOptions

خيارات لعملية Block Blob Get Block List.

المرتجعات

Promise<BlockBlobGetBlockListResponse>

بيانات الاستجابة لعملية Block Blob Get Block List.

query(string, BlockBlobQueryOptions)

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

استعلام سريع لكائن ثنائي كبير الحجم بتنسيق JSON أو CSV.

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

// Query and convert a blob to a string
const queryBlockBlobResponse = await blockBlobClient.query("select * from BlobStorage");
const downloaded = (await streamToBuffer(queryBlockBlobResponse.readableStreamBody)).toString();
console.log("Query blob content:", downloaded);

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);
  });
}

function query(query: string, options?: BlockBlobQueryOptions): Promise<BlobDownloadResponseModel>

المعلمات

query: string

options: BlockBlobQueryOptions

المرتجعات

Promise<BlobDownloadResponseModel>

stageBlock(string, RequestBodyType, number, BlockBlobStageBlockOptions)

تحميل الكتلة المحددة إلى "منطقة التقسيم المرحلي" للكتلة الثنائية كبيرة الحجم ليتم تثبيتها لاحقا عن طريق استدعاء إلى commitBlockList.

راجع https://docs.microsoft.com/rest/api/storageservices/put-block

function stageBlock(blockId: string, body: RequestBodyType, contentLength: number, options?: BlockBlobStageBlockOptions): Promise<BlockBlobStageBlockResponse>

المعلمات

blockId: string

قيمة 64 بايت مرمزة ب base64

body: HttpRequestBody

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

contentLength: number

عدد وحدات البايت المراد تحميلها.

options: BlockBlobStageBlockOptions

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

المرتجعات

Promise<BlockBlobStageBlockResponse>

بيانات الاستجابة لعملية Block Blob Stage Block.

stageBlockFromURL(string, string, number, number, BlockBlobStageBlockFromURLOptions)

تنشئ عملية Stage Block From URL كتلة جديدة ليتم تثبيتها كجزء من كائن ثنائي كبير الحجم حيث تتم قراءة المحتويات من عنوان URL. تتوفر واجهة برمجة التطبيقات هذه بدءا من الإصدار 2018-03-28.

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

function stageBlockFromURL(blockId: string, sourceURL: string, offset?: number, count?: number, options?: BlockBlobStageBlockFromURLOptions): Promise<BlockBlobStageBlockFromURLResponse>

المعلمات

blockId: string

قيمة 64 بايت مرمزة ب base64

sourceURL: string

يحدد عنوان URL للكائن الثنائي كبير الحجم. قد تكون القيمة عنوان URL يصل إلى 2 كيلوبايت في الطول يحدد كائن ثنائي كبير الحجم. يجب أن تكون القيمة مشفرة بعنوان URL كما تظهر في طلب URI. يجب أن يكون الكائن الثنائي كبير الحجم المصدر عاما أو يجب مصادقته عبر توقيع وصول مشترك. إذا كان الكائن الثنائي كبير الحجم المصدر عاما، فلن تكون هناك حاجة إلى مصادقة لتنفيذ العملية. فيما يلي بعض الأمثلة على عناوين URL للكائن المصدر: - https://myaccount.blob.core.windows.net/mycontainer/myblob - https://myaccount.blob.core.windows.net/mycontainer/myblob?snapshot=

offset: number

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

count: number

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

options: BlockBlobStageBlockFromURLOptions

خيارات لعملية Block Blob Stage Block From URL.

المرتجعات

Promise<BlockBlobStageBlockFromURLResponse>

بيانات الاستجابة لعملية Block Blob Stage Block From URL.

syncUploadFromURL(string, BlockBlobSyncUploadFromURLOptions)

إنشاء كائن ثنائي كبير الحجم جديد للكتلة حيث تتم قراءة محتويات الكائن الثنائي كبير الحجم من عنوان URL معين. يتم دعم واجهة برمجة التطبيقات هذه بدءا من إصدار 2020-04-08. التحديثات الجزئية غير مدعومة مع Put Blob من عنوان URL؛ تتم الكتابة فوق محتوى كائن ثنائي كبير الحجم موجود بمحتوى الكائن الثنائي كبير الحجم الجديد. لإجراء تحديثات جزئية لمحتويات كائن ثنائي كبير الحجم للكتلة باستخدام عنوان URL المصدر، استخدم stageBlockFromURL و commitBlockList.

function syncUploadFromURL(sourceURL: string, options?: BlockBlobSyncUploadFromURLOptions): Promise<BlockBlobPutBlobFromUrlResponse>

المعلمات

sourceURL: string

options: BlockBlobSyncUploadFromURLOptions

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

المرتجعات

Promise<BlockBlobPutBlobFromUrlResponse>

upload(RequestBodyType, number, BlockBlobUploadOptions)

إنشاء كائن ثنائي كبير الحجم جديد للكتلة، أو تحديث محتوى كائن ثنائي كبير الحجم للكتلة موجود. يؤدي تحديث كائن ثنائي كبير الحجم للكتلة موجود إلى الكتابة فوق أي بيانات تعريف موجودة على الكائن الثنائي كبير الحجم. التحديثات الجزئية غير مدعومة؛ تتم الكتابة فوق محتوى الكائن الثنائي كبير الحجم الموجود بالمحتوى الجديد. لإجراء تحديث جزئي لكائن ثنائي كبير الحجم للكتلة، استخدم stageBlock و commitBlockList.

هذه طريقة تحميل غير متوازية، يرجى استخدام uploadFile أو uploadStream أو uploadBrowserData للحصول على أداء أفضل مع تحميل التزامن.

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

function upload(body: RequestBodyType, contentLength: number, options?: BlockBlobUploadOptions): Promise<BlockBlobUploadResponse>

المعلمات

body: HttpRequestBody

كائن ثنائي كبير الحجم أو سلسلة أو ArrayBuffer أو ArrayBufferView أو دالة ترجع دفقا جديدا قابلا للقراءة تكون إزاحته من بداية مصدر البيانات.

contentLength: number

طول الجسم بالبايت. استخدم Buffer.byteLength() لحساب طول النص الأساسي لسلسلة بما في ذلك الأحرف غير المرمزة ب Base64/Hex.

options: BlockBlobUploadOptions

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

المرتجعات

Promise<BlockBlobUploadResponse>

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

استخدام المثال:

const content = "Hello world!";
const uploadBlobResponse = await blockBlobClient.upload(content, content.length);

uploadBrowserData(Blob | ArrayBuffer | ArrayBufferView, BlockBlobParallelUploadOptions)

تحذير

واجهة برمجة التطبيقات هذه مهملة الآن.

Use uploadData instead.

متوفر فقط في المستعرضات.

تحميل كائن Blob/File/ArrayBuffer/ArrayBufferView لحظر الكائن الثنائي كبير الحجم.

عندما يكون طول المخزن المؤقت أقل من أو يساوي 256 ميغابايت، سيستخدم هذا الأسلوب استدعاء تحميل 1 لإنهاء التحميل. وإلا، سيستدعي هذا الأسلوب stageBlock لتحميل الكتل، وأخيرا استدعاء commitBlockList لتثبيت قائمة الحظر.

خيار blobHTTPHeaders الشائع لتعيينه هو blobContentType، ما يمكن المستعرض من توفير وظائف استنادا إلى نوع الملف.

function uploadBrowserData(browserData: Blob | ArrayBuffer | ArrayBufferView, options?: BlockBlobParallelUploadOptions): Promise<BlobUploadCommonResponse>

المعلمات

browserData: Blob | ArrayBuffer | ArrayBufferView

Blob أو File أو ArrayBuffer أو ArrayBufferView

options: BlockBlobParallelUploadOptions

خيارات لتحميل بيانات المستعرض.

المرتجعات

Promise<BlobUploadCommonResponse>

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

uploadData(Blob | ArrayBuffer | ArrayBufferView | Buffer, BlockBlobParallelUploadOptions)

تحميل مخزن مؤقت (Node.js)/كائن Blob (المتصفحات)/ArrayBuffer/ArrayBufferView إلى BlockBlob.

عندما لا يزيد طول البيانات عن maxSingleShotSize المحدد (الافتراضي هو <xref:BLOCK_BLOB_MAX_UPLOAD_BLOB_BYTES>)، سيستخدم هذا الأسلوب استدعاء تحميل واحد لإنهاء التحميل. وإلا، سيستدعي هذا الأسلوب stageBlock لتحميل الكتل، وأخيرا استدعاء commitBlockList لتثبيت قائمة الحظر.

خيار blobHTTPHeaders الشائع لتعيينه هو blobContentType، ما يمكن المستعرض من توفير وظائف استنادا إلى نوع الملف.

function uploadData(data: Blob | ArrayBuffer | ArrayBufferView | Buffer, options?: BlockBlobParallelUploadOptions): Promise<BlobUploadCommonResponse>

المعلمات

data: Blob | ArrayBuffer | ArrayBufferView | Buffer

المخزن المؤقت (Node.js) أو Blob أو ArrayBuffer أو ArrayBufferView

options: BlockBlobParallelUploadOptions

المرتجعات

Promise<BlobUploadCommonResponse>

uploadFile(string, BlockBlobParallelUploadOptions)

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

تحميل ملف محلي في كتل إلى كائن ثنائي كبير الحجم للكتلة.

عندما يكون حجم الملف أقل من أو يساوي 256 ميغابايت، سيستخدم هذا الأسلوب استدعاء تحميل 1 لإنهاء التحميل. وإلا، سيستدعي هذا الأسلوب stageBlock لتحميل الكتل، وأخيرا استدعاء commitBlockList لتثبيت قائمة الحظر.

function uploadFile(filePath: string, options?: BlockBlobParallelUploadOptions): Promise<BlobUploadCommonResponse>

المعلمات

filePath: string

المسار الكامل للملف المحلي

options: BlockBlobParallelUploadOptions

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

المرتجعات

Promise<BlobUploadCommonResponse>

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

uploadStream(Readable, number, number, BlockBlobUploadStreamOptions)

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

تحميل دفق Node.js قابل للقراءة إلى كائن ثنائي كبير الحجم للكتلة.

تلميحات تحسين الأداء:

تدفق الإدخال highWaterMark من الأفضل تعيين نفس القيمة باستخدام معلمة bufferSize، والتي ستتجنب عمليات Buffer.concat().

function uploadStream(stream: Readable, bufferSize?: number, maxConcurrency?: number, options?: BlockBlobUploadStreamOptions): Promise<BlobUploadCommonResponse>

المعلمات

stream: Readable

Node.js دفق قابل للقراءة

bufferSize: number

حجم كل مخزن مؤقت مخصص، أيضا حجم الكتلة في الكائن الثنائي كبير الحجم للكتلة التي تم تحميلها. القيمة الافتراضية هي 8 ميغابايت

maxConcurrency: number

يشير الحد الأقصى للتزامن إلى الحد الأقصى لعدد المخازن المؤقتة التي يمكن تخصيصها، والارتباط الإيجابي مع الحد الأقصى للتزامن في التحميل. القيمة الافتراضية هي 5

options: BlockBlobUploadStreamOptions

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

المرتجعات

Promise<BlobUploadCommonResponse>

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

withSnapshot(string)

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

function withSnapshot(snapshot: string): BlockBlobClient

المعلمات

snapshot: string

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

المرتجعات

BlockBlobClient

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

تفاصيل الأساليب المتوارثة

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>

موروث منBlobClient.abortCopyFromURL

beginCopyFromURL(string, BlobBeginCopyFromURLOptions)

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

في الإصدار 2012-02-12 والإصدارات الأحدث، يمكن أن يكون مصدر عملية نسخ كائن ثنائي كبير الحجم كائن ثنائي كبير الحجم ملتزما في أي حساب تخزين 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>>

موروث منBlobClient.beginCopyFromURL

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>

موروث منBlobClient.createSnapshot

delete(BlobDeleteOptions)

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

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

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

المعلمات

options: BlobDeleteOptions

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

المرتجعات

Promise<BlobDeleteResponse>

موروث منBlobClient.delete

deleteIfExists(BlobDeleteOptions)

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

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

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

المعلمات

options: BlobDeleteOptions

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

المرتجعات

Promise<BlobDeleteIfExistsResponse>

موروث منBlobClient.deleteIfExists

deleteImmutabilityPolicy(BlobDeleteImmutabilityPolicyOptions)

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

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

المعلمات

options: BlobDeleteImmutabilityPolicyOptions

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

المرتجعات

Promise<BlobDeleteImmutabilityPolicyResponse>

موروث منBlobClient.deleteImmutabilityPolicy

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>

موروث منBlobClient.download

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>

موروث منBlobClient.downloadToBuffer

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>

موروث منBlobClient.downloadToBuffer

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 إلى غير معرف نظرا لأن محتواه تمت قراءته وكتابته بالفعل في ملف محلي في المسار المحدد.

موروث منBlobClient.downloadToFile

exists(BlobExistsOptions)

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

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

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

المعلمات

options: BlobExistsOptions

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

المرتجعات

Promise<boolean>

موروث منBlobClient.exists

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 الذي تم إنشاؤه.

موروث منBlobClient.generateSasUrl

getAppendBlobClient()

إنشاء كائن AppendBlobClient.

function getAppendBlobClient(): AppendBlobClient

المرتجعات

AppendBlobClient

موروث منBlobClient.getAppendBlobClient

getBlobLeaseClient(string)

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

function getBlobLeaseClient(proposeLeaseId?: string): BlobLeaseClient

المعلمات

proposeLeaseId: string

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

المرتجعات

BlobLeaseClient

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

موروث منBlobClient.getBlobLeaseClient

getBlockBlobClient()

إنشاء كائن BlockBlobClient.

function getBlockBlobClient(): BlockBlobClient

المرتجعات

BlockBlobClient

موروث منBlobClient.getBlockBlobClient

getPageBlobClient()

إنشاء كائن PageBlobClient.

function getPageBlobClient(): PageBlobClient

المرتجعات

PageBlobClient

موروث منBlobClient.getPageBlobClient

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>

موروث منBlobClient.getProperties

getTags(BlobGetTagsOptions)

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

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

المعلمات

options: BlobGetTagsOptions

المرتجعات

Promise<BlobGetTagsResponse>

موروث منBlobClient.getTags

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>

موروث منBlobClient.setAccessTier

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>

موروث منBlobClient.setHTTPHeaders

setImmutabilityPolicy(BlobImmutabilityPolicy, BlobSetImmutabilityPolicyOptions)

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

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

المعلمات

immutabilityPolicy: BlobImmutabilityPolicy

options: BlobSetImmutabilityPolicyOptions

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

المرتجعات

Promise<BlobSetImmutabilityPolicyResponse>

موروث منBlobClient.setImmutabilityPolicy

setLegalHold(boolean, BlobSetLegalHoldOptions)

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

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

المعلمات

legalHoldEnabled: boolean

options: BlobSetLegalHoldOptions

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

المرتجعات

Promise<BlobSetLegalHoldResponse>

موروث منBlobClient.setLegalHold

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>

موروث منBlobClient.setMetadata

setTags(Tags, BlobSetTagsOptions)

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

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

المعلمات

tags: Tags

options: BlobSetTagsOptions

المرتجعات

Promise<BlobSetTagsResponse>

موروث منBlobClient.setTags

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>

موروث منBlobClient.syncCopyFromURL

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>

موروث منBlobClient.undelete

withVersion(string)

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

function withVersion(versionId: string): BlobClient

المعلمات

versionId: string

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

المرتجعات

BlobClient

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

موروث منBlobClient.withVersion

مشاركة عبر

BlockBlobClient class

المنشئون

الخصائص

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

الأساليب

الأساليب المتوارثة

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

BlockBlobClient(string, PipelineLike)

المعلمات

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

المعلمات

BlockBlobClient(string, string, string, StoragePipelineOptions)

المعلمات

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

containerName

قيمة الخاصية

name

قيمة الخاصية

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

accountName

قيمة الخاصية

credential

قيمة الخاصية

url

قيمة الخاصية

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

commitBlockList(string[], BlockBlobCommitBlockListOptions)

المعلمات

المرتجعات

getBlockList(BlockListType, BlockBlobGetBlockListOptions)

المعلمات

المرتجعات

query(string, BlockBlobQueryOptions)

المعلمات

المرتجعات

stageBlock(string, RequestBodyType, number, BlockBlobStageBlockOptions)

المعلمات

المرتجعات

stageBlockFromURL(string, string, number, number, BlockBlobStageBlockFromURLOptions)

المعلمات

المرتجعات

syncUploadFromURL(string, BlockBlobSyncUploadFromURLOptions)

المعلمات

المرتجعات

upload(RequestBodyType, number, BlockBlobUploadOptions)

المعلمات

المرتجعات

uploadBrowserData(Blob | ArrayBuffer | ArrayBufferView, BlockBlobParallelUploadOptions)

المعلمات

المرتجعات

uploadData(Blob | ArrayBuffer | ArrayBufferView | Buffer, BlockBlobParallelUploadOptions)

المعلمات

المرتجعات

uploadFile(string, BlockBlobParallelUploadOptions)

المعلمات

المرتجعات

uploadStream(Readable, number, number, BlockBlobUploadStreamOptions)

المعلمات

المرتجعات

withSnapshot(string)

المعلمات

المرتجعات

تفاصيل الأساليب المتوارثة

abortCopyFromURL(string, BlobAbortCopyFromURLOptions)

المعلمات

المرتجعات

beginCopyFromURL(string, BlobBeginCopyFromURLOptions)

المعلمات

المرتجعات

createSnapshot(BlobCreateSnapshotOptions)

المعلمات

المرتجعات

delete(BlobDeleteOptions)

المعلمات

المرتجعات

deleteIfExists(BlobDeleteOptions)

المعلمات

المرتجعات

deleteImmutabilityPolicy(BlobDeleteImmutabilityPolicyOptions)