Freigeben über

BlobBatchClient class

  • Referenz
Paket:
@azure/storage-blob

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

Siehe https://learn.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 eine 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 für das Löschen zu markieren. Beachten Sie, dass Sie zum Löschen eines Blobs alle Momentaufnahmen löschen müssen. Sie können beide gleichzeitig löschen. Siehe Details zum Löschvorgang. Der Vorgang (Unteranforderung) wird authentifiziert und mit angegebenen Anmeldeinformationen autorisiert. Siehe Blobbatchautorisierungsdetails.
deleteBlobs(string[], StorageSharedKeyCredential | AnonymousCredential | TokenCredential, BlobDeleteOptions)

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

Erstellen Sie mehrere Satzebenenvorgänge, um die Ebene für ein Blob festzulegen. Der Vorgang ist in einem Seiten-BLOB in einem Premium-Speicherkonto und in einem Block-Blob in einem Blob-Speicherkonto zulässig (nur lokal redundanter Speicher). Die Ebene eines Premiumseiten-Blobs bestimmt die zulässige Größe, IOPS und Bandbreite des Blobs. Die Ebene eines Block-BLOB bestimmt den Speichertyp "Hot/Cool/Archive". Dieser Vorgang aktualisiert das ETag des BLOB nicht. Siehe Festlegen von Blobebenendetails. Der Vorgang (Unteranforderung) wird authentifiziert und mit angegebenen Anmeldeinformationen autorisiert. Siehe Blobbatchautorisierungsdetails.
setBlobsAccessTier(string[], StorageSharedKeyCredential | AnonymousCredential | TokenCredential, AccessTier, BlobSetTierOptions)

Erstellen Sie mehrere Satzebenenvorgänge, um die Ebene für ein Blob festzulegen. Der Vorgang ist in einem Seiten-BLOB in einem Premium-Speicherkonto und in einem Block-Blob in einem Blob-Speicherkonto zulässig (nur lokal redundanter Speicher). Die Ebene eines Premiumseiten-Blobs bestimmt die zulässige Größe, IOPS und Bandbreite des Blobs. Die Ebene eines Block-BLOB bestimmt den Speichertyp "Hot/Cool/Archive". Dieser Vorgang aktualisiert das ETag des BLOB nicht. Siehe Festlegen von Blobebenendetails. Der Vorgang (Unteranforderung) wird authentifiziert und mit angegebenen Anmeldeinformationen autorisiert. Siehe Blobbatchautorisierungsdetails.
submitBatch(BlobBatch, BlobBatchSubmitBatchOptionalParams)

Batchanforderung senden, die aus mehreren Unteranforderungen besteht.

Rufen Sie blobBatchClient und andere Details ab, bevor Sie die Codeausschnitte ausführen. blobServiceClient.getBlobBatchClient() gibt den 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 eine 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://learn.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-BLOB-Dienst verweist, z. B. "https://myaccount.blob.core.windows.net". Sie können eine SAS anfügen, wenn Anonyme Anmeldeinformationen verwendet werden, z. B. "https://myaccount.blob.core.windows.net?sasString".

pipeline
PipelineLike

Rufen Sie newPipeline() auf, um eine Standardpipeline zu erstellen oder eine angepasste Pipeline bereitzustellen.

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-BLOB-Dienst verweist, z. B. "https://myaccount.blob.core.windows.net". Sie können eine SAS anfügen, wenn Anonyme Anmeldeinformationen verwendet werden, z. B. "https://myaccount.blob.core.windows.net?sasString".

credential

StorageSharedKeyCredential | AnonymousCredential | TokenCredential

Wie anonyme Anmeldeinformationen, StorageSharedKeyCredential oder anmeldeinformationen aus dem @azure/identity-Paket zum Authentifizieren von Anforderungen an den Dienst. 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 eine 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 für das Löschen zu markieren. Beachten Sie, dass Sie zum Löschen eines Blobs alle Momentaufnahmen löschen müssen. Sie können beide gleichzeitig löschen. Siehe Details zum Löschvorgang. Der Vorgang (Unteranforderung) wird authentifiziert und mit angegebenen Anmeldeinformationen autorisiert. Siehe 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 für das Löschen zu markieren. Beachten Sie, dass Sie zum Löschen eines Blobs alle Momentaufnahmen löschen müssen. Sie können beide gleichzeitig löschen. Siehe Details zum Löschvorgang. Die Vorgänge werden authentifiziert und mit angegebenen Anmeldeinformationen autorisiert. Siehe Blobbatchautorisierungsdetails.

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

Parameter

urls

string[]

Die URLs der zu löschenden BLOB-Ressourcen.

credential

StorageSharedKeyCredential | AnonymousCredential | TokenCredential

Wie anonyme Anmeldeinformationen, StorageSharedKeyCredential oder anmeldeinformationen aus dem @azure/identity-Paket zum Authentifizieren von Anforderungen an den Dienst. 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 Satzebenenvorgänge, um die Ebene für ein Blob festzulegen. Der Vorgang ist in einem Seiten-BLOB in einem Premium-Speicherkonto und in einem Block-Blob in einem Blob-Speicherkonto zulässig (nur lokal redundanter Speicher). Die Ebene eines Premiumseiten-Blobs bestimmt die zulässige Größe, IOPS und Bandbreite des Blobs. Die Ebene eines Block-BLOB bestimmt den Speichertyp "Hot/Cool/Archive". Dieser Vorgang aktualisiert das ETag des BLOB nicht. Siehe Festlegen von Blobebenendetails. Der Vorgang (Unteranforderung) wird authentifiziert und mit angegebenen Anmeldeinformationen autorisiert. Siehe Blobbatchautorisierungsdetails.

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

Parameter

blobClients

BlobClient[]

Die BlobClients für die Blobs, die über einen neuen Ebenensatz verfügen sollen.

tier
AccessTier
options
BlobSetTierOptions

Gibt zurück

Promise<BlobBatchSubmitBatchResponse>

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

Erstellen Sie mehrere Satzebenenvorgänge, um die Ebene für ein Blob festzulegen. Der Vorgang ist in einem Seiten-BLOB in einem Premium-Speicherkonto und in einem Block-Blob in einem Blob-Speicherkonto zulässig (nur lokal redundanter Speicher). Die Ebene eines Premiumseiten-Blobs bestimmt die zulässige Größe, IOPS und Bandbreite des Blobs. Die Ebene eines Block-BLOB bestimmt den Speichertyp "Hot/Cool/Archive". Dieser Vorgang aktualisiert das ETag des BLOB nicht. Siehe Festlegen von Blobebenendetails. Der Vorgang (Unteranforderung) wird authentifiziert und mit angegebenen Anmeldeinformationen autorisiert. Siehe Blobbatchautorisierungsdetails.

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

Parameter

urls

string[]

Die URL der zu löschenden BLOB-Ressource.

credential

StorageSharedKeyCredential | AnonymousCredential | TokenCredential

Wie anonyme Anmeldeinformationen, StorageSharedKeyCredential oder anmeldeinformationen aus dem @azure/identity-Paket zum Authentifizieren von Anforderungen an den Dienst. 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)

Batchanforderung senden, die aus mehreren Unteranforderungen besteht.

Rufen Sie blobBatchClient und andere Details ab, bevor Sie die Codeausschnitte ausführen. blobServiceClient.getBlobBatchClient() gibt den 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 eine 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://learn.microsoft.com/en-us/rest/api/storageservices/blob-batch

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

Parameter

batchRequest
BlobBatch

Eine Gruppe von Lösch- oder SetTier-Vorgängen.

options
BlobBatchSubmitBatchOptionalParams

Gibt zurück

Promise<BlobBatchSubmitBatchResponse>