BlobClient class

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

Parâmetros

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

Parâmetros

Cria uma instância de BlobClient a partir da cadeia de ligação.

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

Parâmetros

accountName: string

Valor de Propriedade

O nome do contentor de armazenamento ao que o blob está associado.

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

O nome do blob.

string name

Valor de Propriedade

Valor de cadeia de URL codificado.

url: string

Valor de Propriedade

Aborta 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

Assíncronamente copia um blob para um destino na conta de armazenamento. Este método devolve um poller de operação de execução prolongada que lhe permite aguardar indefinidamente até que a cópia seja concluída. Também pode cancelar uma cópia antes de ser concluída ao chamar cancelOperation o poller. Tenha em atenção que a chamada de retorno onProgress não será invocada se a operação for concluída no primeiro pedido e tentar cancelar uma cópia concluída resultará num erro. Na versão 2012-02-12 e posterior, a origem de uma operação Copiar Blob pode ser um blob consolidado em qualquer conta de armazenamento do Azure. A partir da versão 2015-02-21, a origem de uma operação Copiar Blob pode ser um ficheiro do Azure em qualquer conta de armazenamento do Azure. Apenas as contas de armazenamento criadas em ou depois de 7 de junho de 2012 permitem que a operação Copiar Blob copie a partir de outra conta de armazenamento.

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

Parâmetros

Devoluções

Cria um instantâneo só de leitura de um blob.

function createSnapshot(options?: BlobCreateSnapshotOptions)

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

Parâmetros

Devoluções

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

Parâmetros

Devoluções

Elimine a política de immutablility no blob.

function deleteImmutabilityPolicy(options?: BlobDeleteImmutabilityPolicyOptions)

Parâmetros

Devoluções

Lê ou transfere um blob do sistema, incluindo os respetivos metadados e propriedades. Também pode chamar Obter Blob para ler um instantâneo.

• No Node.js, os dados são devolvidos num fluxo legível readableStreamBody
• Nos browsers, os dados são devolvidos num 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

APENAS DISPONÍVEL NO NODE.JS RUNTIME. Transfere um Blob do Azure em paralelo para uma memória intermédia. O deslocamento e a contagem são opcionais, transfere todo o blob se não forem fornecidos.

Aviso: as memórias intermédias só podem suportar ficheiros 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 blobs maiores do que este tamanho, considere <xref:downloadToFile>.

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

Parâmetros

Devoluções

APENAS DISPONÍVEL NO NODE.JS RUNTIME. Transfere um Blob do Azure em paralelo para uma memória intermédia. O deslocamento e a contagem são opcionais, transfere todo o blob se não forem fornecidos.

Aviso: as memórias intermédias só podem suportar ficheiros 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 blobs maiores do que este tamanho, considere <xref:downloadToFile>.

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

Parâmetros

Devoluções

APENAS DISPONÍVEL NO NODE.JS RUNTIME. Transfere um Blob do Azure para um ficheiro local. Falha se o caminho de ficheiro especificado já sair. O deslocamento e a contagem são opcionais, passam 0 e não são definidos, respetivamente, para transferir 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 transferência de blobs, mas com readableStreamBody definidos como indefinidos, uma vez que o respetivo conteúdo já é lido e escrito num ficheiro local no caminho especificado.

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

function exists(options?: BlobExistsOptions)

Parâmetros

Devoluções

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

function generateSasUrl(options: BlobGenerateSasUrlOptions)

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.

Cria um objeto AppendBlobClient.

function getAppendBlobClient()

Devoluções

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

function getBlobLeaseClient(proposeLeaseId?: string)

Parâmetros

Devoluções

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

Cria um objeto BlockBlobClient.

function getBlockBlobClient()

Devoluções

Cria um objeto PageBlobClient.

function getPageBlobClient()

Devoluções

Devolve todos os metadados definidos pelo utilizador, propriedades HTTP padrão e propriedades do sistema para o blob. Não devolve o conteúdo do blob.

function getProperties(options?: BlobGetPropertiesOptions)

Parâmetros

Devoluções

Obtém as etiquetas associadas ao blob subjacente.

function getTags(options?: BlobGetTagsOptions)

Parâmetros

Devoluções

Define a camada num blob. A operação é permitida num blob de página numa conta de armazenamento premium e num blob de blocos numa conta de armazenamento de blobs (apenas armazenamento localmente redundante). O escalão de um blob de página premium determina o tamanho permitido, o IOPS e a largura de banda do blob. A camada de um blob de blocos determina o tipo de armazenamento Frequente/Esporádico/Arquivo. 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 não for fornecido nenhum valor ou nenhum valor fornecido para os cabeçalhos HTTP de blob especificados, estes 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 suspensão legal no blob.

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

Parâmetros

Devoluções

Define metadados definidos pelo utilizador para o blob especificado como um ou mais pares nome-valor. Se não for fornecida nenhuma opção ou se não forem definidos metadados no parâmetro, os metadados do blob serão removidos.

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

Parâmetros

Devoluções

Define etiquetas no blob subjacente. Um blob pode ter até 10 etiquetas. As teclas de etiqueta têm de ter entre 1 e 128 carateres. Os valores das etiquetas têm de ter entre 0 e 256 carateres. Os carateres de valor e chave de etiqueta válidos incluem letras minúsculas e maiúsculas, dígitos (0-9), espaço (' '), mais ('+'), subtração ('-'), ponto final ('.'), barra ('/'), dois pontos (':'), igual a ('=') e sublinhado ('_') .

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

Parâmetros

Devoluções

A operação copy from URL síncrona copia um blob ou um recurso da Internet para um novo blob. Não devolverá uma resposta até que a cópia esteja concluída.

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

Parâmetros

Devoluções

Restaura os conteúdos e metadados do blob eliminado de forma recuperável e quaisquer instantâneos de eliminação recuperável associados. O Undelete Blob só é suportado na versão 2017-07-29 ou posterior.

function undelete(options?: BlobUndeleteOptions)

Parâmetros

Devoluções

Cria um novo objeto BlobClient idêntico à origem, mas com o carimbo de data/hora do instantâneo especificado. Fornecer "" removerá o instantâneo e devolverá um Cliente ao blob base.

function withSnapshot(snapshot: string)

Parâmetros

Devoluções

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

Cria um novo objeto BlobClient que aponta para uma versão deste blob. Fornecer "" removerá o versionId e devolverá um Cliente ao blob base.

function withVersion(versionId: string)

Parâmetros

Devoluções

Um novo objeto BlobClient que aponta para a versão deste blob.