Compartilhar via

PageBlobClient class

  • Referência
Pacote:
@azure/storage-blob

PageBlobClient define um conjunto de operações aplicáveis a blobs de página.

Extends
BlobClient

Construtores

PageBlobClient(string, PipelineLike)

Cria uma instância de PageBlobClient.
PageBlobClient(string, StorageSharedKeyCredential | AnonymousCredential | TokenCredential, StoragePipelineOptions)

Cria uma instância de PageBlobClient. 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, somente 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.
PageBlobClient(string, string, string, StoragePipelineOptions)

Cria uma instância de PageBlobClient.

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

clearPages(number, number, PageBlobClearPagesOptions)

Libera as páginas especificadas do blob de páginas.

Confira https://docs.microsoft.com/rest/api/storageservices/put-page
create(number, PageBlobCreateOptions)

Cria um blob de páginas do comprimento especificado. Chame uploadPages para carregar dados em um blob de páginas.

Confira https://docs.microsoft.com/rest/api/storageservices/put-blob
createIfNotExists(number, PageBlobCreateIfNotExistsOptions)

Cria um blob de páginas do comprimento especificado. Chame uploadPages para carregar dados em um blob de páginas. Se o blob com o mesmo nome já existir, o conteúdo do blob existente permanecerá inalterado.

Confira https://docs.microsoft.com/rest/api/storageservices/put-blob
getPageRanges(number, number, PageBlobGetPageRangesOptions)

Retorna a lista de intervalos de página válidos para um blob de páginas ou instantâneo de um blob de páginas.

Confira https://docs.microsoft.com/rest/api/storageservices/get-page-ranges
getPageRangesDiff(number, number, string, PageBlobGetPageRangesDiffOptions)

Obtém a coleção de intervalos de páginas que diferem entre um instantâneo especificado e este blob de página.

Confira https://docs.microsoft.com/rest/api/storageservices/get-page-ranges
getPageRangesDiffForManagedDisks(number, number, string, PageBlobGetPageRangesDiffOptions)

Obtém a coleção de intervalos de páginas que diferem entre um instantâneo especificado e este blob de página para discos gerenciados.

Confira https://docs.microsoft.com/rest/api/storageservices/get-page-ranges
listPageRanges(number, number, PageBlobListPageRangesOptions)

Retorna um iterador iterável assíncrono para listar intervalos de páginas para um blob de páginas.

Confira https://docs.microsoft.com/rest/api/storageservices/get-page-ranges

.byPage() retorna um iterador iterável assíncrono para listar intervalos de páginas para um blob de páginas.

Exemplo usando for await sintaxe:

// Get the pageBlobClient before you run these snippets,
// Can be obtained from `blobServiceClient.getContainerClient("<your-container-name>").getPageBlobClient("<your-blob-name>");`
let i = 1;
for await (const pageRange of pageBlobClient.listPageRanges()) {
  console.log(`Page range ${i++}: ${pageRange.start} - ${pageRange.end}`);
}

Exemplo usando iter.next():

let i = 1;
let iter = pageBlobClient.listPageRanges();
let pageRangeItem = await iter.next();
while (!pageRangeItem.done) {
  console.log(`Page range ${i++}: ${pageRangeItem.value.start} - ${pageRangeItem.value.end}, IsClear: ${pageRangeItem.value.isClear}`);
  pageRangeItem = await iter.next();
}

Exemplo usando byPage():

// passing optional maxPageSize in the page settings
let i = 1;
for await (const response of pageBlobClient.listPageRanges().byPage({ maxPageSize: 20 })) {
  for (const pageRange of response) {
    console.log(`Page range ${i++}: ${pageRange.start} - ${pageRange.end}`);
  }
}

Exemplo usando a paginação com um marcador:

let i = 1;
let iterator = pageBlobClient.listPageRanges().byPage({ maxPageSize: 2 });
let response = (await iterator.next()).value;

// Prints 2 page ranges
for (const pageRange of response) {
  console.log(`Page range ${i++}: ${pageRange.start} - ${pageRange.end}`);
}

// Gets next marker
let marker = response.continuationToken;

// Passing next marker as continuationToken

iterator = pageBlobClient.listPageRanges().byPage({ continuationToken: marker, maxPageSize: 10 });
response = (await iterator.next()).value;

// Prints 10 page ranges
for (const blob of response) {
  console.log(`Page range ${i++}: ${pageRange.start} - ${pageRange.end}`);
}
listPageRangesDiff(number, number, string, PageBlobListPageRangesDiffOptions)

Retorna um iterador iterável assíncrono para listar intervalos de páginas que diferem entre um instantâneo especificado e esse blob de páginas.

Confira https://docs.microsoft.com/rest/api/storageservices/get-page-ranges

.byPage() retorna um iterador iterável assíncrono para listar intervalos de páginas que diferem entre um instantâneo especificado e este blob de página.

Exemplo usando for await sintaxe:

// Get the pageBlobClient before you run these snippets,
// Can be obtained from `blobServiceClient.getContainerClient("<your-container-name>").getPageBlobClient("<your-blob-name>");`
let i = 1;
for await (const pageRange of pageBlobClient.listPageRangesDiff()) {
  console.log(`Page range ${i++}: ${pageRange.start} - ${pageRange.end}`);
}

Exemplo usando iter.next():

let i = 1;
let iter = pageBlobClient.listPageRangesDiff();
let pageRangeItem = await iter.next();
while (!pageRangeItem.done) {
  console.log(`Page range ${i++}: ${pageRangeItem.value.start} - ${pageRangeItem.value.end}, IsClear: ${pageRangeItem.value.isClear}`);
  pageRangeItem = await iter.next();
}

Exemplo usando byPage():

// passing optional maxPageSize in the page settings
let i = 1;
for await (const response of pageBlobClient.listPageRangesDiff().byPage({ maxPageSize: 20 })) {
  for (const pageRange of response) {
    console.log(`Page range ${i++}: ${pageRange.start} - ${pageRange.end}`);
  }
}

Exemplo usando a paginação com um marcador:

let i = 1;
let iterator = pageBlobClient.listPageRangesDiff().byPage({ maxPageSize: 2 });
let response = (await iterator.next()).value;

// Prints 2 page ranges
for (const pageRange of response) {
  console.log(`Page range ${i++}: ${pageRange.start} - ${pageRange.end}`);
}

// Gets next marker
let marker = response.continuationToken;

// Passing next marker as continuationToken

iterator = pageBlobClient.listPageRangesDiff().byPage({ continuationToken: marker, maxPageSize: 10 });
response = (await iterator.next()).value;

// Prints 10 page ranges
for (const blob of response) {
  console.log(`Page range ${i++}: ${pageRange.start} - ${pageRange.end}`);
}
resize(number, PageBlobResizeOptions)

Redimensiona o blob de páginas para o tamanho especificado (que deve ser um múltiplo de 512).

Confira https://docs.microsoft.com/rest/api/storageservices/set-blob-properties
startCopyIncremental(string, PageBlobStartCopyIncrementalOptions)

Inicia uma operação para iniciar uma cópia incremental do instantâneo de um blob de página para esse blob de páginas. O instantâneo é copiado de modo que apenas as alterações diferenciais entre o instantâneo copiado anteriormente sejam transferidas para o destino. Os instantâneos copiados são cópias completas do instantâneo original e podem ser lidos ou copiados como de costume.

Consulte https://docs.microsoft.com/rest/api/storageservices/incremental-copy-blob Ver https://docs.microsoft.com/en-us/azure/virtual-machines/windows/incremental-snapshots
updateSequenceNumber(SequenceNumberActionType, number, PageBlobUpdateSequenceNumberOptions)

Define o número de sequência de um blob de página.

Confira https://docs.microsoft.com/en-us/rest/api/storageservices/set-blob-properties
uploadPages(RequestBodyType, number, number, PageBlobUploadPagesOptions)

Grava 1 ou mais páginas no blob de páginas. Os deslocamentos de início e término devem ser múltiplos de 512.

Confira https://docs.microsoft.com/rest/api/storageservices/put-page
uploadPagesFromURL(string, number, number, number, PageBlobUploadPagesFromURLOptions)

A operação Carregar Páginas grava um intervalo de páginas em um blob de páginas em que o conteúdo é lido de uma URL.

Confira https://docs.microsoft.com/en-us/rest/api/storageservices/put-page-from-url
withSnapshot(string)

Cria um novo objeto PageBlobClient idêntico à origem, mas com o carimbo de data/hora de instantâneo especificado. Forneça "" removerá o instantâneo e retornará um Cliente 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.

Confira 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 execução longa 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 chamando cancelOperation no poller. 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 gerado.

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.

Confira 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 usando 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 alterado (padrão de 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 o cancelamento de cópia:

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

Cria um instantâneo somente leitura de um blob.

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

Confira https://docs.microsoft.com/en-us/rest/api/storageservices/delete-blob
deleteIfExists(BlobDeleteOptions)

Marca o blob ou instantâneo especificado para exclusão se ele 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.

Confira https://docs.microsoft.com/en-us/rest/api/storageservices/delete-blob
deleteImmutabilityPolicy(BlobDeleteImmutabilityPolicyOptions)

Exclua a política de immutablility no blob.
download(number, number, BlobDownloadOptions)

Lê ou baixa um blob do sistema, incluindo seus metadados e propriedades. Você também pode chamar Get Blob para ler um instantâneo.

  • Em Node.js, os dados retornam em um fluxo legível readableStreamBody
  • Em navegadores, os dados retornam em um blobBody de promessa

Confira https://docs.microsoft.com/en-us/rest/api/storageservices/get-blob
downloadToBuffer(Buffer, number, number, BlobDownloadToBufferOptions)

DISPONÍVEL APENAS EM NODE.JS RUNTIME.

Baixa um Blob do Azure em paralelo a um buffer. Deslocamento e contagem são opcionais, baixa todo o blob se eles não forem fornecidos.

Aviso: os buffers só podem dar suporte a arquivos de até 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 NODE.JS RUNTIME.

Baixa um Blob do Azure em paralelo a um buffer. Deslocamento e contagem são opcionais, baixa todo o blob se eles não forem fornecidos.

Aviso: os buffers só podem dar suporte a arquivos de até 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 NODE.JS RUNTIME.

Baixa um Blob do Azure em um arquivo local. Falhará se o caminho de arquivo fornecido já for encerrado. Deslocamento e contagem são opcionais, passam 0 e indefinidos, respectivamente, para baixar o blob inteiro.
exists(BlobExistsOptions)

Retornará true se o recurso de blob do Azure representado por esse cliente existir; false caso contrário.

OBSERVAÇÃO: use essa função com cuidado, pois um blob existente pode ser excluído por outros clientes ou aplicativos. 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 uma cadeia de caracteres para assinar um URI de SAS (Assinatura de Acesso Compartilhado) do Serviço blob com base nas propriedades e parâmetros do cliente passados. A SAS é assinada pela credencial de chave compartilhada do cliente.

Confira 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 de SAS (Assinatura de Acesso Compartilhado) do Serviço blob com base nas propriedades e parâmetros do cliente passados. A SAS é assinada pela credencial de chave compartilhada do cliente.

Confira 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 uma cadeia de caracteres para assinar um URI de SAS (Assinatura de Acesso Compartilhado) do Serviço blob com base nas propriedades e parâmetros do cliente passados. A SAS é assinada pela chave de delegação do usuário de entrada.

Confira https://docs.microsoft.com/en-us/rest/api/storageservices/constructing-a-service-sas
generateUserDelegationSasUrl(BlobGenerateSasUrlOptions, UserDelegationKey)

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

Confira 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 do sku e o tipo de conta da conta especificada. A operação Obter Informações da Conta está disponível em versões de serviço a partir da versão 2018-03-28.

Confira https://docs.microsoft.com/en-us/rest/api/storageservices/get-account-information
getAppendBlobClient()

Cria um objeto AppendBlobClient.
getBlobLeaseClient(string)

Obtenha um blobLeaseClient que gerencia as 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.

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

AVISO: O objeto metadata retornado na resposta terá suas chaves em letras 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á sua caixa original.
getTags(BlobGetTagsOptions)

Obtém as marcas associadas ao blob subjacente.
setAccessTier(string, BlobSetTierOptions)

Define a camada em um blob. A operação é permitida em um blob de páginas em uma conta de armazenamento premium e em um blob de blocos em uma conta de armazenamento de blobs (somente armazenamento com redundância local). A camada de um blob de página premium determina o tamanho permitido, o IOPS e a largura de banda do blob. A camada de um blob de blocos determina o tipo de armazenamento Hot/Cool/Archive. Essa operação não atualiza a ETag do blob.

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

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

Confira https://docs.microsoft.com/en-us/rest/api/storageservices/set-blob-metadata
setTags(Tags, BlobSetTagsOptions)

Define marcas no blob subjacente. Um blob pode ter até 10 marcas. As teclas de marca devem ter entre 1 e 128 caracteres. Os valores de marca devem ter entre 0 e 256 caracteres. Caracteres válidos de chave de marca e valor incluem letras minúsculas e maiúsculas, dígitos (0-9), espaço (' '), mais ('+'), menos ('-'), ponto ('.'), barra ('/'), dois-pontos (':'), iguais ('=') e sublinhado ('_') .
syncCopyFromURL(string, BlobSyncCopyFromURLOptions)

A operação de CÓPIA Síncrona 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 seja concluída.

Confira https://docs.microsoft.com/en-us/rest/api/storageservices/copy-blob-from-url
undelete(BlobUndeleteOptions)

Restaura o conteúdo e os metadados do blob de exclusão reversível e de todos os instantâneos de exclusão reversível associados. Há suporte para o Undelete Blob somente na versão 2017-07-29 ou posterior.

Confira 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. Forneça "" removerá a versionId e retornará um Cliente para o blob base.

Detalhes do construtor

PageBlobClient(string, PipelineLike)

Cria uma instância de PageBlobClient.

new PageBlobClient(url: string, pipeline: PipelineLike)

Parâmetros

url

string

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

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

Cria uma instância de PageBlobClient. 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, somente 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 PageBlobClient(url: string, credential: StorageSharedKeyCredential | AnonymousCredential | TokenCredential, options?: StoragePipelineOptions)

Parâmetros

url

string

Uma cadeia de caracteres do cliente apontando para o blob de páginas do Armazenamento do Azure, como "https://myaccount.blob.core.windows.net/mycontainer/pageblob". Você pode acrescentar uma SAS se estiver usando AnonymousCredential, como "https://myaccount.blob.core.windows.net/mycontainer/pageblob?sasString".

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.

PageBlobClient(string, string, string, StoragePipelineOptions)

Cria uma instância de PageBlobClient.

new PageBlobClient(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 runtime. ] Exemplo de cadeia de conexão da 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 da propriedade

containerName

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

string containerName

Valor da propriedade

string

name

O nome do blob.

string name

Valor da propriedade

string

Detalhes das propriedades herdadas

accountName 

accountName: string

Valor da propriedade

string

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

credential: StorageSharedKeyCredential | AnonymousCredential | TokenCredential

Valor da propriedade

StorageSharedKeyCredential | AnonymousCredential | TokenCredential

herdado deblobClient.credential

url

Valor da cadeia de caracteres de URL codificada.

url: string

Valor da propriedade

string

herdado deblobClient.url

Detalhes do método

clearPages(number, number, PageBlobClearPagesOptions)

Libera as páginas especificadas do blob de páginas.

Confira https://docs.microsoft.com/rest/api/storageservices/put-page

function clearPages(offset?: number, count?: number, options?: PageBlobClearPagesOptions): Promise<PageBlobClearPagesResponse>

Parâmetros

offset

number

Posição de byte inicial das páginas a serem desmarcadas.

count

number

Número de bytes a serem limpos.

options
PageBlobClearPagesOptions

Opções para a operação Limpar Páginas do Blob de Páginas.

Retornos

Promise<PageBlobClearPagesResponse>

Dados de resposta para a operação Limpar Páginas do Blob de Páginas.

create(number, PageBlobCreateOptions)

Cria um blob de páginas do comprimento especificado. Chame uploadPages para carregar dados em um blob de páginas.

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

function create(size: number, options?: PageBlobCreateOptions): Promise<PageBlobCreateResponse>

Parâmetros

size

number

tamanho do blob de páginas.

options
PageBlobCreateOptions

Opções para a operação Criar Blob de Páginas.

Retornos

Promise<PageBlobCreateResponse>

Dados de resposta para a operação Criar Blob de Páginas.

createIfNotExists(number, PageBlobCreateIfNotExistsOptions)

Cria um blob de páginas do comprimento especificado. Chame uploadPages para carregar dados em um blob de páginas. Se o blob com o mesmo nome já existir, o conteúdo do blob existente permanecerá inalterado.

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

function createIfNotExists(size: number, options?: PageBlobCreateIfNotExistsOptions): Promise<PageBlobCreateIfNotExistsResponse>

Parâmetros

size

number

tamanho do blob de páginas.

options
PageBlobCreateIfNotExistsOptions

Retornos

Promise<PageBlobCreateIfNotExistsResponse>

getPageRanges(number, number, PageBlobGetPageRangesOptions)

Retorna a lista de intervalos de página válidos para um blob de páginas ou instantâneo de um blob de páginas.

Confira https://docs.microsoft.com/rest/api/storageservices/get-page-ranges

function getPageRanges(offset?: number, count?: number, options?: PageBlobGetPageRangesOptions): Promise<PageBlobGetPageRangesResponse>

Parâmetros

offset

number

Posição de byte inicial dos intervalos de páginas.

count

number

Número de bytes a serem obtidos.

options
PageBlobGetPageRangesOptions

Opções para a operação Obter Intervalos do Blob de Páginas.

Retornos

Promise<PageBlobGetPageRangesResponse>

Dados de resposta para a operação Obter Intervalos do Blob de Páginas.

getPageRangesDiff(number, number, string, PageBlobGetPageRangesDiffOptions)

Obtém a coleção de intervalos de páginas que diferem entre um instantâneo especificado e este blob de página.

Confira https://docs.microsoft.com/rest/api/storageservices/get-page-ranges

function getPageRangesDiff(offset: number, count: number, prevSnapshot: string, options?: PageBlobGetPageRangesDiffOptions): Promise<PageBlobGetPageRangesDiffResponse>

Parâmetros

offset

number

Posição de byte inicial do blob de páginas

count

number

Número de bytes para obter a diferença de intervalos.

prevSnapshot

string

Carimbo de data/hora do instantâneo para recuperar a diferença.

options
PageBlobGetPageRangesDiffOptions

Opções para a operação Diff Obter Intervalos de Páginas do Blob de Páginas.

Retornos

Promise<PageBlobGetPageRangesDiffResponse>

Dados de resposta para a operação Deiff do Intervalo de Páginas de Obtenção de Blob de Páginas.

getPageRangesDiffForManagedDisks(number, number, string, PageBlobGetPageRangesDiffOptions)

Obtém a coleção de intervalos de páginas que diferem entre um instantâneo especificado e este blob de página para discos gerenciados.

Confira https://docs.microsoft.com/rest/api/storageservices/get-page-ranges

function getPageRangesDiffForManagedDisks(offset: number, count: number, prevSnapshotUrl: string, options?: PageBlobGetPageRangesDiffOptions): Promise<PageBlobGetPageRangesDiffResponse>

Parâmetros

offset

number

Posição de byte inicial do blob de páginas

count

number

Número de bytes para obter a diferença de intervalos.

prevSnapshotUrl

string

URL do instantâneo para recuperar a diferença.

options
PageBlobGetPageRangesDiffOptions

Opções para a operação Diff Obter Intervalos de Páginas do Blob de Páginas.

Retornos

Promise<PageBlobGetPageRangesDiffResponse>

Dados de resposta para a operação Deiff do Intervalo de Páginas de Obtenção de Blob de Páginas.

listPageRanges(number, number, PageBlobListPageRangesOptions)

Retorna um iterador iterável assíncrono para listar intervalos de páginas para um blob de páginas.

Confira https://docs.microsoft.com/rest/api/storageservices/get-page-ranges

.byPage() retorna um iterador iterável assíncrono para listar intervalos de páginas para um blob de páginas.

Exemplo usando for await sintaxe:

// Get the pageBlobClient before you run these snippets,
// Can be obtained from `blobServiceClient.getContainerClient("<your-container-name>").getPageBlobClient("<your-blob-name>");`
let i = 1;
for await (const pageRange of pageBlobClient.listPageRanges()) {
  console.log(`Page range ${i++}: ${pageRange.start} - ${pageRange.end}`);
}

Exemplo usando iter.next():

let i = 1;
let iter = pageBlobClient.listPageRanges();
let pageRangeItem = await iter.next();
while (!pageRangeItem.done) {
  console.log(`Page range ${i++}: ${pageRangeItem.value.start} - ${pageRangeItem.value.end}, IsClear: ${pageRangeItem.value.isClear}`);
  pageRangeItem = await iter.next();
}

Exemplo usando byPage():

// passing optional maxPageSize in the page settings
let i = 1;
for await (const response of pageBlobClient.listPageRanges().byPage({ maxPageSize: 20 })) {
  for (const pageRange of response) {
    console.log(`Page range ${i++}: ${pageRange.start} - ${pageRange.end}`);
  }
}

Exemplo usando a paginação com um marcador:

let i = 1;
let iterator = pageBlobClient.listPageRanges().byPage({ maxPageSize: 2 });
let response = (await iterator.next()).value;

// Prints 2 page ranges
for (const pageRange of response) {
  console.log(`Page range ${i++}: ${pageRange.start} - ${pageRange.end}`);
}

// Gets next marker
let marker = response.continuationToken;

// Passing next marker as continuationToken

iterator = pageBlobClient.listPageRanges().byPage({ continuationToken: marker, maxPageSize: 10 });
response = (await iterator.next()).value;

// Prints 10 page ranges
for (const blob of response) {
  console.log(`Page range ${i++}: ${pageRange.start} - ${pageRange.end}`);
}

function listPageRanges(offset?: number, count?: number, options?: PageBlobListPageRangesOptions): PagedAsyncIterableIterator<PageRangeInfo, PageBlobGetPageRangesResponseModel, PageSettings>

Parâmetros

offset

number

Posição de byte inicial dos intervalos de páginas.

count

number

Número de bytes a serem obtidos.

options
PageBlobListPageRangesOptions

Opções para a operação Obter Intervalos do Blob de Páginas.

Retornos

PagedAsyncIterableIterator<PageRangeInfo, PageBlobGetPageRangesResponseModel, PageSettings>

Um asyncIterableIterator que dá suporte à paginação.

listPageRangesDiff(number, number, string, PageBlobListPageRangesDiffOptions)

Retorna um iterador iterável assíncrono para listar intervalos de páginas que diferem entre um instantâneo especificado e esse blob de páginas.

Confira https://docs.microsoft.com/rest/api/storageservices/get-page-ranges

.byPage() retorna um iterador iterável assíncrono para listar intervalos de páginas que diferem entre um instantâneo especificado e este blob de página.

Exemplo usando for await sintaxe:

// Get the pageBlobClient before you run these snippets,
// Can be obtained from `blobServiceClient.getContainerClient("<your-container-name>").getPageBlobClient("<your-blob-name>");`
let i = 1;
for await (const pageRange of pageBlobClient.listPageRangesDiff()) {
  console.log(`Page range ${i++}: ${pageRange.start} - ${pageRange.end}`);
}

Exemplo usando iter.next():

let i = 1;
let iter = pageBlobClient.listPageRangesDiff();
let pageRangeItem = await iter.next();
while (!pageRangeItem.done) {
  console.log(`Page range ${i++}: ${pageRangeItem.value.start} - ${pageRangeItem.value.end}, IsClear: ${pageRangeItem.value.isClear}`);
  pageRangeItem = await iter.next();
}

Exemplo usando byPage():

// passing optional maxPageSize in the page settings
let i = 1;
for await (const response of pageBlobClient.listPageRangesDiff().byPage({ maxPageSize: 20 })) {
  for (const pageRange of response) {
    console.log(`Page range ${i++}: ${pageRange.start} - ${pageRange.end}`);
  }
}

Exemplo usando a paginação com um marcador:

let i = 1;
let iterator = pageBlobClient.listPageRangesDiff().byPage({ maxPageSize: 2 });
let response = (await iterator.next()).value;

// Prints 2 page ranges
for (const pageRange of response) {
  console.log(`Page range ${i++}: ${pageRange.start} - ${pageRange.end}`);
}

// Gets next marker
let marker = response.continuationToken;

// Passing next marker as continuationToken

iterator = pageBlobClient.listPageRangesDiff().byPage({ continuationToken: marker, maxPageSize: 10 });
response = (await iterator.next()).value;

// Prints 10 page ranges
for (const blob of response) {
  console.log(`Page range ${i++}: ${pageRange.start} - ${pageRange.end}`);
}

function listPageRangesDiff(offset: number, count: number, prevSnapshot: string, options?: PageBlobListPageRangesDiffOptions): PagedAsyncIterableIterator<PageRangeInfo, PageBlobGetPageRangesDiffResponseModel, PageSettings>

Parâmetros

offset

number

Posição de byte inicial dos intervalos de páginas.

count

number

Número de bytes a serem obtidos.

prevSnapshot

string

Carimbo de data/hora do instantâneo para recuperar a diferença.

options
PageBlobListPageRangesDiffOptions

Opções para a operação Obter Intervalos do Blob de Páginas.

Retornos

PagedAsyncIterableIterator<PageRangeInfo, PageBlobGetPageRangesDiffResponseModel, PageSettings>

Um asyncIterableIterator que dá suporte à paginação.

resize(number, PageBlobResizeOptions)

Redimensiona o blob de páginas para o tamanho especificado (que deve ser um múltiplo de 512).

Confira https://docs.microsoft.com/rest/api/storageservices/set-blob-properties

function resize(size: number, options?: PageBlobResizeOptions): Promise<PageBlobResizeResponse>

Parâmetros

size

number

Tamanho do destino

options
PageBlobResizeOptions

Opções para a operação de Redimensionamento do Blob de Páginas.

Retornos

Promise<PageBlobResizeResponse>

Dados de resposta para a operação de Redimensionamento do Blob de Páginas.

startCopyIncremental(string, PageBlobStartCopyIncrementalOptions)

Inicia uma operação para iniciar uma cópia incremental do instantâneo de um blob de página para esse blob de páginas. O instantâneo é copiado de modo que apenas as alterações diferenciais entre o instantâneo copiado anteriormente sejam transferidas para o destino. Os instantâneos copiados são cópias completas do instantâneo original e podem ser lidos ou copiados como de costume.

Consulte https://docs.microsoft.com/rest/api/storageservices/incremental-copy-blob Ver https://docs.microsoft.com/en-us/azure/virtual-machines/windows/incremental-snapshots

function startCopyIncremental(copySource: string, options?: PageBlobStartCopyIncrementalOptions): Promise<PageBlobCopyIncrementalResponse>

Parâmetros

copySource

string

Especifica o nome do instantâneo de blob da página de origem. Por exemplo, https://myaccount.blob.core.windows.net/mycontainer/myblob?snapshot=

options
PageBlobStartCopyIncrementalOptions

Opções para a operação Incremental de Cópia de Blob de Páginas.

Retornos

Promise<PageBlobCopyIncrementalResponse>

Dados de resposta para a operação Incremental de Cópia de Blob de Páginas.

updateSequenceNumber(SequenceNumberActionType, number, PageBlobUpdateSequenceNumberOptions)

Define o número de sequência de um blob de página.

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

function updateSequenceNumber(sequenceNumberAction: SequenceNumberActionType, sequenceNumber?: number, options?: PageBlobUpdateSequenceNumberOptions): Promise<PageBlobUpdateSequenceNumberResponse>

Parâmetros

sequenceNumberAction
SequenceNumberActionType

Indica como o serviço deve modificar o número de sequência do blob.

sequenceNumber

number

Obrigatório se sequenceNumberAction for max ou update

options
PageBlobUpdateSequenceNumberOptions

Opções para a operação Número da Sequência de Atualizações do Blob de Páginas.

Retornos

Promise<PageBlobUpdateSequenceNumberResponse>

Dados de resposta para a operação Número da Sequência de Atualizações do Blob de Páginas.

uploadPages(RequestBodyType, number, number, PageBlobUploadPagesOptions)

Grava 1 ou mais páginas no blob de páginas. Os deslocamentos de início e término devem ser múltiplos de 512.

Confira https://docs.microsoft.com/rest/api/storageservices/put-page

function uploadPages(body: RequestBodyType, offset: number, count: number, options?: PageBlobUploadPagesOptions): Promise<PageBlobUploadPagesResponse>

Parâmetros

body
HttpRequestBody

Dados a serem carregados

offset

number

Deslocamento do blob de página de destino

count

number

Comprimento do conteúdo do corpo, também número de bytes a serem carregados

options
PageBlobUploadPagesOptions

Opções para a operação Páginas de Upload do Blob de Páginas.

Retornos

Promise<PageBlobUploadPagesResponse>

Dados de resposta para a operação Páginas de Upload do Blob de Páginas.

uploadPagesFromURL(string, number, number, number, PageBlobUploadPagesFromURLOptions)

A operação Carregar Páginas grava um intervalo de páginas em um blob de páginas em que o conteúdo é lido de uma URL.

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

function uploadPagesFromURL(sourceURL: string, sourceOffset: number, destOffset: number, count: number, options?: PageBlobUploadPagesFromURLOptions): Promise<PageBlobUploadPagesFromURLResponse>

Parâmetros

sourceURL

string

Especifique uma URL para a origem da cópia, SAS (Assinatura de Acesso Compartilhado) talvez seja necessária para autenticação

sourceOffset

number

O deslocamento de origem do qual copiar. Passar 0 para copiar do início do blob de página de origem

destOffset

number

Deslocamento do blob de página de destino

count

number

Número de bytes a serem carregados do blob da página de origem

options
PageBlobUploadPagesFromURLOptions

Retornos

Promise<PageBlobUploadPagesFromURLResponse>

withSnapshot(string)

Cria um novo objeto PageBlobClient idêntico à origem, mas com o carimbo de data/hora de instantâneo especificado. Forneça "" removerá o instantâneo e retornará um Cliente para o blob base.

function withSnapshot(snapshot: string): PageBlobClient

Parâmetros

snapshot

string

O carimbo de data/hora do instantâneo.

Retornos

PageBlobClient

Um novo objeto PageBlobClient idêntico à origem, mas com o carimbo de data/hora de 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.

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

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

Parâmetros

copyId

string

ID da operação copiar da URL.

options
BlobAbortCopyFromURLOptions

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

Retornos

Promise<BlobAbortCopyFromURLResponse>

herdado de blobClient.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 execução longa 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 chamando cancelOperation no poller. 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 gerado.

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.

Confira 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 usando 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 alterado (padrão de 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 o cancelamento de cópia:

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

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

Parâmetros

copySource

string

url para o Blob/Arquivo do Azure de origem.

options
BlobBeginCopyFromURLOptions

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

Retornos

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

Herdado deBlobClient.beginCopyFromURL

createSnapshot(BlobCreateSnapshotOptions)

Cria um instantâneo somente leitura de um blob.

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

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

Parâmetros

options
BlobCreateSnapshotOptions

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

Retornos

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.

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

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

Parâmetros

options
BlobDeleteOptions

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

Retornos

Promise<BlobDeleteResponse>

herdado do blobClient.delete

deleteIfExists(BlobDeleteOptions)

Marca o blob ou instantâneo especificado para exclusão se ele 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.

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

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

Parâmetros

options
BlobDeleteOptions

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

Retornos

Promise<BlobDeleteIfExistsResponse>

herdado deBlobClient.deleteIfExists

deleteImmutabilityPolicy(BlobDeleteImmutabilityPolicyOptions)

Exclua a política de immutablility no blob.

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

Parâmetros

options
BlobDeleteImmutabilityPolicyOptions

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

Retornos

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 Get Blob para ler um instantâneo.

  • Em Node.js, os dados retornam em um fluxo legível readableStreamBody
  • Em navegadores, os dados retornam em um blobBody de promessa

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

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

Parâmetros

offset

number

A partir da qual a posição do blob será baixada, 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 Blobs.

Uso de exemplo (Node.js):

// Download and convert a blob to a string
const downloadBlockBlobResponse = await blobClient.download();
const downloaded = await streamToBuffer(downloadBlockBlobResponse.readableStreamBody);
console.log("Downloaded blob content:", downloaded.toString());

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

Uso de exemplo (navegador):

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

Retornos

Promise<BlobDownloadResponseParsed>

Herdado deBlobClient.download

downloadToBuffer(Buffer, number, number, BlobDownloadToBufferOptions)

DISPONÍVEL APENAS EM NODE.JS RUNTIME.

Baixa um Blob do Azure em paralelo a um buffer. Deslocamento e contagem são opcionais, baixa todo o blob se eles não forem fornecidos.

Aviso: os buffers só podem dar suporte a arquivos de até 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

O buffer a ser preenchido deve ter um comprimento maior que a contagem

offset

number

De qual posição do blob de blocos será baixado(em bytes)

count

number

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

options
BlobDownloadToBufferOptions

BlobDownloadToBufferOptions

Retornos

Promise<Buffer>

Herdado deBlobClient.downloadToBuffer

downloadToBuffer(number, number, BlobDownloadToBufferOptions)

DISPONÍVEL APENAS EM NODE.JS RUNTIME.

Baixa um Blob do Azure em paralelo a um buffer. Deslocamento e contagem são opcionais, baixa todo o blob se eles não forem fornecidos.

Aviso: os buffers só podem dar suporte a arquivos de até um gigabyte em sistemas de 32 bits ou cerca de dois gigabytes em sistemas de 64 bits devido a limitações de Node.js/V8. Para blobs maiores que esse tamanho, considere downloadToFile.

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

Parâmetros

offset

number

De qual posição do blob de blocos será baixado(em bytes)

count

number

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

options
BlobDownloadToBufferOptions

BlobDownloadToBufferOptions

Retornos

Promise<Buffer>

Herdado deBlobClient.downloadToBuffer

downloadToFile(string, number, number, BlobDownloadOptions)

DISPONÍVEL APENAS EM NODE.JS RUNTIME.

Baixa um Blob do Azure em um arquivo local. Falhará se o caminho de arquivo fornecido já for encerrado. Deslocamento e contagem são opcionais, passam 0 e indefinidos, respectivamente, para baixar o blob inteiro.

function downloadToFile(filePath: string, offset?: number, count?: number, options?: BlobDownloadOptions): Promise<BlobDownloadResponseParsed>

Parâmetros

filePath

string

offset

number

De qual posição do blob de blocos será baixado.

count

number

Quantos dados serão baixados. Será baixado até o final ao passar indefinido.

options
BlobDownloadOptions

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

Retornos

Promise<BlobDownloadResponseParsed>

Os dados de resposta para a operação de download de blob, mas com readableStreamBody definido como indefinido, pois seu conteúdo já é lido e gravado em um arquivo local no caminho especificado.

Herdado deBlobClient.downloadToFile

exists(BlobExistsOptions)

Retornará true se o recurso de blob do Azure representado por esse cliente existir; false caso contrário.

OBSERVAÇÃO: use essa função com cuidado, pois um blob existente pode ser excluído por outros clientes ou aplicativos. 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 Exists.

Retornos

Promise<boolean>

Herdado deBlobClient.exists

generateSasStringToSign(BlobGenerateSasUrlOptions)

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

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

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

Retornos

string

O URI de SAS que consiste no URI para o recurso representado por esse 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 de SAS (Assinatura de Acesso Compartilhado) do Serviço blob com base nas propriedades e parâmetros do cliente passados. A SAS é assinada pela credencial de chave compartilhada do cliente.

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

Retornos

Promise<string>

O URI de SAS que consiste no URI para o recurso representado por esse 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 uma cadeia de caracteres para assinar um URI de SAS (Assinatura de Acesso Compartilhado) do Serviço blob com base nas propriedades e parâmetros do cliente passados. A SAS é assinada pela chave de delegação do usuário de entrada.

Confira 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 retornado de blobServiceClient.getUserDelegationKey()

Retornos

string

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

herdado deBlobClient.generateUserDelegationSasStringToSign

generateUserDelegationSasUrl(BlobGenerateSasUrlOptions, UserDelegationKey)

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

Confira 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 retornado de blobServiceClient.getUserDelegationKey()

Retornos

Promise<string>

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

Herdado deBlobClient.generateUserDelegationSasUrl

getAccountInfo(BlobGetAccountInfoOptions)

A operação Obter Informações da Conta retorna o nome do sku e o tipo de conta da conta especificada. A operação Obter Informações da Conta está disponível em versões de serviço a partir da versão 2018-03-28.

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

Retornos

Promise<BlobGetAccountInfoResponse>

Dados de resposta para a operação Informações da Conta de Obtenção de Serviço.

herdado deblobClient.getAccountInfo

getAppendBlobClient()

Cria um objeto AppendBlobClient.

function getAppendBlobClient(): AppendBlobClient

Retornos

AppendBlobClient

herdado deBlobClient.getAppendBlobClient

getBlobLeaseClient(string)

Obtenha um blobLeaseClient que gerencia as concessões no blob.

function getBlobLeaseClient(proposeLeaseId?: string): BlobLeaseClient

Parâmetros

proposeLeaseId

string

ID de concessão proposta inicial.

Retornos

BlobLeaseClient

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

Herdado deBlobClient.getBlobLeaseClient

getBlockBlobClient()

Cria um objeto BlockBlobClient.

function getBlockBlobClient(): BlockBlobClient

Retornos

BlockBlobClient

Herdado deBlobClient.getBlockBlobClient

getPageBlobClient()

Cria um objeto PageBlobClient.

function getPageBlobClient(): PageBlobClient

Retornos

PageBlobClient

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

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

AVISO: O objeto metadata retornado na resposta terá suas chaves em letras 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á sua caixa original.

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

Parâmetros

options
BlobGetPropertiesOptions

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

Retornos

Promise<BlobGetPropertiesResponse>

herdado deblobClient.getProperties

getTags(BlobGetTagsOptions)

Obtém as marcas associadas ao blob subjacente.

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

Parâmetros

options
BlobGetTagsOptions

Retornos

Promise<BlobGetTagsResponse>

herdado deblobClient.getTags

setAccessTier(string, BlobSetTierOptions)

Define a camada em um blob. A operação é permitida em um blob de páginas em uma conta de armazenamento premium e em um blob de blocos em uma conta de armazenamento de blobs (somente armazenamento com redundância local). A camada de um blob de página premium determina o tamanho permitido, o IOPS e a largura de banda do blob. A camada de um blob de blocos determina o tipo de armazenamento Hot/Cool/Archive. Essa operação não atualiza a ETag do blob.

Confira 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 de Camada de Conjunto de Blobs.

Retornos

Promise<BlobSetTierResponse>

Herdado deBlobClient.setAccessTier

setHTTPHeaders(BlobHTTPHeaders, BlobSetHTTPHeadersOptions)

Define as propriedades do sistema no blob.

Se nenhum valor for 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.

Confira 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 for 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 habilitando o navegador para fornecer funcionalidade com base no tipo de arquivo.

options
BlobSetHTTPHeadersOptions

Opções opcionais para a operação Defina Cabeçalhos HTTP do Blob.

Retornos

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.

Retornos

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.

Retornos

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.

Confira 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 fornecido, os metadados existentes serão removidos.

options
BlobSetMetadataOptions

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

Retornos

Promise<BlobSetMetadataResponse>

herdado deblobClient.setMetadata

setTags(Tags, BlobSetTagsOptions)

Define marcas no blob subjacente. Um blob pode ter até 10 marcas. As teclas de marca devem ter entre 1 e 128 caracteres. Os valores de marca devem ter entre 0 e 256 caracteres. Caracteres válidos de chave de marca e valor incluem letras minúsculas e maiúsculas, dígitos (0-9), espaço (' '), mais ('+'), menos ('-'), ponto ('.'), barra ('/'), dois-pontos (':'), iguais ('=') e sublinhado ('_') .

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

Parâmetros

tags
Tags
options
BlobSetTagsOptions

Retornos

Promise<BlobSetTagsResponse>

Herdado deBlobClient.setTags

syncCopyFromURL(string, BlobSyncCopyFromURLOptions)

A operação de CÓPIA Síncrona 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 seja concluída.

Confira 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

A URL de origem da qual copiar, SAS (Assinatura de Acesso Compartilhado) talvez seja necessária para autenticação

options
BlobSyncCopyFromURLOptions

Retornos

Promise<BlobCopyFromURLResponse>

Herdado deBlobClient.syncCopyFromURL

undelete(BlobUndeleteOptions)

Restaura o conteúdo e os metadados do blob de exclusão reversível e de todos os instantâneos de exclusão reversível associados. Há suporte para o Undelete Blob somente na versão 2017-07-29 ou posterior.

Confira 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 Desdelete de Blob.

Retornos

Promise<BlobUndeleteResponse>

herdado deblobClient.undelete

withVersion(string)

Cria um novo objeto BlobClient apontando para uma versão desse blob. Forneça "" removerá a versionId e retornará um Cliente para o blob base.

function withVersion(versionId: string): BlobClient

Parâmetros

versionId

string

A versionId.

Retornos

BlobClient

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

Herdado deBlobClient.withVersion