BlockBlobClient class

Référence

Paquet:: @azure/storage-blob

BlockBlobClient définit un ensemble d’opérations applicables aux objets blob de blocs.

Extends: BlobClient

Constructeurs

BlockBlobClient(string, PipelineLike)	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.
BlockBlobClient(string, StorageSharedKeyCredential \| AnonymousCredential \| TokenCredential, StoragePipelineOptions)	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.
BlockBlobClient(string, string, string, StoragePipelineOptions)	Crée une instance de BlockBlobClient.

Propriétés

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

Propriétés héritées

accountName
credential	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é.
url	Valeur de chaîne d’URL encodée.

Méthodes

commitBlockList(string[], BlockBlobCommitBlockListOptions)	É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 stageBlock antérieure. Vous pouvez appeler 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. Voir https://docs.microsoft.com/rest/api/storageservices/put-block-list
getBlockList(BlockListType, BlockBlobGetBlockListOptions)	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é. Voir https://docs.microsoft.com/rest/api/storageservices/get-block-list
query(string, BlockBlobQueryOptions)	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); }); }
stageBlock(string, RequestBodyType, number, BlockBlobStageBlockOptions)	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. Voir https://docs.microsoft.com/rest/api/storageservices/put-block
stageBlockFromURL(string, string, number, number, BlockBlobStageBlockFromURLOptions)	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. Voir https://docs.microsoft.com/en-us/rest/api/storageservices/put-block-from-url
syncUploadFromURL(string, BlockBlobSyncUploadFromURLOptions)	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 stageBlockFromURL et commitBlockList.
upload(RequestBodyType, number, BlockBlobUploadOptions)	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 d’un objet blob de blocs, utilisez stageBlock et commitBlockList. Il s’agit d’une méthode de chargement non parallèle, utilisez uploadFile, uploadStream ou uploadBrowserData pour obtenir de meilleures performances avec le chargement concurrentiel. Voir https://docs.microsoft.com/rest/api/storageservices/put-blob
uploadBrowserData(Blob \| ArrayBuffer \| ArrayBufferView, BlockBlobParallelUploadOptions)	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 stageBlock pour charger des blocs, puis appelle commitBlockList pour valider la liste de blocs. Une option courante blobHTTPHeaders à définir est `blobContentType`, ce qui permet au navigateur de fournir des fonctionnalités basées sur le type de fichier.
uploadData(Blob \| ArrayBuffer \| ArrayBufferView \| Buffer, BlockBlobParallelUploadOptions)	Charge un tampon(Node.js)/Blob(navigateurs)/ArrayBuffer/ArrayBufferView dans un BlockBlob. Lorsque la longueur des données n’est pas supérieure à la longueur spécifiée maxSingleShotSize (la valeur par défaut est <xref:BLOCK_BLOB_MAX_UPLOAD_BLOB_BYTES>), 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. Une option courante blobHTTPHeaders à définir est `blobContentType`, ce qui permet au navigateur de fournir des fonctionnalités basées sur le type de fichier.
uploadFile(string, BlockBlobParallelUploadOptions)	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.
uploadStream(Readable, number, number, BlockBlobUploadStreamOptions)	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().
withSnapshot(string)	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.

Méthodes héritées

abortCopyFromURL(string, BlobAbortCopyFromURLOptions)	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. Voir https://docs.microsoft.com/en-us/rest/api/storageservices/abort-copy-blob
beginCopyFromURL(string, BlobBeginCopyFromURLOptions)	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. 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 des 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 utilisant l’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 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. 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 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. Voir https://docs.microsoft.com/en-us/rest/api/storageservices/delete-blob
deleteImmutabilityPolicy(BlobDeleteImmutabilityPolicyOptions)	Supprimez la stratégie 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 un blobBody de promesse 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 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 de downloadToFile.
downloadToBuffer(number, number, BlobDownloadToBufferOptions)	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 de 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 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.
exists(BlobExistsOptions)	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.
generateSasStringToSign(BlobGenerateSasUrlOptions)	Disponible uniquement pour BlobClient construit avec des informations d’identification de clé partagée. Génère une chaîne à signer pour un URI SAS (Blob Service Shared Access Signature) en fonction des 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. Voir https://docs.microsoft.com/en-us/rest/api/storageservices/constructing-a-service-sas
generateSasUrl(BlobGenerateSasUrlOptions)	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. Voir https://docs.microsoft.com/en-us/rest/api/storageservices/constructing-a-service-sas
generateUserDelegationSasStringToSign(BlobGenerateSasUrlOptions, UserDelegationKey)	Disponible uniquement pour BlobClient construit avec des informations d’identification de clé partagée. Génère une chaîne à signer pour un URI SAS (Blob Service Shared Access Signature) en fonction des propriétés et paramètres du client transmis. La SAP est signée par la clé de délégation d’utilisateur d’entrée. Voir https://docs.microsoft.com/en-us/rest/api/storageservices/constructing-a-service-sas
generateUserDelegationSasUrl(BlobGenerateSasUrlOptions, UserDelegationKey)	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 la clé de délégation d’utilisateur d’entrée. Voir https://docs.microsoft.com/en-us/rest/api/storageservices/constructing-a-service-sas
getAccountInfo(BlobGetAccountInfoOptions)	L’opération Obtenir les informations sur le compte retourne le nom de la référence SKU et le type de compte pour le compte spécifié. L’opération Obtenir des informations sur le compte est disponible sur les versions de service à compter de la version 2018-03-28. Voir https://docs.microsoft.com/en-us/rest/api/storageservices/get-account-information
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 de l’objet blob. Il 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 s’ils contenaient initialement 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`, qui conserve 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 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. Voir https://docs.microsoft.com/en-us/rest/api/storageservices/set-blob-tier
setHTTPHeaders(BlobHTTPHeaders, BlobSetHTTPHeadersOptions)	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. Voir https://docs.microsoft.com/en-us/rest/api/storageservices/set-blob-properties
setImmutabilityPolicy(BlobImmutabilityPolicy, BlobSetImmutabilityPolicyOptions)	Définissez la stratégie d’immuabilité 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é 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. 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 ê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 ('_') .
syncCopyFromURL(string, BlobSyncCopyFromURLOptions)	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. 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. Undelete Blob est pris en charge uniquement sur la version 2017-07-29 ou ultérieure. Voir https://docs.microsoft.com/en-us/rest/api/storageservices/undelete-blob
withVersion(string)	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.

Détails du constructeur

BlockBlobClient(string, PipelineLike)

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

url: string

Chaîne d’URL pointant vers l’objet blob de blocs stockage Azure, par exemple «https://myaccount.blob.core.windows.net/mycontainer/blockblob". Vous pouvez ajouter une SAP si vous utilisez AnonymousCredential, par exemple «https://myaccount.blob.core.windows.net/mycontainer/blockblob?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 dans le chemin d’URL seront échappés. 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é.

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

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

Paramètres

url: string

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

Optionnel. Options de configuration du pipeline HTTP.

BlockBlobClient(string, string, string, StoragePipelineOptions)

Crée une instance de BlockBlobClient.

new BlockBlobClient(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 - exemple de chaîne de connexion SAS DefaultEndpointsProtocol=https;AccountName=myaccount;AccountKey=accountKey;EndpointSuffix=core.windows.net - 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 de configuration du pipeline HTTP.

Détails de la propriété

containerName

Nom du conteneur de stockage auquel 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ée deBlobClient.accountName

credential

credential: StorageSharedKeyCredential | AnonymousCredential | TokenCredential

Valeur de propriété

StorageSharedKeyCredential | AnonymousCredential | TokenCredential

héritée deBlobClient.credential

url

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

url: string

Valeur de propriété

string

héritée deBlobClient.url

Détails de la méthode

commitBlockList(string[], BlockBlobCommitBlockListOptions)

É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 stageBlock antérieure. Vous pouvez appeler 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.

Voir https://docs.microsoft.com/rest/api/storageservices/put-block-list

function commitBlockList(blocks: string[], options?: BlockBlobCommitBlockListOptions): Promise<BlockBlobCommitBlockListResponse>

Paramètres

blocks: string[]

Tableau de valeur de 64 octets codée en base64

options: BlockBlobCommitBlockListOptions

Options de l’opération de liste de blocs de validation d’objet blob de blocs.

Retours

Promise<BlockBlobCommitBlockListResponse>

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

getBlockList(BlockListType, BlockBlobGetBlockListOptions)

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

Voir https://docs.microsoft.com/rest/api/storageservices/get-block-list

function getBlockList(listType: BlockListType, options?: BlockBlobGetBlockListOptions): Promise<BlockBlobGetBlockListResponse>

Paramètres

listType: BlockListType

Spécifie s’il faut retourner la liste des blocs validés, la liste des blocs non validés ou les deux listes ensemble.

options: BlockBlobGetBlockListOptions

Options de l’opération De liste de blocs Get Block Blob.

Retours

Promise<BlockBlobGetBlockListResponse>

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

query(string, BlockBlobQueryOptions)

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

Paramètres

query: string

options: BlockBlobQueryOptions

Retours

Promise<BlobDownloadResponseModel>

stageBlock(string, RequestBodyType, number, BlockBlobStageBlockOptions)

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.

Voir https://docs.microsoft.com/rest/api/storageservices/put-block

function stageBlock(blockId: string, body: RequestBodyType, contentLength: number, options?: BlockBlobStageBlockOptions): Promise<BlockBlobStageBlockResponse>

Paramètres

blockId: string

Valeur de 64 octets codée en base64

body: HttpRequestBody

Données à charger dans la zone intermédiaire.

contentLength: number

Nombre d’octets à charger.

options: BlockBlobStageBlockOptions

Options de l’opération bloquer l’étape de l’objet blob de blocs.

Retours

Promise<BlockBlobStageBlockResponse>

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

stageBlockFromURL(string, string, number, number, BlockBlobStageBlockFromURLOptions)

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.

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

function stageBlockFromURL(blockId: string, sourceURL: string, offset?: number, count?: number, options?: BlockBlobStageBlockFromURLOptions): Promise<BlockBlobStageBlockFromURLResponse>

Paramètres

blockId: string

Valeur de 64 octets codée en base64

sourceURL: string

Spécifie l’URL de l’objet blob. La valeur peut être une URL d’une longueur maximale de 2 Ko qui spécifie un objet blob. La valeur doit être encodée en URL, car elle apparaît dans un URI de requête. L’objet blob source doit être public ou doit être authentifié via une signature d’accès partagé. Si l’objet blob source est public, aucune authentification n’est requise pour effectuer l’opération. Voici quelques exemples d’URL d’objet source : - https://myaccount.blob.core.windows.net/mycontainer/myblob - https://myaccount.blob.core.windows.net/mycontainer/myblob?snapshot=

offset: number

À partir de laquelle la 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échargera jusqu’à la fin lorsqu’il n’est pas défini

options: BlockBlobStageBlockFromURLOptions

Options du bloc d’étape d’objet blob de blocs à partir de l’opération d’URL.

Retours

Promise<BlockBlobStageBlockFromURLResponse>

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

syncUploadFromURL(string, BlockBlobSyncUploadFromURLOptions)

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 stageBlockFromURL et commitBlockList.

function syncUploadFromURL(sourceURL: string, options?: BlockBlobSyncUploadFromURLOptions): Promise<BlockBlobPutBlobFromUrlResponse>

Paramètres

sourceURL: string

options: BlockBlobSyncUploadFromURLOptions

Paramètres facultatifs.

Retours

Promise<BlockBlobPutBlobFromUrlResponse>

upload(RequestBodyType, number, BlockBlobUploadOptions)

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 d’un objet blob de blocs, utilisez stageBlock et commitBlockList.

Il s’agit d’une méthode de chargement non parallèle, utilisez uploadFile, uploadStream ou uploadBrowserData pour obtenir de meilleures performances avec le chargement concurrentiel.

Voir https://docs.microsoft.com/rest/api/storageservices/put-blob

function upload(body: RequestBodyType, contentLength: number, options?: BlockBlobUploadOptions): Promise<BlockBlobUploadResponse>

Paramètres

body: HttpRequestBody

Blob, string, ArrayBuffer, ArrayBufferView ou fonction qui retourne un nouveau flux lisible dont le décalage est du début de la source de données.

contentLength: number

Longueur du corps en octets. Utilisez Buffer.byteLength() pour calculer la longueur du corps d’une chaîne, y compris les caractères non codés en base64/hex.

options: BlockBlobUploadOptions

Options de l’opération de chargement d’objets blob de blocs.

Retours

Promise<BlockBlobUploadResponse>

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

uploadBrowserData(Blob | ArrayBuffer | ArrayBufferView, BlockBlobParallelUploadOptions)

Avertissement

Cette API est à présent déconseillée.

Use uploadData instead.

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 stageBlock pour charger des blocs, puis appelle commitBlockList pour valider la liste de blocs.

Une option courante blobHTTPHeaders à 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): Promise<BlobUploadCommonResponse>

Paramètres

browserData: Blob | ArrayBuffer | ArrayBufferView

Blob, File, ArrayBuffer ou ArrayBufferView

options: BlockBlobParallelUploadOptions

Options de chargement des données du navigateur.

Retours

Promise<BlobUploadCommonResponse>

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

uploadData(Blob | ArrayBuffer | ArrayBufferView | Buffer, BlockBlobParallelUploadOptions)

Charge un tampon(Node.js)/Blob(navigateurs)/ArrayBuffer/ArrayBufferView dans un BlockBlob.

Lorsque la longueur des données n’est pas supérieure à la longueur spécifiée maxSingleShotSize (la valeur par défaut est <xref:BLOCK_BLOB_MAX_UPLOAD_BLOB_BYTES>), 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.

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

function uploadData(data: Blob | ArrayBuffer | ArrayBufferView | Buffer, options?: BlockBlobParallelUploadOptions): Promise<BlobUploadCommonResponse>

Paramètres

data: Blob | ArrayBuffer | ArrayBufferView | Buffer

Buffer(Node.js), Blob, ArrayBuffer ou ArrayBufferView

options: BlockBlobParallelUploadOptions

Retours

Promise<BlobUploadCommonResponse>

uploadFile(string, BlockBlobParallelUploadOptions)

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

Paramètres

filePath: string

Chemin d’accès complet du fichier local

options: BlockBlobParallelUploadOptions

Options de chargement dans l’opération d’objet blob de blocs.

Retours

Promise<BlobUploadCommonResponse>

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

uploadStream(Readable, number, number, BlockBlobUploadStreamOptions)

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

Paramètres

stream: Readable

Node.js flux lisible

bufferSize: number

Taille de chaque mémoire tampon allouée, également la taille de bloc dans l’objet blob de blocs chargé. La valeur par défaut est 8 Mo

maxConcurrency: number

La concurrence maximale indique le nombre maximal de mémoires tampons qui peuvent être allouées, une corrélation positive avec la concurrence maximale de chargement. La valeur par défaut est 5

options: BlockBlobUploadStreamOptions

Options pour charger le flux dans l’opération d’objet blob de blocs.

Retours

Promise<BlobUploadCommonResponse>

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

withSnapshot(string)

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): BlockBlobClient

Paramètres

snapshot: string

Horodatage d’instantané.

Retours

BlockBlobClient

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

Détails de la méthode héritée

abortCopyFromURL(string, BlobAbortCopyFromURLOptions)

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.

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 pour l’opération Copier à partir de l’URL de l’objet blob.

Retours

Promise<BlobAbortCopyFromURLResponse>

héritée deBlobClient.abortCopyFromURL

beginCopyFromURL(string, BlobBeginCopyFromURLOptions)

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.

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 des 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 utilisant l’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 pour l’opération Copier à partir de l’URL de démarrage de l’objet blob.

Retours

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

héritée deBlobClient.beginCopyFromURL

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 pour l’opération De création d’instantané d’objet blob.

Retours

Promise<BlobCreateSnapshotResponse>

héritée deBlobClient.createSnapshot

delete(BlobDeleteOptions)

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.

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>

héritée deBlobClient.delete

deleteIfExists(BlobDeleteOptions)

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.

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>

héritée deBlobClient.deleteIfExists

deleteImmutabilityPolicy(BlobDeleteImmutabilityPolicyOptions)

Supprimez la stratégie 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>

héritée deBlobClient.deleteImmutabilityPolicy

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 un blobBody de promesse

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 laquelle la 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échargera jusqu’à la fin lorsqu’il n’est pas défini

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>

héritée deBlobClient.download

downloadToBuffer(Buffer, number, number, BlobDownloadToBufferOptions)

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 de downloadToFile.

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

Paramètres

buffer: Buffer

Mémoire tampon à remplir, doit avoir une longueur supérieure au nombre

offset: number

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

count: number

Quantité de données (en octets) à télécharger. Téléchargera jusqu’à la fin lors de la transmission non définie

options: BlobDownloadToBufferOptions

BlobDownloadToBufferOptions

Retours

Promise<Buffer>

héritée deBlobClient.downloadToBuffer

downloadToBuffer(number, number, BlobDownloadToBufferOptions)

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.

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

Paramètres

offset: number

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

count: number

Quantité de données (en octets) à télécharger. Téléchargera jusqu’à la fin lors de la transmission non définie

options: BlobDownloadToBufferOptions

BlobDownloadToBufferOptions

Retours

Promise<Buffer>

héritée deBlobClient.downloadToBuffer

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 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): 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. Se télécharge à la fin lors de la transmission non définie.

options: BlobDownloadOptions

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

héritée deBlobClient.downloadToFile

exists(BlobExistsOptions)

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

Paramètres

options: BlobExistsOptions

options pour l’opération Exists.

Retours

Promise<boolean>

héritée deBlobClient.existe

generateSasStringToSign(BlobGenerateSasUrlOptions)

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

Génère une chaîne à signer pour un URI SAS (Blob Service Shared Access Signature) en fonction des 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.

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

function generateSasStringToSign(options: BlobGenerateSasUrlOptions): string

Paramètres

options: BlobGenerateSasUrlOptions

Paramètres facultatifs.

Retours

string

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

héritée deBlobClient.generateSasStringToSign

generateSasUrl(BlobGenerateSasUrlOptions)

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.

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

héritée deBlobClient.generateSasUrl

generateUserDelegationSasStringToSign(BlobGenerateSasUrlOptions, UserDelegationKey)

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

Génère une chaîne à signer pour un URI SAS (Blob Service Shared Access Signature) en fonction des propriétés et paramètres du client transmis. La SAP est signée par la clé de délégation d’utilisateur d’entrée.

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

function generateUserDelegationSasStringToSign(options: BlobGenerateSasUrlOptions, userDelegationKey: UserDelegationKey): string

Paramètres

options: BlobGenerateSasUrlOptions

Paramètres facultatifs.

userDelegationKey: UserDelegationKey

Valeur de retour de blobServiceClient.getUserDelegationKey()

Retours

string

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

héritée deBlobClient.generateUserDelegationSasStringToSign

generateUserDelegationSasUrl(BlobGenerateSasUrlOptions, UserDelegationKey)

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 la clé de délégation d’utilisateur d’entrée.

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

function generateUserDelegationSasUrl(options: BlobGenerateSasUrlOptions, userDelegationKey: UserDelegationKey): Promise<string>

Paramètres

options: BlobGenerateSasUrlOptions

Paramètres facultatifs.

userDelegationKey: UserDelegationKey

Valeur de retour de blobServiceClient.getUserDelegationKey()

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

héritée deBlobClient.generateUserDelegationSasUrl

getAccountInfo(BlobGetAccountInfoOptions)

L’opération Obtenir les informations sur le compte retourne le nom de la référence SKU et le type de compte pour le compte spécifié. L’opération Obtenir des informations sur le compte est disponible sur les versions de service à compter de la version 2018-03-28.

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

function getAccountInfo(options?: BlobGetAccountInfoOptions): Promise<BlobGetAccountInfoResponse>

Paramètres

options: BlobGetAccountInfoOptions

Options de l’opération Obtenir les informations de compte du service.

Retours

Promise<BlobGetAccountInfoResponse>

Données de réponse pour l’opération d’informations sur le compte Get du service.

héritée deBlobClient.getAccountInfo

getAppendBlobClient()

Crée un objet AppendBlobClient.

function getAppendBlobClient(): AppendBlobClient

Retours

AppendBlobClient

héritée deBlobClient.getAppendBlobClient

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.

héritée deBlobClient.getBlobLeaseClient

getBlockBlobClient()

Crée un objet BlockBlobClient.

function getBlockBlobClient(): BlockBlobClient

Retours

BlockBlobClient

héritée deBlobClient.getBlockBlobClient

getPageBlobClient()

Crée un objet PageBlobClient.

function getPageBlobClient(): PageBlobClient

Retours

PageBlobClient

héritée deBlobClient.getPageBlobClient

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 de l’objet blob. Il 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 s’ils contenaient initialement 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, qui conserve 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>

héritée deBlobClient.getProperties

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>

héritée deBlobClient.getTags

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

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 pour l’opération de niveau de jeu d’objets blob.

Retours

Promise<BlobSetTierResponse>

héritée deBlobClient.setAccessTier

setHTTPHeaders(BlobHTTPHeaders, BlobSetHTTPHeadersOptions)

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.

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 d’objet blob sans valeur seront effacés. Un en-tête courant à définir est blobContentType permettant 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 de jeu d’objets blob.

Retours

Promise<BlobSetHTTPHeadersResponse>

héritée deBlobClient.setHTTPHeaders

setImmutabilityPolicy(BlobImmutabilityPolicy, BlobSetImmutabilityPolicyOptions)

Définissez la stratégie d’immuabilité 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>

héritée deBlobClient.setImmutabilityPolicy

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>

héritée deBlobClient.setLegalHold

setMetadata(Metadata, BlobSetMetadataOptions)

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.

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’est fournie, les métadonnées existantes seront supprimées.

options: BlobSetMetadataOptions

Options facultatives pour définir l’opération de métadonnées.

Retours

Promise<BlobSetMetadataResponse>

héritée deBlobClient.setMetadata

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 ê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): Promise<BlobSetTagsResponse>

Paramètres

tags: Tags

options: BlobSetTagsOptions

Retours

Promise<BlobSetTagsResponse>

héritée deBlobClient.setTags

syncCopyFromURL(string, BlobSyncCopyFromURLOptions)

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.

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

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

options: BlobSyncCopyFromURLOptions

Retours

Promise<BlobCopyFromURLResponse>

héritée deBlobClient.syncCopyFromURL

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. Undelete Blob est pris en charge uniquement sur la version 2017-07-29 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 l’opération Annuler la suppression d’objet blob.

Retours

Promise<BlobUndeleteResponse>

héritée deBlobClient.undelete

withVersion(string)

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): BlobClient

Paramètres

versionId: string

Id de version.

Retours

BlobClient

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

héritée deBlobClient.withVersion

Partager via

BlockBlobClient class

Constructeurs

Propriétés

Propriétés héritées

Méthodes

Méthodes héritées

Détails du constructeur

BlockBlobClient(string, PipelineLike)

Paramètres

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

Paramètres

BlockBlobClient(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

commitBlockList(string[], BlockBlobCommitBlockListOptions)

Paramètres

Retours

getBlockList(BlockListType, BlockBlobGetBlockListOptions)

Paramètres

Retours

query(string, BlockBlobQueryOptions)

Paramètres

Retours

stageBlock(string, RequestBodyType, number, BlockBlobStageBlockOptions)

Paramètres

Retours

stageBlockFromURL(string, string, number, number, BlockBlobStageBlockFromURLOptions)

Paramètres

Retours

syncUploadFromURL(string, BlockBlobSyncUploadFromURLOptions)

Paramètres

Retours

upload(RequestBodyType, number, BlockBlobUploadOptions)

Paramètres

Retours

uploadBrowserData(Blob | ArrayBuffer | ArrayBufferView, BlockBlobParallelUploadOptions)

Paramètres

Retours

uploadData(Blob | ArrayBuffer | ArrayBufferView | Buffer, BlockBlobParallelUploadOptions)

Paramètres

Retours

uploadFile(string, BlockBlobParallelUploadOptions)

Paramètres

Retours

uploadStream(Readable, number, number, BlockBlobUploadStreamOptions)

Paramètres

Retours

withSnapshot(string)

Paramètres

Retours

Détails de la méthode héritée

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)