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)

Параметры

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

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

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

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

Параметры

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

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

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

Параметры

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

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

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

Параметры

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

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

Операция Get Account Information возвращает имя 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)

Параметры

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

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