AppendBlobClient class

Pacote:: @azure/storage-blob

AppendBlobClient define um conjunto de operações aplicáveis a blobs de apêndice.

Extends: BlobClient

Construtores

AppendBlobClient(string, PipelineLike)	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.
AppendBlobClient(string, StorageSharedKeyCredential \| AnonymousCredential \| TokenCredential, StoragePipelineOptions)	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.
AppendBlobClient(string, string, string, StoragePipelineOptions)	Cria uma instância de AppendBlobClient.

Propriedades

accountName
containerName	O nome do contêiner de armazenamento ao qual o blob está associado.
credential	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.
name	O nome do blob.
url	Valor da cadeia de caracteres de URL codificada.

Métodos

abortCopyFromURL(string, BlobAbortCopyFromURLOptions)	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.
appendBlock(HttpRequestBody, number, AppendBlobAppendBlockOptions)	Confirma um novo bloco de dados no final do blob de acréscimo existente.
appendBlockFromURL(string, number, number, AppendBlobAppendBlockFromURLOptions)	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.
beginCopyFromURL(string, BlobBeginCopyFromURLOptions)	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.
create(AppendBlobCreateOptions)	Cria um blob de acréscimo de 0 comprimentos. Chame AppendBlock para acrescentar dados a um blob de acréscimo.
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.
createSnapshot(BlobCreateSnapshotOptions)	Cria um instantâneo somente leitura de um blob.
delete(BlobDeleteOptions)	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.
deleteIfExists(BlobDeleteOptions)	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.
deleteImmutabilityPolicy(BlobDeleteImmutabilityPolicyOptions)	Exclua a política de imutablilidade no blob.
download(number, number, BlobDownloadOptions)	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
downloadToBuffer(Buffer, number, number, BlobDownloadToBufferOptions)	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>.
downloadToBuffer(number, number, BlobDownloadToBufferOptions)	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>.
downloadToFile(string, number, number, BlobDownloadOptions)	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.
exists(BlobExistsOptions)	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.
generateSasUrl(BlobGenerateSasUrlOptions)	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.
getAppendBlobClient()	Cria um objeto AppendBlobClient.
getBlobLeaseClient(string)	Obtenha um <xref:BlobLeaseClient> que gerencia locações no blob.
getBlockBlobClient()	Cria um objeto BlockBlobClient.
getPageBlobClient()	Cria um objeto PageBlobClient.
getProperties(BlobGetPropertiesOptions)	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.
getTags(BlobGetTagsOptions)	Obtém as tags associadas ao blob subjacente.
seal(AppendBlobSealOptions)	Sela o blob de apêndice, tornando-o somente leitura.
setAccessTier(BlockBlobTier \| PremiumPageBlobTier \| string, BlobSetTierOptions)	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.
setHTTPHeaders(BlobHTTPHeaders, BlobSetHTTPHeadersOptions)	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.
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 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.
setTags(Tags, BlobSetTagsOptions)	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 ('_').
syncCopyFromURL(string, BlobSyncCopyFromURLOptions)	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.
undelete(BlobUndeleteOptions)	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.
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 retornará um Cliente ao blob de base.
withVersion(string)	Cria um novo objeto BlobClient apontando para uma versão desse blob. Fornecer "" removerá o versionId e retornará um cliente para o blob base.

Detalhes do Construtor

AppendBlobClient(string, PipelineLike)

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

url: string

Uma cadeia de caracteres de URL apontando para o blob de acréscimo do Armazenamento do Azure, como "https://myaccount.blob.core.windows.net/mycontainer/appendblob". Você pode acrescentar uma SAS se estiver usando AnonymousCredential, como "https://myaccount.blob.core.windows.net/mycontainer/appendblob?sasString". Esse método aceita uma URL codificada ou uma URL não codificada apontando para um blob. A cadeia de caracteres de URL codificada NÃO será escapada duas vezes, apenas caracteres especiais no caminho da URL serão escapados. No entanto, se um nome de blob incluir ? ou %, o nome do blob deve ser codificado na URL. Como um blob chamado "my?blob%", o URL deve ser "https://myaccount.blob.core.windows.net/mycontainer/my%3Fblob%25".

pipeline: PipelineLike

Chame newPipeline() para criar um pipeline padrão 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

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.

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 conexão de conta ou uma cadeia de conexão SAS de uma conta de armazenamento do Azure. [ Observação - A cadeia de conexão da conta só pode ser usada em NODE.JS tempo de execução. ] Exemplo de cadeia de conexão de conta - DefaultEndpointsProtocol=https;AccountName=myaccount;AccountKey=accountKey;EndpointSuffix=core.windows.net exemplo de cadeia de conexã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 contêiner.

blobName: string

Nome do blob.

options: StoragePipelineOptions

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

Detalhes de Propriedade

accountName

accountName: string

Valor de Propriedade

string

containerName

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

string containerName

Valor de Propriedade

string

credential

credential: StorageSharedKeyCredential | AnonymousCredential | TokenCredential

Valor de Propriedade

StorageSharedKeyCredential | AnonymousCredential | TokenCredential

name

O nome do blob.

string name

Valor de Propriedade

string

url

Valor da cadeia de caracteres de URL codificada.

url: string

Valor de Propriedade

string

Detalhes de Método

abortCopyFromURL(string, BlobAbortCopyFromURLOptions)

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

copyId: string

Id da operação Copy From URL.

options: BlobAbortCopyFromURLOptions

Opções opcionais para a operação Blob Abort Copy From URL.

Devoluções

Promise<BlobAbortCopyFromURLResponse>

appendBlock(HttpRequestBody, number, AppendBlobAppendBlockOptions)

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

function appendBlock(body: HttpRequestBody, contentLength: number, options?: AppendBlobAppendBlockOptions)

Parâmetros

body: HttpRequestBody

Dados a anexar.

contentLength: number

Comprimento do corpo em bytes.

options: AppendBlobAppendBlockOptions

Opções para a operação Append Block.

Exemplo de uso:

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

function appendBlockFromURL(sourceURL: string, sourceOffset: number, count: number, options?: AppendBlobAppendBlockFromURLOptions)

Parâmetros

sourceURL: string

          The url to the blob that will be the source of the copy. A source blob in the same storage account can
          be authenticated via Shared Key. However, if the source is a blob in another account, the source blob
          must either be public or must be authenticated via a shared access signature. If the source blob is
          public, no authentication is required to perform the operation.

sourceOffset: number

Deslocamento na fonte a ser anexado

count: number

Número de bytes a acrescentar como bloco

options: AppendBlobAppendBlockFromURLOptions

Devoluções

Promise<AppendBlobAppendBlockFromUrlResponse>

beginCopyFromURL(string, BlobBeginCopyFromURLOptions)

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

copySource: string

url para o Blob/Arquivo do Azure de origem.

options: BlobBeginCopyFromURLOptions

Opções opcionais para a operação Blob Start Copy From URL.

Devoluções

Promise<PollerLike<PollOperationState<BlobBeginCopyFromURLResponse>, BlobBeginCopyFromURLResponse>>

create(AppendBlobCreateOptions)

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

function create(options?: AppendBlobCreateOptions)

Parâmetros

options: AppendBlobCreateOptions

Opções para a operação Append Block Create.

Exemplo de uso:

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.

function createIfNotExists(options?: AppendBlobCreateIfNotExistsOptions)

Parâmetros

options: AppendBlobCreateIfNotExistsOptions

Devoluções

Promise<AppendBlobCreateIfNotExistsResponse>

createSnapshot(BlobCreateSnapshotOptions)

Cria um instantâneo somente leitura de um blob.

function createSnapshot(options?: BlobCreateSnapshotOptions)

Parâmetros

options: BlobCreateSnapshotOptions

Opções opcionais para a operação Blob Create Snapshot.

Devoluções

Promise<BlobCreateSnapshotResponse>

delete(BlobDeleteOptions)

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

options: BlobDeleteOptions

Opções opcionais para a operação Blob Delete.

Devoluções

Promise<BlobDeleteResponse>

deleteIfExists(BlobDeleteOptions)

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

options: BlobDeleteOptions

Opções opcionais para a operação Blob Delete.

Devoluções

Promise<BlobDeleteIfExistsResponse>

deleteImmutabilityPolicy(BlobDeleteImmutabilityPolicyOptions)

Exclua a política de imutablilidade no blob.

function deleteImmutabilityPolicy(options?: BlobDeleteImmutabilityPolicyOptions)

Parâmetros

options: BlobDeleteImmutabilityPolicyOptions

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

Devoluções

Promise<BlobDeleteImmutabilityPolicyResponse>

download(number, number, BlobDownloadOptions)

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

offset: number

A partir de qual posição do blob baixar, maior ou igual a 0

count: number

Quantos dados serão baixados, maior que 0. Será baixado até o final quando indefinido

options: BlobDownloadOptions

Opções opcionais para a operação de Download de Blob.

Exemplo de utilização (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);
});
}

Exemplo de utilização (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>

downloadToBuffer(Buffer, number, number, BlobDownloadToBufferOptions)

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

buffer: Buffer

Buffer para ser preenchido, deve ter comprimento maior do que contagem

offset: number

A partir de qual posição do blob bloco para download (em bytes)

count: number

Quantos dados (em bytes) devem ser baixados. Será baixado até o final ao passar indefinido

options: BlobDownloadToBufferOptions

BlobDownloadToBufferOptions

Devoluções

Promise<Buffer>

downloadToBuffer(number, number, BlobDownloadToBufferOptions)

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.

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

Parâmetros

offset: number

A partir de qual posição do blob bloco para download (em bytes)

count: number

Quantos dados (em bytes) devem ser baixados. Será baixado até o final ao passar indefinido

options: BlobDownloadToBufferOptions

BlobDownloadToBufferOptions

Devoluções

Promise<Buffer>

downloadToFile(string, number, number, BlobDownloadOptions)

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

filePath: string

offset: number

A partir de qual posição do blob bloco para download.

count: number

Quantos dados serão baixados. Fará o download até o final ao passar indefinido.

options: BlobDownloadOptions

Opções para opções de download de Blob.

Devoluções

Promise<BlobDownloadResponseParsed>

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.

exists(BlobExistsOptions)

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

options: BlobExistsOptions

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

Devoluções

Promise<boolean>

generateSasUrl(BlobGenerateSasUrlOptions)

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

options: BlobGenerateSasUrlOptions

Parâmetros opcionais.

Devoluções

Promise<string>

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

getAppendBlobClient()

Cria um objeto AppendBlobClient.

function getAppendBlobClient()

Devoluções

AppendBlobClient

getBlobLeaseClient(string)

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

function getBlobLeaseClient(proposeLeaseId?: string)

Parâmetros

proposeLeaseId: string

Proposta inicial de arrendamento Id.

Devoluções

BlobLeaseClient

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

getBlockBlobClient()

Cria um objeto BlockBlobClient.

function getBlockBlobClient()

Devoluções

BlockBlobClient

getPageBlobClient()

Cria um objeto PageBlobClient.

function getPageBlobClient()

Devoluções

PageBlobClient

getProperties(BlobGetPropertiesOptions)

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

options: BlobGetPropertiesOptions

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

Devoluções

Promise<BlobGetPropertiesResponse>

getTags(BlobGetTagsOptions)

Obtém as tags associadas ao blob subjacente.

function getTags(options?: BlobGetTagsOptions)

Parâmetros

options: BlobGetTagsOptions

Devoluções

Promise<BlobGetTagsResponse>

seal(AppendBlobSealOptions)

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

function seal(options?: AppendBlobSealOptions)

Parâmetros

options: AppendBlobSealOptions

Devoluções

Promise<AppendBlobAppendBlockResponse>

setAccessTier(BlockBlobTier | PremiumPageBlobTier | string, BlobSetTierOptions)

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

tier: BlockBlobTier | PremiumPageBlobTier | string

A camada a ser definida no blob. Os valores válidos são Hot, Cool ou Archive.

options: BlobSetTierOptions

Opções opcionais para a operação Blob set Tier.

Devoluções

Promise<BlobSetTierResponse>

setHTTPHeaders(BlobHTTPHeaders, BlobSetHTTPHeadersOptions)

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

blobHTTPHeaders: BlobHTTPHeaders

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. Um cabeçalho comum a ser definido é blobContentType permitir que o navegador forneça funcionalidade com base no tipo de arquivo.

options: BlobSetHTTPHeadersOptions

Opções opcionais para a operação Blob set HTTP Headers.

Devoluções

Promise<BlobSetHTTPHeadersResponse>

setImmutabilityPolicy(BlobImmutabilityPolicy, BlobSetImmutabilityPolicyOptions)

Defina a política de imutablilidade no blob.

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

Parâmetros

immutabilityPolicy: BlobImmutabilityPolicy

options: BlobSetImmutabilityPolicyOptions

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

Devoluções

Promise<BlobSetImmutabilityPolicyResponse>

setLegalHold(boolean, BlobSetLegalHoldOptions)

Defina a retenção legal no blob.

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

Parâmetros

legalHoldEnabled: boolean

options: BlobSetLegalHoldOptions

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

Devoluções

Promise<BlobSetLegalHoldResponse>

setMetadata(Metadata, BlobSetMetadataOptions)

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

metadata: Metadata

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

options: BlobSetMetadataOptions

Opções opcionais para a operação Definir metadados.

Devoluções

Promise<BlobSetMetadataResponse>

setTags(Tags, BlobSetTagsOptions)

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

tags: Tags

options: BlobSetTagsOptions

Devoluções

Promise<BlobSetTagsResponse>

syncCopyFromURL(string, BlobSyncCopyFromURLOptions)

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

copySource: string

O URL de origem do qual copiar, Assinatura de Acesso Compartilhado (SAS) pode ser necessário para autenticação

options: BlobSyncCopyFromURLOptions

Devoluções

Promise<BlobCopyFromURLResponse>

undelete(BlobUndeleteOptions)

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

options: BlobUndeleteOptions

Opções opcionais para a operação Blob Undelete.

Devoluções

Promise<BlobUndeleteResponse>

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

function withSnapshot(snapshot: string)

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.

withVersion(string)

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

versionId: string

O versionId.

Devoluções

BlobClient

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

Comentários

Esta página foi útil?

Partilhar via

AppendBlobClient class

Construtores

Propriedades

Métodos

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

accountName

Valor de Propriedade

containerName

Valor de Propriedade

credential

Valor de Propriedade

name

Valor de Propriedade

url

Valor de Propriedade

Detalhes de Método

abortCopyFromURL(string, BlobAbortCopyFromURLOptions)

Parâmetros

Devoluções

appendBlock(HttpRequestBody, number, AppendBlobAppendBlockOptions)

Parâmetros

Devoluções

appendBlockFromURL(string, number, number, AppendBlobAppendBlockFromURLOptions)

Parâmetros

Devoluções

beginCopyFromURL(string, BlobBeginCopyFromURLOptions)

Parâmetros

Devoluções

create(AppendBlobCreateOptions)

Parâmetros

Devoluções

createIfNotExists(AppendBlobCreateIfNotExistsOptions)

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)

Parâmetros

Devoluções

getAppendBlobClient()

Devoluções

getBlobLeaseClient(string)

Parâmetros

Devoluções

getBlockBlobClient()

Devoluções

getPageBlobClient()