مشاركة عبر

PageBlobClient class

  • ‏‏المرجع
الحزمة:
@azure/storage-blob

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

Extends
BlobClient

المنشئون

PageBlobClient(string, PipelineLike)

إنشاء مثيل PageBlobClient.
PageBlobClient(string, StorageSharedKeyCredential | AnonymousCredential | TokenCredential, StoragePipelineOptions)

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

إنشاء مثيل PageBlobClient.

الخصائص

containerName

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

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

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

accountName
credential

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

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

الأساليب

clearPages(number, number, PageBlobClearPagesOptions)

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

راجع https://docs.microsoft.com/rest/api/storageservices/put-page
create(number, PageBlobCreateOptions)

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

راجع https://docs.microsoft.com/rest/api/storageservices/put-blob
createIfNotExists(number, PageBlobCreateIfNotExistsOptions)

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

راجع https://docs.microsoft.com/rest/api/storageservices/put-blob
getPageRanges(number, number, PageBlobGetPageRangesOptions)

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

راجع https://docs.microsoft.com/rest/api/storageservices/get-page-ranges
getPageRangesDiff(number, number, string, PageBlobGetPageRangesDiffOptions)

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

راجع https://docs.microsoft.com/rest/api/storageservices/get-page-ranges
getPageRangesDiffForManagedDisks(number, number, string, PageBlobGetPageRangesDiffOptions)

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

راجع https://docs.microsoft.com/rest/api/storageservices/get-page-ranges
listPageRanges(number, number, PageBlobListPageRangesOptions)

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

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

يقوم .byPage() بإرجاع مكرر غير متزامن قابل للتكريب إلى قائمة نطاقات الصفحات لكائن ثنائي كبير الحجم للصفحة.

مثال على استخدام for await بناء الجملة:

// Get the pageBlobClient before you run these snippets,
// Can be obtained from `blobServiceClient.getContainerClient("<your-container-name>").getPageBlobClient("<your-blob-name>");`
let i = 1;
for await (const pageRange of pageBlobClient.listPageRanges()) {
  console.log(`Page range ${i++}: ${pageRange.start} - ${pageRange.end}`);
}

مثال على استخدام iter.next():

let i = 1;
let iter = pageBlobClient.listPageRanges();
let pageRangeItem = await iter.next();
while (!pageRangeItem.done) {
  console.log(`Page range ${i++}: ${pageRangeItem.value.start} - ${pageRangeItem.value.end}, IsClear: ${pageRangeItem.value.isClear}`);
  pageRangeItem = await iter.next();
}

مثال على استخدام byPage():

// passing optional maxPageSize in the page settings
let i = 1;
for await (const response of pageBlobClient.listPageRanges().byPage({ maxPageSize: 20 })) {
  for (const pageRange of response) {
    console.log(`Page range ${i++}: ${pageRange.start} - ${pageRange.end}`);
  }
}

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

let i = 1;
let iterator = pageBlobClient.listPageRanges().byPage({ maxPageSize: 2 });
let response = (await iterator.next()).value;

// Prints 2 page ranges
for (const pageRange of response) {
  console.log(`Page range ${i++}: ${pageRange.start} - ${pageRange.end}`);
}

// Gets next marker
let marker = response.continuationToken;

// Passing next marker as continuationToken

iterator = pageBlobClient.listPageRanges().byPage({ continuationToken: marker, maxPageSize: 10 });
response = (await iterator.next()).value;

// Prints 10 page ranges
for (const blob of response) {
  console.log(`Page range ${i++}: ${pageRange.start} - ${pageRange.end}`);
}
listPageRangesDiff(number, number, string, PageBlobListPageRangesDiffOptions)

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

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

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

مثال على استخدام for await بناء الجملة:

// Get the pageBlobClient before you run these snippets,
// Can be obtained from `blobServiceClient.getContainerClient("<your-container-name>").getPageBlobClient("<your-blob-name>");`
let i = 1;
for await (const pageRange of pageBlobClient.listPageRangesDiff()) {
  console.log(`Page range ${i++}: ${pageRange.start} - ${pageRange.end}`);
}

مثال على استخدام iter.next():

let i = 1;
let iter = pageBlobClient.listPageRangesDiff();
let pageRangeItem = await iter.next();
while (!pageRangeItem.done) {
  console.log(`Page range ${i++}: ${pageRangeItem.value.start} - ${pageRangeItem.value.end}, IsClear: ${pageRangeItem.value.isClear}`);
  pageRangeItem = await iter.next();
}

مثال على استخدام byPage():

// passing optional maxPageSize in the page settings
let i = 1;
for await (const response of pageBlobClient.listPageRangesDiff().byPage({ maxPageSize: 20 })) {
  for (const pageRange of response) {
    console.log(`Page range ${i++}: ${pageRange.start} - ${pageRange.end}`);
  }
}

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

let i = 1;
let iterator = pageBlobClient.listPageRangesDiff().byPage({ maxPageSize: 2 });
let response = (await iterator.next()).value;

// Prints 2 page ranges
for (const pageRange of response) {
  console.log(`Page range ${i++}: ${pageRange.start} - ${pageRange.end}`);
}

// Gets next marker
let marker = response.continuationToken;

// Passing next marker as continuationToken

iterator = pageBlobClient.listPageRangesDiff().byPage({ continuationToken: marker, maxPageSize: 10 });
response = (await iterator.next()).value;

// Prints 10 page ranges
for (const blob of response) {
  console.log(`Page range ${i++}: ${pageRange.start} - ${pageRange.end}`);
}
resize(number, PageBlobResizeOptions)

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

راجع https://docs.microsoft.com/rest/api/storageservices/set-blob-properties
startCopyIncremental(string, PageBlobStartCopyIncrementalOptions)

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

راجع https://docs.microsoft.com/rest/api/storageservices/incremental-copy-blob الاطلاع على https://docs.microsoft.com/en-us/azure/virtual-machines/windows/incremental-snapshots
updateSequenceNumber(SequenceNumberActionType, number, PageBlobUpdateSequenceNumberOptions)

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

راجع https://docs.microsoft.com/en-us/rest/api/storageservices/set-blob-properties
uploadPages(RequestBodyType, number, number, PageBlobUploadPagesOptions)

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

راجع https://docs.microsoft.com/rest/api/storageservices/put-page
uploadPagesFromURL(string, number, number, number, PageBlobUploadPagesFromURLOptions)

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

راجع https://docs.microsoft.com/en-us/rest/api/storageservices/put-page-from-url
withSnapshot(string)

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

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

abortCopyFromURL(string, BlobAbortCopyFromURLOptions)

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

راجع https://docs.microsoft.com/en-us/rest/api/storageservices/abort-copy-blob
beginCopyFromURL(string, BlobBeginCopyFromURLOptions)

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

احذف نهج immutablility على الكائن الثنائي كبير الحجم.
download(number, number, BlobDownloadOptions)

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

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

راجع https://docs.microsoft.com/en-us/rest/api/storageservices/get-blob
downloadToBuffer(Buffer, number, number, BlobDownloadToBufferOptions)

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

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

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

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

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

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

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

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

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

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

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

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

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

إنشاء كائن AppendBlobClient.
getBlobLeaseClient(string)

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

إنشاء كائن BlockBlobClient.
getPageBlobClient()

إنشاء كائن PageBlobClient.
getProperties(BlobGetPropertiesOptions)

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

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

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

يحصل على العلامات المقترنة بالكائنات الثنائية كبيرة الحجم الأساسية.
setAccessTier(string, BlobSetTierOptions)

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

راجع https://docs.microsoft.com/en-us/rest/api/storageservices/set-blob-tier
setHTTPHeaders(BlobHTTPHeaders, BlobSetHTTPHeadersOptions)

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

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

راجع https://docs.microsoft.com/en-us/rest/api/storageservices/set-blob-properties
setImmutabilityPolicy(BlobImmutabilityPolicy, BlobSetImmutabilityPolicyOptions)

تعيين نهج الثبات على الكائن الثنائي كبير الحجم.
setLegalHold(boolean, BlobSetLegalHoldOptions)

تعيين تعليق قانوني على الكائن الثنائي كبير الحجم.
setMetadata(Metadata, BlobSetMetadataOptions)

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

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

راجع https://docs.microsoft.com/en-us/rest/api/storageservices/set-blob-metadata
setTags(Tags, BlobSetTagsOptions)

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

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

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

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

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

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

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

PageBlobClient(string, PipelineLike)

إنشاء مثيل PageBlobClient.

new PageBlobClient(url: string, pipeline: PipelineLike)

المعلمات

url

string

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

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.

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

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

قيمة الخاصية

StorageSharedKeyCredential | AnonymousCredential | TokenCredential

موروث منBlobClient.credential

url

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

url: string

قيمة الخاصية

string

موروث منBlobClient.url

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

clearPages(number, number, PageBlobClearPagesOptions)

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

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

function clearPages(offset?: number, count?: number, options?: PageBlobClearPagesOptions): Promise<PageBlobClearPagesResponse>

المعلمات

offset

number

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

count

number

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

options
PageBlobClearPagesOptions

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

المرتجعات

Promise<PageBlobClearPagesResponse>

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

create(number, PageBlobCreateOptions)

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

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

function create(size: number, options?: PageBlobCreateOptions): Promise<PageBlobCreateResponse>

المعلمات

size

number

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

options
PageBlobCreateOptions

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

المرتجعات

Promise<PageBlobCreateResponse>

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

createIfNotExists(number, PageBlobCreateIfNotExistsOptions)

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

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

function createIfNotExists(size: number, options?: PageBlobCreateIfNotExistsOptions): Promise<PageBlobCreateIfNotExistsResponse>

المعلمات

size

number

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

options
PageBlobCreateIfNotExistsOptions

المرتجعات

Promise<PageBlobCreateIfNotExistsResponse>

getPageRanges(number, number, PageBlobGetPageRangesOptions)

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

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

function getPageRanges(offset?: number, count?: number, options?: PageBlobGetPageRangesOptions): Promise<PageBlobGetPageRangesResponse>

المعلمات

offset

number

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

count

number

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

options
PageBlobGetPageRangesOptions

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

المرتجعات

Promise<PageBlobGetPageRangesResponse>

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

getPageRangesDiff(number, number, string, PageBlobGetPageRangesDiffOptions)

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

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

function getPageRangesDiff(offset: number, count: number, prevSnapshot: string, options?: PageBlobGetPageRangesDiffOptions): Promise<PageBlobGetPageRangesDiffResponse>

المعلمات

offset

number

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

count

number

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

prevSnapshot

string

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

options
PageBlobGetPageRangesDiffOptions

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

المرتجعات

Promise<PageBlobGetPageRangesDiffResponse>

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

getPageRangesDiffForManagedDisks(number, number, string, PageBlobGetPageRangesDiffOptions)

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

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

function getPageRangesDiffForManagedDisks(offset: number, count: number, prevSnapshotUrl: string, options?: PageBlobGetPageRangesDiffOptions): Promise<PageBlobGetPageRangesDiffResponse>

المعلمات

offset

number

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

count

number

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

prevSnapshotUrl

string

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

options
PageBlobGetPageRangesDiffOptions

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

المرتجعات

Promise<PageBlobGetPageRangesDiffResponse>

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

listPageRanges(number, number, PageBlobListPageRangesOptions)

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

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

يقوم .byPage() بإرجاع مكرر غير متزامن قابل للتكريب إلى قائمة نطاقات الصفحات لكائن ثنائي كبير الحجم للصفحة.

مثال على استخدام for await بناء الجملة:

// Get the pageBlobClient before you run these snippets,
// Can be obtained from `blobServiceClient.getContainerClient("<your-container-name>").getPageBlobClient("<your-blob-name>");`
let i = 1;
for await (const pageRange of pageBlobClient.listPageRanges()) {
  console.log(`Page range ${i++}: ${pageRange.start} - ${pageRange.end}`);
}

مثال على استخدام iter.next():

let i = 1;
let iter = pageBlobClient.listPageRanges();
let pageRangeItem = await iter.next();
while (!pageRangeItem.done) {
  console.log(`Page range ${i++}: ${pageRangeItem.value.start} - ${pageRangeItem.value.end}, IsClear: ${pageRangeItem.value.isClear}`);
  pageRangeItem = await iter.next();
}

مثال على استخدام byPage():

// passing optional maxPageSize in the page settings
let i = 1;
for await (const response of pageBlobClient.listPageRanges().byPage({ maxPageSize: 20 })) {
  for (const pageRange of response) {
    console.log(`Page range ${i++}: ${pageRange.start} - ${pageRange.end}`);
  }
}

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

let i = 1;
let iterator = pageBlobClient.listPageRanges().byPage({ maxPageSize: 2 });
let response = (await iterator.next()).value;

// Prints 2 page ranges
for (const pageRange of response) {
  console.log(`Page range ${i++}: ${pageRange.start} - ${pageRange.end}`);
}

// Gets next marker
let marker = response.continuationToken;

// Passing next marker as continuationToken

iterator = pageBlobClient.listPageRanges().byPage({ continuationToken: marker, maxPageSize: 10 });
response = (await iterator.next()).value;

// Prints 10 page ranges
for (const blob of response) {
  console.log(`Page range ${i++}: ${pageRange.start} - ${pageRange.end}`);
}

function listPageRanges(offset?: number, count?: number, options?: PageBlobListPageRangesOptions): PagedAsyncIterableIterator<PageRangeInfo, PageBlobGetPageRangesResponseModel, PageSettings>

المعلمات

offset

number

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

count

number

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

options
PageBlobListPageRangesOptions

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

المرتجعات

PagedAsyncIterableIterator<PageRangeInfo, PageBlobGetPageRangesResponseModel, PageSettings>

asyncIterableIterator يدعم ترحيل الصفحات.

listPageRangesDiff(number, number, string, PageBlobListPageRangesDiffOptions)

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

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

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

مثال على استخدام for await بناء الجملة:

// Get the pageBlobClient before you run these snippets,
// Can be obtained from `blobServiceClient.getContainerClient("<your-container-name>").getPageBlobClient("<your-blob-name>");`
let i = 1;
for await (const pageRange of pageBlobClient.listPageRangesDiff()) {
  console.log(`Page range ${i++}: ${pageRange.start} - ${pageRange.end}`);
}

مثال على استخدام iter.next():

let i = 1;
let iter = pageBlobClient.listPageRangesDiff();
let pageRangeItem = await iter.next();
while (!pageRangeItem.done) {
  console.log(`Page range ${i++}: ${pageRangeItem.value.start} - ${pageRangeItem.value.end}, IsClear: ${pageRangeItem.value.isClear}`);
  pageRangeItem = await iter.next();
}

مثال على استخدام byPage():

// passing optional maxPageSize in the page settings
let i = 1;
for await (const response of pageBlobClient.listPageRangesDiff().byPage({ maxPageSize: 20 })) {
  for (const pageRange of response) {
    console.log(`Page range ${i++}: ${pageRange.start} - ${pageRange.end}`);
  }
}

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

let i = 1;
let iterator = pageBlobClient.listPageRangesDiff().byPage({ maxPageSize: 2 });
let response = (await iterator.next()).value;

// Prints 2 page ranges
for (const pageRange of response) {
  console.log(`Page range ${i++}: ${pageRange.start} - ${pageRange.end}`);
}

// Gets next marker
let marker = response.continuationToken;

// Passing next marker as continuationToken

iterator = pageBlobClient.listPageRangesDiff().byPage({ continuationToken: marker, maxPageSize: 10 });
response = (await iterator.next()).value;

// Prints 10 page ranges
for (const blob of response) {
  console.log(`Page range ${i++}: ${pageRange.start} - ${pageRange.end}`);
}

function listPageRangesDiff(offset: number, count: number, prevSnapshot: string, options?: PageBlobListPageRangesDiffOptions): PagedAsyncIterableIterator<PageRangeInfo, PageBlobGetPageRangesDiffResponseModel, PageSettings>

المعلمات

offset

number

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

count

number

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

prevSnapshot

string

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

options
PageBlobListPageRangesDiffOptions

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

المرتجعات

PagedAsyncIterableIterator<PageRangeInfo, PageBlobGetPageRangesDiffResponseModel, PageSettings>

asyncIterableIterator يدعم ترحيل الصفحات.

resize(number, PageBlobResizeOptions)

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

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

function resize(size: number, options?: PageBlobResizeOptions): Promise<PageBlobResizeResponse>

المعلمات

size

number

حجم الهدف

options
PageBlobResizeOptions

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

المرتجعات

Promise<PageBlobResizeResponse>

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

startCopyIncremental(string, PageBlobStartCopyIncrementalOptions)

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

راجع https://docs.microsoft.com/rest/api/storageservices/incremental-copy-blob الاطلاع على https://docs.microsoft.com/en-us/azure/virtual-machines/windows/incremental-snapshots

function startCopyIncremental(copySource: string, options?: PageBlobStartCopyIncrementalOptions): Promise<PageBlobCopyIncrementalResponse>

المعلمات

copySource

string

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

options
PageBlobStartCopyIncrementalOptions

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

المرتجعات

Promise<PageBlobCopyIncrementalResponse>

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

updateSequenceNumber(SequenceNumberActionType, number, PageBlobUpdateSequenceNumberOptions)

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

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

function updateSequenceNumber(sequenceNumberAction: SequenceNumberActionType, sequenceNumber?: number, options?: PageBlobUpdateSequenceNumberOptions): Promise<PageBlobUpdateSequenceNumberResponse>

المعلمات

sequenceNumberAction
SequenceNumberActionType

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

sequenceNumber

number

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

options
PageBlobUpdateSequenceNumberOptions

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

المرتجعات

Promise<PageBlobUpdateSequenceNumberResponse>

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

uploadPages(RequestBodyType, number, number, PageBlobUploadPagesOptions)

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

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

function uploadPages(body: RequestBodyType, offset: number, count: number, options?: PageBlobUploadPagesOptions): Promise<PageBlobUploadPagesResponse>

المعلمات

body
HttpRequestBody

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

offset

number

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

count

number

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

options
PageBlobUploadPagesOptions

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

المرتجعات

Promise<PageBlobUploadPagesResponse>

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

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

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

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

function uploadPagesFromURL(sourceURL: string, sourceOffset: number, destOffset: number, count: number, options?: PageBlobUploadPagesFromURLOptions): Promise<PageBlobUploadPagesFromURLResponse>

المعلمات

sourceURL

string

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

sourceOffset

number

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

destOffset

number

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

count

number

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

options
PageBlobUploadPagesFromURLOptions

المرتجعات

Promise<PageBlobUploadPagesFromURLResponse>

withSnapshot(string)

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

function withSnapshot(snapshot: string): PageBlobClient

المعلمات

snapshot

string

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

المرتجعات

PageBlobClient

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

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

abortCopyFromURL(string, BlobAbortCopyFromURLOptions)

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

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

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

المعلمات

copyId

string

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

options
BlobAbortCopyFromURLOptions

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

المرتجعات

Promise<BlobAbortCopyFromURLResponse>

موروث منBlobClient.abortCopyFromURL

beginCopyFromURL(string, BlobBeginCopyFromURLOptions)

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

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

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

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

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

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

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

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

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

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

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

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

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

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

المعلمات

copySource

string

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

options
BlobBeginCopyFromURLOptions

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

المرتجعات

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

موروث منBlobClient.beginCopyFromURL

createSnapshot(BlobCreateSnapshotOptions)

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

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

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

المعلمات

options
BlobCreateSnapshotOptions

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

المرتجعات

Promise<BlobCreateSnapshotResponse>

موروث منBlobClient.createSnapshot

delete(BlobDeleteOptions)

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

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

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

المعلمات

options
BlobDeleteOptions

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

المرتجعات

Promise<BlobDeleteResponse>

موروث منBlobClient.delete

deleteIfExists(BlobDeleteOptions)

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

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

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

المعلمات

options
BlobDeleteOptions

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

المرتجعات

Promise<BlobDeleteIfExistsResponse>

موروث منBlobClient.deleteIfExists

deleteImmutabilityPolicy(BlobDeleteImmutabilityPolicyOptions)

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

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

المعلمات

options
BlobDeleteImmutabilityPolicyOptions

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

المرتجعات

Promise<BlobDeleteImmutabilityPolicyResponse>

موروث منBlobClient.deleteImmutabilityPolicy

download(number, number, BlobDownloadOptions)

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

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

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

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

المعلمات

offset

number

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

count

number

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

options
BlobDownloadOptions

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

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

// Download and convert a blob to a string
const downloadBlockBlobResponse = await blobClient.download();
const downloaded = await streamToBuffer(downloadBlockBlobResponse.readableStreamBody);
console.log("Downloaded blob content:", downloaded.toString());

async function streamToBuffer(readableStream) {
return new Promise((resolve, reject) => {
const chunks = [];
readableStream.on("data", (data) => {
chunks.push(data instanceof Buffer ? data : Buffer.from(data));
});
readableStream.on("end", () => {
resolve(Buffer.concat(chunks));
});
readableStream.on("error", reject);
});
}

مثال على الاستخدام (المتصفح):

// Download and convert a blob to a string
const downloadBlockBlobResponse = await blobClient.download();
const downloaded = await blobToString(await downloadBlockBlobResponse.blobBody);
console.log(
  "Downloaded blob content",
  downloaded
);

async function blobToString(blob: Blob): Promise<string> {
  const fileReader = new FileReader();
  return new Promise<string>((resolve, reject) => {
    fileReader.onloadend = (ev: any) => {
      resolve(ev.target!.result);
    };
    fileReader.onerror = reject;
    fileReader.readAsText(blob);
  });
}

المرتجعات

Promise<BlobDownloadResponseParsed>

موروث منBlobClient.download

downloadToBuffer(Buffer, number, number, BlobDownloadToBufferOptions)

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

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

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

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

المعلمات

buffer

Buffer

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

offset

number

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

count

number

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

options
BlobDownloadToBufferOptions

BlobDownloadToBufferOptions

المرتجعات

Promise<Buffer>

موروث منBlobClient.downloadToBuffer

downloadToBuffer(number, number, BlobDownloadToBufferOptions)

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

تنزيل 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

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

المرتجعات

Promise<BlobDownloadResponseParsed>

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

موروث منBlobClient.downloadToFile

exists(BlobExistsOptions)

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

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

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

المعلمات

options
BlobExistsOptions

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

المرتجعات

Promise<boolean>

موروث منBlobClient.exists

generateSasUrl(BlobGenerateSasUrlOptions)

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

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

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

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

المعلمات

options
BlobGenerateSasUrlOptions

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

المرتجعات

Promise<string>

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

موروث منBlobClient.generateSasUrl

getAppendBlobClient()

إنشاء كائن AppendBlobClient.

function getAppendBlobClient(): AppendBlobClient

المرتجعات

AppendBlobClient

موروث منBlobClient.getAppendBlobClient

getBlobLeaseClient(string)

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

function getBlobLeaseClient(proposeLeaseId?: string): BlobLeaseClient

المعلمات

proposeLeaseId

string

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

المرتجعات

BlobLeaseClient

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

موروث منBlobClient.getBlobLeaseClient

getBlockBlobClient()

إنشاء كائن BlockBlobClient.

function getBlockBlobClient(): BlockBlobClient

المرتجعات

BlockBlobClient

موروث منBlobClient.getBlockBlobClient

getPageBlobClient()

إنشاء كائن PageBlobClient.

function getPageBlobClient(): PageBlobClient

المرتجعات

PageBlobClient

موروث منBlobClient.getPageBlobClient

getProperties(BlobGetPropertiesOptions)

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

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

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

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

المعلمات

options
BlobGetPropertiesOptions

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

المرتجعات

Promise<BlobGetPropertiesResponse>

موروث منBlobClient.getProperties

getTags(BlobGetTagsOptions)

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

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

المعلمات

options
BlobGetTagsOptions

المرتجعات

Promise<BlobGetTagsResponse>

موروث منBlobClient.getTags

setAccessTier(string, BlobSetTierOptions)

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

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

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

المعلمات

tier

string

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

options
BlobSetTierOptions

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

المرتجعات

Promise<BlobSetTierResponse>

موروث منBlobClient.setAccessTier

setHTTPHeaders(BlobHTTPHeaders, BlobSetHTTPHeadersOptions)

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

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

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

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

المعلمات

blobHTTPHeaders
BlobHTTPHeaders

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

options
BlobSetHTTPHeadersOptions

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

المرتجعات

Promise<BlobSetHTTPHeadersResponse>

موروث منBlobClient.setHTTPHeaders

setImmutabilityPolicy(BlobImmutabilityPolicy, BlobSetImmutabilityPolicyOptions)

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

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

المعلمات

immutabilityPolicy
BlobImmutabilityPolicy
options
BlobSetImmutabilityPolicyOptions

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

المرتجعات

Promise<BlobSetImmutabilityPolicyResponse>

موروث منBlobClient.setImmutabilityPolicy

setLegalHold(boolean, BlobSetLegalHoldOptions)

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

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

المعلمات

legalHoldEnabled

boolean

options
BlobSetLegalHoldOptions

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

المرتجعات

Promise<BlobSetLegalHoldResponse>

موروث منBlobClient.setLegalHold

setMetadata(Metadata, BlobSetMetadataOptions)

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

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

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

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

المعلمات

metadata
Metadata

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

options
BlobSetMetadataOptions

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

المرتجعات

Promise<BlobSetMetadataResponse>

موروث منBlobClient.setMetadata

setTags(Tags, BlobSetTagsOptions)

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

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

المعلمات

tags
Tags
options
BlobSetTagsOptions

المرتجعات

Promise<BlobSetTagsResponse>

موروث منBlobClient.setTags

syncCopyFromURL(string, BlobSyncCopyFromURLOptions)

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

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

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

المعلمات

copySource

string

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

options
BlobSyncCopyFromURLOptions

المرتجعات

Promise<BlobCopyFromURLResponse>

موروث منBlobClient.syncCopyFromURL

undelete(BlobUndeleteOptions)

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

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

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

المعلمات

options
BlobUndeleteOptions

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

المرتجعات

Promise<BlobUndeleteResponse>

موروث منBlobClient.undelete

withVersion(string)

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

function withVersion(versionId: string): BlobClient

المعلمات

versionId

string

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

المرتجعات

BlobClient

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

موروث منBlobClient.withVersion