AppendBlobClient class

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

يمتد

المنشئون

AppendBlobClient(string, PipelineLike)

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

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

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

AppendBlobClient(string, string, string, StoragePipelineOptions)

إنشاء مثيل AppendBlobClient.

الخصائص

containerName

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

name

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

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

accountName
credential

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

url

قيمة سلسلة URL المرمزة.

الأساليب

appendBlock(RequestBodyType, number, AppendBlobAppendBlockOptions)

تثبيت كتلة جديدة من البيانات في نهاية الكائن الثنائي كبير الحجم الموجود للإلحاق.

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

appendBlockFromURL(string, number, number, AppendBlobAppendBlockFromURLOptions)

تقوم عملية Append Block بتثبيت كتلة جديدة من البيانات إلى نهاية كائن ثنائي كبير الحجم للإلحاق موجود حيث تتم قراءة المحتويات من عنوان URL المصدر.

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

create(AppendBlobCreateOptions)

إنشاء كائن ثنائي كبير الحجم للإلحاق بطول 0. استدعاء AppendBlock لإلحاق البيانات إلى كائن ثنائي كبير الحجم للإلحاق.

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

createIfNotExists(AppendBlobCreateIfNotExistsOptions)

إنشاء كائن ثنائي كبير الحجم للإلحاق بطول 0. استدعاء AppendBlock لإلحاق البيانات إلى كائن ثنائي كبير الحجم للإلحاق. إذا كان الكائن الثنائي كبير الحجم بنفس الاسم موجودا بالفعل، فسيظل محتوى الكائن الثنائي كبير الحجم الموجود دون تغيير.

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

seal(AppendBlobSealOptions)

ختم الكائن الثنائي كبير الحجم للإلحاق، مما يجعله للقراءة فقط.

withSnapshot(string)

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

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

abortCopyFromURL(string, BlobAbortCopyFromURLOptions)

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

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

beginCopyFromURL(string, BlobBeginCopyFromURLOptions)

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

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

راجع 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

getAccountInfo(BlobGetAccountInfoOptions)

ترجع عملية الحصول على معلومات الحساب اسم sku ونوع الحساب للحساب المحدد. تتوفر عملية الحصول على معلومات الحساب على إصدارات الخدمة بدءا من الإصدار 2018-03-28.

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

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)

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

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

AppendBlobClient(string, PipelineLike)

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

new AppendBlobClient(url: string, pipeline: PipelineLike)

المعلمات

url

string

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

pipeline
PipelineLike

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

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

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

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

المعلمات

url

string

سلسلة URL تشير إلى كائن ثنائي كبير الحجم لإلحاق Azure Storage، مثل "https://myaccount.blob.core.windows.net/mycontainer/appendblob". يمكنك إلحاق SAS إذا كنت تستخدم AnonymousCredential، مثل "https://myaccount.blob.core.windows.net/mycontainer/appendblob?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.

AppendBlobClient(string, string, string, StoragePipelineOptions)

إنشاء مثيل AppendBlobClient.

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

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

credential: StorageSharedKeyCredential | AnonymousCredential | TokenCredential

قيمة الخاصية

موروث منBlobClient.credential

url

قيمة سلسلة URL المرمزة.

url: string

قيمة الخاصية

string

موروث منBlobClient.url

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

appendBlock(RequestBodyType, number, AppendBlobAppendBlockOptions)

تثبيت كتلة جديدة من البيانات في نهاية الكائن الثنائي كبير الحجم الموجود للإلحاق.

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

function appendBlock(body: RequestBodyType, contentLength: number, options?: AppendBlobAppendBlockOptions): Promise<AppendBlobAppendBlockResponse>

المعلمات

body
HttpRequestBody

البيانات المراد إلحاقها.

contentLength

number

طول الجسم بالبايت.

options
AppendBlobAppendBlockOptions

خيارات لعملية إلحاق كتلة.

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

const content = "Hello World!";

// Create a new append blob and append data to the blob.
const newAppendBlobClient = containerClient.getAppendBlobClient("<blob name>");
await newAppendBlobClient.create();
await newAppendBlobClient.appendBlock(content, content.length);

// Append data to an existing append blob.
const existingAppendBlobClient = containerClient.getAppendBlobClient("<blob name>");
await existingAppendBlobClient.appendBlock(content, content.length);

المرتجعات

appendBlockFromURL(string, number, number, AppendBlobAppendBlockFromURLOptions)

تقوم عملية Append Block بتثبيت كتلة جديدة من البيانات إلى نهاية كائن ثنائي كبير الحجم للإلحاق موجود حيث تتم قراءة المحتويات من عنوان URL المصدر.

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

function appendBlockFromURL(sourceURL: string, sourceOffset: number, count: number, options?: AppendBlobAppendBlockFromURLOptions): Promise<AppendBlobAppendBlockFromUrlResponse>

المعلمات

sourceURL

string

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

sourceOffset

number

الإزاحة في المصدر المراد إلحاقها

count

number

عدد وحدات البايت المراد إلحاقها ككتلة

المرتجعات

create(AppendBlobCreateOptions)

إنشاء كائن ثنائي كبير الحجم للإلحاق بطول 0. استدعاء AppendBlock لإلحاق البيانات إلى كائن ثنائي كبير الحجم للإلحاق.

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

function create(options?: AppendBlobCreateOptions): Promise<AppendBlobCreateResponse>

المعلمات

options
AppendBlobCreateOptions

خيارات لعملية إنشاء كتلة الإلحاق.

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

const appendBlobClient = containerClient.getAppendBlobClient("<blob name>");
await appendBlobClient.create();

المرتجعات

createIfNotExists(AppendBlobCreateIfNotExistsOptions)

إنشاء كائن ثنائي كبير الحجم للإلحاق بطول 0. استدعاء AppendBlock لإلحاق البيانات إلى كائن ثنائي كبير الحجم للإلحاق. إذا كان الكائن الثنائي كبير الحجم بنفس الاسم موجودا بالفعل، فسيظل محتوى الكائن الثنائي كبير الحجم الموجود دون تغيير.

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

function createIfNotExists(options?: AppendBlobCreateIfNotExistsOptions): Promise<AppendBlobCreateIfNotExistsResponse>

المعلمات

المرتجعات

seal(AppendBlobSealOptions)

ختم الكائن الثنائي كبير الحجم للإلحاق، مما يجعله للقراءة فقط.

function seal(options?: AppendBlobSealOptions): Promise<AppendBlobAppendBlockResponse>

المعلمات

المرتجعات

withSnapshot(string)

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

function withSnapshot(snapshot: string): AppendBlobClient

المعلمات

snapshot

string

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

المرتجعات

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

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

abortCopyFromURL(string, BlobAbortCopyFromURLOptions)

إحباط عملية Copy 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.

المرتجعات

موروث منBlobClient.abortCopyFromURL

beginCopyFromURL(string, BlobBeginCopyFromURLOptions)

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

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

راجع 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.

المرتجعات

موروث من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.

المرتجعات

موروث منBlobClient.createSnapshot

delete(BlobDeleteOptions)

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

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

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

المعلمات

options
BlobDeleteOptions

خيارات اختيارية لعملية حذف Blob.

المرتجعات

موروث منBlobClient.delete

deleteIfExists(BlobDeleteOptions)

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

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

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

المعلمات

options
BlobDeleteOptions

خيارات اختيارية لعملية حذف Blob.

المرتجعات

موروث منBlobClient.deleteIfExists

deleteImmutabilityPolicy(BlobDeleteImmutabilityPolicyOptions)

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

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

المعلمات

options
BlobDeleteImmutabilityPolicyOptions

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

المرتجعات

موروث من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

خيارات اختيارية لعملية تنزيل Blob.

مثال على الاستخدام (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);
  });
}

المرتجعات

موروث من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.

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

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

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

خيارات لخيارات تنزيل Blob.

المرتجعات

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

getAccountInfo(BlobGetAccountInfoOptions)

ترجع عملية الحصول على معلومات الحساب اسم sku ونوع الحساب للحساب المحدد. تتوفر عملية الحصول على معلومات الحساب على إصدارات الخدمة بدءا من الإصدار 2018-03-28.

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

function getAccountInfo(options?: BlobGetAccountInfoOptions): Promise<BlobGetAccountInfoResponse>

المعلمات

options
BlobGetAccountInfoOptions

خيارات لعملية Service Get Account Info.

المرتجعات

بيانات الاستجابة لعملية Service Get Account Info.

موروث منBlobClient.getAccountInfo

getAppendBlobClient()

إنشاء كائن AppendBlobClient.

function getAppendBlobClient(): AppendBlobClient

المرتجعات

موروث منBlobClient.getAppendBlobClient

getBlobLeaseClient(string)

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

function getBlobLeaseClient(proposeLeaseId?: string): BlobLeaseClient

المعلمات

proposeLeaseId

string

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

المرتجعات

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

موروث منBlobClient.getBlobLeaseClient

getBlockBlobClient()

إنشاء كائن BlockBlobClient.

function getBlockBlobClient(): BlockBlobClient

المرتجعات

موروث منBlobClient.getBlockBlobClient

getPageBlobClient()

إنشاء كائن PageBlobClient.

function getPageBlobClient(): 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

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

المرتجعات

موروث منBlobClient.getProperties

getTags(BlobGetTagsOptions)

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

function getTags(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.

المرتجعات

موروث من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.

المرتجعات

موروث منBlobClient.setHTTPHeaders

setImmutabilityPolicy(BlobImmutabilityPolicy, BlobSetImmutabilityPolicyOptions)

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

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

المعلمات

immutabilityPolicy
BlobImmutabilityPolicy
options
BlobSetImmutabilityPolicyOptions

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

المرتجعات

موروث منBlobClient.setImmutabilityPolicy

setLegalHold(boolean, BlobSetLegalHoldOptions)

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

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

المعلمات

legalHoldEnabled

boolean

options
BlobSetLegalHoldOptions

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

المرتجعات

موروث من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

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

المرتجعات

موروث منBlobClient.setMetadata

setTags(Tags, BlobSetTagsOptions)

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

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

المعلمات

tags
Tags

المرتجعات

موروث منBlobClient.setTags

syncCopyFromURL(string, BlobSyncCopyFromURLOptions)

تنسخ عملية النسخ المتزامن من عنوان 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) مطلوبا للمصادقة

المرتجعات

موروث من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

خيارات اختيارية لعملية إلغاء حذف Blob.

المرتجعات

موروث منBlobClient.undelete

withVersion(string)

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

function withVersion(versionId: string): BlobClient

المعلمات

versionId

string

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

المرتجعات

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

موروث منBlobClient.withVersion