BlobClient class

Pacchetto:: @azure/storage-blob

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

BlobClient(string, PipelineLike)	Crea un'istanza di BlobClient. Questo metodo accetta un URL codificato o un URL non codificato che punta a un BLOB. La stringa URL codificata non verrà preceduta da un carattere di escape due volte. Solo i caratteri speciali nel percorso URL verranno preceduti da un carattere di escape. Se il nome di un BLOB include ? o %, il nome del BLOB deve essere codificato nell'URL.
BlobClient(string, StorageSharedKeyCredential \| AnonymousCredential \| TokenCredential, StoragePipelineOptions)	Crea un'istanza di BlobClient. Questo metodo accetta un URL codificato o un URL non codificato che punta a un BLOB. La stringa URL codificata non verrà preceduta da un carattere di escape due volte. Solo i caratteri speciali nel percorso URL verranno preceduti da un carattere di escape. Se il nome di un BLOB include ? o %, il nome del BLOB deve essere codificato nell'URL.
BlobClient(string, string, string, StoragePipelineOptions)	Crea un'istanza di BlobClient dalla stringa di connessione.

Proprietà

accountName
containerName	Il nome del contenitore di archiviazione a cui è associato il BLOB.
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.
name	Nome del BLOB.
url	Valore stringa URL codificato.

Metodi

abortCopyFromURL(string, BlobAbortCopyFromURLOptions)	Interrompe un'operazione di copia blob asincrona in sospeso e lascia un BLOB di destinazione con lunghezza zero e metadati completi. Versione 2012-02-12 e successive.
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.
createSnapshot(BlobCreateSnapshotOptions)	Crea uno snapshot di sola lettura di un 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.
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.
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
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 <xref: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 <xref: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.
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.
getAppendBlobClient()	Crea un oggetto AppendBlobClient.
getBlobLeaseClient(string)	Ottenere un <xref: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.
getTags(BlobGetTagsOptions)	Ottiene i tag associati al BLOB sottostante.
setAccessTier(BlockBlobTier \| PremiumPageBlobTier \| 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.
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.
setImmutabilityPolicy(BlobImmutabilityPolicy, BlobSetImmutabilityPolicyOptions)	Impostare i criteri di immutablility 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.
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.
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.
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.
withVersion(string)	Crea un nuovo oggetto BlobClient che punta a una versione di questo BLOB. Specificare "" rimuoverà il versionId e restituirà un client al BLOB di base.

Dettagli costruttore

BlobClient(string, PipelineLike)

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

new BlobClient(url: string, pipeline: PipelineLike)

Parametri

url: string

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

pipeline: PipelineLike

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

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

new BlobClient(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.

BlobClient(string, string, string, StoragePipelineOptions)

Crea un'istanza di BlobClient dalla stringa di connessione.

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

Parametri

connectionString: string

Stringa di connessione dell'account o stringa di connessione sas di un account di archiviazione di Azure. [ Nota: la stringa di connessione dell'account può essere usata solo in NODE.JS runtime. ] Esempio di stringa di connessione dell'account - 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à

accountName

accountName: string

Valore della proprietà

string

containerName

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

string containerName

Valore della proprietà

string

credential

credential: StorageSharedKeyCredential | AnonymousCredential | TokenCredential

Valore della proprietà

StorageSharedKeyCredential | AnonymousCredential | TokenCredential

name

Nome del BLOB.

string name

Valore della proprietà

string

url

Valore stringa URL codificato.

url: string

Valore della proprietà

string

Dettagli metodo

abortCopyFromURL(string, BlobAbortCopyFromURLOptions)

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

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

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>

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.

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

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<PollerLike<PollOperationState<BlobBeginCopyFromURLResponse>, BlobBeginCopyFromURLResponse>>

createSnapshot(BlobCreateSnapshotOptions)

Crea uno snapshot di sola lettura di un BLOB.

function createSnapshot(options?: BlobCreateSnapshotOptions)

Parametri

options: BlobCreateSnapshotOptions

Opzioni facoltative per l'operazione Di creazione snapshot BLOB.

Restituisce

Promise<BlobCreateSnapshotResponse>

delete(BlobDeleteOptions)

Contrassegna il BLOB o lo snapshot specificato per l'eliminazione. Il BLOB 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.

function delete(options?: BlobDeleteOptions)

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

function deleteIfExists(options?: BlobDeleteOptions)

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)

Parametri

options: BlobDeleteImmutabilityPolicyOptions

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

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

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 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 <xref:downloadToFile>.

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

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>

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)

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>

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)

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.

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)

Parametri

options: BlobExistsOptions

opzioni per l'operazione Exists.

Restituisce

Promise<boolean>

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.

function generateSasUrl(options: BlobGenerateSasUrlOptions)

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

Restituisce

AppendBlobClient

getBlobLeaseClient(string)

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

function getBlobLeaseClient(proposeLeaseId?: string)

Parametri

proposeLeaseId: string

ID lease proposto iniziale.

Restituisce

BlobLeaseClient

Nuovo oggetto BlobLeaseClient per la gestione dei lease nel BLOB.

getBlockBlobClient()

Crea un oggetto BlockBlobClient.

function getBlockBlobClient()

Restituisce

BlockBlobClient

getPageBlobClient()

Crea un oggetto PageBlobClient.

function getPageBlobClient()

Restituisce

PageBlobClient

getProperties(BlobGetPropertiesOptions)

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

function getProperties(options?: BlobGetPropertiesOptions)

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)

Parametri

options: BlobGetTagsOptions

Restituisce

Promise<BlobGetTagsResponse>

setAccessTier(BlockBlobTier | PremiumPageBlobTier | 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.

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

Parametri

tier: BlockBlobTier | PremiumPageBlobTier | 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>

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.

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

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>

setImmutabilityPolicy(BlobImmutabilityPolicy, BlobSetImmutabilityPolicyOptions)

Impostare i criteri di immutablility nel BLOB.

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

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

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

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 viene specificata alcuna opzione o nessun metadato definito nel parametro , i metadati del BLOB verranno rimossi.

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

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

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

Parametri

tags: Tags

options: BlobSetTagsOptions

Restituisce

Promise<BlobSetTagsResponse>

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.

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

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.

function undelete(options?: BlobUndeleteOptions)

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)

Parametri

snapshot: string

Timestamp dello snapshot.

Restituisce

BlobClient

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)

Parametri

versionId: string

VersionId.

Restituisce

BlobClient

Nuovo oggetto BlobClient che punta alla versione di questo BLOB.

Commenti e suggerimenti

Questa pagina è stata utile?

Condividi tramite

BlobClient class

Costruttori

Proprietà

Metodi

Dettagli costruttore

BlobClient(string, PipelineLike)

Parametri

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

Parametri

BlobClient(string, string, string, StoragePipelineOptions)

Parametri

Dettagli proprietà

accountName

Valore della proprietà

containerName

Valore della proprietà

credential

Valore della proprietà

name

Valore della proprietà

url

Valore della proprietà

Dettagli metodo

abortCopyFromURL(string, BlobAbortCopyFromURLOptions)

Parametri

Restituisce

beginCopyFromURL(string, BlobBeginCopyFromURLOptions)

Parametri

Restituisce

createSnapshot(BlobCreateSnapshotOptions)

Parametri

Restituisce

delete(BlobDeleteOptions)

Parametri

Restituisce

deleteIfExists(BlobDeleteOptions)

Parametri

Restituisce

deleteImmutabilityPolicy(BlobDeleteImmutabilityPolicyOptions)

Parametri

Restituisce

download(number, number, BlobDownloadOptions)

Parametri

Restituisce

downloadToBuffer(Buffer, number, number, BlobDownloadToBufferOptions)

Parametri

Restituisce

downloadToBuffer(number, number, BlobDownloadToBufferOptions)

Parametri

Restituisce

downloadToFile(string, number, number, BlobDownloadOptions)

Parametri

Restituisce

exists(BlobExistsOptions)

Parametri

Restituisce

generateSasUrl(BlobGenerateSasUrlOptions)

Parametri

Restituisce

getAppendBlobClient()

Restituisce

getBlobLeaseClient(string)

Parametri

Restituisce

getBlockBlobClient()

Restituisce

getPageBlobClient()

Restituisce

getProperties(BlobGetPropertiesOptions)

Parametri

Restituisce

getTags(BlobGetTagsOptions)

Parametri

Restituisce

setAccessTier(BlockBlobTier | PremiumPageBlobTier | string, BlobSetTierOptions)

Parametri

Restituisce

setHTTPHeaders(BlobHTTPHeaders, BlobSetHTTPHeadersOptions)

Parametri