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. Este método aceita um URL codificado ou um URL não codificado que aponte para um blob. A cadeia de URL codificada NÃO será escapada duas vezes, apenas os carateres especiais no caminho do URL serão escapados. Se um nome de blob incluir ? ou %, o nome do blob tem de ser codificado no URL.
PageBlobClient(string, string, string, StoragePipelineOptions)	Cria uma instância de PageBlobClient.

Propriedades

accountName
containerName	O nome do contentor de armazenamento ao que o blob está associado.
credential	Tal como AnonymousCredential, StorageSharedKeyCredential ou qualquer credencial do `@azure/identity` pacote para autenticar pedidos para o serviço. Também pode fornecer um objeto que implementa a interface TokenCredential. Se não for especificado, é utilizado AnonymousCredential.
name	O nome do blob.
url	Valor da cadeia de URL codificado.

Métodos

abortCopyFromURL(string, BlobAbortCopyFromURLOptions)	Aborta 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. Este método devolve um poller de operação de execução prolongada que lhe permite aguardar indefinidamente até que a cópia seja concluída. Também pode cancelar uma cópia antes de ser concluída ao chamar `cancelOperation` o poller. Tenha em atenção que a chamada de retorno onProgress não será invocada se a operação for concluída no primeiro pedido e tentar cancelar uma cópia concluída resultará num erro. Na versão 2012-02-12 e posterior, a origem de uma operação Copiar Blob pode ser um blob consolidado em qualquer conta de armazenamento do Azure. A partir da versão 2015-02-21, a origem de uma operação Copiar Blob pode ser um ficheiro do Azure em qualquer conta de armazenamento do Azure. Apenas as contas de armazenamento criadas em ou depois de 7 de junho de 2012 permitem que a operação Copiar Blob copie a partir de outra conta de armazenamento.
clearPages(number, number, PageBlobClearPagesOptions)	Liberta as páginas especificadas do blob de páginas.
create(number, PageBlobCreateOptions)	Cria um blob de páginas com o comprimento especificado. Chame uploadPages para carregar dados para um blob de páginas.
createIfNotExists(number, PageBlobCreateIfNotExistsOptions)	Cria um blob de páginas com o comprimento especificado. Chame uploadPages para carregar dados para 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 só de leitura de um blob.
delete(BlobDeleteOptions)	Marca o blob ou instantâneo especificado para eliminação. O blob é posteriormente eliminado durante a libertação da memória. Tenha em atenção que, para eliminar um blob, tem de eliminar todos os respetivos instantâneos. Pode eliminar ambos ao mesmo tempo com a operação Eliminar Blob.
deleteIfExists(BlobDeleteOptions)	Marca o blob ou instantâneo especificado para eliminação, se existir. O blob é posteriormente eliminado durante a libertação da memória. Tenha em atenção que, para eliminar um blob, tem de eliminar todos os respetivos instantâneos. Pode eliminar ambos ao mesmo tempo com a operação Eliminar Blob.
deleteImmutabilityPolicy(BlobDeleteImmutabilityPolicyOptions)	Elimine a política de immutablility no blob.
download(number, number, BlobDownloadOptions)	Lê ou transfere um blob do sistema, incluindo os respetivos metadados e propriedades. Também pode chamar Obter Blob para ler um instantâneo. No Node.js, os dados são devolvidos num fluxo legível legívelStreamBody Nos browsers, os dados são devolvidos num blobBody de promessa
downloadToBuffer(Buffer, number, number, BlobDownloadToBufferOptions)	DISPONÍVEL APENAS NO NODE.JS RUNTIME. Transfere um Blob do Azure em paralelo para uma memória intermédia. O deslocamento e a contagem são opcionais, transfere todo o blob se não forem fornecidos. Aviso: As memórias intermédias só podem suportar ficheiros 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 do que este tamanho, considere <xref:downloadToFile>.
downloadToBuffer(number, number, BlobDownloadToBufferOptions)	DISPONÍVEL APENAS NO NODE.JS RUNTIME. Transfere um Blob do Azure em paralelo para uma memória intermédia. O deslocamento e a contagem são opcionais, transfere todo o blob se não forem fornecidos. Aviso: As memórias intermédias só podem suportar ficheiros 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 do que este tamanho, considere <xref:downloadToFile>.
downloadToFile(string, number, number, BlobDownloadOptions)	DISPONÍVEL APENAS NO NODE.JS RUNTIME. Transfere um Blob do Azure para um ficheiro local. Falha se o caminho de ficheiro especificado já sair. O deslocamento e a contagem são opcionais, passam 0 e são indefinidos, respetivamente, para transferir todo o blob.
exists(BlobExistsOptions)	Devolve 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. Os novos blobs vice-versa podem ser adicionados por outros clientes ou aplicações após a conclusão desta função.
generateSasUrl(BlobGenerateSasUrlOptions)	Disponível apenas para BlobClient construído com uma credencial de chave partilhada. Gera um URI de Assinatura de Acesso Partilhado (SAS) do Serviço blob com base nas propriedades e parâmetros do cliente transmitidos. A SAS é assinada pela credencial de chave partilhada do cliente.
getAppendBlobClient()	Cria um objeto AppendBlobClient.
getBlobLeaseClient(string)	Obtenha um <xref:BlobLeaseClient> que faça a gestão de concessões no blob.
getBlockBlobClient()	Cria um objeto BlockBlobClient.
getPageBlobClient()	Cria um objeto PageBlobClient.
getPageRanges(number, number, PageBlobGetPageRangesOptions)	Devolve 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 este blob de página.
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 geridos.
getProperties(BlobGetPropertiesOptions)	Devolve todos os metadados definidos pelo utilizador, propriedades HTTP padrão e propriedades do sistema para o blob. Não devolve o conteúdo do blob.
getTags(BlobGetTagsOptions)	Obtém as etiquetas associadas ao blob subjacente.
resize(number, PageBlobResizeOptions)	Redimensiona o blob de páginas para o tamanho especificado (que tem de ser um múltiplo de 512).
setAccessTier(BlockBlobTier \| PremiumPageBlobTier \| string, BlobSetTierOptions)	Define a camada num blob. A operação é permitida num blob de páginas numa conta de armazenamento premium e num blob de blocos numa conta de armazenamento de blobs (apenas armazenamento localmente redundante). O escalão de um blob de páginas premium determina o tamanho permitido, o IOPS e a largura de banda do blob. A camada de um blob de blocos determina o tipo de armazenamento Frequente/Esporádico/Arquivo. Esta operação não atualiza a ETag do blob.
setHTTPHeaders(BlobHTTPHeaders, BlobSetHTTPHeadersOptions)	Define as propriedades do sistema no blob. Se não for fornecido nenhum valor ou nenhum valor fornecido para os cabeçalhos HTTP de blob especificados, estes cabeçalhos HTTP de blob sem um valor serão limpos.
setImmutabilityPolicy(BlobImmutabilityPolicy, BlobSetImmutabilityPolicyOptions)	Defina a política de imutablilidade no blob.
setLegalHold(boolean, BlobSetLegalHoldOptions)	Defina a retenção legal no blob.
setMetadata(Metadata, BlobSetMetadataOptions)	Define metadados definidos pelo utilizador para o blob especificado como um ou mais pares nome-valor. Se não for fornecida nenhuma opção ou se não forem definidos metadados no parâmetro, os metadados do blob serão removidos.
setTags(Tags, BlobSetTagsOptions)	Define etiquetas no blob subjacente. Um blob pode ter até 10 etiquetas. As teclas de etiqueta têm de ter entre 1 e 128 carateres. Os valores das etiquetas têm de ter entre 0 e 256 carateres. Os carateres de chave e valor de etiqueta válidos incluem letras minúsculas e maiúsculas, dígitos (0-9), espaço (' '), mais ('+'), menos ('-'), ponto final ('.'), barra ('/'), dois pontos (':'), igual a ('=') e caráter de 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 a 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 habitualmente.
syncCopyFromURL(string, BlobSyncCopyFromURLOptions)	A operação copiar de URL síncrona copia um blob ou um recurso da Internet para um novo blob. Não devolverá uma resposta até que a cópia esteja concluída.
undelete(BlobUndeleteOptions)	Restaura os conteúdos e metadados do blob eliminado de forma recuperável e quaisquer instantâneos de eliminação recuperável associados. Anular Eliminação de Blobs só é suportado 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)	Escreve 1 ou mais páginas no blob de páginas. Os desvios de início e de fim têm de ser múltiplos de 512.
uploadPagesFromURL(string, number, number, number, PageBlobUploadPagesFromURLOptions)	A operação Carregar Páginas escreve um intervalo de páginas num blob de páginas onde os conteúdos são lidos a partir de um 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 devolverá um Cliente ao blob base.
withVersion(string)	Cria um novo objeto BlobClient que aponta para uma versão deste blob. Fornecer "" removerá o versionId e devolverá um Cliente ao 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 cliente a apontar para o blob de páginas do Armazenamento do Azure, como "https://myaccount.blob.core.windows.net/mycontainer/pageblob". Pode acrescentar uma SAS se utilizar AnonymousCredential, como "https://myaccount.blob.core.windows.net/mycontainer/pageblob?sasString".

pipeline: PipelineLike

Chame newPipeline() para criar um pipeline predefinido ou forneça um pipeline personalizado.

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

Cria uma instância de PageBlobClient. Este método aceita um URL codificado ou um URL não codificado que aponte para um blob. A cadeia de URL codificada NÃO será escapada duas vezes, apenas os carateres especiais no caminho do URL serão escapados. Se um nome de blob incluir ? ou %, o nome do blob tem de ser codificado no URL.

new PageBlobClient(url: string, credential: StorageSharedKeyCredential | AnonymousCredential | TokenCredential, options?: StoragePipelineOptions)

Parâmetros

url: string

credential: StorageSharedKeyCredential | AnonymousCredential | TokenCredential

Tal como AnonymousCredential, StorageSharedKeyCredential ou qualquer credencial do @azure/identity pacote para autenticar pedidos para o serviço. Também pode fornecer um objeto que implementa a interface TokenCredential. Se não for especificado, é utilizado AnonymousCredential.

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 ligação de conta ou uma cadeia de ligação SAS de uma conta de armazenamento do Azure. [ Nota - a cadeia de ligação da conta só pode ser utilizada no NODE.JS runtime. ] Exemplo de cadeia de ligação de conta -DefaultEndpointsProtocol=https;AccountName=myaccount;AccountKey=accountKey;EndpointSuffix=core.windows.net Exemplo de cadeia de ligaçã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 contentor.

blobName: string

Nome do blob.

options: StoragePipelineOptions

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

Detalhes de Propriedade

accountName

accountName: string

Valor de Propriedade

string

containerName

O nome do contentor de armazenamento ao que o blob está associado.

string containerName

Valor de Propriedade

string

credential

credential: StorageSharedKeyCredential | AnonymousCredential | TokenCredential

Valor de Propriedade

StorageSharedKeyCredential | AnonymousCredential | TokenCredential

name

O nome do blob.

string name

Valor de Propriedade

string

url

Valor da cadeia de URL codificado.

url: string

Valor de Propriedade

string

Detalhes de Método

abortCopyFromURL(string, BlobAbortCopyFromURLOptions)

Aborta 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 do URL.

options: BlobAbortCopyFromURLOptions

Opções opcionais para a operação Abortar Cópia do UrL do Blob.

Devoluções

Promise<BlobAbortCopyFromURLResponse>

beginCopyFromURL(string, BlobBeginCopyFromURLOptions)

Copia de forma assíncrona um blob para um destino dentro da conta de armazenamento. Este método devolve um poller de operação de execução prolongada que lhe permite aguardar indefinidamente até que a cópia seja concluída. Também pode cancelar uma cópia antes de ser concluída ao chamar cancelOperation o poller. Tenha em atenção que a chamada de retorno onProgress não será invocada se a operação for concluída no primeiro pedido e tentar cancelar uma cópia concluída resultará num erro. Na versão 2012-02-12 e posterior, a origem de uma operação Copiar Blob pode ser um blob consolidado em qualquer conta de armazenamento do Azure. A partir da versão 2015-02-21, a origem de uma operação Copiar Blob pode ser um ficheiro do Azure em qualquer conta de armazenamento do Azure. Apenas as contas de armazenamento criadas em ou depois de 7 de junho de 2012 permitem que a operação Copiar Blob copie a partir de outra conta de armazenamento.

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

Parâmetros

copySource: string

url para o Blob/Ficheiro do Azure de origem.

options: BlobBeginCopyFromURLOptions

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

Devoluções

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

clearPages(number, number, PageBlobClearPagesOptions)

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

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

Parâmetros

offset: number

A iniciar a posição de byte das páginas a limpar.

count: number

Número de bytes a limpar.

options: PageBlobClearPagesOptions

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

Devoluções

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 com o comprimento especificado. Chame uploadPages para carregar dados para 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.

Devoluções

Promise<PageBlobCreateResponse>

Dados de resposta para a operação De Criação de Blobs de Páginas.

createIfNotExists(number, PageBlobCreateIfNotExistsOptions)

Cria um blob de páginas com o comprimento especificado. Chame uploadPages para carregar dados para 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

Devoluções

Promise<PageBlobCreateIfNotExistsResponse>

createSnapshot(BlobCreateSnapshotOptions)

Cria um instantâneo só de leitura de um blob.

function createSnapshot(options?: BlobCreateSnapshotOptions)

Parâmetros

options: BlobCreateSnapshotOptions

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

Devoluções

Promise<BlobCreateSnapshotResponse>

delete(BlobDeleteOptions)

Marca o blob ou instantâneo especificado para eliminação. O blob é posteriormente eliminado durante a libertação da memória. Tenha em atenção que, para eliminar um blob, tem de eliminar todos os respetivos instantâneos. Pode eliminar ambos ao mesmo tempo com a operação Eliminar Blob.

function delete(options?: BlobDeleteOptions)

Parâmetros

options: BlobDeleteOptions

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

Devoluções

Promise<BlobDeleteResponse>

deleteIfExists(BlobDeleteOptions)

Marca o blob ou instantâneo especificado para eliminação, se existir. O blob é posteriormente eliminado durante a libertação da memória. Tenha em atenção que, para eliminar um blob, tem de eliminar todos os respetivos instantâneos. Pode eliminar ambos ao mesmo tempo com a operação Eliminar Blob.

function deleteIfExists(options?: BlobDeleteOptions)

Parâmetros

options: BlobDeleteOptions

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

Devoluções

Promise<BlobDeleteIfExistsResponse>

deleteImmutabilityPolicy(BlobDeleteImmutabilityPolicyOptions)

Elimine a política de immutablility no blob.

function deleteImmutabilityPolicy(options?: BlobDeleteImmutabilityPolicyOptions)

Parâmetros

options: BlobDeleteImmutabilityPolicyOptions

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

Devoluções

Promise<BlobDeleteImmutabilityPolicyResponse>

download(number, number, BlobDownloadOptions)

Lê ou transfere um blob do sistema, incluindo os respetivos metadados e propriedades. Também pode chamar Obter Blob para ler um instantâneo.

No Node.js, os dados são devolvidos num fluxo legível legívelStreamBody
Nos browsers, os dados são devolvidos num blobBody de promessa

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

Parâmetros

offset: number

A partir da posição do blob a transferir, maior ou igual a 0

count: number

A quantidade de dados a transferir, superior a 0. Será transferido para o fim quando não for definido

options: BlobDownloadOptions

Opções opcionais para a operação de Transferência de Blobs.

Utilização de exemplo (Node.js):

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

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

Utilização de exemplo (browser):

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

async function blobToString(blob: Blob): Promise<string> {
  const fileReader = new FileReader();
  return new Promise<string>((resolve, reject) => {
    fileReader.onloadend = (ev: any) => {
      resolve(ev.target!.result);
    };
    fileReader.onerror = reject;
    fileReader.readAsText(blob);
  });
}

Devoluções

Promise<BlobDownloadResponseParsed>

downloadToBuffer(Buffer, number, number, BlobDownloadToBufferOptions)

DISPONÍVEL APENAS NO NODE.JS RUNTIME. Transfere um Blob do Azure em paralelo para uma memória intermédia. O deslocamento e a contagem são opcionais, transfere todo o blob se não forem fornecidos.

Aviso: As memórias intermédias só podem suportar ficheiros 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 do que este tamanho, considere <xref:downloadToFile>.

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

Parâmetros

buffer: Buffer

Memória intermédia a preencher, tem de ter um comprimento superior à contagem

offset: number

A partir da posição do blob de blocos a transferir(em bytes)

count: number

A quantidade de dados (em bytes) a transferir. Será transferida para o fim ao passar indefinidamente

options: BlobDownloadToBufferOptions

BlobDownloadToBufferOptions

Devoluções

Promise<Buffer>

downloadToBuffer(number, number, BlobDownloadToBufferOptions)

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

Parâmetros

offset: number

A partir da posição do blob de blocos a transferir(em bytes)

count: number

A quantidade de dados (em bytes) a transferir. Será transferida para o fim ao passar indefinidamente

options: BlobDownloadToBufferOptions

BlobDownloadToBufferOptions

Devoluções

Promise<Buffer>

downloadToFile(string, number, number, BlobDownloadOptions)

DISPONÍVEL APENAS NO NODE.JS RUNTIME. Transfere um Blob do Azure para um ficheiro local. Falha se o caminho de ficheiro especificado já sair. O deslocamento e a contagem são opcionais, passam 0 e são indefinidos, respetivamente, para transferir todo o blob.

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

Parâmetros

filePath: string

offset: number

A partir da posição do blob de blocos a transferir.

count: number

A quantidade de dados a transferir. Será transferido para o fim ao passar indefinido.

options: BlobDownloadOptions

Opções para opções de transferência de Blobs.

Devoluções

Promise<BlobDownloadResponseParsed>

Os dados de resposta para a operação de transferência de blobs, mas com readableStreamBody definido como indefinido, uma vez que o respetivo conteúdo já é lido e escrito num ficheiro local no caminho especificado.

exists(BlobExistsOptions)

Devolve 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. Os novos blobs vice-versa podem ser adicionados por outros clientes ou aplicações após a conclusão desta função.

function exists(options?: BlobExistsOptions)

Parâmetros

options: BlobExistsOptions

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

Devoluções

Promise<boolean>

generateSasUrl(BlobGenerateSasUrlOptions)

Disponível apenas para BlobClient construído com uma credencial de chave partilhada. Gera um URI de Assinatura de Acesso Partilhado (SAS) do Serviço blob com base nas propriedades e parâmetros do cliente transmitidos. A SAS é assinada pela credencial de chave partilhada do cliente.

function generateSasUrl(options: BlobGenerateSasUrlOptions)

Parâmetros

options: BlobGenerateSasUrlOptions

Parâmetros opcionais.

Devoluções

Promise<string>

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

getAppendBlobClient()

Cria um objeto AppendBlobClient.

function getAppendBlobClient()

Devoluções

AppendBlobClient

getBlobLeaseClient(string)

Obtenha um <xref:BlobLeaseClient> que faça a gestão de concessões no blob.

function getBlobLeaseClient(proposeLeaseId?: string)

Parâmetros

proposeLeaseId: string

ID de concessão proposta inicial.

Devoluções

BlobLeaseClient

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

getBlockBlobClient()

Cria um objeto BlockBlobClient.

function getBlockBlobClient()

Devoluções

BlockBlobClient

getPageBlobClient()

Cria um objeto PageBlobClient.

function getPageBlobClient()

Devoluções

PageBlobClient

getPageRanges(number, number, PageBlobGetPageRangesOptions)

Devolve 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

A iniciar a posição de byte dos intervalos de páginas.

count: number

Número de bytes a obter.

options: PageBlobGetPageRangesOptions

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

Devoluções

Promise<PageBlobGetPageRangesResponse>

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

getPageRangesDiff(number, number, string, PageBlobGetPageRangesDiffOptions)

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

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

Parâmetros

offset: number

A iniciar a posição de byte do blob de páginas

count: number

Número de bytes para que os intervalos se difam.

prevSnapshot: string

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

options: PageBlobGetPageRangesDiffOptions

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

Devoluções

Promise<PageBlobGetPageRangesDiffResponse>

Dados de resposta para a operação De difusã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 este blob de página para discos geridos.

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

Parâmetros

offset: number

A iniciar a posição de byte do blob de páginas

count: number

Número de bytes para que os intervalos se difam.

prevSnapshotUrl: string

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

options: PageBlobGetPageRangesDiffOptions

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

Devoluções

Promise<PageBlobGetPageRangesDiffResponse>

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

getProperties(BlobGetPropertiesOptions)

Devolve todos os metadados definidos pelo utilizador, propriedades HTTP padrão e propriedades do sistema para o blob. Não devolve o conteúdo do blob.

function getProperties(options?: BlobGetPropertiesOptions)

Parâmetros

options: BlobGetPropertiesOptions

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

Devoluções

Promise<BlobGetPropertiesResponse>

getTags(BlobGetTagsOptions)

Obtém as etiquetas associadas ao blob subjacente.

function getTags(options?: BlobGetTagsOptions)

Parâmetros

options: BlobGetTagsOptions

Devoluções

Promise<BlobGetTagsResponse>

resize(number, PageBlobResizeOptions)

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

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

Parâmetros

size: number

Tamanho do destino

options: PageBlobResizeOptions

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

Devoluções

Promise<PageBlobResizeResponse>

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

setAccessTier(BlockBlobTier | PremiumPageBlobTier | string, BlobSetTierOptions)

Define a camada num blob. A operação é permitida num blob de páginas numa conta de armazenamento premium e num blob de blocos numa conta de armazenamento de blobs (apenas armazenamento localmente redundante). O escalão de um blob de páginas premium determina o tamanho permitido, o IOPS e a largura de banda do blob. A camada de um blob de blocos determina o tipo de armazenamento Frequente/Esporádico/Arquivo. Esta 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 definir no blob. Os valores válidos são Frequente, Esporádico ou Arquivo.

options: BlobSetTierOptions

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

Devoluções

Promise<BlobSetTierResponse>

setHTTPHeaders(BlobHTTPHeaders, BlobSetHTTPHeadersOptions)

Define as propriedades do sistema no blob. Se não for fornecido nenhum valor ou nenhum valor fornecido para os cabeçalhos HTTP de blob especificados, estes cabeçalhos HTTP de blob sem um valor serão limpos.

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

Parâmetros

blobHTTPHeaders: BlobHTTPHeaders

Se não for fornecido nenhum valor ou nenhum valor fornecido para os cabeçalhos HTTP de blob especificados, estes cabeçalhos HTTP de blob sem um valor serão limpos. Um cabeçalho comum a definir é blobContentType permitir que o browser forneça funcionalidades com base no tipo de ficheiro.

options: BlobSetHTTPHeadersOptions

Opções opcionais para a operação Definir Cabeçalhos HTTP de Blobs.

Devoluções

Promise<BlobSetHTTPHeadersResponse>

setImmutabilityPolicy(BlobImmutabilityPolicy, BlobSetImmutabilityPolicyOptions)

Defina a política de imutablilidade no blob.

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

Parâmetros

immutabilityPolicy: BlobImmutabilityPolicy

options: BlobSetImmutabilityPolicyOptions

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

Devoluções

Promise<BlobSetImmutabilityPolicyResponse>

setLegalHold(boolean, BlobSetLegalHoldOptions)

Defina a retenção legal no blob.

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

Parâmetros

legalHoldEnabled: boolean

options: BlobSetLegalHoldOptions

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

Devoluções

Promise<BlobSetLegalHoldResponse>

setMetadata(Metadata, BlobSetMetadataOptions)

Define metadados definidos pelo utilizador para o blob especificado como um ou mais pares nome-valor. Se não for fornecida nenhuma opção ou se não forem definidos metadados 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 este valor. Se não for fornecido nenhum valor, os metadados existentes serão removidos.

options: BlobSetMetadataOptions

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

Devoluções

Promise<BlobSetMetadataResponse>

setTags(Tags, BlobSetTagsOptions)

Define etiquetas no blob subjacente. Um blob pode ter até 10 etiquetas. As teclas de etiqueta têm de ter entre 1 e 128 carateres. Os valores das etiquetas têm de ter entre 0 e 256 carateres. Os carateres de chave e valor de etiqueta válidos incluem letras minúsculas e maiúsculas, dígitos (0-9), espaço (' '), mais ('+'), menos ('-'), ponto final ('.'), barra ('/'), dois pontos (':'), igual a ('=') e caráter de sublinhado ('_') .

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

Parâmetros

tags: Tags

options: BlobSetTagsOptions

Devoluções

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

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

Parâmetros

copySource: string

Especifica o nome do instantâneo do 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 Copiar Incremental do Blob de Páginas.

Devoluções

Promise<PageBlobCopyIncrementalResponse>

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

syncCopyFromURL(string, BlobSyncCopyFromURLOptions)

A operação copiar de URL síncrona copia um blob ou um recurso da Internet para um novo blob. Não devolverá uma resposta até que a cópia esteja concluída.

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

Parâmetros

copySource: string

O URL de origem a partir do , Assinatura de Acesso Partilhado (SAS) talvez necessário para autenticação

options: BlobSyncCopyFromURLOptions

Devoluções

Promise<BlobCopyFromURLResponse>

undelete(BlobUndeleteOptions)

Restaura os conteúdos e metadados do blob eliminado de forma recuperável e quaisquer instantâneos de eliminação recuperável associados. Anular Eliminação de Blobs só é suportado na versão 2017-07-29 ou posterior.

function undelete(options?: BlobUndeleteOptions)

Parâmetros

options: BlobUndeleteOptions

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

Devoluções

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

Necessário se sequenceNumberAction for máx. ou atualizar

options: PageBlobUpdateSequenceNumberOptions

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

Devoluções

Promise<PageBlobUpdateSequenceNumberResponse>

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

uploadPages(HttpRequestBody, number, number, PageBlobUploadPagesOptions)

Escreve 1 ou mais páginas no blob de páginas. Os desvios de início e de fim têm de ser múltiplos de 512.

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

Parâmetros

body: HttpRequestBody

Dados a carregar

offset: number

Desvio do blob de páginas de destino

count: number

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

options: PageBlobUploadPagesOptions

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

Devoluções

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 escreve um intervalo de páginas num blob de páginas onde os conteúdos são lidos a partir de um URL.

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

Parâmetros

sourceURL: string

Especifique um URL para a origem de cópia, Assinatura de Acesso Partilhado (SAS) talvez necessário para autenticação

sourceOffset: number

O desvio de origem para copiar. Passar 0 para copiar a partir do início do blob de páginas de origem

destOffset: number

Desvio do blob de páginas de destino

count: number

Número de bytes a carregar a partir do blob de páginas 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 devolverá um Cliente ao blob base.

function withSnapshot(snapshot: string)

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.

withVersion(string)

Cria um novo objeto BlobClient que aponta para uma versão deste blob. Fornecer "" removerá o versionId e devolverá um Cliente ao blob base.

function withVersion(versionId: string)

Parâmetros

versionId: string

O versionId.

Devoluções

BlobClient

Um novo objeto BlobClient a apontar para a versão deste blob.

Partilhar 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 de Propriedade

accountName

Valor de Propriedade

containerName

Valor de Propriedade

credential

Valor de Propriedade

name

Valor de Propriedade

url

Valor de Propriedade

Detalhes de Método

abortCopyFromURL(string, BlobAbortCopyFromURLOptions)

Parâmetros

Devoluções

beginCopyFromURL(string, BlobBeginCopyFromURLOptions)

Parâmetros

Devoluções

clearPages(number, number, PageBlobClearPagesOptions)

Parâmetros

Devoluções

create(number, PageBlobCreateOptions)

Parâmetros

Devoluções

createIfNotExists(number, PageBlobCreateIfNotExistsOptions)

Parâmetros

Devoluções

createSnapshot(BlobCreateSnapshotOptions)

Parâmetros

Devoluções

delete(BlobDeleteOptions)

Parâmetros

Devoluções

deleteIfExists(BlobDeleteOptions)

Parâmetros

Devoluções

deleteImmutabilityPolicy(BlobDeleteImmutabilityPolicyOptions)

Parâmetros

Devoluções

download(number, number, BlobDownloadOptions)

Parâmetros

Devoluções

downloadToBuffer(Buffer, number, number, BlobDownloadToBufferOptions)

Parâmetros

Devoluções

downloadToBuffer(number, number, BlobDownloadToBufferOptions)

Parâmetros

Devoluções

downloadToFile(string, number, number, BlobDownloadOptions)

Parâmetros

Devoluções

exists(BlobExistsOptions)

Parâmetros

Devoluções

generateSasUrl(BlobGenerateSasUrlOptions)

Parâmetros

Devoluções

getAppendBlobClient()

Devoluções

getBlobLeaseClient(string)

Parâmetros

Devoluções

getBlockBlobClient()

Devoluções

getPageBlobClient()

Devoluções

getPageRanges(number, number, PageBlobGetPageRangesOptions)

Parâmetros