PageBlobClient class

Riferimento

Pacchetto:: @azure/storage-blob

PageBlobClient definisce un set di operazioni applicabili ai BLOB di pagine.

Extends: BlobClient

Costruttori

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

Proprietà

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

Metodi

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.
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.
clearPages(number, number, PageBlobClearPagesOptions)	Libera le pagine specificate dal BLOB di pagine.
create(number, PageBlobCreateOptions)	Crea un BLOB di pagine della lunghezza specificata. Chiamare uploadPages per caricare i dati in un BLOB di pagine.
createIfNotExists(number, PageBlobCreateIfNotExistsOptions)	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.
createSnapshot(BlobCreateSnapshotOptions)	Crea uno snapshot di sola lettura di un BLOB.
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.
deleteIfExists(BlobDeleteOptions)	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.
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 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
downloadToBuffer(Buffer, number, number, BlobDownloadToBufferOptions)	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>.
downloadToBuffer(number, number, BlobDownloadToBufferOptions)	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>.
downloadToFile(string, number, number, BlobDownloadOptions)	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.
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 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.
generateSasUrl(BlobGenerateSasUrlOptions)	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.
getAppendBlobClient()	Crea un oggetto AppendBlobClient.
getBlobLeaseClient(string)	Ottenere un oggetto <xref:BlobLeaseClient> che gestisce i lease nel BLOB.
getBlockBlobClient()	Crea un oggetto BlockBlobClient.
getPageBlobClient()	Crea un oggetto PageBlobClient.
getPageRanges(number, number, PageBlobGetPageRangesOptions)	Restituisce l'elenco di intervalli di pagine validi per un BLOB di pagine o uno snapshot di un BLOB di pagine.
getPageRangesDiff(number, number, string, PageBlobGetPageRangesDiffOptions)	Ottiene la raccolta di intervalli di pagine che differiscono tra uno snapshot specificato e questo BLOB di pagine.
getPageRangesDiffForManagedDisks(number, number, string, PageBlobGetPageRangesDiffOptions)	Ottiene la raccolta di intervalli di pagine che differiscono tra uno snapshot specificato e questo BLOB di pagine per i dischi gestiti.
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.
resize(number, PageBlobResizeOptions)	Ridimensiona il BLOB di pagina alla dimensione specificata, che deve essere un multiplo di 512.
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 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.
setHTTPHeaders(BlobHTTPHeaders, BlobSetHTTPHeadersOptions)	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.
setImmutabilityPolicy(BlobImmutabilityPolicy, BlobSetImmutabilityPolicyOptions)	Impostare criteri di immutablility nel BLOB.
setLegalHold(boolean, BlobSetLegalHoldOptions)	Impostare il blocco legale sul BLOB.
setMetadata(Metadata, BlobSetMetadataOptions)	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.
setTags(Tags, BlobSetTagsOptions)	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 ('_') .
startCopyIncremental(string, PageBlobStartCopyIncrementalOptions)	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.
syncCopyFromURL(string, BlobSyncCopyFromURLOptions)	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.
undelete(BlobUndeleteOptions)	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.
updateSequenceNumber(SequenceNumberActionType, number, PageBlobUpdateSequenceNumberOptions)	Imposta il numero di sequenza di un BLOB di pagine.
uploadPages(HttpRequestBody, number, number, PageBlobUploadPagesOptions)	Scrive 1 o più pagine nel BLOB di pagine. Gli offset di inizio e fine devono essere un multiplo di 512.
uploadPagesFromURL(string, number, number, number, PageBlobUploadPagesFromURLOptions)	L'operazione Carica pagine scrive un intervallo di pagine in un BLOB di pagine in cui il contenuto viene letto da un URL.
withSnapshot(string)	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.
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

PageBlobClient(string, PipelineLike)

Crea un'istanza di PageBlobClient.

new PageBlobClient(url: string, pipeline: PipelineLike)

Parametri

url: string

Stringa client che punta al BLOB di pagine di Archiviazione di Azure, ad esempio "https://myaccount.blob.core.windows.net/mycontainer/pageblob". È possibile aggiungere una firma di accesso condiviso se si usa AnonymousCredential, ad esempio "https://myaccount.blob.core.windows.net/mycontainer/pageblob?sasString".

pipeline: PipelineLike

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

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

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

url: string

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

Facoltativa. Opzioni per configurare la pipeline HTTP.

PageBlobClient(string, string, string, StoragePipelineOptions)

Crea un'istanza di PageBlobClient.

new PageBlobClient(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

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

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.

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

Parametri

copySource: string

url dell'origine BLOB/file di Azure.

options: BlobBeginCopyFromURLOptions

Opzioni facoltative per l'operazione Avvio copia BLOB dall'URL.

Restituisce

Promise<PollerLike<PollOperationState<BlobBeginCopyFromURLResponse>, BlobBeginCopyFromURLResponse>>

clearPages(number, number, PageBlobClearPagesOptions)

Libera le pagine specificate dal BLOB di pagine.

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

Parametri

offset: number

Posizione di byte iniziale delle pagine da cancellare.

count: number

Numero di byte da cancellare.

options: PageBlobClearPagesOptions

Opzioni per l'operazione Cancella pagine BLOB di pagina.

Restituisce

Promise<PageBlobClearPagesResponse>

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

create(number, PageBlobCreateOptions)

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

size: number

dimensioni del BLOB di pagina.

options: PageBlobCreateOptions

Opzioni per l'operazione Creazione BLOB di pagine.

Restituisce

Promise<PageBlobCreateResponse>

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

createIfNotExists(number, PageBlobCreateIfNotExistsOptions)

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

size: number

dimensioni del BLOB di pagina.

options: PageBlobCreateIfNotExistsOptions

Restituisce

Promise<PageBlobCreateIfNotExistsResponse>

createSnapshot(BlobCreateSnapshotOptions)

Crea uno snapshot di sola lettura di un BLOB.

function createSnapshot(options?: BlobCreateSnapshotOptions)

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.

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

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 non modificabilità 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 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

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

Utilizzo di esempio (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);
});
}

Utilizzo di esempio (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 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

buffer: Buffer

Buffer da riempire, deve avere lunghezza maggiore del numero

offset: number

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

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

Parametri

offset: number

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

filePath: string

offset: number

Da quale posizione del BLOB a blocchi scaricare.

count: number

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

options: BlobDownloadOptions

Opzioni di download BLOB.

Restituisce

Promise<BlobDownloadResponseParsed>

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.

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

options: BlobExistsOptions

opzioni per l'operazione Esiste.

Restituisce

Promise<boolean>

generateSasUrl(BlobGenerateSasUrlOptions)

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

options: BlobGenerateSasUrlOptions

Parametri facoltativi.

Restituisce

Promise<string>

URI di firma di accesso condiviso costituito dall'URI alla 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 oggetto <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

getPageRanges(number, number, PageBlobGetPageRangesOptions)

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

offset: number

Posizione di byte iniziale degli intervalli di pagine.

count: number

Numero di byte da ottenere.

options: PageBlobGetPageRangesOptions

Opzioni per l'operazione Recupera intervalli BLOB di pagine.

Restituisce

Promise<PageBlobGetPageRangesResponse>

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

getPageRangesDiff(number, number, string, PageBlobGetPageRangesDiffOptions)

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

offset: number

Posizione di byte iniziale del BLOB di pagine

count: number

Numero di byte per ottenere intervalli diff.

prevSnapshot: string

Timestamp dello snapshot per recuperare la differenza.

options: PageBlobGetPageRangesDiffOptions

Opzioni per l'operazione Get Page Blob Get Page Range Diff.

Restituisce

Promise<PageBlobGetPageRangesDiffResponse>

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

getPageRangesDiffForManagedDisks(number, number, string, PageBlobGetPageRangesDiffOptions)

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

offset: number

Posizione di byte iniziale del BLOB di pagine

count: number

Numero di byte per ottenere intervalli diff.

prevSnapshotUrl: string

URL dello snapshot per recuperare la differenza.

options: PageBlobGetPageRangesDiffOptions

Opzioni per l'operazione Get Page Blob Get Page Range Diff.

Restituisce

Promise<PageBlobGetPageRangesDiffResponse>

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

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 ottenere l'operazione Proprietà.

Restituisce

Promise<BlobGetPropertiesResponse>

getTags(BlobGetTagsOptions)

Ottiene i tag associati al BLOB sottostante.

function getTags(options?: BlobGetTagsOptions)

Parametri

options: BlobGetTagsOptions

Restituisce

Promise<BlobGetTagsResponse>

resize(number, PageBlobResizeOptions)

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

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

Parametri

size: number

Dimensione destinazione

options: PageBlobResizeOptions

Opzioni per l'operazione Ridimensiona BLOB di pagine.

Restituisce

Promise<PageBlobResizeResponse>

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

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

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

Restituisce

Promise<BlobSetTierResponse>

setHTTPHeaders(BlobHTTPHeaders, BlobSetHTTPHeadersOptions)

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

blobHTTPHeaders: BlobHTTPHeaders

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. Un'intestazione comune da impostare blobContentType consente al browser di fornire funzionalità in base al tipo di file.

options: BlobSetHTTPHeadersOptions

Opzioni facoltative per l'operazione Imposta intestazioni HTTP.

Restituisce

Promise<BlobSetHTTPHeadersResponse>

setImmutabilityPolicy(BlobImmutabilityPolicy, BlobSetImmutabilityPolicyOptions)

Impostare criteri di immutablility nel BLOB.

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

Parametri

immutabilityPolicy: BlobImmutabilityPolicy

options: BlobSetImmutabilityPolicyOptions

Opzioni facoltative per impostare criteri di non modificabilità nel BLOB.

Restituisce

Promise<BlobSetImmutabilityPolicyResponse>

setLegalHold(boolean, BlobSetLegalHoldOptions)

Impostare il blocco legale sul BLOB.

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

Parametri

legalHoldEnabled: boolean

options: BlobSetLegalHoldOptions

Opzioni facoltative per impostare il blocco legale 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 fornita alcuna opzione o nessun metadati 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 rimosso alcun valore specificato i metadati esistenti.

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

tags: Tags

options: BlobSetTagsOptions

Restituisce

Promise<BlobSetTagsResponse>

startCopyIncremental(string, PageBlobStartCopyIncrementalOptions)

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

copySource: string

Specifica il nome dello snapshot BLOB della pagina di origine. Ad esempio, usare https://myaccount.blob.core.windows.net/mycontainer/myblob?snapshot=

options: PageBlobStartCopyIncrementalOptions

Opzioni per l'operazione incrementale copia BLOB di pagine.

Restituisce

Promise<PageBlobCopyIncrementalResponse>

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

syncCopyFromURL(string, BlobSyncCopyFromURLOptions)

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

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 temporanea e di eventuali snapshot eliminati soft associati. Undelete BLOB è supportato solo nella versione 2017-07-29 o successiva.

function undelete(options?: BlobUndeleteOptions)

Parametri

options: BlobUndeleteOptions

Opzioni facoltative per l'operazione Di annullamento eliminazione BLOB.

Restituisce

Promise<BlobUndeleteResponse>

updateSequenceNumber(SequenceNumberActionType, number, PageBlobUpdateSequenceNumberOptions)

Imposta il numero di sequenza di un BLOB di pagine.

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

Parametri

sequenceNumberAction: SequenceNumberActionType

Indica come il servizio deve modificare il numero di sequenza del BLOB.

sequenceNumber: number

Obbligatorio se sequenceNumberAction è max o update

options: PageBlobUpdateSequenceNumberOptions

Opzioni per l'operazione Numero sequenza di aggiornamento BLOB di pagine.

Restituisce

Promise<PageBlobUpdateSequenceNumberResponse>

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

uploadPages(HttpRequestBody, number, number, PageBlobUploadPagesOptions)

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

body: HttpRequestBody

Dati da caricare

offset: number

Offset del BLOB di pagine di destinazione

count: number

Lunghezza del contenuto del corpo, numero anche di byte da caricare

options: PageBlobUploadPagesOptions

Opzioni per l'operazione Caricamento pagine BLOB di pagine.

Restituisce

Promise<PageBlobUploadPagesResponse>

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

uploadPagesFromURL(string, number, number, number, PageBlobUploadPagesFromURLOptions)

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

sourceURL: string

Specificare un URL per l'origine di copia, la firma di accesso condiviso (SAS) potrebbe essere necessaria per l'autenticazione

sourceOffset: number

Offset di origine da cui eseguire la copia. Passare 0 per copiare dall'inizio del BLOB di pagine di origine

destOffset: number

Offset del BLOB di pagine di destinazione

count: number

Numero di byte da caricare dal BLOB di pagine di origine

options: PageBlobUploadPagesFromURLOptions

Restituisce

Promise<PageBlobUploadPagesFromURLResponse>

withSnapshot(string)

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

snapshot: string

Timestamp dello snapshot.

Restituisce

PageBlobClient

Nuovo oggetto PageBlobClient 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.

Condividi tramite

PageBlobClient class

Costruttori

Proprietà

Metodi

Dettagli costruttore

PageBlobClient(string, PipelineLike)

Parametri

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

Parametri

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

clearPages(number, number, PageBlobClearPagesOptions)

Parametri

Restituisce

create(number, PageBlobCreateOptions)

Parametri

Restituisce

createIfNotExists(number, PageBlobCreateIfNotExistsOptions)

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

getPageRanges(number, number, PageBlobGetPageRangesOptions)

Parametri