AppendBlobClient class

Referência

Pacote:: @azure/storage-blob

AppendBlobClient define um conjunto de operações aplicáveis aos blobs de acréscimo.

Extends: BlobClient

Construtores

AppendBlobClient(string, PipelineLike)	Cria uma instância de AppendBlobClient. Este método aceita um URL codificado ou um URL não codificado que aponta para um blob de acréscimo. 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.
AppendBlobClient(string, StorageSharedKeyCredential \| AnonymousCredential \| TokenCredential, StoragePipelineOptions)	Cria uma instância de AppendBlobClient. Este método aceita um URL codificado ou um URL não codificado que aponta para um blob de acréscimo. 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.
AppendBlobClient(string, string, string, StoragePipelineOptions)	Cria uma instância de AppendBlobClient.

Propriedades

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

Propriedades Herdadas

accountName
credential	Tal como AnonymousCredential, StorageSharedKeyCredential ou qualquer credencial do `@azure/identity` pacote para autenticar pedidos para o serviço. Também pode fornecer um objeto que implementa a interface TokenCredential. Se não for especificado, é utilizado AnonymousCredential.
url	Valor da cadeia de URL codificado.

Métodos

appendBlock(HttpRequestBody, number, AppendBlobAppendBlockOptions)	Consolida um novo bloco de dados no final do blob de acréscimo existente. Veja https://docs.microsoft.com/rest/api/storageservices/append-block
appendBlockFromURL(string, number, number, AppendBlobAppendBlockFromURLOptions)	A operação Acrescentar Bloco consolida um novo bloco de dados no final de um blob de acréscimo existente onde os conteúdos são lidos a partir de um URL de origem. Veja https://docs.microsoft.com/en-us/rest/api/storageservices/append-block-from-url
create(AppendBlobCreateOptions)	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
createIfNotExists(AppendBlobCreateIfNotExistsOptions)	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
seal(AppendBlobSealOptions)	Fecha o blob de acréscimo, tornando-o só de leitura.
withSnapshot(string)	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 devolverá um Cliente ao blob base.

Métodos Herdados

abortCopyFromURL(string, BlobAbortCopyFromURLOptions)	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. Veja https://docs.microsoft.com/en-us/rest/api/storageservices/abort-copy-blob
beginCopyFromURL(string, BlobBeginCopyFromURLOptions)	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. Veja https://docs.microsoft.com/en-us/rest/api/storageservices/copy-blob Exemplo através de consultas automáticas: `const copyPoller = await blobClient.beginCopyFromURL('url'); const result = await copyPoller.pollUntilDone();` Exemplo de utilização de consultas manuais: `const copyPoller = await blobClient.beginCopyFromURL('url'); while (!poller.isDone()) { await poller.poll(); } const result = copyPoller.getResult();` Exemplo com atualizações de progresso: const copyPoller = await blobClient.beginCopyFromURL('url', { onProgress(state) { console.log(`Progress: ${state.copyProgress}`); } }); const result = await copyPoller.pollUntilDone(); Exemplo com um intervalo de consulta alterado (predefiniçã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 com o 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.'); } }`
createSnapshot(BlobCreateSnapshotOptions)	Cria um instantâneo só de leitura de um blob. Veja https://docs.microsoft.com/en-us/rest/api/storageservices/snapshot-blob
delete(BlobDeleteOptions)	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. Veja https://docs.microsoft.com/en-us/rest/api/storageservices/delete-blob
deleteIfExists(BlobDeleteOptions)	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. Veja https://docs.microsoft.com/en-us/rest/api/storageservices/delete-blob
deleteImmutabilityPolicy(BlobDeleteImmutabilityPolicyOptions)	Elimine a política de immutablility no blob.
download(number, number, BlobDownloadOptions)	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 Veja https://docs.microsoft.com/en-us/rest/api/storageservices/get-blob
downloadToBuffer(Buffer, number, number, BlobDownloadToBufferOptions)	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 downloadToFile.
downloadToBuffer(number, number, BlobDownloadToBufferOptions)	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 downloadToFile.
downloadToFile(string, number, number, BlobDownloadOptions)	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.
exists(BlobExistsOptions)	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.
generateSasUrl(BlobGenerateSasUrlOptions)	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. Veja https://docs.microsoft.com/en-us/rest/api/storageservices/constructing-a-service-sas
getAppendBlobClient()	Cria um objeto AppendBlobClient.
getBlobLeaseClient(string)	Obtenha um BlobLeaseClient que gere as concessões no blob.
getBlockBlobClient()	Cria um objeto BlockBlobClient.
getPageBlobClient()	Cria um objeto PageBlobClient.
getProperties(BlobGetPropertiesOptions)	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. Veja https://docs.microsoft.com/en-us/rest/api/storageservices/get-blob-properties AVISO: o `metadata` objeto devolvido na resposta terá as respetivas teclas em minúsculas, mesmo que tenham originalmente carateres em maiúsculas. Isto difere das chaves de metadados devolvidas pelos métodos containerClient que listam blobs com a opção `includeMetadata` , que irá manter a sua caixa original.
getTags(BlobGetTagsOptions)	Obtém as etiquetas associadas ao blob subjacente.
setAccessTier(string, BlobSetTierOptions)	Define a camada num blob. A operação é permitida num blob de páginas 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áginas 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 a ETag do blob. Veja https://docs.microsoft.com/en-us/rest/api/storageservices/set-blob-tier
setHTTPHeaders(BlobHTTPHeaders, BlobSetHTTPHeadersOptions)	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. Veja https://docs.microsoft.com/en-us/rest/api/storageservices/set-blob-properties
setImmutabilityPolicy(BlobImmutabilityPolicy, BlobSetImmutabilityPolicyOptions)	Defina a política de imutablilidade no blob.
setLegalHold(boolean, BlobSetLegalHoldOptions)	Defina a retenção legal no blob.
setMetadata(Metadata, BlobSetMetadataOptions)	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. Veja https://docs.microsoft.com/en-us/rest/api/storageservices/set-blob-metadata
setTags(Tags, BlobSetTagsOptions)	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 chave e valor de etiqueta válidos incluem letras minúsculas e maiúsculas, dígitos (0-9), espaço (' '), mais ('+'), menos ('-'), ponto final ('.'), barra ('/'), dois pontos (':'), igual a ('=') e caráter de sublinhado ('_') .
syncCopyFromURL(string, BlobSyncCopyFromURLOptions)	A operação copiar de 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. Veja https://docs.microsoft.com/en-us/rest/api/storageservices/copy-blob-from-url
undelete(BlobUndeleteOptions)	Restaura os conteúdos e metadados do blob eliminado de forma recuperável e quaisquer instantâneos de eliminação recuperável associados. Anular Eliminação de Blobs só é suportado na versão 2017-07-29 ou posterior. Veja https://docs.microsoft.com/en-us/rest/api/storageservices/undelete-blob
withVersion(string)	Cria um novo objeto BlobClient que aponta para uma versão deste blob. Fornecer "" removerá o versionId e devolverá um Cliente ao blob base.

Detalhes do Construtor

AppendBlobClient(string, PipelineLike)

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

Parâmetros

url: string

Uma cadeia de URL a apontar para o blob de acréscimo do Armazenamento do Azure, como "https://myaccount.blob.core.windows.net/mycontainer/appendblob". Pode acrescentar uma SAS se utilizar AnonymousCredential, como "https://myaccount.blob.core.windows.net/mycontainer/appendblob?sasString". 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. No entanto, se um nome de blob incluir ? ou %, o nome do blob tem de ser codificado no URL. Tal como um blob com o nome "my?blob%", o URL deve ser "https://myaccount.blob.core.windows.net/mycontainer/my%3Fblob%25".

pipeline: PipelineLike

Chame newPipeline() para criar um pipeline predefinido ou forneça um pipeline personalizado.

AppendBlobClient(string, StorageSharedKeyCredential | AnonymousCredential | TokenCredential, StoragePipelineOptions)

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

Parâmetros

url: string

credential: StorageSharedKeyCredential | AnonymousCredential | TokenCredential

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.

options: StoragePipelineOptions

Opcional. Opções para configurar o pipeline HTTP.

AppendBlobClient(string, string, string, StoragePipelineOptions)

Cria uma instância de AppendBlobClient.

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

Parâmetros

connectionString: string

Cadeia de ligação de conta ou uma cadeia de ligação SAS de uma conta de armazenamento do Azure. [ Nota - A cadeia de ligação de conta só pode ser utilizada no NODE.JS runtime. ] Exemplo de cadeia de ligação de conta -DefaultEndpointsProtocol=https;AccountName=myaccount;AccountKey=accountKey;EndpointSuffix=core.windows.net Exemplo de cadeia de ligação SAS - BlobEndpoint=https://myaccount.blob.core.windows.net/;QueueEndpoint=https://myaccount.queue.core.windows.net/;FileEndpoint=https://myaccount.file.core.windows.net/;TableEndpoint=https://myaccount.table.core.windows.net/;SharedAccessSignature=sasString

containerName: string

Nome do contentor.

blobName: string

Nome do blob.

options: StoragePipelineOptions

Opcional. Opções para configurar o pipeline HTTP.

Detalhes de Propriedade

containerName

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

string containerName

Valor de Propriedade

string

name

O nome do blob.

string name

Valor de Propriedade

string

Detalhes da Propriedade Herdada

accountName

accountName: string

Valor de Propriedade

string

Herdado deBlobClient.accountName

credential

Tal como AnonymousCredential, StorageSharedKeyCredential ou qualquer credencial do @azure/identity pacote para autenticar pedidos para o 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

StorageSharedKeyCredential | AnonymousCredential | TokenCredential

Herdado deBlobClient.credential

url

Valor da cadeia de URL codificado.

url: string

Valor de Propriedade

string

Herdado deBlobClient.url

Detalhes de Método

appendBlock(HttpRequestBody, number, AppendBlobAppendBlockOptions)

Consolida 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: HttpRequestBody, contentLength: number, options?: AppendBlobAppendBlockOptions): Promise<AppendBlobAppendBlockResponse>

Parâmetros

body: HttpRequestBody

Dados a acrescentar.

contentLength: number

Comprimento do corpo em bytes.

options: AppendBlobAppendBlockOptions

Opções para a operação Acrescentar Bloco.

Utilização de exemplo:

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

Promise<AppendBlobAppendBlockResponse>

appendBlockFromURL(string, number, number, AppendBlobAppendBlockFromURLOptions)

A operação Acrescentar Bloco consolida um novo bloco de dados no final de um blob de acréscimo existente onde os conteúdos são lidos a partir de um 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

sourceURL: string

O URL para o blob que será a origem da cópia. Um blob de origem na mesma conta de armazenamento pode ser autenticado através da Chave Partilhada. No entanto, se a origem for um blob noutra conta, o blob de origem tem de ser público ou ter de ser autenticado através de uma assinatura de acesso partilhado. Se o blob de origem for público, não é necessária autenticação para executar a operação.

sourceOffset: number

Desvio na origem a acrescentar

count: number

Número de bytes a acrescentar como um bloco

options: AppendBlobAppendBlockFromURLOptions

Devoluções

Promise<AppendBlobAppendBlockFromUrlResponse>

create(AppendBlobCreateOptions)

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

options: AppendBlobCreateOptions

Opções para a operação Acrescentar Criação de Blocos.

Utilização de exemplo:

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

Devoluções

Promise<AppendBlobCreateResponse>

createIfNotExists(AppendBlobCreateIfNotExistsOptions)

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

options: AppendBlobCreateIfNotExistsOptions

Devoluções

Promise<AppendBlobCreateIfNotExistsResponse>

seal(AppendBlobSealOptions)

Fecha o blob de acréscimo, tornando-o só de leitura.

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

Parâmetros

options: AppendBlobSealOptions

Devoluções

Promise<AppendBlobAppendBlockResponse>

withSnapshot(string)

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 devolverá um Cliente ao blob base.

function withSnapshot(snapshot: string): AppendBlobClient

Parâmetros

snapshot: string

O carimbo de data/hora do instantâneo.

Devoluções

AppendBlobClient

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

Detalhes do Método Herdado

abortCopyFromURL(string, BlobAbortCopyFromURLOptions)

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.

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

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

Parâmetros

copyId: string

ID da operação Copiar do URL.

options: BlobAbortCopyFromURLOptions

Opções opcionais para a operação Abortar Cópia do URL do Blob.

Devoluções

Promise<BlobAbortCopyFromURLResponse>

Herdado deBlobClient.abortCopyFromURL

beginCopyFromURL(string, BlobBeginCopyFromURLOptions)

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.

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

Exemplo através de consultas automáticas:

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

Exemplo de utilização de consultas manuais:

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

Exemplo com atualizações de progresso:

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

Exemplo com um intervalo de consulta alterado (predefiniçã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 com o 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

copySource: string

url para o Blob/Ficheiro do Azure de origem.

options: BlobBeginCopyFromURLOptions

Opções opcionais para a operação Iniciar Cópia a Partir do URL do Blob.

Devoluções

Promise<PollerLikeWithCancellation<PollOperationState<BlobBeginCopyFromURLResponse>, BlobBeginCopyFromURLResponse>>

Herdado deBlobClient.beginCopyFromURL

createSnapshot(BlobCreateSnapshotOptions)

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

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

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

Parâmetros

options: BlobCreateSnapshotOptions

Opções opcionais para a operação Criar Instantâneo de Blobs.

Devoluções

Promise<BlobCreateSnapshotResponse>

Herdado deBlobClient.createSnapshot

delete(BlobDeleteOptions)

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.

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

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

Parâmetros

options: BlobDeleteOptions

Opções opcionais para a operação de Eliminação de Blobs.

Devoluções

Promise<BlobDeleteResponse>

Herdado deBlobClient.delete

deleteIfExists(BlobDeleteOptions)

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.

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

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

Parâmetros

options: BlobDeleteOptions

Opções opcionais para a operação de Eliminação de Blobs.

Devoluções

Promise<BlobDeleteIfExistsResponse>

Herdado deBlobClient.deleteIfExists

deleteImmutabilityPolicy(BlobDeleteImmutabilityPolicyOptions)

Elimine a política de immutablility no blob.

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

Parâmetros

options: BlobDeleteImmutabilityPolicyOptions

Opções opcionais para eliminar a política de imutabilidade no blob.

Devoluções

Promise<BlobDeleteImmutabilityPolicyResponse>

Herdado deBlobClient.deleteImmutabilityPolicy

download(number, number, BlobDownloadOptions)

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

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

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

Parâmetros

offset: number

A partir da posição do blob a transferir, maior ou igual a 0

count: number

A quantidade de dados a transferir, superior a 0. Será transferido para o fim quando não for definido

options: BlobDownloadOptions

Opções opcionais para a operação de Transferência de Blobs.

Utilização de exemplo (Node.js):

// 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);
});
}

Utilização de exemplo (browser):

// 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

Promise<BlobDownloadResponseParsed>

Herdado deBlobClient.download

downloadToBuffer(Buffer, number, number, BlobDownloadToBufferOptions)

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 downloadToFile.

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

Parâmetros

buffer: Buffer

Memória intermédia a preencher, tem de ter um comprimento superior à contagem

offset: number

A partir da posição do blob de blocos a transferir(em bytes)

count: number

Quanta quantidade de dados (em bytes) a transferir. Será transferida para o fim ao passar indefinidamente

options: BlobDownloadToBufferOptions

BlobDownloadToBufferOptions

Devoluções

Promise<Buffer>

Herdado deBlobClient.downloadToBuffer

downloadToBuffer(number, number, BlobDownloadToBufferOptions)

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.

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

Parâmetros

offset: number

A partir da posição do blob de blocos a transferir(em bytes)

count: number

Quanta quantidade de dados (em bytes) a transferir. Será transferida para o fim ao passar indefinidamente

options: BlobDownloadToBufferOptions

BlobDownloadToBufferOptions

Devoluções

Promise<Buffer>

Herdado deBlobClient.downloadToBuffer

downloadToFile(string, number, number, BlobDownloadOptions)

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

Parâmetros

filePath: string

offset: number

A partir da posição do blob de blocos a transferir.

count: number

Quanta quantidade de dados a transferir. Será transferido para o fim ao passar indefinido.

options: BlobDownloadOptions

Opções para opções de transferência de Blobs.

Devoluções

Promise<BlobDownloadResponseParsed>

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.

Herdado deBlobClient.downloadToFile

exists(BlobExistsOptions)

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

Parâmetros

options: BlobExistsOptions

opções para a operação Existe.

Devoluções

Promise<boolean>

Herdado doBlobClient.existe

generateSasUrl(BlobGenerateSasUrlOptions)

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.

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

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

Parâmetros

options: BlobGenerateSasUrlOptions

Parâmetros opcionais.

Devoluções

Promise<string>

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

Herdado deBlobClient.generateSasUrl

getAppendBlobClient()

Cria um objeto AppendBlobClient.

function getAppendBlobClient(): AppendBlobClient

Devoluções

AppendBlobClient

Herdado deBlobClient.getAppendBlobClient

getBlobLeaseClient(string)

Obtenha um BlobLeaseClient que gere as concessões no blob.

function getBlobLeaseClient(proposeLeaseId?: string): BlobLeaseClient

Parâmetros

proposeLeaseId: string

ID de concessão proposta inicial.

Devoluções

BlobLeaseClient

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

Herdado deBlobClient.getBlobLeaseClient

getBlockBlobClient()

Cria um objeto BlockBlobClient.

function getBlockBlobClient(): BlockBlobClient

Devoluções

BlockBlobClient

Herdado deBlobClient.getBlockBlobClient

getPageBlobClient()

Cria um objeto PageBlobClient.

function getPageBlobClient(): PageBlobClient

Devoluções

PageBlobClient

Herdado deBlobClient.getPageBlobClient

getProperties(BlobGetPropertiesOptions)

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.

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

AVISO: o metadata objeto devolvido na resposta terá as respetivas teclas em minúsculas, mesmo que tenham originalmente carateres em maiúsculas. Isto difere das chaves de metadados devolvidas pelos métodos containerClient que listam blobs com a opção includeMetadata , que irá manter a sua caixa original.

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

Parâmetros

options: BlobGetPropertiesOptions

Opções opcionais para a operação Obter Propriedades.

Devoluções

Promise<BlobGetPropertiesResponse>

Herdado deBlobClient.getProperties

getTags(BlobGetTagsOptions)

Obtém as etiquetas associadas ao blob subjacente.

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

Parâmetros

options: BlobGetTagsOptions

Devoluções

Promise<BlobGetTagsResponse>

Herdado deBlobClient.getTags

setAccessTier(string, BlobSetTierOptions)

Define a camada num blob. A operação é permitida num blob de páginas 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áginas 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 a 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

tier: string

A camada a definir no blob. Os valores válidos são Frequente, Esporádico ou Arquivo.

options: BlobSetTierOptions

Opções opcionais para a operação de Camada de Conjunto de Blobs.

Devoluções

Promise<BlobSetTierResponse>

Herdado deBlobClient.setAccessTier

setHTTPHeaders(BlobHTTPHeaders, BlobSetHTTPHeadersOptions)

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.

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

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

Parâmetros

blobHTTPHeaders: BlobHTTPHeaders

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. Um cabeçalho comum a definir é blobContentType permitir que o browser forneça funcionalidades com base no tipo de ficheiro.

options: BlobSetHTTPHeadersOptions

Opções opcionais para a operação Definir Cabeçalhos HTTP de Blobs.

Devoluções

Promise<BlobSetHTTPHeadersResponse>

Herdado deBlobClient.setHTTPHeaders

setImmutabilityPolicy(BlobImmutabilityPolicy, BlobSetImmutabilityPolicyOptions)

Defina a política de imutablilidade no blob.

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

Parâmetros

immutabilityPolicy: BlobImmutabilityPolicy

options: BlobSetImmutabilityPolicyOptions

Opções opcionais para definir a política de imutabilidade no blob.

Devoluções

Promise<BlobSetImmutabilityPolicyResponse>

Herdado deBlobClient.setImmutabilityPolicy

setLegalHold(boolean, BlobSetLegalHoldOptions)

Defina a retenção legal no blob.

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

Parâmetros

legalHoldEnabled: boolean

options: BlobSetLegalHoldOptions

Opções opcionais para definir a retenção legal no blob.

Devoluções

Promise<BlobSetLegalHoldResponse>

Herdado deBlobClient.setLegalHold

setMetadata(Metadata, BlobSetMetadataOptions)

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.

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

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

Parâmetros

metadata: Metadata

Substitua os metadados existentes por este valor. Se não for fornecido nenhum valor, os metadados existentes serão removidos.

options: BlobSetMetadataOptions

Opções opcionais para definir a operação de Metadados.

Devoluções

Promise<BlobSetMetadataResponse>

Herdado deBlobClient.setMetadata

setTags(Tags, BlobSetTagsOptions)

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 chave e valor de etiqueta válidos incluem letras minúsculas e maiúsculas, dígitos (0-9), espaço (' '), mais ('+'), menos ('-'), ponto final ('.'), barra ('/'), dois pontos (':'), igual a ('=') e caráter de sublinhado ('_') .

function setTags(tags: Tags, options?: BlobSetTagsOptions): Promise<BlobSetTagsResponse>

Parâmetros

tags: Tags

options: BlobSetTagsOptions

Devoluções

Promise<BlobSetTagsResponse>

Herdado deBlobClient.setTags

syncCopyFromURL(string, BlobSyncCopyFromURLOptions)

A operação copiar de 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.

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

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

Parâmetros

copySource: string

O URL de origem a partir do , Assinatura de Acesso Partilhado (SAS) talvez necessário para autenticação

options: BlobSyncCopyFromURLOptions

Devoluções

Promise<BlobCopyFromURLResponse>

Herdado deBlobClient.syncCopyFromURL

undelete(BlobUndeleteOptions)

Restaura os conteúdos e metadados do blob eliminado de forma recuperável e quaisquer instantâneos de eliminação recuperável associados. Anular Eliminação de Blobs só é suportado 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

options: BlobUndeleteOptions

Opções opcionais para a operação Anular Eliminação de Blobs.

Devoluções

Promise<BlobUndeleteResponse>

Herdado deBlobClient.undelete

withVersion(string)

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

Parâmetros

versionId: string

O versionId.

Devoluções

BlobClient

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

Herdado deBlobClient.withVersion

Share via

AppendBlobClient class

Construtores

Propriedades

Propriedades Herdadas

Métodos

Métodos Herdados

Detalhes do Construtor

AppendBlobClient(string, PipelineLike)

Parâmetros

AppendBlobClient(string, StorageSharedKeyCredential | AnonymousCredential | TokenCredential, StoragePipelineOptions)

Parâmetros

AppendBlobClient(string, string, string, StoragePipelineOptions)

Parâmetros

Detalhes de Propriedade

containerName

Valor de Propriedade

name

Valor de Propriedade

Detalhes da Propriedade Herdada

accountName

Valor de Propriedade

credential

Valor de Propriedade

url

Valor de Propriedade

Detalhes de Método

appendBlock(HttpRequestBody, number, AppendBlobAppendBlockOptions)

Parâmetros

Devoluções

appendBlockFromURL(string, number, number, AppendBlobAppendBlockFromURLOptions)

Parâmetros

Devoluções

create(AppendBlobCreateOptions)

Parâmetros

Devoluções

createIfNotExists(AppendBlobCreateIfNotExistsOptions)

Parâmetros

Devoluções

seal(AppendBlobSealOptions)

Parâmetros

Devoluções

withSnapshot(string)

Parâmetros

Devoluções

Detalhes do Método Herdado

abortCopyFromURL(string, BlobAbortCopyFromURLOptions)

Parâmetros

Devoluções

beginCopyFromURL(string, BlobBeginCopyFromURLOptions)

Parâmetros

Devoluções

createSnapshot(BlobCreateSnapshotOptions)

Parâmetros

Devoluções

delete(BlobDeleteOptions)

Parâmetros

Devoluções

deleteIfExists(BlobDeleteOptions)

Parâmetros

Devoluções

deleteImmutabilityPolicy(BlobDeleteImmutabilityPolicyOptions)

Parâmetros

Devoluções

download(number, number, BlobDownloadOptions)

Parâmetros

Devoluções

downloadToBuffer(Buffer, number, number, BlobDownloadToBufferOptions)

Parâmetros

Devoluções

downloadToBuffer(number, number, BlobDownloadToBufferOptions)

Parâmetros

Devoluções

downloadToFile(string, number, number, BlobDownloadOptions)

Parâmetros

Devoluções

exists(BlobExistsOptions)

Parâmetros

Devoluções

generateSasUrl(BlobGenerateSasUrlOptions)