BlobBatchClient class
BlobBatchClient umožňuje provádět dávkové požadavky do služby Azure Storage Blob Service.
Viz https://docs.microsoft.com/en-us/rest/api/storageservices/blob-batch
Konstruktory
Blob |
Vytvoří instanci BlobBatchClient. |
Blob |
Vytvoří instanci BlobBatchClient. |
Metody
create |
Vytvoří BlobBatch . BlobBatch představuje agregovanou sadu operací s objekty blob. |
delete |
Vytvořte několik operací odstranění, které označí zadané objekty blob nebo snímky k odstranění. Nezapomeňte, že pokud chcete odstranit objekt blob, musíte odstranit všechny jeho snímky. Obojí můžete odstranit současně. Viz podrobnosti operace odstranění. Operace (podrequest) se ověří a autorizuje pomocí zadaných přihlašovacích údajů. Viz podrobnosti o dávkové autorizaci objektů blob. |
delete |
Vytvořte několik operací odstranění, které označí zadané objekty blob nebo snímky k odstranění. Nezapomeňte, že pokud chcete odstranit objekt blob, musíte odstranit všechny jeho snímky. Obojí můžete odstranit současně. Viz podrobnosti operace odstranění. Operace budou ověřeny a autorizované pomocí zadaných přihlašovacích údajů. Viz podrobnosti o dávkové autorizaci objektů blob. |
set |
Vytvořte více operací sady vrstev, které nastaví vrstvu v objektu blob. Operace je povolená na objektu 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ě hot/Cool/Archive. Tato operace neaktualizuje značku ETag objektu blob. Viz nastavení podrobností o úrovni objektů blob. Operace (podrequest) se ověří a autorizuje pomocí zadaných přihlašovacích údajů. Viz podrobnosti o dávkové autorizaci objektů blob. |
set |
Vytvořte více operací sady vrstev, které nastaví vrstvu v objektu blob. Operace je povolená na objektu 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ě hot/Cool/Archive. Tato operace neaktualizuje značku ETag objektu blob. Viz nastavení podrobností o úrovni objektů blob. Operace (podrequest) se ověří a autorizuje pomocí zadaných přihlašovacích údajů. Viz podrobnosti o dávkové autorizaci objektů blob. |
submit |
Odešlete dávkový požadavek, který se skládá z několika podpožadek. Před spuštěním fragmentů kódu získejte Příklad použití:
Příklad použití zapůjčení:
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 metody newPipeline() vytvořte výchozí kanál nebo zadejte přizpůsobený 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 balíčku @azure/identity
k ověření požadavků na službu. Můžete také poskytnout objekt, který implementuje TokenCredential rozhraní. Pokud není zadáno, použije se anonymnícredential.
- options
- StoragePipelineOptions
Možnosti konfigurace kanálu HTTP
Podrobnosti metody
createBatch()
Vytvoří BlobBatch . BlobBatch představuje agregovanou sadu operací s objekty blob.
function createBatch(): BlobBatch
Návraty
deleteBlobs(BlobClient[], BlobDeleteOptions)
Vytvořte několik operací odstranění, které označí zadané objekty blob nebo snímky k odstranění. Nezapomeňte, že pokud chcete odstranit objekt blob, musíte odstranit všechny jeho snímky. Obojí můžete odstranit současně. Viz podrobnosti operace odstranění. Operace (podrequest) se ověří a autorizuje pomocí zadaných přihlašovacích údajů. Viz podrobnosti o dávkové autorizaci objektů blob.
function deleteBlobs(blobClients: BlobClient[], options?: BlobDeleteOptions): Promise<BlobBatchSubmitBatchResponse>
Parametry
- blobClients
Objekty blob 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í. Nezapomeňte, že pokud chcete odstranit objekt blob, musíte odstranit všechny jeho snímky. Obojí můžete odstranit současně. Viz podrobnosti operace odstranění. Operace budou ověřeny a autorizované pomocí zadaných přihlašovacích údajů. Viz podrobnosti o dávkové autorizaci 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 balíčku @azure/identity
k ověření požadavků na službu. Můžete také poskytnout objekt, který implementuje TokenCredential rozhraní. Pokud není zadáno, použije se anonymnícredential.
- options
- BlobDeleteOptions
Návraty
Promise<BlobBatchSubmitBatchResponse>
setBlobsAccessTier(BlobClient[], AccessTier, BlobSetTierOptions)
Vytvořte více operací sady vrstev, které nastaví vrstvu v objektu blob. Operace je povolená na objektu 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ě hot/Cool/Archive. Tato operace neaktualizuje značku ETag objektu blob. Viz nastavení podrobností o úrovni objektů blob. Operace (podrequest) se ověří a autorizuje pomocí zadaných přihlašovacích údajů. Viz podrobnosti o dávkové autorizaci objektů blob.
function setBlobsAccessTier(blobClients: BlobClient[], tier: AccessTier, options?: BlobSetTierOptions): Promise<BlobBatchSubmitBatchResponse>
Parametry
- blobClients
Objekty blobClient 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 více operací sady vrstev, které nastaví vrstvu v objektu blob. Operace je povolená na objektu 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ě hot/Cool/Archive. Tato operace neaktualizuje značku ETag objektu blob. Viz nastavení podrobností o úrovni objektů blob. Operace (podrequest) se ověří a autorizuje pomocí zadaných přihlašovacích údajů. Viz podrobnosti o dávkové autorizaci 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 balíčku @azure/identity
k ověření požadavků na službu. Můžete také poskytnout objekt, který implementuje TokenCredential rozhraní. Pokud není zadáno, použije se anonymnícredential.
- tier
- AccessTier
- options
- BlobSetTierOptions
Návraty
Promise<BlobBatchSubmitBatchResponse>
submitBatch(BlobBatch, BlobBatchSubmitBatchOptionalParams)
Odešlete dávkový požadavek, který se skládá z několika podpožadek.
Před spuštěním fragmentů kódu získejte blobBatchClient
a další podrobnosti.
blobServiceClient.getBlobBatchClient()
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.
Návraty
Promise<BlobBatchSubmitBatchResponse>