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à 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.
PageBlobClient(string, string, string, StoragePipelineOptions)

Crea un'istanza di PageBlobClient.

Proprietà

containerName

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

Nome del BLOB.

Proprietà ereditate

accountName
credential

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

Valore stringa URL codificato.

Metodi

clearPages(number, number, PageBlobClearPagesOptions)

Libera le pagine specificate dal BLOB di pagine.

Vedere https://docs.microsoft.com/rest/api/storageservices/put-page
create(number, PageBlobCreateOptions)

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

Vedere https://docs.microsoft.com/rest/api/storageservices/put-blob
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.

Vedere https://docs.microsoft.com/rest/api/storageservices/put-blob
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.

Vedere https://docs.microsoft.com/rest/api/storageservices/get-page-ranges
getPageRangesDiff(number, number, string, PageBlobGetPageRangesDiffOptions)

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

Vedere https://docs.microsoft.com/rest/api/storageservices/get-page-ranges
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.

Vedere https://docs.microsoft.com/rest/api/storageservices/get-page-ranges
listPageRanges(number, number, PageBlobListPageRangesOptions)

Restituisce un iteratore iteratore asincrono per elencare gli intervalli di pagine per un BLOB di pagine.

Vedere https://docs.microsoft.com/rest/api/storageservices/get-page-ranges

.byPage() restituisce un iteratore iteratore asincrono per elencare gli intervalli di pagine per un BLOB di pagine.

Esempio di for await sintassi:

// Get the pageBlobClient before you run these snippets,
// Can be obtained from `blobServiceClient.getContainerClient("<your-container-name>").getPageBlobClient("<your-blob-name>");`
let i = 1;
for await (const pageRange of pageBlobClient.listPageRanges()) {
  console.log(`Page range ${i++}: ${pageRange.start} - ${pageRange.end}`);
}

Esempio con iter.next():

let i = 1;
let iter = pageBlobClient.listPageRanges();
let pageRangeItem = await iter.next();
while (!pageRangeItem.done) {
  console.log(`Page range ${i++}: ${pageRangeItem.value.start} - ${pageRangeItem.value.end}, IsClear: ${pageRangeItem.value.isClear}`);
  pageRangeItem = await iter.next();
}

Esempio con byPage():

// passing optional maxPageSize in the page settings
let i = 1;
for await (const response of pageBlobClient.listPageRanges().byPage({ maxPageSize: 20 })) {
  for (const pageRange of response) {
    console.log(`Page range ${i++}: ${pageRange.start} - ${pageRange.end}`);
  }
}

Esempio che usa il paging con un marcatore:

let i = 1;
let iterator = pageBlobClient.listPageRanges().byPage({ maxPageSize: 2 });
let response = (await iterator.next()).value;

// Prints 2 page ranges
for (const pageRange of response) {
  console.log(`Page range ${i++}: ${pageRange.start} - ${pageRange.end}`);
}

// Gets next marker
let marker = response.continuationToken;

// Passing next marker as continuationToken

iterator = pageBlobClient.listPageRanges().byPage({ continuationToken: marker, maxPageSize: 10 });
response = (await iterator.next()).value;

// Prints 10 page ranges
for (const blob of response) {
  console.log(`Page range ${i++}: ${pageRange.start} - ${pageRange.end}`);
}
listPageRangesDiff(number, number, string, PageBlobListPageRangesDiffOptions)

Restituisce un iteratore iteratore asincrono per elencare gli intervalli di pagine che differiscono tra uno snapshot specificato e questo BLOB di pagine.

Vedere https://docs.microsoft.com/rest/api/storageservices/get-page-ranges

.byPage() restituisce un iteratore iterabile asincrono per elencare gli intervalli di pagine che differiscono tra uno snapshot specificato e questo BLOB di pagine.

Esempio di for await sintassi:

// Get the pageBlobClient before you run these snippets,
// Can be obtained from `blobServiceClient.getContainerClient("<your-container-name>").getPageBlobClient("<your-blob-name>");`
let i = 1;
for await (const pageRange of pageBlobClient.listPageRangesDiff()) {
  console.log(`Page range ${i++}: ${pageRange.start} - ${pageRange.end}`);
}

Esempio con iter.next():

let i = 1;
let iter = pageBlobClient.listPageRangesDiff();
let pageRangeItem = await iter.next();
while (!pageRangeItem.done) {
  console.log(`Page range ${i++}: ${pageRangeItem.value.start} - ${pageRangeItem.value.end}, IsClear: ${pageRangeItem.value.isClear}`);
  pageRangeItem = await iter.next();
}

Esempio con byPage():

// passing optional maxPageSize in the page settings
let i = 1;
for await (const response of pageBlobClient.listPageRangesDiff().byPage({ maxPageSize: 20 })) {
  for (const pageRange of response) {
    console.log(`Page range ${i++}: ${pageRange.start} - ${pageRange.end}`);
  }
}

Esempio che usa il paging con un marcatore:

let i = 1;
let iterator = pageBlobClient.listPageRangesDiff().byPage({ maxPageSize: 2 });
let response = (await iterator.next()).value;

// Prints 2 page ranges
for (const pageRange of response) {
  console.log(`Page range ${i++}: ${pageRange.start} - ${pageRange.end}`);
}

// Gets next marker
let marker = response.continuationToken;

// Passing next marker as continuationToken

iterator = pageBlobClient.listPageRangesDiff().byPage({ continuationToken: marker, maxPageSize: 10 });
response = (await iterator.next()).value;

// Prints 10 page ranges
for (const blob of response) {
  console.log(`Page range ${i++}: ${pageRange.start} - ${pageRange.end}`);
}
resize(number, PageBlobResizeOptions)

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

Vedere https://docs.microsoft.com/rest/api/storageservices/set-blob-properties
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.

Vedere Vedere https://docs.microsoft.com/rest/api/storageservices/incremental-copy-blobhttps://docs.microsoft.com/en-us/azure/virtual-machines/windows/incremental-snapshots
updateSequenceNumber(SequenceNumberActionType, number, PageBlobUpdateSequenceNumberOptions)

Imposta il numero di sequenza di un BLOB di pagine.

Vedere https://docs.microsoft.com/en-us/rest/api/storageservices/set-blob-properties
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.

Vedere https://docs.microsoft.com/rest/api/storageservices/put-page
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.

Vedere https://docs.microsoft.com/en-us/rest/api/storageservices/put-page-from-url
withSnapshot(string)

Crea un nuovo oggetto PageBlobClient identico all'origine, ma con il timestamp snapshot specificato. Specificare "" rimuoverà lo snapshot e restituirà un client al BLOB di base.

Metodi ereditati

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.

Vedere https://docs.microsoft.com/en-us/rest/api/storageservices/abort-copy-blob
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 a tempo indeterminato fino al completamento della copia. È anche possibile 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. L'operazione di copia dei BLOB da un account di archiviazione diverso è consentita solo per gli account di archiviazione creati il 7 giugno 2012 o successivamente.

Vedere https://docs.microsoft.com/en-us/rest/api/storageservices/copy-blob

Esempio che usa il polling automatico:

const copyPoller = await blobClient.beginCopyFromURL('url');
const result = await copyPoller.pollUntilDone();

Esempio di 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 modificato (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.');
  }
}
createSnapshot(BlobCreateSnapshotOptions)

Crea uno snapshot di sola lettura di un BLOB.

Vedere https://docs.microsoft.com/en-us/rest/api/storageservices/snapshot-blob
delete(BlobDeleteOptions)

Contrassegna il BLOB o lo snapshot specificato per l'eliminazione. Il Blob verrà eliminato in seguito durante un'operazione di Garbage Collection. Si noti che per eliminare un Blob, è necessario eliminare tutti i relativi snapshot. È possibile eliminare entrambi contemporaneamente con l'operazione Elimina BLOB.

Vedere https://docs.microsoft.com/en-us/rest/api/storageservices/delete-blob
deleteIfExists(BlobDeleteOptions)

Contrassegna il BLOB o lo snapshot specificato per l'eliminazione, se esistente. Il Blob verrà eliminato in seguito durante un'operazione di Garbage Collection. Si noti che per eliminare un Blob, è necessario eliminare tutti i relativi snapshot. È possibile eliminare entrambi contemporaneamente con l'operazione Elimina BLOB.

Vedere https://docs.microsoft.com/en-us/rest/api/storageservices/delete-blob
deleteImmutabilityPolicy(BlobDeleteImmutabilityPolicyOptions)

Eliminare i criteri di immutablility nel BLOB.
download(number, number, BlobDownloadOptions)

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

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

Vedere https://docs.microsoft.com/en-us/rest/api/storageservices/get-blob
downloadToBuffer(Buffer, number, number, BlobDownloadToBufferOptions)

DISPONIBILE SOLO IN NODE.JS RUNTIME.

Scarica un BLOB di Azure in parallelo in un buffer. Offset e conteggio sono facoltativi, scarica l'intero BLOB se non vengono forniti.

Avviso: i buffer possono supportare solo i file fino a circa un gigabyte nei sistemi a 32 bit o circa due gigabyte nei sistemi a 64 bit a causa delle limitazioni di Node.js/V8. Per i BLOB superiori a queste dimensioni, prendere in considerazione downloadToFile.
downloadToBuffer(number, number, BlobDownloadToBufferOptions)

DISPONIBILE SOLO IN NODE.JS RUNTIME.

Scarica un BLOB di Azure in parallelo in un buffer. Offset e conteggio sono facoltativi, scarica l'intero BLOB se non vengono forniti.

Avviso: i buffer possono supportare solo i file fino a circa un gigabyte nei sistemi a 32 bit o circa due gigabyte nei sistemi a 64 bit a causa delle limitazioni di Node.js/V8. Per i BLOB superiori a queste dimensioni, prendere in considerazione downloadToFile.
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 di chiave condivisa.

Genera un URI di firma di accesso condiviso (SAS) del servizio BLOB in base alle proprietà e ai parametri del client passati. La firma di accesso condiviso viene firmata dalle credenziali della chiave condivisa del client.

Vedere https://docs.microsoft.com/en-us/rest/api/storageservices/constructing-a-service-sas
getAppendBlobClient()

Crea un oggetto AppendBlobClient.
getBlobLeaseClient(string)

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

Vedere https://docs.microsoft.com/en-us/rest/api/storageservices/get-blob-properties

AVVISO: l'oggetto metadata restituito nella risposta avrà le chiavi in lettere minuscole, anche se in origine contengono caratteri maiuscoli. Ciò è diverso dalle chiavi di metadati restituite dai metodi di ContainerClient che elencano i BLOB usando l'opzione , che manterrà le includeMetadata maiuscole e minuscole originali.
getTags(BlobGetTagsOptions)

Ottiene i tag associati al BLOB sottostante.
setAccessTier(string, BlobSetTierOptions)

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

Vedere https://docs.microsoft.com/en-us/rest/api/storageservices/set-blob-tier
setHTTPHeaders(BlobHTTPHeaders, BlobSetHTTPHeadersOptions)

Imposta le proprietà di sistema nel BLOB.

Se non viene specificato alcun valore o nessun valore specificato per le intestazioni HTTP BLOB specificate, queste intestazioni HTTP BLOB senza un valore verranno cancellate.

Vedere https://docs.microsoft.com/en-us/rest/api/storageservices/set-blob-properties
setImmutabilityPolicy(BlobImmutabilityPolicy, BlobSetImmutabilityPolicyOptions)

Impostare i criteri di immutablility nel BLOB.
setLegalHold(boolean, BlobSetLegalHoldOptions)

Impostare il blocco a fini giudiziari sul BLOB.
setMetadata(Metadata, BlobSetMetadataOptions)

Imposta i metadati definiti dall'utente per il BLOB specificato come una o più coppie nome-valore.

Se non è stata specificata alcuna opzione o nessun metadati definito nel parametro, i metadati del BLOB verranno rimossi.

Vedere https://docs.microsoft.com/en-us/rest/api/storageservices/set-blob-metadata
setTags(Tags, BlobSetTagsOptions)

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

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

Vedere https://docs.microsoft.com/en-us/rest/api/storageservices/copy-blob-from-url
undelete(BlobUndeleteOptions)

Ripristina il contenuto e i metadati del BLOB eliminato soft e degli snapshot eliminati soft associati. Il BLOB di annullamento dell'eliminazione è supportato solo nella versione 2017-07-29 o successiva.

Vedere https://docs.microsoft.com/en-us/rest/api/storageservices/undelete-blob
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 URL 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". 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. Tuttavia, se il nome di un BLOB include ? o %, il nome del BLOB deve essere codificato nell'URL. Ad esempio, un BLOB denominato "my?blob%", l'URL deve essere "https://myaccount.blob.core.windows.net/mycontainer/my%3Fblob%25".

pipeline
PipelineLike

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

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à 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 PageBlobClient(url: string, credential: StorageSharedKeyCredential | AnonymousCredential | TokenCredential, options?: StoragePipelineOptions)

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

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 utilizzato 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 in NODE.JS runtime. ] Esempio di stringa di connessione dell'account -DefaultEndpointsProtocol=https;AccountName=myaccount;AccountKey=accountKey;EndpointSuffix=core.windows.net Esempio di stringa di connessione di firma di accesso condiviso - 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à

containerName

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

string containerName

Valore della proprietà

string

name

Nome del BLOB.

string name

Valore della proprietà

string

Dettagli proprietà ereditate

accountName 

accountName: string

Valore della proprietà

string

Ereditato daBlobClient.accountName

credential

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

credential: StorageSharedKeyCredential | AnonymousCredential | TokenCredential

Valore della proprietà

StorageSharedKeyCredential | AnonymousCredential | TokenCredential

Ereditato daBlobClient.credential

url

Valore stringa URL codificato.

url: string

Valore della proprietà

string

Ereditato daBLOBClient.url

Dettagli metodo

clearPages(number, number, PageBlobClearPagesOptions)

Libera le pagine specificate dal BLOB di pagine.

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

function clearPages(offset?: number, count?: number, options?: PageBlobClearPagesOptions): Promise<PageBlobClearPagesResponse>

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.

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

function create(size: number, options?: PageBlobCreateOptions): Promise<PageBlobCreateResponse>

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.

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

function createIfNotExists(size: number, options?: PageBlobCreateIfNotExistsOptions): Promise<PageBlobCreateIfNotExistsResponse>

Parametri

size

number

dimensioni del BLOB di pagina.

options
PageBlobCreateIfNotExistsOptions

Restituisce

Promise<PageBlobCreateIfNotExistsResponse>

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.

Vedere https://docs.microsoft.com/rest/api/storageservices/get-page-ranges

function getPageRanges(offset?: number, count?: number, options?: PageBlobGetPageRangesOptions): Promise<PageBlobGetPageRangesResponse>

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.

Vedere https://docs.microsoft.com/rest/api/storageservices/get-page-ranges

function getPageRangesDiff(offset: number, count: number, prevSnapshot: string, options?: PageBlobGetPageRangesDiffOptions): Promise<PageBlobGetPageRangesDiffResponse>

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.

Vedere https://docs.microsoft.com/rest/api/storageservices/get-page-ranges

function getPageRangesDiffForManagedDisks(offset: number, count: number, prevSnapshotUrl: string, options?: PageBlobGetPageRangesDiffOptions): Promise<PageBlobGetPageRangesDiffResponse>

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.

listPageRanges(number, number, PageBlobListPageRangesOptions)

Restituisce un iteratore iteratore asincrono per elencare gli intervalli di pagine per un BLOB di pagine.

Vedere https://docs.microsoft.com/rest/api/storageservices/get-page-ranges

.byPage() restituisce un iteratore iteratore asincrono per elencare gli intervalli di pagine per un BLOB di pagine.

Esempio di for await sintassi:

// Get the pageBlobClient before you run these snippets,
// Can be obtained from `blobServiceClient.getContainerClient("<your-container-name>").getPageBlobClient("<your-blob-name>");`
let i = 1;
for await (const pageRange of pageBlobClient.listPageRanges()) {
  console.log(`Page range ${i++}: ${pageRange.start} - ${pageRange.end}`);
}

Esempio con iter.next():

let i = 1;
let iter = pageBlobClient.listPageRanges();
let pageRangeItem = await iter.next();
while (!pageRangeItem.done) {
  console.log(`Page range ${i++}: ${pageRangeItem.value.start} - ${pageRangeItem.value.end}, IsClear: ${pageRangeItem.value.isClear}`);
  pageRangeItem = await iter.next();
}

Esempio con byPage():

// passing optional maxPageSize in the page settings
let i = 1;
for await (const response of pageBlobClient.listPageRanges().byPage({ maxPageSize: 20 })) {
  for (const pageRange of response) {
    console.log(`Page range ${i++}: ${pageRange.start} - ${pageRange.end}`);
  }
}

Esempio che usa il paging con un marcatore:

let i = 1;
let iterator = pageBlobClient.listPageRanges().byPage({ maxPageSize: 2 });
let response = (await iterator.next()).value;

// Prints 2 page ranges
for (const pageRange of response) {
  console.log(`Page range ${i++}: ${pageRange.start} - ${pageRange.end}`);
}

// Gets next marker
let marker = response.continuationToken;

// Passing next marker as continuationToken

iterator = pageBlobClient.listPageRanges().byPage({ continuationToken: marker, maxPageSize: 10 });
response = (await iterator.next()).value;

// Prints 10 page ranges
for (const blob of response) {
  console.log(`Page range ${i++}: ${pageRange.start} - ${pageRange.end}`);
}

function listPageRanges(offset?: number, count?: number, options?: PageBlobListPageRangesOptions): PagedAsyncIterableIterator<PageRangeInfo, PageBlobGetPageRangesResponseModel, PageSettings>

Parametri

offset

number

Posizione di byte iniziale degli intervalli di pagine.

count

number

Numero di byte da ottenere.

options
PageBlobListPageRangesOptions

Opzioni per l'operazione Recupera intervalli BLOB di pagine.

Restituisce

PagedAsyncIterableIterator<PageRangeInfo, PageBlobGetPageRangesResponseModel, PageSettings>

AsyncIterableIterator che supporta il paging.

listPageRangesDiff(number, number, string, PageBlobListPageRangesDiffOptions)

Restituisce un iteratore iteratore asincrono per elencare gli intervalli di pagine che differiscono tra uno snapshot specificato e questo BLOB di pagine.

Vedere https://docs.microsoft.com/rest/api/storageservices/get-page-ranges

.byPage() restituisce un iteratore iterabile asincrono per elencare gli intervalli di pagine che differiscono tra uno snapshot specificato e questo BLOB di pagine.

Esempio di for await sintassi:

// Get the pageBlobClient before you run these snippets,
// Can be obtained from `blobServiceClient.getContainerClient("<your-container-name>").getPageBlobClient("<your-blob-name>");`
let i = 1;
for await (const pageRange of pageBlobClient.listPageRangesDiff()) {
  console.log(`Page range ${i++}: ${pageRange.start} - ${pageRange.end}`);
}

Esempio con iter.next():

let i = 1;
let iter = pageBlobClient.listPageRangesDiff();
let pageRangeItem = await iter.next();
while (!pageRangeItem.done) {
  console.log(`Page range ${i++}: ${pageRangeItem.value.start} - ${pageRangeItem.value.end}, IsClear: ${pageRangeItem.value.isClear}`);
  pageRangeItem = await iter.next();
}

Esempio con byPage():

// passing optional maxPageSize in the page settings
let i = 1;
for await (const response of pageBlobClient.listPageRangesDiff().byPage({ maxPageSize: 20 })) {
  for (const pageRange of response) {
    console.log(`Page range ${i++}: ${pageRange.start} - ${pageRange.end}`);
  }
}

Esempio che usa il paging con un marcatore:

let i = 1;
let iterator = pageBlobClient.listPageRangesDiff().byPage({ maxPageSize: 2 });
let response = (await iterator.next()).value;

// Prints 2 page ranges
for (const pageRange of response) {
  console.log(`Page range ${i++}: ${pageRange.start} - ${pageRange.end}`);
}

// Gets next marker
let marker = response.continuationToken;

// Passing next marker as continuationToken

iterator = pageBlobClient.listPageRangesDiff().byPage({ continuationToken: marker, maxPageSize: 10 });
response = (await iterator.next()).value;

// Prints 10 page ranges
for (const blob of response) {
  console.log(`Page range ${i++}: ${pageRange.start} - ${pageRange.end}`);
}

function listPageRangesDiff(offset: number, count: number, prevSnapshot: string, options?: PageBlobListPageRangesDiffOptions): PagedAsyncIterableIterator<PageRangeInfo, PageBlobGetPageRangesDiffResponseModel, PageSettings>

Parametri

offset

number

Posizione di byte iniziale degli intervalli di pagine.

count

number

Numero di byte da ottenere.

prevSnapshot

string

Timestamp dello snapshot per recuperare la differenza.

options
PageBlobListPageRangesDiffOptions

Opzioni per l'operazione Recupera intervalli BLOB di pagine.

Restituisce

PagedAsyncIterableIterator<PageRangeInfo, PageBlobGetPageRangesDiffResponseModel, PageSettings>

AsyncIterableIterator che supporta il paging.

resize(number, PageBlobResizeOptions)

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

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

function resize(size: number, options?: PageBlobResizeOptions): Promise<PageBlobResizeResponse>

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.

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.

Vedere Vedere https://docs.microsoft.com/rest/api/storageservices/incremental-copy-blobhttps://docs.microsoft.com/en-us/azure/virtual-machines/windows/incremental-snapshots

function startCopyIncremental(copySource: string, options?: PageBlobStartCopyIncrementalOptions): Promise<PageBlobCopyIncrementalResponse>

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.

updateSequenceNumber(SequenceNumberActionType, number, PageBlobUpdateSequenceNumberOptions)

Imposta il numero di sequenza di un BLOB di pagine.

Vedere https://docs.microsoft.com/en-us/rest/api/storageservices/set-blob-properties

function updateSequenceNumber(sequenceNumberAction: SequenceNumberActionType, sequenceNumber?: number, options?: PageBlobUpdateSequenceNumberOptions): Promise<PageBlobUpdateSequenceNumberResponse>

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.

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

function uploadPages(body: HttpRequestBody, offset: number, count: number, options?: PageBlobUploadPagesOptions): Promise<PageBlobUploadPagesResponse>

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

Restituisce

Promise<PageBlobUploadPagesResponse>

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

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.

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

function uploadPagesFromURL(sourceURL: string, sourceOffset: number, destOffset: number, count: number, options?: PageBlobUploadPagesFromURLOptions): Promise<PageBlobUploadPagesFromURLResponse>

Parametri

sourceURL

string

Specificare un URL per l'origine di copia, firma di accesso condiviso (SAS) forse necessario per l'autenticazione

sourceOffset

number

Offset di origine da cui copiare. 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 snapshot specificato. Specificare "" rimuoverà lo snapshot e restituirà un client al BLOB di base.

function withSnapshot(snapshot: string): PageBlobClient

Parametri

snapshot

string

Timestamp dello snapshot.

Restituisce

PageBlobClient

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

Dettagli dei metodi ereditati

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.

Vedere https://docs.microsoft.com/en-us/rest/api/storageservices/abort-copy-blob

function abortCopyFromURL(copyId: string, options?: BlobAbortCopyFromURLOptions): Promise<BlobAbortCopyFromURLResponse>

Parametri

copyId

string

ID dell'operazione Copia da URL.

options
BlobAbortCopyFromURLOptions

Opzioni facoltative per l'operazione Copia da URL di interruzione BLOB.

Restituisce

Promise<BlobAbortCopyFromURLResponse>

Ereditato daBlobClient.abortCopyFromURL

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 a tempo indeterminato fino al completamento della copia. È anche possibile 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. L'operazione di copia dei BLOB da un account di archiviazione diverso è consentita solo per gli account di archiviazione creati il 7 giugno 2012 o successivamente.

Vedere https://docs.microsoft.com/en-us/rest/api/storageservices/copy-blob

Esempio che usa il polling automatico:

const copyPoller = await blobClient.beginCopyFromURL('url');
const result = await copyPoller.pollUntilDone();

Esempio di 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 modificato (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

copySource

string

URL dell'origine BLOB/file di Azure.

options
BlobBeginCopyFromURLOptions

Opzioni facoltative per l'operazione Di avvio copia dal BLOB dall'URL.

Restituisce

Promise<PollerLikeWithCancellation<PollOperationState<BlobBeginCopyFromURLResponse>, BlobBeginCopyFromURLResponse>>

Ereditato daBlobClient.beginCopyFromURL

createSnapshot(BlobCreateSnapshotOptions)

Crea uno snapshot di sola lettura di un BLOB.

Vedere https://docs.microsoft.com/en-us/rest/api/storageservices/snapshot-blob

function createSnapshot(options?: BlobCreateSnapshotOptions): Promise<BlobCreateSnapshotResponse>

Parametri

options
BlobCreateSnapshotOptions

Opzioni facoltative per l'operazione Di creazione snapshot BLOB.

Restituisce

Promise<BlobCreateSnapshotResponse>

Ereditato daBlobClient.createSnapshot

delete(BlobDeleteOptions)

Contrassegna il BLOB o lo snapshot specificato per l'eliminazione. Il Blob verrà eliminato in seguito durante un'operazione di Garbage Collection. Si noti che per eliminare un Blob, è necessario eliminare tutti i relativi snapshot. È possibile eliminare entrambi contemporaneamente con l'operazione Elimina BLOB.

Vedere https://docs.microsoft.com/en-us/rest/api/storageservices/delete-blob

function delete(options?: BlobDeleteOptions): Promise<BlobDeleteResponse>

Parametri

options
BlobDeleteOptions

Opzioni facoltative per l'operazione di eliminazione BLOB.

Restituisce

Promise<BlobDeleteResponse>

Ereditato daBlobClient.delete

deleteIfExists(BlobDeleteOptions)

Contrassegna il BLOB o lo snapshot specificato per l'eliminazione, se esistente. Il Blob verrà eliminato in seguito durante un'operazione di Garbage Collection. Si noti che per eliminare un Blob, è necessario eliminare tutti i relativi snapshot. È possibile eliminare entrambi contemporaneamente con l'operazione Elimina BLOB.

Vedere https://docs.microsoft.com/en-us/rest/api/storageservices/delete-blob

function deleteIfExists(options?: BlobDeleteOptions): Promise<BlobDeleteIfExistsResponse>

Parametri

options
BlobDeleteOptions

Opzioni facoltative per l'operazione di eliminazione BLOB.

Restituisce

Promise<BlobDeleteIfExistsResponse>

Ereditato daBlobClient.deleteIfExists

deleteImmutabilityPolicy(BlobDeleteImmutabilityPolicyOptions)

Eliminare i criteri di immutablility nel BLOB.

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

Parametri

options
BlobDeleteImmutabilityPolicyOptions

Opzioni facoltative per eliminare i criteri di immutabilità nel BLOB.

Restituisce

Promise<BlobDeleteImmutabilityPolicyResponse>

Ereditato daBlobClient.deleteImmutabilityPolicy

download(number, number, BlobDownloadOptions)

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

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

Vedere https://docs.microsoft.com/en-us/rest/api/storageservices/get-blob

function download(offset?: number, count?: number, options?: BlobDownloadOptions): Promise<BlobDownloadResponseParsed>

Parametri

offset

number

Da quale posizione del BLOB scaricare, maggiore o uguale a 0

count

number

Quantità di dati da scaricare, maggiore di 0. Verrà scaricato alla fine quando non definito

options
BlobDownloadOptions

Opzioni facoltative per l'operazione di download BLOB.

Esempio di utilizzo (Node.js):

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

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

Esempio di utilizzo (browser):

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

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

Restituisce

Promise<BlobDownloadResponseParsed>

Ereditato daBlobClient.download

downloadToBuffer(Buffer, number, number, BlobDownloadToBufferOptions)

DISPONIBILE SOLO IN NODE.JS RUNTIME.

Scarica un BLOB di Azure in parallelo in un buffer. Offset e conteggio sono facoltativi, scarica l'intero BLOB se non vengono forniti.

Avviso: i buffer possono supportare solo i file fino a circa un gigabyte nei sistemi a 32 bit o circa due gigabyte nei sistemi a 64 bit a causa delle limitazioni di Node.js/V8. Per i BLOB superiori a queste dimensioni, prendere in considerazione downloadToFile.

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

Parametri

buffer

Buffer

Il buffer da riempire deve avere una lunghezza maggiore del conteggio

offset

number

Da quale posizione del BLOB in blocchi scaricare(in byte)

count

number

Quantità di dati (in byte) da scaricare. Verrà scaricato alla fine quando si passa un valore non definito

options
BlobDownloadToBufferOptions

BlobDownloadToBufferOptions

Restituisce

Promise<Buffer>

Ereditato daBlobClient.downloadToBuffer

downloadToBuffer(number, number, BlobDownloadToBufferOptions)

DISPONIBILE SOLO IN NODE.JS RUNTIME.

Scarica un BLOB di Azure in parallelo in un buffer. Offset e conteggio sono facoltativi, scarica l'intero BLOB se non vengono forniti.

Avviso: i buffer possono supportare solo i file fino a circa un gigabyte nei sistemi a 32 bit o circa due gigabyte nei sistemi a 64 bit a causa delle limitazioni di Node.js/V8. Per i BLOB superiori a queste dimensioni, prendere in considerazione downloadToFile.

function downloadToBuffer(offset?: number, count?: number, options?: BlobDownloadToBufferOptions): Promise<Buffer>

Parametri

offset

number

Da quale posizione del BLOB in blocchi scaricare(in byte)

count

number

Quantità di dati (in byte) da scaricare. Verrà scaricato alla fine quando si passa un valore non definito

options
BlobDownloadToBufferOptions

BlobDownloadToBufferOptions

Restituisce

Promise<Buffer>

Ereditato daBlobClient.downloadToBuffer

downloadToFile(string, number, number, BlobDownloadOptions)

DISPONIBILE SOLO IN NODE.JS RUNTIME.

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

function downloadToFile(filePath: string, offset?: number, count?: number, options?: BlobDownloadOptions): Promise<BlobDownloadResponseParsed>

Parametri

filePath

string

offset

number

Da quale posizione del BLOB in blocchi scaricare.

count

number

Quantità di dati da scaricare. Verrà scaricato alla fine quando si passa un valore non definito.

options
BlobDownloadOptions

Opzioni per il download del BLOB.

Restituisce

Promise<BlobDownloadResponseParsed>

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

Ereditato daBlobClient.downloadToFile

exists(BlobExistsOptions)

Restituisce true se la risorsa BLOB di Azure rappresentata da questo client esiste; false in caso contrario.

NOTA: usare questa funzione con attenzione perché un BLOB esistente potrebbe essere eliminato da altri client o applicazioni. Viceversa, è possibile aggiungere nuovi BLOB da altri client o applicazioni al termine di questa funzione.

function exists(options?: BlobExistsOptions): Promise<boolean>

Parametri

options
BlobExistsOptions

opzioni per l'operazione Exists.

Restituisce

Promise<boolean>

Ereditato daBlobClient.exists

generateSasUrl(BlobGenerateSasUrlOptions)

Disponibile solo per BlobClient costruito con credenziali di chiave condivisa.

Genera un URI di firma di accesso condiviso (SAS) del servizio BLOB in base alle proprietà e ai parametri del client passati. La firma di accesso condiviso viene firmata dalle credenziali della chiave condivisa del client.

Vedere https://docs.microsoft.com/en-us/rest/api/storageservices/constructing-a-service-sas

function generateSasUrl(options: BlobGenerateSasUrlOptions): Promise<string>

Parametri

options
BlobGenerateSasUrlOptions

Parametri facoltativi.

Restituisce

Promise<string>

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

Ereditato daBlobClient.generateSasUrl

getAppendBlobClient()

Crea un oggetto AppendBlobClient.

function getAppendBlobClient(): AppendBlobClient

Restituisce

AppendBlobClient

Ereditato daBlobClient.getAppendBlobClient

getBlobLeaseClient(string)

Ottenere un BlobLeaseClient che gestisce i lease nel BLOB.

function getBlobLeaseClient(proposeLeaseId?: string): BlobLeaseClient

Parametri

proposeLeaseId

string

ID lease proposto iniziale.

Restituisce

BlobLeaseClient

Nuovo oggetto BlobLeaseClient per la gestione dei lease nel BLOB.

Ereditato daBlobClient.getBlobLeaseClient

getBlockBlobClient()

Crea un oggetto BlockBlobClient.

function getBlockBlobClient(): BlockBlobClient

Restituisce

BlockBlobClient

Ereditato daBlobClient.getBlockBlobClient

getPageBlobClient()

Crea un oggetto PageBlobClient.

function getPageBlobClient(): PageBlobClient

Restituisce

PageBlobClient

Ereditato daBlobClient.getPageBlobClient

getProperties(BlobGetPropertiesOptions)

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

Vedere https://docs.microsoft.com/en-us/rest/api/storageservices/get-blob-properties

AVVISO: l'oggetto metadata restituito nella risposta avrà le chiavi in lettere minuscole, anche se in origine contengono caratteri maiuscoli. Ciò è diverso dalle chiavi di metadati restituite dai metodi di ContainerClient che elencano i BLOB usando l'opzione , che manterrà le includeMetadata maiuscole e minuscole originali.

function getProperties(options?: BlobGetPropertiesOptions): Promise<BlobGetPropertiesResponse>

Parametri

options
BlobGetPropertiesOptions

Opzioni facoltative per l'operazione Recupera proprietà.

Restituisce

Promise<BlobGetPropertiesResponse>

Ereditato daBlobClient.getProperties

getTags(BlobGetTagsOptions)

Ottiene i tag associati al BLOB sottostante.

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

Parametri

options
BlobGetTagsOptions

Restituisce

Promise<BlobGetTagsResponse>

Ereditato daBlobClient.getTags

setAccessTier(string, BlobSetTierOptions)

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

Vedere https://docs.microsoft.com/en-us/rest/api/storageservices/set-blob-tier

function setAccessTier(tier: string, options?: BlobSetTierOptions): Promise<BlobSetTierResponse>

Parametri

tier

string

Livello da impostare nel BLOB. I valori validi sono Hot, Cool o Archive.

options
BlobSetTierOptions

Opzioni facoltative per l'operazione Livello set BLOB.

Restituisce

Promise<BlobSetTierResponse>

Ereditato daBlobClient.setAccessTier

setHTTPHeaders(BlobHTTPHeaders, BlobSetHTTPHeadersOptions)

Imposta le proprietà di sistema nel BLOB.

Se non viene specificato alcun valore o nessun valore specificato per le intestazioni HTTP BLOB specificate, queste intestazioni HTTP BLOB senza un valore verranno cancellate.

Vedere https://docs.microsoft.com/en-us/rest/api/storageservices/set-blob-properties

function setHTTPHeaders(blobHTTPHeaders?: BlobHTTPHeaders, options?: BlobSetHTTPHeadersOptions): Promise<BlobSetHTTPHeadersResponse>

Parametri

blobHTTPHeaders
BlobHTTPHeaders

Se non viene specificato alcun valore o nessun valore specificato per le intestazioni HTTP BLOB specificate, queste intestazioni HTTP BLOB senza un valore verranno cancellate. Un'intestazione comune da impostare consente blobContentType al browser di fornire funzionalità in base al tipo di file.

options
BlobSetHTTPHeadersOptions

Opzioni facoltative per l'operazione Imposta intestazioni HTTP del BLOB.

Restituisce

Promise<BlobSetHTTPHeadersResponse>

Ereditato daBlobClient.setHTTPHeaders

setImmutabilityPolicy(BlobImmutabilityPolicy, BlobSetImmutabilityPolicyOptions)

Impostare i criteri di immutablility nel BLOB.

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

Parametri

immutabilityPolicy
BlobImmutabilityPolicy
options
BlobSetImmutabilityPolicyOptions

Opzioni facoltative per impostare i criteri di immutabilità nel BLOB.

Restituisce

Promise<BlobSetImmutabilityPolicyResponse>

Ereditato daBlobClient.setImmutabilityPolicy

setLegalHold(boolean, BlobSetLegalHoldOptions)

Impostare il blocco a fini giudiziari sul BLOB.

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

Parametri

legalHoldEnabled

boolean

options
BlobSetLegalHoldOptions

Opzioni facoltative per impostare il blocco a fini giudiziari nel BLOB.

Restituisce

Promise<BlobSetLegalHoldResponse>

Ereditato daBlobClient.setLegalHold

setMetadata(Metadata, BlobSetMetadataOptions)

Imposta i metadati definiti dall'utente per il BLOB specificato come una o più coppie nome-valore.

Se non è stata specificata alcuna opzione o nessun metadati definito nel parametro, i metadati del BLOB verranno rimossi.

Vedere https://docs.microsoft.com/en-us/rest/api/storageservices/set-blob-metadata

function setMetadata(metadata?: Metadata, options?: BlobSetMetadataOptions): Promise<BlobSetMetadataResponse>

Parametri

metadata
Metadata

Sostituire i metadati esistenti con questo valore. Se non viene specificato alcun valore, i metadati esistenti verranno rimossi.

options
BlobSetMetadataOptions

Opzioni facoltative per impostare l'operazione metadati.

Restituisce

Promise<BlobSetMetadataResponse>

Ereditato daBlobClient.setMetadata

setTags(Tags, BlobSetTagsOptions)

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

function setTags(tags: Tags, options?: BlobSetTagsOptions): Promise<BlobSetTagsResponse>

Parametri

tags
Tags
options
BlobSetTagsOptions

Restituisce

Promise<BlobSetTagsResponse>

Ereditato daBlobClient.setTags

syncCopyFromURL(string, BlobSyncCopyFromURLOptions)

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

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

function syncCopyFromURL(copySource: string, options?: BlobSyncCopyFromURLOptions): Promise<BlobCopyFromURLResponse>

Parametri

copySource

string

URL di origine da cui copiare, firma di accesso condiviso (SAS) potrebbe essere necessario per l'autenticazione

options
BlobSyncCopyFromURLOptions

Restituisce

Promise<BlobCopyFromURLResponse>

Ereditato daBlobClient.syncCopyFromURL

undelete(BlobUndeleteOptions)

Ripristina il contenuto e i metadati del BLOB eliminato soft e degli snapshot eliminati soft associati. Il BLOB di annullamento dell'eliminazione è supportato solo nella versione 2017-07-29 o successiva.

Vedere https://docs.microsoft.com/en-us/rest/api/storageservices/undelete-blob

function undelete(options?: BlobUndeleteOptions): Promise<BlobUndeleteResponse>

Parametri

options
BlobUndeleteOptions

Opzioni facoltative per l'operazione di annullamento dell'eliminazione blob.

Restituisce

Promise<BlobUndeleteResponse>

Ereditato daBlobClient.undelete

withVersion(string)

Crea un nuovo oggetto BlobClient che punta a una versione di questo BLOB. Specificare "" rimuoverà il versionId e restituirà un client al BLOB di base.

function withVersion(versionId: string): BlobClient

Parametri

versionId

string

VersionId.

Restituisce

BlobClient

Nuovo oggetto BlobClient che punta alla versione di questo BLOB.

Ereditato daBlobClient.withVersion