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

Значение свойства

Например, AnonymousCredential, StorageSharedKeyCredential или любые учетные @azure/identity данные из пакета для проверки подлинности запросов к службе. Можно также предоставить объект, реализующий интерфейс TokenCredential. Если не указано, используется AnonymousCredential.

credential: StorageSharedKeyCredential | AnonymousCredential | TokenCredential

Значение свойства

Закодированное значение строки URL-адреса.

url: string

Значение свойства

Создайте контейнер BLOB-объектов.

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

Параметры

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

Ответ на создание контейнера и соответствующий клиент контейнера.

Удаляет контейнер BLOB-объектов.

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

Параметры

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

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

Возвращает асинхронный итератор для поиска всех BLOB-объектов с указанным тегом в указанной учетной записи. .byPage() возвращает асинхронный итератор для перечисления больших двоичных объектов на страницах.

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

Параметры

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

Создает экземпляр BlobServiceClient из строки подключения.

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

Параметры

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

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

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

Параметры

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

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

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

function getAccountInfo(options?: ServiceGetAccountInfoOptions)

Параметры

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

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

Создает объект BlobBatchClient для выполнения пакетных операций.

function getBlobBatchClient()

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

Новый объект BlobBatchClient для этой службы.

Создает <xref:ContainerClient> объект

function getContainerClient(containerName: string)

Параметры

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

Новый объект ContainerClient для заданного имени контейнера.

Пример использования:

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

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

function getProperties(options?: ServiceGetPropertiesOptions)

Параметры

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

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

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

function getStatistics(options?: ServiceGetStatisticsOptions)

Параметры

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

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

ДОСТУПНО ТОЛЬКО ПРИ ИСПОЛЬЗОВАНИИ ПРОВЕРКИ ПОДЛИННОСТИ МАРКЕРА НОСИТЕЛЯ (TokenCredential). Извлекает ключ делегирования пользователя для службы BLOB-объектов. Это допустимая операция только при использовании проверки подлинности маркера носителя.

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

Параметры

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

Возвращает асинхронный итератор для вывода списка всех контейнеров в указанной учетной записи. .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)

Параметры

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

AsyncIterableIterator, поддерживающий разбиение по страницам.

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

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

Параметры

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

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

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

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

Параметры

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

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