ContainerClient class

Cria uma instância do ContainerClient. Este método aceita um URL que aponta para um contentor. A cadeia de URL codificada NÃO será escapada duas vezes, apenas os carateres especiais no caminho do URL serão escapados. Se um nome de blob incluir ? ou %, o nome do blob tem de ser codificado no URL.

new ContainerClient(url: string, pipeline: PipelineLike)

Parâmetros

Cria uma instância do ContainerClient. Este método aceita um URL que aponta para um contentor. A cadeia de URL codificada NÃO será escapada duas vezes, apenas os carateres especiais no caminho do URL serão escapados. Se um nome de blob incluir ? ou %, o nome do blob tem de ser codificado no URL.

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

Parâmetros

Cria uma instância do ContainerClient.

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

Parâmetros

accountName: string

Valor de Propriedade

O nome do contentor.

string containerName

Valor de Propriedade

Tal como AnonymousCredential, StorageSharedKeyCredential ou qualquer credencial do @azure/identity pacote para autenticar pedidos no serviço. Também pode fornecer um objeto que implementa a interface TokenCredential. Se não for especificado, é utilizado AnonymousCredential.

credential: StorageSharedKeyCredential | AnonymousCredential | TokenCredential

Valor de Propriedade

Valor de cadeia de URL codificado.

url: string

Valor de Propriedade

Cria um novo contentor na conta especificada. Se o contentor 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 contentor na conta especificada. Se o contentor com o mesmo nome já existir, não será alterado.

function createIfNotExists(options?: ContainerCreateOptions)

Parâmetros

Devoluções

Marca o contentor especificado para eliminação. O contentor e quaisquer blobs contidos no mesmo são posteriormente eliminados durante a recolha de lixo.

function delete(options?: ContainerDeleteMethodOptions)

Parâmetros

Devoluções

Marca o blob ou instantâneo especificado para eliminação. O blob é posteriormente eliminado durante a recolha de lixo. Tenha em atenção que, para eliminar um blob, tem de eliminar todos os respetivos instantâneos. Pode eliminar ambos ao mesmo tempo com a operação Eliminar Blob.

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

Parâmetros

Devoluções

Bloquear dados de resposta de eliminação de blobs.

Marca o contentor especificado para eliminação, se existir. O contentor e quaisquer blobs contidos no mesmo são posteriormente eliminados durante a recolha de lixo.

function deleteIfExists(options?: ContainerDeleteMethodOptions)

Parâmetros

Devoluções

Devolve verdadeiro se o recurso de contentor do Azure representado por este cliente existir; falso de outra forma. NOTA: utilize esta função com cuidado, uma vez que um contentor existente pode ser eliminado por outros clientes ou aplicações. Os novos contentores vice-versa com o mesmo nome podem ser adicionados por outros clientes ou aplicações após a conclusão desta função.

function exists(options?: ContainerExistsOptions)

Parâmetros

Devoluções

Disponível apenas para ContainerClient construído com uma credencial de chave partilhada. Gera um URI de Assinatura de Acesso Partilhado (SAS) do Serviço de Contentor de Blobs com base nas propriedades e parâmetros do cliente transmitidos. A SAS é assinada pela credencial de chave partilhada do cliente.

function generateSasUrl(options: ContainerGenerateSasUrlOptions)

Parâmetros

Devoluções

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

Obtém as permissões para o contentor especificado. As permissões indicam se os dados de contentor podem ser acedidos publicamente. AVISO: a Data javaScript perderá potencialmente a precisão ao analisar startsOn e expira Em cadeias. 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 realizar operações em lote.

function getBlobBatchClient()

Devoluções

Um novo objeto BlobBatchClient para este contentor.

Cria um <xref:BlobClient>

function getBlobClient(blobName: string)

Parâmetros

Devoluções

Um novo objeto BlobClient para o nome do blob especificado.

Obtenha um que faça a <xref:BlobLeaseClient> gestão de concessões no contentor.

function getBlobLeaseClient(proposeLeaseId?: string)

Parâmetros

Devoluções

Um novo objeto BlobLeaseClient para gerir concessões no contentor.

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

Devolve todas as propriedades de sistema e metadados definidos pelo utilizador para o contentor especificado. Os dados devolvidos não incluem a lista de blobs do contentor.

function getProperties(options?: ContainerGetPropertiesOptions)

Parâmetros

Devoluções

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

Exemplo com for await sintaxe:

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 com 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 com 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 com a paginação com o tamanho máximo da 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

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

Exemplo com for await sintaxe:

// 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 com 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 com 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 com a 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 a paginação.

Define as permissões para o contentor especificado. As permissões indicam se os blobs num contentor podem ser acedidos publicamente. Quando define permissões para um contentor, as permissões existentes são substituídas. Se não for fornecido qualquer acesso ou containerAcl, a ACL de contentor existente será removida.

Quando estabelece uma política de acesso armazenada num contentor, pode demorar até 30 segundos a entrar em vigor. Durante este intervalo, uma assinatura de acesso partilhado associada à política de acesso armazenado falhará com o código de estado 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 utilizador para o contentor especificado. Se não for fornecida nenhuma opção ou se não forem definidos metadados no parâmetro, os metadados de contentor serão removidos.

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

Parâmetros

Devoluções

Cria um novo blob de blocos ou atualiza o conteúdo de um blob de blocos existente. Atualizar um blob de blocos existente substitui quaisquer metadados existentes no blob. As atualizações parciais não são suportadas; o conteúdo do blob existente é substituído pelo novo conteúdo. Para efetuar uma atualização parcial de um blob de blocos, utilize <xref:BlockBlobClient.stageBlock> e <xref:BlockBlobClient.commitBlockList>.

Este é um método de carregamento não paralelo, utilize <xref:BlockBlobClient.uploadFile>ou <xref:BlockBlobClient.uploadStream><xref:BlockBlobClient.uploadBrowserData> para um melhor desempenho com o carregamento de simultaneidade.

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

Parâmetros

Devoluções

Bloquear dados de resposta de carregamento de Blobs e a instância blockBlobClient correspondente.