ContainerClient class

Cria uma instância de ContainerClient. Esse método aceita uma URL apontando para um contêiner. A cadeia de caracteres de URL codificada NÃO será escapada duas vezes, apenas caracteres especiais no caminho da URL serão escapados. Se um nome de blob incluir ? ou %, o nome do blob deve ser codificado na URL.

new ContainerClient(url: string, pipeline: PipelineLike)

Parâmetros

Cria uma instância de ContainerClient. Esse método aceita uma URL apontando para um contêiner. A cadeia de caracteres de URL codificada NÃO será escapada duas vezes, apenas caracteres especiais no caminho da URL serão escapados. Se um nome de blob incluir ? ou %, o nome do blob deve ser codificado na URL.

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

Parâmetros

Cria uma instância de ContainerClient.

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

Parâmetros

accountName: string

Valor de Propriedade

O nome do contêiner.

string containerName

Valor de Propriedade

Como AnonymousCredential, StorageSharedKeyCredential ou qualquer credencial do pacote @azure/identity para autenticar solicitações para o serviço. Você também pode fornecer um objeto que implementa a interface TokenCredential. Se não for especificado, AnonymousCredential será usado.

credential: StorageSharedKeyCredential | AnonymousCredential | TokenCredential

Valor de Propriedade

Valor da cadeia de caracteres de URL codificada.

url: string

Valor de Propriedade

Cria um novo contêiner na conta especificada. Se o contêiner com o mesmo nome já existir, a operação falhará.

function create(options?: ContainerCreateOptions)

Parâmetros

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

Devoluções

Cria um novo contêiner na conta especificada. Se o contêiner com o mesmo nome já existir, ele não será alterado.

function createIfNotExists(options?: ContainerCreateOptions)

Parâmetros

Devoluções

Marca o contêiner especificado para exclusão. O recipiente e quaisquer blobs contidos nele são posteriormente excluídos durante a coleta de lixo.

function delete(options?: ContainerDeleteMethodOptions)

Parâmetros

Devoluções

Marca o blob ou instantâneo especificado para exclusão. O blob é posteriormente excluído durante a coleta de lixo. Observe que, para excluir um blob, você deve excluir todos os seus instantâneos. Você pode excluir ambos ao mesmo tempo com a operação Excluir Blob.

function deleteBlob(blobName: string, options?: ContainerDeleteBlobOptions)

Parâmetros

Devoluções

Bloquear dados de resposta de exclusão de blob.

Marca o contêiner especificado para exclusão, se ele existir. O recipiente e quaisquer blobs contidos nele são posteriormente excluídos durante a coleta de lixo.

function deleteIfExists(options?: ContainerDeleteMethodOptions)

Parâmetros

Devoluções

Retorna true se o recurso de contêiner do Azure representado por este cliente existir; falso caso contrário. NOTA: utilize esta função com cuidado, uma vez que um contentor existente pode ser eliminado por outros clientes ou aplicações. Vice-versa, novos contêineres com o mesmo nome podem ser adicionados por outros clientes ou aplicativos após a conclusão dessa função.

function exists(options?: ContainerExistsOptions)

Parâmetros

Devoluções

Disponível apenas para ContainerClient construído com uma credencial de chave compartilhada. Gera um URI SAS (Assinatura de Acesso Compartilhado) do Serviço de Contêiner de Blob com base nas propriedades e parâmetros do cliente passados. O SAS é assinado pela credencial de chave compartilhada do cliente.

function generateSasUrl(options: ContainerGenerateSasUrlOptions)

Parâmetros

Devoluções

O URI SAS que consiste no URI para o recurso representado por este cliente, seguido pelo token SAS gerado.

Obtém as permissões para o contêiner especificado. As permissões indicam se os dados do contêiner podem ser acessados publicamente. AVISO: JavaScript Date perderá potencialmente a precisão ao analisar startsOn e expiresOn strings. Por exemplo, a nova Data("2018-12-31T03:44:23.8827891Z").toISOString() obterá "2018-12-31T03:44:23.882Z".

function getAccessPolicy(options?: ContainerGetAccessPolicyOptions)

Parâmetros

Devoluções

Cria um <xref:AppendBlobClient>

function getAppendBlobClient(blobName: string)

Parâmetros

Devoluções

Cria um objeto BlobBatchClient para conduzir operações em lote.

function getBlobBatchClient()

Devoluções

Um novo objeto BlobBatchClient para este contêiner.

Cria um <xref:BlobClient>

function getBlobClient(blobName: string)

Parâmetros

Devoluções

Um novo objeto BlobClient para o nome de blob fornecido.

Obtenha um <xref:BlobLeaseClient> que gerencie as locações no contêiner.

function getBlobLeaseClient(proposeLeaseId?: string)

Parâmetros

Devoluções

Um novo objeto BlobLeaseClient para gerenciar concessões no contêiner.

Cria um <xref:BlockBlobClient>

function getBlockBlobClient(blobName: string)

Parâmetros

const content = "Hello world!";

const blockBlobClient = containerClient.getBlockBlobClient("<blob name>");
const uploadBlobResponse = await blockBlobClient.upload(content, content.length);

Devoluções

Cria um <xref:PageBlobClient>

function getPageBlobClient(blobName: string)

Parâmetros

Devoluções

Retorna todos os metadados definidos pelo usuário e as propriedades do sistema para o contêiner especificado. Os dados retornados não incluem a lista de blobs do contêiner.

function getProperties(options?: ContainerGetPropertiesOptions)

Parâmetros

Devoluções

Retorna um iterador iterável assíncrono para listar todos os blobs por hierarquia. na conta especificada. .byPage() retorna um iterador iterável assíncrono para listar os blobs por hierarquia nas páginas.

Exemplo usando sintaxe for await:

for await (const item of containerClient.listBlobsByHierarchy("/")) {
  if (item.kind === "prefix") {
    console.log(`\tBlobPrefix: ${item.name}`);
  } else {
    console.log(`\tBlobItem: name - ${item.name}, last modified - ${item.properties.lastModified}`);
  }
}

Exemplo usando iter.next():

let iter = containerClient.listBlobsByHierarchy("/", { prefix: "prefix1/" });
let entity = await iter.next();
while (!entity.done) {
  let item = entity.value;
  if (item.kind === "prefix") {
    console.log(`\tBlobPrefix: ${item.name}`);
  } else {
    console.log(`\tBlobItem: name - ${item.name}, last modified - ${item.properties.lastModified}`);
  }
  entity = await iter.next();
}

Exemplo usando byPage():

console.log("Listing blobs by hierarchy by page");
for await (const response of containerClient.listBlobsByHierarchy("/").byPage()) {
  const segment = response.segment;
  if (segment.blobPrefixes) {
    for (const prefix of segment.blobPrefixes) {
      console.log(`\tBlobPrefix: ${prefix.name}`);
    }
  }
  for (const blob of response.segment.blobItems) {
    console.log(`\tBlobItem: name - ${blob.name}, last modified - ${blob.properties.lastModified}`);
  }
}

Exemplo de utilização de paginação com um tamanho máximo de página:

console.log("Listing blobs by hierarchy by page, specifying a prefix and a max page size");

let i = 1;
for await (const response of containerClient.listBlobsByHierarchy("/", { prefix: "prefix2/sub1/"}).byPage({ maxPageSize: 2 })) {
  console.log(`Page ${i++}`);
  const segment = response.segment;

  if (segment.blobPrefixes) {
    for (const prefix of segment.blobPrefixes) {
      console.log(`\tBlobPrefix: ${prefix.name}`);
    }
  }

  for (const blob of response.segment.blobItems) {
    console.log(`\tBlobItem: name - ${blob.name}, last modified - ${blob.properties.lastModified}`);
  }
}

function listBlobsByHierarchy(delimiter: string, options?: ContainerListBlobsOptions)

Parâmetros

Devoluções

Retorna um iterador iterável assíncrono para listar todos os blobs na conta especificada. .byPage() retorna um iterador iterável assíncrono para listar os blobs nas páginas.

Exemplo usando sintaxe for await:

// Get the containerClient before you run these snippets,
// Can be obtained from `blobServiceClient.getContainerClient("<your-container-name>");`
let i = 1;
for await (const blob of containerClient.listBlobsFlat()) {
  console.log(`Blob ${i++}: ${blob.name}`);
}

Exemplo usando iter.next():

let i = 1;
let iter = containerClient.listBlobsFlat();
let blobItem = await iter.next();
while (!blobItem.done) {
  console.log(`Blob ${i++}: ${blobItem.value.name}`);
  blobItem = await iter.next();
}

Exemplo usando byPage():

// passing optional maxPageSize in the page settings
let i = 1;
for await (const response of containerClient.listBlobsFlat().byPage({ maxPageSize: 20 })) {
  for (const blob of response.segment.blobItems) {
    console.log(`Blob ${i++}: ${blob.name}`);
  }
}

Exemplo de utilização da paginação com um marcador:

let i = 1;
let iterator = containerClient.listBlobsFlat().byPage({ maxPageSize: 2 });
let response = (await iterator.next()).value;

// Prints 2 blob names
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
for (const blob of response.segment.blobItems) {
  console.log(`Blob ${i++}: ${blob.name}`);
}

function listBlobsFlat(options?: ContainerListBlobsOptions)

Parâmetros

Devoluções

Um asyncIterableIterator que suporta paginação.

Define as permissões para o contêiner especificado. As permissões indicam se os blobs em um contêiner podem ser acessados publicamente. Quando você define permissões para um contêiner, as permissões existentes são substituídas. Se nenhum acesso ou containerAcl fornecido, a ACL do contêiner existente será removida.

Quando você estabelece uma política de acesso armazenado em um contêiner, ela pode levar até 30 segundos para entrar em vigor. Durante esse intervalo, uma assinatura de acesso compartilhado associada à política de acesso armazenado falhará com o código de status 403 (Proibido), até que a política de acesso fique ativa.

function setAccessPolicy(access?: PublicAccessType, containerAcl?: SignedIdentifier[], options?: ContainerSetAccessPolicyOptions)

Parâmetros

Devoluções

Define um ou mais pares nome-valor definidos pelo usuário para o contêiner especificado. Se nenhuma opção for fornecida, ou nenhum metadados definido no parâmetro, os metadados do contêiner serão removidos.

function setMetadata(metadata?: Metadata, options?: ContainerSetMetadataOptions)

Parâmetros

Devoluções

Cria um novo blob de bloco ou atualiza o conteúdo de um blob de bloco existente. A atualização de um blob de bloco existente substitui quaisquer metadados existentes no blob. Não há suporte para atualizações parciais; O conteúdo do blob existente é substituído pelo novo conteúdo. Para executar uma atualização parcial de um blob de bloco, use <xref:BlockBlobClient.stageBlock> e <xref:BlockBlobClient.commitBlockList>.

Este é um método de upload não paralelo, use <xref:BlockBlobClient.uploadFile>, <xref:BlockBlobClient.uploadStream> ou <xref:BlockBlobClient.uploadBrowserData> para um melhor desempenho com o upload simultâneo.

function uploadBlockBlob(blobName: string, body: HttpRequestBody, contentLength: number, options?: BlockBlobUploadOptions)

Parâmetros

Devoluções

Bloqueie os dados de resposta de carregamento de Blob e a instância BlockBlobClient correspondente.