PageBlobClient class

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

Extends

المنشئون

PageBlobClient(string, PipelineLike)

إنشاء مثيل PageBlobClient.

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

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

PageBlobClient(string, string, string, StoragePipelineOptions)

إنشاء مثيل PageBlobClient.

الخصائص

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

clearPages(number, number, PageBlobClearPagesOptions)

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

create(number, PageBlobCreateOptions)

إنشاء كائن ثنائي كبير الحجم للصفحة بالطول المحدد. استدعاء uploadPages لتحميل بيانات البيانات إلى كائن ثنائي كبير الحجم للصفحة.

createIfNotExists(number, PageBlobCreateIfNotExistsOptions)

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

createSnapshot(BlobCreateSnapshotOptions)

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

delete(BlobDeleteOptions)

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

deleteIfExists(BlobDeleteOptions)

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

deleteImmutabilityPolicy(BlobDeleteImmutabilityPolicyOptions)

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

download(number, number, BlobDownloadOptions)

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

  • في Node.js، ترجع البيانات في دفق قابل للقراءةStreamBody
  • في المستعرضات، ترجع البيانات في blobBody وعد
downloadToBuffer(Buffer, number, number, BlobDownloadToBufferOptions)

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

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

downloadToBuffer(number, number, BlobDownloadToBufferOptions)

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

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

downloadToFile(string, number, number, BlobDownloadOptions)

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

exists(BlobExistsOptions)

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

generateSasUrl(BlobGenerateSasUrlOptions)

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

getAppendBlobClient()

إنشاء كائن AppendBlobClient.

getBlobLeaseClient(string)

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

getBlockBlobClient()

إنشاء كائن BlockBlobClient.

getPageBlobClient()

إنشاء كائن PageBlobClient.

getPageRanges(number, number, PageBlobGetPageRangesOptions)

إرجاع قائمة نطاقات الصفحات الصالحة لكائن ثنائي كبير الحجم للصفحة أو لقطة لكائن ثنائي كبير الحجم للصفحة.

getPageRangesDiff(number, number, string, PageBlobGetPageRangesDiffOptions)

يحصل على مجموعة نطاقات الصفحات التي تختلف بين لقطة محددة ونقطة الصفحة هذه.

getPageRangesDiffForManagedDisks(number, number, string, PageBlobGetPageRangesDiffOptions)

يحصل على مجموعة نطاقات الصفحات التي تختلف بين لقطة محددة ونقطة الصفحة هذه للأقراص المدارة.

getProperties(BlobGetPropertiesOptions)

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

getTags(BlobGetTagsOptions)

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

resize(number, PageBlobResizeOptions)

تغيير حجم كائن ثنائي كبير الحجم للصفحة إلى الحجم المحدد (والذي يجب أن يكون مضاعفا يبلغ 512).

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

startCopyIncremental(string, PageBlobStartCopyIncrementalOptions)

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

syncCopyFromURL(string, BlobSyncCopyFromURLOptions)

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

undelete(BlobUndeleteOptions)

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

updateSequenceNumber(SequenceNumberActionType, number, PageBlobUpdateSequenceNumberOptions)

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

uploadPages(HttpRequestBody, number, number, PageBlobUploadPagesOptions)

يكتب 1 أو أكثر من الصفحات إلى كائن ثنائي كبير الحجم للصفحة. يجب أن تكون إزاحات البداية والنهاية مضاعف 512.

uploadPagesFromURL(string, number, number, number, PageBlobUploadPagesFromURLOptions)

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

withSnapshot(string)

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

withVersion(string)

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

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

PageBlobClient(string, PipelineLike)

إنشاء مثيل PageBlobClient.

new PageBlobClient(url: string, pipeline: PipelineLike)

المعلمات

url

string

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

pipeline
PipelineLike

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

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

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

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

المعلمات

url

string

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

credential

StorageSharedKeyCredential | AnonymousCredential | TokenCredential

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

options
StoragePipelineOptions

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

PageBlobClient(string, string, string, StoragePipelineOptions)

إنشاء مثيل PageBlobClient.

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

clearPages(number, number, PageBlobClearPagesOptions)

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

function clearPages(offset?: number, count?: number, options?: PageBlobClearPagesOptions)

المعلمات

offset

number

بدء موضع البايت للصفحات لمسحها.

count

number

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

options
PageBlobClearPagesOptions

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

المرتجعات

بيانات الاستجابة لعملية Page Blob Clear Pages.

create(number, PageBlobCreateOptions)

إنشاء كائن ثنائي كبير الحجم للصفحة بالطول المحدد. استدعاء uploadPages لتحميل بيانات البيانات إلى كائن ثنائي كبير الحجم للصفحة.

function create(size: number, options?: PageBlobCreateOptions)

المعلمات

size

number

حجم كائن ثنائي كبير الحجم للصفحة.

options
PageBlobCreateOptions

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

المرتجعات

بيانات الاستجابة لعملية إنشاء كائن ثنائي كبير الحجم للصفحة.

createIfNotExists(number, PageBlobCreateIfNotExistsOptions)

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

function createIfNotExists(size: number, options?: PageBlobCreateIfNotExistsOptions)

المعلمات

size

number

حجم كائن ثنائي كبير الحجم للصفحة.

المرتجعات

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

المرتجعات

getPageBlobClient()

إنشاء كائن PageBlobClient.

function getPageBlobClient()

المرتجعات

getPageRanges(number, number, PageBlobGetPageRangesOptions)

إرجاع قائمة نطاقات الصفحات الصالحة لكائن ثنائي كبير الحجم للصفحة أو لقطة لكائن ثنائي كبير الحجم للصفحة.

function getPageRanges(offset?: number, count?: number, options?: PageBlobGetPageRangesOptions)

المعلمات

offset

number

بدء موضع البايت لنطاقات الصفحات.

count

number

عدد وحدات البايت التي يجب الحصول عليها.

options
PageBlobGetPageRangesOptions

خيارات لعملية Page Blob Get Ranges.

المرتجعات

بيانات الاستجابة لعملية Page Blob Get Ranges.

getPageRangesDiff(number, number, string, PageBlobGetPageRangesDiffOptions)

يحصل على مجموعة نطاقات الصفحات التي تختلف بين لقطة محددة ونقطة الصفحة هذه.

function getPageRangesDiff(offset: number, count: number, prevSnapshot: string, options?: PageBlobGetPageRangesDiffOptions)

المعلمات

offset

number

بداية موضع البايت لكائن ثنائي كبير الحجم للصفحة

count

number

عدد وحدات البايت للحصول على نطاقات diff.

prevSnapshot

string

الطابع الزمني للقطة لاسترداد الفرق.

options
PageBlobGetPageRangesDiffOptions

خيارات لعملية Page Blob Get Page Ranges Diff.

المرتجعات

بيانات الاستجابة لعملية Page Blob Get Page Range Diff.

getPageRangesDiffForManagedDisks(number, number, string, PageBlobGetPageRangesDiffOptions)

يحصل على مجموعة نطاقات الصفحات التي تختلف بين لقطة محددة ونقطة الصفحة هذه للأقراص المدارة.

function getPageRangesDiffForManagedDisks(offset: number, count: number, prevSnapshotUrl: string, options?: PageBlobGetPageRangesDiffOptions)

المعلمات

offset

number

بداية موضع البايت لكائن ثنائي كبير الحجم للصفحة

count

number

عدد وحدات البايت للحصول على نطاقات diff.

prevSnapshotUrl

string

عنوان URL للقطة لاسترداد الفرق.

options
PageBlobGetPageRangesDiffOptions

خيارات لعملية Page Blob Get Page Ranges Diff.

المرتجعات

بيانات الاستجابة لعملية Page Blob Get Page Range Diff.

getProperties(BlobGetPropertiesOptions)

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

function getProperties(options?: BlobGetPropertiesOptions)

المعلمات

options
BlobGetPropertiesOptions

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

المرتجعات

getTags(BlobGetTagsOptions)

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

function getTags(options?: BlobGetTagsOptions)

المعلمات

المرتجعات

resize(number, PageBlobResizeOptions)

تغيير حجم كائن ثنائي كبير الحجم للصفحة إلى الحجم المحدد (والذي يجب أن يكون مضاعفا يبلغ 512).

function resize(size: number, options?: PageBlobResizeOptions)

المعلمات

size

number

حجم الهدف

options
PageBlobResizeOptions

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

المرتجعات

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

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

المرتجعات

startCopyIncremental(string, PageBlobStartCopyIncrementalOptions)

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

function startCopyIncremental(copySource: string, options?: PageBlobStartCopyIncrementalOptions)

المعلمات

copySource

string

يحدد اسم لقطة كائن ثنائي كبير الحجم للصفحة المصدر. على سبيل المثال،⁧https://myaccount.blob.core.windows.net/mycontainer/myblob?snapshot=

options
PageBlobStartCopyIncrementalOptions

خيارات لعملية Page Blob Copy Incremental.

المرتجعات

بيانات الاستجابة لعملية Page Blob Copy Incremental.

syncCopyFromURL(string, BlobSyncCopyFromURLOptions)

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

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

المعلمات

copySource

string

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

المرتجعات

undelete(BlobUndeleteOptions)

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

function undelete(options?: BlobUndeleteOptions)

المعلمات

options
BlobUndeleteOptions

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

المرتجعات

updateSequenceNumber(SequenceNumberActionType, number, PageBlobUpdateSequenceNumberOptions)

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

function updateSequenceNumber(sequenceNumberAction: SequenceNumberActionType, sequenceNumber?: number, options?: PageBlobUpdateSequenceNumberOptions)

المعلمات

sequenceNumberAction
SequenceNumberActionType

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

sequenceNumber

number

مطلوب إذا كان sequenceNumberAction هو الحد الأقصى أو التحديث

options
PageBlobUpdateSequenceNumberOptions

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

المرتجعات

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

uploadPages(HttpRequestBody, number, number, PageBlobUploadPagesOptions)

يكتب 1 أو أكثر من الصفحات إلى كائن ثنائي كبير الحجم للصفحة. يجب أن تكون إزاحات البداية والنهاية مضاعف 512.

function uploadPages(body: HttpRequestBody, offset: number, count: number, options?: PageBlobUploadPagesOptions)

المعلمات

body

HttpRequestBody

البيانات المراد تحميلها

offset

number

إزاحة الكائن الثنائي كبير الحجم للصفحة الوجهة

count

number

طول المحتوى للنص الأساسي، وكذلك عدد وحدات البايت التي سيتم تحميلها

options
PageBlobUploadPagesOptions

خيارات لعملية Page Blob Upload Pages.

المرتجعات

بيانات الاستجابة لعملية Page Blob Upload Pages.

uploadPagesFromURL(string, number, number, number, PageBlobUploadPagesFromURLOptions)

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

function uploadPagesFromURL(sourceURL: string, sourceOffset: number, destOffset: number, count: number, options?: PageBlobUploadPagesFromURLOptions)

المعلمات

sourceURL

string

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

sourceOffset

number

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

destOffset

number

إزاحة الكائن الثنائي كبير الحجم للصفحة الوجهة

count

number

عدد وحدات البايت التي سيتم تحميلها من الكائن الثنائي كبير الحجم للصفحة المصدر

المرتجعات

withSnapshot(string)

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

function withSnapshot(snapshot: string)

المعلمات

snapshot

string

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

المرتجعات

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

withVersion(string)

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

function withVersion(versionId: string)

المعلمات

versionId

string

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

المرتجعات

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