Partilhar 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, 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.
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ágina.

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

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

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

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

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

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

Visualizar 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 esse blob de página.

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

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

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

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

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

Exemplo usando sintaxe for await:

// 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 de utilização da 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 a lista de intervalos de páginas que diferem entre um instantâneo especificado e esse blob de página.

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

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

Exemplo usando sintaxe for await:

// 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 de utilização da 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ágina para o tamanho especificado (que deve ser um múltiplo de 512).

Visualizar 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ágina. O snapshot é copiado de forma que apenas as alterações diferenciais entre o snapshot 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.

Visualizar https://docs.microsoft.com/rest/api/storageservices/incremental-copy-blob Visualizar 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.

Visualizar 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ágina. Os deslocamentos de início e fim devem ser um múltiplo de 512.

Visualizar 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ágina onde o conteúdo é lido de uma URL.

Visualizar 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 do instantâneo especificado. Fornecer "" removerá o instantâneo e retornará um Cliente ao blob de 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.
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
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

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 da página de 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, 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.

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, 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 PageBlobClient(url: string, credential: StorageSharedKeyCredential | AnonymousCredential | TokenCredential, options?: StoragePipelineOptions)

Parâmetros

url

string

Uma cadeia de caracteres de Cliente apontando para o blob da página de 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 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

Como AnonymousCredential, StorageSharedKeyCredential ou qualquer credencial do pacote @azure/identity para autenticar solicitações para o serviço. Você também pode fornecer um objeto que implementa a interface TokenCredential. Se não for especificado, AnonymousCredential será usado.

credential: StorageSharedKeyCredential | AnonymousCredential | TokenCredential

Valor de Propriedade

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

clearPages(number, number, PageBlobClearPagesOptions)

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

Visualizar 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 inicial do byte das páginas a serem limpas.

count

number

Número de bytes a limpar.

options
PageBlobClearPagesOptions

Opções para a operação Page Blob Clear Pages.

Devoluções

Promise<PageBlobClearPagesResponse>

Dados de resposta para a operação Page Blob Clear Pages.

create(number, PageBlobCreateOptions)

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

Visualizar 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ágina.

options
PageBlobCreateOptions

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

Devoluções

Promise<PageBlobCreateResponse>

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

createIfNotExists(number, PageBlobCreateIfNotExistsOptions)

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

Visualizar 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ágina.

options
PageBlobCreateIfNotExistsOptions

Devoluções

Promise<PageBlobCreateIfNotExistsResponse>

getPageRanges(number, number, PageBlobGetPageRangesOptions)

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

Visualizar 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 inicial de bytes dos intervalos de páginas.

count

number

Número de bytes a obter.

options
PageBlobGetPageRangesOptions

Opções para a operação Page Blob Get Ranges.

Devoluções

Promise<PageBlobGetPageRangesResponse>

Dados de resposta para a operação Intervalos de obtenção de blob de página.

getPageRangesDiff(number, number, string, PageBlobGetPageRangesDiffOptions)

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

Visualizar 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 inicial do byte do blob de página

count

number

Número de bytes para obter intervalos diff.

prevSnapshot

string

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

options
PageBlobGetPageRangesDiffOptions

Opções para a operação Page Blob Get Page Ranges Diff.

Devoluções

Promise<PageBlobGetPageRangesDiffResponse>

Dados de resposta para a operação Page Blob Get Page Range Diff.

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.

Visualizar 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 inicial do byte do blob de página

count

number

Número de bytes para obter intervalos diff.

prevSnapshotUrl

string

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

options
PageBlobGetPageRangesDiffOptions

Opções para a operação Page Blob Get Page Ranges Diff.

Devoluções

Promise<PageBlobGetPageRangesDiffResponse>

Dados de resposta para a operação Page Blob Get Page Range Diff.

listPageRanges(number, number, PageBlobListPageRangesOptions)

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

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

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

Exemplo usando sintaxe for await:

// 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 de utilização da 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 inicial de bytes dos intervalos de páginas.

count

number

Número de bytes a obter.

options
PageBlobListPageRangesOptions

Opções para a operação Page Blob Get Ranges.

Devoluções

PagedAsyncIterableIterator<PageRangeInfo, PageBlobGetPageRangesResponseModel, PageSettings>

Um asyncIterableIterator que suporta paginação.

listPageRangesDiff(number, number, string, PageBlobListPageRangesDiffOptions)

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

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

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

Exemplo usando sintaxe for await:

// 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 de utilização da 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 inicial de bytes dos intervalos de páginas.

count

number

Número de bytes a obter.

prevSnapshot

string

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

options
PageBlobListPageRangesDiffOptions

Opções para a operação Page Blob Get Ranges.

Devoluções

PagedAsyncIterableIterator<PageRangeInfo, PageBlobGetPageRangesDiffResponseModel, PageSettings>

Um asyncIterableIterator que suporta paginação.

resize(number, PageBlobResizeOptions)

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

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

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

Parâmetros

size

number

Tamanho do alvo

options
PageBlobResizeOptions

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

Devoluções

Promise<PageBlobResizeResponse>

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

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ágina. O snapshot é copiado de forma que apenas as alterações diferenciais entre o snapshot 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.

Visualizar https://docs.microsoft.com/rest/api/storageservices/incremental-copy-blob Visualizar 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ágina.

Devoluções

Promise<PageBlobCopyIncrementalResponse>

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

updateSequenceNumber(SequenceNumberActionType, number, PageBlobUpdateSequenceNumberOptions)

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

Visualizar 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

Necessário se sequenceNumberAction for max ou update

options
PageBlobUpdateSequenceNumberOptions

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

Devoluções

Promise<PageBlobUpdateSequenceNumberResponse>

Dados de resposta para a operação Número de Sequência de Atualização de Blob de Página.

uploadPages(RequestBodyType, number, number, PageBlobUploadPagesOptions)

Grava 1 ou mais páginas no blob de página. Os deslocamentos de início e fim devem ser um múltiplo de 512.

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

offset

number

Deslocamento do blob da 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 Page Blob Upload Pages.

Devoluções

Promise<PageBlobUploadPagesResponse>

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

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

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

Visualizar 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 fonte de cópia, Assinatura de Acesso Compartilhado (SAS) talvez necessária para autenticação

sourceOffset

number

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

destOffset

number

Deslocamento do blob da página de destino

count

number

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

options
PageBlobUploadPagesFromURLOptions

Devoluções

Promise<PageBlobUploadPagesFromURLResponse>

withSnapshot(string)

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

function withSnapshot(snapshot: string): PageBlobClient

Parâmetros

snapshot

string

O carimbo de data/hora do instantâneo.

Devoluções

PageBlobClient

Um novo objeto PageBlobClient 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.

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

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

Parâmetros

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

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

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