AppendBlobClient class

Crée une instance d’AppendBlobClient. Cette méthode accepte une URL encodée ou une URL non codée pointant vers un objet blob d’ajout. 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 AppendBlobClient(url: string, pipeline: PipelineLike)

Paramètres

Crée une instance d’AppendBlobClient. Cette méthode accepte une URL encodée ou une URL non codée pointant vers un objet blob d’ajout. 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 AppendBlobClient(url: string, credential: StorageSharedKeyCredential | AnonymousCredential | TokenCredential, options?: StoragePipelineOptions)

Paramètres

Crée une instance d’AppendBlobClient.

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

Paramètres

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

string containerName

Valeur de propriété

Nom de l’objet blob.

string name

Valeur de propriété

accountName: string

Valeur de propriété

héritée deBlobClient.accountName

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

credential: StorageSharedKeyCredential | AnonymousCredential | TokenCredential

Valeur de propriété

héritée deBlobClient.credential

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

url: string

Valeur de propriété

héritée deBlobClient.url

Valide un nouveau bloc de données à la fin de l’objet blob d’ajout existant.

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

function appendBlock(body: RequestBodyType, contentLength: number, options?: AppendBlobAppendBlockOptions): Promise<AppendBlobAppendBlockResponse>

Paramètres

const content = "Hello World!";

// Create a new append blob and append data to the blob.
const newAppendBlobClient = containerClient.getAppendBlobClient("<blob name>");
await newAppendBlobClient.create();
await newAppendBlobClient.appendBlock(content, content.length);

// Append data to an existing append blob.
const existingAppendBlobClient = containerClient.getAppendBlobClient("<blob name>");
await existingAppendBlobClient.appendBlock(content, content.length);

Retours

L’opération Append Block valide un nouveau bloc de données à la fin d’un objet blob d’ajout existant où le contenu est lu à partir d’une URL source.

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

function appendBlockFromURL(sourceURL: string, sourceOffset: number, count: number, options?: AppendBlobAppendBlockFromURLOptions): Promise<AppendBlobAppendBlockFromUrlResponse>

Paramètres

Retours

Crée un objet blob d’ajout de 0 longueur. Appelez AppendBlock pour ajouter des données à un objet blob d’ajout.

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

function create(options?: AppendBlobCreateOptions): Promise<AppendBlobCreateResponse>

Paramètres

const appendBlobClient = containerClient.getAppendBlobClient("<blob name>");
await appendBlobClient.create();

Retours

Crée un objet blob d’ajout de 0 longueur. Appelez AppendBlock pour ajouter des données à un objet blob d’ajout. Si l’objet blob portant le même nom existe déjà, le contenu de l’objet blob existant reste inchangé.

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

function createIfNotExists(options?: AppendBlobCreateIfNotExistsOptions): Promise<AppendBlobCreateIfNotExistsResponse>

Paramètres

Retours

Scelle l’objet blob d’ajout, ce qui le rend en lecture seule.

function seal(options?: AppendBlobSealOptions): Promise<AppendBlobAppendBlockResponse>

Paramètres

Retours

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

function withSnapshot(snapshot: string): AppendBlobClient

Paramètres

Retours

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

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

Retours

héritée deBlobClient.abortCopyFromURL

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

Retours

héritée deBlobClient.beginCopyFromURL

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

Retours

héritée deBlobClient.createSnapshot

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

Retours

héritée deBlobClient.delete

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

Retours

héritée deBlobClient.deleteIfExists

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

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

Paramètres

Retours

héritée deBlobClient.deleteImmutabilityPolicy

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

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

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

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

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

Retours

héritée deBlobClient.download

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

Retours

héritée deBlobClient.downloadToBuffer

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(offset?: number, count?: number, options?: BlobDownloadToBufferOptions): Promise<Buffer>

Paramètres

Retours

héritée deBlobClient.downloadToBuffer

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

Retours

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

héritée deBlobClient.downloadToFile

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

Retours

héritée deBlobClient.existe

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

Retours

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

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

Retours

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

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

Retours

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

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

Retours

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

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

Retours

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

héritée deBlobClient.getAccountInfo

Crée un objet AppendBlobClient.

function getAppendBlobClient(): AppendBlobClient

Retours

héritée deBlobClient.getAppendBlobClient

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

function getBlobLeaseClient(proposeLeaseId?: string): BlobLeaseClient

Paramètres

Retours

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

héritée deBlobClient.getBlobLeaseClient

Crée un objet BlockBlobClient.

function getBlockBlobClient(): BlockBlobClient

Retours

héritée deBlobClient.getBlockBlobClient

Crée un objet PageBlobClient.

function getPageBlobClient(): PageBlobClient

Retours

héritée deBlobClient.getPageBlobClient

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

Retours

héritée deBlobClient.getProperties

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

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

Paramètres

Retours

héritée deBlobClient.getTags

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

Retours

héritée deBlobClient.setAccessTier

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

Retours

héritée deBlobClient.setHTTPHeaders

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

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

Paramètres

Retours

héritée deBlobClient.setImmutabilityPolicy

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

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

Paramètres

Retours

héritée deBlobClient.setLegalHold

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

Retours

héritée deBlobClient.setMetadata

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

Retours

héritée deBlobClient.setTags

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

Retours

héritée deBlobClient.syncCopyFromURL

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

Retours

héritée deBlobClient.undelete

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

Retours

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

héritée deBlobClient.withVersion