BlobServiceClient class

إنشاء مثيل BlobServiceClient.

new BlobServiceClient(url: string, pipeline: PipelineLike)

المعلمات

إنشاء مثيل BlobServiceClient.

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

المعلمات

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

قيمة الخاصية

موروث من StorageClient.accountName

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

credential: StorageSharedKeyCredential | AnonymousCredential | TokenCredential

قيمة الخاصية

موروث من StorageClient.credential

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

url: string

قيمة الخاصية

موروث من StorageClient.url

إنشاء حاوية Blob.

راجع https://learn.microsoft.com/en-us/rest/api/storageservices/create-container

function createContainer(containerName: string, options?: ContainerCreateOptions): Promise<{ containerClient: ContainerClient, containerCreateResponse: ContainerCreateResponse }>

المعلمات

المرتجعات

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

حذف حاوية Blob.

function deleteContainer(containerName: string, options?: ContainerDeleteMethodOptions): Promise<ContainerDeleteResponse>

المعلمات

المرتجعات

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

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

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

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

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

let i = 1;
for await (const blob of blobServiceClient.findBlobsByTags("tagkey='tagvalue'")) {
  console.log(`Blob ${i++}: ${container.name}`);
}

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

let i = 1;
const iter = blobServiceClient.findBlobsByTags("tagkey='tagvalue'");
let blobItem = await iter.next();
while (!blobItem.done) {
  console.log(`Blob ${i++}: ${blobItem.value.name}`);
  blobItem = await iter.next();
}

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

// passing optional maxPageSize in the page settings
let i = 1;
for await (const response of blobServiceClient.findBlobsByTags("tagkey='tagvalue'").byPage({ maxPageSize: 20 })) {
  if (response.blobs) {
    for (const blob of response.blobs) {
      console.log(`Blob ${i++}: ${blob.name}`);
    }
  }
}

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

let i = 1;
let iterator = blobServiceClient.findBlobsByTags("tagkey='tagvalue'").byPage({ maxPageSize: 2 });
let response = (await iterator.next()).value;

// Prints 2 blob names
if (response.blobs) {
  for (const blob of response.blobs) {
    console.log(`Blob ${i++}: ${blob.name}`);
  }
}

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

// Prints blob names
if (response.blobs) {
  for (const blob of response.blobs) {
     console.log(`Blob ${i++}: ${blob.name}`);
  }
}

function findBlobsByTags(tagFilterSqlExpression: string, options?: ServiceFindBlobByTagsOptions): PagedAsyncIterableIterator<FilterBlobItem, ServiceFindBlobsByTagsSegmentResponse, PageSettings>

المعلمات

المرتجعات

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

static function fromConnectionString(connectionString: string, options?: StoragePipelineOptions): BlobServiceClient

المعلمات

المرتجعات

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

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

راجع https://learn.microsoft.com/en-us/rest/api/storageservices/create-account-sas

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

المعلمات

المرتجعات

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

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

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

راجع https://learn.microsoft.com/en-us/rest/api/storageservices/create-account-sas

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

المعلمات

المرتجعات

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

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

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

function getAccountInfo(options?: ServiceGetAccountInfoOptions): Promise<ServiceGetAccountInfoResponse>

المعلمات

المرتجعات

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

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

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

function getBlobBatchClient(): BlobBatchClient

المرتجعات

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

إنشاء كائن containerClient

function getContainerClient(containerName: string): ContainerClient

المعلمات

المرتجعات

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

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

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

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

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

function getProperties(options?: ServiceGetPropertiesOptions): Promise<ServiceGetPropertiesResponse>

المعلمات

المرتجعات

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

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

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

function getStatistics(options?: ServiceGetStatisticsOptions): Promise<ServiceGetStatisticsResponse>

المعلمات

المرتجعات

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

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

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

راجع https://learn.microsoft.com/en-us/rest/api/storageservices/get-user-delegation-key

function getUserDelegationKey(startsOn: Date, expiresOn: Date, options?: ServiceGetUserDelegationKeyOptions): Promise<ServiceGetUserDelegationKeyResponse>

المعلمات

المرتجعات

ترجع هذه الدالة مكرر غير متزامن لسرد كافة الحاويات ضمن الحساب المحدد.

يقوم .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): PagedAsyncIterableIterator<ContainerItem, ServiceListContainersSegmentResponse, PageSettings>

المعلمات

المرتجعات

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

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

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

function setProperties(properties: BlobServiceProperties, options?: ServiceSetPropertiesOptions): Promise<ServiceSetPropertiesResponse>

المعلمات

المرتجعات

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

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

function undeleteContainer(deletedContainerName: string, deletedContainerVersion: string, options?: ServiceUndeleteContainerOptions): Promise<{ containerClient: ContainerClient, containerUndeleteResponse: ContainerUndeleteResponse }>

المعلمات

المرتجعات

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