BlockBlobClient class

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

Extends

المنشئون

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.

الخصائص

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 أو بعد ذلك بعملية نسخ كائن ثنائي كبير الحجم للنسخ من حساب تخزين آخر.

commitBlockList(string[], BlockBlobCommitBlockListOptions)

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

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.

getBlockList(BlockListType, BlockBlobGetBlockListOptions)

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

getPageBlobClient()

إنشاء كائن PageBlobClient.

getProperties(BlobGetPropertiesOptions)

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

getTags(BlobGetTagsOptions)

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

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);
  });
}
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)، ومساحة (' ')، بالإضافة إلى ('+')، وطرح ('-')، ونقطة ('.')، وشرطة مائلة للأمام ('/')، ونقاط النقطتين (':')، وتساوي ('=')، وتسطير سفلي ('_') .

stageBlock(string, HttpRequestBody, number, BlockBlobStageBlockOptions)

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

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

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

syncCopyFromURL(string, BlobSyncCopyFromURLOptions)

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

syncUploadFromURL(string, BlockBlobSyncUploadFromURLOptions)

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

undelete(BlobUndeleteOptions)

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

upload(HttpRequestBody, number, BlockBlobUploadOptions)

إنشاء كائن ثنائي كبير الحجم للكتلة جديد، أو تحديث محتوى كائن ثنائي كبير الحجم للكتلة موجود. يؤدي تحديث كائن ثنائي كبير الحجم للكتلة موجود إلى الكتابة فوق أي بيانات تعريف موجودة على الكائن الثنائي كبير الحجم. التحديثات الجزئية غير مدعومة؛ تتم الكتابة فوق محتوى الكائن الثنائي كبير الحجم الموجود بالمحتوى الجديد. لإجراء تحديث جزئي لكائن ثنائي كبير الحجم للكتلة، استخدم <xref:stageBlock> و <xref:commitBlockList>. هذه طريقة تحميل غير متوازية، يرجى استخدام <xref:uploadFile>أو <xref:uploadStream><xref:uploadBrowserData> للحصول على أداء أفضل مع تحميل التزامن.

uploadBrowserData(Blob | ArrayBuffer | ArrayBufferView, BlockBlobParallelUploadOptions)

متوفر فقط في المستعرضات. تحميل كائن Blob/File/ArrayBuffer/ArrayBufferView لحظر الكائن الثنائي كبير الحجم.

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

أحد الخيارات الشائعة <xref:BlockBlobParallelUploadOptions.blobHTTPHeaders> التي يجب تعيينها هو blobContentType، مما يمكن المستعرض من توفير وظائف استنادا إلى نوع الملف.

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

تحميل المخزن المؤقت (Node.js)/كائن Blob(المتصفحات)/ArrayBuffer/ArrayBufferView إلى BlockBlob. عندما لا يزيد طول البيانات عن المحدد <xref:BlockBlobParallelUploadOptions.maxSingleShotSize> (الافتراضي هو <xref:BLOCK_BLOB_MAX_UPLOAD_BLOB_BYTES>)، سيستخدم هذا الأسلوب استدعاء واحد <xref:upload> لإنهاء التحميل. وإلا، سيستدعي <xref:stageBlock> هذا الأسلوب لتحميل الكتل، وأخيرا استدعاء <xref:commitBlockList> لتثبيت قائمة الحظر.

أحد الخيارات الشائعة <xref:BlockBlobParallelUploadOptions.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 إلى الكائن الثنائي كبير الحجم الأساسي.

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)

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

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

المعلمات

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".

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.

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

accountName

accountName: string

قيمة الخاصية

string

containerName

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

string containerName

قيمة الخاصية

string

credential

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

credential: 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.

المرتجعات

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>>

commitBlockList(string[], BlockBlobCommitBlockListOptions)

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

function commitBlockList(blocks: string[], options?: BlockBlobCommitBlockListOptions)

المعلمات

blocks

string[]

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

options
BlockBlobCommitBlockListOptions

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

المرتجعات

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

createSnapshot(BlobCreateSnapshotOptions)

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

function createSnapshot(options?: BlobCreateSnapshotOptions)

المعلمات

options
BlobCreateSnapshotOptions

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

المرتجعات

delete(BlobDeleteOptions)

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

function delete(options?: BlobDeleteOptions)

المعلمات

options
BlobDeleteOptions

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

المرتجعات

deleteIfExists(BlobDeleteOptions)

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

function deleteIfExists(options?: BlobDeleteOptions)

المعلمات

options
BlobDeleteOptions

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

المرتجعات

deleteImmutabilityPolicy(BlobDeleteImmutabilityPolicyOptions)

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

function deleteImmutabilityPolicy(options?: BlobDeleteImmutabilityPolicyOptions)

المعلمات

options
BlobDeleteImmutabilityPolicyOptions

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

المرتجعات

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

المرتجعات

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

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

المرتجعات

بيانات الاستجابة لعملية تنزيل الكائن الثنائي كبير الحجم، ولكن مع تعيين 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()

المرتجعات

getBlobLeaseClient(string)

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

function getBlobLeaseClient(proposeLeaseId?: string)

المعلمات

proposeLeaseId

string

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

المرتجعات

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

getBlockBlobClient()

إنشاء كائن BlockBlobClient.

function getBlockBlobClient()

المرتجعات

getBlockList(BlockListType, BlockBlobGetBlockListOptions)

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

function getBlockList(listType: BlockListType, options?: BlockBlobGetBlockListOptions)

المعلمات

listType
BlockListType

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

options
BlockBlobGetBlockListOptions

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

المرتجعات

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

getPageBlobClient()

إنشاء كائن PageBlobClient.

function getPageBlobClient()

المرتجعات

getProperties(BlobGetPropertiesOptions)

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

function getProperties(options?: BlobGetPropertiesOptions)

المعلمات

options
BlobGetPropertiesOptions

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

المرتجعات

getTags(BlobGetTagsOptions)

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

function getTags(options?: BlobGetTagsOptions)

المعلمات

المرتجعات

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)

المعلمات

query

string

المرتجعات

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.

المرتجعات

setHTTPHeaders(BlobHTTPHeaders, BlobSetHTTPHeadersOptions)

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

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

المعلمات

blobHTTPHeaders
BlobHTTPHeaders

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

options
BlobSetHTTPHeadersOptions

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

المرتجعات

setImmutabilityPolicy(BlobImmutabilityPolicy, BlobSetImmutabilityPolicyOptions)

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

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

المعلمات

immutabilityPolicy
BlobImmutabilityPolicy
options
BlobSetImmutabilityPolicyOptions

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

المرتجعات

setLegalHold(boolean, BlobSetLegalHoldOptions)

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

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

المعلمات

legalHoldEnabled

boolean

options
BlobSetLegalHoldOptions

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

المرتجعات

setMetadata(Metadata, BlobSetMetadataOptions)

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

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

المعلمات

metadata
Metadata

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

options
BlobSetMetadataOptions

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

المرتجعات

setTags(Tags, BlobSetTagsOptions)

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

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

المعلمات

tags
Tags

المرتجعات

stageBlock(string, HttpRequestBody, number, BlockBlobStageBlockOptions)

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

function stageBlock(blockId: string, body: HttpRequestBody, contentLength: number, options?: BlockBlobStageBlockOptions)

المعلمات

blockId

string

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

body

HttpRequestBody

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

contentLength

number

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

options
BlockBlobStageBlockOptions

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

المرتجعات

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

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

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

function stageBlockFromURL(blockId: string, sourceURL: string, offset?: number, count?: number, options?: BlockBlobStageBlockFromURLOptions)

المعلمات

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.

المرتجعات

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

syncCopyFromURL(string, BlobSyncCopyFromURLOptions)

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

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

المعلمات

copySource

string

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

المرتجعات

syncUploadFromURL(string, BlockBlobSyncUploadFromURLOptions)

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

function syncUploadFromURL(sourceURL: string, options?: BlockBlobSyncUploadFromURLOptions)

المعلمات

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=

options
BlockBlobSyncUploadFromURLOptions

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

المرتجعات

undelete(BlobUndeleteOptions)

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

function undelete(options?: BlobUndeleteOptions)

المعلمات

options
BlobUndeleteOptions

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

المرتجعات

upload(HttpRequestBody, number, BlockBlobUploadOptions)

إنشاء كائن ثنائي كبير الحجم للكتلة جديد، أو تحديث محتوى كائن ثنائي كبير الحجم للكتلة موجود. يؤدي تحديث كائن ثنائي كبير الحجم للكتلة موجود إلى الكتابة فوق أي بيانات تعريف موجودة على الكائن الثنائي كبير الحجم. التحديثات الجزئية غير مدعومة؛ تتم الكتابة فوق محتوى الكائن الثنائي كبير الحجم الموجود بالمحتوى الجديد. لإجراء تحديث جزئي لكائن ثنائي كبير الحجم للكتلة، استخدم <xref:stageBlock> و <xref:commitBlockList>. هذه طريقة تحميل غير متوازية، يرجى استخدام <xref:uploadFile>أو <xref:uploadStream><xref:uploadBrowserData> للحصول على أداء أفضل مع تحميل التزامن.

function upload(body: HttpRequestBody, contentLength: number, options?: BlockBlobUploadOptions)

المعلمات

body

HttpRequestBody

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

contentLength

number

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

options
BlockBlobUploadOptions

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

المرتجعات

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

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

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

uploadBrowserData(Blob | ArrayBuffer | ArrayBufferView, BlockBlobParallelUploadOptions)

تحذير

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

Use <xref:uploadData> instead.

متوفر فقط في المستعرضات. تحميل كائن Blob/File/ArrayBuffer/ArrayBufferView لحظر الكائن الثنائي كبير الحجم.

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

أحد الخيارات الشائعة <xref:BlockBlobParallelUploadOptions.blobHTTPHeaders> التي يجب تعيينها هو blobContentType، مما يمكن المستعرض من توفير وظائف استنادا إلى نوع الملف.

function uploadBrowserData(browserData: Blob | ArrayBuffer | ArrayBufferView, options?: BlockBlobParallelUploadOptions)

المعلمات

browserData

Blob | ArrayBuffer | ArrayBufferView

Blob أو File أو ArrayBuffer أو ArrayBufferView

options
BlockBlobParallelUploadOptions

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

المرتجعات

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

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

تحميل المخزن المؤقت (Node.js)/كائن Blob(المتصفحات)/ArrayBuffer/ArrayBufferView إلى BlockBlob. عندما لا يزيد طول البيانات عن المحدد <xref:BlockBlobParallelUploadOptions.maxSingleShotSize> (الافتراضي هو <xref:BLOCK_BLOB_MAX_UPLOAD_BLOB_BYTES>)، سيستخدم هذا الأسلوب استدعاء واحد <xref:upload> لإنهاء التحميل. وإلا، سيستدعي <xref:stageBlock> هذا الأسلوب لتحميل الكتل، وأخيرا استدعاء <xref:commitBlockList> لتثبيت قائمة الحظر.

أحد الخيارات الشائعة <xref:BlockBlobParallelUploadOptions.blobHTTPHeaders> التي يجب تعيينها هو blobContentType، مما يمكن المستعرض من توفير وظائف استنادا إلى نوع الملف.

function uploadData(data: Buffer | Blob | ArrayBuffer | ArrayBufferView, options?: BlockBlobParallelUploadOptions)

المعلمات

data

Buffer | Blob | ArrayBuffer | ArrayBufferView

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

المرتجعات

uploadFile(string, BlockBlobParallelUploadOptions)

متوفر فقط في وقت تشغيل NODE.JS. تحميل ملف محلي في كتل إلى كائن ثنائي كبير الحجم للكتلة.

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

function uploadFile(filePath: string, options?: BlockBlobParallelUploadOptions)

المعلمات

filePath

string

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

options
BlockBlobParallelUploadOptions

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

المرتجعات

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

uploadStream(Readable, number, number, BlockBlobUploadStreamOptions)

متوفر فقط في وقت تشغيل NODE.JS. تحميل دفق Node.js قابل للقراءة إلى كائن ثنائي كبير الحجم للكتلة.

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

  • تدفق الإدخال highWaterMark من الأفضل تعيين نفس القيمة باستخدام معلمة bufferSize، والتي ستتجنب عمليات Buffer.concat().
function uploadStream(stream: Readable, bufferSize?: number, maxConcurrency?: number, options?: BlockBlobUploadStreamOptions)

المعلمات

stream

Readable

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

bufferSize

number

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

maxConcurrency

number

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

options
BlockBlobUploadStreamOptions

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

المرتجعات

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

withSnapshot(string)

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

function withSnapshot(snapshot: string)

المعلمات

snapshot

string

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

المرتجعات

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

withVersion(string)

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

function withVersion(versionId: string)

المعلمات

versionId

string

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

المرتجعات

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