Sdílet prostřednictvím

BlobBatchClient class

  • Reference
Balíček:
@azure/storage-blob

Objekt BlobBatchClient umožňuje provádět dávkové požadavky na službu Azure Storage Blob Service.

Viz https://docs.microsoft.com/en-us/rest/api/storageservices/blob-batch.

Konstruktory

BlobBatchClient(string, PipelineLike)

Vytvoří instanci BlobBatchClient.
BlobBatchClient(string, StorageSharedKeyCredential | AnonymousCredential | TokenCredential, StoragePipelineOptions)

Vytvoří instanci BlobBatchClient.

Metody

createBatch()

Vytvoří objekt BlobBatch. BlobBatch představuje agregovanou sadu operací s objekty blob.
deleteBlobs(BlobClient[], BlobDeleteOptions)

Vytvořte několik operací odstranění, které označí zadané objekty blob nebo snímky k odstranění. Upozorňujeme, že pokud chcete odstranit objekt blob, musíte odstranit všechny jeho snímky. Obojí můžete odstranit současně. Projděte si podrobnosti o operaci odstranění. Operace (dílčí žádost) bude ověřena a autorizována pomocí zadaných přihlašovacích údajů. Projděte si podrobnosti o autorizaci dávky objektů blob.
deleteBlobs(string[], StorageSharedKeyCredential | AnonymousCredential | TokenCredential, BlobDeleteOptions)

Vytvořte několik operací odstranění, které označí zadané objekty blob nebo snímky k odstranění. Upozorňujeme, že pokud chcete odstranit objekt blob, musíte odstranit všechny jeho snímky. Obojí můžete odstranit současně. Projděte si podrobnosti o operaci odstranění. Operace budou ověřeny a autorizovány pomocí zadaných přihlašovacích údajů. Projděte si podrobnosti o autorizaci dávky objektů blob.
setBlobsAccessTier(BlobClient[], AccessTier, BlobSetTierOptions)

Vytvořte operace s více úrovněmi, které nastaví úroveň v objektu blob. Operace je povolená pro objekt blob stránky v účtu služby Premium Storage a v objektu blob bloku v účtu úložiště objektů blob (pouze místně redundantní úložiště). Úroveň objektu blob stránky Úrovně Premium určuje povolenou velikost, IOPS a šířku pásma objektu blob. Úroveň objektu blob bloku určuje typ úložiště horká/studená/archivní. Tato operace neaktualizuje ETag objektu blob. Projděte si podrobnosti o nastavení úrovně objektů blob. Operace (dílčí žádost) bude ověřena a autorizována pomocí zadaných přihlašovacích údajů. Projděte si podrobnosti o autorizaci dávky objektů blob.
setBlobsAccessTier(string[], StorageSharedKeyCredential | AnonymousCredential | TokenCredential, AccessTier, BlobSetTierOptions)

Vytvořte operace s více úrovněmi, které nastaví úroveň v objektu blob. Operace je povolená pro objekt blob stránky v účtu služby Premium Storage a v objektu blob bloku v účtu úložiště objektů blob (pouze místně redundantní úložiště). Úroveň objektu blob stránky Úrovně Premium určuje povolenou velikost, IOPS a šířku pásma objektu blob. Úroveň objektu blob bloku určuje typ úložiště horká/studená/archivní. Tato operace neaktualizuje ETag objektu blob. Projděte si podrobnosti o nastavení úrovně objektů blob. Operace (dílčí žádost) bude ověřena a autorizována pomocí zadaných přihlašovacích údajů. Projděte si podrobnosti o autorizaci dávky objektů blob.
submitBatch(BlobBatch, BlobBatchSubmitBatchOptionalParams)

Odešlete dávkovou žádost, která se skládá z několika dílčích požadavků.

Před spuštěním fragmentů kódu získejte blobBatchClient další podrobnosti. blobServiceClient.getBlobBatchClient() poskytne blobBatchClient

Příklad použití:

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

Příklad použití zapůjčení:

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

Viz https://docs.microsoft.com/en-us/rest/api/storageservices/blob-batch.

Podrobnosti konstruktoru

BlobBatchClient(string, PipelineLike)

Vytvoří instanci BlobBatchClient.

new BlobBatchClient(url: string, pipeline: PipelineLike)

Parametry

url

string

Adresa URL odkazující na službu Objektů blob služby Azure Storage, například "https://myaccount.blob.core.windows.net". Sas můžete připojit, pokud používáte AnonymousCredential, například "https://myaccount.blob.core.windows.net?sasString".

pipeline
PipelineLike

Voláním příkazu newPipeline() vytvořte výchozí kanál nebo zadejte vlastní kanál.

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

Vytvoří instanci BlobBatchClient.

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

Parametry

url

string

Adresa URL odkazující na službu Objektů blob služby Azure Storage, například "https://myaccount.blob.core.windows.net". Sas můžete připojit, pokud používáte AnonymousCredential, například "https://myaccount.blob.core.windows.net?sasString".

credential

StorageSharedKeyCredential | AnonymousCredential | TokenCredential

Například AnonymousCredential, StorageSharedKeyCredential nebo jakékoli přihlašovací údaje z @azure/identity balíčku k ověřování požadavků na službu. Můžete také zadat objekt, který implementuje rozhraní TokenCredential. Pokud není zadáno, použije se AnonymníCredential.

options
StoragePipelineOptions

Možnosti konfigurace kanálu HTTP

Podrobnosti metody

createBatch()

Vytvoří objekt BlobBatch. BlobBatch představuje agregovanou sadu operací s objekty blob.

function createBatch(): BlobBatch

Návraty

BlobBatch

deleteBlobs(BlobClient[], BlobDeleteOptions)

Vytvořte několik operací odstranění, které označí zadané objekty blob nebo snímky k odstranění. Upozorňujeme, že pokud chcete odstranit objekt blob, musíte odstranit všechny jeho snímky. Obojí můžete odstranit současně. Projděte si podrobnosti o operaci odstranění. Operace (dílčí žádost) bude ověřena a autorizována pomocí zadaných přihlašovacích údajů. Projděte si podrobnosti o autorizaci dávky objektů blob.

function deleteBlobs(blobClients: BlobClient[], options?: BlobDeleteOptions): Promise<BlobBatchSubmitBatchResponse>

Parametry

blobClients

BlobClient[]

BlobClients pro objekty blob, které se mají odstranit.

options
BlobDeleteOptions

Návraty

Promise<BlobBatchSubmitBatchResponse>

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

Vytvořte několik operací odstranění, které označí zadané objekty blob nebo snímky k odstranění. Upozorňujeme, že pokud chcete odstranit objekt blob, musíte odstranit všechny jeho snímky. Obojí můžete odstranit současně. Projděte si podrobnosti o operaci odstranění. Operace budou ověřeny a autorizovány pomocí zadaných přihlašovacích údajů. Projděte si podrobnosti o autorizaci dávky objektů blob.

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

Parametry

urls

string[]

Adresy URL prostředků objektů blob, které se mají odstranit.

credential

StorageSharedKeyCredential | AnonymousCredential | TokenCredential

Například AnonymousCredential, StorageSharedKeyCredential nebo jakékoli přihlašovací údaje z @azure/identity balíčku k ověřování požadavků na službu. Můžete také zadat objekt, který implementuje rozhraní TokenCredential. Pokud není zadáno, použije se AnonymníCredential.

options
BlobDeleteOptions

Návraty

Promise<BlobBatchSubmitBatchResponse>

setBlobsAccessTier(BlobClient[], AccessTier, BlobSetTierOptions)

Vytvořte operace s více úrovněmi, které nastaví úroveň v objektu blob. Operace je povolená pro objekt blob stránky v účtu služby Premium Storage a v objektu blob bloku v účtu úložiště objektů blob (pouze místně redundantní úložiště). Úroveň objektu blob stránky Úrovně Premium určuje povolenou velikost, IOPS a šířku pásma objektu blob. Úroveň objektu blob bloku určuje typ úložiště horká/studená/archivní. Tato operace neaktualizuje ETag objektu blob. Projděte si podrobnosti o nastavení úrovně objektů blob. Operace (dílčí žádost) bude ověřena a autorizována pomocí zadaných přihlašovacích údajů. Projděte si podrobnosti o autorizaci dávky objektů blob.

function setBlobsAccessTier(blobClients: BlobClient[], tier: AccessTier, options?: BlobSetTierOptions): Promise<BlobBatchSubmitBatchResponse>

Parametry

blobClients

BlobClient[]

BlobClients pro objekty blob, které by měly mít novou sadu vrstev.

tier
AccessTier
options
BlobSetTierOptions

Návraty

Promise<BlobBatchSubmitBatchResponse>

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

Vytvořte operace s více úrovněmi, které nastaví úroveň v objektu blob. Operace je povolená pro objekt blob stránky v účtu služby Premium Storage a v objektu blob bloku v účtu úložiště objektů blob (pouze místně redundantní úložiště). Úroveň objektu blob stránky Úrovně Premium určuje povolenou velikost, IOPS a šířku pásma objektu blob. Úroveň objektu blob bloku určuje typ úložiště horká/studená/archivní. Tato operace neaktualizuje ETag objektu blob. Projděte si podrobnosti o nastavení úrovně objektů blob. Operace (dílčí žádost) bude ověřena a autorizována pomocí zadaných přihlašovacích údajů. Projděte si podrobnosti o autorizaci dávky objektů blob.

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

Parametry

urls

string[]

Adresy URL prostředku objektu blob, který chcete odstranit.

credential

StorageSharedKeyCredential | AnonymousCredential | TokenCredential

Například AnonymousCredential, StorageSharedKeyCredential nebo jakékoli přihlašovací údaje z @azure/identity balíčku k ověřování požadavků na službu. Můžete také zadat objekt, který implementuje rozhraní TokenCredential. Pokud není zadáno, použije se AnonymníCredential.

tier
AccessTier
options
BlobSetTierOptions

Návraty

Promise<BlobBatchSubmitBatchResponse>

submitBatch(BlobBatch, BlobBatchSubmitBatchOptionalParams)

Odešlete dávkovou žádost, která se skládá z několika dílčích požadavků.

Před spuštěním fragmentů kódu získejte blobBatchClient další podrobnosti. blobServiceClient.getBlobBatchClient() poskytne blobBatchClient

Příklad použití:

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

Příklad použití zapůjčení:

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

Viz https://docs.microsoft.com/en-us/rest/api/storageservices/blob-batch.

function submitBatch(batchRequest: BlobBatch, options?: BlobBatchSubmitBatchOptionalParams): Promise<BlobBatchSubmitBatchResponse>

Parametry

batchRequest
BlobBatch

Sada operací Delete nebo SetTier.

options
BlobBatchSubmitBatchOptionalParams

Návraty

Promise<BlobBatchSubmitBatchResponse>