BlockBlobClient class

Riferimento

Pacchetto:: @azure/storage-blob

BlockBlobClient definisce un set di operazioni applicabili ai BLOB in blocchi.

Extends: BlobClient

Costruttori

BlockBlobClient(string, PipelineLike)	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.
BlockBlobClient(string, StorageSharedKeyCredential \| AnonymousCredential \| TokenCredential, StoragePipelineOptions)	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.
BlockBlobClient(string, string, string, StoragePipelineOptions)	Crea un'istanza di BlockBlobClient.

Proprietà

containerName	Il nome del contenitore di archiviazione a cui è associato il BLOB.
name	Nome del BLOB.

Proprietà ereditate

accountName
credential	Ad esempio AnonymousCredential, StorageSharedKeyCredential o qualsiasi credenziale del pacchetto `@azure/identity` 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

commitBlockList(string[], BlockBlobCommitBlockListOptions)	Scrive un BLOB specificando l'elenco di ID blocchi che costituiscono il BLOB. Per poter essere scritto come parte di un BLOB, è necessario che un blocco sia stato scritto correttamente nel server in un'operazione stageBlock precedente. È possibile chiamare commitBlockList per aggiornare un BLOB caricando solo i blocchi modificati, quindi eseguendo il commit dei blocchi nuovi ed esistenti insieme. Tutti i blocchi non specificati nell'elenco di blocchi e eliminati definitivamente. Vedere https://docs.microsoft.com/rest/api/storageservices/put-block-list
getBlockList(BlockListType, BlockBlobGetBlockListOptions)	Restituisce l'elenco di blocchi caricati come parte di un BLOB in blocchi usando il filtro dell'elenco di blocchi specificato. Vedere https://docs.microsoft.com/rest/api/storageservices/get-block-list
query(string, BlockBlobQueryOptions)	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); }); }
stageBlock(string, RequestBodyType, number, BlockBlobStageBlockOptions)	Carica il blocco specificato nell'area di gestione temporanea del BLOB in blocchi per essere eseguito in un secondo momento tramite una chiamata a commitBlockList. Vedere https://docs.microsoft.com/rest/api/storageservices/put-block
stageBlockFromURL(string, string, number, number, BlockBlobStageBlockFromURLOptions)	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. Vedere https://docs.microsoft.com/en-us/rest/api/storageservices/put-block-from-url
syncUploadFromURL(string, BlockBlobSyncUploadFromURLOptions)	Crea un nuovo BLOB in blocchi in cui il contenuto del BLOB viene letto da un DETERMINATO URL. 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 stageBlockFromURL e commitBlockList.
upload(RequestBodyType, number, BlockBlobUploadOptions)	Crea un nuovo BLOB in blocchi o aggiorna il contenuto di un BLOB in blocchi esistente. L'aggiornamento di un BLOB in blocchi esistente sovrascrive tutti i 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 stageBlock e commitBlockList. Si tratta di un metodo di caricamento non parallelo, usare uploadFile, uploadStream o uploadBrowserData per ottenere prestazioni migliori con il caricamento della concorrenza. Vedere https://docs.microsoft.com/rest/api/storageservices/put-blob
uploadBrowserData(Blob \| ArrayBuffer \| ArrayBufferView, BlockBlobParallelUploadOptions)	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à stageBlock per caricare blocchi e infine chiamare commitBlockList per eseguire il commit dell'elenco di blocchi. Un'opzione blobHTTPHeaders comune da impostare è , consentendo al browser di fornire funzionalità in base al tipo di file.
uploadData(Blob \| ArrayBuffer \| ArrayBufferView \| Buffer, BlockBlobParallelUploadOptions)	Carica un oggetto Buffer(Node.js)/Blob(browser)/ArrayBuffer/ArrayBufferView in un oggetto BlockBlob. Quando la lunghezza dei dati non è superiore a quella specificata maxSingleShotSize (il valore predefinito è <xref:BLOCK_BLOB_MAX_UPLOAD_BLOB_BYTES>), questo metodo userà 1 caricamento chiamata per completare il caricamento. In caso contrario, questo metodo chiamerà stageBlock per caricare blocchi e infine chiamare commitBlockList per eseguire il commit dell'elenco di blocchi. Un'opzione blobHTTPHeaders comune da impostare è , consentendo al browser di fornire funzionalità in base al tipo di file.
uploadFile(string, BlockBlobParallelUploadOptions)	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.
uploadStream(Readable, number, number, BlockBlobUploadStreamOptions)	DISPONIBILE SOLO IN NODE.JS RUNTIME. Carica un flusso leggibile Node.js 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().
withSnapshot(string)	Crea un nuovo oggetto BlockBlobClient identico all'origine, ma con il timestamp dello snapshot specificato. Specificare "" rimuoverà lo snapshot e restituirà un URL al BLOB di base.

Metodi ereditati

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 dell'operazione a esecuzione prolungata che consente di attendere a tempo indeterminato fino al completamento della copia. Puoi anche 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. Solo gli account di archiviazione creati il 7 giugno 2012 consentono l'operazione copia BLOB da un altro account di archiviazione. 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 in modifica (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 viene eliminato in un secondo momento durante l'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 presente. Il BLOB viene eliminato in un secondo momento durante l'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 Recupera BLOB per leggere uno snapshot. In Node.jsi dati vengono restituiti in un flusso leggibileStreamBody 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 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 file fino a circa un gigabyte su sistemi a 32 bit o circa due gigabyte su sistemi a 64 bit a causa di limitazioni di Node.js/V8. Per i BLOB superiori a questa dimensione, prendere in considerazione downloadToFile.
downloadToBuffer(number, number, BlobDownloadToBufferOptions)	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 file fino a circa un gigabyte su sistemi a 32 bit o circa due gigabyte su sistemi a 64 bit a causa di limitazioni di Node.js/V8. Per i BLOB superiori a questa dimensione, prendere in considerazione downloadToFile.
downloadToFile(string, number, number, BlobDownloadOptions)	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.
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 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.
generateSasStringToSign(BlobGenerateSasUrlOptions)	Disponibile solo per BlobClient costruito con credenziali chiave condivise. Genera una stringa per firmare un URI di firma di accesso condiviso del servizio BLOB in base alle proprietà e ai parametri del client passati. La firma di accesso condiviso è firmata dalle credenziali della chiave condivisa del client. Vedere https://docs.microsoft.com/en-us/rest/api/storageservices/constructing-a-service-sas
generateSasUrl(BlobGenerateSasUrlOptions)	Disponibile solo per BlobClient costruito con credenziali chiave condivise. 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 è firmata dalle credenziali della chiave condivisa del client. Vedere https://docs.microsoft.com/en-us/rest/api/storageservices/constructing-a-service-sas
generateUserDelegationSasStringToSign(BlobGenerateSasUrlOptions, UserDelegationKey)	Disponibile solo per BlobClient costruito con credenziali chiave condivise. Genera una stringa per firmare un URI di firma di accesso condiviso del servizio BLOB in base alle proprietà e ai parametri del client passati. La firma di accesso condiviso è firmata dalla chiave di delega dell'utente di input. Vedere https://docs.microsoft.com/en-us/rest/api/storageservices/constructing-a-service-sas
generateUserDelegationSasUrl(BlobGenerateSasUrlOptions, UserDelegationKey)	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 è firmata dalla chiave di delega dell'utente di input. Vedere https://docs.microsoft.com/en-us/rest/api/storageservices/constructing-a-service-sas
getAccountInfo(BlobGetAccountInfoOptions)	L'operazione Get Account Information restituisce il nome sku e il tipo di account per l'account specificato. L'operazione Get Account Information è disponibile nelle versioni del servizio a partire dalla versione 2018-03-28. Vedere https://docs.microsoft.com/en-us/rest/api/storageservices/get-account-information
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 relative chiavi in lettere minuscole, anche se originariamente contengono caratteri maiuscoli. Ciò differisce dalle chiavi di metadati restituite dai metodi di ContainerClient che elencano i BLOB usando l'opzione `includeMetadata`, che manterrà la combinazione di 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 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. 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 specificato 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 i criteri di immutabilità nel BLOB.
setLegalHold(boolean, BlobSetLegalHoldOptions)	Impostare il blocco a fini giudiziari nel BLOB.
setMetadata(Metadata, BlobSetMetadataOptions)	Imposta i metadati definiti dall'utente per il BLOB specificato come una o più coppie nome-valore. Se non viene specificata alcuna opzione o nessun metadato 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. 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 (':'), equals ('=') e sottolineatura ('_') .
syncCopyFromURL(string, BlobSyncCopyFromURLOptions)	L'operazione Copy From 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 soft e degli snapshot eliminati soft associati. Il BLOB di annullamento dell'eliminazione è supportato solo nella versione 2017-07-29 o successiva. Vedere https://docs.microsoft.com/en-us/rest/api/storageservices/undelete-blob
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

BlockBlobClient(string, PipelineLike)

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

url: string

Stringa URL che punta al BLOB in blocchi di Archiviazione di Azure, ad esempio "https://myaccount.blob.core.windows.net/mycontainer/blockblob". È possibile aggiungere una firma di accesso condiviso se si usa AnonymousCredential, ad esempio "https://myaccount.blob.core.windows.net/mycontainer/blockblob?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.

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

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

Parametri

url: string

credential: StorageSharedKeyCredential | AnonymousCredential | TokenCredential

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

options: StoragePipelineOptions

Opzionale. Opzioni per configurare la pipeline HTTP.

BlockBlobClient(string, string, string, StoragePipelineOptions)

Crea un'istanza di BlockBlobClient.

new BlockBlobClient(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 - Esempio di stringa di connessione sas DefaultEndpointsProtocol=https;AccountName=myaccount;AccountKey=accountKey;EndpointSuffix=core.windows.net - 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

Opzionale. Opzioni per configurare la pipeline HTTP.

Dettagli proprietà

containerName

Il nome del contenitore di archiviazione a cui è associato il 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 daBlobClient.accountName

credential

credential: StorageSharedKeyCredential | AnonymousCredential | TokenCredential

Valore della proprietà

StorageSharedKeyCredential | AnonymousCredential | TokenCredential

ereditato daBlobClient.credential

url

Valore stringa URL codificato.

url: string

Valore della proprietà

string

ereditato daBlobClient.url

Dettagli metodo

commitBlockList(string[], BlockBlobCommitBlockListOptions)

Scrive un BLOB specificando l'elenco di ID blocchi che costituiscono il BLOB. Per poter essere scritto come parte di un BLOB, è necessario che un blocco sia stato scritto correttamente nel server in un'operazione stageBlock precedente. È possibile chiamare commitBlockList per aggiornare un BLOB caricando solo i blocchi modificati, quindi eseguendo il commit dei blocchi nuovi ed esistenti insieme. Tutti i blocchi non specificati nell'elenco di blocchi e eliminati definitivamente.

Vedere https://docs.microsoft.com/rest/api/storageservices/put-block-list

function commitBlockList(blocks: string[], options?: BlockBlobCommitBlockListOptions): Promise<BlockBlobCommitBlockListResponse>

Parametri

blocks: string[]

Matrice di valore a 64 byte con codifica base64

options: BlockBlobCommitBlockListOptions

Opzioni per l'operazione Block Blob Commit Block Block List.

Restituisce

Promise<BlockBlobCommitBlockListResponse>

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

getBlockList(BlockListType, BlockBlobGetBlockListOptions)

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

Vedere https://docs.microsoft.com/rest/api/storageservices/get-block-list

function getBlockList(listType: BlockListType, options?: BlockBlobGetBlockListOptions): Promise<BlockBlobGetBlockListResponse>

Parametri

listType: BlockListType

Specifica se restituire l'elenco dei blocchi di cui è stato eseguito il commit, l'elenco di blocchi di cui non è stato eseguito il commit o entrambi gli elenchi insieme.

options: BlockBlobGetBlockListOptions

Opzioni per l'operazione Get Block Blob Get Block List.

Restituisce

Promise<BlockBlobGetBlockListResponse>

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

query(string, BlockBlobQueryOptions)

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

Parametri

query: string

options: BlockBlobQueryOptions

Restituisce

Promise<BlobDownloadResponseModel>

stageBlock(string, RequestBodyType, number, BlockBlobStageBlockOptions)

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

Vedere https://docs.microsoft.com/rest/api/storageservices/put-block

function stageBlock(blockId: string, body: RequestBodyType, contentLength: number, options?: BlockBlobStageBlockOptions): Promise<BlockBlobStageBlockResponse>

Parametri

blockId: string

Valore a 64 byte con codifica base64

body: HttpRequestBody

Dati da caricare nell'area di gestione temporanea.

contentLength: number

Numero di byte da caricare.

options: BlockBlobStageBlockOptions

Opzioni per l'operazione Blocco di fasi BLOB in blocchi.

Restituisce

Promise<BlockBlobStageBlockResponse>

Dati di risposta per l'operazione blocco di fasi BLOB in blocchi.

stageBlockFromURL(string, string, number, number, BlockBlobStageBlockFromURLOptions)

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.

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

Parametri

blockId: string

Valore a 64 byte con codifica base64

sourceURL: string

Specifica l'URL del BLOB. Il valore può essere un URL di lunghezza massima di 2 KB che specifica un BLOB. Il valore deve essere codificato con URL come apparirebbe in un URI della richiesta. Il BLOB di origine deve essere pubblico o deve essere autenticato tramite una firma di accesso condiviso. Se il BLOB di origine è pubblico, non è necessaria alcuna autenticazione per eseguire l'operazione. Ecco alcuni esempi di URL di oggetti di origine: - https://myaccount.blob.core.windows.net/mycontainer/myblob - https://myaccount.blob.core.windows.net/mycontainer/myblob?snapshot=

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

Opzioni per l'operazione Block Blob Stage Block From URL .Options to the Block Blob Stage Block From URL operation.

Restituisce

Promise<BlockBlobStageBlockFromURLResponse>

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

syncUploadFromURL(string, BlockBlobSyncUploadFromURLOptions)

Crea un nuovo BLOB in blocchi in cui il contenuto del BLOB viene letto da un DETERMINATO URL. 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 stageBlockFromURL e commitBlockList.

function syncUploadFromURL(sourceURL: string, options?: BlockBlobSyncUploadFromURLOptions): Promise<BlockBlobPutBlobFromUrlResponse>

Parametri

sourceURL: string

options: BlockBlobSyncUploadFromURLOptions

Parametri facoltativi.

Restituisce

Promise<BlockBlobPutBlobFromUrlResponse>

upload(RequestBodyType, number, BlockBlobUploadOptions)

Crea un nuovo BLOB in blocchi o aggiorna il contenuto di un BLOB in blocchi esistente. L'aggiornamento di un BLOB in blocchi esistente sovrascrive tutti i 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 stageBlock e commitBlockList.

Si tratta di un metodo di caricamento non parallelo, usare uploadFile, uploadStream o uploadBrowserData per ottenere prestazioni migliori con il caricamento della concorrenza.

Vedere https://docs.microsoft.com/rest/api/storageservices/put-blob

function upload(body: RequestBodyType, contentLength: number, options?: BlockBlobUploadOptions): Promise<BlockBlobUploadResponse>

Parametri

body: HttpRequestBody

BLOB, string, ArrayBuffer, ArrayBufferView o una funzione che restituisce un nuovo flusso leggibile il cui offset proviene dall'origine dati.

contentLength: number

Lunghezza del corpo in byte. Usare Buffer.byteLength() per calcolare la lunghezza del corpo per una stringa, inclusi caratteri non con codifica Base64/Hex.

options: BlockBlobUploadOptions

Opzioni per l'operazione di caricamento BLOB in blocchi.

Restituisce

Promise<BlockBlobUploadResponse>

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

uploadBrowserData(Blob | ArrayBuffer | ArrayBufferView, BlockBlobParallelUploadOptions)

Avviso

Questa API è ora deprecata.

Use uploadData instead.

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à stageBlock per caricare blocchi e infine chiamare commitBlockList per eseguire il commit dell'elenco di blocchi.

Un'opzione blobHTTPHeaders comune da impostare è , consentendo al browser di fornire funzionalità in base al tipo di file.

function uploadBrowserData(browserData: Blob | ArrayBuffer | ArrayBufferView, options?: BlockBlobParallelUploadOptions): Promise<BlobUploadCommonResponse>

Parametri

browserData: Blob | ArrayBuffer | ArrayBufferView

BLOB, File, ArrayBuffer o ArrayBufferView

options: BlockBlobParallelUploadOptions

Opzioni per caricare i dati del browser.

Restituisce

Promise<BlobUploadCommonResponse>

Dati di risposta per l'operazione di caricamento BLOB.

uploadData(Blob | ArrayBuffer | ArrayBufferView | Buffer, BlockBlobParallelUploadOptions)

Carica un oggetto Buffer(Node.js)/Blob(browser)/ArrayBuffer/ArrayBufferView in un oggetto BlockBlob.

Quando la lunghezza dei dati non è superiore a quella specificata maxSingleShotSize (il valore predefinito è <xref:BLOCK_BLOB_MAX_UPLOAD_BLOB_BYTES>), questo metodo userà 1 caricamento chiamata per completare il caricamento. In caso contrario, questo metodo chiamerà stageBlock per caricare blocchi e infine chiamare commitBlockList per eseguire il commit dell'elenco di blocchi.

Un'opzione blobHTTPHeaders comune da impostare è , consentendo al browser di fornire funzionalità in base al tipo di file.

function uploadData(data: Blob | ArrayBuffer | ArrayBufferView | Buffer, options?: BlockBlobParallelUploadOptions): Promise<BlobUploadCommonResponse>

Parametri

data: Blob | ArrayBuffer | ArrayBufferView | Buffer

Buffer(Node.js), BLOB, ArrayBuffer o ArrayBufferView

options: BlockBlobParallelUploadOptions

Restituisce

Promise<BlobUploadCommonResponse>

uploadFile(string, BlockBlobParallelUploadOptions)

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

Parametri

filePath: string

Percorso completo del file locale

options: BlockBlobParallelUploadOptions

Opzioni per l'operazione Carica nel BLOB in blocchi.

Restituisce

Promise<BlobUploadCommonResponse>

Dati di risposta per l'operazione di caricamento BLOB.

uploadStream(Readable, number, number, BlockBlobUploadStreamOptions)

DISPONIBILE SOLO IN NODE.JS RUNTIME.

Carica un flusso leggibile Node.js 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): Promise<BlobUploadCommonResponse>

Parametri

stream: Readable

Node.js flusso leggibile

bufferSize: number

Dimensioni di ogni buffer allocato, anche le dimensioni del blocco nel BLOB in blocchi caricato. Il valore predefinito è 8 MB

maxConcurrency: number

La concorrenza massima indica il numero massimo di buffer che possono essere allocati, correlazione positiva con la concorrenza massima di caricamento. Il valore predefinito è 5

options: BlockBlobUploadStreamOptions

Opzioni per caricare l'operazione Flusso in BLOB in blocchi.

Restituisce

Promise<BlobUploadCommonResponse>

Dati di risposta per l'operazione di caricamento BLOB.

withSnapshot(string)

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

function withSnapshot(snapshot: string): BlockBlobClient

Parametri

snapshot: string

Timestamp dello snapshot.

Restituisce

BlockBlobClient

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

Dettagli dei metodi ereditati

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 dall'URL.

options: BlobAbortCopyFromURLOptions

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

Restituisce

Promise<BlobAbortCopyFromURLResponse>

ereditato daBlobClient.abortCopyFromURL

beginCopyFromURL(string, BlobBeginCopyFromURLOptions)

Copia in modo asincrono un BLOB in una destinazione all'interno dell'account di archiviazione. Questo metodo restituisce un poller dell'operazione a esecuzione prolungata che consente di attendere a tempo indeterminato fino al completamento della copia. Puoi anche 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. Solo gli account di archiviazione creati il 7 giugno 2012 consentono l'operazione copia BLOB da un altro account di archiviazione.

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 in modifica (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 per l'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>>

ereditato daBlobClient.beginCopyFromURL

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>

ereditato daBlobClient.createSnapshot

delete(BlobDeleteOptions)

Contrassegna il BLOB o lo snapshot specificato per l'eliminazione. Il BLOB viene eliminato in un secondo momento durante l'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>

ereditato daBlobClient.delete

deleteIfExists(BlobDeleteOptions)

Contrassegna il BLOB o lo snapshot specificato per l'eliminazione, se presente. Il BLOB viene eliminato in un secondo momento durante l'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>

ereditato daBlobClient.deleteIfExists

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 immutabilità nel BLOB.

Restituisce

Promise<BlobDeleteImmutabilityPolicyResponse>

Ereditato daBlobClient.deleteImmutabilityPolicy

download(number, number, BlobDownloadOptions)

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

In Node.jsi dati vengono restituiti in un flusso leggibileStreamBody
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 di download BLOB.

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

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

ereditato daBlobClient.download

downloadToBuffer(Buffer, number, number, BlobDownloadToBufferOptions)

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 file fino a circa un gigabyte su sistemi a 32 bit o circa due gigabyte su sistemi a 64 bit a causa di limitazioni di Node.js/V8. Per i BLOB superiori a questa dimensione, prendere in considerazione downloadToFile.

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

Parametri

buffer: Buffer

Il buffer da riempire deve avere una lunghezza maggiore del conteggio

offset: number

Da quale posizione del BLOB in 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>

Ereditato daBlobClient.downloadToBuffer

downloadToBuffer(number, number, BlobDownloadToBufferOptions)

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.

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

Parametri

offset: number

Da quale posizione del BLOB in 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>

Ereditato daBlobClient.downloadToBuffer

downloadToFile(string, number, number, BlobDownloadOptions)

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

Parametri

filePath: string

offset: number

Da quale posizione del BLOB in blocchi scaricare.

count: number

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

options: BlobDownloadOptions

Opzioni per le opzioni di download blob.

Restituisce

Promise<BlobDownloadResponseParsed>

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

ereditato daBlobClient.downloadToFile

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

Parametri

options: BlobExistsOptions

opzioni per l'operazione Exists.

Restituisce

Promise<boolean>

ereditato daBlobClient.exists

generateSasStringToSign(BlobGenerateSasUrlOptions)

Disponibile solo per BlobClient costruito con credenziali chiave condivise.

Genera una stringa per firmare un URI di firma di accesso condiviso del servizio BLOB in base alle proprietà e ai parametri del client passati. La firma di accesso condiviso è firmata dalle credenziali della chiave condivisa del client.

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

function generateSasStringToSign(options: BlobGenerateSasUrlOptions): string

Parametri

options: BlobGenerateSasUrlOptions

Parametri facoltativi.

Restituisce

string

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

Ereditato daBlobClient.generateSasStringToSign

generateSasUrl(BlobGenerateSasUrlOptions)

Disponibile solo per BlobClient costruito con credenziali chiave condivise.

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 è firmata dalle credenziali 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 della risorsa rappresentata da questo client, seguito dal token di firma di accesso condiviso generato.

ereditato daBlobClient.generateSasUrl

generateUserDelegationSasStringToSign(BlobGenerateSasUrlOptions, UserDelegationKey)

Disponibile solo per BlobClient costruito con credenziali chiave condivise.

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

function generateUserDelegationSasStringToSign(options: BlobGenerateSasUrlOptions, userDelegationKey: UserDelegationKey): string

Parametri

options: BlobGenerateSasUrlOptions

Parametri facoltativi.

userDelegationKey: UserDelegationKey

Valore restituito di blobServiceClient.getUserDelegationKey()

Restituisce

string

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

Ereditato daBlobClient.generateUserDelegationSasStringToSign

generateUserDelegationSasUrl(BlobGenerateSasUrlOptions, UserDelegationKey)

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 è firmata dalla chiave di delega dell'utente di input.

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

function generateUserDelegationSasUrl(options: BlobGenerateSasUrlOptions, userDelegationKey: UserDelegationKey): Promise<string>

Parametri

options: BlobGenerateSasUrlOptions

Parametri facoltativi.

userDelegationKey: UserDelegationKey

Valore restituito di blobServiceClient.getUserDelegationKey()

Restituisce

Promise<string>

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

Ereditato daBlobClient.generateUserDelegationSasUrl

getAccountInfo(BlobGetAccountInfoOptions)

L'operazione Get Account Information restituisce il nome sku e il tipo di account per l'account specificato. L'operazione Get Account Information è disponibile nelle versioni del servizio a partire dalla versione 2018-03-28.

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

function getAccountInfo(options?: BlobGetAccountInfoOptions): Promise<BlobGetAccountInfoResponse>

Parametri

options: BlobGetAccountInfoOptions

Opzioni per l'operazione Service Get Account Info .Options to the Service Get Account Info operation.

Restituisce

Promise<BlobGetAccountInfoResponse>

Dati di risposta per l'operazione Di recupero dell'account del servizio.

ereditato daBlobClient.getAccountInfo

getAppendBlobClient()

Crea un oggetto AppendBlobClient.

function getAppendBlobClient(): AppendBlobClient

Restituisce

AppendBlobClient

Ereditato daBlobClient.getAppendBlobClient

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.

Ereditato daBlobClient.getBlobLeaseClient

getBlockBlobClient()

Crea un oggetto BlockBlobClient.

function getBlockBlobClient(): BlockBlobClient

Restituisce

BlockBlobClient

Ereditato daBlobClient.getBlockBlobClient

getPageBlobClient()

Crea un oggetto PageBlobClient.

function getPageBlobClient(): PageBlobClient

Restituisce

PageBlobClient

Ereditato daBlobClient.getPageBlobClient

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 relative chiavi in lettere minuscole, anche se originariamente contengono caratteri maiuscoli. Ciò differisce dalle chiavi di metadati restituite dai metodi di ContainerClient che elencano i BLOB usando l'opzione includeMetadata, che manterrà la combinazione di maiuscole e minuscole originali.

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

Parametri

options: BlobGetPropertiesOptions

Opzioni facoltative per l'operazione Recupera proprietà.

Restituisce

Promise<BlobGetPropertiesResponse>

Ereditato daBlobClient.getProperties

getTags(BlobGetTagsOptions)

Ottiene i tag associati al BLOB sottostante.

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

Parametri

options: BlobGetTagsOptions

Restituisce

Promise<BlobGetTagsResponse>

ereditato daBlobClient.getTags

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

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 livello del set di BLOB.

Restituisce

Promise<BlobSetTierResponse>

Ereditato daBlobClient.setAccessTier

setHTTPHeaders(BlobHTTPHeaders, BlobSetHTTPHeadersOptions)

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.

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 specificato 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 consentire al browser di fornire funzionalità in base al tipo di file.

options: BlobSetHTTPHeadersOptions

Opzioni facoltative per l'operazione Imposta intestazioni HTTP del BLOB.

Restituisce

Promise<BlobSetHTTPHeadersResponse>

Ereditato daBlobClient.setHTTPHeaders

setImmutabilityPolicy(BlobImmutabilityPolicy, BlobSetImmutabilityPolicyOptions)

Impostare i criteri di immutabilità nel BLOB.

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

Parametri

immutabilityPolicy: BlobImmutabilityPolicy

options: BlobSetImmutabilityPolicyOptions

Opzioni facoltative per impostare i criteri di immutabilità nel BLOB.

Restituisce

Promise<BlobSetImmutabilityPolicyResponse>

Ereditato daBlobClient.setImmutabilityPolicy

setLegalHold(boolean, BlobSetLegalHoldOptions)

Impostare il blocco a fini giudiziari nel BLOB.

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

Parametri

legalHoldEnabled: boolean

options: BlobSetLegalHoldOptions

Opzioni facoltative per impostare il blocco a fini giudiziari nel BLOB.

Restituisce

Promise<BlobSetLegalHoldResponse>

Ereditato daBlobClient.setLegalHold

setMetadata(Metadata, BlobSetMetadataOptions)

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

Se non viene specificata alcuna opzione o nessun metadato 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 specificato alcun valore, i metadati esistenti verranno rimossi.

options: BlobSetMetadataOptions

Opzioni facoltative per impostare l'operazione metadati.

Restituisce

Promise<BlobSetMetadataResponse>

Ereditato daBlobClient.setMetadata

setTags(Tags, BlobSetTagsOptions)

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 (':'), equals ('=') e sottolineatura ('_') .

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

Parametri

tags: Tags

options: BlobSetTagsOptions

Restituisce

Promise<BlobSetTagsResponse>

ereditato daBlobClient.setTags

syncCopyFromURL(string, BlobSyncCopyFromURLOptions)

L'operazione Copy From 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>

Ereditato daBlobClient.syncCopyFromURL

undelete(BlobUndeleteOptions)

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.

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 dell'eliminazione BLOB.

Restituisce

Promise<BlobUndeleteResponse>

ereditato daBlobClient.undelete

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.

Ereditato daBlobClient.withVersion

Condividi tramite

BlockBlobClient class

Costruttori

Proprietà

Proprietà ereditate

Metodi

Metodi ereditati

Dettagli costruttore

BlockBlobClient(string, PipelineLike)

Parametri

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

Parametri

BlockBlobClient(string, string, string, StoragePipelineOptions)

Parametri

Dettagli proprietà

containerName

Valore della proprietà

name

Valore della proprietà

Dettagli proprietà ereditate

accountName

Valore della proprietà

credential

Valore della proprietà

url

Valore della proprietà

Dettagli metodo

commitBlockList(string[], BlockBlobCommitBlockListOptions)

Parametri

Restituisce

getBlockList(BlockListType, BlockBlobGetBlockListOptions)

Parametri

Restituisce

query(string, BlockBlobQueryOptions)

Parametri

Restituisce

stageBlock(string, RequestBodyType, number, BlockBlobStageBlockOptions)

Parametri

Restituisce

stageBlockFromURL(string, string, number, number, BlockBlobStageBlockFromURLOptions)

Parametri

Restituisce

syncUploadFromURL(string, BlockBlobSyncUploadFromURLOptions)

Parametri

Restituisce

upload(RequestBodyType, number, BlockBlobUploadOptions)

Parametri

Restituisce

uploadBrowserData(Blob | ArrayBuffer | ArrayBufferView, BlockBlobParallelUploadOptions)

Parametri

Restituisce

uploadData(Blob | ArrayBuffer | ArrayBufferView | Buffer, BlockBlobParallelUploadOptions)

Parametri

Restituisce

uploadFile(string, BlockBlobParallelUploadOptions)

Parametri

Restituisce

uploadStream(Readable, number, number, BlockBlobUploadStreamOptions)

Parametri

Restituisce

withSnapshot(string)

Parametri

Restituisce

Dettagli dei metodi ereditati

abortCopyFromURL(string, BlobAbortCopyFromURLOptions)

Parametri

Restituisce

beginCopyFromURL(string, BlobBeginCopyFromURLOptions)

Parametri

Restituisce

createSnapshot(BlobCreateSnapshotOptions)

Parametri

Restituisce

delete(BlobDeleteOptions)

Parametri

Restituisce

deleteIfExists(BlobDeleteOptions)

Parametri

Restituisce

deleteImmutabilityPolicy(BlobDeleteImmutabilityPolicyOptions)