BlockBlobClient class
BlockBlobClient define um conjunto de operações aplicáveis a blobs de blocos.
- Extends
Construtores
Block |
Cria uma instância de BlockBlobClient. Esse método aceita uma URL codificada ou URL não codificada apontando para um blob de blocos. A cadeia de caracteres de URL codificada NÃO será escapada duas vezes, somente caracteres especiais no caminho da URL serão escapados. Se um nome de blob incluir? ou %, o nome do blob deve ser codificado na URL. |
Block |
Cria uma instância de BlockBlobClient. Esse método aceita uma URL codificada ou URL não codificada apontando para um blob de blocos. A cadeia de caracteres de URL codificada NÃO será escapada duas vezes, somente caracteres especiais no caminho da URL serão escapados. Se um nome de blob incluir? ou %, o nome do blob deve ser codificado na URL. |
Block |
Cria uma instância de BlockBlobClient. |
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 pacote |
url | Valor da cadeia de caracteres de URL codificada. |
Métodos
commit |
Grava um blob especificando a lista de IDs de bloco que compõem o blob. Para ser gravado como parte de um blob, um bloco deve ter sido gravado com êxito no servidor em uma operação anterior stageBlock. Você pode chamar commitBlockList para atualizar um blob carregando apenas os blocos que foram alterados e, em seguida, confirmando os blocos novos e existentes juntos. Todos os blocos não especificados na lista de blocos e excluídos permanentemente. Consulte https://docs.microsoft.com/rest/api/storageservices/put-block-list |
get |
Retorna a lista de blocos que foram carregados como parte de um blob de blocos usando o filtro de lista de blocos especificado. Consulte https://docs.microsoft.com/rest/api/storageservices/get-block-list |
query(string, Block |
DISPONÍVEL APENAS EM NODE.JS RUNTIME. Consulta rápida para um blob formatado em JSON ou CSV. Uso de exemplo (Node.js):
|
stage |
Carrega o bloco especificado na "área de preparo" do blob de blocos para ser confirmado posteriormente por uma chamada para commitBlockList. Consulte https://docs.microsoft.com/rest/api/storageservices/put-block |
stage |
A operação de URL Bloco de Estágio cria um novo bloco a ser confirmado como parte de um blob em que o conteúdo é lido de uma URL. Essa API está disponível a partir da versão 2018-03-28. Consulte https://docs.microsoft.com/en-us/rest/api/storageservices/put-block-from-url |
sync |
Cria um novo Blob de Blocos em que o conteúdo do blob é lido de uma determinada URL. Essa API tem suporte a partir da versão 2020-04-08. Não há suporte para atualizações parciais com o Put Blob da URL; o conteúdo de um blob existente é substituído com o conteúdo do novo blob. Para executar atualizações parciais no conteúdo de um blob de blocos usando uma URL de origem, use stageBlockFromURL e commitBlockList. |
upload(Request |
Cria um novo blob de blocos ou atualiza o conteúdo de um blob de blocos existente. A atualização de um blob de blocos existente substitui todos os metadados existentes no blob. Não há suporte para atualizações parciais; o conteúdo do blob existente é substituído com o novo conteúdo. Para executar uma atualização parcial de um blob de blocos, use stageBlock e commitBlockList. Esse é um método de carregamento não paralelo, use uploadFile, uploadStream ou uploadBrowserData para melhorar o desempenho com o carregamento de simultaneidade. Consulte https://docs.microsoft.com/rest/api/storageservices/put-blob |
upload |
DISPONÍVEL SOMENTE EM NAVEGADORES. Carrega um objeto Blob/File/ArrayBuffer/ArrayBufferView do navegador para bloquear o blob. Quando o tamanho do buffer for menor ou igual a 256 MB, esse método usará uma chamada de upload para concluir o upload. Caso contrário, esse método chamará stageBlock para carregar blocos e, por fim, chamará commitBlockList para confirmar a lista de blocos. Uma opção comum blobHTTPHeaders a ser definida é |
upload |
Carrega um objeto Buffer(Node.js)/Blob(browsers)/ArrayBuffer/ArrayBufferView em um BlockBlob. Quando o comprimento dos dados não for mais do que o maxSingleShotSize especificado (o padrão é <xref:BLOCK_BLOB_MAX_UPLOAD_BLOB_BYTES>), esse método usará 1 carregar chamada para concluir o upload. Caso contrário, esse método chamará stageBlock para carregar blocos e, por fim, chamará commitBlockList para confirmar a lista de blocos. Uma opção comum blobHTTPHeaders a ser definida é |
upload |
DISPONÍVEL APENAS EM NODE.JS RUNTIME. Carrega um arquivo local em blocos para um blob de blocos. Quando o tamanho do arquivo for menor ou igual a 256 MB, esse método usará uma chamada de upload para concluir o upload. Caso contrário, esse método chamará stageBlock para carregar blocos e, por fim, chamará commitBlockList para confirmar a lista de blocos. |
upload |
DISPONÍVEL APENAS EM NODE.JS RUNTIME. Carrega um fluxo legível Node.js no blob de blocos. DICAS DE MELHORIA DE DESEMPENHO:
|
with |
Cria um novo objeto BlockBlobClient idêntico à origem, mas com o carimbo de data/hora de instantâneo especificado. Forneça "" removerá o instantâneo e retornará uma URL para o blob base. |
Métodos herdados
abort |
Anula uma operação de Blob de Cópia assíncrona pendente e deixa um blob de destino com comprimento zero e metadados completos. Versão 2012-02-12 e mais recente. Consulte 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 poller de operação de execução longa que permite que você aguarde indefinidamente até que a cópia seja concluída.
Você também pode cancelar uma cópia antes que ela seja concluída chamando Na versão 2012-02-12 e posterior, a origem de uma operação de Blob de Cópia pode ser um blob confirmado em qualquer conta de armazenamento do Azure. A partir da versão 2015-02-21, a origem de uma operação de Blob de Cópia pode ser um arquivo do Azure em qualquer conta de armazenamento do Azure. Somente contas de armazenamento criadas em ou após 7 de junho de 2012 permitem que a operação Copiar Blob copie de outra conta de armazenamento. Consulte 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 alterado (padrão de 15 segundos):
Exemplo usando o cancelamento de cópia:
|
create |
Cria um instantâneo somente leitura de um blob. Consulte 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 é posteriormente excluído durante a coleta de lixo. Observe que, para excluir um blob, você deve excluir todos os seus instantâneos. Você pode excluir ambos ao mesmo tempo com a operação Excluir Blob. Consulte https://docs.microsoft.com/en-us/rest/api/storageservices/delete-blob |
delete |
Marca o blob ou instantâneo especificado para exclusão se ele existir. O blob é posteriormente excluído durante a coleta de lixo. Observe que, para excluir um blob, você deve excluir todos os seus instantâneos. Você pode excluir ambos ao mesmo tempo com a operação Excluir Blob. Consulte https://docs.microsoft.com/en-us/rest/api/storageservices/delete-blob |
delete |
Exclua a política de immutablility no blob. |
download(number, number, Blob |
Lê ou baixa um blob do sistema, incluindo seus metadados e propriedades. Você também pode chamar Get Blob para ler um instantâneo.
Consulte https://docs.microsoft.com/en-us/rest/api/storageservices/get-blob |
download |
DISPONÍVEL APENAS EM NODE.JS RUNTIME. Baixa um Blob do Azure em paralelo a um buffer. Deslocamento e contagem são opcionais, baixa todo o blob se eles não forem fornecidos. Aviso: os buffers só podem dar suporte a arquivos de até um gigabyte em sistemas de 32 bits ou cerca de dois gigabytes em sistemas de 64 bits devido a limitações de Node.js/V8. Para blobs maiores que esse tamanho, considere downloadToFile. |
download |
DISPONÍVEL APENAS EM NODE.JS RUNTIME. Baixa um Blob do Azure em paralelo a um buffer. Deslocamento e contagem são opcionais, baixa todo o blob se eles não forem fornecidos. Aviso: os buffers só podem dar suporte a arquivos de até um gigabyte em sistemas de 32 bits ou cerca de dois gigabytes em sistemas de 64 bits devido a limitações de Node.js/V8. Para blobs maiores que esse tamanho, considere downloadToFile. |
download |
DISPONÍVEL APENAS EM NODE.JS RUNTIME. Baixa um Blob do Azure em um arquivo local. Falhará se o caminho de arquivo fornecido já for encerrado. Deslocamento e contagem são opcionais, passam 0 e indefinidos, respectivamente, para baixar o blob inteiro. |
exists(Blob |
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. |
generate |
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. Consulte https://docs.microsoft.com/en-us/rest/api/storageservices/constructing-a-service-sas |
get |
A operação Obter Informações da Conta retorna o nome do sku e o tipo de conta da conta especificada. A operação Obter Informações da Conta está disponível em versões de serviço a partir da versão 2018-03-28. Consulte https://docs.microsoft.com/en-us/rest/api/storageservices/get-account-information |
get |
Cria um objeto AppendBlobClient. |
get |
Obtenha um blobLeaseClient |
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. Ele não retorna o conteúdo do blob. Consulte https://docs.microsoft.com/en-us/rest/api/storageservices/get-blob-properties AVISO: O objeto |
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ágina premium determina o tamanho permitido, o IOPS e a largura de banda do blob. A camada de um blob de blocos determina o tipo de armazenamento Hot/Cool/Archive. Essa operação não atualiza a ETag do blob. Consulte 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. Consulte 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 nome-valor. Se nenhuma opção for fornecida ou nenhum metadados definido no parâmetro, os metadados de blob serão removidos. Consulte 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. Caracteres válidos de chave de marca e valor incluem letras minúsculas e maiúsculas, dígitos (0-9), espaço (' '), mais ('+'), menos ('-'), ponto ('.'), barra ('/'), dois-pontos (':'), iguais ('=') e sublinhado ('_') . |
sync |
A operação de CÓPIA Síncrona da URL copia um blob ou um recurso da Internet para um novo blob. Ele não retornará uma resposta até que a cópia seja concluída. Consulte https://docs.microsoft.com/en-us/rest/api/storageservices/copy-blob-from-url |
undelete(Blob |
Restaura o conteúdo e os metadados do blob de exclusão reversível e de todos os instantâneos de exclusão reversível associados. Há suporte para o Undelete Blob somente na versão 2017-07-29 ou posterior. Consulte 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 base. |
Detalhes do construtor
BlockBlobClient(string, PipelineLike)
Cria uma instância de BlockBlobClient. Esse método aceita uma URL codificada ou URL não codificada apontando para um blob de blocos. A cadeia de caracteres de URL codificada NÃO será escapada duas vezes, somente caracteres especiais no caminho da URL serão escapados. Se um nome de blob incluir? ou %, o nome do blob deve ser codificado na URL.
new BlockBlobClient(url: string, pipeline: PipelineLike)
Parâmetros
- url
-
string
Uma cadeia de caracteres de URL apontando para o blob de blocos do Armazenamento do Azure, como "https://myaccount.blob.core.windows.net/mycontainer/blockblob". Você pode acrescentar uma SAS se estiver usando AnonymousCredential, como "https://myaccount.blob.core.windows.net/mycontainer/blockblob?sasString". Esse método aceita uma URL codificada ou UMA URL não codificada apontando para um blob. A cadeia de caracteres de URL codificada NÃO será escapada duas vezes, somente caracteres especiais no caminho da URL serão escapados. No entanto, se um nome de blob incluir? ou %, o nome do blob deve ser codificado na URL. Como um blob chamado "my?blob%", a URL deve ser "https://myaccount.blob.core.windows.net/mycontainer/my%3Fblob%25".
- pipeline
- PipelineLike
Chame newPipeline() para criar um pipeline padrão ou forneça um pipeline personalizado.
BlockBlobClient(string, StorageSharedKeyCredential | AnonymousCredential | TokenCredential, StoragePipelineOptions)
Cria uma instância de BlockBlobClient. Esse método aceita uma URL codificada ou URL não codificada apontando para um blob de blocos. A cadeia de caracteres de URL codificada NÃO será escapada duas vezes, somente caracteres especiais no caminho da URL serão escapados. Se um nome de blob incluir? ou %, o nome do blob deve ser codificado na URL.
new BlockBlobClient(url: string, credential?: StorageSharedKeyCredential | AnonymousCredential | TokenCredential, options?: StoragePipelineOptions)
Parâmetros
- url
-
string
Uma cadeia de caracteres de URL apontando para o blob de blocos do Armazenamento do Azure, como "https://myaccount.blob.core.windows.net/mycontainer/blockblob". Você pode acrescentar uma SAS se estiver usando AnonymousCredential, como "https://myaccount.blob.core.windows.net/mycontainer/blockblob?sasString". Esse método aceita uma URL codificada ou UMA URL não codificada apontando para um blob. A cadeia de caracteres de URL codificada NÃO será escapada duas vezes, somente caracteres especiais no caminho da URL serão escapados. No entanto, se um nome de blob incluir? ou %, o nome do blob deve ser codificado na URL. Como um blob chamado "my?blob%", a URL deve ser "https://myaccount.blob.core.windows.net/mycontainer/my%3Fblob%25".
- credential
-
StorageSharedKeyCredential | AnonymousCredential | TokenCredential
Como AnonymousCredential, StorageSharedKeyCredential ou qualquer credencial do pacote @azure/identity
para autenticar solicitações para o serviço. Você também pode fornecer um objeto que implementa a interface TokenCredential. Se não for especificado, AnonymousCredential será usado.
- options
- StoragePipelineOptions
Opcional. Opções para configurar o pipeline HTTP.
BlockBlobClient(string, string, string, StoragePipelineOptions)
Cria uma instância de BlockBlobClient.
new BlockBlobClient(connectionString: string, containerName: string, blobName: string, options?: StoragePipelineOptions)
Parâmetros
- connectionString
-
string
Cadeia de conexão de conta ou uma cadeia de conexão SAS de uma conta de armazenamento do Azure.
[ Observação - A cadeia de conexão da conta só pode ser usada em NODE.JS runtime. ] Exemplo de cadeia de conexão da conta –
DefaultEndpointsProtocol=https;AccountName=myaccount;AccountKey=accountKey;EndpointSuffix=core.windows.net
exemplo de cadeia de conexão SAS – BlobEndpoint=https://myaccount.blob.core.windows.net/;QueueEndpoint=https://myaccount.queue.core.windows.net/;FileEndpoint=https://myaccount.file.core.windows.net/;TableEndpoint=https://myaccount.table.core.windows.net/;SharedAccessSignature=sasString
- containerName
-
string
Nome do contêiner.
- blobName
-
string
Nome do blob.
- options
- StoragePipelineOptions
Opcional. Opções para configurar o pipeline HTTP.
Detalhes da propriedade
containerName
O nome do contêiner de armazenamento ao qual o blob está associado.
string containerName
Valor da propriedade
string
name
O nome do blob.
string name
Valor da propriedade
string
Detalhes das propriedades herdadas
accountName
credential
Como AnonymousCredential, StorageSharedKeyCredential ou qualquer credencial do pacote @azure/identity
para autenticar solicitações para o serviço. Você também pode fornecer um objeto que implementa a interface TokenCredential. Se não for especificado, AnonymousCredential será usado.
credential: StorageSharedKeyCredential | AnonymousCredential | TokenCredential
Valor da propriedade
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
commitBlockList(string[], BlockBlobCommitBlockListOptions)
Grava um blob especificando a lista de IDs de bloco que compõem o blob. Para ser gravado como parte de um blob, um bloco deve ter sido gravado com êxito no servidor em uma operação anterior stageBlock. Você pode chamar commitBlockList para atualizar um blob carregando apenas os blocos que foram alterados e, em seguida, confirmando os blocos novos e existentes juntos. Todos os blocos não especificados na lista de blocos e excluídos permanentemente.
Consulte https://docs.microsoft.com/rest/api/storageservices/put-block-list
function commitBlockList(blocks: string[], options?: BlockBlobCommitBlockListOptions): Promise<BlockBlobCommitBlockListResponse>
Parâmetros
- blocks
-
string[]
Matriz de valor de 64 bytes codificado em base64
- options
- BlockBlobCommitBlockListOptions
Opções para a operação Lista de Blocos de Confirmação de Blob de Blocos.
Retornos
Promise<BlockBlobCommitBlockListResponse>
Dados de resposta para a operação Lista de Blocos de Confirmação de Blobs de Blocos.
getBlockList(BlockListType, BlockBlobGetBlockListOptions)
Retorna a lista de blocos que foram carregados como parte de um blob de blocos usando o filtro de lista de blocos especificado.
Consulte https://docs.microsoft.com/rest/api/storageservices/get-block-list
function getBlockList(listType: BlockListType, options?: BlockBlobGetBlockListOptions): Promise<BlockBlobGetBlockListResponse>
Parâmetros
- listType
- BlockListType
Especifica se a lista de blocos confirmados deve ser retornada, a lista de blocos não confirmados ou ambas as listas juntas.
- options
- BlockBlobGetBlockListOptions
Opções para a operação Obter Lista de Blocos do Blob de Blocos.
Retornos
Promise<BlockBlobGetBlockListResponse>
Dados de resposta para a operação Lista de Bloqueios de Obtenção de Blobs de Blocos.
query(string, BlockBlobQueryOptions)
DISPONÍVEL APENAS EM NODE.JS RUNTIME.
Consulta rápida para um blob formatado em JSON ou CSV.
Uso de exemplo (Node.js):
// Query and convert a blob to a string
const queryBlockBlobResponse = await blockBlobClient.query("select * from BlobStorage");
const downloaded = (await streamToBuffer(queryBlockBlobResponse.readableStreamBody)).toString();
console.log("Query blob content:", downloaded);
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);
});
}
function query(query: string, options?: BlockBlobQueryOptions): Promise<BlobDownloadResponseModel>
Parâmetros
- query
-
string
- options
- BlockBlobQueryOptions
Retornos
Promise<BlobDownloadResponseModel>
stageBlock(string, RequestBodyType, number, BlockBlobStageBlockOptions)
Carrega o bloco especificado na "área de preparo" do blob de blocos para ser confirmado posteriormente por uma chamada para commitBlockList.
Consulte https://docs.microsoft.com/rest/api/storageservices/put-block
function stageBlock(blockId: string, body: RequestBodyType, contentLength: number, options?: BlockBlobStageBlockOptions): Promise<BlockBlobStageBlockResponse>
Parâmetros
- blockId
-
string
Um valor de 64 bytes codificado em base64
- body
- HttpRequestBody
Dados a serem carregados na área de preparo.
- contentLength
-
number
Número de bytes a serem carregados.
- options
- BlockBlobStageBlockOptions
Opções para a operação Bloquear Bloco de Estágio de Blob.
Retornos
Promise<BlockBlobStageBlockResponse>
Dados de resposta para a operação Bloquear Bloco de Estágio de Blob.
stageBlockFromURL(string, string, number, number, BlockBlobStageBlockFromURLOptions)
A operação de URL Bloco de Estágio cria um novo bloco a ser confirmado como parte de um blob em que o conteúdo é lido de uma URL. Essa API está disponível a partir da versão 2018-03-28.
Consulte https://docs.microsoft.com/en-us/rest/api/storageservices/put-block-from-url
function stageBlockFromURL(blockId: string, sourceURL: string, offset?: number, count?: number, options?: BlockBlobStageBlockFromURLOptions): Promise<BlockBlobStageBlockFromURLResponse>
Parâmetros
- blockId
-
string
Um valor de 64 bytes codificado em base64
- sourceURL
-
string
Especifica a URL do blob. O valor pode ser uma URL de até 2 KB de comprimento que especifica um blob. O valor deve ser codificado em URL como seria exibido em um URI de solicitação. O blob de origem deve 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. Aqui estão alguns exemplos de URLs de objeto de origem: - https://myaccount.blob.core.windows.net/mycontainer/myblob - https://myaccount.blob.core.windows.net/mycontainer/myblob?snapshot=
- offset
-
number
A partir da qual a posição do blob será baixada, maior ou igual a 0
- count
-
number
Quantos dados serão baixados, maior que 0. Será baixado até o final quando indefinido
Opções para a operação bloquear o bloco de estágio de blob da operação de URL.
Retornos
Promise<BlockBlobStageBlockFromURLResponse>
Dados de resposta para a operação bloquear o bloco de estágio de blob da operação de URL.
syncUploadFromURL(string, BlockBlobSyncUploadFromURLOptions)
Cria um novo Blob de Blocos em que o conteúdo do blob é lido de uma determinada URL. Essa API tem suporte a partir da versão 2020-04-08. Não há suporte para atualizações parciais com o Put Blob da URL; o conteúdo de um blob existente é substituído com o conteúdo do novo blob. Para executar atualizações parciais no conteúdo de um blob de blocos usando uma URL de origem, use stageBlockFromURL e commitBlockList.
function syncUploadFromURL(sourceURL: string, options?: BlockBlobSyncUploadFromURLOptions): Promise<BlockBlobPutBlobFromUrlResponse>
Parâmetros
- sourceURL
-
string
Especifica a URL do blob. O valor pode ser uma URL de até 2 KB de comprimento que especifica um blob. O valor deve ser codificado em URL como seria exibido em um URI de solicitação. O blob de origem deve 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. Aqui estão alguns exemplos de URLs de objeto de origem: - https://myaccount.blob.core.windows.net/mycontainer/myblob - https://myaccount.blob.core.windows.net/mycontainer/myblob?snapshot=
Parâmetros opcionais.
Retornos
Promise<BlockBlobPutBlobFromUrlResponse>
upload(RequestBodyType, number, BlockBlobUploadOptions)
Cria um novo blob de blocos ou atualiza o conteúdo de um blob de blocos existente. A atualização de um blob de blocos existente substitui todos os metadados existentes no blob. Não há suporte para atualizações parciais; o conteúdo do blob existente é substituído com o novo conteúdo. Para executar uma atualização parcial de um blob de blocos, use stageBlock e commitBlockList.
Esse é um método de carregamento não paralelo, use uploadFile, uploadStream ou uploadBrowserData para melhorar o desempenho com o carregamento de simultaneidade.
Consulte https://docs.microsoft.com/rest/api/storageservices/put-blob
function upload(body: RequestBodyType, contentLength: number, options?: BlockBlobUploadOptions): Promise<BlockBlobUploadResponse>
Parâmetros
- body
- HttpRequestBody
Blob, cadeia de caracteres, ArrayBuffer, ArrayBufferView ou uma função que retorna um novo fluxo legível cujo deslocamento é do início da fonte de dados.
- contentLength
-
number
Comprimento do corpo em bytes. Use Buffer.byteLength() para calcular o tamanho do corpo de uma cadeia de caracteres, incluindo caracteres não codificados em Base64/Hex.
- options
- BlockBlobUploadOptions
Opções para a operação de Carregamento de Blobs de Blocos.
Retornos
Promise<BlockBlobUploadResponse>
Dados de resposta para a operação de Carregamento de Blobs de Blocos.
Uso de exemplo:
const content = "Hello world!";
const uploadBlobResponse = await blockBlobClient.upload(content, content.length);
uploadBrowserData(Blob | ArrayBuffer | ArrayBufferView, BlockBlobParallelUploadOptions)
DISPONÍVEL SOMENTE EM NAVEGADORES.
Carrega um objeto Blob/File/ArrayBuffer/ArrayBufferView do navegador para bloquear o blob.
Quando o tamanho do buffer for menor ou igual a 256 MB, esse método usará uma chamada de upload para concluir o upload. Caso contrário, esse método chamará stageBlock para carregar blocos e, por fim, chamará commitBlockList para confirmar a lista de blocos.
Uma opção comum blobHTTPHeaders a ser definida é blobContentType
, permitindo que o navegador forneça funcionalidade com base no tipo de arquivo.
function uploadBrowserData(browserData: Blob | ArrayBuffer | ArrayBufferView, options?: BlockBlobParallelUploadOptions): Promise<BlobUploadCommonResponse>
Parâmetros
- browserData
-
Blob | ArrayBuffer | ArrayBufferView
Blob, Arquivo, ArrayBuffer ou ArrayBufferView
- options
- BlockBlobParallelUploadOptions
Opções para carregar dados do navegador.
Retornos
Promise<BlobUploadCommonResponse>
Dados de resposta para a operação de Carregamento de Blobs.
uploadData(Blob | ArrayBuffer | ArrayBufferView | Buffer, BlockBlobParallelUploadOptions)
Carrega um objeto Buffer(Node.js)/Blob(browsers)/ArrayBuffer/ArrayBufferView em um BlockBlob.
Quando o comprimento dos dados não for mais do que o maxSingleShotSize especificado (o padrão é <xref:BLOCK_BLOB_MAX_UPLOAD_BLOB_BYTES>), esse método usará 1 carregar chamada para concluir o upload. Caso contrário, esse método chamará stageBlock para carregar blocos e, por fim, chamará commitBlockList para confirmar a lista de blocos.
Uma opção comum blobHTTPHeaders a ser definida é blobContentType
, permitindo que o navegador forneça funcionalidade com base no tipo de arquivo.
function uploadData(data: Blob | ArrayBuffer | ArrayBufferView | Buffer, options?: BlockBlobParallelUploadOptions): Promise<BlobUploadCommonResponse>
Parâmetros
- data
-
Blob | ArrayBuffer | ArrayBufferView | Buffer
Buffer(Node.js), Blob, ArrayBuffer ou ArrayBufferView
- options
- BlockBlobParallelUploadOptions
Retornos
Promise<BlobUploadCommonResponse>
uploadFile(string, BlockBlobParallelUploadOptions)
DISPONÍVEL APENAS EM NODE.JS RUNTIME.
Carrega um arquivo local em blocos para um blob de blocos.
Quando o tamanho do arquivo for menor ou igual a 256 MB, esse método usará uma chamada de upload para concluir o upload. Caso contrário, esse método chamará stageBlock para carregar blocos e, por fim, chamará commitBlockList para confirmar a lista de blocos.
function uploadFile(filePath: string, options?: BlockBlobParallelUploadOptions): Promise<BlobUploadCommonResponse>
Parâmetros
- filePath
-
string
Caminho completo do arquivo local
- options
- BlockBlobParallelUploadOptions
Opções para carregar na operação de blob de blocos.
Retornos
Promise<BlobUploadCommonResponse>
Dados de resposta para a operação de Carregamento de Blobs.
uploadStream(Readable, number, number, BlockBlobUploadStreamOptions)
DISPONÍVEL APENAS EM NODE.JS RUNTIME.
Carrega um fluxo legível Node.js no blob de blocos.
DICAS DE MELHORIA DE DESEMPENHO:
- O fluxo de entrada highWaterMark é melhor definir um mesmo valor com o parâmetro bufferSize, o que evitará operações buffer.concat().
function uploadStream(stream: Readable, bufferSize?: number, maxConcurrency?: number, options?: BlockBlobUploadStreamOptions): Promise<BlobUploadCommonResponse>
Parâmetros
- stream
-
Readable
Node.js fluxo legível
- bufferSize
-
number
Tamanho de cada buffer alocado, também o tamanho do bloco no blob de blocos carregado. O valor padrão é 8 MB
- maxConcurrency
-
number
A simultaneidade máxima indica o número máximo de buffers que podem ser alocados, correlação positiva com simultaneidade máxima de upload. O valor padrão é 5
- options
- BlockBlobUploadStreamOptions
Opções para carregar o Fluxo para bloquear a operação blob.
Retornos
Promise<BlobUploadCommonResponse>
Dados de resposta para a operação de Carregamento de Blobs.
withSnapshot(string)
Cria um novo objeto BlockBlobClient idêntico à origem, mas com o carimbo de data/hora de instantâneo especificado. Forneça "" removerá o instantâneo e retornará uma URL para o blob base.
function withSnapshot(snapshot: string): BlockBlobClient
Parâmetros
- snapshot
-
string
O carimbo de data/hora do instantâneo.
Retornos
Um novo objeto BlockBlobClient idêntico à origem, mas com o carimbo de data/hora de instantâneo especificado.
Detalhes do método herdado
abortCopyFromURL(string, BlobAbortCopyFromURLOptions)
Anula uma operação de Blob de Cópia assíncrona pendente e deixa um blob de destino com comprimento zero e metadados completos. Versão 2012-02-12 e mais recente.
Consulte https://docs.microsoft.com/en-us/rest/api/storageservices/abort-copy-blob
function abortCopyFromURL(copyId: string, options?: BlobAbortCopyFromURLOptions): Promise<BlobAbortCopyFromURLResponse>
Parâmetros
- copyId
-
string
ID da operação copiar da URL.
- options
- BlobAbortCopyFromURLOptions
Opções opcionais para a operação Desativar Cópia da URL do Blob.
Retornos
Promise<BlobAbortCopyFromURLResponse>
beginCopyFromURL(string, BlobBeginCopyFromURLOptions)
Copia de forma assíncrona um blob para um destino dentro da conta de armazenamento.
Esse método retorna um poller de operação de execução longa que permite que você aguarde indefinidamente até que a cópia seja concluída.
Você também pode cancelar uma cópia antes que ela seja concluída chamando cancelOperation
no poller.
Observe que o retorno de chamada onProgress não será invocado se a operação for concluída na primeira solicitação e a tentativa de cancelar uma cópia concluída resultará em um erro sendo gerado.
Na versão 2012-02-12 e posterior, a origem de uma operação de Blob de Cópia pode ser um blob confirmado em qualquer conta de armazenamento do Azure. A partir da versão 2015-02-21, a origem de uma operação de Blob de Cópia pode ser um arquivo do Azure em qualquer conta de armazenamento do Azure. Somente contas de armazenamento criadas em ou após 7 de junho de 2012 permitem que a operação Copiar Blob copie de outra conta de armazenamento.
Consulte https://docs.microsoft.com/en-us/rest/api/storageservices/copy-blob
Exemplo usando sondagem automática:
const copyPoller = await blobClient.beginCopyFromURL('url');
const result = await copyPoller.pollUntilDone();
Exemplo usando sondagem manual:
const copyPoller = await blobClient.beginCopyFromURL('url');
while (!poller.isDone()) {
await poller.poll();
}
const result = copyPoller.getResult();
Exemplo usando atualizações de progresso:
const copyPoller = await blobClient.beginCopyFromURL('url', {
onProgress(state) {
console.log(`Progress: ${state.copyProgress}`);
}
});
const result = await copyPoller.pollUntilDone();
Exemplo usando um intervalo de sondagem alterado (padrão de 15 segundos):
const copyPoller = await blobClient.beginCopyFromURL('url', {
intervalInMs: 1000 // poll blob every 1 second for copy progress
});
const result = await copyPoller.pollUntilDone();
Exemplo usando o cancelamento de cópia:
const copyPoller = await blobClient.beginCopyFromURL('url');
// cancel operation after starting it.
try {
await copyPoller.cancelOperation();
// calls to get the result now throw PollerCancelledError
await copyPoller.getResult();
} catch (err) {
if (err.name === 'PollerCancelledError') {
console.log('The copy was cancelled.');
}
}
function beginCopyFromURL(copySource: string, options?: BlobBeginCopyFromURLOptions): Promise<PollerLikeWithCancellation<PollOperationState<BlobBeginCopyFromURLResponse>, BlobBeginCopyFromURLResponse>>
Parâmetros
- copySource
-
string
url para o Blob/Arquivo do Azure de origem.
- options
- BlobBeginCopyFromURLOptions
Opções opcionais para a operação de URL Iniciar Cópia do Blob.
Retornos
Promise<PollerLikeWithCancellation<PollOperationState<BlobBeginCopyFromURLResponse>, BlobBeginCopyFromURLResponse>>
Herdado deBlobClient.beginCopyFromURL
createSnapshot(BlobCreateSnapshotOptions)
Cria um instantâneo somente leitura de um blob.
Consulte https://docs.microsoft.com/en-us/rest/api/storageservices/snapshot-blob
function createSnapshot(options?: BlobCreateSnapshotOptions): Promise<BlobCreateSnapshotResponse>
Parâmetros
- options
- BlobCreateSnapshotOptions
Opções opcionais para a operação Criar Instantâneo de Blob.
Retornos
Promise<BlobCreateSnapshotResponse>
herdado deblobClient.createSnapshot
delete(BlobDeleteOptions)
Marca o blob ou instantâneo especificado para exclusão. O blob é posteriormente excluído durante a coleta de lixo. Observe que, para excluir um blob, você deve excluir todos os seus instantâneos. Você pode excluir ambos ao mesmo tempo com a operação Excluir Blob.
Consulte https://docs.microsoft.com/en-us/rest/api/storageservices/delete-blob
function delete(options?: BlobDeleteOptions): Promise<BlobDeleteResponse>
Parâmetros
- options
- BlobDeleteOptions
Opções opcionais para a operação de Exclusão de Blobs.
Retornos
Promise<BlobDeleteResponse>
deleteIfExists(BlobDeleteOptions)
Marca o blob ou instantâneo especificado para exclusão se ele existir. O blob é posteriormente excluído durante a coleta de lixo. Observe que, para excluir um blob, você deve excluir todos os seus instantâneos. Você pode excluir ambos ao mesmo tempo com a operação Excluir Blob.
Consulte https://docs.microsoft.com/en-us/rest/api/storageservices/delete-blob
function deleteIfExists(options?: BlobDeleteOptions): Promise<BlobDeleteIfExistsResponse>
Parâmetros
- options
- BlobDeleteOptions
Opções opcionais para a operação de Exclusão de Blobs.
Retornos
Promise<BlobDeleteIfExistsResponse>
herdado deBlobClient.deleteIfExists
deleteImmutabilityPolicy(BlobDeleteImmutabilityPolicyOptions)
Exclua a política de immutablility no blob.
function deleteImmutabilityPolicy(options?: BlobDeleteImmutabilityPolicyOptions): Promise<BlobDeleteImmutabilityPolicyResponse>
Parâmetros
Opções opcionais para excluir a política de imutabilidade no blob.
Retornos
Promise<BlobDeleteImmutabilityPolicyResponse>
Herdado deBlobClient.deleteImmutabilityPolicy
download(number, number, BlobDownloadOptions)
Lê ou baixa um blob do sistema, incluindo seus metadados e propriedades. Você também pode chamar Get Blob para ler um instantâneo.
- Em Node.js, os dados retornam em um fluxo legível readableStreamBody
- Em navegadores, os dados retornam em um blobBody de promessa
Consulte https://docs.microsoft.com/en-us/rest/api/storageservices/get-blob
function download(offset?: number, count?: number, options?: BlobDownloadOptions): Promise<BlobDownloadResponseParsed>
Parâmetros
- offset
-
number
A partir da qual a posição do blob será baixada, maior ou igual a 0
- count
-
number
Quantos dados serão baixados, maior que 0. Será baixado até o final quando indefinido
- options
- BlobDownloadOptions
Opções opcionais para a operação de Download de Blobs.
Uso de exemplo (Node.js):
// Download and convert a blob to a string
const downloadBlockBlobResponse = await blobClient.download();
const downloaded = await streamToBuffer(downloadBlockBlobResponse.readableStreamBody);
console.log("Downloaded blob content:", downloaded.toString());
async function streamToBuffer(readableStream) {
return new Promise((resolve, reject) => {
const chunks = [];
readableStream.on("data", (data) => {
chunks.push(data instanceof Buffer ? data : Buffer.from(data));
});
readableStream.on("end", () => {
resolve(Buffer.concat(chunks));
});
readableStream.on("error", reject);
});
}
Uso de exemplo (navegador):
// Download and convert a blob to a string
const downloadBlockBlobResponse = await blobClient.download();
const downloaded = await blobToString(await downloadBlockBlobResponse.blobBody);
console.log(
"Downloaded blob content",
downloaded
);
async function blobToString(blob: Blob): Promise<string> {
const fileReader = new FileReader();
return new Promise<string>((resolve, reject) => {
fileReader.onloadend = (ev: any) => {
resolve(ev.target!.result);
};
fileReader.onerror = reject;
fileReader.readAsText(blob);
});
}
Retornos
Promise<BlobDownloadResponseParsed>
Herdado deBlobClient.download
downloadToBuffer(Buffer, number, number, BlobDownloadToBufferOptions)
DISPONÍVEL APENAS EM NODE.JS RUNTIME.
Baixa um Blob do Azure em paralelo a um buffer. Deslocamento e contagem são opcionais, baixa todo o blob se eles não forem fornecidos.
Aviso: os buffers só podem dar suporte a arquivos de até um gigabyte em sistemas de 32 bits ou cerca de dois gigabytes em sistemas de 64 bits devido a limitações de Node.js/V8. Para blobs maiores que esse tamanho, considere downloadToFile.
function downloadToBuffer(buffer: Buffer, offset?: number, count?: number, options?: BlobDownloadToBufferOptions): Promise<Buffer>
Parâmetros
- buffer
-
Buffer
O buffer a ser preenchido deve ter um comprimento maior que a contagem
- offset
-
number
De qual posição do blob de blocos será baixado(em bytes)
- count
-
number
Quantos dados(em bytes) serão baixados. Será baixado até o final ao passar indefinido
- options
- BlobDownloadToBufferOptions
BlobDownloadToBufferOptions
Retornos
Promise<Buffer>
Herdado deBlobClient.downloadToBuffer
downloadToBuffer(number, number, BlobDownloadToBufferOptions)
DISPONÍVEL APENAS EM NODE.JS RUNTIME.
Baixa um Blob do Azure em paralelo a um buffer. Deslocamento e contagem são opcionais, baixa todo o blob se eles não forem fornecidos.
Aviso: os buffers só podem dar suporte a arquivos de até um gigabyte em sistemas de 32 bits ou cerca de dois gigabytes em sistemas de 64 bits devido a limitações de Node.js/V8. Para blobs maiores que esse tamanho, considere downloadToFile.
function downloadToBuffer(offset?: number, count?: number, options?: BlobDownloadToBufferOptions): Promise<Buffer>
Parâmetros
- offset
-
number
De qual posição do blob de blocos será baixado(em bytes)
- count
-
number
Quantos dados(em bytes) serão baixados. Será baixado até o final ao passar indefinido
- options
- BlobDownloadToBufferOptions
BlobDownloadToBufferOptions
Retornos
Promise<Buffer>
Herdado deBlobClient.downloadToBuffer
downloadToFile(string, number, number, BlobDownloadOptions)
DISPONÍVEL APENAS EM NODE.JS RUNTIME.
Baixa um Blob do Azure em um arquivo local. Falhará se o caminho de arquivo fornecido já for encerrado. Deslocamento e contagem são opcionais, passam 0 e indefinidos, respectivamente, para baixar o blob inteiro.
function downloadToFile(filePath: string, offset?: number, count?: number, options?: BlobDownloadOptions): Promise<BlobDownloadResponseParsed>
Parâmetros
- filePath
-
string
- offset
-
number
De qual posição do blob de blocos será baixado.
- count
-
number
Quantos dados serão baixados. Será baixado até o final ao passar indefinido.
- options
- BlobDownloadOptions
Opções para opções de download de Blob.
Retornos
Promise<BlobDownloadResponseParsed>
Os dados de resposta para a operação de download de blob, mas com readableStreamBody definido como indefinido, pois seu conteúdo já é lido e gravado em um arquivo local no caminho especificado.
Herdado deBlobClient.downloadToFile
exists(BlobExistsOptions)
Retornará true se o recurso de blob do Azure representado por esse cliente existir; false caso contrário.
OBSERVAÇÃO: use essa função com cuidado, pois um blob existente pode ser excluído por outros clientes ou aplicativos. Vice-versa, novos blobs podem ser adicionados por outros clientes ou aplicativos após a conclusão dessa função.
function exists(options?: BlobExistsOptions): Promise<boolean>
Parâmetros
- options
- BlobExistsOptions
opções para a operação Exists.
Retornos
Promise<boolean>
Herdado deBlobClient.exists
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.
Consulte 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
getAccountInfo(BlobGetAccountInfoOptions)
A operação Obter Informações da Conta retorna o nome do sku e o tipo de conta da conta especificada. A operação Obter Informações da Conta está disponível em versões de serviço a partir da versão 2018-03-28.
Consulte https://docs.microsoft.com/en-us/rest/api/storageservices/get-account-information
function getAccountInfo(options?: BlobGetAccountInfoOptions): Promise<BlobGetAccountInfoResponse>
Parâmetros
- options
- BlobGetAccountInfoOptions
Opções para a operação Obter Informações da Conta do Serviço.
Retornos
Promise<BlobGetAccountInfoResponse>
Dados de resposta para a operação Informações da Conta de Obtenção de Serviço.
herdado deblobClient.getAccountInfo
getAppendBlobClient()
Cria um objeto AppendBlobClient.
function getAppendBlobClient(): AppendBlobClient
Retornos
herdado deBlobClient.getAppendBlobClient
getBlobLeaseClient(string)
Obtenha um blobLeaseClient
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. Ele não retorna o conteúdo do blob.
Consulte https://docs.microsoft.com/en-us/rest/api/storageservices/get-blob-properties
AVISO: O objeto metadata
retornado na resposta terá suas chaves em letras minúsculas, mesmo que originalmente contivessem caracteres maiúsculos. Isso difere das chaves de metadados retornadas pelos métodos de ContainerClient que listam blobs usando a opção includeMetadata
, que manterá sua caixa original.
function getProperties(options?: BlobGetPropertiesOptions): Promise<BlobGetPropertiesResponse>
Parâmetros
- options
- BlobGetPropertiesOptions
Opções opcionais para a operação Obter Propriedades.
Retornos
Promise<BlobGetPropertiesResponse>
herdado deblobClient.getProperties
getTags(BlobGetTagsOptions)
Obtém as marcas associadas ao blob subjacente.
function getTags(options?: BlobGetTagsOptions): Promise<BlobGetTagsResponse>
Parâmetros
- options
- BlobGetTagsOptions
Retornos
Promise<BlobGetTagsResponse>
herdado deblobClient.getTags
setAccessTier(string, BlobSetTierOptions)
Define a camada em um blob. A operação é permitida em um blob de páginas em uma conta de armazenamento premium e em um blob de blocos em uma conta de armazenamento de blobs (somente armazenamento com redundância local). A camada de um blob de página premium determina o tamanho permitido, o IOPS e a largura de banda do blob. A camada de um blob de blocos determina o tipo de armazenamento Hot/Cool/Archive. Essa operação não atualiza a ETag do blob.
Consulte https://docs.microsoft.com/en-us/rest/api/storageservices/set-blob-tier
function setAccessTier(tier: string, options?: BlobSetTierOptions): Promise<BlobSetTierResponse>
Parâmetros
- tier
-
string
A camada a ser definida no blob. Os valores válidos são Hot, Cool ou Archive.
- options
- BlobSetTierOptions
Opções opcionais para a operação de Camada de Conjunto de Blobs.
Retornos
Promise<BlobSetTierResponse>
Herdado deBlobClient.setAccessTier
setHTTPHeaders(BlobHTTPHeaders, BlobSetHTTPHeadersOptions)
Define as propriedades do sistema no blob.
Se nenhum valor for fornecido ou nenhum valor fornecido para os cabeçalhos HTTP de blob especificados, esses cabeçalhos HTTP de blob sem um valor serão limpos.
Consulte https://docs.microsoft.com/en-us/rest/api/storageservices/set-blob-properties
function setHTTPHeaders(blobHTTPHeaders?: BlobHTTPHeaders, options?: BlobSetHTTPHeadersOptions): Promise<BlobSetHTTPHeadersResponse>
Parâmetros
- blobHTTPHeaders
- BlobHTTPHeaders
Se nenhum valor for fornecido ou nenhum valor fornecido para os cabeçalhos HTTP de blob especificados, esses cabeçalhos HTTP de blob sem um valor serão limpos.
Um cabeçalho comum a ser definido é blobContentType
habilitando o navegador para fornecer funcionalidade com base no tipo de arquivo.
- options
- BlobSetHTTPHeadersOptions
Opções opcionais para a operação Defina Cabeçalhos HTTP do Blob.
Retornos
Promise<BlobSetHTTPHeadersResponse>
Herdado deBlobClient.setHTTPHeaders
setImmutabilityPolicy(BlobImmutabilityPolicy, BlobSetImmutabilityPolicyOptions)
Defina a política de imutabilidade no blob.
function setImmutabilityPolicy(immutabilityPolicy: BlobImmutabilityPolicy, options?: BlobSetImmutabilityPolicyOptions): Promise<BlobSetImmutabilityPolicyResponse>
Parâmetros
- immutabilityPolicy
- BlobImmutabilityPolicy
- options
- BlobSetImmutabilityPolicyOptions
Opções opcionais para definir a política de imutabilidade no blob.
Retornos
Promise<BlobSetImmutabilityPolicyResponse>
Herdado deBlobClient.setImmutabilityPolicy
setLegalHold(boolean, BlobSetLegalHoldOptions)
Defina a retenção legal no blob.
function setLegalHold(legalHoldEnabled: boolean, options?: BlobSetLegalHoldOptions): Promise<BlobSetLegalHoldResponse>
Parâmetros
- legalHoldEnabled
-
boolean
- options
- BlobSetLegalHoldOptions
Opções opcionais para definir a retenção legal no blob.
Retornos
Promise<BlobSetLegalHoldResponse>
Herdado deBlobClient.setLegalHold
setMetadata(Metadata, BlobSetMetadataOptions)
Define metadados definidos pelo usuário para o blob especificado como um ou mais pares nome-valor.
Se nenhuma opção for fornecida ou nenhum metadados definido no parâmetro, os metadados de blob serão removidos.
Consulte https://docs.microsoft.com/en-us/rest/api/storageservices/set-blob-metadata
function setMetadata(metadata?: Metadata, options?: BlobSetMetadataOptions): Promise<BlobSetMetadataResponse>
Parâmetros
- metadata
- Metadata
Substitua os metadados existentes por esse valor. Se nenhum valor fornecido, os metadados existentes serão removidos.
- options
- BlobSetMetadataOptions
Opções opcionais para definir a operação de metadados.
Retornos
Promise<BlobSetMetadataResponse>
herdado deblobClient.setMetadata
setTags(Tags, BlobSetTagsOptions)
Define marcas no blob subjacente. Um blob pode ter até 10 marcas. As teclas de marca devem ter entre 1 e 128 caracteres. Os valores de marca devem ter entre 0 e 256 caracteres. Caracteres válidos de chave de marca e valor incluem letras minúsculas e maiúsculas, dígitos (0-9), espaço (' '), mais ('+'), menos ('-'), ponto ('.'), barra ('/'), dois-pontos (':'), iguais ('=') e sublinhado ('_') .
function setTags(tags: Tags, options?: BlobSetTagsOptions): Promise<BlobSetTagsResponse>
Parâmetros
- tags
- Tags
- options
- BlobSetTagsOptions
Retornos
Promise<BlobSetTagsResponse>
Herdado deBlobClient.setTags
syncCopyFromURL(string, BlobSyncCopyFromURLOptions)
A operação de CÓPIA Síncrona da URL copia um blob ou um recurso da Internet para um novo blob. Ele não retornará uma resposta até que a cópia seja concluída.
Consulte https://docs.microsoft.com/en-us/rest/api/storageservices/copy-blob-from-url
function syncCopyFromURL(copySource: string, options?: BlobSyncCopyFromURLOptions): Promise<BlobCopyFromURLResponse>
Parâmetros
- copySource
-
string
A URL de origem da qual copiar, SAS (Assinatura de Acesso Compartilhado) talvez seja necessária para autenticação
- options
- BlobSyncCopyFromURLOptions
Retornos
Promise<BlobCopyFromURLResponse>
Herdado deBlobClient.syncCopyFromURL
undelete(BlobUndeleteOptions)
Restaura o conteúdo e os metadados do blob de exclusão reversível e de todos os instantâneos de exclusão reversível associados. Há suporte para o Undelete Blob somente na versão 2017-07-29 ou posterior.
Consulte https://docs.microsoft.com/en-us/rest/api/storageservices/undelete-blob
function undelete(options?: BlobUndeleteOptions): Promise<BlobUndeleteResponse>
Parâmetros
- options
- BlobUndeleteOptions
Opções opcionais para a operação Desdelete de Blob.
Retornos
Promise<BlobUndeleteResponse>
herdado deblobClient.undelete
withVersion(string)
Cria um novo objeto BlobClient apontando para uma versão desse blob. Forneça "" removerá a versionId e retornará um Cliente para o blob base.
function withVersion(versionId: string): BlobClient
Parâmetros
- versionId
-
string
A versionId.
Retornos
Um novo objeto BlobClient apontando para a versão desse blob.
Herdado deBlobClient.withVersion