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, созданного с использованием учетных данных общего ключа.

Создает универсальный код ресурса (URI) подписанного URL-адреса учетной записи BLOB-объекта на основе свойств и параметров клиента, переданных. SAS подписан учетными данными общего ключа клиента.

См. https://learn.microsoft.com/en-us/rest/api/storageservices/create-account-sas

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

Параметры

Возвращаемое значение

URI SAS учетной записи, состоящий из URI ресурса, представленного этим клиентом, за которым следует созданный маркер SAS.

Доступно только для BLOBServiceClient, созданного с использованием учетных данных общего ключа.

Создает строку для входа для URI подписанного URL-адреса учетной записи BLOB-объектов (SAS) на основе свойств и параметров клиента, переданных в. SAS подписан учетными данными общего ключа клиента.

См. https://learn.microsoft.com/en-us/rest/api/storageservices/create-account-sas

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

Параметры

Возвращаемое значение

URI SAS учетной записи, состоящий из URI ресурса, представленного этим клиентом, за которым следует созданный маркер SAS.

Операция Get Account Information возвращает имя sku и тип учетной записи для указанной учетной записи. Операция получения сведений об учетной записи доступна в версиях служб, начиная с версии 2018-03-28.

См. https://learn.microsoft.com/en-us/rest/api/storageservices/get-account-information

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

Параметры

Возвращаемое значение

Ответные данные для операции получения сведений об учетной записи службы.

Создает объект 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-объектов учетной записи хранения, включая свойства для правил аналитики хранилища и CORS (совместного использования ресурсов между источниками).

См. https://learn.microsoft.com/en-us/rest/api/storageservices/get-blob-service-properties

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

Параметры

Возвращаемое значение

Ответные данные для операции получения свойств службы.

Извлекает статистику, связанную с репликацией для службы BLOB-объектов. Она доступна только в конечной точке дополнительного расположения, если для учетной записи хранения включена геоизбыточная репликация доступа для чтения.

См. https://learn.microsoft.com/en-us/rest/api/storageservices/get-blob-service-stats

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

Параметры

Возвращаемое значение

Ответные данные для операции получения статистики службы.

ДОСТУПНО ТОЛЬКО ПРИ ИСПОЛЬЗОВАНИИ ПРОВЕРКИ ПОДЛИННОСТИ МАРКЕРА НОСИТЕЛЯ (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-объектов учетной записи хранения, включая свойства для аналитики хранилища, правил CORS (совместного использования ресурсов между источниками) и параметров обратимого удаления.

См. https://learn.microsoft.com/en-us/rest/api/storageservices/set-blob-service-properties

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

Параметры

Возвращаемое значение

Ответные данные для операции "Свойства набора служб".

Восстановите ранее удаленный контейнер BLOB-объектов. Этот API работает только в том случае, если для учетной записи хранения, связанной с контейнером, включен обратимое удаление контейнера.

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

Параметры

Возвращаемое значение

Ответ на удаление контейнера.