AppendBlobClient class

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

Parametri

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

Parametri

Crea un'istanza di AppendBlobClient.

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

Parametri

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

string containerName

Valore della proprietà

Nome del BLOB.

string name

Valore della proprietà

accountName: string

Valore della proprietà

ereditato daBlobClient.accountName

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.

credential: StorageSharedKeyCredential | AnonymousCredential | TokenCredential

Valore della proprietà

ereditato daBlobClient.credential

Valore stringa URL codificato.

url: string

Valore della proprietà

ereditato daBlobClient.url

Esegue il commit di un nuovo blocco di dati alla fine del BLOB di accodamento esistente.

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

function appendBlock(body: RequestBodyType, contentLength: number, options?: AppendBlobAppendBlockOptions): Promise<AppendBlobAppendBlockResponse>

Parametri

const content = "Hello World!";

// Create a new append blob and append data to the blob.
const newAppendBlobClient = containerClient.getAppendBlobClient("<blob name>");
await newAppendBlobClient.create();
await newAppendBlobClient.appendBlock(content, content.length);

// Append data to an existing append blob.
const existingAppendBlobClient = containerClient.getAppendBlobClient("<blob name>");
await existingAppendBlobClient.appendBlock(content, content.length);

Restituisce

L'operazione Append Block esegue il commit di un nuovo blocco di dati alla fine di un BLOB di accodamento esistente in cui il contenuto viene letto da un URL di origine.

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

function appendBlockFromURL(sourceURL: string, sourceOffset: number, count: number, options?: AppendBlobAppendBlockFromURLOptions): Promise<AppendBlobAppendBlockFromUrlResponse>

Parametri

Restituisce

Crea un BLOB di accodamento di lunghezza 0. Chiamare AppendBlock per aggiungere dati a un BLOB di accodamento.

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

function create(options?: AppendBlobCreateOptions): Promise<AppendBlobCreateResponse>

Parametri

const appendBlobClient = containerClient.getAppendBlobClient("<blob name>");
await appendBlobClient.create();

Restituisce

Crea un BLOB di accodamento di lunghezza 0. Chiamare AppendBlock per aggiungere dati a un BLOB di accodamento. Se il BLOB con lo stesso nome esiste già, il contenuto del BLOB esistente rimarrà invariato.

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

function createIfNotExists(options?: AppendBlobCreateIfNotExistsOptions): Promise<AppendBlobCreateIfNotExistsResponse>

Parametri

Restituisce

Sigilla il BLOB di accodamento, rendendolo di sola lettura.

function seal(options?: AppendBlobSealOptions): Promise<AppendBlobAppendBlockResponse>

Parametri

Restituisce

Crea un nuovo oggetto AppendBlobClient 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): AppendBlobClient

Parametri

Restituisce

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

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

Restituisce

ereditato daBlobClient.abortCopyFromURL

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

Restituisce

ereditato daBlobClient.beginCopyFromURL

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

Restituisce

ereditato daBlobClient.createSnapshot

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

Restituisce

ereditato daBlobClient.delete

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

Restituisce

ereditato daBlobClient.deleteIfExists

Eliminare i criteri di immutablility nel BLOB.

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

Parametri

Restituisce

Ereditato daBlobClient.deleteImmutabilityPolicy

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

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

async function streamToBuffer(readableStream) {
return new Promise((resolve, reject) => {
const chunks = [];
readableStream.on("data", (data) => {
chunks.push(data instanceof Buffer ? data : Buffer.from(data));
});
readableStream.on("end", () => {
resolve(Buffer.concat(chunks));
});
readableStream.on("error", reject);
});
}

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

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

Restituisce

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

Restituisce

Ereditato daBlobClient.downloadToBuffer

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(offset?: number, count?: number, options?: BlobDownloadToBufferOptions): Promise<Buffer>

Parametri

Restituisce

Ereditato daBlobClient.downloadToBuffer

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

Restituisce

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

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

Restituisce

ereditato daBlobClient.exists

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

Restituisce

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

ereditato daBlobClient.generateSasUrl

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

Restituisce

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

ereditato daBlobClient.getAccountInfo

Crea un oggetto AppendBlobClient.

function getAppendBlobClient(): AppendBlobClient

Restituisce

Ereditato daBlobClient.getAppendBlobClient

Ottenere un BlobLeaseClient che gestisce i lease nel BLOB.

function getBlobLeaseClient(proposeLeaseId?: string): BlobLeaseClient

Parametri

Restituisce

Nuovo oggetto BlobLeaseClient per la gestione dei lease nel BLOB.

Ereditato daBlobClient.getBlobLeaseClient

Crea un oggetto BlockBlobClient.

function getBlockBlobClient(): BlockBlobClient

Restituisce

Ereditato daBlobClient.getBlockBlobClient

Crea un oggetto PageBlobClient.

function getPageBlobClient(): PageBlobClient

Restituisce

Ereditato daBlobClient.getPageBlobClient

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

Restituisce

Ereditato daBlobClient.getProperties

Ottiene i tag associati al BLOB sottostante.

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

Parametri

Restituisce

ereditato daBlobClient.getTags

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

Restituisce

Ereditato daBlobClient.setAccessTier

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

Restituisce

Ereditato daBlobClient.setHTTPHeaders

Impostare i criteri di immutabilità nel BLOB.

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

Parametri

Restituisce

Ereditato daBlobClient.setImmutabilityPolicy

Impostare il blocco a fini giudiziari nel BLOB.

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

Parametri

Restituisce

Ereditato daBlobClient.setLegalHold

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

Restituisce

Ereditato daBlobClient.setMetadata

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

Restituisce

ereditato daBlobClient.setTags

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

Restituisce

Ereditato daBlobClient.syncCopyFromURL

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

Restituisce

ereditato daBlobClient.undelete

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

Restituisce

Nuovo oggetto BlobClient che punta alla versione di questo BLOB.

Ereditato daBlobClient.withVersion