ContainerClient class

Создает экземпляр ContainerClient. Этот метод принимает URL-адрес, указывающий на контейнер. Строка ЗАкодированного URL-адреса не будет экранирована дважды, будут экранированы только специальные символы в пути URL-адреса. Если имя большого двоичного объекта включается? или %, имя большого двоичного объекта должно быть закодировано в URL-адресе.

new ContainerClient(url: string, pipeline: PipelineLike)

Параметры

Создает экземпляр ContainerClient. Этот метод принимает URL-адрес, указывающий на контейнер. Строка ЗАкодированного URL-адреса не будет экранирована дважды, будут экранированы только специальные символы в пути URL-адреса. Если имя большого двоичного объекта включается? или %, имя большого двоичного объекта должно быть закодировано в URL-адресе.

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

Параметры

Создает экземпляр ContainerClient.

new ContainerClient(connectionString: string, containerName: string, options?: StoragePipelineOptions)

Параметры

Имя контейнера.

string containerName

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

accountName: string

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

наследуется от storageClient.accountName

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

credential: StorageSharedKeyCredential | AnonymousCredential | TokenCredential

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

наследуется от StorageClient.credential

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

url: string

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

наследуется от StorageClient.url

Создает контейнер под указанной учетной записью. Если контейнер с тем же именем уже существует, операция завершается ошибкой.

См. правила именования https://learn.microsoft.com/rest/api/storageservices/create-container: см. https://learn.microsoft.com/rest/api/storageservices/naming-and-referencing-containers--blobs--and-metadata

function create(options?: ContainerCreateOptions): Promise<ContainerCreateResponse>

Параметры

import { BlobServiceClient } from "@azure/storage-blob";
import { DefaultAzureCredential } from "@azure/identity";

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

const containerName = "<container name>";
const containerClient = blobServiceClient.getContainerClient(containerName);
const createContainerResponse = await containerClient.create();
console.log("Container was created successfully", createContainerResponse.requestId);

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

Создает контейнер под указанной учетной записью. Если контейнер с тем же именем уже существует, он не изменяется.

См. правила именования https://learn.microsoft.com/rest/api/storageservices/create-container: см. https://learn.microsoft.com/rest/api/storageservices/naming-and-referencing-containers--blobs--and-metadata

function createIfNotExists(options?: ContainerCreateOptions): Promise<ContainerCreateIfNotExistsResponse>

Параметры

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

Помечает указанный контейнер для удаления. Контейнер и все большие двоичные объекты, содержащиеся в нем, позже удаляются во время сборки мусора.

См. раздел https://learn.microsoft.com/rest/api/storageservices/delete-container.

function delete(options?: ContainerDeleteMethodOptions): Promise<ContainerDeleteResponse>

Параметры

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

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

См. раздел https://learn.microsoft.com/rest/api/storageservices/delete-blob.

function deleteBlob(blobName: string, options?: ContainerDeleteBlobOptions): Promise<BlobDeleteResponse>

Параметры

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

Блочные данные ответа на удаление BLOB-объектов.

Помечает указанный контейнер для удаления, если он существует. Контейнер и все большие двоичные объекты, содержащиеся в нем, позже удаляются во время сборки мусора.

См. раздел https://learn.microsoft.com/rest/api/storageservices/delete-container.

function deleteIfExists(options?: ContainerDeleteMethodOptions): Promise<ContainerDeleteIfExistsResponse>

Параметры

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

Возвращает значение true, если ресурс контейнера Azure, представленный этим клиентом; False в противном случае.

ПРИМЕЧАНИЕ. Используйте эту функцию с осторожностью, так как существующий контейнер может быть удален другими клиентами или приложениями. Наоборот, новые контейнеры с тем же именем могут быть добавлены другими клиентами или приложениями после завершения этой функции.

function exists(options?: ContainerExistsOptions): Promise<boolean>

Параметры

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

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

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

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

import { BlobServiceClient } from "@azure/storage-blob";
import { DefaultAzureCredential } from "@azure/identity";

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

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

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

// Example using `iter.next()` syntax
i = 1;
const iter = containerClient.findBlobsByTags("tagkey='tagvalue'");
let { value, done } = await iter.next();
while (!done) {
  console.log(`Blob ${i++}: ${value.name}`);
  ({ value, done } = await iter.next());
}

// Example using `byPage()` syntax
i = 1;
for await (const page of containerClient
  .findBlobsByTags("tagkey='tagvalue'")
  .byPage({ maxPageSize: 20 })) {
  for (const blob of page.blobs) {
    console.log(`Blob ${i++}: ${blob.name}`);
  }
}

// Example using paging with a marker
i = 1;
let iterator = containerClient.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 = containerClient
  .findBlobsByTags("tagkey='tagvalue'")
  .byPage({ continuationToken: marker, maxPageSize: 10 });
response = (await iterator.next()).value;
// Prints 10 blob names
if (response.blobs) {
  for (const blob of response.blobs) {
    console.log(`Blob ${i++}: ${blob.name}`);
  }
}

function findBlobsByTags(tagFilterSqlExpression: string, options?: ContainerFindBlobByTagsOptions): PagedAsyncIterableIterator<FilterBlobItem, ContainerFindBlobsByTagsSegmentResponse, PageSettings>

Параметры

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

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

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

См. раздел https://learn.microsoft.com/rest/api/storageservices/constructing-a-service-sas.

function generateSasStringToSign(options: ContainerGenerateSasUrlOptions): string

Параметры

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

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

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

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

См. раздел https://learn.microsoft.com/rest/api/storageservices/constructing-a-service-sas.

function generateSasUrl(options: ContainerGenerateSasUrlOptions): Promise<string>

Параметры

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

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

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

См. раздел https://learn.microsoft.com/rest/api/storageservices/constructing-a-service-sas.

function generateUserDelegationSasStringToSign(options: ContainerGenerateSasUrlOptions, userDelegationKey: UserDelegationKey): string

Параметры

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

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

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

См. раздел https://learn.microsoft.com/rest/api/storageservices/constructing-a-service-sas.

function generateUserDelegationSasUrl(options: ContainerGenerateSasUrlOptions, userDelegationKey: UserDelegationKey): Promise<string>

Параметры

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

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

Получает разрешения для указанного контейнера. Разрешения указывают, могут ли данные контейнера получить общедоступный доступ.

ПРЕДУПРЕЖДЕНИЕ. Дата JavaScript потенциально потеряет точность при синтаксическом анализе начинается и истекает срок действия строкOn. Например, new Date("2018-12-31T03:44:23.8827891Z").toISOString() получит "2018-12-31T03:44:23.882Z".

См. раздел https://learn.microsoft.com/rest/api/storageservices/get-container-acl.

function getAccessPolicy(options?: ContainerGetAccessPolicyOptions): Promise<ContainerGetAccessPolicyResponse>

Параметры

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

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

См. раздел https://learn.microsoft.com/rest/api/storageservices/get-account-information.

function getAccountInfo(options?: ContainerGetAccountInfoOptions): Promise<ContainerGetAccountInfoResponse>

Параметры

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

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

Создает AppendBlobClient

function getAppendBlobClient(blobName: string): AppendBlobClient

Параметры

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

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

См. раздел https://learn.microsoft.com/rest/api/storageservices/blob-batch.

function getBlobBatchClient(): BlobBatchClient

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

Новый объект BlobBatchClient для этого контейнера.

Создает BLOBClient

function getBlobClient(blobName: string): BlobClient

Параметры

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

Новый объект BLOBClient для заданного имени большого двоичного объекта.

Получите BlobLeaseClient, которая управляет арендой контейнера.

function getBlobLeaseClient(proposeLeaseId?: string): BlobLeaseClient

Параметры

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

Новый объект BlobLeaseClient для управления арендами контейнера.

Создает BlockBlobClient

function getBlockBlobClient(blobName: string): BlockBlobClient

Параметры

import { BlobServiceClient } from "@azure/storage-blob";
import { DefaultAzureCredential } from "@azure/identity";

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

const containerName = "<container name>";
const blobName = "<blob name>";
const containerClient = blobServiceClient.getContainerClient(containerName);
const blockBlobClient = containerClient.getBlockBlobClient(blobName);

const content = "Hello world!";
const uploadBlobResponse = await blockBlobClient.upload(content, content.length);

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

Создает PageBlobClient

function getPageBlobClient(blobName: string): PageBlobClient

Параметры

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

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

См. раздел https://learn.microsoft.com/rest/api/storageservices/get-container-properties.

ПРЕДУПРЕЖДЕНИЕ. Объект metadata, возвращенный в ответе, будет иметь свои ключи в нижнем регистре, даже если они первоначально содержали прописные символы. Это отличается от ключей метаданных, возвращаемых методом listContainersBLOBServiceClient с помощью параметра includeMetadata, который будет хранить исходный регистр.

function getProperties(options?: ContainerGetPropertiesOptions): Promise<ContainerGetPropertiesResponse>

Параметры

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

Возвращает асинхронный итератор для перечисления всех больших двоичных объектов по иерархии. под указанной учетной записью.

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

import { BlobServiceClient } from "@azure/storage-blob";
import { DefaultAzureCredential } from "@azure/identity";

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

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

// Example using `for await` syntax
let i = 1;
const blobs = containerClient.listBlobsByHierarchy("/");
for await (const blob of blobs) {
  if (blob.kind === "prefix") {
    console.log(`\tBlobPrefix: ${blob.name}`);
  } else {
    console.log(`\tBlobItem: name - ${blob.name}`);
  }
}

// Example using `iter.next()` syntax
i = 1;
const iter = containerClient.listBlobsByHierarchy("/");
let { value, done } = await iter.next();
while (!done) {
  if (value.kind === "prefix") {
    console.log(`\tBlobPrefix: ${value.name}`);
  } else {
    console.log(`\tBlobItem: name - ${value.name}`);
  }
  ({ value, done } = await iter.next());
}

// Example using `byPage()` syntax
i = 1;
for await (const page of containerClient.listBlobsByHierarchy("/").byPage({ maxPageSize: 20 })) {
  const segment = page.segment;
  if (segment.blobPrefixes) {
    for (const prefix of segment.blobPrefixes) {
      console.log(`\tBlobPrefix: ${prefix.name}`);
    }
  }
  for (const blob of page.segment.blobItems) {
    console.log(`\tBlobItem: name - ${blob.name}`);
  }
}

// Example using paging with a marker
i = 1;
let iterator = containerClient.listBlobsByHierarchy("/").byPage({ maxPageSize: 2 });
let response = (await iterator.next()).value;
// Prints 2 blob names
if (response.blobPrefixes) {
  for (const prefix of response.blobPrefixes) {
    console.log(`\tBlobPrefix: ${prefix.name}`);
  }
}
if (response.segment.blobItems) {
  for (const blob of response.segment.blobItems) {
    console.log(`\tBlobItem: name - ${blob.name}`);
  }
}
// Gets next marker
let marker = response.continuationToken;
// Passing next marker as continuationToken
iterator = containerClient
  .listBlobsByHierarchy("/")
  .byPage({ continuationToken: marker, maxPageSize: 10 });
response = (await iterator.next()).value;
// Prints 10 blob names
if (response.blobPrefixes) {
  for (const prefix of response.blobPrefixes) {
    console.log(`\tBlobPrefix: ${prefix.name}`);
  }
}
if (response.segment.blobItems) {
  for (const blob of response.segment.blobItems) {
    console.log(`Blob ${i++}: ${blob.name}`);
  }
}

function listBlobsByHierarchy(delimiter: string, options?: ContainerListBlobsOptions): PagedAsyncIterableIterator<({ kind: "prefix" } & BlobPrefix) | ({ kind: "blob" } & BlobItem), ContainerListBlobHierarchySegmentResponse, PageSettings>

Параметры

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

Возвращает асинхронный итератор для перечисления всех больших двоичных объектов в указанной учетной записи.

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

import { BlobServiceClient } from "@azure/storage-blob";
import { DefaultAzureCredential } from "@azure/identity";

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

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

// Example using `for await` syntax
let i = 1;
const blobs = containerClient.listBlobsFlat();
for await (const blob of blobs) {
  console.log(`Blob ${i++}: ${blob.name}`);
}

// Example using `iter.next()` syntax
i = 1;
const iter = containerClient.listBlobsFlat();
let { value, done } = await iter.next();
while (!done) {
  console.log(`Blob ${i++}: ${value.name}`);
  ({ value, done } = await iter.next());
}

// Example using `byPage()` syntax
i = 1;
for await (const page of containerClient.listBlobsFlat().byPage({ maxPageSize: 20 })) {
  for (const blob of page.segment.blobItems) {
    console.log(`Blob ${i++}: ${blob.name}`);
  }
}

// Example using paging with a marker
i = 1;
let iterator = containerClient.listBlobsFlat().byPage({ maxPageSize: 2 });
let response = (await iterator.next()).value;
// Prints 2 blob names
if (response.segment.blobItems) {
  for (const blob of response.segment.blobItems) {
    console.log(`Blob ${i++}: ${blob.name}`);
  }
}
// Gets next marker
let marker = response.continuationToken;
// Passing next marker as continuationToken
iterator = containerClient.listBlobsFlat().byPage({ continuationToken: marker, maxPageSize: 10 });
response = (await iterator.next()).value;
// Prints 10 blob names
if (response.segment.blobItems) {
  for (const blob of response.segment.blobItems) {
    console.log(`Blob ${i++}: ${blob.name}`);
  }
}

function listBlobsFlat(options?: ContainerListBlobsOptions): PagedAsyncIterableIterator<BlobItem, ContainerListBlobFlatSegmentResponse, PageSettings>

Параметры

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

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

Задает разрешения для указанного контейнера. Разрешения указывают, доступны ли большие двоичные объекты в контейнере общедоступным образом.

При установке разрешений для контейнера заменяются существующие разрешения. Если доступ или контейнерAcl не указан, доступ к существующему ACL контейнера будет удален.

При установке хранимой политики доступа в контейнере может потребоваться до 30 секунд. В течение этого интервала подписанный URL-адрес, связанный с хранимой политикой доступа, завершится ошибкой с кодом состояния 403 (запрещено), пока политика доступа не станет активной.

См. раздел https://learn.microsoft.com/rest/api/storageservices/set-container-acl.

function setAccessPolicy(access?: PublicAccessType, containerAcl?: SignedIdentifier[], options?: ContainerSetAccessPolicyOptions): Promise<ContainerSetAccessPolicyResponse>

Параметры

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

Задает одну или несколько определяемых пользователем пар name-value для указанного контейнера.

Если в параметре не указан параметр или метаданные, определенные в параметре, метаданные контейнера будут удалены.

См. раздел https://learn.microsoft.com/rest/api/storageservices/set-container-metadata.

function setMetadata(metadata?: Metadata, options?: ContainerSetMetadataOptions): Promise<ContainerSetMetadataResponse>

Параметры

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

Создает новый блочный большой двоичный объект или обновляет содержимое существующего блочного большого двоичного объекта.

Обновление существующего блочного BLOB-объекта перезаписывает все существующие метаданные большого двоичного объекта. Частичные обновления не поддерживаются; Содержимое существующего большого двоичного объекта перезаписывается новым содержимым. Чтобы выполнить частичное обновление блочного большого двоичного объекта, используйте stageBlock и commitBlockList.

Это не параллельный метод отправки, используйте uploadFile, uploadStream или uploadBrowserData для повышения производительности при отправке параллелизма.

См. раздел https://learn.microsoft.com/rest/api/storageservices/put-blob.

function uploadBlockBlob(blobName: string, body: RequestBodyType, contentLength: number, options?: BlockBlobUploadOptions): Promise<{ blockBlobClient: BlockBlobClient, response: BlockBlobUploadResponse }>

Параметры

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

Блочные данные ответа отправки BLOB-объектов и соответствующий экземпляр BlockBlobClient.