PageBlobClient class

Referência

Pacote:: @azure/storage-blob

PageBlobClient define um conjunto de operações aplicáveis aos blobs de páginas.

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 terá escape 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

accountName
containerName	O nome do contêiner de armazenamento ao qual o blob está associado.
credential	Como AnonymousCredential, StorageSharedKeyCredential ou qualquer credencial do `@azure/identity` pacote para autenticar solicitações para o serviço. Você também pode fornecer um objeto que implementa a interface TokenCredential. Se não for especificado, AnonymousCredential será usado.
name	O nome do blob.
url	Valor da cadeia de caracteres de URL codificada.

Métodos

abortCopyFromURL(string, BlobAbortCopyFromURLOptions)	Anula uma operação de Copiar Blob assíncrona pendente e deixa um blob de destino com comprimento zero e metadados completos. Versão 2012-02-12 e mais recente.
beginCopyFromURL(string, BlobBeginCopyFromURLOptions)	Copia de forma assíncrona um blob para um destino dentro da conta de armazenamento. Esse método retorna um sondador de operação de execução prolongada 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 tentar 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 copiar blob 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 Copiar Blob pode ser um arquivo do Azure em qualquer conta de armazenamento do Azure. Apenas as contas de armazenamento criadas a partir de 7 de junho de 2012 permitem que a operação Copy Blob faça cópias de outra conta de armazenamento.
clearPages(number, number, PageBlobClearPagesOptions)	Libera as páginas especificadas 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.
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.
createSnapshot(BlobCreateSnapshotOptions)	Cria um instantâneo somente leitura de um blob.
delete(BlobDeleteOptions)	Marca o blob ou instantâneo especificado para exclusão. O blob é excluído posteriormente, durante a coleta de lixo. Observe que para excluir um blob, você deve excluir todos os seus instantâneos. Você pode excluir ambos ao mesmo tempo com a operação Excluir Blob.
deleteIfExists(BlobDeleteOptions)	Marca o blob ou instantâneo especificado para exclusão, se existir. O blob é excluído posteriormente, durante a coleta de lixo. Observe que para excluir um blob, você deve excluir todos os seus instantâneos. Você pode excluir ambos ao mesmo tempo com a operação Excluir Blob.
deleteImmutabilityPolicy(BlobDeleteImmutabilityPolicyOptions)	Exclua a política immutablility 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. Em Node.js, os dados retornam em um fluxo legível ReadableStreamBody Em navegadores, os dados retornam em um blobBody de promessa
downloadToBuffer(Buffer, number, number, BlobDownloadToBufferOptions)	DISPONÍVEL SOMENTE EM NODE.JS RUNTIME. Baixa um Blob do Azure em paralelo a um buffer. Deslocamento e contagem são opcionais, baixando todo o blob se eles não forem fornecidos. Aviso: os buffers só podem dar suporte a 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 <xref:downloadToFile>.
downloadToBuffer(number, number, BlobDownloadToBufferOptions)	DISPONÍVEL SOMENTE EM NODE.JS RUNTIME. Baixa um Blob do Azure em paralelo a um buffer. Deslocamento e contagem são opcionais, baixando todo o blob se eles não forem fornecidos. Aviso: os buffers só podem dar suporte a 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 <xref:downloadToFile>.
downloadToFile(string, number, number, BlobDownloadOptions)	DISPONÍVEL APENAS NO RUNTIME NODE.JS. 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, passe 0 e indefinidos, respectivamente, para baixar todo o blob.
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.
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.
getAppendBlobClient()	Cria um objeto AppendBlobClient.
getBlobLeaseClient(string)	Obtenha um <xref:BlobLeaseClient> que gerencia as concessões no blob.
getBlockBlobClient()	Cria um objeto BlockBlobClient.
getPageBlobClient()	Cria um objeto PageBlobClient.
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.
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áginas.
getPageRangesDiffForManagedDisks(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 para discos gerenciados.
getProperties(BlobGetPropertiesOptions)	Retorna todos os metadados definidos pelo usuário, propriedades HTTP padrão e propriedades do sistema para o blob. Ela não retorna o conteúdo do blob.
getTags(BlobGetTagsOptions)	Obtém as marcas associadas ao blob subjacente.
resize(number, PageBlobResizeOptions)	Redimensiona o blob de páginas para o tamanho especificado (que deve ser um múltiplo de 512).
setAccessTier(BlockBlobTier \| PremiumPageBlobTier \| 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, o IOPS e a largura de banda permitidos 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.
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.
setImmutabilityPolicy(BlobImmutabilityPolicy, BlobSetImmutabilityPolicyOptions)	Defina a política immutablility 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 de nome-valor. Se nenhuma opção for fornecida ou nenhum metadado definido no parâmetro , os metadados do blob serão removidos.
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 estar entre 0 e 256 caracteres. Os caracteres válidos de chave de marca e valor incluem letras maiúsculas e minúsculas, dígitos (0-9), espaço (' '), mais ('+'), menos ('-'), ponto ('.'), barra ('/'), dois-pontos (':'), igual a ('=') e sublinhado ('_') .
startCopyIncremental(string, PageBlobStartCopyIncrementalOptions)	Inicia uma operação para iniciar uma cópia incremental do instantâneo de um blob de página para este 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.
syncCopyFromURL(string, BlobSyncCopyFromURLOptions)	A operação de URL de Cópia Síncrona 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.
undelete(BlobUndeleteOptions)	Restaura o conteúdo e os metadados do blob de exclusão reversível e de todos os instantâneos excluídos reversível associados. O Undelete Blob tem suporte apenas na versão 2017-07-29 ou posterior.
updateSequenceNumber(SequenceNumberActionType, number, PageBlobUpdateSequenceNumberOptions)	Define o número de sequência de um blob de páginas.
uploadPages(HttpRequestBody, number, number, PageBlobUploadPagesOptions)	Grava 1 ou mais páginas no blob de páginas. Os deslocamentos inicial e final devem ser múltiplos de 512.
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.
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 para o blob base.
withVersion(string)	Cria um novo objeto BlobClient apontando para uma versão desse blob. Fornecer "" 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 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".

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 terá escape 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

credential: StorageSharedKeyCredential | AnonymousCredential | TokenCredential

Como AnonymousCredential, StorageSharedKeyCredential ou qualquer credencial do @azure/identity pacote 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 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 da propriedade

accountName

accountName: string

Valor da propriedade

string

containerName

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

string containerName

Valor da propriedade

string

credential

credential: StorageSharedKeyCredential | AnonymousCredential | TokenCredential

Valor da propriedade

StorageSharedKeyCredential | AnonymousCredential | TokenCredential

name

O nome do blob.

string name

Valor da propriedade

string

url

Valor da cadeia de caracteres de URL codificada.

url: string

Valor da propriedade

string

Detalhes do método

abortCopyFromURL(string, BlobAbortCopyFromURLOptions)

Anula uma operação de Copiar Blob assíncrona pendente e deixa um blob de destino com comprimento zero e metadados completos. Versão 2012-02-12 e mais recente.

function abortCopyFromURL(copyId: string, options?: BlobAbortCopyFromURLOptions)

Parâmetros

copyId: string

ID da operação Copiar da URL.

options: BlobAbortCopyFromURLOptions

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

Retornos

Promise<BlobAbortCopyFromURLResponse>

beginCopyFromURL(string, BlobBeginCopyFromURLOptions)

Copia de forma assíncrona um blob para um destino dentro da conta de armazenamento. Esse método retorna um sondador de operação de execução prolongada 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 tentar 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 copiar blob 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 Copiar Blob pode ser um arquivo do Azure em qualquer conta de armazenamento do Azure. Apenas as contas de armazenamento criadas a partir de 7 de junho de 2012 permitem que a operação Copy Blob faça cópias de outra conta de armazenamento.

function beginCopyFromURL(copySource: string, options?: BlobBeginCopyFromURLOptions)

Parâmetros

copySource: string

url para o Blob/Arquivo do Azure de origem.

options: BlobBeginCopyFromURLOptions

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

Retornos

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

clearPages(number, number, PageBlobClearPagesOptions)

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

function clearPages(offset?: number, count?: number, options?: PageBlobClearPagesOptions)

Parâmetros

offset: number

Iniciando a posição de bytes das páginas a serem limpas.

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.

function create(size: number, options?: PageBlobCreateOptions)

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.

function createIfNotExists(size: number, options?: PageBlobCreateIfNotExistsOptions)

Parâmetros

size: number

tamanho do blob de páginas.

options: PageBlobCreateIfNotExistsOptions

Retornos

Promise<PageBlobCreateIfNotExistsResponse>

createSnapshot(BlobCreateSnapshotOptions)

Cria um instantâneo somente leitura de um blob.

function createSnapshot(options?: BlobCreateSnapshotOptions)

Parâmetros

options: BlobCreateSnapshotOptions

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

Retornos

Promise<BlobCreateSnapshotResponse>

delete(BlobDeleteOptions)

Marca o blob ou instantâneo especificado para exclusão. O blob é excluído posteriormente, durante a coleta de lixo. Observe que para excluir um blob, você deve excluir todos os seus instantâneos. Você pode excluir ambos ao mesmo tempo com a operação Excluir Blob.

function delete(options?: BlobDeleteOptions)

Parâmetros

options: BlobDeleteOptions

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

Retornos

Promise<BlobDeleteResponse>

deleteIfExists(BlobDeleteOptions)

Marca o blob ou instantâneo especificado para exclusão, se existir. O blob é excluído posteriormente, durante a coleta de lixo. Observe que para excluir um blob, você deve excluir todos os seus instantâneos. Você pode excluir ambos ao mesmo tempo com a operação Excluir Blob.

function deleteIfExists(options?: BlobDeleteOptions)

Parâmetros

options: BlobDeleteOptions

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

Retornos

Promise<BlobDeleteIfExistsResponse>

deleteImmutabilityPolicy(BlobDeleteImmutabilityPolicyOptions)

Exclua a política immutablility no blob.

function deleteImmutabilityPolicy(options?: BlobDeleteImmutabilityPolicyOptions)

Parâmetros

options: BlobDeleteImmutabilityPolicyOptions

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

Retornos

Promise<BlobDeleteImmutabilityPolicyResponse>

download(number, number, BlobDownloadOptions)

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

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

function download(offset?: number, count?: number, options?: BlobDownloadOptions)

Parâmetros

offset: number

De qual posição do blob baixar, maior ou igual a 0

count: number

Quantos dados devem ser 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 uso (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>

downloadToBuffer(Buffer, number, number, BlobDownloadToBufferOptions)

DISPONÍVEL SOMENTE EM NODE.JS RUNTIME. Baixa um Blob do Azure em paralelo a um buffer. Deslocamento e contagem são opcionais, baixando todo o blob se eles não forem fornecidos.

Aviso: os buffers só podem dar suporte a 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 <xref:downloadToFile>.

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

Parâmetros

buffer: Buffer

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

offset: number

A partir da qual a posição do blob de blocos será baixada (em bytes)

count: number

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

options: BlobDownloadToBufferOptions

BlobDownloadToBufferOptions

Retornos

Promise<Buffer>

downloadToBuffer(number, number, BlobDownloadToBufferOptions)

DISPONÍVEL SOMENTE EM NODE.JS RUNTIME. Baixa um Blob do Azure em paralelo a um buffer. Deslocamento e contagem são opcionais, baixando todo o blob se eles não forem fornecidos.

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

Parâmetros

offset: number

A partir da qual a posição do blob de blocos será baixada (em bytes)

count: number

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

options: BlobDownloadToBufferOptions

BlobDownloadToBufferOptions

Retornos

Promise<Buffer>

downloadToFile(string, number, number, BlobDownloadOptions)

DISPONÍVEL APENAS NO RUNTIME NODE.JS. 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, passe 0 e indefinidos, respectivamente, para baixar todo o blob.

function downloadToFile(filePath: string, offset?: number, count?: number, options?: BlobDownloadOptions)

Parâmetros

filePath: string

offset: number

A partir da qual a posição do blob de blocos será baixada.

count: number

Quantos dados devem ser baixados. Baixará 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.

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)

Parâmetros

options: BlobExistsOptions

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

Retornos

Promise<boolean>

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.

function generateSasUrl(options: BlobGenerateSasUrlOptions)

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.

getAppendBlobClient()

Cria um objeto AppendBlobClient.

function getAppendBlobClient()

Retornos

AppendBlobClient

getBlobLeaseClient(string)

Obtenha um <xref:BlobLeaseClient> que gerencia as concessões no blob.

function getBlobLeaseClient(proposeLeaseId?: string)

Parâmetros

proposeLeaseId: string

ID de concessão proposta inicial.

Retornos

BlobLeaseClient

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

getBlockBlobClient()

Cria um objeto BlockBlobClient.

function getBlockBlobClient()

Retornos

BlockBlobClient

getPageBlobClient()

Cria um objeto PageBlobClient.

function getPageBlobClient()

Retornos

PageBlobClient

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.

function getPageRanges(offset?: number, count?: number, options?: PageBlobGetPageRangesOptions)

Parâmetros

offset: number

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

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

function getPageRangesDiff(offset: number, count: number, prevSnapshot: string, options?: PageBlobGetPageRangesDiffOptions)

Parâmetros

offset: number

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

count: number

Número de bytes para obter intervalos dif.

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 Obter Intervalo de Páginas do 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 esse blob de página para discos gerenciados.

function getPageRangesDiffForManagedDisks(offset: number, count: number, prevSnapshotUrl: string, options?: PageBlobGetPageRangesDiffOptions)

Parâmetros

offset: number

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

count: number

Número de bytes para obter intervalos dif.

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 Obter Intervalo de Páginas do Blob de Páginas.

getProperties(BlobGetPropertiesOptions)

Retorna todos os metadados definidos pelo usuário, propriedades HTTP padrão e propriedades do sistema para o blob. Ela não retorna o conteúdo do blob.

function getProperties(options?: BlobGetPropertiesOptions)

Parâmetros

options: BlobGetPropertiesOptions

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

Retornos

Promise<BlobGetPropertiesResponse>

getTags(BlobGetTagsOptions)

Obtém as marcas associadas ao blob subjacente.

function getTags(options?: BlobGetTagsOptions)

Parâmetros

options: BlobGetTagsOptions

Retornos

Promise<BlobGetTagsResponse>

resize(number, PageBlobResizeOptions)

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

function resize(size: number, options?: PageBlobResizeOptions)

Parâmetros

size: number

Tamanho de destino

options: PageBlobResizeOptions

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

Retornos

Promise<PageBlobResizeResponse>

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

setAccessTier(BlockBlobTier | PremiumPageBlobTier | 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, o IOPS e a largura de banda permitidos 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.

function setAccessTier(tier: BlockBlobTier | PremiumPageBlobTier | string, options?: BlobSetTierOptions)

Parâmetros

tier: BlockBlobTier | PremiumPageBlobTier | string

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

options: BlobSetTierOptions

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

Retornos

Promise<BlobSetTierResponse>

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.

function setHTTPHeaders(blobHTTPHeaders?: BlobHTTPHeaders, options?: BlobSetHTTPHeadersOptions)

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

options: BlobSetHTTPHeadersOptions

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

Retornos

Promise<BlobSetHTTPHeadersResponse>

setImmutabilityPolicy(BlobImmutabilityPolicy, BlobSetImmutabilityPolicyOptions)

Defina a política immutablility no blob.

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

Parâmetros

immutabilityPolicy: BlobImmutabilityPolicy

options: BlobSetImmutabilityPolicyOptions

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

Retornos

Promise<BlobSetImmutabilityPolicyResponse>

setLegalHold(boolean, BlobSetLegalHoldOptions)

Defina a retenção legal no blob.

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

Parâmetros

legalHoldEnabled: boolean

options: BlobSetLegalHoldOptions

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

Retornos

Promise<BlobSetLegalHoldResponse>

setMetadata(Metadata, BlobSetMetadataOptions)

Define metadados definidos pelo usuário para o blob especificado como um ou mais pares de nome-valor. Se nenhuma opção for fornecida ou nenhum metadado definido no parâmetro , os metadados do blob serão removidos.

function setMetadata(metadata?: Metadata, options?: BlobSetMetadataOptions)

Parâmetros

metadata: Metadata

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

options: BlobSetMetadataOptions

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

Retornos

Promise<BlobSetMetadataResponse>

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

function setTags(tags: Tags, options?: BlobSetTagsOptions)

Parâmetros

tags: Tags

options: BlobSetTagsOptions

Retornos

Promise<BlobSetTagsResponse>

startCopyIncremental(string, PageBlobStartCopyIncrementalOptions)

Inicia uma operação para iniciar uma cópia incremental do instantâneo de um blob de página para este 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.

function startCopyIncremental(copySource: string, options?: PageBlobStartCopyIncrementalOptions)

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.

syncCopyFromURL(string, BlobSyncCopyFromURLOptions)

A operação de URL de Cópia Síncrona 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.

function syncCopyFromURL(copySource: string, options?: BlobSyncCopyFromURLOptions)

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>

undelete(BlobUndeleteOptions)

Restaura o conteúdo e os metadados do blob de exclusão reversível e de todos os instantâneos excluídos reversível associados. O Undelete Blob tem suporte apenas na versão 2017-07-29 ou posterior.

function undelete(options?: BlobUndeleteOptions)

Parâmetros

options: BlobUndeleteOptions

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

Retornos

Promise<BlobUndeleteResponse>

updateSequenceNumber(SequenceNumberActionType, number, PageBlobUpdateSequenceNumberOptions)

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

function updateSequenceNumber(sequenceNumberAction: SequenceNumberActionType, sequenceNumber?: number, options?: PageBlobUpdateSequenceNumberOptions)

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ção do Blob de Páginas.

Retornos

Promise<PageBlobUpdateSequenceNumberResponse>

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

uploadPages(HttpRequestBody, number, number, PageBlobUploadPagesOptions)

Grava 1 ou mais páginas no blob de páginas. Os deslocamentos inicial e final devem ser múltiplos de 512.

function uploadPages(body: HttpRequestBody, offset: number, count: number, options?: PageBlobUploadPagesOptions)

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 Carregamento de Blobs de Páginas.

Retornos

Promise<PageBlobUploadPagesResponse>

Dados de resposta para a operação Páginas de Carregamento de Blobs 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.

function uploadPagesFromURL(sourceURL: string, sourceOffset: number, destOffset: number, count: number, options?: PageBlobUploadPagesFromURLOptions)

Parâmetros

sourceURL: string

Especifique uma URL para a fonte de 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 do instantâneo especificado. Fornecer "" removerá o instantâneo e retornará um Cliente para o blob base.

function withSnapshot(snapshot: string)

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 do instantâneo especificado.

withVersion(string)

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

function withVersion(versionId: string)

Parâmetros

versionId: string

A versionId.

Retornos

BlobClient

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

Compartilhar via

PageBlobClient class

Construtores

Propriedades

Métodos

Detalhes do construtor

PageBlobClient(string, PipelineLike)

Parâmetros

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

Parâmetros

PageBlobClient(string, string, string, StoragePipelineOptions)

Parâmetros

Detalhes da propriedade

accountName

Valor da propriedade

containerName

Valor da propriedade

credential

Valor da propriedade

name

Valor da propriedade

url

Valor da propriedade

Detalhes do método

abortCopyFromURL(string, BlobAbortCopyFromURLOptions)

Parâmetros

Retornos

beginCopyFromURL(string, BlobBeginCopyFromURLOptions)

Parâmetros

Retornos

clearPages(number, number, PageBlobClearPagesOptions)

Parâmetros

Retornos

create(number, PageBlobCreateOptions)

Parâmetros

Retornos

createIfNotExists(number, PageBlobCreateIfNotExistsOptions)

Parâmetros

Retornos

createSnapshot(BlobCreateSnapshotOptions)

Parâmetros

Retornos

delete(BlobDeleteOptions)

Parâmetros

Retornos

deleteIfExists(BlobDeleteOptions)

Parâmetros

Retornos

deleteImmutabilityPolicy(BlobDeleteImmutabilityPolicyOptions)

Parâmetros

Retornos

download(number, number, BlobDownloadOptions)

Parâmetros

Retornos

downloadToBuffer(Buffer, number, number, BlobDownloadToBufferOptions)

Parâmetros

Retornos

downloadToBuffer(number, number, BlobDownloadToBufferOptions)

Parâmetros

Retornos

downloadToFile(string, number, number, BlobDownloadOptions)

Parâmetros

Retornos

exists(BlobExistsOptions)

Parâmetros

Retornos

generateSasUrl(BlobGenerateSasUrlOptions)

Parâmetros

Retornos

getAppendBlobClient()

Retornos

getBlobLeaseClient(string)

Parâmetros

Retornos

getBlockBlobClient()

Retornos

getPageBlobClient()

Retornos

getPageRanges(number, number, PageBlobGetPageRangesOptions)

Parâmetros