BlobClient class

Référence

Paquet:: @azure/storage-blob

Un BlobClient représente une URL vers un objet blob stockage Azure ; l’objet blob peut être un objet blob de bloc, un objet blob d’ajout ou un objet blob de page.

Extends: StorageClient

Constructeurs

BlobClient(string, PipelineLike)	Crée une instance de BlobClient. Cette méthode accepte une URL encodée ou une URL non codée pointant vers un objet blob. La chaîne d’URL encodée ne sera PAS échappée deux fois. Seuls les caractères spéciaux du chemin d’URL seront placés dans une séquence d’échappement. Si un nom d’objet blob inclut ? ou %, le nom de l’objet blob doit être encodé dans l’URL.
BlobClient(string, StorageSharedKeyCredential \| AnonymousCredential \| TokenCredential, StoragePipelineOptions)	Crée une instance de BlobClient. Cette méthode accepte une URL encodée ou une URL non codée pointant vers un objet blob. La chaîne d’URL encodée ne sera PAS échappée deux fois. Seuls les caractères spéciaux du chemin d’URL seront placés dans une séquence d’échappement. Si un nom d’objet blob inclut ? ou %, le nom de l’objet blob doit être encodé dans l’URL.
BlobClient(string, string, string, StoragePipelineOptions)	Crée une instance de BlobClient à partir d’une chaîne de connexion.

Propriétés

containerName	Nom du conteneur de stockage à lequel l’objet blob est associé.
name	Nom de l'objet blob.

Propriétés héritées

accountName
credential	Par exemple, AnonymousCredential, StorageSharedKeyCredential ou toutes les informations d’identification du `@azure/identity` package pour authentifier les demandes adressées au service. Vous pouvez également fournir un objet qui implémente l’interface TokenCredential. S’il n’est pas spécifié, AnonymousCredential est utilisé.
url	Valeur de chaîne d’URL encodée.

Méthodes

abortCopyFromURL(string, BlobAbortCopyFromURLOptions)	Annule une opération de copie asynchrone d’objet blob en attente et laisse un objet blob de destination avec des métadonnées de longueur nulle et complète. Version du 12.02.12 et ultérieure. Voir https://docs.microsoft.com/en-us/rest/api/storageservices/abort-copy-blob
beginCopyFromURL(string, BlobBeginCopyFromURLOptions)	Copie de manière asynchrone un objet blob vers une destination dans le compte de stockage. Cette méthode retourne un polleur d’opération 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 les versions 2012-02-12 et ultérieures, 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 à partir du 7 juin 2012 autorisent l'opération de copie d'objets blob à partir d'un autre compte de stockage. Voir https://docs.microsoft.com/en-us/rest/api/storageservices/copy-blob Exemple utilisant l’interrogation automatique : `const copyPoller = await blobClient.beginCopyFromURL('url'); const result = await copyPoller.pollUntilDone();` Exemple d’interrogation manuelle : `const copyPoller = await blobClient.beginCopyFromURL('url'); while (!poller.isDone()) { await poller.poll(); } const result = copyPoller.getResult();` Exemple utilisant les mises à jour de progression : const copyPoller = await blobClient.beginCopyFromURL('url', { onProgress(state) { console.log(`Progress: ${state.copyProgress}`); } }); const result = await copyPoller.pollUntilDone(); Exemple utilisant un intervalle d’interrogation changeant (15 secondes par défaut) : `const copyPoller = await blobClient.beginCopyFromURL('url', { intervalInMs: 1000 // poll blob every 1 second for copy progress }); const result = await copyPoller.pollUntilDone();` Exemple d’annulation de copie : `const copyPoller = await blobClient.beginCopyFromURL('url'); // cancel operation after starting it. try { await copyPoller.cancelOperation(); // calls to get the result now throw PollerCancelledError await copyPoller.getResult(); } catch (err) { if (err.name === 'PollerCancelledError') { console.log('The copy was cancelled.'); } }`
createSnapshot(BlobCreateSnapshotOptions)	Crée un instantané en lecture seule d'un objet blob. Voir https://docs.microsoft.com/en-us/rest/api/storageservices/snapshot-blob
delete(BlobDeleteOptions)	Marque l’objet blob ou l’instantané spécifié pour suppression. L'objet blob est ensuite supprimé lors du 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. Voir https://docs.microsoft.com/en-us/rest/api/storageservices/delete-blob
deleteIfExists(BlobDeleteOptions)	Marque l’objet blob ou l’instantané spécifié pour suppression s’il existe. L'objet blob est ensuite supprimé lors du 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. Voir https://docs.microsoft.com/en-us/rest/api/storageservices/delete-blob
deleteImmutabilityPolicy(BlobDeleteImmutabilityPolicyOptions)	Supprimez la stratégie d’immutablility sur l’objet blob.
download(number, number, BlobDownloadOptions)	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 une promesse blobBody Voir https://docs.microsoft.com/en-us/rest/api/storageservices/get-blob
downloadToBuffer(Buffer, number, number, BlobDownloadToBufferOptions)	DISPONIBLE UNIQUEMENT DANS NODE.JS RUNTIME. Télécharge un objet blob Azure en parallèle sur 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 ne peuvent prendre en charge les fichiers que jusqu’à environ un gigaoctet sur les systèmes 32 bits ou environ deux gigaoctets sur les systèmes 64 bits en raison des limitations de Node.js/V8. Pour les objets blob supérieurs à cette taille, envisagez downloadToFile.
downloadToBuffer(number, number, BlobDownloadToBufferOptions)	DISPONIBLE UNIQUEMENT DANS NODE.JS RUNTIME. Télécharge un objet blob Azure en parallèle sur 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 ne peuvent prendre en charge les fichiers que jusqu’à environ un gigaoctet sur les systèmes 32 bits ou environ deux gigaoctets sur les systèmes 64 bits en raison des limitations de Node.js/V8. Pour les objets blob supérieurs à cette taille, envisagez downloadToFile.
downloadToFile(string, number, number, BlobDownloadOptions)	DISPONIBLE UNIQUEMENT DANS NODE.JS RUNTIME. Télécharge un objet blob Azure dans un fichier local. Échoue si le chemin d’accès au fichier donné se ferme déjà. Le décalage et le nombre sont facultatifs, passant respectivement 0 et non défini pour télécharger l’objet blob entier.
exists(BlobExistsOptions)	Retourne true si la ressource d’objet blob Azure représentée par ce client existe ; false dans le cas contraire. 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.
generateSasUrl(BlobGenerateSasUrlOptions)	Disponible uniquement pour BlobClient construit avec des informations d’identification de clé partagée. Génère un URI de signature d’accès partagé du service Blob (SAS) en fonction des propriétés et paramètres du client transmis. La signature SAS est signée par les informations d’identification de clé partagée du client. Voir https://docs.microsoft.com/en-us/rest/api/storageservices/constructing-a-service-sas
getAppendBlobClient()	Crée un objet AppendBlobClient.
getBlobLeaseClient(string)	Obtenez un BlobLeaseClient qui gère les baux sur l’objet blob.
getBlockBlobClient()	Crée un objet BlockBlobClient.
getPageBlobClient()	Crée un objet PageBlobClient.
getProperties(BlobGetPropertiesOptions)	Retourne toutes les métadonnées définies par l'utilisateur, les propriétés HTTP standard et les propriétés système pour l'objet blob. Elle ne retourne pas le contenu de l'objet blob. Voir https://docs.microsoft.com/en-us/rest/api/storageservices/get-blob-properties AVERTISSEMENT : L’objet `metadata` retourné dans la réponse aura ses clés en minuscules, même si elles contenaient à l’origine des caractères majuscules. Cela diffère des clés de métadonnées retournées par les méthodes de ContainerClient qui répertorient les objets blob à l’aide de l’option `includeMetadata` , ce qui conservera leur casse d’origine.
getTags(BlobGetTagsOptions)	Obtient les balises associées à l’objet blob sous-jacent.
setAccessTier(string, BlobSetTierOptions)	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 page 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. Voir https://docs.microsoft.com/en-us/rest/api/storageservices/set-blob-tier
setHTTPHeaders(BlobHTTPHeaders, BlobSetHTTPHeadersOptions)	Définit les propriétés système de 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 blob sans valeur sont effacés. Voir https://docs.microsoft.com/en-us/rest/api/storageservices/set-blob-properties
setImmutabilityPolicy(BlobImmutabilityPolicy, BlobSetImmutabilityPolicyOptions)	Définissez la stratégie d’immutablility sur l’objet blob.
setLegalHold(boolean, BlobSetLegalHoldOptions)	Définissez la conservation légale sur l’objet blob.
setMetadata(Metadata, BlobSetMetadataOptions)	Définit les métadonnées définies par l’utilisateur pour l’objet blob spécifié en tant qu’une ou plusieurs paires nom-valeur. Si aucune option n’est fournie ou si aucune métadonnées n’est définie dans le paramètre, les métadonnées d’objet blob sont supprimées. Voir https://docs.microsoft.com/en-us/rest/api/storageservices/set-blob-metadata
setTags(Tags, BlobSetTagsOptions)	Définit des balises sur l’objet blob sous-jacent. Un objet blob peut avoir jusqu’à 10 balises. Les clés de balise doivent comporter entre 1 et 128 caractères. Les valeurs de balise doivent être comprises entre 0 et 256 caractères. Les caractères de clé de balise et de valeur valides incluent les lettres minuscules et majuscules, les chiffres (0-9), l’espace (''), plus ('+'), moins ('-'), point ('.'), la barre oblique ('/'), les deux-points (':'), égal à ('=') et le trait de soulignement ('_') .
syncCopyFromURL(string, BlobSyncCopyFromURLOptions)	L’opération Copier à partir d’UNE URL synchrone copie un objet blob ou une ressource Internet vers un nouvel objet blob. Il ne retourne pas de réponse tant que la copie n’est pas terminée. Voir https://docs.microsoft.com/en-us/rest/api/storageservices/copy-blob-from-url
undelete(BlobUndeleteOptions)	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. Annuler la suppression d’un objet blob est pris en charge uniquement sur la version 29-07-2017 ou ultérieure. Voir https://docs.microsoft.com/en-us/rest/api/storageservices/undelete-blob
withSnapshot(string)	Crée un objet BlobClient identique à la source, mais avec l’horodatage d’instantané spécifié. L’option « » supprime l’instantané et retourne un client à l’objet blob de base.
withVersion(string)	Crée un objet BlobClient pointant vers une version de cet objet blob. L’option « » supprime l’id de version et retourne un client à l’objet blob de base.

Détails du constructeur

BlobClient(string, PipelineLike)

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

new BlobClient(url: string, pipeline: PipelineLike)

Paramètres

url: string

Chaîne d’URL pointant vers l’objet blob Stockage Azure, telle que «https://myaccount.blob.core.windows.net/mycontainer/blob" ; ». Vous pouvez ajouter une signature d’accès partagé si vous utilisez AnonymousCredential, par exemple «https://myaccount.blob.core.windows.net/mycontainer/blob?sasString" ; ». Cette méthode accepte une URL encodée ou une URL non codée pointant vers un objet blob. La chaîne d’URL encodée ne sera PAS échappée deux fois. Seuls les caractères spéciaux du chemin d’URL seront placés dans une séquence d’échappement. Toutefois, si un nom d’objet blob inclut ? ou %, le nom de l’objet blob doit être encodé dans l’URL. Par exemple, un objet blob nommé « my?blob% », l’URL doit être «https://myaccount.blob.core.windows.net/mycontainer/my%3Fblob%25" ;.

pipeline: PipelineLike

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

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

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

Paramètres

url: string

Chaîne cliente pointant vers le service d’objet blob Stockage Azure, telle que « https://myaccount.blob.core.windows.net". Vous pouvez ajouter une signature d’accès partagé si vous utilisez AnonymousCredential, par exemple «https://myaccount.blob.core.windows.net?sasString" ; ».

credential: StorageSharedKeyCredential | AnonymousCredential | TokenCredential

Par exemple, AnonymousCredential, StorageSharedKeyCredential ou toutes les informations d’identification du @azure/identity package pour authentifier les demandes adressées au service. Vous pouvez également fournir un objet qui implémente l’interface TokenCredential. S’il n’est pas spécifié, AnonymousCredential est utilisé.

options: StoragePipelineOptions

Optionnel. Options pour configurer le pipeline HTTP.

BlobClient(string, string, string, StoragePipelineOptions)

Crée une instance de BlobClient à partir d’une chaîne de connexion.

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

Paramètres

connectionString: string

Chaîne de connexion de compte ou chaîne de connexion SAP d’un compte de stockage Azure. [ Remarque : la chaîne de connexion de compte ne peut être utilisée que dans NODE.JS runtime. ] Exemple de chaîne de connexion de compte -DefaultEndpointsProtocol=https;AccountName=myaccount;AccountKey=accountKey;EndpointSuffix=core.windows.net Exemple de chaîne de connexion SAS - BlobEndpoint=https://myaccount.blob.core.windows.net/;QueueEndpoint=https://myaccount.queue.core.windows.net/;FileEndpoint=https://myaccount.file.core.windows.net/;TableEndpoint=https://myaccount.table.core.windows.net/;SharedAccessSignature=sasString

containerName: string

Nom du conteneur.

blobName: string

Nom de l’objet blob.

options: StoragePipelineOptions

Optionnel. Options pour configurer le pipeline HTTP.

Détails de la propriété

containerName

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

string containerName

Valeur de propriété

string

name

Nom de l'objet blob.

string name

Valeur de propriété

string

Détails de la propriété héritée

accountName

accountName: string

Valeur de propriété

string

Hérité de StorageClient.accountName

credential

credential: StorageSharedKeyCredential | AnonymousCredential | TokenCredential

Valeur de propriété

StorageSharedKeyCredential | AnonymousCredential | TokenCredential

Hérité de StorageClient.credential

url

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

url: string

Valeur de propriété

string

Hérité de StorageClient.url

Détails de la méthode

abortCopyFromURL(string, BlobAbortCopyFromURLOptions)

Annule une opération de copie asynchrone d’objet blob en attente et laisse un objet blob de destination avec des métadonnées de longueur nulle et complète. Version du 12.02.12 et ultérieure.

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

function abortCopyFromURL(copyId: string, options?: BlobAbortCopyFromURLOptions): Promise<BlobAbortCopyFromURLResponse>

Paramètres

copyId: string

ID de l’opération Copier à partir de l’URL.

options: BlobAbortCopyFromURLOptions

Options facultatives de l’opération d’annulation de la copie à partir de l’URL d’objet blob.

Retours

Promise<BlobAbortCopyFromURLResponse>

beginCopyFromURL(string, BlobBeginCopyFromURLOptions)

Copie de manière asynchrone un objet blob vers une destination dans le compte de stockage. Cette méthode retourne un polleur d’opération 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 les versions 2012-02-12 et ultérieures, 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 à partir du 7 juin 2012 autorisent l'opération de copie d'objets blob à partir d'un autre compte de stockage.

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

Exemple utilisant l’interrogation automatique :

const copyPoller = await blobClient.beginCopyFromURL('url');
const result = await copyPoller.pollUntilDone();

Exemple d’interrogation manuelle :

const copyPoller = await blobClient.beginCopyFromURL('url');
while (!poller.isDone()) {
   await poller.poll();
}
const result = copyPoller.getResult();

Exemple utilisant les mises à jour de progression :

const copyPoller = await blobClient.beginCopyFromURL('url', {
  onProgress(state) {
    console.log(`Progress: ${state.copyProgress}`);
  }
});
const result = await copyPoller.pollUntilDone();

Exemple utilisant un intervalle d’interrogation changeant (15 secondes par défaut) :

const copyPoller = await blobClient.beginCopyFromURL('url', {
  intervalInMs: 1000 // poll blob every 1 second for copy progress
});
const result = await copyPoller.pollUntilDone();

Exemple d’annulation de copie :

const copyPoller = await blobClient.beginCopyFromURL('url');
// cancel operation after starting it.
try {
  await copyPoller.cancelOperation();
  // calls to get the result now throw PollerCancelledError
  await copyPoller.getResult();
} catch (err) {
  if (err.name === 'PollerCancelledError') {
    console.log('The copy was cancelled.');
  }
}

function beginCopyFromURL(copySource: string, options?: BlobBeginCopyFromURLOptions): Promise<PollerLikeWithCancellation<PollOperationState<BlobBeginCopyFromURLResponse>, BlobBeginCopyFromURLResponse>>

Paramètres

copySource: string

url vers l’objet blob/fichier Azure source.

options: BlobBeginCopyFromURLOptions

Options facultatives de l’opération Démarrer la copie à partir de l’URL d’objet blob.

Retours

Promise<PollerLikeWithCancellation<PollOperationState<BlobBeginCopyFromURLResponse>, BlobBeginCopyFromURLResponse>>

createSnapshot(BlobCreateSnapshotOptions)

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

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

function createSnapshot(options?: BlobCreateSnapshotOptions): Promise<BlobCreateSnapshotResponse>

Paramètres

options: BlobCreateSnapshotOptions

Options facultatives de l’opération Créer un instantané d’objet blob.

Retours

Promise<BlobCreateSnapshotResponse>

delete(BlobDeleteOptions)

Marque l’objet blob ou l’instantané spécifié pour suppression. L'objet blob est ensuite supprimé lors du 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.

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

function delete(options?: BlobDeleteOptions): Promise<BlobDeleteResponse>

Paramètres

options: BlobDeleteOptions

Options facultatives pour l’opération De suppression d’objets blob.

Retours

Promise<BlobDeleteResponse>

deleteIfExists(BlobDeleteOptions)

Marque l’objet blob ou l’instantané spécifié pour suppression s’il existe. L'objet blob est ensuite supprimé lors du 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.

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

function deleteIfExists(options?: BlobDeleteOptions): Promise<BlobDeleteIfExistsResponse>

Paramètres

options: BlobDeleteOptions

Options facultatives pour l’opération De suppression d’objets blob.

Retours

Promise<BlobDeleteIfExistsResponse>

deleteImmutabilityPolicy(BlobDeleteImmutabilityPolicyOptions)

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

function deleteImmutabilityPolicy(options?: BlobDeleteImmutabilityPolicyOptions): Promise<BlobDeleteImmutabilityPolicyResponse>

Paramètres

options: BlobDeleteImmutabilityPolicyOptions

Options facultatives pour supprimer la stratégie d’immuabilité sur l’objet blob.

Retours

Promise<BlobDeleteImmutabilityPolicyResponse>

download(number, number, BlobDownloadOptions)

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 une promesse blobBody

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

function download(offset?: number, count?: number, options?: BlobDownloadOptions): Promise<BlobDownloadResponseParsed>

Paramètres

offset: number

À partir de quelle position de l’objet blob à télécharger, supérieure ou égale à 0

count: number

Quantité de données à télécharger, supérieure à 0. Téléchargement jusqu’à la fin en cas de définition non définie

options: BlobDownloadOptions

Options facultatives pour l’opération De téléchargement d’objets blob.

Exemple d’utilisation (Node.js) :

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

Exemple d’utilisation (navigateur) :

// 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

Promise<BlobDownloadResponseParsed>

downloadToBuffer(Buffer, number, number, BlobDownloadToBufferOptions)

DISPONIBLE UNIQUEMENT DANS NODE.JS RUNTIME.

Télécharge un objet blob Azure en parallèle sur 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 ne peuvent prendre en charge les fichiers que jusqu’à environ un gigaoctet sur les systèmes 32 bits ou environ deux gigaoctets sur les systèmes 64 bits en raison des limitations de Node.js/V8. Pour les objets blob supérieurs à cette taille, envisagez downloadToFile.

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

Paramètres

buffer: Buffer

La mémoire tampon à remplir doit avoir une longueur supérieure au nombre

offset: number

À partir de quelle position de l’objet blob de bloc à télécharger (en octets)

count: number

Quantité de données (en octets) à télécharger. Téléchargement à la fin lors de la transmission d’undefined

options: BlobDownloadToBufferOptions

BlobDownloadToBufferOptions

Retours

Promise<Buffer>

downloadToBuffer(number, number, BlobDownloadToBufferOptions)

DISPONIBLE UNIQUEMENT DANS NODE.JS RUNTIME.

Télécharge un objet blob Azure en parallèle sur 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.

function downloadToBuffer(offset?: number, count?: number, options?: BlobDownloadToBufferOptions): Promise<Buffer>

Paramètres

offset: number

À partir de quelle position de l’objet blob de bloc à télécharger (en octets)

count: number

Quantité de données (en octets) à télécharger. Téléchargement à la fin lors de la transmission d’undefined

options: BlobDownloadToBufferOptions

BlobDownloadToBufferOptions

Retours

Promise<Buffer>

downloadToFile(string, number, number, BlobDownloadOptions)

DISPONIBLE UNIQUEMENT DANS NODE.JS RUNTIME.

Télécharge un objet blob Azure dans un fichier local. Échoue si le chemin d’accès au fichier donné se ferme déjà. Le décalage et le nombre sont facultatifs, passant respectivement 0 et non défini pour télécharger l’objet blob entier.

function downloadToFile(filePath: string, offset?: number, count?: number, options?: BlobDownloadOptions): Promise<BlobDownloadResponseParsed>

Paramètres

filePath: string

offset: number

À partir de quelle position de l’objet blob de blocs à télécharger.

count: number

Quantité de données à télécharger. Est téléchargé à la fin lors de la transmission d’undefined.

options: BlobDownloadOptions

Options pour les options de téléchargement d’objets blob.

Retours

Promise<BlobDownloadResponseParsed>

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

exists(BlobExistsOptions)

Retourne true si la ressource d’objet blob Azure représentée par ce client existe ; false dans le cas contraire.

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): Promise<boolean>

Paramètres

options: BlobExistsOptions

options de l’opération Exists.

Retours

Promise<boolean>

generateSasUrl(BlobGenerateSasUrlOptions)

Disponible uniquement pour BlobClient construit avec des informations d’identification de clé partagée.

Génère un URI de signature d’accès partagé du service Blob (SAS) en fonction des propriétés et paramètres du client transmis. La signature SAS est signée par les informations d’identification de clé partagée du client.

Voir https://docs.microsoft.com/en-us/rest/api/storageservices/constructing-a-service-sas

function generateSasUrl(options: BlobGenerateSasUrlOptions): Promise<string>

Paramètres

options: BlobGenerateSasUrlOptions

Paramètres facultatifs.

Retours

Promise<string>

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

getAppendBlobClient()

Crée un objet AppendBlobClient.

function getAppendBlobClient(): AppendBlobClient

Retours

AppendBlobClient

getBlobLeaseClient(string)

Obtenez un BlobLeaseClient qui gère les baux sur l’objet blob.

function getBlobLeaseClient(proposeLeaseId?: string): BlobLeaseClient

Paramètres

proposeLeaseId: string

ID de bail initial proposé.

Retours

BlobLeaseClient

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

getBlockBlobClient()

Crée un objet BlockBlobClient.

function getBlockBlobClient(): BlockBlobClient

Retours

BlockBlobClient

getPageBlobClient()

Crée un objet PageBlobClient.

function getPageBlobClient(): PageBlobClient

Retours

PageBlobClient

getProperties(BlobGetPropertiesOptions)

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

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

AVERTISSEMENT : L’objet metadata retourné dans la réponse aura ses clés en minuscules, même si elles contenaient à l’origine des caractères majuscules. Cela diffère des clés de métadonnées retournées par les méthodes de ContainerClient qui répertorient les objets blob à l’aide de l’option includeMetadata , ce qui conservera leur casse d’origine.

function getProperties(options?: BlobGetPropertiesOptions): Promise<BlobGetPropertiesResponse>

Paramètres

options: BlobGetPropertiesOptions

Options facultatives pour l’opération Obtenir les propriétés.

Retours

Promise<BlobGetPropertiesResponse>

getTags(BlobGetTagsOptions)

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

function getTags(options?: BlobGetTagsOptions): Promise<BlobGetTagsResponse>

Paramètres

options: BlobGetTagsOptions

Retours

Promise<BlobGetTagsResponse>

setAccessTier(string, BlobSetTierOptions)

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

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

function setAccessTier(tier: string, options?: BlobSetTierOptions): Promise<BlobSetTierResponse>

Paramètres

tier: string

Niveau à définir sur l’objet blob. Les valeurs valides sont Hot, Cool ou Archive.

options: BlobSetTierOptions

Options facultatives de l’opération de niveau d’ensemble d’objets blob.

Retours

Promise<BlobSetTierResponse>

setHTTPHeaders(BlobHTTPHeaders, BlobSetHTTPHeadersOptions)

Définit les propriétés système de 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 blob sans valeur sont effacés.

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

function setHTTPHeaders(blobHTTPHeaders?: BlobHTTPHeaders, options?: BlobSetHTTPHeadersOptions): Promise<BlobSetHTTPHeadersResponse>

Paramètres

blobHTTPHeaders: BlobHTTPHeaders

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 blob sans valeur sont effacés. Un en-tête courant à définir permet blobContentType au navigateur de fournir des fonctionnalités basées sur le type de fichier.

options: BlobSetHTTPHeadersOptions

Options facultatives pour l’opération Définir les en-têtes HTTP d’objet blob.

Retours

Promise<BlobSetHTTPHeadersResponse>

setImmutabilityPolicy(BlobImmutabilityPolicy, BlobSetImmutabilityPolicyOptions)

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

function setImmutabilityPolicy(immutabilityPolicy: BlobImmutabilityPolicy, options?: BlobSetImmutabilityPolicyOptions): Promise<BlobSetImmutabilityPolicyResponse>

Paramètres

immutabilityPolicy: BlobImmutabilityPolicy

options: BlobSetImmutabilityPolicyOptions

Options facultatives pour définir la stratégie d’immuabilité sur l’objet blob.

Retours

Promise<BlobSetImmutabilityPolicyResponse>

setLegalHold(boolean, BlobSetLegalHoldOptions)

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

function setLegalHold(legalHoldEnabled: boolean, options?: BlobSetLegalHoldOptions): Promise<BlobSetLegalHoldResponse>

Paramètres

legalHoldEnabled: boolean

options: BlobSetLegalHoldOptions

Options facultatives pour définir la conservation légale sur l’objet blob.

Retours

Promise<BlobSetLegalHoldResponse>

setMetadata(Metadata, BlobSetMetadataOptions)

Définit les métadonnées définies par l’utilisateur pour l’objet blob spécifié en tant qu’une ou plusieurs paires nom-valeur.

Si aucune option n’est fournie ou si aucune métadonnées n’est définie dans le paramètre, les métadonnées d’objet blob sont supprimées.

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

function setMetadata(metadata?: Metadata, options?: BlobSetMetadataOptions): Promise<BlobSetMetadataResponse>

Paramètres

metadata: Metadata

Remplacez les métadonnées existantes par cette valeur. Si aucune valeur n’a été fournie, les métadonnées existantes seront supprimées.

options: BlobSetMetadataOptions

Options facultatives pour l’opération Définir les métadonnées.

Retours

Promise<BlobSetMetadataResponse>

setTags(Tags, BlobSetTagsOptions)

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

function setTags(tags: Tags, options?: BlobSetTagsOptions): Promise<BlobSetTagsResponse>

Paramètres

tags: Tags

options: BlobSetTagsOptions

Retours

Promise<BlobSetTagsResponse>

syncCopyFromURL(string, BlobSyncCopyFromURLOptions)

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

Voir https://docs.microsoft.com/en-us/rest/api/storageservices/copy-blob-from-url

function syncCopyFromURL(copySource: string, options?: BlobSyncCopyFromURLOptions): Promise<BlobCopyFromURLResponse>

Paramètres

copySource: string

URL source à partir de laquelle copier, signature d’accès partagé (SAS) peut être nécessaire pour l’authentification

options: BlobSyncCopyFromURLOptions

Retours

Promise<BlobCopyFromURLResponse>

undelete(BlobUndeleteOptions)

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. Annuler la suppression d’un objet blob est pris en charge uniquement sur la version 29-07-2017 ou ultérieure.

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

function undelete(options?: BlobUndeleteOptions): Promise<BlobUndeleteResponse>

Paramètres

options: BlobUndeleteOptions

Options facultatives pour annuler la suppression de l’opération Blob.

Retours

Promise<BlobUndeleteResponse>

withSnapshot(string)

Crée un objet BlobClient identique à la source, mais avec l’horodatage d’instantané spécifié. L’option « » supprime l’instantané et retourne un client à l’objet blob de base.

function withSnapshot(snapshot: string): BlobClient

Paramètres

snapshot: string

Horodatage de l’instantané.

Retours

BlobClient

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

withVersion(string)

Crée un objet BlobClient pointant vers une version de cet objet blob. L’option « » supprime l’id de version et retourne un client à l’objet blob de base.

function withVersion(versionId: string): BlobClient

Paramètres

versionId: string

VersionId.

Retours

BlobClient

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

Partager via

BlobClient class

Constructeurs

Propriétés

Propriétés héritées

Méthodes

Détails du constructeur

BlobClient(string, PipelineLike)

Paramètres

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

Paramètres

BlobClient(string, string, string, StoragePipelineOptions)

Paramètres

Détails de la propriété

containerName

Valeur de propriété

name

Valeur de propriété

Détails de la propriété héritée

accountName

Valeur de propriété

credential

Valeur de propriété

url

Valeur de propriété

Détails de la méthode

abortCopyFromURL(string, BlobAbortCopyFromURLOptions)

Paramètres

Retours

beginCopyFromURL(string, BlobBeginCopyFromURLOptions)

Paramètres

Retours

createSnapshot(BlobCreateSnapshotOptions)

Paramètres

Retours

delete(BlobDeleteOptions)

Paramètres

Retours

deleteIfExists(BlobDeleteOptions)

Paramètres

Retours

deleteImmutabilityPolicy(BlobDeleteImmutabilityPolicyOptions)

Paramètres

Retours

download(number, number, BlobDownloadOptions)

Paramètres

Retours

downloadToBuffer(Buffer, number, number, BlobDownloadToBufferOptions)

Paramètres

Retours

downloadToBuffer(number, number, BlobDownloadToBufferOptions)

Paramètres

Retours

downloadToFile(string, number, number, BlobDownloadOptions)

Paramètres

Retours

exists(BlobExistsOptions)

Paramètres

Retours

generateSasUrl(BlobGenerateSasUrlOptions)

Paramètres

Retours

getAppendBlobClient()

Retours

getBlobLeaseClient(string)

Paramètres

Retours

getBlockBlobClient()

Retours

getPageBlobClient()

Retours

getProperties(BlobGetPropertiesOptions)

Paramètres

Retours

getTags(BlobGetTagsOptions)

Paramètres

Retours

setAccessTier(string, BlobSetTierOptions)

Paramètres

Retours