BlockBlobClient class

Referência

Pacote:: @azure/storage-blob

BlockBlobClient define um conjunto de operações aplicáveis a blobs de bloco.

Extends: BlobClient

Construtores

BlockBlobClient(string, PipelineLike)	Cria uma instância de BlockBlobClient. Este método aceita um URL codificado ou um URL não codificado apontando para um blob de bloco. A cadeia de caracteres de URL codificada NÃO será escapada duas vezes, apenas caracteres especiais no caminho da URL serão escapados. Se um nome de blob incluir ? ou %, o nome do blob deve ser codificado na URL.
BlockBlobClient(string, StorageSharedKeyCredential \| AnonymousCredential \| TokenCredential, StoragePipelineOptions)	Cria uma instância de BlockBlobClient. Este método aceita um URL codificado ou um URL não codificado apontando para um blob de bloco. A cadeia de caracteres de URL codificada NÃO será escapada duas vezes, apenas caracteres especiais no caminho da URL serão escapados. Se um nome de blob incluir ? ou %, o nome do blob deve ser codificado na URL.
BlockBlobClient(string, string, string, StoragePipelineOptions)	Cria uma instância de BlockBlobClient.

Propriedades

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

Propriedades Herdadas

accountName
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.
url	Valor da cadeia de caracteres de URL codificada.

Métodos

commitBlockList(string[], BlockBlobCommitBlockListOptions)	Escreve um blob especificando a lista de IDs de bloco que compõem o blob. Para ser gravado como parte de um blob, um bloco deve ter sido gravado com êxito no servidor em uma operação de de stageBlock anterior. Você pode chamar commitBlockList para atualizar um blob carregando apenas os blocos que foram alterados e, em seguida, confirmando os blocos novos e existentes juntos. Quaisquer blocos não especificados na lista de bloqueios e excluídos permanentemente. Visualizar https://docs.microsoft.com/rest/api/storageservices/put-block-list
getBlockList(BlockListType, BlockBlobGetBlockListOptions)	Retorna a lista de blocos que foram carregados como parte de um blob de bloco usando o filtro de lista de blocos especificado. Visualizar https://docs.microsoft.com/rest/api/storageservices/get-block-list
query(string, BlockBlobQueryOptions)	DISPONÍVEL APENAS EM TEMPO DE EXECUÇÃO NODE.JS. Consulta rápida para um blob formatado em JSON ou CSV. Exemplo de utilização (Node.js): // Query and convert a blob to a string const queryBlockBlobResponse = await blockBlobClient.query("select * from BlobStorage"); const downloaded = (await streamToBuffer(queryBlockBlobResponse.readableStreamBody)).toString(); console.log("Query blob content:", downloaded); async function streamToBuffer(readableStream) { return new Promise((resolve, reject) => { const chunks = []; readableStream.on("data", (data) => { chunks.push(data instanceof Buffer ? data : Buffer.from(data)); }); readableStream.on("end", () => { resolve(Buffer.concat(chunks)); }); readableStream.on("error", reject); }); }
stageBlock(string, RequestBodyType, number, BlockBlobStageBlockOptions)	Carrega o bloco especificado na "área de preparação" do blob de bloco para ser posteriormente confirmado por uma chamada para commitBlockList. Visualizar https://docs.microsoft.com/rest/api/storageservices/put-block
stageBlockFromURL(string, string, number, number, BlockBlobStageBlockFromURLOptions)	A operação Stage Block From URL cria um novo bloco a ser confirmado como parte de um blob onde o conteúdo é lido de uma URL. Esta API está disponível a partir da versão 2018-03-28. Visualizar https://docs.microsoft.com/en-us/rest/api/storageservices/put-block-from-url
syncUploadFromURL(string, BlockBlobSyncUploadFromURLOptions)	Cria um novo Blob de Bloco onde o conteúdo do blob é lido de uma determinada URL. Esta API é suportada a partir da versão 2020-04-08. Não há suporte para atualizações parciais com Put Blob from URL; O conteúdo de um blob existente é substituído pelo conteúdo do novo blob. Para executar atualizações parciais no conteúdo de um blob de bloco usando uma URL de origem, use stageBlockFromURL e commitBlockList.
upload(RequestBodyType, number, BlockBlobUploadOptions)	Cria um novo blob de bloco ou atualiza o conteúdo de um blob de bloco existente. A atualização de um blob de bloco existente substitui quaisquer metadados existentes no blob. Não há suporte para atualizações parciais; O conteúdo do blob existente é substituído pelo novo conteúdo. Para executar uma atualização parcial de um blob de bloco, use stageBlock e commitBlockList. Este é um método de upload não paralelo, use uploadFile, uploadStream ou uploadBrowserData para um melhor desempenho com o upload simultâneo. Visualizar https://docs.microsoft.com/rest/api/storageservices/put-blob
uploadBrowserData(Blob \| ArrayBuffer \| ArrayBufferView, BlockBlobParallelUploadOptions)	DISPONÍVEL APENAS EM NAVEGADORES. Carrega um objeto Blob/File/ArrayBuffer/ArrayBufferView do navegador para bloquear o blob. Quando o comprimento do buffer for menor ou igual a 256MB, esse método usará 1 chamada de upload para concluir o upload. Caso contrário, esse método chamará stageBlock para carregar blocos e, finalmente, chamará commitBlockList para confirmar a lista de bloqueios. Uma opção comum blobHTTPHeaders para definir é `blobContentType`, permitindo que o navegador forneça funcionalidade com base no tipo de arquivo.
uploadData(Blob \| ArrayBuffer \| ArrayBufferView \| Buffer, BlockBlobParallelUploadOptions)	Carrega um objeto Buffer(Node.js)/Blob(browsers)/ArrayBuffer/ArrayBufferView para um BlockBlob. Quando o comprimento dos dados não é mais do que o especifile maxSingleShotSize (o padrão é <xref:BLOCK_BLOB_MAX_UPLOAD_BLOB_BYTES>), esse método usará 1 carregar chamada para concluir o upload. Caso contrário, esse método chamará stageBlock para carregar blocos e, finalmente, chamará commitBlockList para confirmar a lista de bloqueios. Uma opção comum blobHTTPHeaders para definir é `blobContentType`, permitindo que o navegador forneça funcionalidade com base no tipo de arquivo.
uploadFile(string, BlockBlobParallelUploadOptions)	DISPONÍVEL APENAS EM TEMPO DE EXECUÇÃO NODE.JS. Carrega um arquivo local em blocos para um blob de bloco. Quando o tamanho do ficheiro for inferior ou igual a 256MB, este método utilizará 1 chamada de carregamento para concluir o carregamento. Caso contrário, esse método chamará stageBlock para carregar blocos e, finalmente, chamará commitBlockList para confirmar a lista de bloqueios.
uploadStream(Readable, number, number, BlockBlobUploadStreamOptions)	DISPONÍVEL APENAS EM TEMPO DE EXECUÇÃO NODE.JS. Carrega um fluxo Node.js legível no blob de bloco. DICAS DE MELHORIA DE DESEMPENHO: O fluxo de entrada highWaterMark é melhor definir um mesmo valor com o parâmetro bufferSize, o que evitará operações Buffer.concat().
withSnapshot(string)	Cria um novo objeto BlockBlobClient idêntico à origem, mas com o carimbo de data/hora do instantâneo especificado. Fornecer "" removerá o instantâneo e retornará uma URL para o blob base.

Métodos Herdados

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. Visualizar https://docs.microsoft.com/en-us/rest/api/storageservices/abort-copy-blob
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. Visualizar 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.'); } }`
createSnapshot(BlobCreateSnapshotOptions)	Cria um instantâneo somente leitura de um blob. Visualizar https://docs.microsoft.com/en-us/rest/api/storageservices/snapshot-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. Visualizar https://docs.microsoft.com/en-us/rest/api/storageservices/delete-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. Visualizar https://docs.microsoft.com/en-us/rest/api/storageservices/delete-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 Visualizar https://docs.microsoft.com/en-us/rest/api/storageservices/get-blob
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 blobs maiores que esse tamanho, considere 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 blobs maiores que esse tamanho, considere 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.
generateSasStringToSign(BlobGenerateSasUrlOptions)	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. Visualizar https://docs.microsoft.com/en-us/rest/api/storageservices/constructing-a-service-sas
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. Visualizar https://docs.microsoft.com/en-us/rest/api/storageservices/constructing-a-service-sas
generateUserDelegationSasStringToSign(BlobGenerateSasUrlOptions, UserDelegationKey)	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. Visualizar https://docs.microsoft.com/en-us/rest/api/storageservices/constructing-a-service-sas
generateUserDelegationSasUrl(BlobGenerateSasUrlOptions, UserDelegationKey)	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. Visualizar https://docs.microsoft.com/en-us/rest/api/storageservices/constructing-a-service-sas
getAccountInfo(BlobGetAccountInfoOptions)	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. Visualizar https://docs.microsoft.com/en-us/rest/api/storageservices/get-account-information
getAppendBlobClient()	Cria um objeto AppendBlobClient.
getBlobLeaseClient(string)	Obtenha um BlobLeaseClient que gerencia concessõ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. Visualizar 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.
getTags(BlobGetTagsOptions)	Obtém as tags associadas ao blob subjacente.
setAccessTier(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. Visualizar https://docs.microsoft.com/en-us/rest/api/storageservices/set-blob-tier
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. Visualizar https://docs.microsoft.com/en-us/rest/api/storageservices/set-blob-properties
setImmutabilityPolicy(BlobImmutabilityPolicy, BlobSetImmutabilityPolicyOptions)	Defina a política de imutabilidade 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. Visualizar https://docs.microsoft.com/en-us/rest/api/storageservices/set-blob-metadata
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. Visualizar https://docs.microsoft.com/en-us/rest/api/storageservices/copy-blob-from-url
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. Visualizar https://docs.microsoft.com/en-us/rest/api/storageservices/undelete-blob
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

BlockBlobClient(string, PipelineLike)

Cria uma instância de BlockBlobClient. Este método aceita um URL codificado ou um URL não codificado apontando para um blob de bloco. A cadeia de caracteres de URL codificada NÃO será escapada duas vezes, apenas caracteres especiais no caminho da URL serão escapados. Se um nome de blob incluir ? ou %, o nome do blob deve ser codificado na URL.

new BlockBlobClient(url: string, pipeline: PipelineLike)

Parâmetros

url: string

Uma cadeia de caracteres de URL apontando para o blob de bloco do Armazenamento do Azure, como "https://myaccount.blob.core.windows.net/mycontainer/blockblob". Você pode acrescentar uma SAS se estiver usando AnonymousCredential, como "https://myaccount.blob.core.windows.net/mycontainer/blockblob?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.

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

new BlockBlobClient(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.

BlockBlobClient(string, string, string, StoragePipelineOptions)

Cria uma instância de BlockBlobClient.

new BlockBlobClient(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

containerName

O nome do contêiner de armazenamento ao qual 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

credential: StorageSharedKeyCredential | AnonymousCredential | TokenCredential

Valor de Propriedade

StorageSharedKeyCredential | AnonymousCredential | TokenCredential

herdado deBlobClient.credential

url

Valor da cadeia de caracteres de URL codificada.

url: string

Valor de Propriedade

string

herdado deBlobClient.url

Detalhes de Método

commitBlockList(string[], BlockBlobCommitBlockListOptions)

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

Visualizar https://docs.microsoft.com/rest/api/storageservices/put-block-list

function commitBlockList(blocks: string[], options?: BlockBlobCommitBlockListOptions): Promise<BlockBlobCommitBlockListResponse>

Parâmetros

blocks: string[]

Matriz de valor de 64 bytes codificada em base64

options: BlockBlobCommitBlockListOptions

Opções para a operação Block Blob Commit Block List.

Devoluções

Promise<BlockBlobCommitBlockListResponse>

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

getBlockList(BlockListType, BlockBlobGetBlockListOptions)

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

Visualizar https://docs.microsoft.com/rest/api/storageservices/get-block-list

function getBlockList(listType: BlockListType, options?: BlockBlobGetBlockListOptions): Promise<BlockBlobGetBlockListResponse>

Parâmetros

listType: BlockListType

Especifica se a lista de blocos confirmados, a lista de blocos não confirmados ou ambas as listas devem ser retornadas.

options: BlockBlobGetBlockListOptions

Opções para a operação Block Blob Get Block List.

Devoluções

Promise<BlockBlobGetBlockListResponse>

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

query(string, BlockBlobQueryOptions)

DISPONÍVEL APENAS EM TEMPO DE EXECUÇÃO NODE.JS.

Consulta rápida para um blob formatado em JSON ou CSV.

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

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

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

function query(query: string, options?: BlockBlobQueryOptions): Promise<BlobDownloadResponseModel>

Parâmetros

query: string

options: BlockBlobQueryOptions

Devoluções

Promise<BlobDownloadResponseModel>

stageBlock(string, RequestBodyType, number, BlockBlobStageBlockOptions)

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

Visualizar https://docs.microsoft.com/rest/api/storageservices/put-block

function stageBlock(blockId: string, body: RequestBodyType, contentLength: number, options?: BlockBlobStageBlockOptions): Promise<BlockBlobStageBlockResponse>

Parâmetros

blockId: string

Um valor de 64 bytes codificado em base64

body: HttpRequestBody

Dados para carregar na área de preparação.

contentLength: number

Número de bytes a carregar.

options: BlockBlobStageBlockOptions

Opções para a operação Bloco de Estágio de Blob de Bloco.

Devoluções

Promise<BlockBlobStageBlockResponse>

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

stageBlockFromURL(string, string, number, number, BlockBlobStageBlockFromURLOptions)

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

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

function stageBlockFromURL(blockId: string, sourceURL: string, offset?: number, count?: number, options?: BlockBlobStageBlockFromURLOptions): Promise<BlockBlobStageBlockFromURLResponse>

Parâmetros

blockId: string

Um valor de 64 bytes codificado em base64

sourceURL: string

Especifica a URL do blob. O valor pode ser uma URL de até 2 KB de comprimento que especifica um blob. O valor deve ser codificado por URL como apareceria em um URI de solicitação. O blob de origem deve ser público ou autenticado por meio de uma assinatura de acesso compartilhado. Se o blob de origem for público, nenhuma autenticação será necessária para executar a operação. Aqui estão alguns exemplos de URLs de objeto de origem: - https://myaccount.blob.core.windows.net/mycontainer/myblob - https://myaccount.blob.core.windows.net/mycontainer/myblob?snapshot=

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: BlockBlobStageBlockFromURLOptions

Opções para a operação Bloquear Estágio de Blob Bloquear de URL.

Devoluções

Promise<BlockBlobStageBlockFromURLResponse>

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

syncUploadFromURL(string, BlockBlobSyncUploadFromURLOptions)

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

function syncUploadFromURL(sourceURL: string, options?: BlockBlobSyncUploadFromURLOptions): Promise<BlockBlobPutBlobFromUrlResponse>

Parâmetros

sourceURL: string

options: BlockBlobSyncUploadFromURLOptions

Parâmetros opcionais.

Devoluções

Promise<BlockBlobPutBlobFromUrlResponse>

upload(RequestBodyType, number, BlockBlobUploadOptions)

Cria um novo blob de bloco ou atualiza o conteúdo de um blob de bloco existente. A atualização de um blob de bloco existente substitui quaisquer metadados existentes no blob. Não há suporte para atualizações parciais; O conteúdo do blob existente é substituído pelo novo conteúdo. Para executar uma atualização parcial de um blob de bloco, use stageBlock e commitBlockList.

Este é um método de upload não paralelo, use uploadFile, uploadStream ou uploadBrowserData para um melhor desempenho com o upload simultâneo.

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

function upload(body: RequestBodyType, contentLength: number, options?: BlockBlobUploadOptions): Promise<BlockBlobUploadResponse>

Parâmetros

body: HttpRequestBody

Blob, string, ArrayBuffer, ArrayBufferView ou uma função que retorna um novo fluxo legível cujo deslocamento é do início da fonte de dados.

contentLength: number

Comprimento do corpo em bytes. Use Buffer.byteLength() para calcular o comprimento do corpo para uma cadeia de caracteres incluindo caracteres não codificados em Base64/Hex.

options: BlockBlobUploadOptions

Opções para a operação Block Blob Upload.

Devoluções

Promise<BlockBlobUploadResponse>

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

Exemplo de uso:

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

uploadBrowserData(Blob | ArrayBuffer | ArrayBufferView, BlockBlobParallelUploadOptions)

Aviso

Esta API foi preterida.

Use uploadData instead.

DISPONÍVEL APENAS EM NAVEGADORES.

Carrega um objeto Blob/File/ArrayBuffer/ArrayBufferView do navegador para bloquear o blob.

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

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

function uploadBrowserData(browserData: Blob | ArrayBuffer | ArrayBufferView, options?: BlockBlobParallelUploadOptions): Promise<BlobUploadCommonResponse>

Parâmetros

browserData: Blob | ArrayBuffer | ArrayBufferView

Blob, File, ArrayBuffer ou ArrayBufferView

options: BlockBlobParallelUploadOptions

Opções para carregar dados do navegador.

Devoluções

Promise<BlobUploadCommonResponse>

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

uploadData(Blob | ArrayBuffer | ArrayBufferView | Buffer, BlockBlobParallelUploadOptions)

Carrega um objeto Buffer(Node.js)/Blob(browsers)/ArrayBuffer/ArrayBufferView para um BlockBlob.

Quando o comprimento dos dados não é mais do que o especifile maxSingleShotSize (o padrão é <xref:BLOCK_BLOB_MAX_UPLOAD_BLOB_BYTES>), esse método usará 1 carregar chamada para concluir o upload. Caso contrário, esse método chamará stageBlock para carregar blocos e, finalmente, chamará commitBlockList para confirmar a lista de bloqueios.

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

function uploadData(data: Blob | ArrayBuffer | ArrayBufferView | Buffer, options?: BlockBlobParallelUploadOptions): Promise<BlobUploadCommonResponse>

Parâmetros

data: Blob | ArrayBuffer | ArrayBufferView | Buffer

Buffer(Node.js), Blob, ArrayBuffer ou ArrayBufferView

options: BlockBlobParallelUploadOptions

Devoluções

Promise<BlobUploadCommonResponse>

uploadFile(string, BlockBlobParallelUploadOptions)

DISPONÍVEL APENAS EM TEMPO DE EXECUÇÃO NODE.JS.

Carrega um arquivo local em blocos para um blob de bloco.

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

function uploadFile(filePath: string, options?: BlockBlobParallelUploadOptions): Promise<BlobUploadCommonResponse>

Parâmetros

filePath: string

Caminho completo do arquivo local

options: BlockBlobParallelUploadOptions

Opções para carregar para bloquear a operação de Blob.

Devoluções

Promise<BlobUploadCommonResponse>

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

uploadStream(Readable, number, number, BlockBlobUploadStreamOptions)

DISPONÍVEL APENAS EM TEMPO DE EXECUÇÃO NODE.JS.

Carrega um fluxo Node.js legível no blob de bloco.

DICAS DE MELHORIA DE DESEMPENHO:

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

function uploadStream(stream: Readable, bufferSize?: number, maxConcurrency?: number, options?: BlockBlobUploadStreamOptions): Promise<BlobUploadCommonResponse>

Parâmetros

stream: Readable

Node.js Fluxo legível

bufferSize: number

Tamanho de cada buffer alocado, também o tamanho do bloco no blob de bloco carregado. O valor padrão é 8MB

maxConcurrency: number

A simultaneidade máxima indica o número máximo de buffers que podem ser alocados, correlação positiva com a simultaneidade máxima de upload. O valor padrão é 5

options: BlockBlobUploadStreamOptions

Opções para carregar fluxo para bloquear a operação de Blob.

Devoluções

Promise<BlobUploadCommonResponse>

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

withSnapshot(string)

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

function withSnapshot(snapshot: string): BlockBlobClient

Parâmetros

snapshot: string

O carimbo de data/hora do instantâneo.

Devoluções

BlockBlobClient

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

Detalhes do Método Herdado

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.

Visualizar 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 Copy From URL.

options: BlobAbortCopyFromURLOptions

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

Devoluções

Promise<BlobAbortCopyFromURLResponse>

herdado deBlobClient.abortCopyFromURL

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.

Visualizar 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

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<PollerLikeWithCancellation<PollOperationState<BlobBeginCopyFromURLResponse>, BlobBeginCopyFromURLResponse>>

herdado de BlobClient.beginCopyFromURL

createSnapshot(BlobCreateSnapshotOptions)

Cria um instantâneo somente leitura de um blob.

Visualizar 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 Blob Create Snapshot.

Devoluções

Promise<BlobCreateSnapshotResponse>

herdado deBlobClient.createSnapshot

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.

Visualizar 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 Blob Delete.

Devoluções

Promise<BlobDeleteResponse>

herdado deBlobClient.delete

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.

Visualizar 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 Blob Delete.

Devoluções

Promise<BlobDeleteIfExistsResponse>

herdado deBlobClient.deleteIfExists

deleteImmutabilityPolicy(BlobDeleteImmutabilityPolicyOptions)

Exclua a política de imutablilidade no blob.

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

Parâmetros

options: BlobDeleteImmutabilityPolicyOptions

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

Devoluções

Promise<BlobDeleteImmutabilityPolicyResponse>

herdado deBlobClient.deleteImmutabilityPolicy

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

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

herdado deBlobClient.download

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

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

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>

herdado deBlobClient.downloadToBuffer

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

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>

herdado deBlobClient.downloadToBuffer

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

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.

herdado deBlobClient.downloadToFile

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

Parâmetros

options: BlobExistsOptions

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

Devoluções

Promise<boolean>

herdado deBlobClient.exists

generateSasStringToSign(BlobGenerateSasUrlOptions)

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.

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

function generateSasStringToSign(options: BlobGenerateSasUrlOptions): string

Parâmetros

options: BlobGenerateSasUrlOptions

Parâmetros opcionais.

Devoluções

string

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

herdado deBlobClient.generateSasStringToSign

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.

Visualizar 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 SAS que consiste no URI para o recurso representado por este cliente, seguido pelo token SAS gerado.

herdado deBlobClient.generateSasUrl

generateUserDelegationSasStringToSign(BlobGenerateSasUrlOptions, UserDelegationKey)

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.

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

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

Parâmetros

options: BlobGenerateSasUrlOptions

Parâmetros opcionais.

userDelegationKey: UserDelegationKey

Valor de retorno de blobServiceClient.getUserDelegationKey()

Devoluções

string

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

herdado deBlobClient.generateUserDelegationSasStringToSign

generateUserDelegationSasUrl(BlobGenerateSasUrlOptions, UserDelegationKey)

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.

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

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

Parâmetros

options: BlobGenerateSasUrlOptions

Parâmetros opcionais.

userDelegationKey: UserDelegationKey

Valor de retorno de blobServiceClient.getUserDelegationKey()

Devoluções

Promise<string>

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

herdado de BlobClient.generateUserDelegationSasUrl

getAccountInfo(BlobGetAccountInfoOptions)

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.

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

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

Parâmetros

options: BlobGetAccountInfoOptions

Opções para a operação Obter informações da conta do serviço.

Devoluções

Promise<BlobGetAccountInfoResponse>

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

herdado deBlobClient.getAccountInfo

getAppendBlobClient()

Cria um objeto AppendBlobClient.

function getAppendBlobClient(): AppendBlobClient

Devoluções

AppendBlobClient

herdado deBlobClient.getAppendBlobClient

getBlobLeaseClient(string)

Obtenha um BlobLeaseClient que gerencia concessões no blob.

function getBlobLeaseClient(proposeLeaseId?: string): BlobLeaseClient

Parâmetros

proposeLeaseId: string

Proposta inicial de arrendamento Id.

Devoluções

BlobLeaseClient

Um novo objeto BlobLeaseClient para gerenciar 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 de BlobClient.getPageBlobClient

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.

Visualizar 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

options: BlobGetPropertiesOptions

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

Devoluções

Promise<BlobGetPropertiesResponse>

herdado deBlobClient.getProperties

getTags(BlobGetTagsOptions)

Obtém as tags 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 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.

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

herdado de BlobClient.setAccessTier

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.

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

herdado deBlobClient.setHTTPHeaders

setImmutabilityPolicy(BlobImmutabilityPolicy, BlobSetImmutabilityPolicyOptions)

Defina a política de imutabilidade 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 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.

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

herdado de BlobClient.setMetadata

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

Parâmetros

tags: Tags

options: BlobSetTagsOptions

Devoluções

Promise<BlobSetTagsResponse>

herdado deBlobClient.setTags

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.

Visualizar 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 do qual copiar, Assinatura de Acesso Compartilhado (SAS) pode ser necessário para autenticação

options: BlobSyncCopyFromURLOptions

Devoluções

Promise<BlobCopyFromURLResponse>

herdado de BlobClient.syncCopyFromURL

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.

Visualizar 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 Blob Undelete.

Devoluções

Promise<BlobUndeleteResponse>

herdado deBlobClient.undelete

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

Parâmetros

versionId: string

O versionId.

Devoluções

BlobClient

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

herdado deBlobClient.withVersion

Partilhar via

BlockBlobClient class

Construtores

Propriedades

Propriedades Herdadas

Métodos

Métodos Herdados

Detalhes do Construtor

BlockBlobClient(string, PipelineLike)

Parâmetros

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

Parâmetros

BlockBlobClient(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

commitBlockList(string[], BlockBlobCommitBlockListOptions)

Parâmetros

Devoluções

getBlockList(BlockListType, BlockBlobGetBlockListOptions)

Parâmetros

Devoluções

query(string, BlockBlobQueryOptions)

Parâmetros

Devoluções

stageBlock(string, RequestBodyType, number, BlockBlobStageBlockOptions)

Parâmetros

Devoluções

stageBlockFromURL(string, string, number, number, BlockBlobStageBlockFromURLOptions)

Parâmetros

Devoluções

syncUploadFromURL(string, BlockBlobSyncUploadFromURLOptions)

Parâmetros

Devoluções

upload(RequestBodyType, number, BlockBlobUploadOptions)

Parâmetros

Devoluções

uploadBrowserData(Blob | ArrayBuffer | ArrayBufferView, BlockBlobParallelUploadOptions)

Parâmetros

Devoluções

uploadData(Blob | ArrayBuffer | ArrayBufferView | Buffer, BlockBlobParallelUploadOptions)

Parâmetros

Devoluções

uploadFile(string, BlockBlobParallelUploadOptions)

Parâmetros

Devoluções

uploadStream(Readable, number, number, BlockBlobUploadStreamOptions)

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)