BlobClient class
BlobClient rappresenta un URL di un BLOB di Archiviazione di Azure; il BLOB può essere un BLOB in blocchi, un BLOB di accodamento o un BLOB di pagine.
- Extends
-
StorageClient
Costruttori
Blob |
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à eliminata due volte, verranno escape solo caratteri speciali nel percorso URL. Se un nome BLOB include ? o %, il nome del BLOB deve essere codificato nell'URL. |
Blob |
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à eliminata due volte, verranno escape solo caratteri speciali nel percorso URL. Se un nome BLOB include ? o %, il nome del BLOB deve essere codificato nell'URL. |
Blob |
Crea un'istanza di BLOBClient dalla stringa di connessione. |
Proprietà
container |
Il nome del contenitore di archiviazione a cui è associato il BLOB. |
name | Nome del BLOB. |
Proprietà ereditate
account |
|
credential | Ad esempio AnonymousCredential, StorageSharedKeyCredential o qualsiasi credenziale del |
url | Valore stringa URL codificato. |
Metodi
abort |
Interrompe un'operazione blob di copia asincrona in sospeso e lascia un BLOB di destinazione con lunghezza zero e metadati completi. Versione 2012-02-12 e versioni successive. Vedere https://docs.microsoft.com/en-us/rest/api/storageservices/abort-copy-blob |
begin |
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 in modo indefinito fino al completamento della copia.
È anche possibile annullare una copia prima che venga completata chiamando Nella versione 2012-02-12 e successiva l'origine per un'operazione BLOB di copia può essere un BLOB di commit in qualsiasi account di archiviazione di Azure. A partire dalla versione 2015-02-21, l'origine per un'operazione blob di copia 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:
Esempio di uso del polling manuale:
Esempio di utilizzo degli aggiornamenti dello stato:
Esempio che usa un intervallo di polling modificato (predefinito 15 secondi):
Esempio di annullamento della copia:
|
create |
Crea uno snapshot di sola lettura di un BLOB. Vedere https://docs.microsoft.com/en-us/rest/api/storageservices/snapshot-blob |
delete(Blob |
Contrassegna il BLOB o lo snapshot specificati 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 |
delete |
Contrassegna il BLOB o lo snapshot specificato per l'eliminazione se esiste. 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 |
delete |
Eliminare i criteri di immutablility nel BLOB. |
download(number, number, Blob |
Legge o scarica un BLOB dal sistema, inclusi i relativi metadati e proprietà. È anche possibile chiamare Get BLOB per leggere uno snapshot.
Vedere https://docs.microsoft.com/en-us/rest/api/storageservices/get-blob |
download |
DISPONIBILE SOLO IN NODE.JS RUNTIME. Scarica un BLOB di Azure in parallelo in un buffer. Offset e conteggio sono facoltativi, scarica l'intero BLOB se non vengono forniti. Avviso: i buffer possono supportare solo i file fino a circa un gigabyte nei sistemi a 32 bit o circa due gigabyte nei sistemi a 64 bit a causa delle limitazioni di Node.js/V8. Per i BLOB superiori a queste dimensioni, prendere in considerazione downloadToFile. |
download |
DISPONIBILE SOLO IN NODE.JS RUNTIME. Scarica un BLOB di Azure in parallelo in un buffer. Offset e conteggio sono facoltativi, scarica l'intero BLOB se non vengono forniti. Avviso: i buffer possono supportare solo i file fino a circa un gigabyte nei sistemi a 32 bit o circa due gigabyte nei sistemi a 64 bit a causa delle limitazioni di Node.js/V8. Per i BLOB superiori a queste dimensioni, prendere in considerazione downloadToFile. |
download |
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(Blob |
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. |
generate |
Disponibile solo per BlobClient costruito con credenziali di chiave condivisa. Genera un URI di firma di accesso condiviso (SAS) del servizio BLOB in base alle proprietà e ai parametri del client passati. La firma di accesso condiviso viene firmata dalle credenziali della chiave condivisa del client. Vedere https://docs.microsoft.com/en-us/rest/api/storageservices/constructing-a-service-sas |
get |
Crea un oggetto AppendBlobClient. |
get |
Ottenere un BlobLeaseClient che gestisce i lease nel BLOB. |
get |
Crea un oggetto BlockBlobClient. |
get |
Crea un oggetto PageBlobClient. |
get |
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 |
get |
Ottiene i tag associati al BLOB sottostante. |
set |
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 |
set |
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 |
set |
Impostare i criteri di immutabilità nel BLOB. |
set |
Impostare il blocco a fini giudiziari sul BLOB. |
set |
Imposta i metadati definiti dall'utente per il BLOB specificato come una o più coppie nome-valore. Se non è stata specificata alcuna opzione o nessun metadati definito nel parametro, i metadati del BLOB verranno rimossi. Vedere https://docs.microsoft.com/en-us/rest/api/storageservices/set-blob-metadata |
set |
Imposta i tag nel BLOB sottostante. Un BLOB può avere fino a 10 tag. I tasti tag devono essere compresi tra 1 e 128 caratteri. I valori dei tag devono essere compresi tra 0 e 256 caratteri. I caratteri di chiave e valore di tag validi includono lettere minuscole e maiuscole, cifre (0-9), spazio (' '), più ('+'), meno ('-'), punto ('.'), barra ('/'), due punti (':'), uguale ('=') e sottolineatura ('_') . |
sync |
L'operazione Copia da URL sincrona copia un BLOB o una risorsa Internet in un nuovo BLOB. Non restituirà una risposta fino al completamento della copia. Vedere https://docs.microsoft.com/en-us/rest/api/storageservices/copy-blob-from-url |
undelete(Blob |
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 |
with |
Crea un nuovo oggetto BlobClient identico all'origine, ma con il timestamp dello snapshot specificato. Specificare "" rimuoverà lo snapshot e restituirà un client al BLOB di base. |
with |
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à eliminata due volte, verranno escape solo caratteri speciali nel percorso URL. Se un nome 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à eliminata due volte, verranno escape solo caratteri speciali nel percorso URL. Tuttavia, se un nome 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à eliminata due volte, verranno escape solo caratteri speciali nel percorso URL. Se un nome 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 usata AnonymousCredential.
- options
- StoragePipelineOptions
facoltativo. 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 nel runtime di NODE.JS. ] Esempio di stringa di connessione account -DefaultEndpointsProtocol=https;AccountName=myaccount;AccountKey=accountKey;EndpointSuffix=core.windows.net
Esempio di stringa di connessione SAS - BlobEndpoint=https://myaccount.blob.core.windows.net/;QueueEndpoint=https://myaccount.queue.core.windows.net/;FileEndpoint=https://myaccount.file.core.windows.net/;TableEndpoint=https://myaccount.table.core.windows.net/;SharedAccessSignature=sasString
- containerName
-
string
Nome del contenitore.
- blobName
-
string
Nome BLOB.
- options
- StoragePipelineOptions
facoltativo. 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 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 usata AnonymousCredential.
credential: StorageSharedKeyCredential | AnonymousCredential | TokenCredential
Valore della proprietà
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 blob di copia asincrona in sospeso e lascia un BLOB di destinazione con lunghezza zero e metadati completi. Versione 2012-02-12 e versioni 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 Copia di interruzione BLOB dall'URL.
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 in modo indefinito fino al completamento della copia.
È anche possibile annullare una copia prima che venga completata chiamando cancelOperation
il 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 genera un errore.
Nella versione 2012-02-12 e successiva l'origine per un'operazione BLOB di copia può essere un BLOB di commit in qualsiasi account di archiviazione di Azure. A partire dalla versione 2015-02-21, l'origine per un'operazione blob di copia 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 uso 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 (predefinito 15 secondi):
const copyPoller = await blobClient.beginCopyFromURL('url', {
intervalInMs: 1000 // poll blob every 1 second for copy progress
});
const result = await copyPoller.pollUntilDone();
Esempio di 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 Avvio copia BLOB dall'URL.
Restituisce
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 Creazione snapshot BLOB.
Restituisce
Promise<BlobCreateSnapshotResponse>
delete(BlobDeleteOptions)
Contrassegna il BLOB o lo snapshot specificati 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 esiste. 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
Opzioni facoltative per eliminare i criteri di immutabilità nel BLOB.
Restituisce
Promise<BlobDeleteImmutabilityPolicyResponse>
download(number, number, BlobDownloadOptions)
Legge o scarica un BLOB dal sistema, inclusi i relativi metadati e proprietà. È anche possibile chiamare Get BLOB per leggere uno snapshot.
- In Node.js i dati vengono restituiti in un flusso leggibileStreamBody
- Nei browser i dati vengono restituiti in un blob promiseBody
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>
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 i file fino a circa un gigabyte nei sistemi a 32 bit o circa due gigabyte nei sistemi a 64 bit a causa delle limitazioni di Node.js/V8. Per i BLOB superiori a queste dimensioni, 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 un valore non definito
- options
- BlobDownloadToBufferOptions
BlobDownloadToBufferOptions
Restituisce
Promise<Buffer>
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 i file fino a circa un gigabyte nei sistemi a 32 bit o circa due gigabyte nei sistemi a 64 bit a causa delle limitazioni di Node.js/V8. Per i BLOB superiori a queste dimensioni, prendere in considerazione downloadToFile.
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 un valore non definito
- options
- BlobDownloadToBufferOptions
BlobDownloadToBufferOptions
Restituisce
Promise<Buffer>
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 quando si passa un valore non definito.
- options
- BlobDownloadOptions
Opzioni per il download del BLOB.
Restituisce
Promise<BlobDownloadResponseParsed>
I dati di risposta per l'operazione di download blob, ma con readableStreamBody impostato su un valore non definito perché il contenuto è già letto e scritto in un file locale nel percorso specificato.
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>
generateSasUrl(BlobGenerateSasUrlOptions)
Disponibile solo per BlobClient costruito con credenziali di chiave condivisa.
Genera un URI di firma di accesso condiviso (SAS) del servizio BLOB in base alle proprietà e ai parametri del client passati. La firma di accesso condiviso viene firmata dalle credenziali della chiave condivisa del client.
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.
getAppendBlobClient()
Crea un oggetto AppendBlobClient.
function getAppendBlobClient(): AppendBlobClient
Restituisce
getBlobLeaseClient(string)
Ottenere un BlobLeaseClient che gestisce i lease nel BLOB.
function getBlobLeaseClient(proposeLeaseId?: string): BlobLeaseClient
Parametri
- proposeLeaseId
-
string
ID lease proposto iniziale.
Restituisce
Nuovo oggetto BlobLeaseClient per la gestione dei lease nel BLOB.
getBlockBlobClient()
Crea un oggetto BlockBlobClient.
function getBlockBlobClient(): BlockBlobClient
Restituisce
getPageBlobClient()
Crea un oggetto PageBlobClient.
function getPageBlobClient(): PageBlobClient
Restituisce
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 l'operazione Recupera 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 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 Livello set BLOB.
Restituisce
Promise<BlobSetTierResponse>
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 consente blobContentType
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>
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>
setLegalHold(boolean, BlobSetLegalHoldOptions)
Impostare il blocco a fini giudiziari sul 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>
setMetadata(Metadata, BlobSetMetadataOptions)
Imposta i metadati definiti dall'utente per il BLOB specificato come una o più coppie nome-valore.
Se non è stata specificata alcuna opzione o nessun metadati definito nel parametro, i metadati del BLOB verranno rimossi.
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>
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 (':'), uguale ('=') e sottolineatura ('_') .
function setTags(tags: Tags, options?: BlobSetTagsOptions): Promise<BlobSetTagsResponse>
Parametri
- tags
- Tags
- options
- BlobSetTagsOptions
Restituisce
Promise<BlobSetTagsResponse>
syncCopyFromURL(string, BlobSyncCopyFromURLOptions)
L'operazione Copia da URL sincrona copia un BLOB o una risorsa Internet in un nuovo BLOB. Non restituirà una risposta fino al completamento della copia.
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 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>
withSnapshot(string)
Crea un nuovo oggetto BlobClient identico all'origine, ma con il timestamp dello 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
Nuovo oggetto BlobClient identico all'origine, ma con il timestamp dello 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
Nuovo oggetto BlobClient che punta alla versione di questo BLOB.