Partager via

BlobBatchClient class

  • Référence
Paquet:
@azure/storage-blob

Un BlobBatchClient vous permet d’effectuer des requêtes par lots au service Blob Stockage Azure.

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

Constructeurs

BlobBatchClient(string, PipelineLike)

Crée une instance de BlobBatchClient.
BlobBatchClient(string, StorageSharedKeyCredential | AnonymousCredential | TokenCredential, StoragePipelineOptions)

Crée une instance de BlobBatchClient.

Méthodes

createBatch()

Crée un BlobBatch. Un BlobBatch représente un ensemble agrégé d’opérations sur les objets blob.
deleteBlobs(BlobClient[], BlobDeleteOptions)

Créez plusieurs opérations de suppression pour marquer les objets blob ou instantanés spécifiés pour suppression. Notez que pour supprimer un objet blob, vous devez supprimer tous ses instantanés. Vous pouvez supprimer les deux en même temps. Consultez détails de l’opération de suppression. L’opération(sous-demande) est authentifiée et autorisée avec les informations d’identification spécifiées. Consultez détails de l’autorisation par lot d’objets blob.
deleteBlobs(string[], StorageSharedKeyCredential | AnonymousCredential | TokenCredential, BlobDeleteOptions)

Créez plusieurs opérations de suppression pour marquer les objets blob ou instantanés spécifiés pour suppression. Notez que pour supprimer un objet blob, vous devez supprimer tous ses instantanés. Vous pouvez supprimer les deux en même temps. Consultez détails de l’opération de suppression. Les opérations seront authentifiées et autorisées avec les informations d’identification spécifiées. Consultez détails de l’autorisation par lot d’objets blob.
setBlobsAccessTier(BlobClient[], AccessTier, BlobSetTierOptions)

Créez plusieurs opérations de niveau défini pour définir le niveau sur un objet blob. L’opération est autorisée sur un objet blob de pages dans un compte de stockage Premium et sur un objet blob de blocs dans un compte de stockage d’objets blob (stockage localement redondant uniquement). Le niveau d’un objet blob de pages Premium détermine la taille, les IOPS et la bande passante autorisées de l’objet blob. Le niveau d’un objet blob de blocs détermine le type de stockage Chaud/Froid/Archive. Cette opération ne met pas à jour l’ETag de l’objet blob. Consultez définir les détails du niveau d’objet blob. L’opération(sous-demande) est authentifiée et autorisée avec les informations d’identification spécifiées. Consultez détails de l’autorisation par lot d’objets blob.
setBlobsAccessTier(string[], StorageSharedKeyCredential | AnonymousCredential | TokenCredential, AccessTier, BlobSetTierOptions)

Créez plusieurs opérations de niveau défini pour définir le niveau sur un objet blob. L’opération est autorisée sur un objet blob de pages dans un compte de stockage Premium et sur un objet blob de blocs dans un compte de stockage d’objets blob (stockage localement redondant uniquement). Le niveau d’un objet blob de pages Premium détermine la taille, les IOPS et la bande passante autorisées de l’objet blob. Le niveau d’un objet blob de blocs détermine le type de stockage Chaud/Froid/Archive. Cette opération ne met pas à jour l’ETag de l’objet blob. Consultez définir les détails du niveau d’objet blob. L’opération(sous-demande) est authentifiée et autorisée avec les informations d’identification spécifiées. Consultez détails de l’autorisation par lot d’objets blob.
submitBatch(BlobBatch, BlobBatchSubmitBatchOptionalParams)

Envoyez une demande de traitement par lots qui se compose de plusieurs sous-requêtes.

Obtenez blobBatchClient et d’autres détails avant d’exécuter les extraits de code. blobServiceClient.getBlobBatchClient() donne le blobBatchClient

Exemple d’utilisation :

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

Exemple utilisant un bail :

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

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

Détails du constructeur

BlobBatchClient(string, PipelineLike)

Crée une instance de BlobBatchClient.

new BlobBatchClient(url: string, pipeline: PipelineLike)

Paramètres

url

string

URL pointant vers le service d’objets blob Stockage Azure, par exemple «https://myaccount.blob.core.windows.net". Vous pouvez ajouter une SAP si vous utilisez AnonymousCredential, par exemple «https://myaccount.blob.core.windows.net?sasString".

pipeline
PipelineLike

Appelez newPipeline() pour créer un pipeline par défaut ou fournissez un pipeline personnalisé.

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

Crée une instance de BlobBatchClient.

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

Paramètres

url

string

URL pointant vers le service d’objets blob Stockage Azure, par exemple «https://myaccount.blob.core.windows.net". Vous pouvez ajouter une SAP si vous utilisez AnonymousCredential, par exemple «https://myaccount.blob.core.windows.net?sasString".

credential

StorageSharedKeyCredential | AnonymousCredential | TokenCredential

Tels que AnonymousCredential, StorageSharedKeyCredential ou toutes les informations d’identification du package @azure/identity pour authentifier les demandes auprès du service. Vous pouvez également fournir un objet qui implémente l’interface TokenCredential. Si ce n’est pas spécifié, AnonymousCredential est utilisé.

options
StoragePipelineOptions

Options de configuration du pipeline HTTP.

Détails de la méthode

createBatch()

Crée un BlobBatch. Un BlobBatch représente un ensemble agrégé d’opérations sur les objets blob.

function createBatch(): BlobBatch

Retours

BlobBatch

deleteBlobs(BlobClient[], BlobDeleteOptions)

Créez plusieurs opérations de suppression pour marquer les objets blob ou instantanés spécifiés pour suppression. Notez que pour supprimer un objet blob, vous devez supprimer tous ses instantanés. Vous pouvez supprimer les deux en même temps. Consultez détails de l’opération de suppression. L’opération(sous-demande) est authentifiée et autorisée avec les informations d’identification spécifiées. Consultez détails de l’autorisation par lot d’objets blob.

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

Paramètres

blobClients

BlobClient[]

BlobClients pour les objets blob à supprimer.

options
BlobDeleteOptions

Retours

Promise<BlobBatchSubmitBatchResponse>

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

Créez plusieurs opérations de suppression pour marquer les objets blob ou instantanés spécifiés pour suppression. Notez que pour supprimer un objet blob, vous devez supprimer tous ses instantanés. Vous pouvez supprimer les deux en même temps. Consultez détails de l’opération de suppression. Les opérations seront authentifiées et autorisées avec les informations d’identification spécifiées. Consultez détails de l’autorisation par lot d’objets blob.

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

Paramètres

urls

string[]

URL des ressources d’objet blob à supprimer.

credential

StorageSharedKeyCredential | AnonymousCredential | TokenCredential

Tels que AnonymousCredential, StorageSharedKeyCredential ou toutes les informations d’identification du package @azure/identity pour authentifier les demandes auprès du service. Vous pouvez également fournir un objet qui implémente l’interface TokenCredential. Si ce n’est pas spécifié, AnonymousCredential est utilisé.

options
BlobDeleteOptions

Retours

Promise<BlobBatchSubmitBatchResponse>

setBlobsAccessTier(BlobClient[], AccessTier, BlobSetTierOptions)

Créez plusieurs opérations de niveau défini pour définir le niveau sur un objet blob. L’opération est autorisée sur un objet blob de pages dans un compte de stockage Premium et sur un objet blob de blocs dans un compte de stockage d’objets blob (stockage localement redondant uniquement). Le niveau d’un objet blob de pages Premium détermine la taille, les IOPS et la bande passante autorisées de l’objet blob. Le niveau d’un objet blob de blocs détermine le type de stockage Chaud/Froid/Archive. Cette opération ne met pas à jour l’ETag de l’objet blob. Consultez définir les détails du niveau d’objet blob. L’opération(sous-demande) est authentifiée et autorisée avec les informations d’identification spécifiées. Consultez détails de l’autorisation par lot d’objets blob.

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

Paramètres

blobClients

BlobClient[]

BlobClients pour les objets blob qui doivent avoir un nouveau niveau défini.

tier
AccessTier
options
BlobSetTierOptions

Retours

Promise<BlobBatchSubmitBatchResponse>

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

Créez plusieurs opérations de niveau défini pour définir le niveau sur un objet blob. L’opération est autorisée sur un objet blob de pages dans un compte de stockage Premium et sur un objet blob de blocs dans un compte de stockage d’objets blob (stockage localement redondant uniquement). Le niveau d’un objet blob de pages Premium détermine la taille, les IOPS et la bande passante autorisées de l’objet blob. Le niveau d’un objet blob de blocs détermine le type de stockage Chaud/Froid/Archive. Cette opération ne met pas à jour l’ETag de l’objet blob. Consultez définir les détails du niveau d’objet blob. L’opération(sous-demande) est authentifiée et autorisée avec les informations d’identification spécifiées. Consultez détails de l’autorisation par lot d’objets blob.

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

Paramètres

urls

string[]

URL de la ressource d’objet blob à supprimer.

credential

StorageSharedKeyCredential | AnonymousCredential | TokenCredential

Tels que AnonymousCredential, StorageSharedKeyCredential ou toutes les informations d’identification du package @azure/identity pour authentifier les demandes auprès du service. Vous pouvez également fournir un objet qui implémente l’interface TokenCredential. Si ce n’est pas spécifié, AnonymousCredential est utilisé.

tier
AccessTier
options
BlobSetTierOptions

Retours

Promise<BlobBatchSubmitBatchResponse>

submitBatch(BlobBatch, BlobBatchSubmitBatchOptionalParams)

Envoyez une demande de traitement par lots qui se compose de plusieurs sous-requêtes.

Obtenez blobBatchClient et d’autres détails avant d’exécuter les extraits de code. blobServiceClient.getBlobBatchClient() donne le blobBatchClient

Exemple d’utilisation :

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

Exemple utilisant un bail :

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

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

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

Paramètres

batchRequest
BlobBatch

Ensemble d’opérations Delete ou SetTier.

options
BlobBatchSubmitBatchOptionalParams

Retours

Promise<BlobBatchSubmitBatchResponse>