BlockBlobClient class

Cria uma instância de BlockBlobClient. Este método aceita um URL codificado ou um URL não codificado apontando para um blob de bloco. 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 BlockBlobClient(url: string, pipeline: PipelineLike)

Parâmetros

Cria uma instância de BlockBlobClient. Este método aceita um URL codificado ou um URL não codificado apontando para um blob de bloco. 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 BlockBlobClient(url: string, credential?: StorageSharedKeyCredential | AnonymousCredential | TokenCredential, options?: StoragePipelineOptions)

Parâmetros

Cria uma instância de BlockBlobClient.

new BlockBlobClient(connectionString: string, containerName: string, blobName: string, options?: StoragePipelineOptions)

Parâmetros

accountName: string

Valor de Propriedade

O nome do contêiner de armazenamento ao qual o blob está associado.

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

O nome do blob.

string name

Valor de Propriedade

Valor da cadeia de caracteres de URL codificada.

url: string

Valor de Propriedade

Anula uma operação de Blob de cópia assíncrona pendente e deixa um blob de destino com comprimento zero e metadados completos. Versão 2012-02-12 e mais recente.

function abortCopyFromURL(copyId: string, options?: BlobAbortCopyFromURLOptions)

Parâmetros

Devoluções

Copia de forma assíncrona um blob para um destino dentro da conta de armazenamento. Esse método retorna um poller de operação de longa duração que permite que você aguarde indefinidamente até que a cópia seja concluída. Você também pode cancelar uma cópia antes que ela seja concluída ligando para cancelOperation no ponteiro. Observe que o retorno de chamada onProgress não será invocado se a operação for concluída na primeira solicitação, e a tentativa de cancelar uma cópia concluída resultará em um erro sendo lançado. Na versão 2012-02-12 e posterior, a origem de uma operação de Blob de Cópia pode ser um blob confirmado em qualquer conta de armazenamento do Azure. A partir da versão 2015-02-21, a origem de uma operação de Blob de Cópia pode ser um arquivo do Azure em qualquer conta de armazenamento do Azure. Somente contas de armazenamento criadas em ou após 7 de junho de 2012 permitem que a operação Copiar Blob copie de outra conta de armazenamento.

function beginCopyFromURL(copySource: string, options?: BlobBeginCopyFromURLOptions)

Parâmetros

Devoluções

Escreve um blob especificando a lista de IDs de bloco que compõem o blob. Para ser escrito como parte de um blob, um bloco deve ter sido gravado com êxito no servidor em uma operação de <xref:stageBlock> anterior. Você pode chamar <xref:commitBlockList> para atualizar um blob carregando apenas os blocos que foram alterados e, em seguida, confirmando os blocos novos e existentes juntos. Quaisquer blocos não especificados na lista de bloqueios e excluídos permanentemente.

function commitBlockList(blocks: string[], options?: BlockBlobCommitBlockListOptions)

Parâmetros

Devoluções

Dados de resposta para a operação Lista de Bloqueios de Confirmação de Blob de Bloco.

Cria um instantâneo somente leitura de um blob.

function createSnapshot(options?: BlobCreateSnapshotOptions)

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 delete(options?: BlobDeleteOptions)

Parâmetros

Devoluções

Marca o blob ou instantâneo especificado para exclusão, se existir. 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 deleteIfExists(options?: BlobDeleteOptions)

Parâmetros

Devoluções

Exclua a política de imutablilidade no blob.

function deleteImmutabilityPolicy(options?: BlobDeleteImmutabilityPolicyOptions)

Parâmetros

Devoluções

Lê ou baixa um blob do sistema, incluindo seus metadados e propriedades. Você também pode chamar Obter Blob para ler um instantâneo.

• No Node.js, os dados retornam em um fluxo legível readableStreamBody
• Em navegadores, os dados retornam em um blobBody de promessa

function download(offset?: number, count?: number, options?: BlobDownloadOptions)

Parâmetros

// Download and convert a blob to a string
const downloadBlockBlobResponse = await blobClient.download();
const downloaded = await streamToBuffer(downloadBlockBlobResponse.readableStreamBody);
console.log("Downloaded blob content:", downloaded.toString());

async function streamToBuffer(readableStream) {
return new Promise((resolve, reject) => {
const chunks = [];
readableStream.on("data", (data) => {
chunks.push(data instanceof Buffer ? data : Buffer.from(data));
});
readableStream.on("end", () => {
resolve(Buffer.concat(chunks));
});
readableStream.on("error", reject);
});
}

// Download and convert a blob to a string
const downloadBlockBlobResponse = await blobClient.download();
const downloaded = await blobToString(await downloadBlockBlobResponse.blobBody);
console.log(
  "Downloaded blob content",
  downloaded
);

async function blobToString(blob: Blob): Promise<string> {
  const fileReader = new FileReader();
  return new Promise<string>((resolve, reject) => {
    fileReader.onloadend = (ev: any) => {
      resolve(ev.target!.result);
    };
    fileReader.onerror = reject;
    fileReader.readAsText(blob);
  });
}

Devoluções

DISPONÍVEL APENAS EM TEMPO DE EXECUÇÃO NODE.JS. Baixa um Blob do Azure em paralelo a um buffer. Deslocamento e contagem são opcionais, baixa todo o blob se não forem fornecidos.

Aviso: Os buffers só podem suportar arquivos de até cerca de um gigabyte em sistemas de 32 bits ou cerca de dois gigabytes em sistemas de 64 bits devido a limitações de Node.js/V8. Para bolhas maiores que esse tamanho, considere <xref:downloadToFile>.

function downloadToBuffer(buffer: Buffer, offset?: number, count?: number, options?: BlobDownloadToBufferOptions)

Parâmetros

Devoluções

DISPONÍVEL APENAS EM TEMPO DE EXECUÇÃO NODE.JS. Baixa um Blob do Azure em paralelo a um buffer. Deslocamento e contagem são opcionais, baixa todo o blob se não forem fornecidos.

Aviso: Os buffers só podem suportar arquivos de até cerca de um gigabyte em sistemas de 32 bits ou cerca de dois gigabytes em sistemas de 64 bits devido a limitações de Node.js/V8. Para bolhas maiores que esse tamanho, considere <xref:downloadToFile>.

function downloadToBuffer(offset?: number, count?: number, options?: BlobDownloadToBufferOptions)

Parâmetros

Devoluções

DISPONÍVEL APENAS EM TEMPO DE EXECUÇÃO NODE.JS. Baixa um Blob do Azure para um arquivo local. Falhará se o caminho do arquivo fornecido já for encerrado. Deslocamento e contagem são opcionais, passe 0 e indefinido, respectivamente, para baixar todo o blob.

function downloadToFile(filePath: string, offset?: number, count?: number, options?: BlobDownloadOptions)

Parâmetros

Devoluções

Os dados de resposta para a operação de download de blob, mas com readableStreamBody definido como indefinido, uma vez que seu conteúdo já é lido e gravado em um arquivo local no caminho especificado.

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

function exists(options?: BlobExistsOptions)

Parâmetros

Devoluções

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

function generateSasUrl(options: BlobGenerateSasUrlOptions)

Parâmetros

Devoluções

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

Cria um objeto AppendBlobClient.

function getAppendBlobClient()

Devoluções

Obtenha um <xref:BlobLeaseClient> que gerencia locações no blob.

function getBlobLeaseClient(proposeLeaseId?: string)

Parâmetros

Devoluções

Um novo objeto BlobLeaseClient para gerenciar concessões no blob.

Cria um objeto BlockBlobClient.

function getBlockBlobClient()

Devoluções

Retorna a lista de blocos que foram carregados como parte de um blob de bloco usando o filtro de lista de blocos especificado.

function getBlockList(listType: BlockListType, options?: BlockBlobGetBlockListOptions)

Parâmetros

Devoluções

Dados de resposta para a operação Block Blob Get Block List.

Cria um objeto PageBlobClient.

function getPageBlobClient()

Devoluções

Retorna todos os metadados definidos pelo usuário, propriedades HTTP padrão e propriedades do sistema para o blob. Ele não retorna o conteúdo do blob.

function getProperties(options?: BlobGetPropertiesOptions)

Parâmetros

Devoluções

Obtém as tags associadas ao blob subjacente.

function getTags(options?: BlobGetTagsOptions)

Parâmetros

Devoluções

DISPONÍVEL APENAS EM TEMPO DE EXECUÇÃO NODE.JS. Consulta rápida para um blob formatado em JSON ou CSV.

Exemplo de utilização (Node.js):

// Query and convert a blob to a string
const queryBlockBlobResponse = await blockBlobClient.query("select * from BlobStorage");
const downloaded = (await streamToBuffer(queryBlockBlobResponse.readableStreamBody)).toString();
console.log("Query blob content:", downloaded);

async function streamToBuffer(readableStream) {
  return new Promise((resolve, reject) => {
    const chunks = [];
    readableStream.on("data", (data) => {
      chunks.push(data instanceof Buffer ? data : Buffer.from(data));
    });
    readableStream.on("end", () => {
      resolve(Buffer.concat(chunks));
    });
    readableStream.on("error", reject);
  });
}

function query(query: string, options?: BlockBlobQueryOptions)

Parâmetros

Devoluções

Define a camada em um blob. A operação é permitida em um blob de página em uma conta de armazenamento premium e em um blob de bloco em uma conta de armazenamento de blob (somente armazenamento redundante localmente). A camada de um blob de página premium determina o tamanho, IOPS e largura de banda permitidos do blob. A camada de um blob de bloco determina o tipo de armazenamento Hot/Cool/Archive. Esta operação não atualiza o ETag do blob.

function setAccessTier(tier: BlockBlobTier | PremiumPageBlobTier | string, options?: BlobSetTierOptions)

Parâmetros

Devoluções

Define as propriedades do sistema no blob. Se nenhum valor fornecido, ou nenhum valor fornecido para os cabeçalhos HTTP de blob especificados, esses cabeçalhos HTTP de blob sem um valor serão limpos.

function setHTTPHeaders(blobHTTPHeaders?: BlobHTTPHeaders, options?: BlobSetHTTPHeadersOptions)

Parâmetros

Devoluções

Defina a política de imutablilidade no blob.

function setImmutabilityPolicy(immutabilityPolicy: BlobImmutabilityPolicy, options?: BlobSetImmutabilityPolicyOptions)

Parâmetros

Devoluções

Defina a retenção legal no blob.

function setLegalHold(legalHoldEnabled: boolean, options?: BlobSetLegalHoldOptions)

Parâmetros

Devoluções

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

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

Parâmetros

Devoluções

Define tags no blob subjacente. Um blob pode ter até 10 tags. As teclas de tag devem ter entre 1 e 128 caracteres. Os valores das tags devem estar entre 0 e 256 caracteres. Os caracteres de chave e valor de tag válidos incluem letras minúsculas e maiúsculas, dígitos (0-9), espaço (' '), mais ('+'), menos ('-'), ponto ('.'), barra ('/'), dois pontos (':'), igual ('=') e sublinhado ('_').

function setTags(tags: Tags, options?: BlobSetTagsOptions)

Parâmetros

Devoluções

Carrega o bloco especificado na "área de preparação" do blob de bloco para ser posteriormente confirmado por uma chamada para commitBlockList.

function stageBlock(blockId: string, body: HttpRequestBody, contentLength: number, options?: BlockBlobStageBlockOptions)

Parâmetros

Devoluções

Dados de resposta para a operação Bloco de Estágio de Blob de Bloco.

A operação Stage Block From URL cria um novo bloco a ser confirmado como parte de um blob onde o conteúdo é lido de uma URL. Esta API está disponível a partir da versão 2018-03-28.

function stageBlockFromURL(blockId: string, sourceURL: string, offset?: number, count?: number, options?: BlockBlobStageBlockFromURLOptions)

Parâmetros

Devoluções

Dados de resposta para a operação Block Blob Stage Block From URL.

A operação síncrona Copiar da URL copia um blob ou um recurso da Internet para um novo blob. Ele não retornará uma resposta até que a cópia esteja completa.

function syncCopyFromURL(copySource: string, options?: BlobSyncCopyFromURLOptions)

Parâmetros

Devoluções

Cria um novo Blob de Bloco onde o conteúdo do blob é lido de uma determinada URL. Esta API é suportada a partir da versão 2020-04-08. Não há suporte para atualizações parciais com Put Blob from URL; O conteúdo de um blob existente é substituído pelo conteúdo do novo blob. Para executar atualizações parciais no conteúdo de um blob de bloco usando uma URL de origem, use <xref:stageBlockFromURL> e <xref:commitBlockList>.

function syncUploadFromURL(sourceURL: string, options?: BlockBlobSyncUploadFromURLOptions)

Parâmetros

Devoluções

Restaura o conteúdo e os metadados do blob excluído suavemente e de quaisquer instantâneos excluídos suavemente associados. O Undelete Blob é suportado apenas na versão 2017-07-29 ou posterior.

function undelete(options?: BlobUndeleteOptions)

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:stageBlock> e <xref:commitBlockList>. Este é um método de upload não paralelo, use <xref:uploadFile>, <xref:uploadStream> ou <xref:uploadBrowserData> para um melhor desempenho com o upload simultâneo.

function upload(body: HttpRequestBody, contentLength: number, options?: BlockBlobUploadOptions)

Parâmetros

Devoluções

Dados de resposta para a operação Block Blob Upload.

Exemplo de uso:

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

DISPONÍVEL APENAS EM NAVEGADORES. Carrega um objeto Blob/File/ArrayBuffer/ArrayBufferView do navegador para bloquear o blob.

Quando o comprimento do buffer for menor ou igual a 256MB, esse método usará 1 chamada de upload para concluir o upload. Caso contrário, esse método chamará <xref:stageBlock> para carregar blocos e, finalmente, chamará <xref:commitBlockList> para confirmar a lista de bloqueios.

Uma opção de <xref:BlockBlobParallelUploadOptions.blobHTTPHeaders> comum para definir é blobContentType, permitindo que o navegador forneça funcionalidade com base no tipo de arquivo.

function uploadBrowserData(browserData: Blob | ArrayBuffer | ArrayBufferView, options?: BlockBlobParallelUploadOptions)

Parâmetros

Devoluções

Dados de resposta para a operação Blob Upload.

Carrega um objeto Buffer(Node.js)/Blob(browsers)/ArrayBuffer/ArrayBufferView para um BlockBlob. Quando o comprimento dos dados não é mais do que o <xref:BlockBlobParallelUploadOptions.maxSingleShotSize> specifiled (o padrão é <xref:BLOCK_BLOB_MAX_UPLOAD_BLOB_BYTES>), esse método usará 1 <xref:upload> chamada para concluir o upload. Caso contrário, esse método chamará <xref:stageBlock> para carregar blocos e, finalmente, chamará <xref:commitBlockList> para confirmar a lista de bloqueios.

Uma opção de <xref:BlockBlobParallelUploadOptions.blobHTTPHeaders> comum para definir é blobContentType, permitindo que o navegador forneça funcionalidade com base no tipo de arquivo.

function uploadData(data: Buffer | Blob | ArrayBuffer | ArrayBufferView, options?: BlockBlobParallelUploadOptions)

Parâmetros

Devoluções

DISPONÍVEL APENAS EM TEMPO DE EXECUÇÃO NODE.JS. Carrega um arquivo local em blocos para um blob de bloco.

Quando o tamanho do ficheiro for inferior ou igual a 256MB, este método utilizará 1 chamada de carregamento para concluir o carregamento. Caso contrário, esse método chamará stageBlock para carregar blocos e, finalmente, chamará commitBlockList para confirmar a lista de bloqueios.

function uploadFile(filePath: string, options?: BlockBlobParallelUploadOptions)

Parâmetros

Devoluções

Dados de resposta para a operação Blob Upload.

DISPONÍVEL APENAS EM TEMPO DE EXECUÇÃO NODE.JS. Carrega um fluxo Node.js legível no blob de bloco.

DICAS DE MELHORIA DE DESEMPENHO:

• O fluxo de entrada highWaterMark é melhor definir um mesmo valor com o parâmetro bufferSize, o que evitará operações Buffer.concat().

function uploadStream(stream: Readable, bufferSize?: number, maxConcurrency?: number, options?: BlockBlobUploadStreamOptions)

Parâmetros

Devoluções

Dados de resposta para a operação Blob Upload.

Cria um novo objeto BlockBlobClient idêntico à origem, mas com o carimbo de data/hora do instantâneo especificado. Fornecer "" removerá o instantâneo e retornará uma URL para o blob base.

function withSnapshot(snapshot: string)

Parâmetros

Devoluções

Um novo objeto BlockBlobClient idêntico à origem, mas com o carimbo de data/hora do instantâneo especificado.

Cria um novo objeto BlobClient apontando para uma versão desse blob. Fornecer "" removerá o versionId e retornará um cliente para o blob base.

function withVersion(versionId: string)

Parâmetros

Devoluções

Um novo objeto BlobClient apontando para a versão desse blob.