Compartir a través de

BlobBatchClient class

  • Referencia
Paquete:
@azure/storage-blob

BlobBatchClient permite realizar solicitudes por lotes al servicio Blob de Azure Storage.

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

Constructores

BlobBatchClient(string, PipelineLike)

Crea una instancia de BlobBatchClient.
BlobBatchClient(string, StorageSharedKeyCredential | AnonymousCredential | TokenCredential, StoragePipelineOptions)

Crea una instancia de BlobBatchClient.

Métodos

createBatch()

Crea un BlobBatch. Un BlobBatch representa un conjunto agregado de operaciones en blobs.
deleteBlobs(BlobClient[], BlobDeleteOptions)

Cree varias operaciones de eliminación para marcar los blobs o instantáneas especificados para su eliminación. Tenga en cuenta que para eliminar un blob, debe eliminar todas sus instantáneas. Puede eliminar ambos al mismo tiempo. Consulte los detalles de la operación de eliminación. La operación (subrequest) se autenticará y autorizará con la credencial especificada. Consulte los detalles de autorización por lotes de blobs.
deleteBlobs(string[], StorageSharedKeyCredential | AnonymousCredential | TokenCredential, BlobDeleteOptions)

Cree varias operaciones de eliminación para marcar los blobs o instantáneas especificados para su eliminación. Tenga en cuenta que para eliminar un blob, debe eliminar todas sus instantáneas. Puede eliminar ambos al mismo tiempo. Consulte los detalles de la operación de eliminación. Las operaciones se autenticarán y autorizarán con la credencial especificada. Consulte los detalles de autorización por lotes de blobs.
setBlobsAccessTier(BlobClient[], AccessTier, BlobSetTierOptions)

Cree varias operaciones de nivel de conjunto para establecer el nivel en un blob. La operación se permite en un blob en páginas de una cuenta de Premium Storage y en un blob en bloques en una cuenta de almacenamiento de blobs (solo almacenamiento con redundancia local). El nivel de un blob en páginas Premium determina el tamaño permitido, las IOPS y el ancho de banda del blob. El nivel de un blob en bloques determina el tipo de almacenamiento de acceso frecuente, esporádico o de archivo. Esta operación no actualiza la etiqueta ETag del blob. Consulte establecimiento de los detalles del nivel de blob. La operación (subrequest) se autenticará y se autorizará con la credencial especificada. Consulte los detalles de autorización por lotes de blobs.
setBlobsAccessTier(string[], StorageSharedKeyCredential | AnonymousCredential | TokenCredential, AccessTier, BlobSetTierOptions)

Cree varias operaciones de nivel de conjunto para establecer el nivel en un blob. La operación se permite en un blob en páginas de una cuenta de Premium Storage y en un blob en bloques en una cuenta de almacenamiento de blobs (solo almacenamiento con redundancia local). El nivel de un blob en páginas Premium determina el tamaño permitido, las IOPS y el ancho de banda del blob. El nivel de un blob en bloques determina el tipo de almacenamiento de acceso frecuente, esporádico o de archivo. Esta operación no actualiza la etiqueta ETag del blob. Consulte establecimiento de los detalles del nivel de blob. La operación (subrequest) se autenticará y se autorizará con la credencial especificada. Consulte los detalles de autorización por lotes de blobs.
submitBatch(BlobBatch, BlobBatchSubmitBatchOptionalParams)

Enviar solicitud por lotes que consta de varios subrequests.

Obtenga blobBatchClient y otros detalles antes de ejecutar los fragmentos de código. blobServiceClient.getBlobBatchClient() proporciona el blobBatchClient

Ejemplo de uso:

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

Ejemplo de uso de una concesió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);

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

Detalles del constructor

BlobBatchClient(string, PipelineLike)

Crea una instancia de BlobBatchClient.

new BlobBatchClient(url: string, pipeline: PipelineLike)

Parámetros

url

string

Dirección URL que apunta a Azure Storage Blob Service, como "https://myaccount.blob.core.windows.net". Puede anexar una SAS si usa AnonymousCredential, como "https://myaccount.blob.core.windows.net?sasString".

pipeline
PipelineLike

Llame a newPipeline() para crear una canalización predeterminada o proporcione una canalización personalizada.

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

Crea una instancia de BlobBatchClient.

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

Parámetros

url

string

Dirección URL que apunta a Azure Storage Blob Service, como "https://myaccount.blob.core.windows.net". Puede anexar una SAS si usa AnonymousCredential, como "https://myaccount.blob.core.windows.net?sasString".

credential

StorageSharedKeyCredential | AnonymousCredential | TokenCredential

Por ejemplo, AnonymousCredential, StorageSharedKeyCredential o cualquier credencial del @azure/identity paquete para autenticar las solicitudes en el servicio. También puede proporcionar un objeto que implemente la interfaz TokenCredential. Si no se especifica, se usa AnonymousCredential.

options
StoragePipelineOptions

Opciones para configurar la canalización HTTP.

Detalles del método

createBatch()

Crea un BlobBatch. Un BlobBatch representa un conjunto agregado de operaciones en blobs.

function createBatch(): BlobBatch

Devoluciones

BlobBatch

deleteBlobs(BlobClient[], BlobDeleteOptions)

Cree varias operaciones de eliminación para marcar los blobs o instantáneas especificados para su eliminación. Tenga en cuenta que para eliminar un blob, debe eliminar todas sus instantáneas. Puede eliminar ambos al mismo tiempo. Consulte los detalles de la operación de eliminación. La operación (subrequest) se autenticará y autorizará con la credencial especificada. Consulte los detalles de autorización por lotes de blobs.

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

Parámetros

blobClients

BlobClient[]

BlobClients para los blobs que se van a eliminar.

options
BlobDeleteOptions

Devoluciones

Promise<BlobBatchSubmitBatchResponse>

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

Cree varias operaciones de eliminación para marcar los blobs o instantáneas especificados para su eliminación. Tenga en cuenta que para eliminar un blob, debe eliminar todas sus instantáneas. Puede eliminar ambos al mismo tiempo. Consulte los detalles de la operación de eliminación. Las operaciones se autenticarán y autorizarán con la credencial especificada. Consulte los detalles de autorización por lotes de blobs.

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

Parámetros

urls

string[]

Las direcciones URL de los recursos de blob que se van a eliminar.

credential

StorageSharedKeyCredential | AnonymousCredential | TokenCredential

Por ejemplo, AnonymousCredential, StorageSharedKeyCredential o cualquier credencial del @azure/identity paquete para autenticar las solicitudes en el servicio. También puede proporcionar un objeto que implemente la interfaz TokenCredential. Si no se especifica, se usa AnonymousCredential.

options
BlobDeleteOptions

Devoluciones

Promise<BlobBatchSubmitBatchResponse>

setBlobsAccessTier(BlobClient[], AccessTier, BlobSetTierOptions)

Cree varias operaciones de nivel de conjunto para establecer el nivel en un blob. La operación se permite en un blob en páginas de una cuenta de Premium Storage y en un blob en bloques en una cuenta de almacenamiento de blobs (solo almacenamiento con redundancia local). El nivel de un blob en páginas Premium determina el tamaño permitido, las IOPS y el ancho de banda del blob. El nivel de un blob en bloques determina el tipo de almacenamiento de acceso frecuente, esporádico o de archivo. Esta operación no actualiza la etiqueta ETag del blob. Consulte establecimiento de los detalles del nivel de blob. La operación (subrequest) se autenticará y se autorizará con la credencial especificada. Consulte los detalles de autorización por lotes de blobs.

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

Parámetros

blobClients

BlobClient[]

BlobClients para los blobs que deben tener un nuevo nivel establecido.

tier
AccessTier
options
BlobSetTierOptions

Devoluciones

Promise<BlobBatchSubmitBatchResponse>

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

Cree varias operaciones de nivel de conjunto para establecer el nivel en un blob. La operación se permite en un blob en páginas de una cuenta de Premium Storage y en un blob en bloques en una cuenta de almacenamiento de blobs (solo almacenamiento con redundancia local). El nivel de un blob en páginas Premium determina el tamaño permitido, las IOPS y el ancho de banda del blob. El nivel de un blob en bloques determina el tipo de almacenamiento de acceso frecuente, esporádico o de archivo. Esta operación no actualiza la etiqueta ETag del blob. Consulte establecimiento de los detalles del nivel de blob. La operación (subrequest) se autenticará y se autorizará con la credencial especificada. Consulte los detalles de autorización por lotes de blobs.

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

Parámetros

urls

string[]

Direcciones URL del recurso de blob que se va a eliminar.

credential

StorageSharedKeyCredential | AnonymousCredential | TokenCredential

Por ejemplo, AnonymousCredential, StorageSharedKeyCredential o cualquier credencial del @azure/identity paquete para autenticar las solicitudes en el servicio. También puede proporcionar un objeto que implemente la interfaz TokenCredential. Si no se especifica, se usa AnonymousCredential.

tier
AccessTier
options
BlobSetTierOptions

Devoluciones

Promise<BlobBatchSubmitBatchResponse>

submitBatch(BlobBatch, BlobBatchSubmitBatchOptionalParams)

Enviar solicitud por lotes que consta de varios subrequests.

Obtenga blobBatchClient y otros detalles antes de ejecutar los fragmentos de código. blobServiceClient.getBlobBatchClient() proporciona el blobBatchClient

Ejemplo de uso:

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

Ejemplo de uso de una concesió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);

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

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

Parámetros

batchRequest
BlobBatch

Un conjunto de operaciones Delete o SetTier.

options
BlobBatchSubmitBatchOptionalParams

Devoluciones

Promise<BlobBatchSubmitBatchResponse>