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 non encodée pointant vers un objet blob de blocs. La chaîne d’URL encodée ne fera PAS l’objet d’une séquence d’échappement deux fois, seuls les caractères spéciaux dans le chemin d’accès de l’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.
BlockBlobClient(string, StorageSharedKeyCredential \| AnonymousCredential \| TokenCredential, StoragePipelineOptions)	Crée une instance de BlockBlobClient. Cette méthode accepte une URL encodée ou non encodée pointant vers un objet blob de blocs. La chaîne d’URL encodée ne fera PAS l’objet d’une séquence d’échappement deux fois, seuls les caractères spéciaux dans le chemin d’accès de l’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.
BlockBlobClient(string, string, string, StoragePipelineOptions)	Crée une instance de BlockBlobClient.

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	Telles que 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

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 stageBlock précédente. Vous pouvez appeler commitBlockList pour mettre à jour un objet blob en chargeant uniquement les blocs qui ont changé, puis en validant ensemble les blocs nouveaux et existants. 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, HttpRequestBody, 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 Étape Bloquer à partir de l’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 où le contenu de l’objet blob est lu à partir d’une URL donnée. Cette API est prise en charge à partir de la version 2020-04-08. Les mises à jour partielles ne sont pas prises en charge avec Put Blob from 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(HttpRequestBody, 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 de 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 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/File/ArrayBuffer/ArrayBufferView de navigateur dans l’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 appellera stageBlock pour charger des blocs, puis appellera commitBlockList pour valider la liste de blocs. Une option blobHTTPHeaders courante à 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 objet Buffer(Node.js)/Blob(browsers)/ArrayBuffer/ArrayBufferView dans un BlockBlob. Lorsque la longueur des données n’est pas supérieure à la valeur 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 appellera stageBlock pour charger des blocs, puis appellera commitBlockList pour valider la liste de blocs. Une option blobHTTPHeaders courante à 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 en 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 appellera stageBlock pour charger des blocs, puis appellera commitBlockList pour valider la liste de blocs.
uploadStream(Readable, number, number, BlockBlobUploadStreamOptions)	DISPONIBLE UNIQUEMENT DANS NODE.JS RUNTIME. Charge un flux Node.js accessible en lecture dans un objet blob de blocs. CONSEILS D’AMÉLIORATION DES PERFORMANCES : Le flux d’entrée highWaterMark est préférable de définir une même valeur avec le paramètre bufferSize, ce qui évitera 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 à l’objet blob de base.

Méthodes héritées

abortCopyFromURL(string, BlobAbortCopyFromURLOptions)	Abandonne une opération de copie asynchrone d’objet blob en attente et laisse un objet blob de destination avec aucune longueur et des métadonnées complètes. 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 pollueur 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 demande, 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 utilisant l’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 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 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 un objet 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 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 de copie synchrone de l’URL 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 de 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 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 que « » supprime l’id de version et retourne un client à 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 non encodée pointant vers un objet blob de blocs. La chaîne d’URL encodée ne fera PAS l’objet d’une séquence d’échappement deux fois, seuls les caractères spéciaux dans le chemin d’accès de l’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 BlockBlobClient(url: string, pipeline: PipelineLike)

Paramètres

url: string

Chaîne d’URL pointant vers l’objet blob de blocs stockage Azure, telle que «https://myaccount.blob.core.windows.net/mycontainer/blockblob" ; ». Vous pouvez ajouter une signature d’accès partagé si vous utilisez AnonymousCredential, par exemple «https://myaccount.blob.core.windows.net/mycontainer/blockblob?sasString" ; ». Cette méthode accepte une URL encodée ou non encodée pointant vers un objet blob. La chaîne d’URL encodée ne fera PAS l’objet d’une séquence d’échappement deux fois, seuls les caractères spéciaux dans le chemin d’accès de l’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é.

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

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

Paramètres

url: string

credential: StorageSharedKeyCredential | AnonymousCredential | TokenCredential

Telles que 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 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 -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 de configuration du 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é deBlobClient.accountName

credential

credential: StorageSharedKeyCredential | AnonymousCredential | TokenCredential

Valeur de propriété

StorageSharedKeyCredential | AnonymousCredential | TokenCredential

Hérité deBlobClient.credential

url

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

url: string

Valeur de propriété

string

Hérité 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 stageBlock précédente. Vous pouvez appeler commitBlockList pour mettre à jour un objet blob en chargeant uniquement les blocs qui ont changé, puis en validant ensemble les blocs nouveaux et existants. 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 d’une valeur de 64 octets codée en base64

options: BlockBlobCommitBlockListOptions

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

Retours

Promise<BlockBlobCommitBlockListResponse>

Données de réponse pour l’opération De validation de liste de blocs d’objets 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

Indique quelle liste retourner : liste des blocs validés, liste des blocs non validés ou ces deux listes.

options: BlockBlobGetBlockListOptions

Options de l’opération Obtenir la liste de blocs d’objets blob.

Retours

Promise<BlockBlobGetBlockListResponse>

Données de réponse pour l’opération Obtenir la liste de blocs d’objets 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, HttpRequestBody, 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: HttpRequestBody, 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 de préproduction.

contentLength: number

Nombre d’octets à charger.

options: BlockBlobStageBlockOptions

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

Retours

Promise<BlockBlobStageBlockResponse>

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

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

L’opération Étape Bloquer à partir de l’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 sous forme d'URL, comme dans une URI de demande. 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 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 lorsqu’il n’est pas défini

options: BlockBlobStageBlockFromURLOptions

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

Retours

Promise<BlockBlobStageBlockFromURLResponse>

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

syncUploadFromURL(string, BlockBlobSyncUploadFromURLOptions)

Crée un objet blob de blocs où le contenu de l’objet blob est lu à partir d’une URL donnée. Cette API est prise en charge à partir de la version 2020-04-08. Les mises à jour partielles ne sont pas prises en charge avec Put Blob from 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(HttpRequestBody, 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 de 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 de meilleures performances avec le chargement concurrentiel.

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

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

Paramètres

body: HttpRequestBody

Blob, string, ArrayBuffer, ArrayBufferView ou une fonction qui retourne un nouveau flux accessible en lecture dont le décalage provient 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 incluant des 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/File/ArrayBuffer/ArrayBufferView de navigateur dans l’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 appellera stageBlock pour charger des blocs, puis appellera commitBlockList pour valider la liste de blocs.

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

function uploadBrowserData(browserData: Blob | ArrayBuffer | ArrayBufferView, options?: BlockBlobParallelUploadOptions): 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 objet Buffer(Node.js)/Blob(browsers)/ArrayBuffer/ArrayBufferView dans un BlockBlob.

Lorsque la longueur des données n’est pas supérieure à la valeur 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 appellera stageBlock pour charger des blocs, puis appellera commitBlockList pour valider la liste de blocs.

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

function uploadData(data: 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 en 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 appellera stageBlock pour charger des blocs, puis appellera 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 pour charger 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 accessible en lecture dans un objet blob de blocs.

CONSEILS D’AMÉLIORATION DES PERFORMANCES :

Le flux d’entrée highWaterMark est préférable de définir une même valeur avec le paramètre bufferSize, ce qui évitera 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, ainsi que la taille de bloc dans l’objet blob de blocs chargé. La valeur par défaut est 8 Mo

maxConcurrency: number

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

options: BlockBlobUploadStreamOptions

Options de l’opération Charger un flux dans un 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 à l’objet blob de base.

function withSnapshot(snapshot: string): BlockBlobClient

Paramètres

snapshot: string

Horodatage de l’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 de copie asynchrone d’objet blob en attente et laisse un objet blob de destination avec aucune longueur et des métadonnées complètes. 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’abandon de copie à partir de l’URL de l’objet blob.

Retours

Promise<BlobAbortCopyFromURLResponse>

Hérité deBlobClient.abortCopyFromURL

beginCopyFromURL(string, BlobBeginCopyFromURLOptions)

Copie de manière asynchrone un objet blob vers une destination dans le compte de stockage. Cette méthode retourne un pollueur 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 demande, 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 utilisant l’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 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 de l’objet blob/fichier Azure source.

options: BlobBeginCopyFromURLOptions

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

Retours

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

Hérité 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 de l’opération Créer un 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 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 de l’opération De suppression d’objets blob.

Retours

Promise<BlobDeleteResponse>

Hérité deBlobClient.delete

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 de l’opération De suppression d’objets blob.

Retours

Promise<BlobDeleteIfExistsResponse>

Hérité deBlobClient.deleteIfExists

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>

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 objet 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 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 lorsqu’il n’est pas défini

options: BlobDownloadOptions

Options facultatives de 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 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>

Hérité deBlobClient.downloadToBuffer

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>

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

Hérité deBlobClient.downloadToFile

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>

Hérité deBlobClient.exists

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

Hérité deBlobClient.generateSasUrl

getAppendBlobClient()

Crée un objet AppendBlobClient.

function getAppendBlobClient(): AppendBlobClient

Retours

AppendBlobClient

Hérité 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é deBlobClient.getBlobLeaseClient

getBlockBlobClient()

Crée un objet BlockBlobClient.

function getBlockBlobClient(): BlockBlobClient

Retours

BlockBlobClient

Hérité deBlobClient.getBlockBlobClient

getPageBlobClient()

Crée un objet PageBlobClient.

function getPageBlobClient(): PageBlobClient

Retours

PageBlobClient

Hérité 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 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>

Hérité 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é 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 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>

Hérité deBlobClient.setAccessTier

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>

Hérité deBlobClient.setHTTPHeaders

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>

Hérité 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é deBlobClient.setLegalHold

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>

Hérité 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 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>

Hérité deBlobClient.setTags

syncCopyFromURL(string, BlobSyncCopyFromURLOptions)

L’opération de copie synchrone de l’URL 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 effectuer la copie, signature d’accès partagé (SAP) peut être nécessaire pour l’authentification

options: BlobSyncCopyFromURLOptions

Retours

Promise<BlobCopyFromURLResponse>

Hérité deBlobClient.syncCopyFromURL

undelete(BlobUndeleteOptions)

Restaure le contenu et les métadonnées de l’objet blob supprimé de manière réversible et de 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 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 de l’opération Annuler la suppression de l’objet blob.

Retours

Promise<BlobUndeleteResponse>

Hérité deBlobClient.undelete

withVersion(string)

Crée un objet BlobClient pointant vers une version de cet objet blob. Indiquez que « » 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.

Hérité deBlobClient.withVersion

Share 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, HttpRequestBody, number, BlockBlobStageBlockOptions)

Paramètres

Retours

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

Paramètres

Retours

syncUploadFromURL(string, BlockBlobSyncUploadFromURLOptions)

Paramètres

Retours

upload(HttpRequestBody, 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)