BlobBatchClient class

Pakiet:

@azure/storage-blob

Obiekt BlobBatchClient umożliwia wykonywanie wsadowych żądań do usługi Azure Storage Blob Service.

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

Konstruktory

BlobBatchClient(string, PipelineLike)	Tworzy wystąpienie obiektu BlobBatchClient.
BlobBatchClient(string, StorageSharedKeyCredential | AnonymousCredential | TokenCredential, StoragePipelineOptions)	Tworzy wystąpienie obiektu BlobBatchClient.

Metody

createBatch()	Tworzy obiekt BlobBatch. Obiekt BlobBatch reprezentuje zagregowany zestaw operacji na obiektach blob.
deleteBlobs(BlobClient[], BlobDeleteOptions)	Utwórz wiele operacji usuwania, aby oznaczyć określone obiekty blob lub migawki do usunięcia. Należy pamiętać, że aby usunąć obiekt blob, należy usunąć wszystkie jego migawki. Oba te elementy można usunąć w tym samym czasie. Zobacz szczegóły operacji usuwania. Operacja (subrequest) zostanie uwierzytelniona i autoryzowana przy użyciu określonych poświadczeń. Zobacz szczegóły autoryzacji wsadowej obiektów blob.
deleteBlobs(string[], StorageSharedKeyCredential | AnonymousCredential | TokenCredential, BlobDeleteOptions)	Utwórz wiele operacji usuwania, aby oznaczyć określone obiekty blob lub migawki do usunięcia. Należy pamiętać, że aby usunąć obiekt blob, należy usunąć wszystkie jego migawki. Oba te elementy można usunąć w tym samym czasie. Zobacz szczegóły operacji usuwania. Operacje zostaną uwierzytelnione i autoryzowane przy użyciu określonych poświadczeń. Zobacz szczegóły autoryzacji wsadowej obiektu blob.
setBlobsAccessTier(BlobClient[], AccessTier, BlobSetTierOptions)	Utwórz wiele operacji warstwy zestawu, aby ustawić warstwę w obiekcie blob. Operacja jest dozwolona na stronicowym obiekcie blob na koncie usługi Premium Storage i na blokowym obiekcie blob na koncie magazynu obiektów blob (tylko magazyn lokalnie nadmiarowy). Warstwa stronicowego obiektu blob w warstwie Premium określa dozwolony rozmiar, liczbę operacji we/wy na sekundę i przepustowość obiektu blob. Warstwa blokowego obiektu blob określa typ magazynu Gorąca/Chłodna/Archiwum. Ta operacja nie aktualizuje elementu ETag obiektu blob. Zobacz ustawianie szczegółów warstwy obiektu blob. Operacja (subrequest) zostanie uwierzytelniona i autoryzowana przy użyciu określonych poświadczeń. Zobacz szczegóły autoryzacji wsadowej obiektu blob.
setBlobsAccessTier(string[], StorageSharedKeyCredential | AnonymousCredential | TokenCredential, AccessTier, BlobSetTierOptions)	Utwórz wiele operacji warstwy zestawu, aby ustawić warstwę w obiekcie blob. Operacja jest dozwolona na stronicowym obiekcie blob na koncie usługi Premium Storage i na blokowym obiekcie blob na koncie magazynu obiektów blob (tylko magazyn lokalnie nadmiarowy). Warstwa stronicowego obiektu blob w warstwie Premium określa dozwolony rozmiar, liczbę operacji we/wy na sekundę i przepustowość obiektu blob. Warstwa blokowego obiektu blob określa typ magazynu Gorąca/Chłodna/Archiwum. Ta operacja nie aktualizuje elementu ETag obiektu blob. Zobacz ustawianie szczegółów warstwy obiektu blob. Operacja (subrequest) zostanie uwierzytelniona i autoryzowana przy użyciu określonych poświadczeń. Zobacz szczegóły autoryzacji wsadowej obiektu blob.
submitBatch(BlobBatch, BlobBatchSubmitBatchOptionalParams)	Prześlij żądanie wsadowe składające się z wielu podkwestni. Pobierz blobBatchClient i inne szczegóły przed uruchomieniem fragmentów kodu. blobServiceClient.getBlobBatchClient() daje blobBatchClient Przykład użycia: 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); Przykład użycia dzierżawy: 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); Zobacz https://docs.microsoft.com/en-us/rest/api/storageservices/blob-batch

Szczegóły konstruktora

BlobBatchClient(string, PipelineLike)

Tworzy wystąpienie obiektu BlobBatchClient.

new BlobBatchClient(url: string, pipeline: PipelineLike)

Parametry

url

string

Adres URL wskazujący usługę Azure Storage Blob Service, taką jak "https://myaccount.blob.core.windows.net". Sygnaturę dostępu współdzielonego można dołączyć, jeśli używasz elementu AnonymousCredential, takiego jak "https://myaccount.blob.core.windows.net?sasString".

pipeline

PipelineLike

Wywołaj metodę newPipeline(), aby utworzyć domyślny potok, lub podaj dostosowany potok.

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

Tworzy wystąpienie obiektu BlobBatchClient.

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

Parametry

url

string

Adres URL wskazujący usługę Azure Storage Blob Service, taką jak "https://myaccount.blob.core.windows.net". Sygnaturę dostępu współdzielonego można dołączyć, jeśli używasz elementu AnonymousCredential, takiego jak "https://myaccount.blob.core.windows.net?sasString".

credential

StorageSharedKeyCredential | AnonymousCredential | TokenCredential

Takie jak AnonymousCredential, StorageSharedKeyCredential lub dowolne poświadczenia z pakietu w @azure/identity celu uwierzytelnienia żądań do usługi. Można również podać obiekt, który implementuje interfejs TokenCredential. Jeśli nie zostanie określony, zostanie użyty parametr AnonymousCredential.

options

StoragePipelineOptions

Opcje konfigurowania potoku HTTP.

Szczegóły metody

createBatch()

Tworzy obiekt BlobBatch. Obiekt BlobBatch reprezentuje zagregowany zestaw operacji na obiektach blob.

function createBatch(): BlobBatch

Zwraca

BlobBatch

deleteBlobs(BlobClient[], BlobDeleteOptions)

Utwórz wiele operacji usuwania, aby oznaczyć określone obiekty blob lub migawki do usunięcia. Należy pamiętać, że aby usunąć obiekt blob, należy usunąć wszystkie jego migawki. Oba te elementy można usunąć w tym samym czasie. Zobacz szczegóły operacji usuwania. Operacja (subrequest) zostanie uwierzytelniona i autoryzowana przy użyciu określonych poświadczeń. Zobacz szczegóły autoryzacji wsadowej obiektów blob.

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

Parametry

blobClients

BlobClient[]

Obiekty blobClient dla obiektów blob do usunięcia.

options

BlobDeleteOptions

Zwraca

Promise<BlobBatchSubmitBatchResponse>

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

Utwórz wiele operacji usuwania, aby oznaczyć określone obiekty blob lub migawki do usunięcia. Należy pamiętać, że aby usunąć obiekt blob, należy usunąć wszystkie jego migawki. Oba te elementy można usunąć w tym samym czasie. Zobacz szczegóły operacji usuwania. Operacje zostaną uwierzytelnione i autoryzowane przy użyciu określonych poświadczeń. Zobacz szczegóły autoryzacji wsadowej obiektu blob.

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

Parametry

urls

string[]

Adresy URL zasobów obiektów blob do usunięcia.

credential

StorageSharedKeyCredential | AnonymousCredential | TokenCredential

Takie jak AnonymousCredential, StorageSharedKeyCredential lub dowolne poświadczenia z @azure/identity pakietu w celu uwierzytelnienia żądań do usługi. Można również podać obiekt implementujący interfejs TokenCredential. Jeśli nie zostanie określony, zostanie użyty parametr AnonymousCredential.

options

BlobDeleteOptions

Zwraca

Promise<BlobBatchSubmitBatchResponse>

setBlobsAccessTier(BlobClient[], AccessTier, BlobSetTierOptions)

Utwórz wiele operacji warstwy zestawu, aby ustawić warstwę w obiekcie blob. Operacja jest dozwolona na stronicowym obiekcie blob na koncie usługi Premium Storage i na blokowym obiekcie blob na koncie magazynu obiektów blob (tylko magazyn lokalnie nadmiarowy). Warstwa stronicowego obiektu blob w warstwie Premium określa dozwolony rozmiar, liczbę operacji we/wy na sekundę i przepustowość obiektu blob. Warstwa blokowego obiektu blob określa typ magazynu Gorąca/Chłodna/Archiwum. Ta operacja nie aktualizuje elementu ETag obiektu blob. Zobacz ustawianie szczegółów warstwy obiektu blob. Operacja (subrequest) zostanie uwierzytelniona i autoryzowana przy użyciu określonych poświadczeń. Zobacz szczegóły autoryzacji wsadowej obiektu blob.

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

Parametry

blobClients

BlobClient[]

Obiekty blobClient dla obiektów blob, które powinny mieć nowy zestaw warstw.

tier

AccessTier

options

BlobSetTierOptions

Zwraca

Promise<BlobBatchSubmitBatchResponse>

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

Utwórz wiele operacji warstwy zestawu, aby ustawić warstwę w obiekcie blob. Operacja jest dozwolona na stronicowym obiekcie blob na koncie usługi Premium Storage i na blokowym obiekcie blob na koncie magazynu obiektów blob (tylko magazyn lokalnie nadmiarowy). Warstwa stronicowego obiektu blob w warstwie Premium określa dozwolony rozmiar, liczbę operacji we/wy na sekundę i przepustowość obiektu blob. Warstwa blokowego obiektu blob określa typ magazynu Gorąca/Chłodna/Archiwum. Ta operacja nie aktualizuje elementu ETag obiektu blob. Zobacz ustawianie szczegółów warstwy obiektu blob. Operacja (subrequest) zostanie uwierzytelniona i autoryzowana przy użyciu określonych poświadczeń. Zobacz szczegóły autoryzacji wsadowej obiektu blob.

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

Parametry

urls

string[]

Adresy URL zasobu obiektu blob do usunięcia.

credential

StorageSharedKeyCredential | AnonymousCredential | TokenCredential

Takie jak AnonymousCredential, StorageSharedKeyCredential lub dowolne poświadczenia z @azure/identity pakietu w celu uwierzytelnienia żądań do usługi. Można również podać obiekt implementujący interfejs TokenCredential. Jeśli nie zostanie określony, zostanie użyty parametr AnonymousCredential.

tier

AccessTier

options

BlobSetTierOptions

Zwraca

Promise<BlobBatchSubmitBatchResponse>

submitBatch(BlobBatch, BlobBatchSubmitBatchOptionalParams)

Prześlij żądanie wsadowe składające się z wielu podkwestni.

Pobierz blobBatchClient i inne szczegóły przed uruchomieniem fragmentów kodu. blobServiceClient.getBlobBatchClient() daje blobBatchClient

Przykład użycia:

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

Przykład użycia dzierżawy:

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

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

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

Parametry

batchRequest

BlobBatch

Zestaw operacji Delete lub SetTier.

options

BlobBatchSubmitBatchOptionalParams

Zwraca

Promise<BlobBatchSubmitBatchResponse>