AppendBlobClient class
AppendBlobClient define um conjunto de operações aplicáveis a blobs de acréscimo.
- Extends
Construtores
Append |
Cria uma instância de AppendBlobClient. Esse método aceita uma URL codificada ou uma URL não codificada apontando para um blob de acréscimo. 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. |
Append |
Cria uma instância de AppendBlobClient. Esse método aceita uma URL codificada ou uma URL não codificada apontando para um blob de acréscimo. 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. |
Append |
Cria uma instância de AppendBlobClient. |
Propriedades
container |
O nome do contêiner de armazenamento ao qual o blob está associado. |
name | O nome do blob. |
Propriedades herdadas
account |
|
credential | Como AnonymousCredential, StorageSharedKeyCredential ou qualquer credencial do |
url | Valor da cadeia de caracteres de URL codificada. |
Métodos
append |
Confirma um novo bloco de dados no final do blob de acréscimo existente. Veja https://docs.microsoft.com/rest/api/storageservices/append-block |
append |
A operação Anexar Bloco confirma um novo bloco de dados ao final de um blob de acréscimo existente em que o conteúdo é lido de uma URL de origem. Veja https://docs.microsoft.com/en-us/rest/api/storageservices/append-block-from-url |
create(Append |
Cria um blob de acréscimo de 0 comprimento. Chame AppendBlock para acrescentar dados a um blob de acréscimo. Veja https://docs.microsoft.com/rest/api/storageservices/put-blob |
create |
Cria um blob de acréscimo de 0 comprimento. Chame AppendBlock para acrescentar dados a um blob de acréscimo. Se o blob com o mesmo nome já existir, o conteúdo do blob existente permanecerá inalterado. Veja https://docs.microsoft.com/rest/api/storageservices/put-blob |
seal(Append |
Sela o blob de acréscimo, tornando-o somente leitura. |
with |
Cria um novo objeto AppendBlobClient 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 de base. |
Métodos herdados
abort |
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. Veja https://docs.microsoft.com/en-us/rest/api/storageservices/abort-copy-blob |
begin |
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 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. Veja https://docs.microsoft.com/en-us/rest/api/storageservices/copy-blob Exemplo usando sondagem automática:
Exemplo usando sondagem manual:
Exemplo usando atualizações de progresso:
Exemplo usando um intervalo de sondagem variável (padrão de 15 segundos):
Exemplo usando o cancelamento de cópia:
|
create |
Cria um instantâneo somente leitura de um blob. Veja https://docs.microsoft.com/en-us/rest/api/storageservices/snapshot-blob |
delete(Blob |
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. Veja https://docs.microsoft.com/en-us/rest/api/storageservices/delete-blob |
delete |
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. Veja https://docs.microsoft.com/en-us/rest/api/storageservices/delete-blob |
delete |
Exclua a política immutablility no blob. |
download(number, number, Blob |
Lê ou baixa um blob do sistema, incluindo seus metadados e propriedades. Você também pode chamar Obter Blob para ler um instantâneo.
Veja https://docs.microsoft.com/en-us/rest/api/storageservices/get-blob |
download |
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 downloadToFile. |
download |
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 downloadToFile. |
download |
DISPONÍVEL SOMENTE EM NODE.JS RUNTIME. Baixa um Blob do Azure em um arquivo local. Falhará se o caminho de arquivo fornecido já for encerrado. Deslocamento e contagem são opcionais, passe 0 e indefinido, respectivamente, para baixar o blob inteiro. |
exists(Blob |
Retornará true se o recurso de blob do Azure representado por esse cliente existir; caso contrário, false. 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. |
generate |
Disponível somente 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. Veja https://docs.microsoft.com/en-us/rest/api/storageservices/constructing-a-service-sas |
get |
Cria um objeto AppendBlobClient. |
get |
Obtenha um BlobLeaseClient que gerencia concessões no blob. |
get |
Cria um objeto BlockBlobClient. |
get |
Cria um objeto PageBlobClient. |
get |
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. Veja https://docs.microsoft.com/en-us/rest/api/storageservices/get-blob-properties AVISO: o |
get |
Obtém as marcas associadas ao blob subjacente. |
set |
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áginas 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 Frequente/Esporádico/Arquivo Morto. Essa operação não atualiza a ETag do blob. Veja https://docs.microsoft.com/en-us/rest/api/storageservices/set-blob-tier |
set |
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. Veja https://docs.microsoft.com/en-us/rest/api/storageservices/set-blob-properties |
set |
Defina a política de imutabilidade no blob. |
set |
Defina a retenção legal no blob. |
set |
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. Veja https://docs.microsoft.com/en-us/rest/api/storageservices/set-blob-metadata |
set |
Define marcas no blob subjacente. Um blob pode ter até 10 marcas. As teclas de marca devem ter entre 1 e 128 caracteres. Os valores de marca devem ter entre 0 e 256 caracteres. Os caracteres de chave e valor de marca 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 sublinhado ('_') . |
sync |
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 seja concluída. Veja https://docs.microsoft.com/en-us/rest/api/storageservices/copy-blob-from-url |
undelete(Blob |
Restaura o conteúdo e os metadados do blob com exclusão reversível e de todos os instantâneos excluídos temporariamente associados. O blob de exclusão tem suporte apenas na versão 2017-07-29 ou posterior. Veja https://docs.microsoft.com/en-us/rest/api/storageservices/undelete-blob |
with |
Cria um novo objeto BlobClient apontando para uma versão desse blob. Forneça "" removerá a versionId e retornará um Cliente para o blob de base. |
Detalhes do construtor
AppendBlobClient(string, PipelineLike)
Cria uma instância de AppendBlobClient. Esse método aceita uma URL codificada ou uma URL não codificada apontando para um blob de acréscimo. 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 AppendBlobClient(url: string, pipeline: PipelineLike)
Parâmetros
- url
-
string
Uma cadeia de caracteres de URL apontando para o blob de acréscimo do Armazenamento do Azure, como "https://myaccount.blob.core.windows.net/mycontainer/appendblob". Você pode acrescentar uma SAS se estiver usando AnonymousCredential, como "https://myaccount.blob.core.windows.net/mycontainer/appendblob?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 terá escape duas vezes, somente caracteres especiais no caminho da URL serão escapados. No entanto, se um nome de blob incluir ? ou %, o nome do blob deve ser codificado na URL. Como um blob chamado "my?blob%", a URL deve ser "https://myaccount.blob.core.windows.net/mycontainer/my%3Fblob%25".
- pipeline
- PipelineLike
Chame newPipeline() para criar um pipeline padrão ou forneça um pipeline personalizado.
AppendBlobClient(string, StorageSharedKeyCredential | AnonymousCredential | TokenCredential, StoragePipelineOptions)
Cria uma instância de AppendBlobClient. Esse método aceita uma URL codificada ou uma URL não codificada apontando para um blob de acréscimo. 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 AppendBlobClient(url: string, credential: StorageSharedKeyCredential | AnonymousCredential | TokenCredential, options?: StoragePipelineOptions)
Parâmetros
- url
-
string
Uma cadeia de caracteres de URL apontando para o blob de acréscimo do Armazenamento do Azure, como "https://myaccount.blob.core.windows.net/mycontainer/appendblob". Você pode acrescentar uma SAS se estiver usando AnonymousCredential, como "https://myaccount.blob.core.windows.net/mycontainer/appendblob?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 terá escape duas vezes, somente caracteres especiais no caminho da URL serão escapados. No entanto, se um nome de blob incluir ? ou %, o nome do blob deve ser codificado na URL. Como um blob chamado "my?blob%", a URL deve ser "https://myaccount.blob.core.windows.net/mycontainer/my%3Fblob%25".
- 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.
AppendBlobClient(string, string, string, StoragePipelineOptions)
Cria uma instância de AppendBlobClient.
new AppendBlobClient(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 de blob.
- options
- StoragePipelineOptions
Opcional. Opções para configurar o pipeline HTTP.
Detalhes da propriedade
containerName
O nome do contêiner de armazenamento ao qual o blob está associado.
string containerName
Valor da propriedade
string
name
O nome do blob.
string name
Valor da propriedade
string
Detalhes das propriedades herdadas
accountName
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.
credential: StorageSharedKeyCredential | AnonymousCredential | TokenCredential
Valor da propriedade
Herdado deBlobClient.credential
url
Valor da cadeia de caracteres de URL codificada.
url: string
Valor da propriedade
string
Herdado deBlobClient.url
Detalhes do método
appendBlock(RequestBodyType, number, AppendBlobAppendBlockOptions)
Confirma um novo bloco de dados no final do blob de acréscimo existente.
Veja https://docs.microsoft.com/rest/api/storageservices/append-block
function appendBlock(body: RequestBodyType, contentLength: number, options?: AppendBlobAppendBlockOptions): Promise<AppendBlobAppendBlockResponse>
Parâmetros
- body
- HttpRequestBody
Dados a serem acrescentados.
- contentLength
-
number
Comprimento do corpo em bytes.
- options
- AppendBlobAppendBlockOptions
Opções para a operação Anexar Bloco.
Exemplo de uso:
const content = "Hello World!";
// Create a new append blob and append data to the blob.
const newAppendBlobClient = containerClient.getAppendBlobClient("<blob name>");
await newAppendBlobClient.create();
await newAppendBlobClient.appendBlock(content, content.length);
// Append data to an existing append blob.
const existingAppendBlobClient = containerClient.getAppendBlobClient("<blob name>");
await existingAppendBlobClient.appendBlock(content, content.length);
Retornos
Promise<AppendBlobAppendBlockResponse>
appendBlockFromURL(string, number, number, AppendBlobAppendBlockFromURLOptions)
A operação Anexar Bloco confirma um novo bloco de dados ao final de um blob de acréscimo existente em que o conteúdo é lido de uma URL de origem.
Veja https://docs.microsoft.com/en-us/rest/api/storageservices/append-block-from-url
function appendBlockFromURL(sourceURL: string, sourceOffset: number, count: number, options?: AppendBlobAppendBlockFromURLOptions): Promise<AppendBlobAppendBlockFromUrlResponse>
Parâmetros
- sourceURL
-
string
A URL para o blob que será a origem da cópia. Um blob de origem na mesma conta de armazenamento pode ser autenticado por meio da Chave Compartilhada. No entanto, se a origem for um blob em outra conta, o blob de origem deverá ser público ou deve ser autenticado por meio de uma assinatura de acesso compartilhado. Se o blob de origem for público, nenhuma autenticação será necessária para executar a operação.
- sourceOffset
-
number
Deslocamento na origem a ser acrescentada
- count
-
number
Número de bytes a serem acrescentados como um bloco
Retornos
Promise<AppendBlobAppendBlockFromUrlResponse>
create(AppendBlobCreateOptions)
Cria um blob de acréscimo de 0 comprimento. Chame AppendBlock para acrescentar dados a um blob de acréscimo.
Veja https://docs.microsoft.com/rest/api/storageservices/put-blob
function create(options?: AppendBlobCreateOptions): Promise<AppendBlobCreateResponse>
Parâmetros
- options
- AppendBlobCreateOptions
Opções para a operação Append Block Create.
Exemplo de uso:
const appendBlobClient = containerClient.getAppendBlobClient("<blob name>");
await appendBlobClient.create();
Retornos
Promise<AppendBlobCreateResponse>
createIfNotExists(AppendBlobCreateIfNotExistsOptions)
Cria um blob de acréscimo de 0 comprimento. Chame AppendBlock para acrescentar dados a um blob de acréscimo. Se o blob com o mesmo nome já existir, o conteúdo do blob existente permanecerá inalterado.
Veja https://docs.microsoft.com/rest/api/storageservices/put-blob
function createIfNotExists(options?: AppendBlobCreateIfNotExistsOptions): Promise<AppendBlobCreateIfNotExistsResponse>
Parâmetros
Retornos
Promise<AppendBlobCreateIfNotExistsResponse>
seal(AppendBlobSealOptions)
Sela o blob de acréscimo, tornando-o somente leitura.
function seal(options?: AppendBlobSealOptions): Promise<AppendBlobAppendBlockResponse>
Parâmetros
- options
- AppendBlobSealOptions
Retornos
Promise<AppendBlobAppendBlockResponse>
withSnapshot(string)
Cria um novo objeto AppendBlobClient 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 de base.
function withSnapshot(snapshot: string): AppendBlobClient
Parâmetros
- snapshot
-
string
O carimbo de data/hora do instantâneo.
Retornos
Um novo objeto AppendBlobClient 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 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.
Veja https://docs.microsoft.com/en-us/rest/api/storageservices/abort-copy-blob
function abortCopyFromURL(copyId: string, options?: BlobAbortCopyFromURLOptions): Promise<BlobAbortCopyFromURLResponse>
Parâmetros
- copyId
-
string
ID da operação Copiar da URL.
- options
- BlobAbortCopyFromURLOptions
Opções opcionais para a operação Anular Cópia da URL do Blob.
Retornos
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 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.
Veja https://docs.microsoft.com/en-us/rest/api/storageservices/copy-blob
Exemplo usando sondagem automática:
const copyPoller = await blobClient.beginCopyFromURL('url');
const result = await copyPoller.pollUntilDone();
Exemplo usando sondagem manual:
const copyPoller = await blobClient.beginCopyFromURL('url');
while (!poller.isDone()) {
await poller.poll();
}
const result = copyPoller.getResult();
Exemplo usando atualizações de progresso:
const copyPoller = await blobClient.beginCopyFromURL('url', {
onProgress(state) {
console.log(`Progress: ${state.copyProgress}`);
}
});
const result = await copyPoller.pollUntilDone();
Exemplo usando um intervalo de sondagem variável (padrão de 15 segundos):
const copyPoller = await blobClient.beginCopyFromURL('url', {
intervalInMs: 1000 // poll blob every 1 second for copy progress
});
const result = await copyPoller.pollUntilDone();
Exemplo usando o cancelamento de cópia:
const copyPoller = await blobClient.beginCopyFromURL('url');
// cancel operation after starting it.
try {
await copyPoller.cancelOperation();
// calls to get the result now throw PollerCancelledError
await copyPoller.getResult();
} catch (err) {
if (err.name === 'PollerCancelledError') {
console.log('The copy was cancelled.');
}
}
function beginCopyFromURL(copySource: string, options?: BlobBeginCopyFromURLOptions): Promise<PollerLikeWithCancellation<PollOperationState<BlobBeginCopyFromURLResponse>, BlobBeginCopyFromURLResponse>>
Parâmetros
- copySource
-
string
url para o Blob/Arquivo do Azure de origem.
- options
- BlobBeginCopyFromURLOptions
Opções opcionais para a operação Iniciar Cópia da URL do Blob.
Retornos
Promise<PollerLikeWithCancellation<PollOperationState<BlobBeginCopyFromURLResponse>, BlobBeginCopyFromURLResponse>>
Herdado deBlobClient.beginCopyFromURL
createSnapshot(BlobCreateSnapshotOptions)
Cria um instantâneo somente leitura de um blob.
Veja https://docs.microsoft.com/en-us/rest/api/storageservices/snapshot-blob
function createSnapshot(options?: BlobCreateSnapshotOptions): Promise<BlobCreateSnapshotResponse>
Parâmetros
- options
- BlobCreateSnapshotOptions
Opções opcionais para a operação Criar Instantâneo de Blob.
Retornos
Promise<BlobCreateSnapshotResponse>
Herdado deBlobClient.createSnapshot
delete(BlobDeleteOptions)
Marca o blob ou instantâneo especificado para exclusão. O blob é 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.
Veja https://docs.microsoft.com/en-us/rest/api/storageservices/delete-blob
function delete(options?: BlobDeleteOptions): Promise<BlobDeleteResponse>
Parâmetros
- options
- BlobDeleteOptions
Opções opcionais para a operação de Exclusão de Blob.
Retornos
Promise<BlobDeleteResponse>
Herdado deBlobClient.delete
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.
Veja https://docs.microsoft.com/en-us/rest/api/storageservices/delete-blob
function deleteIfExists(options?: BlobDeleteOptions): Promise<BlobDeleteIfExistsResponse>
Parâmetros
- options
- BlobDeleteOptions
Opções opcionais para a operação de Exclusão de Blob.
Retornos
Promise<BlobDeleteIfExistsResponse>
Herdado deBlobClient.deleteIfExists
deleteImmutabilityPolicy(BlobDeleteImmutabilityPolicyOptions)
Exclua a política immutablility no blob.
function deleteImmutabilityPolicy(options?: BlobDeleteImmutabilityPolicyOptions): Promise<BlobDeleteImmutabilityPolicyResponse>
Parâmetros
Opções opcionais para excluir a política de imutabilidade no blob.
Retornos
Promise<BlobDeleteImmutabilityPolicyResponse>
Herdado deBlobClient.deleteImmutabilityPolicy
download(number, number, BlobDownloadOptions)
Lê ou baixa um blob do sistema, incluindo seus metadados e propriedades. Você também pode chamar 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
Veja 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
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>
Herdado deBlobClient.download
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 downloadToFile.
function downloadToBuffer(buffer: Buffer, offset?: number, count?: number, options?: BlobDownloadToBufferOptions): Promise<Buffer>
Parâmetros
- buffer
-
Buffer
O buffer a ser preenchido deve ter um comprimento maior que a contagem
- offset
-
number
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>
Herdado deBlobClient.downloadToBuffer
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 downloadToFile.
function downloadToBuffer(offset?: number, count?: number, options?: BlobDownloadToBufferOptions): Promise<Buffer>
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. Baixará até o final ao passar indefinido
- options
- BlobDownloadToBufferOptions
BlobDownloadToBufferOptions
Retornos
Promise<Buffer>
Herdado deBlobClient.downloadToBuffer
downloadToFile(string, number, number, BlobDownloadOptions)
DISPONÍVEL SOMENTE EM NODE.JS RUNTIME.
Baixa um Blob do Azure em um arquivo local. Falhará se o caminho de arquivo fornecido já for encerrado. Deslocamento e contagem são opcionais, passe 0 e indefinido, respectivamente, para baixar o blob inteiro.
function downloadToFile(filePath: string, offset?: number, count?: number, options?: BlobDownloadOptions): Promise<BlobDownloadResponseParsed>
Parâmetros
- filePath
-
string
- offset
-
number
De qual posição do blob de blocos baixar.
- 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.
Herdado deBlobClient.downloadToFile
exists(BlobExistsOptions)
Retornará true se o recurso de blob do Azure representado por esse cliente existir; caso contrário, false.
OBSERVAÇÃO: use essa função com cuidado, pois um blob existente pode ser excluído por outros clientes ou aplicativos. Vice-versa, novos blobs podem ser adicionados por outros clientes ou aplicativos após a conclusão dessa função.
function exists(options?: BlobExistsOptions): Promise<boolean>
Parâmetros
- options
- BlobExistsOptions
opções para a operação Exists.
Retornos
Promise<boolean>
Herdado deBlobClient.exists
generateSasUrl(BlobGenerateSasUrlOptions)
Disponível somente 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.
Veja https://docs.microsoft.com/en-us/rest/api/storageservices/constructing-a-service-sas
function generateSasUrl(options: BlobGenerateSasUrlOptions): Promise<string>
Parâmetros
- options
- BlobGenerateSasUrlOptions
Parâmetros opcionais.
Retornos
Promise<string>
O URI de SAS que consiste no URI para o recurso representado por esse cliente, seguido pelo token SAS gerado.
Herdado deBlobClient.generateSasUrl
getAppendBlobClient()
Cria um objeto AppendBlobClient.
function getAppendBlobClient(): AppendBlobClient
Retornos
Herdado deBlobClient.getAppendBlobClient
getBlobLeaseClient(string)
Obtenha um BlobLeaseClient que gerencia concessões no blob.
function getBlobLeaseClient(proposeLeaseId?: string): BlobLeaseClient
Parâmetros
- proposeLeaseId
-
string
ID de concessão proposta inicial.
Retornos
Um novo objeto BlobLeaseClient para gerenciar concessões no blob.
Herdado deBlobClient.getBlobLeaseClient
getBlockBlobClient()
Cria um objeto BlockBlobClient.
function getBlockBlobClient(): BlockBlobClient
Retornos
Herdado deBlobClient.getBlockBlobClient
getPageBlobClient()
Cria um objeto PageBlobClient.
function getPageBlobClient(): PageBlobClient
Retornos
Herdado deBlobClient.getPageBlobClient
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.
Veja https://docs.microsoft.com/en-us/rest/api/storageservices/get-blob-properties
AVISO: o metadata
objeto retornado na resposta terá suas chaves em letras minúsculas, mesmo que originalmente contivessem caracteres maiúsculos. Isso é diferente das chaves de metadados retornadas pelos métodos de ContainerClient que listam blobs usando a opção includeMetadata
, que manterá o uso de maiúsculas e minúsculas original.
function getProperties(options?: BlobGetPropertiesOptions): Promise<BlobGetPropertiesResponse>
Parâmetros
- options
- BlobGetPropertiesOptions
Opções opcionais para a operação Obter Propriedades.
Retornos
Promise<BlobGetPropertiesResponse>
Herdado deBlobClient.getProperties
getTags(BlobGetTagsOptions)
Obtém as marcas associadas ao blob subjacente.
function getTags(options?: BlobGetTagsOptions): Promise<BlobGetTagsResponse>
Parâmetros
- options
- BlobGetTagsOptions
Retornos
Promise<BlobGetTagsResponse>
Herdado deBlobClient.getTags
setAccessTier(string, BlobSetTierOptions)
Define a camada em um blob. A operação é permitida em um blob de páginas em uma conta de armazenamento premium e em um blob de blocos em uma conta de armazenamento de blobs (somente armazenamento com redundância local). A camada de um blob de páginas 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 Frequente/Esporádico/Arquivo Morto. Essa operação não atualiza a ETag do blob.
Veja 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 Frequente, Esporádico ou Arquivo Morto.
- options
- BlobSetTierOptions
Opções opcionais para a operação Defina Camada de Blob.
Retornos
Promise<BlobSetTierResponse>
Herdado deBlobClient.setAccessTier
setHTTPHeaders(BlobHTTPHeaders, BlobSetHTTPHeadersOptions)
Define as propriedades do sistema no blob.
Se nenhum valor for fornecido ou nenhum valor fornecido para os cabeçalhos HTTP de blob especificados, esses cabeçalhos HTTP de blob sem um valor serão limpos.
Veja https://docs.microsoft.com/en-us/rest/api/storageservices/set-blob-properties
function setHTTPHeaders(blobHTTPHeaders?: BlobHTTPHeaders, options?: BlobSetHTTPHeadersOptions): Promise<BlobSetHTTPHeadersResponse>
Parâmetros
- blobHTTPHeaders
- BlobHTTPHeaders
Se nenhum valor for fornecido ou nenhum valor fornecido para os cabeçalhos HTTP de blob especificados, esses cabeçalhos HTTP de blob sem um valor serão limpos.
Um cabeçalho comum a ser definido é blobContentType
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 de Blob.
Retornos
Promise<BlobSetHTTPHeadersResponse>
Herdado deBlobClient.setHTTPHeaders
setImmutabilityPolicy(BlobImmutabilityPolicy, BlobSetImmutabilityPolicyOptions)
Defina a política de imutabilidade no blob.
function setImmutabilityPolicy(immutabilityPolicy: BlobImmutabilityPolicy, options?: BlobSetImmutabilityPolicyOptions): Promise<BlobSetImmutabilityPolicyResponse>
Parâmetros
- immutabilityPolicy
- BlobImmutabilityPolicy
- options
- BlobSetImmutabilityPolicyOptions
Opções opcionais para definir a política de imutabilidade no blob.
Retornos
Promise<BlobSetImmutabilityPolicyResponse>
Herdado deBlobClient.setImmutabilityPolicy
setLegalHold(boolean, BlobSetLegalHoldOptions)
Defina a retenção legal no blob.
function setLegalHold(legalHoldEnabled: boolean, options?: BlobSetLegalHoldOptions): Promise<BlobSetLegalHoldResponse>
Parâmetros
- legalHoldEnabled
-
boolean
- options
- BlobSetLegalHoldOptions
Opções opcionais para definir a retenção legal no blob.
Retornos
Promise<BlobSetLegalHoldResponse>
Herdado deBlobClient.setLegalHold
setMetadata(Metadata, BlobSetMetadataOptions)
Define metadados definidos pelo usuário para o blob especificado como um ou mais pares de nome-valor.
Se nenhuma opção for fornecida ou nenhum metadado definido no parâmetro , os metadados do blob serão removidos.
Veja https://docs.microsoft.com/en-us/rest/api/storageservices/set-blob-metadata
function setMetadata(metadata?: Metadata, options?: BlobSetMetadataOptions): Promise<BlobSetMetadataResponse>
Parâmetros
- metadata
- Metadata
Substitua os metadados existentes por esse valor. Se nenhum valor fornecido, os metadados existentes serão removidos.
- options
- BlobSetMetadataOptions
Opções opcionais para definir a operação de metadados.
Retornos
Promise<BlobSetMetadataResponse>
Herdado deBlobClient.setMetadata
setTags(Tags, BlobSetTagsOptions)
Define marcas no blob subjacente. Um blob pode ter até 10 marcas. As teclas de marca devem ter entre 1 e 128 caracteres. Os valores de marca devem ter entre 0 e 256 caracteres. Os caracteres de chave e valor de marca 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 sublinhado ('_') .
function setTags(tags: Tags, options?: BlobSetTagsOptions): Promise<BlobSetTagsResponse>
Parâmetros
- tags
- Tags
- options
- BlobSetTagsOptions
Retornos
Promise<BlobSetTagsResponse>
Herdado deBlobClient.setTags
syncCopyFromURL(string, BlobSyncCopyFromURLOptions)
A operação 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 seja concluída.
Veja https://docs.microsoft.com/en-us/rest/api/storageservices/copy-blob-from-url
function syncCopyFromURL(copySource: string, options?: BlobSyncCopyFromURLOptions): Promise<BlobCopyFromURLResponse>
Parâmetros
- copySource
-
string
A URL de origem da qual copiar, SAS (Assinatura de Acesso Compartilhado) talvez seja necessária para autenticação
- options
- BlobSyncCopyFromURLOptions
Retornos
Promise<BlobCopyFromURLResponse>
Herdado deBlobClient.syncCopyFromURL
undelete(BlobUndeleteOptions)
Restaura o conteúdo e os metadados do blob com exclusão reversível e de todos os instantâneos excluídos temporariamente associados. O blob de exclusão tem suporte apenas na versão 2017-07-29 ou posterior.
Veja 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 Desexcluir Blob.
Retornos
Promise<BlobUndeleteResponse>
Herdado deBlobClient.undelete
withVersion(string)
Cria um novo objeto BlobClient apontando para uma versão desse blob. Forneça "" removerá a versionId e retornará um Cliente para o blob de base.
function withVersion(versionId: string): BlobClient
Parâmetros
- versionId
-
string
A versionId.
Retornos
Um novo objeto BlobClient apontando para a versão desse blob.
Herdado deBlobClient.withVersion