BlockBlobClient class

Crea un'istanza di BlockBlobClient. Questo metodo accetta un URL codificato o un URL non codificato che punta a un BLOB in blocchi. La stringa URL codificata non verrà preceduta da un carattere di escape due volte. Solo i caratteri speciali nel percorso URL verranno preceduti da un carattere di escape. Se il nome di un BLOB include ? o %, il nome del BLOB deve essere codificato nell'URL.

new BlockBlobClient(url: string, pipeline: PipelineLike)

Parametri

Crea un'istanza di BlockBlobClient. Questo metodo accetta un URL codificato o un URL non codificato che punta a un BLOB in blocchi. La stringa URL codificata non verrà preceduta da un carattere di escape due volte. Solo i caratteri speciali nel percorso URL verranno preceduti da un carattere di escape. Se il nome di un BLOB include ? o %, il nome del BLOB deve essere codificato nell'URL.

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

Parametri

Crea un'istanza di BlockBlobClient.

new BlockBlobClient(connectionString: string, containerName: string, blobName: string, options?: StoragePipelineOptions)

Parametri

accountName: string

Valore della proprietà

Il nome del contenitore di archiviazione associato al BLOB.

string containerName

Valore della proprietà

Ad esempio AnonymousCredential, StorageSharedKeyCredential o qualsiasi credenziale del @azure/identity pacchetto per autenticare le richieste al servizio. È anche possibile fornire un oggetto che implementa l'interfaccia TokenCredential. Se non specificato, viene usata AnonymousCredential.

credential: StorageSharedKeyCredential | AnonymousCredential | TokenCredential

Valore della proprietà

Nome del BLOB.

string name

Valore della proprietà

Valore stringa URL codificato.

url: string

Valore della proprietà

Interrompe un'operazione Di copia BLOB asincrona in sospeso e lascia un BLOB di destinazione con lunghezza zero e metadati completi. Versione 2012-02-12 e successive.

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

Parametri

Restituisce

Copia in modo asincrono un BLOB in una destinazione all'interno dell'account di archiviazione. Questo metodo restituisce un poller di operazione a esecuzione prolungata che consente di attendere a tempo indeterminato fino al completamento della copia. È anche possibile annullare una copia prima che venga completata chiamando cancelOperation sul poller. Si noti che il callback onProgress non verrà richiamato se l'operazione viene completata nella prima richiesta e il tentativo di annullare una copia completata genererà un errore. Nella versione 2012-02-12 e successive, l'origine per un'operazione di copia BLOB può essere un BLOB di cui è stato eseguito il commit in qualsiasi account di archiviazione di Azure. A partire dalla versione 2015-02-21, l'origine per un'operazione Di copia BLOB può essere un file di Azure in qualsiasi account di archiviazione di Azure. L'operazione di copia dei BLOB da un account di archiviazione diverso è consentita solo per gli account di archiviazione creati il 7 giugno 2012 o successivamente.

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

Parametri

Restituisce

Scrive un Blob specificando l'elenco degli ID blocco che compongono il Blob. Per poter essere scritto come parte di un Blob, un blocco deve essere stato scritto correttamente nel server in un'operazione <xref:stageBlock> precedente. È possibile chiamare <xref:commitBlockList> per aggiornare un Blob caricando solo i blocchi che sono stati modificati ed eseguendo il commit dei blocchi nuovi ed esistenti. Eventuali blocchi non specificati nell'elenco di blocchi e eliminati definitivamente.

function commitBlockList(blocks: string[], options?: BlockBlobCommitBlockListOptions)

Parametri

Restituisce

Dati di risposta per l'operazione Block Blob Commit Block List.

Crea uno snapshot di sola lettura di un BLOB.

function createSnapshot(options?: BlobCreateSnapshotOptions)

Parametri

Restituisce

Contrassegna il BLOB o lo snapshot specificato per l'eliminazione. Il Blob verrà eliminato in seguito durante un'operazione di Garbage Collection. Si noti che per eliminare un Blob, è necessario eliminare tutti i relativi snapshot. È possibile eliminare entrambi contemporaneamente con l'operazione Elimina BLOB.

function delete(options?: BlobDeleteOptions)

Parametri

Restituisce

Contrassegna il BLOB o lo snapshot specificato per l'eliminazione, se esistente. Il Blob verrà eliminato in seguito durante un'operazione di Garbage Collection. Si noti che per eliminare un Blob, è necessario eliminare tutti i relativi snapshot. È possibile eliminare entrambi contemporaneamente con l'operazione Elimina BLOB.

function deleteIfExists(options?: BlobDeleteOptions)

Parametri

Restituisce

Eliminare i criteri di immutablility nel BLOB.

function deleteImmutabilityPolicy(options?: BlobDeleteImmutabilityPolicyOptions)

Parametri

Restituisce

Legge o scarica un BLOB dal sistema, inclusi i relativi metadati e proprietà. È anche possibile chiamare Get BLOB per leggere uno snapshot.

• In Node.js i dati vengono restituiti in un flusso leggibileStreamBody
• Nei browser i dati vengono restituiti in un blob promiseBody

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

Parametri

// 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);
});
}

// 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);
  });
}

Restituisce

DISPONIBILE SOLO IN NODE.JS RUNTIME. Scarica un BLOB di Azure in parallelo in un buffer. Offset e conteggio sono facoltativi, scarica l'intero BLOB se non vengono forniti.

Avviso: i buffer possono supportare solo i file fino a circa un gigabyte nei sistemi a 32 bit o circa due gigabyte nei sistemi a 64 bit a causa delle limitazioni di Node.js/V8. Per i BLOB maggiori di questa dimensione, prendere in considerazione <xref:downloadToFile>.

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

Parametri

Restituisce

DISPONIBILE SOLO IN NODE.JS RUNTIME. Scarica un BLOB di Azure in parallelo in un buffer. Offset e conteggio sono facoltativi, scarica l'intero BLOB se non vengono forniti.

Avviso: i buffer possono supportare solo i file fino a circa un gigabyte nei sistemi a 32 bit o circa due gigabyte nei sistemi a 64 bit a causa delle limitazioni di Node.js/V8. Per i BLOB maggiori di questa dimensione, prendere in considerazione <xref:downloadToFile>.

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

Parametri

Restituisce

DISPONIBILE SOLO IN NODE.JS RUNTIME. Scarica un BLOB di Azure in un file locale. Ha esito negativo se il percorso del file specificato viene già chiuso. Offset e conteggio sono facoltativi, passano rispettivamente 0 e non definiti per scaricare l'intero BLOB.

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

Parametri

Restituisce

I dati di risposta per l'operazione di download blob, ma con readableStreamBody impostato su un valore non definito perché il contenuto è già letto e scritto in un file locale nel percorso specificato.

Restituisce true se la risorsa BLOB di Azure rappresentata da questo client esiste; false in caso contrario. NOTA: usare questa funzione con attenzione perché un BLOB esistente potrebbe essere eliminato da altri client o applicazioni. Viceversa, è possibile aggiungere nuovi BLOB da altri client o applicazioni al termine di questa funzione.

function exists(options?: BlobExistsOptions)

Parametri

Restituisce

Disponibile solo per BlobClient costruito con credenziali di chiave condivisa. Genera un URI di firma di accesso condiviso (SAS) del servizio BLOB in base alle proprietà e ai parametri del client passati. La firma di accesso condiviso viene firmata dalle credenziali della chiave condivisa del client.

function generateSasUrl(options: BlobGenerateSasUrlOptions)

Parametri

Restituisce

URI di firma di accesso condiviso costituito dall'URI della risorsa rappresentata da questo client, seguito dal token di firma di accesso condiviso generato.

Crea un oggetto AppendBlobClient.

function getAppendBlobClient()

Restituisce

Ottenere un oggetto <xref:BlobLeaseClient> che gestisce i lease nel BLOB.

function getBlobLeaseClient(proposeLeaseId?: string)

Parametri

Restituisce

Nuovo oggetto BlobLeaseClient per la gestione dei lease nel BLOB.

Crea un oggetto BlockBlobClient.

function getBlockBlobClient()

Restituisce

Restituisce l'elenco di blocchi caricati come parte di un BLOB in blocchi usando il filtro elenco di blocchi specificato.

function getBlockList(listType: BlockListType, options?: BlockBlobGetBlockListOptions)

Parametri

Restituisce

Dati di risposta per l'operazione Block Blob Get Block List.

Crea un oggetto PageBlobClient.

function getPageBlobClient()

Restituisce

Restituisce tutti i metadati definiti dall'utente, le proprietà HTTP standard e le proprietà di sistema per il Blob. Non restituisce il contenuto del Blob.

function getProperties(options?: BlobGetPropertiesOptions)

Parametri

Restituisce

Ottiene i tag associati al BLOB sottostante.

function getTags(options?: BlobGetTagsOptions)

Parametri

Restituisce

DISPONIBILE SOLO IN NODE.JS RUNTIME. Query rapida per un BLOB in formato JSON o CSV.

Esempio di utilizzo (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)

Parametri

Restituisce

Imposta il livello su un BLOB. L'operazione è consentita in un BLOB di pagine in un account di archiviazione Premium e in un BLOB in blocchi in un account di archiviazione BLOB (solo archiviazione con ridondanza locale). Il livello di un BLOB di pagine Premium determina le dimensioni, le operazioni di I/O al secondo e la larghezza di banda consentite del BLOB. Il livello di un BLOB in blocchi determina il tipo di archiviazione ad accesso frequente/sporadico/archivio. Questa operazione non aggiorna l'ETag del BLOB.

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

Parametri

Restituisce

Imposta le proprietà di sistema nel BLOB. Se non viene specificato alcun valore o nessun valore specificato per le intestazioni HTTP BLOB specificate, queste intestazioni HTTP BLOB senza un valore verranno cancellate.

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

Parametri

Restituisce

Impostare i criteri di immutablility nel BLOB.

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

Parametri

Restituisce

Impostare il blocco a fini giudiziari sul BLOB.

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

Parametri

Restituisce

Imposta i metadati definiti dall'utente per il BLOB specificato come una o più coppie nome-valore. Se non è stata specificata alcuna opzione o nessun metadati definito nel parametro, i metadati del BLOB verranno rimossi.

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

Parametri

Restituisce

Imposta i tag nel BLOB sottostante. Un BLOB può avere fino a 10 tag. I tasti tag devono essere compresi tra 1 e 128 caratteri. I valori dei tag devono essere compresi tra 0 e 256 caratteri. I caratteri di chiave e valore di tag validi includono lettere minuscole e maiuscole, cifre (0-9), spazio (' '), più ('+'), meno ('-'), punto ('.'), barra ('/'), due punti (':'), uguale ('=') e sottolineatura ('_') .

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

Parametri

Restituisce

Carica il blocco specificato nell'area di gestione temporanea del BLOB in blocchi per essere eseguito in un secondo momento da una chiamata a commitBlockList.

function stageBlock(blockId: string, body: HttpRequestBody, contentLength: number, options?: BlockBlobStageBlockOptions)

Parametri

Restituisce

Dati di risposta per l'operazione Block Blob Stage Block.

L'operazione Stage Block From URL crea un nuovo blocco di cui eseguire il commit come parte di un BLOB in cui il contenuto viene letto da un URL. Questa API è disponibile a partire dalla versione 2018-03-28.

function stageBlockFromURL(blockId: string, sourceURL: string, offset?: number, count?: number, options?: BlockBlobStageBlockFromURLOptions)

Parametri

Restituisce

Dati di risposta per l'operazione Block Blob Stage Block From URL.

L'operazione Copia da URL sincrona copia un BLOB o una risorsa Internet in un nuovo BLOB. Non restituirà una risposta fino al completamento della copia.

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

Parametri

Restituisce

Crea un nuovo BLOB in blocchi in cui il contenuto del BLOB viene letto da un URL specificato. Questa API è supportata a partire dalla versione 2020-04-08. Gli aggiornamenti parziali non sono supportati con Put BLOB from URL; il contenuto di un BLOB esistente viene sovrascritto con il contenuto del nuovo BLOB. Per eseguire aggiornamenti parziali al contenuto di un BLOB in blocchi usando un URL di origine, usare <xref:stageBlockFromURL> e <xref:commitBlockList>.

function syncUploadFromURL(sourceURL: string, options?: BlockBlobSyncUploadFromURLOptions)

Parametri

Restituisce

Ripristina il contenuto e i metadati del BLOB eliminato soft e degli snapshot eliminati soft associati. Il BLOB di annullamento dell'eliminazione è supportato solo nella versione 2017-07-29 o successiva.

function undelete(options?: BlobUndeleteOptions)

Parametri

Restituisce

Crea un nuovo BLOB in blocchi o aggiorna il contenuto di un BLOB in blocchi esistente. L'aggiornamento di un Blob in blocchi esistente comporta la sovrascrittura dei metadati esistenti nel Blob. Gli aggiornamenti parziali non sono supportati; il contenuto del BLOB esistente viene sovrascritto con il nuovo contenuto. Per eseguire un aggiornamento parziale di un BLOB in blocchi, usare <xref:stageBlock> e <xref:commitBlockList>. Si tratta di un metodo di caricamento non parallelo, usare <xref:uploadFile><xref:uploadStream> o <xref:uploadBrowserData> per ottenere prestazioni migliori con il caricamento della concorrenza.

function upload(body: HttpRequestBody, contentLength: number, options?: BlockBlobUploadOptions)

Parametri

Restituisce

Dati di risposta per l'operazione di caricamento BLOB in blocchi.

Esempio di utilizzo:

const content = "Hello world!";
const uploadBlobResponse = await blockBlobClient.upload(content, content.length);

DISPONIBILE SOLO NEI BROWSER. Carica un oggetto BLOB/File/ArrayBuffer/ArrayBufferView del browser nel BLOB in blocchi.

Quando la lunghezza del buffer è minore o uguale a 256 MB, questo metodo userà 1 chiamata di caricamento per completare il caricamento. In caso contrario, questo metodo chiamerà <xref:stageBlock> per caricare i blocchi e infine chiamerà <xref:commitBlockList> per eseguire il commit dell'elenco di blocchi.

Un'opzione comune <xref:BlockBlobParallelUploadOptions.blobHTTPHeaders> da impostare è blobContentType, consentendo al browser di fornire funzionalità in base al tipo di file.

function uploadBrowserData(browserData: Blob | ArrayBuffer | ArrayBufferView, options?: BlockBlobParallelUploadOptions)

Parametri

Restituisce

Dati di risposta per l'operazione di caricamento BLOB.

Carica un oggetto Buffer(Node.js)/Blob(browser)/ArrayBuffer/ArrayBufferView in un BlockBlob. Quando la lunghezza dei dati non è maggiore della specifica <xref:BlockBlobParallelUploadOptions.maxSingleShotSize> (il valore predefinito è <xref:BLOCK_BLOB_MAX_UPLOAD_BLOB_BYTES>), questo metodo userà 1 <xref:upload> chiamata per completare il caricamento. In caso contrario, questo metodo chiamerà <xref:stageBlock> per caricare i blocchi e infine chiamerà <xref:commitBlockList> per eseguire il commit dell'elenco di blocchi.

Un'opzione comune <xref:BlockBlobParallelUploadOptions.blobHTTPHeaders> da impostare è blobContentType, consentendo al browser di fornire funzionalità in base al tipo di file.

function uploadData(data: Buffer | Blob | ArrayBuffer | ArrayBufferView, options?: BlockBlobParallelUploadOptions)

Parametri

Restituisce

DISPONIBILE SOLO IN NODE.JS RUNTIME. Carica un file locale in blocchi in un BLOB in blocchi.

Quando le dimensioni del file sono inferiori o uguali a 256 MB, questo metodo userà 1 chiamata di caricamento per completare il caricamento. In caso contrario, questo metodo chiamerà stageBlock per caricare i blocchi e infine chiamerà commitBlockList per eseguire il commit dell'elenco di blocchi.

function uploadFile(filePath: string, options?: BlockBlobParallelUploadOptions)

Parametri

Restituisce

Dati di risposta per l'operazione di caricamento BLOB.

DISPONIBILE SOLO IN NODE.JS RUNTIME. Carica un flusso Node.js leggibile nel BLOB in blocchi.

SUGGERIMENTI PER IL MIGLIORAMENTO DELLE PRESTAZIONI:

• L'highWaterMark del flusso di input è preferibile impostare lo stesso valore con il parametro bufferSize, che eviterà le operazioni Buffer.concat().

function uploadStream(stream: Readable, bufferSize?: number, maxConcurrency?: number, options?: BlockBlobUploadStreamOptions)

Parametri

Restituisce

Dati di risposta per l'operazione di caricamento BLOB.

Crea un nuovo oggetto BlockBlobClient identico all'origine, ma con il timestamp snapshot specificato. Specificare "" rimuoverà lo snapshot e restituirà un URL al BLOB di base.

function withSnapshot(snapshot: string)

Parametri

Restituisce

Nuovo oggetto BlockBlobClient identico all'origine, ma con il timestamp snapshot specificato.

Crea un nuovo oggetto BLOBClient che punta a una versione di questo BLOB. Specificare "" rimuoverà il versionId e restituirà un client al BLOB di base.

function withVersion(versionId: string)

Parametri

Restituisce

Nuovo oggetto BLOBClient che punta alla versione di questo BLOB.