Dela via

BlobBatchClient class

  • Referens
Paket:
@azure/storage-blob

Med En BlobBatchClient kan du göra batchbaserade begäranden till Azure Storage Blob-tjänsten.

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

Konstruktorer

BlobBatchClient(string, PipelineLike)

Skapar en instans av BlobBatchClient.
BlobBatchClient(string, StorageSharedKeyCredential | AnonymousCredential | TokenCredential, StoragePipelineOptions)

Skapar en instans av BlobBatchClient.

Metoder

createBatch()

Skapar en BlobBatch. En BlobBatch representerar en aggregerad uppsättning åtgärder på blobar.
deleteBlobs(BlobClient[], BlobDeleteOptions)

Skapa flera borttagningsåtgärder för att markera de angivna blobarna eller ögonblicksbilderna för borttagning. Observera att om du vill ta bort en blob måste du ta bort alla dess ögonblicksbilder. Du kan ta bort båda samtidigt. Se information om borttagningsåtgärder. Åtgärden (underbegäran) autentiseras och auktoriseras med angivna autentiseringsuppgifter. Se auktoriseringsinformation för blobbatch.
deleteBlobs(string[], StorageSharedKeyCredential | AnonymousCredential | TokenCredential, BlobDeleteOptions)

Skapa flera borttagningsåtgärder för att markera de angivna blobarna eller ögonblicksbilderna för borttagning. Observera att om du vill ta bort en blob måste du ta bort alla dess ögonblicksbilder. Du kan ta bort båda samtidigt. Se information om borttagningsåtgärder. Åtgärderna autentiseras och auktoriseras med angivna autentiseringsuppgifter. Se information om batchauktorisering för blobar.
setBlobsAccessTier(BlobClient[], AccessTier, BlobSetTierOptions)

Skapa åtgärder på flera uppsättningsnivåer för att ange nivån på en blob. Åtgärden tillåts på en sidblob i ett Premium Storage-konto och på en blockblob i ett bloblagringskonto (endast lokalt redundant lagring). En premium-sidblobs nivå avgör den tillåtna storleken, IOPS och bandbredden för bloben. En blockblobs nivå avgör lagringstypen Frekvent/Lågfrekvent/Arkivlagring. Den här åtgärden uppdaterar inte blobens ETag. Se ange information om blobnivå. Åtgärden (underbegäran) autentiseras och auktoriseras med angiven autentiseringsuppgift. Se information om batchauktorisering för blobar.
setBlobsAccessTier(string[], StorageSharedKeyCredential | AnonymousCredential | TokenCredential, AccessTier, BlobSetTierOptions)

Skapa åtgärder på flera uppsättningsnivåer för att ange nivån på en blob. Åtgärden tillåts på en sidblob i ett Premium Storage-konto och på en blockblob i ett bloblagringskonto (endast lokalt redundant lagring). En premium-sidblobs nivå avgör den tillåtna storleken, IOPS och bandbredden för bloben. En blockblobs nivå avgör lagringstypen Frekvent/Lågfrekvent/Arkivlagring. Den här åtgärden uppdaterar inte blobens ETag. Se ange information om blobnivå. Åtgärden (underbegäran) autentiseras och auktoriseras med angiven autentiseringsuppgift. Se information om batchauktorisering för blobar.
submitBatch(BlobBatch, BlobBatchSubmitBatchOptionalParams)

Skicka batchbegäran som består av flera underbegäranden.

Hämta blobBatchClient och annan information innan du kör kodfragmenten. blobServiceClient.getBlobBatchClient() ger blobBatchClient

Exempel på användning:

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

Exempel med ett lån:

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

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

Konstruktorinformation

BlobBatchClient(string, PipelineLike)

Skapar en instans av BlobBatchClient.

new BlobBatchClient(url: string, pipeline: PipelineLike)

Parametrar

url

string

En URL som pekar på Azure Storage-blobtjänsten, till exempel "https://myaccount.blob.core.windows.net". Du kan lägga till en SAS om du använder AnonymousCredential, till exempel "https://myaccount.blob.core.windows.net?sasString".

pipeline
PipelineLike

Anropa newPipeline() för att skapa en standardpipeline eller ange en anpassad pipeline.

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

Skapar en instans av BlobBatchClient.

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

Parametrar

url

string

En URL som pekar på Azure Storage-blobtjänsten, till exempel "https://myaccount.blob.core.windows.net". Du kan lägga till en SAS om du använder AnonymousCredential, till exempel "https://myaccount.blob.core.windows.net?sasString".

credential

StorageSharedKeyCredential | AnonymousCredential | TokenCredential

Till exempel AnonymousCredential, StorageSharedKeyCredential eller autentiseringsuppgifter från paketet för att autentisera @azure/identity begäranden till tjänsten. Du kan också ange ett -objekt som implementerar TokenCredential-gränssnittet. Om inget anges används AnonymousCredential.

options
StoragePipelineOptions

Alternativ för att konfigurera HTTP-pipelinen.

Metodinformation

createBatch()

Skapar en BlobBatch. En BlobBatch representerar en aggregerad uppsättning åtgärder på blobar.

function createBatch(): BlobBatch

Returer

BlobBatch

deleteBlobs(BlobClient[], BlobDeleteOptions)

Skapa flera borttagningsåtgärder för att markera de angivna blobarna eller ögonblicksbilderna för borttagning. Observera att om du vill ta bort en blob måste du ta bort alla dess ögonblicksbilder. Du kan ta bort båda samtidigt. Se information om borttagningsåtgärder. Åtgärden (underbegäran) autentiseras och auktoriseras med angivna autentiseringsuppgifter. Se auktoriseringsinformation för blobbatch.

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

Parametrar

blobClients

BlobClient[]

BlobClients som blobarna ska ta bort.

options
BlobDeleteOptions

Returer

Promise<BlobBatchSubmitBatchResponse>

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

Skapa flera borttagningsåtgärder för att markera de angivna blobarna eller ögonblicksbilderna för borttagning. Observera att om du vill ta bort en blob måste du ta bort alla dess ögonblicksbilder. Du kan ta bort båda samtidigt. Se information om borttagningsåtgärder. Åtgärderna autentiseras och auktoriseras med angivna autentiseringsuppgifter. Se information om batchauktorisering för blobar.

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

Parametrar

urls

string[]

URL:erna för de blobresurser som ska tas bort.

credential

StorageSharedKeyCredential | AnonymousCredential | TokenCredential

Till exempel AnonymousCredential, StorageSharedKeyCredential eller autentiseringsuppgifter från paketet för att autentisera @azure/identity begäranden till tjänsten. Du kan också ange ett objekt som implementerar TokenCredential-gränssnittet. Om det inte anges används AnonymousCredential.

options
BlobDeleteOptions

Returer

Promise<BlobBatchSubmitBatchResponse>

setBlobsAccessTier(BlobClient[], AccessTier, BlobSetTierOptions)

Skapa åtgärder på flera uppsättningsnivåer för att ange nivån på en blob. Åtgärden tillåts på en sidblob i ett Premium Storage-konto och på en blockblob i ett bloblagringskonto (endast lokalt redundant lagring). En premium-sidblobs nivå avgör den tillåtna storleken, IOPS och bandbredden för bloben. En blockblobs nivå avgör lagringstypen Frekvent/Lågfrekvent/Arkivlagring. Den här åtgärden uppdaterar inte blobens ETag. Se ange information om blobnivå. Åtgärden (underbegäran) autentiseras och auktoriseras med angiven autentiseringsuppgift. Se information om batchauktorisering för blobar.

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

Parametrar

blobClients

BlobClient[]

BlobClients för blobarna som ska ha en ny nivåuppsättning.

tier
AccessTier
options
BlobSetTierOptions

Returer

Promise<BlobBatchSubmitBatchResponse>

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

Skapa åtgärder på flera uppsättningsnivåer för att ange nivån på en blob. Åtgärden tillåts på en sidblob i ett Premium Storage-konto och på en blockblob i ett bloblagringskonto (endast lokalt redundant lagring). En premium-sidblobs nivå avgör den tillåtna storleken, IOPS och bandbredden för bloben. En blockblobs nivå avgör lagringstypen Frekvent/Lågfrekvent/Arkivlagring. Den här åtgärden uppdaterar inte blobens ETag. Se ange information om blobnivå. Åtgärden (underbegäran) autentiseras och auktoriseras med angiven autentiseringsuppgift. Se information om batchauktorisering för blobar.

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

Parametrar

urls

string[]

URL:erna för blobresursen som ska tas bort.

credential

StorageSharedKeyCredential | AnonymousCredential | TokenCredential

Till exempel AnonymousCredential, StorageSharedKeyCredential eller autentiseringsuppgifter från paketet för att autentisera @azure/identity begäranden till tjänsten. Du kan också ange ett objekt som implementerar TokenCredential-gränssnittet. Om det inte anges används AnonymousCredential.

tier
AccessTier
options
BlobSetTierOptions

Returer

Promise<BlobBatchSubmitBatchResponse>

submitBatch(BlobBatch, BlobBatchSubmitBatchOptionalParams)

Skicka batchbegäran som består av flera underbegäranden.

Hämta blobBatchClient och annan information innan du kör kodfragmenten. blobServiceClient.getBlobBatchClient() ger blobBatchClient

Exempel på användning:

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

Exempel med ett lån:

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

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

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

Parametrar

batchRequest
BlobBatch

En uppsättning borttagnings- eller SetTier-åtgärder.

options
BlobBatchSubmitBatchOptionalParams

Returer

Promise<BlobBatchSubmitBatchResponse>