BlobClient class

  • Riferimento
Pacchetto:
@azure/storage-blob

Un BLOBClient rappresenta un URL per un BLOB di archiviazione di Azure; il BLOB può essere un BLOB a blocchi, un BLOB di accodamento o un BLOB di pagine.

Extends

StorageClient

Costruttori

BlobClient(string, PipelineLike)

Crea un'istanza di BlobClient. Questo metodo accetta un URL codificato o un URL non codificato che punta a un BLOB. 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.
BlobClient(string, StorageSharedKeyCredential | AnonymousCredential | TokenCredential, StoragePipelineOptions)

Crea un'istanza di BlobClient. Questo metodo accetta un URL codificato o un URL non codificato che punta a un BLOB. 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.
BlobClient(string, string, string, StoragePipelineOptions)

Crea un'istanza di BlobClient dalla stringa di connessione.

Proprietà

containerName

Il nome del contenitore di archiviazione associato al BLOB.
name

Nome del BLOB.

Proprietà ereditate

accountName
credential

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 utilizzato AnonymousCredential.
url

Valore stringa URL codificato.

Metodi

abortCopyFromURL(string, BlobAbortCopyFromURLOptions)

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.

Vedere https://docs.microsoft.com/en-us/rest/api/storageservices/abort-copy-blob
beginCopyFromURL(string, BlobBeginCopyFromURLOptions)

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.

Vedere https://docs.microsoft.com/en-us/rest/api/storageservices/copy-blob

Esempio che usa il polling automatico:

const copyPoller = await blobClient.beginCopyFromURL('url');
const result = await copyPoller.pollUntilDone();

Esempio di utilizzo del polling manuale:

const copyPoller = await blobClient.beginCopyFromURL('url');
while (!poller.isDone()) {
   await poller.poll();
}
const result = copyPoller.getResult();

Esempio di utilizzo degli aggiornamenti dello stato:

const copyPoller = await blobClient.beginCopyFromURL('url', {
  onProgress(state) {
    console.log(`Progress: ${state.copyProgress}`);
  }
});
const result = await copyPoller.pollUntilDone();

Esempio che usa un intervallo di polling modificato (15 secondi predefinito):

const copyPoller = await blobClient.beginCopyFromURL('url', {
  intervalInMs: 1000 // poll blob every 1 second for copy progress
});
const result = await copyPoller.pollUntilDone();

Esempio di utilizzo dell'annullamento della copia:

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.');
  }
}
createSnapshot(BlobCreateSnapshotOptions)

Crea uno snapshot di sola lettura di un BLOB.

Vedere https://docs.microsoft.com/en-us/rest/api/storageservices/snapshot-blob
delete(BlobDeleteOptions)

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.

Vedere https://docs.microsoft.com/en-us/rest/api/storageservices/delete-blob
deleteIfExists(BlobDeleteOptions)

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.

Vedere https://docs.microsoft.com/en-us/rest/api/storageservices/delete-blob
deleteImmutabilityPolicy(BlobDeleteImmutabilityPolicyOptions)

Eliminare i criteri di immutablility nel BLOB.
download(number, number, BlobDownloadOptions)

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

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

Vedere https://docs.microsoft.com/en-us/rest/api/storageservices/get-blob
downloadToBuffer(Buffer, number, number, BlobDownloadToBufferOptions)

DISPONIBILE SOLO IN RUNTIME NODE.JS.

Scarica un BLOB di Azure in parallelo a 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 un gigabyte su sistemi a 32 bit o circa due gigabyte nei sistemi a 64 bit a causa di limitazioni di Node.js/V8. Per i BLOB più grandi di questa dimensione, è consigliabile scaricareToFile.
downloadToBuffer(number, number, BlobDownloadToBufferOptions)

DISPONIBILE SOLO IN RUNTIME NODE.JS.

Scarica un BLOB di Azure in parallelo a 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 un gigabyte su sistemi a 32 bit o circa due gigabyte nei sistemi a 64 bit a causa di limitazioni di Node.js/V8. Per i BLOB più grandi di questa dimensione, è consigliabile scaricareToFile.
downloadToFile(string, number, number, BlobDownloadOptions)

DISPONIBILE SOLO IN RUNTIME NODE.JS.

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.
exists(BlobExistsOptions)

Restituisce true se la risorsa BLOB di Azure rappresentata da questo client esiste; false in caso contrario.

NOTA: usare questa funzione con attenzione poiché un BLOB esistente potrebbe essere eliminato da altri client o applicazioni. Viceversa, i nuovi BLOB possono essere aggiunti da altri client o applicazioni al termine di questa funzione.
generateSasUrl(BlobGenerateSasUrlOptions)

Disponibile solo per BLOBClient costruito con una credenziale di chiave condivisa.

Genera un URI di firma di accesso condiviso del servizio BLOB in base alle proprietà e ai parametri client passati. La firma di accesso condiviso viene firmata dalla credenziale della chiave condivisa del client.

Vedere https://docs.microsoft.com/en-us/rest/api/storageservices/constructing-a-service-sas
getAppendBlobClient()

Crea un oggetto AppendBlobClient.
getBlobLeaseClient(string)

Ottenere un BLOBLeaseClient che gestisce i lease nel BLOB.
getBlockBlobClient()

Crea un oggetto BlockBlobClient.
getPageBlobClient()

Crea un oggetto PageBlobClient.
getProperties(BlobGetPropertiesOptions)

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.

Vedere https://docs.microsoft.com/en-us/rest/api/storageservices/get-blob-properties

AVVISO: l'oggetto metadata restituito nella risposta avrà le chiavi in lettere minuscole, anche se in origine contengono caratteri maiuscoli. Ciò è diverso dalle chiavi di metadati restituite dai metodi di ContainerClient che elencano i BLOB usando l'opzione, che manterrà le includeMetadata maiuscole e minuscole originali.
getTags(BlobGetTagsOptions)

Ottiene i tag associati al BLOB sottostante.
setAccessTier(string, BlobSetTierOptions)

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

Vedere https://docs.microsoft.com/en-us/rest/api/storageservices/set-blob-tier
setHTTPHeaders(BlobHTTPHeaders, BlobSetHTTPHeadersOptions)

Imposta le proprietà di sistema nel BLOB.

Se non viene fornito alcun valore o nessun valore specificato per le intestazioni HTTP BLOB specificate, queste intestazioni HTTP BLOB senza un valore verranno cancellate.

Vedere https://docs.microsoft.com/en-us/rest/api/storageservices/set-blob-properties
setImmutabilityPolicy(BlobImmutabilityPolicy, BlobSetImmutabilityPolicyOptions)

Impostare criteri di immutablility nel BLOB.
setLegalHold(boolean, BlobSetLegalHoldOptions)

Impostare il blocco legale sul BLOB.
setMetadata(Metadata, BlobSetMetadataOptions)

Imposta i metadati definiti dall'utente per il BLOB specificato come una o più coppie nome-valore.

Se non viene fornita alcuna opzione o nessun metadati definito nel parametro, i metadati del BLOB verranno rimossi.

Vedere https://docs.microsoft.com/en-us/rest/api/storageservices/set-blob-metadata
setTags(Tags, BlobSetTagsOptions)

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

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

Vedere https://docs.microsoft.com/en-us/rest/api/storageservices/copy-blob-from-url
undelete(BlobUndeleteOptions)

Ripristina il contenuto e i metadati del BLOB eliminato temporanea e di eventuali snapshot eliminati soft associati. Undelete BLOB è supportato solo nella versione 2017-07-29 o successiva.

Vedere https://docs.microsoft.com/en-us/rest/api/storageservices/undelete-blob
withSnapshot(string)

Crea un nuovo oggetto BLOBClient identico all'origine, ma con il timestamp snapshot specificato. Specificare "" rimuoverà lo snapshot e restituirà un client al BLOB di base.
withVersion(string)

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.

Dettagli costruttore

BlobClient(string, PipelineLike)

Crea un'istanza di BlobClient. Questo metodo accetta un URL codificato o un URL non codificato che punta a un BLOB. 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 BlobClient(url: string, pipeline: PipelineLike)

Parametri

url

string

Stringa URL che punta al BLOB di Archiviazione di Azure, ad esempio "https://myaccount.blob.core.windows.net/mycontainer/blob". È possibile aggiungere una firma di accesso condiviso se si usa AnonymousCredential, ad esempio "https://myaccount.blob.core.windows.net/mycontainer/blob?sasString". Questo metodo accetta un URL codificato o un URL non codificato che punta a un BLOB. 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. Tuttavia, se il nome di un BLOB include ? o %, il nome del BLOB deve essere codificato nell'URL. Ad esempio, un BLOB denominato "my?blob%", l'URL deve essere "https://myaccount.blob.core.windows.net/mycontainer/my%3Fblob%25".

pipeline
PipelineLike

Chiamare newPipeline() per creare una pipeline predefinita o fornire una pipeline personalizzata.

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

Crea un'istanza di BlobClient. Questo metodo accetta un URL codificato o un URL non codificato che punta a un BLOB. 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 BlobClient(url: string, credential?: StorageSharedKeyCredential | AnonymousCredential | TokenCredential, options?: StoragePipelineOptions)

Parametri

url

string

Stringa client che punta al servizio BLOB di Archiviazione di Azure, ad esempio "https://myaccount.blob.core.windows.net". È possibile aggiungere una firma di accesso condiviso se si usa AnonymousCredential, ad esempio "https://myaccount.blob.core.windows.net?sasString".

credential

StorageSharedKeyCredential | AnonymousCredential | TokenCredential

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 utilizzato AnonymousCredential.

options
StoragePipelineOptions

Facoltativa. Opzioni per configurare la pipeline HTTP.

BlobClient(string, string, string, StoragePipelineOptions)

Crea un'istanza di BlobClient dalla stringa di connessione.

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

Parametri

connectionString

string

Stringa di connessione dell'account o stringa di connessione sas di un account di archiviazione di Azure. [ Nota: la stringa di connessione dell'account può essere usata solo in NODE.JS runtime. ] Esempio di stringa di connessione dell'account -DefaultEndpointsProtocol=https;AccountName=myaccount;AccountKey=accountKey;EndpointSuffix=core.windows.net Esempio di stringa di connessione di firma di accesso condiviso - 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 del contenitore.

blobName

string

Nome BLOB.

options
StoragePipelineOptions

Facoltativa. Opzioni per configurare la pipeline HTTP.

Dettagli proprietà

containerName

Il nome del contenitore di archiviazione associato al BLOB.

string containerName

Valore della proprietà

string

name

Nome del BLOB.

string name

Valore della proprietà

string

Dettagli proprietà ereditate

accountName 

accountName: string

Valore della proprietà

string

Ereditato da StorageClient.accountName

credential

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 utilizzato AnonymousCredential.

credential: StorageSharedKeyCredential | AnonymousCredential | TokenCredential

Valore della proprietà

StorageSharedKeyCredential | AnonymousCredential | TokenCredential

Ereditato da StorageClient.credential

url

Valore stringa URL codificato.

url: string

Valore della proprietà

string

Ereditato da StorageClient.url

Dettagli metodo

abortCopyFromURL(string, BlobAbortCopyFromURLOptions)

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.

Vedere https://docs.microsoft.com/en-us/rest/api/storageservices/abort-copy-blob

function abortCopyFromURL(copyId: string, options?: BlobAbortCopyFromURLOptions): Promise<BlobAbortCopyFromURLResponse>

Parametri

copyId

string

ID dell'operazione Copia da URL.

options
BlobAbortCopyFromURLOptions

Opzioni facoltative per l'operazione Copia da URL di interruzione BLOB.

Restituisce

Promise<BlobAbortCopyFromURLResponse>

beginCopyFromURL(string, BlobBeginCopyFromURLOptions)

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.

Vedere https://docs.microsoft.com/en-us/rest/api/storageservices/copy-blob

Esempio che usa il polling automatico:

const copyPoller = await blobClient.beginCopyFromURL('url');
const result = await copyPoller.pollUntilDone();

Esempio di utilizzo del polling manuale:

const copyPoller = await blobClient.beginCopyFromURL('url');
while (!poller.isDone()) {
   await poller.poll();
}
const result = copyPoller.getResult();

Esempio di utilizzo degli aggiornamenti dello stato:

const copyPoller = await blobClient.beginCopyFromURL('url', {
  onProgress(state) {
    console.log(`Progress: ${state.copyProgress}`);
  }
});
const result = await copyPoller.pollUntilDone();

Esempio che usa un intervallo di polling modificato (15 secondi predefinito):

const copyPoller = await blobClient.beginCopyFromURL('url', {
  intervalInMs: 1000 // poll blob every 1 second for copy progress
});
const result = await copyPoller.pollUntilDone();

Esempio di utilizzo dell'annullamento della copia:

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>>

Parametri

copySource

string

URL dell'origine BLOB/file di Azure.

options
BlobBeginCopyFromURLOptions

Opzioni facoltative per l'operazione Di avvio copia dal BLOB dall'URL.

Restituisce

Promise<PollerLikeWithCancellation<PollOperationState<BlobBeginCopyFromURLResponse>, BlobBeginCopyFromURLResponse>>

createSnapshot(BlobCreateSnapshotOptions)

Crea uno snapshot di sola lettura di un BLOB.

Vedere https://docs.microsoft.com/en-us/rest/api/storageservices/snapshot-blob

function createSnapshot(options?: BlobCreateSnapshotOptions): Promise<BlobCreateSnapshotResponse>

Parametri

options
BlobCreateSnapshotOptions

Opzioni facoltative per l'operazione Di creazione snapshot BLOB.

Restituisce

Promise<BlobCreateSnapshotResponse>

delete(BlobDeleteOptions)

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.

Vedere https://docs.microsoft.com/en-us/rest/api/storageservices/delete-blob

function delete(options?: BlobDeleteOptions): Promise<BlobDeleteResponse>

Parametri

options
BlobDeleteOptions

Opzioni facoltative per l'operazione di eliminazione BLOB.

Restituisce

Promise<BlobDeleteResponse>

deleteIfExists(BlobDeleteOptions)

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.

Vedere https://docs.microsoft.com/en-us/rest/api/storageservices/delete-blob

function deleteIfExists(options?: BlobDeleteOptions): Promise<BlobDeleteIfExistsResponse>

Parametri

options
BlobDeleteOptions

Opzioni facoltative per l'operazione di eliminazione BLOB.

Restituisce

Promise<BlobDeleteIfExistsResponse>

deleteImmutabilityPolicy(BlobDeleteImmutabilityPolicyOptions)

Eliminare i criteri di immutablility nel BLOB.

function deleteImmutabilityPolicy(options?: BlobDeleteImmutabilityPolicyOptions): Promise<BlobDeleteImmutabilityPolicyResponse>

Parametri

options
BlobDeleteImmutabilityPolicyOptions

Opzioni facoltative per eliminare i criteri di non modificabilità nel BLOB.

Restituisce

Promise<BlobDeleteImmutabilityPolicyResponse>

download(number, number, BlobDownloadOptions)

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

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

Vedere https://docs.microsoft.com/en-us/rest/api/storageservices/get-blob

function download(offset?: number, count?: number, options?: BlobDownloadOptions): Promise<BlobDownloadResponseParsed>

Parametri

offset

number

Da quale posizione del BLOB scaricare, maggiore o uguale a 0

count

number

Quantità di dati da scaricare, maggiore di 0. Verrà scaricato alla fine quando non definito

options
BlobDownloadOptions

Opzioni facoltative per l'operazione download BLOB.

Utilizzo di esempio (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);
});
}

Utilizzo di esempio (browser):

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

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

Restituisce

Promise<BlobDownloadResponseParsed>

downloadToBuffer(Buffer, number, number, BlobDownloadToBufferOptions)

DISPONIBILE SOLO IN RUNTIME NODE.JS.

Scarica un BLOB di Azure in parallelo a 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 un gigabyte su sistemi a 32 bit o circa due gigabyte nei sistemi a 64 bit a causa di limitazioni di Node.js/V8. Per i BLOB più grandi di questa dimensione, è consigliabile scaricareToFile.

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

Parametri

buffer

Buffer

Buffer da riempire, deve avere lunghezza maggiore del numero

offset

number

Da quale posizione del BLOB a blocchi scaricare(in byte)

count

number

Quantità di dati (in byte) da scaricare. Verrà scaricato alla fine quando si passa undefined

options
BlobDownloadToBufferOptions

BLOBDownloadToBufferOptions

Restituisce

Promise<Buffer>

downloadToBuffer(number, number, BlobDownloadToBufferOptions)

DISPONIBILE SOLO IN RUNTIME NODE.JS.

Scarica un BLOB di Azure in parallelo a 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 un gigabyte su sistemi a 32 bit o circa due gigabyte nei sistemi a 64 bit a causa di limitazioni di Node.js/V8. Per i BLOB più grandi di questa dimensione, è consigliabile scaricareToFile.

function downloadToBuffer(offset?: number, count?: number, options?: BlobDownloadToBufferOptions): Promise<Buffer>

Parametri

offset

number

Da quale posizione del BLOB a blocchi scaricare(in byte)

count

number

Quantità di dati (in byte) da scaricare. Verrà scaricato alla fine quando si passa undefined

options
BlobDownloadToBufferOptions

BLOBDownloadToBufferOptions

Restituisce

Promise<Buffer>

downloadToFile(string, number, number, BlobDownloadOptions)

DISPONIBILE SOLO IN RUNTIME NODE.JS.

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): Promise<BlobDownloadResponseParsed>

Parametri

filePath

string

offset

number

Da quale posizione del BLOB a blocchi scaricare.

count

number

Quantità di dati da scaricare. Verrà scaricato alla fine durante il passaggio non definito.

options
BlobDownloadOptions

Opzioni di download BLOB.

Restituisce

Promise<BlobDownloadResponseParsed>

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

exists(BlobExistsOptions)

Restituisce true se la risorsa BLOB di Azure rappresentata da questo client esiste; false in caso contrario.

NOTA: usare questa funzione con attenzione poiché un BLOB esistente potrebbe essere eliminato da altri client o applicazioni. Viceversa, i nuovi BLOB possono essere aggiunti da altri client o applicazioni al termine di questa funzione.

function exists(options?: BlobExistsOptions): Promise<boolean>

Parametri

options
BlobExistsOptions

opzioni per l'operazione Esiste.

Restituisce

Promise<boolean>

generateSasUrl(BlobGenerateSasUrlOptions)

Disponibile solo per BLOBClient costruito con una credenziale di chiave condivisa.

Genera un URI di firma di accesso condiviso del servizio BLOB in base alle proprietà e ai parametri client passati. La firma di accesso condiviso viene firmata dalla credenziale della chiave condivisa del client.

Vedere https://docs.microsoft.com/en-us/rest/api/storageservices/constructing-a-service-sas

function generateSasUrl(options: BlobGenerateSasUrlOptions): Promise<string>

Parametri

options
BlobGenerateSasUrlOptions

Parametri facoltativi.

Restituisce

Promise<string>

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

getAppendBlobClient()

Crea un oggetto AppendBlobClient.

function getAppendBlobClient(): AppendBlobClient

Restituisce

AppendBlobClient

getBlobLeaseClient(string)

Ottenere un BLOBLeaseClient che gestisce i lease nel BLOB.

function getBlobLeaseClient(proposeLeaseId?: string): BlobLeaseClient

Parametri

proposeLeaseId

string

ID lease proposto iniziale.

Restituisce

BlobLeaseClient

Nuovo oggetto BLOBLeaseClient per la gestione dei lease nel BLOB.

getBlockBlobClient()

Crea un oggetto BlockBlobClient.

function getBlockBlobClient(): BlockBlobClient

Restituisce

BlockBlobClient

getPageBlobClient()

Crea un oggetto PageBlobClient.

function getPageBlobClient(): PageBlobClient

Restituisce

PageBlobClient

getProperties(BlobGetPropertiesOptions)

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.

Vedere https://docs.microsoft.com/en-us/rest/api/storageservices/get-blob-properties

AVVISO: l'oggetto metadata restituito nella risposta avrà le chiavi in lettere minuscole, anche se in origine contengono caratteri maiuscoli. Ciò è diverso dalle chiavi di metadati restituite dai metodi di ContainerClient che elencano i BLOB usando l'opzione, che manterrà le includeMetadata maiuscole e minuscole originali.

function getProperties(options?: BlobGetPropertiesOptions): Promise<BlobGetPropertiesResponse>

Parametri

options
BlobGetPropertiesOptions

Opzioni facoltative per ottenere l'operazione Proprietà.

Restituisce

Promise<BlobGetPropertiesResponse>

getTags(BlobGetTagsOptions)

Ottiene i tag associati al BLOB sottostante.

function getTags(options?: BlobGetTagsOptions): Promise<BlobGetTagsResponse>

Parametri

options
BlobGetTagsOptions

Restituisce

Promise<BlobGetTagsResponse>

setAccessTier(string, BlobSetTierOptions)

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

Vedere https://docs.microsoft.com/en-us/rest/api/storageservices/set-blob-tier

function setAccessTier(tier: string, options?: BlobSetTierOptions): Promise<BlobSetTierResponse>

Parametri

tier

string

Livello da impostare nel BLOB. I valori validi sono Hot, Cool o Archive.

options
BlobSetTierOptions

Opzioni facoltative per l'operazione Di set di livelli BLOB.

Restituisce

Promise<BlobSetTierResponse>

setHTTPHeaders(BlobHTTPHeaders, BlobSetHTTPHeadersOptions)

Imposta le proprietà di sistema nel BLOB.

Se non viene fornito alcun valore o nessun valore specificato per le intestazioni HTTP BLOB specificate, queste intestazioni HTTP BLOB senza un valore verranno cancellate.

Vedere https://docs.microsoft.com/en-us/rest/api/storageservices/set-blob-properties

function setHTTPHeaders(blobHTTPHeaders?: BlobHTTPHeaders, options?: BlobSetHTTPHeadersOptions): Promise<BlobSetHTTPHeadersResponse>

Parametri

blobHTTPHeaders
BlobHTTPHeaders

Se non viene fornito alcun valore o nessun valore specificato per le intestazioni HTTP BLOB specificate, queste intestazioni HTTP BLOB senza un valore verranno cancellate. Un'intestazione comune da impostare blobContentType consente al browser di fornire funzionalità in base al tipo di file.

options
BlobSetHTTPHeadersOptions

Opzioni facoltative per l'operazione Imposta intestazioni HTTP.

Restituisce

Promise<BlobSetHTTPHeadersResponse>

setImmutabilityPolicy(BlobImmutabilityPolicy, BlobSetImmutabilityPolicyOptions)

Impostare criteri di immutablility nel BLOB.

function setImmutabilityPolicy(immutabilityPolicy: BlobImmutabilityPolicy, options?: BlobSetImmutabilityPolicyOptions): Promise<BlobSetImmutabilityPolicyResponse>

Parametri

immutabilityPolicy
BlobImmutabilityPolicy
options
BlobSetImmutabilityPolicyOptions

Opzioni facoltative per impostare criteri di non modificabilità nel BLOB.

Restituisce

Promise<BlobSetImmutabilityPolicyResponse>

setLegalHold(boolean, BlobSetLegalHoldOptions)

Impostare il blocco legale sul BLOB.

function setLegalHold(legalHoldEnabled: boolean, options?: BlobSetLegalHoldOptions): Promise<BlobSetLegalHoldResponse>

Parametri

legalHoldEnabled

boolean

options
BlobSetLegalHoldOptions

Opzioni facoltative per impostare il blocco legale nel BLOB.

Restituisce

Promise<BlobSetLegalHoldResponse>

setMetadata(Metadata, BlobSetMetadataOptions)

Imposta i metadati definiti dall'utente per il BLOB specificato come una o più coppie nome-valore.

Se non viene fornita alcuna opzione o nessun metadati definito nel parametro, i metadati del BLOB verranno rimossi.

Vedere https://docs.microsoft.com/en-us/rest/api/storageservices/set-blob-metadata

function setMetadata(metadata?: Metadata, options?: BlobSetMetadataOptions): Promise<BlobSetMetadataResponse>

Parametri

metadata
Metadata

Sostituire i metadati esistenti con questo valore. Se non viene rimosso alcun valore specificato i metadati esistenti.

options
BlobSetMetadataOptions

Opzioni facoltative per impostare l'operazione metadati.

Restituisce

Promise<BlobSetMetadataResponse>

setTags(Tags, BlobSetTagsOptions)

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

function setTags(tags: Tags, options?: BlobSetTagsOptions): Promise<BlobSetTagsResponse>

Parametri

tags
Tags
options
BlobSetTagsOptions

Restituisce

Promise<BlobSetTagsResponse>

syncCopyFromURL(string, BlobSyncCopyFromURLOptions)

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

Vedere https://docs.microsoft.com/en-us/rest/api/storageservices/copy-blob-from-url

function syncCopyFromURL(copySource: string, options?: BlobSyncCopyFromURLOptions): Promise<BlobCopyFromURLResponse>

Parametri

copySource

string

URL di origine da cui copiare, firma di accesso condiviso (SAS) potrebbe essere necessario per l'autenticazione

options
BlobSyncCopyFromURLOptions

Restituisce

Promise<BlobCopyFromURLResponse>

undelete(BlobUndeleteOptions)

Ripristina il contenuto e i metadati del BLOB eliminato temporanea e di eventuali snapshot eliminati soft associati. Undelete BLOB è supportato solo nella versione 2017-07-29 o successiva.

Vedere https://docs.microsoft.com/en-us/rest/api/storageservices/undelete-blob

function undelete(options?: BlobUndeleteOptions): Promise<BlobUndeleteResponse>

Parametri

options
BlobUndeleteOptions

Opzioni facoltative per l'operazione Di annullamento eliminazione BLOB.

Restituisce

Promise<BlobUndeleteResponse>

withSnapshot(string)

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

function withSnapshot(snapshot: string): BlobClient

Parametri

snapshot

string

Timestamp dello snapshot.

Restituisce

BlobClient

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

withVersion(string)

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): BlobClient

Parametri

versionId

string

VersionId.

Restituisce

BlobClient

Nuovo oggetto BLOBClient che punta alla versione di questo BLOB.