Condividi tramite

BlobBatchClient class

  • Riferimento
Pacchetto:
@azure/storage-blob

BlobBatchClient consente di effettuare richieste in batch al servizio BLOB di archiviazione di Azure.

Costruttori

BlobBatchClient(string, PipelineLike)

Crea un'istanza di BlobBatchClient.
BlobBatchClient(string, StorageSharedKeyCredential | AnonymousCredential | TokenCredential, StoragePipelineOptions)

Crea un'istanza di BlobBatchClient.

Metodi

createBatch()

Crea un oggetto <xref:BlobBatch>. BlobBatch rappresenta un set aggregato di operazioni sui BLOB.
deleteBlobs(BlobClient[], BlobDeleteOptions)

Creare più operazioni di eliminazione per contrassegnare i BLOB o gli snapshot specificati per l'eliminazione. Si noti che per eliminare un Blob, è necessario eliminare tutti i relativi snapshot. È possibile eliminare entrambi contemporaneamente. Vedere i dettagli dell'operazione di eliminazione. L'operazione (sottoquery) verrà autenticata e autorizzata con le credenziali specificate. Vedere i dettagli dell'autorizzazione batch blob.
deleteBlobs(string[], StorageSharedKeyCredential | AnonymousCredential | TokenCredential, BlobDeleteOptions)

Creare più operazioni di eliminazione per contrassegnare i BLOB o gli snapshot specificati per l'eliminazione. Si noti che per eliminare un Blob, è necessario eliminare tutti i relativi snapshot. È possibile eliminare entrambi contemporaneamente. Vedere i dettagli dell'operazione di eliminazione. Le operazioni verranno autenticate e autorizzate con le credenziali specificate. Vedere i dettagli dell'autorizzazione batch blob.
setBlobsAccessTier(BlobClient[], AccessTier, BlobSetTierOptions)

Creare più operazioni di livello set per impostare il livello in 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 Impostare i dettagli del livello BLOB. L'operazione (sottoquery) verrà autenticata e autorizzata con le credenziali specificate. Vedere i dettagli dell'autorizzazione batch blob.
setBlobsAccessTier(string[], StorageSharedKeyCredential | AnonymousCredential | TokenCredential, AccessTier, BlobSetTierOptions)

Creare più operazioni di livello set per impostare il livello in 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 Impostare i dettagli del livello BLOB. L'operazione (sottoquery) verrà autenticata e autorizzata con le credenziali specificate. Vedere i dettagli dell'autorizzazione batch blob.
submitBatch(BlobBatch, BlobBatchSubmitBatchOptionalParams)

Inviare una richiesta batch costituita da più sottoquery. Ottenere blobBatchClient e altri dettagli prima di eseguire i frammenti di codice. blobServiceClient.getBlobBatchClient() dà l'oggetto blobBatchClient

Esempio di utilizzo:

let batchRequest = new BlobBatch();
await batchRequest.deleteBlob(urlInString0, credential0);
await batchRequest.deleteBlob(urlInString1, credential1, {
 deleteSnapshots: "include"
});
const batchResp = await blobBatchClient.submitBatch(batchRequest);
console.log(batchResp.subResponsesSucceededCount);

Esempio di utilizzo di un lease:

let batchRequest = new BlobBatch();
await batchRequest.setBlobAccessTier(blockBlobClient0, "Cool");
await batchRequest.setBlobAccessTier(blockBlobClient1, "Cool", {
 conditions: { leaseId: leaseId }
});
const batchResp = await blobBatchClient.submitBatch(batchRequest);
console.log(batchResp.subResponsesSucceededCount);

Dettagli costruttore

BlobBatchClient(string, PipelineLike)

Crea un'istanza di BlobBatchClient.

new BlobBatchClient(url: string, pipeline: PipelineLike)

Parametri

url

string

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

pipeline
PipelineLike

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

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

Crea un'istanza di BlobBatchClient.

new BlobBatchClient(url: string, credential?: StorageSharedKeyCredential | AnonymousCredential | TokenCredential, options?: StoragePipelineOptions)

Parametri

url

string

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

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

Opzioni per configurare la pipeline HTTP.

Dettagli metodo

createBatch()

Crea un oggetto <xref:BlobBatch>. BlobBatch rappresenta un set aggregato di operazioni sui BLOB.

function createBatch()

Restituisce

BlobBatch

deleteBlobs(BlobClient[], BlobDeleteOptions)

Creare più operazioni di eliminazione per contrassegnare i BLOB o gli snapshot specificati per l'eliminazione. Si noti che per eliminare un Blob, è necessario eliminare tutti i relativi snapshot. È possibile eliminare entrambi contemporaneamente. Vedere i dettagli dell'operazione di eliminazione. L'operazione (sottoquery) verrà autenticata e autorizzata con le credenziali specificate. Vedere i dettagli dell'autorizzazione batch blob.

function deleteBlobs(blobClients: BlobClient[], options?: BlobDeleteOptions)

Parametri

blobClients

BlobClient[]

BlobClients per i BLOB da eliminare.

options
BlobDeleteOptions

Restituisce

Promise<BlobBatchDeleteBlobsResponse>

deleteBlobs(string[], StorageSharedKeyCredential | AnonymousCredential | TokenCredential, BlobDeleteOptions)

Creare più operazioni di eliminazione per contrassegnare i BLOB o gli snapshot specificati per l'eliminazione. Si noti che per eliminare un Blob, è necessario eliminare tutti i relativi snapshot. È possibile eliminare entrambi contemporaneamente. Vedere i dettagli dell'operazione di eliminazione. Le operazioni verranno autenticate e autorizzate con le credenziali specificate. Vedere i dettagli dell'autorizzazione batch blob.

function deleteBlobs(urls: string[], credential: StorageSharedKeyCredential | AnonymousCredential | TokenCredential, options?: BlobDeleteOptions)

Parametri

urls

string[]

URL delle risorse BLOB da eliminare.

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
BlobDeleteOptions

Restituisce

Promise<BlobBatchDeleteBlobsResponse>

setBlobsAccessTier(BlobClient[], AccessTier, BlobSetTierOptions)

Creare più operazioni di livello set per impostare il livello in 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 Impostare i dettagli del livello BLOB. L'operazione (sottoquery) verrà autenticata e autorizzata con le credenziali specificate. Vedere i dettagli dell'autorizzazione batch blob.

function setBlobsAccessTier(blobClients: BlobClient[], tier: AccessTier, options?: BlobSetTierOptions)

Parametri

blobClients

BlobClient[]

BlobClients per i BLOB che devono avere un nuovo livello impostato.

tier
AccessTier
options
BlobSetTierOptions

Restituisce

Promise<BlobBatchSetBlobsAccessTierResponse>

setBlobsAccessTier(string[], StorageSharedKeyCredential | AnonymousCredential | TokenCredential, AccessTier, BlobSetTierOptions)

Creare più operazioni di livello set per impostare il livello in 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 Impostare i dettagli del livello BLOB. L'operazione (sottoquery) verrà autenticata e autorizzata con le credenziali specificate. Vedere i dettagli dell'autorizzazione batch blob.

function setBlobsAccessTier(urls: string[], credential: StorageSharedKeyCredential | AnonymousCredential | TokenCredential, tier: AccessTier, options?: BlobSetTierOptions)

Parametri

urls

string[]

URL della risorsa BLOB da eliminare.

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.

tier
AccessTier
options
BlobSetTierOptions

Restituisce

Promise<BlobBatchSetBlobsAccessTierResponse>

submitBatch(BlobBatch, BlobBatchSubmitBatchOptionalParams)

Inviare una richiesta batch costituita da più sottoquery. Ottenere blobBatchClient e altri dettagli prima di eseguire i frammenti di codice. blobServiceClient.getBlobBatchClient() dà l'oggetto blobBatchClient

Esempio di utilizzo:

let batchRequest = new BlobBatch();
await batchRequest.deleteBlob(urlInString0, credential0);
await batchRequest.deleteBlob(urlInString1, credential1, {
 deleteSnapshots: "include"
});
const batchResp = await blobBatchClient.submitBatch(batchRequest);
console.log(batchResp.subResponsesSucceededCount);

Esempio di utilizzo di un lease:

let batchRequest = new BlobBatch();
await batchRequest.setBlobAccessTier(blockBlobClient0, "Cool");
await batchRequest.setBlobAccessTier(blockBlobClient1, "Cool", {
 conditions: { leaseId: leaseId }
});
const batchResp = await blobBatchClient.submitBatch(batchRequest);
console.log(batchResp.subResponsesSucceededCount);

function submitBatch(batchRequest: BlobBatch, options?: BlobBatchSubmitBatchOptionalParams)

Parametri

batchRequest
BlobBatch

Set di operazioni Delete o SetTier.

options
BlobBatchSubmitBatchOptionalParams

Restituisce

Promise<BlobBatchSubmitBatchResponse>