مشاركة عبر

BlobServiceClient class

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

يمثل BlobServiceClient عميلا لخدمة Azure Storage Blob مما يسمح لك بمعالجة حاويات الكائن الثنائي كبير الحجم.

Extends
StorageClient

المنشئون

BlobServiceClient(string, PipelineLike)

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

إنشاء مثيل BlobServiceClient.

الخصائص

accountName
credential

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

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

الأساليب

createContainer(string, ContainerCreateOptions)

إنشاء حاوية كائن ثنائي كبير الحجم.
deleteContainer(string, ContainerDeleteMethodOptions)

حذف حاوية كائن ثنائي كبير الحجم.
findBlobsByTags(string, ServiceFindBlobByTagsOptions)

إرجاع مكرر غير متزامن قابل للتكبير للعثور على جميع الكائنات الثنائية كبيرة الحجم ذات العلامة المحددة ضمن الحساب المحدد. يقوم .byPage() بإرجاع مكرر غير متزامن لسرد الكائنات الثنائية كبيرة الحجم في الصفحات.
fromConnectionString(string, StoragePipelineOptions)

إنشاء مثيل BlobServiceClient من سلسلة الاتصال.
generateAccountSasUrl(Date, AccountSASPermissions, string, ServiceGenerateAccountSasUrlOptions)

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

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

إنشاء كائن BlobBatchClient لإجراء عمليات الدفعة.
getContainerClient(string)

إنشاء كائن <xref:ContainerClient>
getProperties(ServiceGetPropertiesOptions)

يحصل على خصائص خدمة Blob لحساب التخزين، بما في ذلك خصائص قواعد Storage Analytics وCORS (مشاركة الموارد عبر المنشأ).
getStatistics(ServiceGetStatisticsOptions)

استرداد الإحصائيات المتعلقة بالنسخ المتماثل لخدمة Blob. يتوفر فقط على نقطة نهاية الموقع الثانوي عند تمكين النسخ المتماثل المتكرر جغرافيا للوصول للقراءة لحساب التخزين.
getUserDelegationKey(Date, Date, ServiceGetUserDelegationKeyOptions)

متوفر فقط عند استخدام مصادقة الرمز المميز للحامل (TokenCredential). استرداد مفتاح تفويض مستخدم لخدمة Blob. هذه عملية صالحة فقط عند استخدام مصادقة الرمز المميز للحامل.
listContainers(ServiceListContainersOptions)

إرجاع مكرر غير متزامن لسرد جميع الحاويات ضمن الحساب المحدد. يقوم .byPage() بإرجاع مكرر غير متزامن لسرد الحاويات في الصفحات.

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

let i = 1;
for await (const container of blobServiceClient.listContainers()) {
  console.log(`Container ${i++}: ${container.name}`);
}

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

let i = 1;
const iter = blobServiceClient.listContainers();
let containerItem = await iter.next();
while (!containerItem.done) {
  console.log(`Container ${i++}: ${containerItem.value.name}`);
  containerItem = await iter.next();
}

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

// passing optional maxPageSize in the page settings
let i = 1;
for await (const response of blobServiceClient.listContainers().byPage({ maxPageSize: 20 })) {
  if (response.containerItems) {
    for (const container of response.containerItems) {
      console.log(`Container ${i++}: ${container.name}`);
    }
  }
}

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

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

// Prints 2 container names
if (response.containerItems) {
  for (const container of response.containerItems) {
    console.log(`Container ${i++}: ${container.name}`);
  }
}

// Gets next marker
let marker = response.continuationToken;
// Passing next marker as continuationToken
iterator = blobServiceClient
  .listContainers()
  .byPage({ continuationToken: marker, maxPageSize: 10 });
response = (await iterator.next()).value;

// Prints 10 container names
if (response.containerItems) {
  for (const container of response.containerItems) {
     console.log(`Container ${i++}: ${container.name}`);
  }
}
setProperties(BlobServiceProperties, ServiceSetPropertiesOptions)

تعيين خصائص نقطة نهاية خدمة Blob لحساب التخزين، بما في ذلك خصائص Storage Analytics وقواعد CORS (مشاركة الموارد عبر المنشأ) وإعدادات الحذف المبدئي.
undeleteContainer(string, string, ServiceUndeleteContainerOptions)

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

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

BlobServiceClient(string, PipelineLike)

إنشاء مثيل BlobServiceClient.

new BlobServiceClient(url: string, pipeline: PipelineLike)

المعلمات

url

string

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

pipeline
PipelineLike

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

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

إنشاء مثيل BlobServiceClient.

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

المعلمات

url

string

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

credential

StorageSharedKeyCredential | AnonymousCredential | TokenCredential

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

options
StoragePipelineOptions

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

مثال على استخدام DefaultAzureCredential من @azure/identity:

const account = "<storage account name>";

const defaultAzureCredential = new DefaultAzureCredential();

const blobServiceClient = new BlobServiceClient(
  `https://${account}.blob.core.windows.net`,
  defaultAzureCredential
);

مثال على استخدام اسم/مفتاح حساب:

const account = "<storage account name>"
const sharedKeyCredential = new StorageSharedKeyCredential(account, "<account key>");

const blobServiceClient = new BlobServiceClient(
  `https://${account}.blob.core.windows.net`,
  sharedKeyCredential
);

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

accountName 

accountName: string

قيمة الخاصية

string

credential

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

credential: StorageSharedKeyCredential | AnonymousCredential | TokenCredential

قيمة الخاصية

StorageSharedKeyCredential | AnonymousCredential | TokenCredential

url

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

url: string

قيمة الخاصية

string

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

createContainer(string, ContainerCreateOptions)

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

function createContainer(containerName: string, options?: ContainerCreateOptions)

المعلمات

containerName

string

اسم الحاوية المراد إنشاؤها.

options
ContainerCreateOptions

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

المرتجعات

Promise<Object>

استجابة إنشاء الحاوية وعميل الحاوية المقابل.

deleteContainer(string, ContainerDeleteMethodOptions)

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

function deleteContainer(containerName: string, options?: ContainerDeleteMethodOptions)

المعلمات

containerName

string

اسم الحاوية المراد حذفها.

options
ContainerDeleteMethodOptions

خيارات لتكوين عملية حذف الحاوية.

المرتجعات

Promise<ContainerDeleteResponse>

استجابة حذف الحاوية.

findBlobsByTags(string, ServiceFindBlobByTagsOptions)

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

function findBlobsByTags(tagFilterSqlExpression: string, options?: ServiceFindBlobByTagsOptions)

المعلمات

tagFilterSqlExpression

string

تمكن المعلمة where المتصل من الاستعلام عن الكائنات الثنائية كبيرة الحجم التي تتطابق علاماتها مع تعبير معين. يجب تقييم التعبير المحدد إلى صحيح لكي يتم إرجاع كائن ثنائي كبير الحجم في النتائج. تحدد قاعدة بناء جملة عامل التصفية [OData - ABNF] التدقيق النحوي الرسمي لقيمة معلمة الاستعلام where؛ ومع ذلك، يتم دعم مجموعة فرعية فقط من بناء جملة عامل تصفية OData في خدمة Blob.

options
ServiceFindBlobByTagsOptions

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

المرتجعات

PagedAsyncIterableIterator<FilterBlobItem, ServiceFindBlobsByTagsSegmentResponse>

fromConnectionString(string, StoragePipelineOptions)

إنشاء مثيل BlobServiceClient من سلسلة الاتصال.

static function fromConnectionString(connectionString: 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

options
StoragePipelineOptions

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

المرتجعات

BlobServiceClient

generateAccountSasUrl(Date, AccountSASPermissions, string, ServiceGenerateAccountSasUrlOptions)

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

function generateAccountSasUrl(expiresOn?: Date, permissions?: AccountSASPermissions, resourceTypes?: string, options?: ServiceGenerateAccountSasUrlOptions)

المعلمات

expiresOn

Date

‏‏اختياري. الوقت الذي يصبح فيه توقيع الوصول المشترك غير صالح. افتراضي إلى ساعة في وقت لاحق إذا لم يتم توفيره.

permissions
AccountSASPermissions

يحدد قائمة الأذونات المراد ربطها ب SAS.

resourceTypes

string

يحدد أنواع الموارد المقترنة بتوقيع الوصول المشترك.

options
ServiceGenerateAccountSasUrlOptions

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

المرتجعات

string

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

getAccountInfo(ServiceGetAccountInfoOptions)

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

function getAccountInfo(options?: ServiceGetAccountInfoOptions)

المعلمات

options
ServiceGetAccountInfoOptions

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

المرتجعات

Promise<ServiceGetAccountInfoResponse>

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

getBlobBatchClient()

إنشاء كائن BlobBatchClient لإجراء عمليات الدفعة.

function getBlobBatchClient()

المرتجعات

BlobBatchClient

كائن BlobBatchClient جديد لهذه الخدمة.

getContainerClient(string)

إنشاء كائن <xref:ContainerClient>

function getContainerClient(containerName: string)

المعلمات

containerName

string

اسم حاوية

المرتجعات

ContainerClient

كائن ContainerClient جديد لاسم الحاوية المحدد.

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

const containerClient = blobServiceClient.getContainerClient("<container name>");

getProperties(ServiceGetPropertiesOptions)

يحصل على خصائص خدمة Blob لحساب التخزين، بما في ذلك خصائص قواعد Storage Analytics وCORS (مشاركة الموارد عبر المنشأ).

function getProperties(options?: ServiceGetPropertiesOptions)

المعلمات

options
ServiceGetPropertiesOptions

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

المرتجعات

Promise<ServiceGetPropertiesResponse>

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

getStatistics(ServiceGetStatisticsOptions)

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

function getStatistics(options?: ServiceGetStatisticsOptions)

المعلمات

options
ServiceGetStatisticsOptions

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

المرتجعات

Promise<ServiceGetStatisticsResponse>

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

getUserDelegationKey(Date, Date, ServiceGetUserDelegationKeyOptions)

متوفر فقط عند استخدام مصادقة الرمز المميز للحامل (TokenCredential). استرداد مفتاح تفويض مستخدم لخدمة Blob. هذه عملية صالحة فقط عند استخدام مصادقة الرمز المميز للحامل.

function getUserDelegationKey(startsOn: Date, expiresOn: Date, options?: ServiceGetUserDelegationKeyOptions)

المعلمات

startsOn

Date

وقت البدء لتفويض المستخدم SAS. يجب أن يكون في غضون 7 أيام من الوقت الحالي

expiresOn

Date

وقت انتهاء توقيع الوصول المشترك لتفويض المستخدم. يجب أن يكون في غضون 7 أيام من الوقت الحالي

options
ServiceGetUserDelegationKeyOptions

المرتجعات

Promise<ServiceGetUserDelegationKeyResponse>

listContainers(ServiceListContainersOptions)

إرجاع مكرر غير متزامن لسرد جميع الحاويات ضمن الحساب المحدد. يقوم .byPage() بإرجاع مكرر غير متزامن لسرد الحاويات في الصفحات.

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

let i = 1;
for await (const container of blobServiceClient.listContainers()) {
  console.log(`Container ${i++}: ${container.name}`);
}

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

let i = 1;
const iter = blobServiceClient.listContainers();
let containerItem = await iter.next();
while (!containerItem.done) {
  console.log(`Container ${i++}: ${containerItem.value.name}`);
  containerItem = await iter.next();
}

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

// passing optional maxPageSize in the page settings
let i = 1;
for await (const response of blobServiceClient.listContainers().byPage({ maxPageSize: 20 })) {
  if (response.containerItems) {
    for (const container of response.containerItems) {
      console.log(`Container ${i++}: ${container.name}`);
    }
  }
}

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

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

// Prints 2 container names
if (response.containerItems) {
  for (const container of response.containerItems) {
    console.log(`Container ${i++}: ${container.name}`);
  }
}

// Gets next marker
let marker = response.continuationToken;
// Passing next marker as continuationToken
iterator = blobServiceClient
  .listContainers()
  .byPage({ continuationToken: marker, maxPageSize: 10 });
response = (await iterator.next()).value;

// Prints 10 container names
if (response.containerItems) {
  for (const container of response.containerItems) {
     console.log(`Container ${i++}: ${container.name}`);
  }
}

function listContainers(options?: ServiceListContainersOptions)

المعلمات

options
ServiceListContainersOptions

خيارات لسرد الحاويات.

المرتجعات

PagedAsyncIterableIterator<ContainerItem, ServiceListContainersSegmentResponse>

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

setProperties(BlobServiceProperties, ServiceSetPropertiesOptions)

تعيين خصائص نقطة نهاية خدمة Blob لحساب التخزين، بما في ذلك خصائص Storage Analytics وقواعد CORS (مشاركة الموارد عبر المنشأ) وإعدادات الحذف المبدئي.

function setProperties(properties: BlobServiceProperties, options?: ServiceSetPropertiesOptions)

المعلمات

properties
BlobServiceProperties
options
ServiceSetPropertiesOptions

خيارات لعملية خصائص مجموعة الخدمة.

المرتجعات

Promise<ServiceSetPropertiesResponse>

بيانات الاستجابة لعملية خصائص مجموعة الخدمة.

undeleteContainer(string, string, ServiceUndeleteContainerOptions)

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

function undeleteContainer(deletedContainerName: string, deletedContainerVersion: string, options?: ServiceUndeleteContainerOptions)

المعلمات

deletedContainerName

string

اسم الحاوية المحذوفة مسبقا.

deletedContainerVersion

string

إصدار الحاوية المحذوفة مسبقا، المستخدمة لتعريف الحاوية المحذوفة بشكل فريد.

options
ServiceUndeleteContainerOptions

خيارات لتكوين عملية استعادة الحاوية.

المرتجعات

Promise<Object>

استجابة حذف الحاوية.