Freigeben über

BlobBatchClient class

  • Referenz
Paket:
@azure/storage-blob

Mit einem BlobBatchClient können Sie Batchanforderungen an den Azure Storage-Blobdienst senden.

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

Konstruktoren

BlobBatchClient(string, PipelineLike)

Erstellt eine Instanz von BlobBatchClient.
BlobBatchClient(string, StorageSharedKeyCredential | AnonymousCredential | TokenCredential, StoragePipelineOptions)

Erstellt eine Instanz von BlobBatchClient.

Methoden

createBatch()

Erstellt einen BlobBatch. Ein BlobBatch stellt einen aggregierten Satz von Vorgängen für Blobs dar.
deleteBlobs(BlobClient[], BlobDeleteOptions)

Erstellen Sie mehrere Löschvorgänge, um die angegebenen Blobs oder Momentaufnahmen zum Löschen zu markieren. Beachten Sie, dass Sie zum Löschen eines BLOB alle zugehörigen Momentaufnahmen löschen müssen. Sie können beide gleichzeitig löschen. Weitere Informationen finden Sie unter Details zum Löschvorgang. Der Vorgang (Subrequest) wird mit den angegebenen Anmeldeinformationen authentifiziert und autorisiert. Weitere Informationen finden Sie unter Blobbatchautorisierungsdetails.
deleteBlobs(string[], StorageSharedKeyCredential | AnonymousCredential | TokenCredential, BlobDeleteOptions)

Erstellen Sie mehrere Löschvorgänge, um die angegebenen Blobs oder Momentaufnahmen zum Löschen zu markieren. Beachten Sie, dass Sie zum Löschen eines BLOB alle zugehörigen Momentaufnahmen löschen müssen. Sie können beide gleichzeitig löschen. Weitere Informationen finden Sie unter Details zum Löschvorgang. Die Vorgänge werden mit angegebenen Anmeldeinformationen authentifiziert und autorisiert. Weitere Informationen finden Sie unter Blobbatchautorisierungsdetails.
setBlobsAccessTier(BlobClient[], AccessTier, BlobSetTierOptions)

Erstellen Sie mehrere Set-Ebenenvorgänge, um die Ebene für ein Blob festzulegen. Der Vorgang ist für ein Seitenblob in einem Storage Premium-Konto und für ein Blockblob in einem Blobspeicherkonto (nur lokal redundanter Speicher) zulässig. Die Ebene eines Premium-Seitenblobs bestimmt die zulässige Größe, IOPS und Bandbreite des Blobs. Die Ebene eines Blockblobs bestimmt den Speichertyp "Heiß/Kalt/Archiv". Bei diesem Vorgang wird das ETag des Blobs nicht aktualisiert. Weitere Informationen finden Sie unter Festlegen von Blobebenendetails. Der Vorgang (Subrequest) wird mit den angegebenen Anmeldeinformationen authentifiziert und autorisiert. Weitere Informationen finden Sie unter Blobbatchautorisierungsdetails.
setBlobsAccessTier(string[], StorageSharedKeyCredential | AnonymousCredential | TokenCredential, AccessTier, BlobSetTierOptions)

Erstellen Sie mehrere Set-Ebenenvorgänge, um die Ebene für ein Blob festzulegen. Der Vorgang ist für ein Seitenblob in einem Storage Premium-Konto und für ein Blockblob in einem Blobspeicherkonto (nur lokal redundanter Speicher) zulässig. Die Ebene eines Premium-Seitenblobs bestimmt die zulässige Größe, IOPS und Bandbreite des Blobs. Die Ebene eines Blockblobs bestimmt den Speichertyp "Heiß/Kalt/Archiv". Bei diesem Vorgang wird das ETag des Blobs nicht aktualisiert. Weitere Informationen finden Sie unter Festlegen von Blobebenendetails. Der Vorgang (Subrequest) wird mit den angegebenen Anmeldeinformationen authentifiziert und autorisiert. Weitere Informationen finden Sie unter Blobbatchautorisierungsdetails.
submitBatch(BlobBatch, BlobBatchSubmitBatchOptionalParams)

Senden Sie eine Batchanforderung, die aus mehreren Unteranforderungen besteht.

Rufen Sie blobBatchClient und andere Details ab, bevor Sie die Codeausschnitte ausführen. blobServiceClient.getBlobBatchClient() gibt die blobBatchClient

Beispielverwendung:

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

Beispiel für die Verwendung einer 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);

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

Details zum Konstruktor

BlobBatchClient(string, PipelineLike)

Erstellt eine Instanz von BlobBatchClient.

new BlobBatchClient(url: string, pipeline: PipelineLike)

Parameter

url

string

Eine URL, die auf den Azure Storage-Blobdienst verweist, z. B. "https://myaccount.blob.core.windows.net". Sie können eine SAS anfügen, wenn Sie AnonymousCredential verwenden, z. B. "https://myaccount.blob.core.windows.net?sasString".

pipeline
PipelineLike

Rufen Sie newPipeline() auf, um eine Standardpipeline zu erstellen, oder stellen Sie eine benutzerdefinierte Pipeline bereit.

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

Erstellt eine Instanz von BlobBatchClient.

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

Parameter

url

string

Eine URL, die auf den Azure Storage-Blobdienst verweist, z. B. "https://myaccount.blob.core.windows.net". Sie können eine SAS anfügen, wenn Sie AnonymousCredential verwenden, z. B. "https://myaccount.blob.core.windows.net?sasString".

credential

StorageSharedKeyCredential | AnonymousCredential | TokenCredential

Beispielsweise AnonymousCredential, StorageSharedKeyCredential oder alle Anmeldeinformationen aus dem @azure/identity Paket, um Anforderungen an den Dienst zu authentifizieren. Sie können auch ein -Objekt bereitstellen, das die TokenCredential-Schnittstelle implementiert. Wenn nicht angegeben, wird AnonymousCredential verwendet.

options
StoragePipelineOptions

Optionen zum Konfigurieren der HTTP-Pipeline.

Details zur Methode

createBatch()

Erstellt einen BlobBatch. Ein BlobBatch stellt einen aggregierten Satz von Vorgängen für Blobs dar.

function createBatch(): BlobBatch

Gibt zurück

BlobBatch

deleteBlobs(BlobClient[], BlobDeleteOptions)

Erstellen Sie mehrere Löschvorgänge, um die angegebenen Blobs oder Momentaufnahmen zum Löschen zu markieren. Beachten Sie, dass Sie zum Löschen eines BLOB alle zugehörigen Momentaufnahmen löschen müssen. Sie können beide gleichzeitig löschen. Weitere Informationen finden Sie unter Details zum Löschvorgang. Der Vorgang (Subrequest) wird mit den angegebenen Anmeldeinformationen authentifiziert und autorisiert. Weitere Informationen finden Sie unter Blobbatchautorisierungsdetails.

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

Parameter

blobClients

BlobClient[]

Die BlobClients für die zu löschenden Blobs.

options
BlobDeleteOptions

Gibt zurück

Promise<BlobBatchSubmitBatchResponse>

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

Erstellen Sie mehrere Löschvorgänge, um die angegebenen Blobs oder Momentaufnahmen zum Löschen zu markieren. Beachten Sie, dass Sie zum Löschen eines BLOB alle zugehörigen Momentaufnahmen löschen müssen. Sie können beide gleichzeitig löschen. Weitere Informationen finden Sie unter Details zum Löschvorgang. Die Vorgänge werden mit angegebenen Anmeldeinformationen authentifiziert und autorisiert. Weitere Informationen finden Sie unter Blobbatchautorisierungsdetails.

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

Parameter

urls

string[]

Die URLs der zu löschenden Blobressourcen.

credential

StorageSharedKeyCredential | AnonymousCredential | TokenCredential

Beispielsweise AnonymousCredential, StorageSharedKeyCredential oder alle Anmeldeinformationen aus dem @azure/identity Paket, um Anforderungen an den Dienst zu authentifizieren. Sie können auch ein -Objekt bereitstellen, das die TokenCredential-Schnittstelle implementiert. Wenn nicht angegeben, wird AnonymousCredential verwendet.

options
BlobDeleteOptions

Gibt zurück

Promise<BlobBatchSubmitBatchResponse>

setBlobsAccessTier(BlobClient[], AccessTier, BlobSetTierOptions)

Erstellen Sie mehrere Set-Ebenenvorgänge, um die Ebene für ein Blob festzulegen. Der Vorgang ist für ein Seitenblob in einem Storage Premium-Konto und für ein Blockblob in einem Blobspeicherkonto (nur lokal redundanter Speicher) zulässig. Die Ebene eines Premium-Seitenblobs bestimmt die zulässige Größe, IOPS und Bandbreite des Blobs. Die Ebene eines Blockblobs bestimmt den Speichertyp "Heiß/Kalt/Archiv". Bei diesem Vorgang wird das ETag des Blobs nicht aktualisiert. Weitere Informationen finden Sie unter Festlegen von Blobebenendetails. Der Vorgang (Subrequest) wird mit den angegebenen Anmeldeinformationen authentifiziert und autorisiert. Weitere Informationen finden Sie unter Blobbatchautorisierungsdetails.

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

Parameter

blobClients

BlobClient[]

Die BlobClients für die Blobs, für die ein neuer Tarif festgelegt sein soll.

tier
AccessTier
options
BlobSetTierOptions

Gibt zurück

Promise<BlobBatchSubmitBatchResponse>

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

Erstellen Sie mehrere Set-Ebenenvorgänge, um die Ebene für ein Blob festzulegen. Der Vorgang ist für ein Seitenblob in einem Storage Premium-Konto und für ein Blockblob in einem Blobspeicherkonto (nur lokal redundanter Speicher) zulässig. Die Ebene eines Premium-Seitenblobs bestimmt die zulässige Größe, IOPS und Bandbreite des Blobs. Die Ebene eines Blockblobs bestimmt den Speichertyp "Heiß/Kalt/Archiv". Bei diesem Vorgang wird das ETag des Blobs nicht aktualisiert. Weitere Informationen finden Sie unter Festlegen von Blobebenendetails. Der Vorgang (Subrequest) wird mit den angegebenen Anmeldeinformationen authentifiziert und autorisiert. Weitere Informationen finden Sie unter Blobbatchautorisierungsdetails.

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

Parameter

urls

string[]

Die URLs der zu löschenden Blobressource.

credential

StorageSharedKeyCredential | AnonymousCredential | TokenCredential

Beispielsweise AnonymousCredential, StorageSharedKeyCredential oder alle Anmeldeinformationen aus dem @azure/identity Paket, um Anforderungen an den Dienst zu authentifizieren. Sie können auch ein -Objekt bereitstellen, das die TokenCredential-Schnittstelle implementiert. Wenn nicht angegeben, wird AnonymousCredential verwendet.

tier
AccessTier
options
BlobSetTierOptions

Gibt zurück

Promise<BlobBatchSubmitBatchResponse>

submitBatch(BlobBatch, BlobBatchSubmitBatchOptionalParams)

Senden Sie eine Batchanforderung, die aus mehreren Unteranforderungen besteht.

Rufen Sie blobBatchClient und andere Details ab, bevor Sie die Codeausschnitte ausführen. blobServiceClient.getBlobBatchClient() gibt die blobBatchClient

Beispielverwendung:

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

Beispiel für die Verwendung einer 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);

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

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

Parameter

batchRequest
BlobBatch

Eine Gruppe von Delete- oder SetTier-Vorgängen.

options
BlobBatchSubmitBatchOptionalParams

Gibt zurück

Promise<BlobBatchSubmitBatchResponse>