AppendBlobClient class

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

Parâmetros

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

Parâmetros

Cria uma instância de AppendBlobClient.

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

Parâmetros

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

string containerName

Valor de Propriedade

O nome do blob.

string name

Valor de Propriedade

accountName: string

Valor de Propriedade

herdado deBlobClient.accountName

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

herdado deBlobClient.credential

Valor da cadeia de caracteres de URL codificada.

url: string

Valor de Propriedade

herdado deBlobClient.url

Confirma um novo bloco de dados no final do blob de acréscimo existente.

Veja https://docs.microsoft.com/rest/api/storageservices/append-block

function appendBlock(body: RequestBodyType, contentLength: number, options?: AppendBlobAppendBlockOptions): Promise<AppendBlobAppendBlockResponse>

Parâmetros

const content = "Hello World!";

// Create a new append blob and append data to the blob.
const newAppendBlobClient = containerClient.getAppendBlobClient("<blob name>");
await newAppendBlobClient.create();
await newAppendBlobClient.appendBlock(content, content.length);

// Append data to an existing append blob.
const existingAppendBlobClient = containerClient.getAppendBlobClient("<blob name>");
await existingAppendBlobClient.appendBlock(content, content.length);

Devoluções

A operação Append Block confirma um novo bloco de dados no final de um blob de acréscimo existente onde o conteúdo é lido de uma url de origem.

Veja https://docs.microsoft.com/en-us/rest/api/storageservices/append-block-from-url

function appendBlockFromURL(sourceURL: string, sourceOffset: number, count: number, options?: AppendBlobAppendBlockFromURLOptions): Promise<AppendBlobAppendBlockFromUrlResponse>

Parâmetros

Devoluções

Cria um blob de acréscimo de 0 comprimentos. Chame AppendBlock para acrescentar dados a um blob de acréscimo.

Veja https://docs.microsoft.com/rest/api/storageservices/put-blob

function create(options?: AppendBlobCreateOptions): Promise<AppendBlobCreateResponse>

Parâmetros

const appendBlobClient = containerClient.getAppendBlobClient("<blob name>");
await appendBlobClient.create();

Devoluções

Cria um blob de acréscimo de 0 comprimentos. Chame AppendBlock para acrescentar dados a um blob de acréscimo. Se o blob com o mesmo nome já existir, o conteúdo do blob existente permanecerá inalterado.

Veja https://docs.microsoft.com/rest/api/storageservices/put-blob

function createIfNotExists(options?: AppendBlobCreateIfNotExistsOptions): Promise<AppendBlobCreateIfNotExistsResponse>

Parâmetros

Devoluções

Sela o blob de apêndice, tornando-o somente leitura.

function seal(options?: AppendBlobSealOptions): Promise<AppendBlobAppendBlockResponse>

Parâmetros

Devoluções

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

function withSnapshot(snapshot: string): AppendBlobClient

Parâmetros

Devoluções

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

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.

Veja https://docs.microsoft.com/en-us/rest/api/storageservices/abort-copy-blob

function abortCopyFromURL(copyId: string, options?: BlobAbortCopyFromURLOptions): Promise<BlobAbortCopyFromURLResponse>

Parâmetros

Devoluções

herdado deBlobClient.abortCopyFromURL

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.

Veja https://docs.microsoft.com/en-us/rest/api/storageservices/copy-blob

Exemplo usando sondagem automática:

const copyPoller = await blobClient.beginCopyFromURL('url');
const result = await copyPoller.pollUntilDone();

Exemplo usando sondagem manual:

const copyPoller = await blobClient.beginCopyFromURL('url');
while (!poller.isDone()) {
   await poller.poll();
}
const result = copyPoller.getResult();

Exemplo de utilização de atualizações de progresso:

const copyPoller = await blobClient.beginCopyFromURL('url', {
  onProgress(state) {
    console.log(`Progress: ${state.copyProgress}`);
  }
});
const result = await copyPoller.pollUntilDone();

Exemplo usando um intervalo de sondagem variável (padrão 15 segundos):

const copyPoller = await blobClient.beginCopyFromURL('url', {
  intervalInMs: 1000 // poll blob every 1 second for copy progress
});
const result = await copyPoller.pollUntilDone();

Exemplo usando cancelamento de cópia:

const copyPoller = await blobClient.beginCopyFromURL('url');
// cancel operation after starting it.
try {
  await copyPoller.cancelOperation();
  // calls to get the result now throw PollerCancelledError
  await copyPoller.getResult();
} catch (err) {
  if (err.name === 'PollerCancelledError') {
    console.log('The copy was cancelled.');
  }
}

function beginCopyFromURL(copySource: string, options?: BlobBeginCopyFromURLOptions): Promise<PollerLikeWithCancellation<PollOperationState<BlobBeginCopyFromURLResponse>, BlobBeginCopyFromURLResponse>>

Parâmetros

Devoluções

herdado de BlobClient.beginCopyFromURL

Cria um instantâneo somente leitura de um blob.

Veja https://docs.microsoft.com/en-us/rest/api/storageservices/snapshot-blob

function createSnapshot(options?: BlobCreateSnapshotOptions): Promise<BlobCreateSnapshotResponse>

Parâmetros

Devoluções

herdado deBlobClient.createSnapshot

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.

Veja https://docs.microsoft.com/en-us/rest/api/storageservices/delete-blob

function delete(options?: BlobDeleteOptions): Promise<BlobDeleteResponse>

Parâmetros

Devoluções

herdado deBlobClient.delete

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.

Veja https://docs.microsoft.com/en-us/rest/api/storageservices/delete-blob

function deleteIfExists(options?: BlobDeleteOptions): Promise<BlobDeleteIfExistsResponse>

Parâmetros

Devoluções

herdado deBlobClient.deleteIfExists

Exclua a política de imutablilidade no blob.

function deleteImmutabilityPolicy(options?: BlobDeleteImmutabilityPolicyOptions): Promise<BlobDeleteImmutabilityPolicyResponse>

Parâmetros

Devoluções

herdado deBlobClient.deleteImmutabilityPolicy

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

Veja https://docs.microsoft.com/en-us/rest/api/storageservices/get-blob

function download(offset?: number, count?: number, options?: BlobDownloadOptions): Promise<BlobDownloadResponseParsed>

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

herdado deBlobClient.download

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 blobs maiores que esse tamanho, considere downloadToFile.

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

Parâmetros

Devoluções

herdado deBlobClient.downloadToBuffer

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 blobs maiores que esse tamanho, considere downloadToFile.

function downloadToBuffer(offset?: number, count?: number, options?: BlobDownloadToBufferOptions): Promise<Buffer>

Parâmetros

Devoluções

herdado deBlobClient.downloadToBuffer

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): Promise<BlobDownloadResponseParsed>

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.

herdado deBlobClient.downloadToFile

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): Promise<boolean>

Parâmetros

Devoluções

herdado deBlobClient.exists

Disponível apenas para BlobClient construído com uma credencial de chave compartilhada.

Gera cadeia de caracteres para assinar um URI SAS (Assinatura de Acesso Compartilhado) do Serviço de Blob com base nas propriedades do cliente e nos parâmetros passados. O SAS é assinado pela credencial de chave compartilhada do cliente.

Veja https://docs.microsoft.com/en-us/rest/api/storageservices/constructing-a-service-sas

function generateSasStringToSign(options: BlobGenerateSasUrlOptions): string

Parâmetros

Devoluções

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

herdado deBlobClient.generateSasStringToSign

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.

Veja https://docs.microsoft.com/en-us/rest/api/storageservices/constructing-a-service-sas

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

Parâmetros

Devoluções

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

herdado deBlobClient.generateSasUrl

Disponível apenas para BlobClient construído com uma credencial de chave compartilhada.

Gera cadeia de caracteres para assinar um URI SAS (Assinatura de Acesso Compartilhado) do Serviço de Blob com base nas propriedades do cliente e nos parâmetros passados. A SAS é assinada pela chave de delegação do usuário de entrada.

Veja https://docs.microsoft.com/en-us/rest/api/storageservices/constructing-a-service-sas

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

Parâmetros

Devoluções

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

herdado deBlobClient.generateUserDelegationSasStringToSign

Gera um URI SAS (Assinatura de Acesso Compartilhado) do Serviço de Blob com base nas propriedades e parâmetros do cliente transmitidos. A SAS é assinada pela chave de delegação do usuário de entrada.

Veja https://docs.microsoft.com/en-us/rest/api/storageservices/constructing-a-service-sas

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

Parâmetros

Devoluções

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

herdado de BlobClient.generateUserDelegationSasUrl

A operação Obter informações da conta retorna o nome da sku e o tipo de conta para a conta especificada. A operação Obter informações da conta está disponível em versões de serviço que começam com a versão 2018-03-28.

Veja https://docs.microsoft.com/en-us/rest/api/storageservices/get-account-information

function getAccountInfo(options?: BlobGetAccountInfoOptions): Promise<BlobGetAccountInfoResponse>

Parâmetros

Devoluções

Dados de resposta para a operação Obter informações da conta do serviço.

herdado deBlobClient.getAccountInfo

Cria um objeto AppendBlobClient.

function getAppendBlobClient(): AppendBlobClient

Devoluções

herdado deBlobClient.getAppendBlobClient

Obtenha um BlobLeaseClient que gerencia concessões no blob.

function getBlobLeaseClient(proposeLeaseId?: string): BlobLeaseClient

Parâmetros

Devoluções

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

herdado deBlobClient.getBlobLeaseClient

Cria um objeto BlockBlobClient.

function getBlockBlobClient(): BlockBlobClient

Devoluções

herdado deBlobClient.getBlockBlobClient

Cria um objeto PageBlobClient.

function getPageBlobClient(): PageBlobClient

Devoluções

herdado de BlobClient.getPageBlobClient

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.

Veja https://docs.microsoft.com/en-us/rest/api/storageservices/get-blob-properties

AVISO: O objeto metadata retornado na resposta terá suas teclas em minúsculas, mesmo que originalmente contivessem caracteres maiúsculos. Isso difere das chaves de metadados retornadas pelos métodos de ContainerClient que listam blobs usando a opção includeMetadata, que manterá seu invólucro original.

function getProperties(options?: BlobGetPropertiesOptions): Promise<BlobGetPropertiesResponse>

Parâmetros

Devoluções

herdado deBlobClient.getProperties

Obtém as tags associadas ao blob subjacente.

function getTags(options?: BlobGetTagsOptions): Promise<BlobGetTagsResponse>

Parâmetros

Devoluções

herdado deBlobClient.getTags

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.

Veja https://docs.microsoft.com/en-us/rest/api/storageservices/set-blob-tier

function setAccessTier(tier: string, options?: BlobSetTierOptions): Promise<BlobSetTierResponse>

Parâmetros

Devoluções

herdado de BlobClient.setAccessTier

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.

Veja https://docs.microsoft.com/en-us/rest/api/storageservices/set-blob-properties

function setHTTPHeaders(blobHTTPHeaders?: BlobHTTPHeaders, options?: BlobSetHTTPHeadersOptions): Promise<BlobSetHTTPHeadersResponse>

Parâmetros

Devoluções

herdado deBlobClient.setHTTPHeaders

Defina a política de imutabilidade no blob.

function setImmutabilityPolicy(immutabilityPolicy: BlobImmutabilityPolicy, options?: BlobSetImmutabilityPolicyOptions): Promise<BlobSetImmutabilityPolicyResponse>

Parâmetros

Devoluções

herdado deBlobClient.setImmutabilityPolicy

Defina a retenção legal no blob.

function setLegalHold(legalHoldEnabled: boolean, options?: BlobSetLegalHoldOptions): Promise<BlobSetLegalHoldResponse>

Parâmetros

Devoluções

herdado deBlobClient.setLegalHold

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.

Veja https://docs.microsoft.com/en-us/rest/api/storageservices/set-blob-metadata

function setMetadata(metadata?: Metadata, options?: BlobSetMetadataOptions): Promise<BlobSetMetadataResponse>

Parâmetros

Devoluções

herdado de BlobClient.setMetadata

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): Promise<BlobSetTagsResponse>

Parâmetros

Devoluções

herdado deBlobClient.setTags

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.

Veja https://docs.microsoft.com/en-us/rest/api/storageservices/copy-blob-from-url

function syncCopyFromURL(copySource: string, options?: BlobSyncCopyFromURLOptions): Promise<BlobCopyFromURLResponse>

Parâmetros

Devoluções

herdado de BlobClient.syncCopyFromURL

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.

Veja https://docs.microsoft.com/en-us/rest/api/storageservices/undelete-blob

function undelete(options?: BlobUndeleteOptions): Promise<BlobUndeleteResponse>

Parâmetros

Devoluções

herdado deBlobClient.undelete

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): BlobClient

Parâmetros

Devoluções

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

herdado deBlobClient.withVersion