PageBlobClient class

Crea un'istanza di PageBlobClient.

new PageBlobClient(url: string, pipeline: PipelineLike)

Parametri

Crea un'istanza di PageBlobClient. 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 PageBlobClient(url: string, credential: StorageSharedKeyCredential | AnonymousCredential | TokenCredential, options?: StoragePipelineOptions)

Parametri

Crea un'istanza di PageBlobClient.

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

Parametri

accountName: string

Valore della proprietà

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

string containerName

Valore della proprietà

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

credential: StorageSharedKeyCredential | AnonymousCredential | TokenCredential

Valore della proprietà

Nome del BLOB.

string name

Valore della proprietà

Valore stringa URL codificato.

url: string

Valore della proprietà

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.

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

Parametri

Restituisce

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.

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

Parametri

Restituisce

Libera le pagine specificate dal BLOB di pagine.

function clearPages(offset?: number, count?: number, options?: PageBlobClearPagesOptions)

Parametri

Restituisce

Dati di risposta per l'operazione Cancella pagine BLOB di pagina.

Crea un BLOB di pagine della lunghezza specificata. Chiamare uploadPages per caricare i dati in un BLOB di pagine.

function create(size: number, options?: PageBlobCreateOptions)

Parametri

Restituisce

Dati di risposta per l'operazione Creazione BLOB di pagine.

Crea un BLOB di pagine della lunghezza specificata. Chiamare uploadPages per caricare i dati in un BLOB di pagine. Se il BLOB con lo stesso nome esiste già, il contenuto del BLOB esistente rimarrà invariato.

function createIfNotExists(size: number, options?: PageBlobCreateIfNotExistsOptions)

Parametri

Restituisce

Crea uno snapshot di sola lettura di un BLOB.

function createSnapshot(options?: BlobCreateSnapshotOptions)

Parametri

Restituisce

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.

function delete(options?: BlobDeleteOptions)

Parametri

Restituisce

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

function deleteIfExists(options?: BlobDeleteOptions)

Parametri

Restituisce

Eliminare i criteri di immutablility nel BLOB.

function deleteImmutabilityPolicy(options?: BlobDeleteImmutabilityPolicyOptions)

Parametri

Restituisce

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

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

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

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

DISPONIBILE SOLO IN RUNTIME NODE.JS. Scarica un BLOB di Azure in parallelo a un buffer. Offset e conteggio sono facoltativi, scarica l'intero BLOB se non vengono forniti.

Avviso: i buffer possono supportare solo i file fino a un gigabyte su sistemi a 32 bit o circa due gigabyte nei sistemi a 64 bit a causa di limitazioni di Node.js/V8. Per i BLOB più grandi di questa dimensione, prendere in considerazione <xref:downloadToFile>.

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

Parametri

Restituisce

DISPONIBILE SOLO IN RUNTIME NODE.JS. Scarica un BLOB di Azure in parallelo a un buffer. Offset e conteggio sono facoltativi, scarica l'intero BLOB se non vengono forniti.

Avviso: i buffer possono supportare solo i file fino a un gigabyte su sistemi a 32 bit o circa due gigabyte nei sistemi a 64 bit a causa di limitazioni di Node.js/V8. Per i BLOB più grandi di questa dimensione, prendere in considerazione <xref:downloadToFile>.

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

Parametri

Restituisce

DISPONIBILE SOLO IN RUNTIME NODE.JS. Scarica un BLOB di Azure in un file locale. Ha esito negativo se il percorso del file specificato viene già chiuso. Offset e conteggio sono facoltativi, passano rispettivamente 0 e non definiti per scaricare l'intero BLOB.

function downloadToFile(filePath: string, offset?: number, count?: number, options?: BlobDownloadOptions)

Parametri

Restituisce

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

Restituisce true se la risorsa BLOB di Azure rappresentata da questo client esiste; false in caso contrario. NOTA: usare questa funzione con attenzione poiché un BLOB esistente potrebbe essere eliminato da altri client o applicazioni. Viceversa, i nuovi BLOB possono essere aggiunti da altri client o applicazioni al termine di questa funzione.

function exists(options?: BlobExistsOptions)

Parametri

Restituisce

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

function generateSasUrl(options: BlobGenerateSasUrlOptions)

Parametri

Restituisce

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

Crea un oggetto AppendBlobClient.

function getAppendBlobClient()

Restituisce

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

function getBlobLeaseClient(proposeLeaseId?: string)

Parametri

Restituisce

Nuovo oggetto BLOBLeaseClient per la gestione dei lease nel BLOB.

Crea un oggetto BlockBlobClient.

function getBlockBlobClient()

Restituisce

Crea un oggetto PageBlobClient.

function getPageBlobClient()

Restituisce

Restituisce l'elenco di intervalli di pagine validi per un BLOB di pagine o uno snapshot di un BLOB di pagine.

function getPageRanges(offset?: number, count?: number, options?: PageBlobGetPageRangesOptions)

Parametri

Restituisce

Dati di risposta per l'operazione Get Range dei BLOB di pagine.

Ottiene la raccolta di intervalli di pagine che differiscono tra uno snapshot specificato e questo BLOB di pagine.

function getPageRangesDiff(offset: number, count: number, prevSnapshot: string, options?: PageBlobGetPageRangesDiffOptions)

Parametri

Restituisce

Dati di risposta per l'operazione Diff dell'intervallo di pagine Get Page BLOB.

Ottiene la raccolta di intervalli di pagine che differiscono tra uno snapshot specificato e questo BLOB di pagine per i dischi gestiti.

function getPageRangesDiffForManagedDisks(offset: number, count: number, prevSnapshotUrl: string, options?: PageBlobGetPageRangesDiffOptions)

Parametri

Restituisce

Dati di risposta per l'operazione Diff dell'intervallo di pagine Get Page BLOB.

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

Restituisce

Ottiene i tag associati al BLOB sottostante.

function getTags(options?: BlobGetTagsOptions)

Parametri

Restituisce

Ridimensiona il BLOB di pagina alla dimensione specificata, che deve essere un multiplo di 512.

function resize(size: number, options?: PageBlobResizeOptions)

Parametri

Restituisce

Dati di risposta per l'operazione Ridimensiona BLOB di pagine.

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

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

Parametri

Restituisce

Imposta le proprietà di sistema nel BLOB. Se non viene fornito alcun valore o nessun valore specificato per le intestazioni HTTP BLOB specificate, queste intestazioni HTTP BLOB senza un valore verranno cancellate.

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

Parametri

Restituisce

Impostare criteri di immutablility nel BLOB.

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

Parametri

Restituisce

Impostare il blocco legale sul BLOB.

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

Parametri

Restituisce

Imposta i metadati definiti dall'utente per il BLOB specificato come una o più coppie nome-valore. Se non viene fornita alcuna opzione o nessun metadati definito nel parametro, i metadati del BLOB verranno rimossi.

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

Parametri

Restituisce

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

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

Parametri

Restituisce

Avvia un'operazione per avviare una copia incrementale dallo snapshot di un BLOB di pagine a questo BLOB di pagine. Lo snapshot viene copiato in modo che solo le modifiche differenziali tra lo snapshot copiato in precedenza vengano trasferite alla destinazione. Gli snapshot copiati sono copie complete dello snapshot originale e possono essere letti o copiati da come di consueto.

function startCopyIncremental(copySource: string, options?: PageBlobStartCopyIncrementalOptions)

Parametri

Restituisce

Dati di risposta per l'operazione incrementale copia BLOB di pagine.

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

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

Parametri

Restituisce

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

function undelete(options?: BlobUndeleteOptions)

Parametri

Restituisce

Imposta il numero di sequenza di un BLOB di pagine.

function updateSequenceNumber(sequenceNumberAction: SequenceNumberActionType, sequenceNumber?: number, options?: PageBlobUpdateSequenceNumberOptions)

Parametri

Restituisce

Dati di risposta per l'operazione Numero sequenza di aggiornamento BLOB di pagine.

Scrive 1 o più pagine nel BLOB di pagine. Gli offset di inizio e fine devono essere un multiplo di 512.

function uploadPages(body: HttpRequestBody, offset: number, count: number, options?: PageBlobUploadPagesOptions)

Parametri

Restituisce

Dati di risposta per l'operazione Pagine di caricamento BLOB di pagine.

L'operazione Carica pagine scrive un intervallo di pagine in un BLOB di pagine in cui il contenuto viene letto da un URL.

function uploadPagesFromURL(sourceURL: string, sourceOffset: number, destOffset: number, count: number, options?: PageBlobUploadPagesFromURLOptions)

Parametri

Restituisce

Crea un nuovo oggetto PageBlobClient 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

Restituisce

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

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

Restituisce

Nuovo oggetto BlobClient che punta alla versione di questo BLOB.