BlockBlobClient class

Crée une instance de BlockBlobClient. Cette méthode accepte une URL encodée ou une URL non codée pointant vers un objet blob de blocs. La chaîne d’URL encodée ne sera PAS échappée deux fois, seuls les caractères spéciaux dans le chemin d’URL seront échappés. Si un nom d’objet blob inclut ? ou %, le nom de l’objet blob doit être encodé dans l’URL.

new BlockBlobClient(url: string, pipeline: PipelineLike)

Paramètres

Crée une instance de BlockBlobClient. Cette méthode accepte une URL encodée ou une URL non codée pointant vers un objet blob de blocs. La chaîne d’URL encodée ne sera PAS échappée deux fois, seuls les caractères spéciaux dans le chemin d’URL seront échappés. Si un nom d’objet blob inclut ? ou %, le nom de l’objet blob doit être encodé dans l’URL.

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

Paramètres

Crée une instance de BlockBlobClient.

new BlockBlobClient(connectionString: string, containerName: string, blobName: string, options?: StoragePipelineOptions)

Paramètres

accountName: string

Valeur de propriété

Nom du conteneur de stockage auquel l’objet blob est associé.

string containerName

Valeur de propriété

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é.

credential: StorageSharedKeyCredential | AnonymousCredential | TokenCredential

Valeur de propriété

Nom de l’objet blob.

string name

Valeur de propriété

Valeur de chaîne d’URL encodée.

url: string

Valeur de propriété

Abandonne une opération d’objet blob de copie asynchrone en attente et laisse un objet blob de destination avec une longueur nulle et des métadonnées complètes. Version 2012-02-12 et ultérieure.

function abortCopyFromURL(copyId: string, options?: BlobAbortCopyFromURLOptions)

Paramètres

Retours

Copie de façon asynchrone un objet blob vers une destination dans le compte de stockage. Cette méthode retourne un polleur d’opérations de longue durée qui vous permet d’attendre indéfiniment jusqu’à ce que la copie soit terminée. Vous pouvez également annuler une copie avant qu’elle ne soit terminée en appelant cancelOperation sur l’polleur. Notez que le rappel onProgress n’est pas appelé si l’opération se termine dans la première requête et que la tentative d’annulation d’une copie terminée entraîne la levée d’une erreur. Dans la version 2012-02-12 et ultérieure, la source d’une opération de copie d’objet blob peut être un objet blob validé dans n’importe quel compte de stockage Azure. À compter de la version 2015-02-21, la source d’une opération de copie d’objet blob peut être un fichier Azure dans n’importe quel compte de stockage Azure. Seuls les comptes de stockage créés le 7 juin 2012 autorisent l’opération Copier l’objet blob à copier à partir d’un autre compte de stockage.

function beginCopyFromURL(copySource: string, options?: BlobBeginCopyFromURLOptions)

Paramètres

Retours

Écrit un objet blob en spécifiant la liste des ID de bloc qui composent l’objet blob. Pour être écrit dans le cadre d’un objet blob, un bloc doit avoir été correctement écrit sur le serveur dans une opération de <xref:stageBlock> antérieure. Vous pouvez appeler <xref:commitBlockList> pour mettre à jour un objet blob en chargeant uniquement les blocs qui ont changé, puis en validant les blocs nouveaux et existants ensemble. Tous les blocs non spécifiés dans la liste de blocs et supprimés définitivement.

function commitBlockList(blocks: string[], options?: BlockBlobCommitBlockListOptions)

Paramètres

Retours

Données de réponse pour l’opération de liste de blocs de validation d’objet blob de blocs.

Crée un instantané en lecture seule d’un objet blob.

function createSnapshot(options?: BlobCreateSnapshotOptions)

Paramètres

Retours

Marque l’objet blob ou l’instantané spécifié pour suppression. L’objet blob est supprimé ultérieurement pendant le garbage collection. Notez que pour supprimer un objet blob, vous devez supprimer tous ses instantanés. Vous pouvez supprimer les deux en même temps avec l’opération Supprimer l’objet blob.

function delete(options?: BlobDeleteOptions)

Paramètres

Retours

Marque l’objet blob ou l’instantané spécifié pour suppression s’il existe. L’objet blob est supprimé ultérieurement pendant le garbage collection. Notez que pour supprimer un objet blob, vous devez supprimer tous ses instantanés. Vous pouvez supprimer les deux en même temps avec l’opération Supprimer l’objet blob.

function deleteIfExists(options?: BlobDeleteOptions)

Paramètres

Retours

Supprimez la stratégie immutablility sur l’objet blob.

function deleteImmutabilityPolicy(options?: BlobDeleteImmutabilityPolicyOptions)

Paramètres

Retours

Lit ou télécharge un objet blob à partir du système, y compris ses métadonnées et ses propriétés. Vous pouvez également appeler Get Blob pour lire un instantané.

• Dans Node.js, les données retournent dans un flux lisibleStreamBody
• Dans les navigateurs, les données retournent dans un blobBody de promesse

function download(offset?: number, count?: number, options?: BlobDownloadOptions)

Paramètres

// Download and convert a blob to a string
const downloadBlockBlobResponse = await blobClient.download();
const downloaded = await streamToBuffer(downloadBlockBlobResponse.readableStreamBody);
console.log("Downloaded blob content:", downloaded.toString());

async function streamToBuffer(readableStream) {
return new Promise((resolve, reject) => {
const chunks = [];
readableStream.on("data", (data) => {
chunks.push(data instanceof Buffer ? data : Buffer.from(data));
});
readableStream.on("end", () => {
resolve(Buffer.concat(chunks));
});
readableStream.on("error", reject);
});
}

// Download and convert a blob to a string
const downloadBlockBlobResponse = await blobClient.download();
const downloaded = await blobToString(await downloadBlockBlobResponse.blobBody);
console.log(
  "Downloaded blob content",
  downloaded
);

async function blobToString(blob: Blob): Promise<string> {
  const fileReader = new FileReader();
  return new Promise<string>((resolve, reject) => {
    fileReader.onloadend = (ev: any) => {
      resolve(ev.target!.result);
    };
    fileReader.onerror = reject;
    fileReader.readAsText(blob);
  });
}

Retours

DISPONIBLE UNIQUEMENT DANS NODE.JS RUNTIME. Télécharge un objet blob Azure en parallèle vers une mémoire tampon. Le décalage et le nombre sont facultatifs, télécharge l’ensemble de l’objet blob s’ils ne sont pas fournis.

Avertissement : les mémoires tampons peuvent uniquement prendre en charge les fichiers pouvant atteindre environ un gigaoctet sur des systèmes 32 bits ou environ deux gigaoctets sur des systèmes 64 bits en raison des limitations de Node.js/V8. Pour les objets blob supérieurs à cette taille, envisagez <xref:downloadToFile>.

function downloadToBuffer(buffer: Buffer, offset?: number, count?: number, options?: BlobDownloadToBufferOptions)

Paramètres

Retours

DISPONIBLE UNIQUEMENT DANS NODE.JS RUNTIME. Télécharge un objet blob Azure en parallèle vers une mémoire tampon. Le décalage et le nombre sont facultatifs, télécharge l’ensemble de l’objet blob s’ils ne sont pas fournis.

Avertissement : les mémoires tampons peuvent uniquement prendre en charge les fichiers pouvant atteindre environ un gigaoctet sur des systèmes 32 bits ou environ deux gigaoctets sur des systèmes 64 bits en raison des limitations de Node.js/V8. Pour les objets blob supérieurs à cette taille, envisagez <xref:downloadToFile>.

function downloadToBuffer(offset?: number, count?: number, options?: BlobDownloadToBufferOptions)

Paramètres

Retours

DISPONIBLE UNIQUEMENT DANS NODE.JS RUNTIME. Télécharge un objet blob Azure dans un fichier local. Échoue si le chemin d’accès du fichier donné se ferme déjà. Le décalage et le nombre sont facultatifs, passent respectivement 0 et non définis pour télécharger l’intégralité de l’objet blob.

function downloadToFile(filePath: string, offset?: number, count?: number, options?: BlobDownloadOptions)

Paramètres

Retours

Données de réponse pour l’opération de téléchargement d’objets blob, mais avec readableStreamBody défini sur non défini, car son contenu est déjà lu et écrit dans un fichier local au chemin spécifié.

Retourne true si la ressource d’objet blob Azure représentée par ce client existe ; false sinon. REMARQUE : utilisez cette fonction avec soin, car un objet blob existant peut être supprimé par d’autres clients ou applications. Inversement, de nouveaux objets blob peuvent être ajoutés par d’autres clients ou applications une fois cette fonction terminée.

function exists(options?: BlobExistsOptions)

Paramètres

Retours

Disponible uniquement pour BlobClient construit avec des informations d’identification de clé partagée. Génère un URI SAP (Blob Service Shared Access Signature) basé sur les propriétés et paramètres du client transmis. La SAP est signée par les informations d’identification de clé partagée du client.

function generateSasUrl(options: BlobGenerateSasUrlOptions)

Paramètres

Retours

URI SAP constitué de l’URI de la ressource représentée par ce client, suivi du jeton SAP généré.

Crée un objet AppendBlobClient.

function getAppendBlobClient()

Retours

Obtenez un <xref:BlobLeaseClient> qui gère les baux sur l’objet blob.

function getBlobLeaseClient(proposeLeaseId?: string)

Paramètres

Retours

Nouvel objet BlobLeaseClient pour la gestion des baux sur l’objet blob.

Crée un objet BlockBlobClient.

function getBlockBlobClient()

Retours

Retourne la liste des blocs qui ont été chargés dans le cadre d’un objet blob de blocs à l’aide du filtre de liste de blocs spécifié.

function getBlockList(listType: BlockListType, options?: BlockBlobGetBlockListOptions)

Paramètres

Retours

Données de réponse pour l’opération De liste de blocs Get Block Blob.

Crée un objet PageBlobClient.

function getPageBlobClient()

Retours

Retourne toutes les métadonnées définies par l’utilisateur, les propriétés HTTP standard et les propriétés système de l’objet blob. Il ne retourne pas le contenu de l’objet blob.

function getProperties(options?: BlobGetPropertiesOptions)

Paramètres

Retours

Obtient les balises associées à l’objet blob sous-jacent.

function getTags(options?: BlobGetTagsOptions)

Paramètres

Retours

DISPONIBLE UNIQUEMENT DANS NODE.JS RUNTIME. Requête rapide pour un objet blob au format JSON ou CSV.

Exemple d’utilisation (Node.js) :

// Query and convert a blob to a string
const queryBlockBlobResponse = await blockBlobClient.query("select * from BlobStorage");
const downloaded = (await streamToBuffer(queryBlockBlobResponse.readableStreamBody)).toString();
console.log("Query blob content:", downloaded);

async function streamToBuffer(readableStream) {
  return new Promise((resolve, reject) => {
    const chunks = [];
    readableStream.on("data", (data) => {
      chunks.push(data instanceof Buffer ? data : Buffer.from(data));
    });
    readableStream.on("end", () => {
      resolve(Buffer.concat(chunks));
    });
    readableStream.on("error", reject);
  });
}

function query(query: string, options?: BlockBlobQueryOptions)

Paramètres

Retours

Définit 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.

function setAccessTier(tier: BlockBlobTier | PremiumPageBlobTier | string, options?: BlobSetTierOptions)

Paramètres

Retours

Définit les propriétés système sur l’objet blob. Si aucune valeur n’est fournie ou aucune valeur fournie pour les en-têtes HTTP d’objet blob spécifiés, ces en-têtes HTTP d’objet blob sans valeur seront effacés.

function setHTTPHeaders(blobHTTPHeaders?: BlobHTTPHeaders, options?: BlobSetHTTPHeadersOptions)

Paramètres

Retours

Définissez la stratégie immutablility sur l’objet blob.

function setImmutabilityPolicy(immutabilityPolicy: BlobImmutabilityPolicy, options?: BlobSetImmutabilityPolicyOptions)

Paramètres

Retours

Définissez la conservation légale sur l’objet blob.

function setLegalHold(legalHoldEnabled: boolean, options?: BlobSetLegalHoldOptions)

Paramètres

Retours

Définit les métadonnées définies par l’utilisateur pour l’objet blob spécifié sous la forme d’une ou plusieurs paires nom-valeur. Si aucune option n’est fournie ou aucune métadonnées définie dans le paramètre, les métadonnées d’objet blob sont supprimées.

function setMetadata(metadata?: Metadata, options?: BlobSetMetadataOptions)

Paramètres

Retours

Définit des balises sur l’objet blob sous-jacent. Un objet blob peut avoir jusqu’à 10 balises. Les clés de balise doivent être comprises entre 1 et 128 caractères. Les valeurs de balise doivent être comprises entre 0 et 256 caractères. Les caractères de clé et de valeur de balise valides incluent des lettres minuscules et majuscules, des chiffres (0-9), un espace ('), plus ('+'), moins ('-'), un point ('.'), une barre oblique ('/'), un signe deux-points (' :'), égal ('=') et un trait de soulignement ('_') .

function setTags(tags: Tags, options?: BlobSetTagsOptions)

Paramètres

Retours

Charge le bloc spécifié dans la « zone intermédiaire » de l’objet blob de blocs pour être validé ultérieurement par un appel à commitBlockList.

function stageBlock(blockId: string, body: HttpRequestBody, contentLength: number, options?: BlockBlobStageBlockOptions)

Paramètres

Retours

Données de réponse pour l’opération de bloc d’étape d’objet blob de blocs.

L’opération Stage Block From URL crée un bloc à commiter dans le cadre d’un objet blob où le contenu est lu à partir d’une URL. Cette API est disponible à partir de la version 2018-03-28.

function stageBlockFromURL(blockId: string, sourceURL: string, offset?: number, count?: number, options?: BlockBlobStageBlockFromURLOptions)

Paramètres

Retours

Données de réponse pour l’opération d’URL du bloc d’étape d’objet blob de blocs.

L’opération de copie à partir d’URL synchrone copie un objet blob ou une ressource Internet vers un nouvel objet blob. Elle ne retourne pas de réponse tant que la copie n’est pas terminée.

function syncCopyFromURL(copySource: string, options?: BlobSyncCopyFromURLOptions)

Paramètres

Retours

Crée un objet blob de blocs dans lequel le contenu de l’objet blob est lu à partir d’une URL donnée. Cette API est prise en charge à compter de la version 2020-04-08. Les mises à jour partielles ne sont pas prises en charge avec Put Blob à partir de l’URL ; le contenu d’un objet blob existant est remplacé par le contenu du nouvel objet blob. Pour effectuer des mises à jour partielles du contenu d’un objet blob de blocs à l’aide d’une URL source, utilisez <xref:stageBlockFromURL> et <xref:commitBlockList>.

function syncUploadFromURL(sourceURL: string, options?: BlockBlobSyncUploadFromURLOptions)

Paramètres

Retours

Restaure le contenu et les métadonnées de l’objet blob supprimé de manière réversible et tous les instantanés supprimés de manière réversible associés. Undelete Blob est pris en charge uniquement sur la version 2017-07-29 ou ultérieure.

function undelete(options?: BlobUndeleteOptions)

Paramètres

Retours

Crée un objet blob de blocs ou met à jour le contenu d’un objet blob de blocs existant. La mise à jour d’un objet blob de blocs existant remplace toutes les métadonnées existantes sur l’objet blob. Les mises à jour partielles ne sont pas prises en charge ; le contenu de l’objet blob existant est remplacé par le nouveau contenu. Pour effectuer une mise à jour partielle des objets blob de blocs, utilisez <xref:stageBlock> et <xref:commitBlockList>. Il s’agit d’une méthode de chargement non parallèle, utilisez <xref:uploadFile>, <xref:uploadStream> ou <xref:uploadBrowserData> pour de meilleures performances avec le chargement concurrentiel.

function upload(body: HttpRequestBody, contentLength: number, options?: BlockBlobUploadOptions)

Paramètres

Retours

Données de réponse pour l’opération de chargement d’objets blob de blocs.

Exemple d’utilisation :

const content = "Hello world!";
const uploadBlobResponse = await blockBlobClient.upload(content, content.length);

DISPONIBLE UNIQUEMENT DANS LES NAVIGATEURS. Charge un objet Blob de navigateur/File/ArrayBuffer/ArrayBufferView dans un objet blob de blocs.

Lorsque la longueur de la mémoire tampon est inférieure ou égale à 256 Mo, cette méthode utilise 1 appel de chargement pour terminer le chargement. Sinon, cette méthode appelle <xref:stageBlock> pour charger des blocs, puis appelle <xref:commitBlockList> pour valider la liste de blocs.

Une option <xref:BlockBlobParallelUploadOptions.blobHTTPHeaders> courante à définir est blobContentType, ce qui permet au navigateur de fournir des fonctionnalités basées sur le type de fichier.

function uploadBrowserData(browserData: Blob | ArrayBuffer | ArrayBufferView, options?: BlockBlobParallelUploadOptions)

Paramètres

Retours

Données de réponse pour l’opération de chargement d’objets blob.

Charge un tampon(Node.js)/Blob(navigateurs)/ArrayBuffer/ArrayBufferView dans un BlockBlob. Lorsque la longueur des données n’est pas supérieure à la <xref:BlockBlobParallelUploadOptions.maxSingleShotSize> spécifiée (la valeur par défaut est <xref:BLOCK_BLOB_MAX_UPLOAD_BLOB_BYTES>), cette méthode utilise 1 <xref:upload> appel pour terminer le chargement. Sinon, cette méthode appelle <xref:stageBlock> pour charger des blocs, puis appelle <xref:commitBlockList> pour valider la liste de blocs.

Une option <xref:BlockBlobParallelUploadOptions.blobHTTPHeaders> courante à définir est blobContentType, ce qui permet au navigateur de fournir des fonctionnalités basées sur le type de fichier.

function uploadData(data: Buffer | Blob | ArrayBuffer | ArrayBufferView, options?: BlockBlobParallelUploadOptions)

Paramètres

Retours

DISPONIBLE UNIQUEMENT DANS NODE.JS RUNTIME. Charge un fichier local dans des blocs dans un objet blob de blocs.

Lorsque la taille du fichier est inférieure ou égale à 256 Mo, cette méthode utilise 1 appel de chargement pour terminer le chargement. Sinon, cette méthode appelle stageBlock pour charger des blocs, puis appelle commitBlockList pour valider la liste de blocs.

function uploadFile(filePath: string, options?: BlockBlobParallelUploadOptions)

Paramètres

Retours

Données de réponse pour l’opération de chargement d’objets blob.

DISPONIBLE UNIQUEMENT DANS NODE.JS RUNTIME. Charge un flux Node.js lisible dans un objet blob de blocs.

CONSEILS D’AMÉLIORATION DES PERFORMANCES :

• Le flux d’entrée highWaterMark est préférable à définir une même valeur avec le paramètre bufferSize, ce qui évite les opérations Buffer.concat().

function uploadStream(stream: Readable, bufferSize?: number, maxConcurrency?: number, options?: BlockBlobUploadStreamOptions)

Paramètres

Retours

Données de réponse pour l’opération de chargement d’objets blob.

Crée un objet BlockBlobClient identique à la source, mais avec l’horodatage d’instantané spécifié. Indiquez « » supprime l’instantané et retourne une URL vers l’objet blob de base.

function withSnapshot(snapshot: string)

Paramètres

Retours

Nouvel objet BlockBlobClient identique à la source, mais avec l’horodatage d’instantané spécifié.

Crée un objet BlobClient pointant vers une version de cet objet blob. Indiquez « » supprime l’ID de version et retourne un client dans l’objet blob de base.

function withVersion(versionId: string)

Paramètres

Retours

Nouvel objet BlobClient pointant vers la version de cet objet blob.