PageBlobClient class

Référence

Paquet:: @azure/storage-blob

PageBlobClient définit un ensemble d’opérations applicables aux objets blob de pages.

Extends: BlobClient

Constructeurs

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

Propriétés

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

Méthodes

abortCopyFromURL(string, BlobAbortCopyFromURLOptions)	Annule une opération de copie asynchrone d’objet blob en attente et laisse un objet blob de destination avec des métadonnées de longueur nulle et complète. Version du 12.02.12 et ultérieure.
beginCopyFromURL(string, BlobBeginCopyFromURLOptions)	Copie de manière asynchrone un objet blob vers une destination dans le compte de stockage. Cette méthode retourne un polleur d’opération de longue durée qui vous permet d’attendre indéfiniment jusqu’à ce que la copie soit terminée. Vous pouvez également annuler une copie avant qu’elle ne soit terminée en appelant `cancelOperation` sur l’polleur. Notez que le rappel onProgress n’est pas appelé si l’opération se termine dans la première requête, et que la tentative d’annulation d’une copie terminée entraîne la levée d’une erreur. Dans les versions 2012-02-12 et ultérieures, la source d’une opération de copie d’objet blob peut être un objet blob validé dans n’importe quel compte de stockage Azure. À compter de la version 2015-02-21, la source d’une opération De copie d’objet blob peut être un fichier Azure dans n’importe quel compte de stockage Azure. Seuls les comptes de stockage créés à partir du 7 juin 2012 autorisent l'opération de copie d'objets blob à partir d'un autre compte de stockage.
clearPages(number, number, PageBlobClearPagesOptions)	Libère les pages spécifiées de l’objet blob de pages.
create(number, PageBlobCreateOptions)	Crée un objet blob de page de la longueur spécifiée. Appelez uploadPages pour charger des données dans un objet blob de pages.
createIfNotExists(number, PageBlobCreateIfNotExistsOptions)	Crée un objet blob de page de la longueur spécifiée. Appelez uploadPages pour charger des données dans un objet blob de pages. Si l’objet blob portant le même nom existe déjà, le contenu de l’objet blob existant reste inchangé.
createSnapshot(BlobCreateSnapshotOptions)	Crée un instantané en lecture seule d'un objet 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.
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.
deleteImmutabilityPolicy(BlobDeleteImmutabilityPolicyOptions)	Supprimez la stratégie d’immutablility sur l’objet blob.
download(number, number, BlobDownloadOptions)	Lit ou télécharge un objet blob à partir du système, y compris ses métadonnées et ses propriétés. Vous pouvez également appeler Get Blob pour lire un instantané. Dans Node.js, les données retournent dans un flux lisibleStreamBody Dans les navigateurs, les données retournent dans une promesse blobBody
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 <xref: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 <xref: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, passez 0 et non défini respectivement 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 dans le cas contraire. REMARQUE : utilisez cette fonction avec précaution, 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é (SAS) du service Blob en fonction des propriétés clientes et des paramètres passés. La signature d’accès partagé est signée par les informations d’identification de clé partagée du client.
getAppendBlobClient()	Crée un objet AppendBlobClient.
getBlobLeaseClient(string)	Obtenez un <xref:BlobLeaseClient> qui gère les baux sur l’objet blob.
getBlockBlobClient()	Crée un objet BlockBlobClient.
getPageBlobClient()	Crée un objet PageBlobClient.
getPageRanges(number, number, PageBlobGetPageRangesOptions)	Retourne la liste des plages de pages valides pour un objet blob de pages ou un instantané d’un objet blob de pages.
getPageRangesDiff(number, number, string, PageBlobGetPageRangesDiffOptions)	Obtient la collection de plages de pages qui diffèrent entre un instantané spécifié et cet objet blob de pages.
getPageRangesDiffForManagedDisks(number, number, string, PageBlobGetPageRangesDiffOptions)	Obtient la collection de plages de pages qui diffèrent entre un instantané spécifié et cet objet blob de pages pour les disques managés.
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.
getTags(BlobGetTagsOptions)	Obtient les balises associées à l’objet blob sous-jacent.
resize(number, PageBlobResizeOptions)	Redimensionne l’objet blob de pages à la taille spécifiée (qui doit être un multiple de 512).
setAccessTier(BlockBlobTier \| PremiumPageBlobTier \| 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és 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.
setHTTPHeaders(BlobHTTPHeaders, BlobSetHTTPHeadersOptions)	Définit les propriétés système de l'objet blob. Si aucune valeur n’est fournie, ou si aucune valeur n’est fournie pour les en-têtes HTTP d’objet blob spécifiés, ces en-têtes HTTP d’objet blob sans valeur sont effacés.
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.
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 des étiquettes doivent être comprises entre 0 et 256 caractères. Les caractères de clé d’étiquette et de valeur valides incluent les lettres minuscules et majuscules, les chiffres (0-9), l’espace (''), plus ('+'), moins ('-'), le point ('.'), la barre oblique ('/'), les deux-points (':'), égal à ('=') et le trait de soulignement ('_') .
startCopyIncremental(string, PageBlobStartCopyIncrementalOptions)	Commence une opération pour démarrer une copie incrémentielle de l’instantané d’un objet blob de pages vers cet objet blob de pages. L’instantané est copié de telle sorte que seules les modifications différentielles entre l’instantané précédemment copié soient transférées vers la destination. Les instantanés copiés sont des copies complètes de l’instantané d’origine et peuvent être lus ou copiés comme d’habitude.
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.
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.
updateSequenceNumber(SequenceNumberActionType, number, PageBlobUpdateSequenceNumberOptions)	Définit le numéro séquentiel d’un objet blob de pages.
uploadPages(HttpRequestBody, number, number, PageBlobUploadPagesOptions)	Écrit 1 ou plusieurs pages dans l’objet blob de pages. Les décalages de début et de fin doivent être un multiple de 512.
uploadPagesFromURL(string, number, number, number, PageBlobUploadPagesFromURLOptions)	L’opération Charger des pages écrit une plage de pages dans un objet blob de pages où le contenu est lu à partir d’une URL.
withSnapshot(string)	Crée un objet PageBlobClient identique à la source, mais avec l’horodatage d’instantané spécifié. L’option « » supprime l’instantané et retourne un client à l’objet blob de base.
withVersion(string)	Crée un objet BlobClient pointant vers une version de cet objet blob. L’option « » supprime l’id de version et retourne un client à l’objet blob de base.

Détails du constructeur

PageBlobClient(string, PipelineLike)

Crée une instance de PageBlobClient.

new PageBlobClient(url: string, pipeline: PipelineLike)

Paramètres

url: string

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

pipeline: PipelineLike

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

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

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

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

Paramètres

url: string

credential: StorageSharedKeyCredential | AnonymousCredential | TokenCredential

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

options: StoragePipelineOptions

facultatif. Options pour configurer le pipeline HTTP.

PageBlobClient(string, string, string, StoragePipelineOptions)

Crée une instance de PageBlobClient.

new PageBlobClient(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

facultatif. Options pour configurer le pipeline HTTP.

Détails de la propriété

accountName

accountName: string

Valeur de propriété

string

containerName

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

string containerName

Valeur de propriété

string

credential

credential: StorageSharedKeyCredential | AnonymousCredential | TokenCredential

Valeur de propriété

StorageSharedKeyCredential | AnonymousCredential | TokenCredential

name

Nom de l'objet blob.

string name

Valeur de propriété

string

url

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

url: string

Valeur de propriété

string

Détails de la méthode

abortCopyFromURL(string, BlobAbortCopyFromURLOptions)

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

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

Paramètres

copyId: string

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

options: BlobAbortCopyFromURLOptions

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

Retours

Promise<BlobAbortCopyFromURLResponse>

beginCopyFromURL(string, BlobBeginCopyFromURLOptions)

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

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

Paramètres

copySource: string

url vers l’objet blob/fichier Azure source.

options: BlobBeginCopyFromURLOptions

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

Retours

Promise<PollerLike<PollOperationState<BlobBeginCopyFromURLResponse>, BlobBeginCopyFromURLResponse>>

clearPages(number, number, PageBlobClearPagesOptions)

Libère les pages spécifiées de l’objet blob de pages.

function clearPages(offset?: number, count?: number, options?: PageBlobClearPagesOptions)

Paramètres

offset: number

Position d’octet de départ des pages à effacer.

count: number

Nombre d’octets à effacer.

options: PageBlobClearPagesOptions

Options de l’opération Effacer les pages d’objet blob de page.

Retours

Promise<PageBlobClearPagesResponse>

Données de réponse pour l’opération Effacer les pages d’objet blob de page.

create(number, PageBlobCreateOptions)

Crée un objet blob de page de la longueur spécifiée. Appelez uploadPages pour charger des données dans un objet blob de pages.

function create(size: number, options?: PageBlobCreateOptions)

Paramètres

size: number

taille de l’objet blob de page.

options: PageBlobCreateOptions

Options de l’opération Créer un objet blob de page.

Retours

Promise<PageBlobCreateResponse>

Données de réponse pour l’opération Création d’objet blob de page.

createIfNotExists(number, PageBlobCreateIfNotExistsOptions)

Crée un objet blob de page de la longueur spécifiée. Appelez uploadPages pour charger des données dans un objet blob de pages. Si l’objet blob portant le même nom existe déjà, le contenu de l’objet blob existant reste inchangé.

function createIfNotExists(size: number, options?: PageBlobCreateIfNotExistsOptions)

Paramètres

size: number

taille de l’objet blob de page.

options: PageBlobCreateIfNotExistsOptions

Retours

Promise<PageBlobCreateIfNotExistsResponse>

createSnapshot(BlobCreateSnapshotOptions)

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

function createSnapshot(options?: BlobCreateSnapshotOptions)

Paramètres

options: BlobCreateSnapshotOptions

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

Retours

Promise<BlobCreateSnapshotResponse>

delete(BlobDeleteOptions)

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

function delete(options?: BlobDeleteOptions)

Paramètres

options: BlobDeleteOptions

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

Retours

Promise<BlobDeleteResponse>

deleteIfExists(BlobDeleteOptions)

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

function deleteIfExists(options?: BlobDeleteOptions)

Paramètres

options: BlobDeleteOptions

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

Retours

Promise<BlobDeleteIfExistsResponse>

deleteImmutabilityPolicy(BlobDeleteImmutabilityPolicyOptions)

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

function deleteImmutabilityPolicy(options?: BlobDeleteImmutabilityPolicyOptions)

Paramètres

options: BlobDeleteImmutabilityPolicyOptions

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

Retours

Promise<BlobDeleteImmutabilityPolicyResponse>

download(number, number, BlobDownloadOptions)

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

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

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

Paramètres

offset: number

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

count: number

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

options: BlobDownloadOptions

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

Exemple d’utilisation (Node.js) :

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

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

Exemple d’utilisation (navigateur) :

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

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

Retours

Promise<BlobDownloadResponseParsed>

downloadToBuffer(Buffer, number, number, BlobDownloadToBufferOptions)

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

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

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

Paramètres

buffer: Buffer

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

offset: number

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

count: number

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

options: BlobDownloadToBufferOptions

BlobDownloadToBufferOptions

Retours

Promise<Buffer>

downloadToBuffer(number, number, BlobDownloadToBufferOptions)

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

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échargement jusqu’à la fin lors de la transmission d’undefined

options: BlobDownloadToBufferOptions

BlobDownloadToBufferOptions

Retours

Promise<Buffer>

downloadToFile(string, number, number, BlobDownloadOptions)

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

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

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. Téléchargement jusqu’à la fin lors du passage non défini.

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 undefined, car son contenu est déjà lu et écrit dans un fichier local au chemin d’accès spécifié.

exists(BlobExistsOptions)

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

function exists(options?: BlobExistsOptions)

Paramètres

options: BlobExistsOptions

options de l’opération Exists.

Retours

Promise<boolean>

generateSasUrl(BlobGenerateSasUrlOptions)

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

function generateSasUrl(options: BlobGenerateSasUrlOptions)

Paramètres

options: BlobGenerateSasUrlOptions

Paramètres facultatifs.

Retours

Promise<string>

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

getAppendBlobClient()

Crée un objet AppendBlobClient.

function getAppendBlobClient()

Retours

AppendBlobClient

getBlobLeaseClient(string)

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

function getBlobLeaseClient(proposeLeaseId?: string)

Paramètres

proposeLeaseId: string

ID de bail initial proposé.

Retours

BlobLeaseClient

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

getBlockBlobClient()

Crée un objet BlockBlobClient.

function getBlockBlobClient()

Retours

BlockBlobClient

getPageBlobClient()

Crée un objet PageBlobClient.

function getPageBlobClient()

Retours

PageBlobClient

getPageRanges(number, number, PageBlobGetPageRangesOptions)

Retourne la liste des plages de pages valides pour un objet blob de pages ou un instantané d’un objet blob de pages.

function getPageRanges(offset?: number, count?: number, options?: PageBlobGetPageRangesOptions)

Paramètres

offset: number

Position d’octet de départ des plages de pages.

count: number

Nombre d’octets à obtenir.

options: PageBlobGetPageRangesOptions

Options de l’opération Obtenir des plages d’objets blob de pages.

Retours

Promise<PageBlobGetPageRangesResponse>

Données de réponse pour l’opération Obtenir des plages d’objets blob de pages.

getPageRangesDiff(number, number, string, PageBlobGetPageRangesDiffOptions)

Obtient la collection de plages de pages qui diffèrent entre un instantané spécifié et cet objet blob de pages.

function getPageRangesDiff(offset: number, count: number, prevSnapshot: string, options?: PageBlobGetPageRangesDiffOptions)

Paramètres

offset: number

Position d’octet de départ de l’objet blob de pages

count: number

Nombre d’octets pour obtenir des plages différentes.

prevSnapshot: string

Horodatage de l’instantané pour récupérer la différence.

options: PageBlobGetPageRangesDiffOptions

Options de l’opération De différences entre les plages de pages d’objet blob de pages.

Retours

Promise<PageBlobGetPageRangesDiffResponse>

Données de réponse pour l’opération Obtenir la différence de plage de pages de l’objet blob de pages.

getPageRangesDiffForManagedDisks(number, number, string, PageBlobGetPageRangesDiffOptions)

Obtient la collection de plages de pages qui diffèrent entre un instantané spécifié et cet objet blob de pages pour les disques managés.

function getPageRangesDiffForManagedDisks(offset: number, count: number, prevSnapshotUrl: string, options?: PageBlobGetPageRangesDiffOptions)

Paramètres

offset: number

Position d’octet de départ de l’objet blob de pages

count: number

Nombre d’octets pour obtenir des plages différentes.

prevSnapshotUrl: string

URL de l’instantané pour récupérer la différence.

options: PageBlobGetPageRangesDiffOptions

Options de l’opération De différences entre les plages de pages d’objet blob de pages.

Retours

Promise<PageBlobGetPageRangesDiffResponse>

Données de réponse pour l’opération Obtenir la différence de plage de pages de l’objet blob de pages.

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.

function getProperties(options?: BlobGetPropertiesOptions)

Paramètres

options: BlobGetPropertiesOptions

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

Retours

Promise<BlobGetPropertiesResponse>

getTags(BlobGetTagsOptions)

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

function getTags(options?: BlobGetTagsOptions)

Paramètres

options: BlobGetTagsOptions

Retours

Promise<BlobGetTagsResponse>

resize(number, PageBlobResizeOptions)

Redimensionne l’objet blob de pages à la taille spécifiée (qui doit être un multiple de 512).

function resize(size: number, options?: PageBlobResizeOptions)

Paramètres

size: number

Taille de la cible

options: PageBlobResizeOptions

Options de l’opération Redimensionnement de l’objet blob de pages.

Retours

Promise<PageBlobResizeResponse>

Données de réponse pour l’opération de redimensionnement de l’objet blob de pages.

setAccessTier(BlockBlobTier | PremiumPageBlobTier | 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és de l’objet blob. Le niveau d’un objet blob de blocs détermine le type de stockage Chaud/Froid/Archive. Cette opération ne met pas à jour l’ETag de l’objet blob.

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

Paramètres

tier: BlockBlobTier | PremiumPageBlobTier | string

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

options: BlobSetTierOptions

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

Retours

Promise<BlobSetTierResponse>

setHTTPHeaders(BlobHTTPHeaders, BlobSetHTTPHeadersOptions)

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

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

Paramètres

blobHTTPHeaders: BlobHTTPHeaders

Si aucune valeur n’est fournie, ou si aucune valeur n’est fournie pour les en-têtes HTTP d’objet blob spécifiés, ces en-têtes HTTP d’objet 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 de l’objet blob.

Retours

Promise<BlobSetHTTPHeadersResponse>

setImmutabilityPolicy(BlobImmutabilityPolicy, BlobSetImmutabilityPolicyOptions)

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

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

Paramètres

immutabilityPolicy: BlobImmutabilityPolicy

options: BlobSetImmutabilityPolicyOptions

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

Retours

Promise<BlobSetImmutabilityPolicyResponse>

setLegalHold(boolean, BlobSetLegalHoldOptions)

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

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

Paramètres

legalHoldEnabled: boolean

options: BlobSetLegalHoldOptions

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

Retours

Promise<BlobSetLegalHoldResponse>

setMetadata(Metadata, BlobSetMetadataOptions)

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

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

Paramètres

metadata: Metadata

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

options: BlobSetMetadataOptions

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

Retours

Promise<BlobSetMetadataResponse>

setTags(Tags, BlobSetTagsOptions)

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

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

Paramètres

tags: Tags

options: BlobSetTagsOptions

Retours

Promise<BlobSetTagsResponse>

startCopyIncremental(string, PageBlobStartCopyIncrementalOptions)

Commence une opération pour démarrer une copie incrémentielle de l’instantané d’un objet blob de pages vers cet objet blob de pages. L’instantané est copié de telle sorte que seules les modifications différentielles entre l’instantané précédemment copié soient transférées vers la destination. Les instantanés copiés sont des copies complètes de l’instantané d’origine et peuvent être lus ou copiés comme d’habitude.

function startCopyIncremental(copySource: string, options?: PageBlobStartCopyIncrementalOptions)

Paramètres

copySource: string

Spécifie le nom de l’instantané de l’objet blob de page source. Par exemple : https://myaccount.blob.core.windows.net/mycontainer/myblob?snapshot=

options: PageBlobStartCopyIncrementalOptions

Options de l’opération de copie incrémentielle de l’objet blob de pages.

Retours

Promise<PageBlobCopyIncrementalResponse>

Données de réponse pour l’opération de copie incrémentielle de l’objet blob de pages.

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.

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

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>

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.

function undelete(options?: BlobUndeleteOptions)

Paramètres

options: BlobUndeleteOptions

Options facultatives de l’opération Annuler la suppression de l’objet blob.

Retours

Promise<BlobUndeleteResponse>

updateSequenceNumber(SequenceNumberActionType, number, PageBlobUpdateSequenceNumberOptions)

Définit le numéro séquentiel d’un objet blob de pages.

function updateSequenceNumber(sequenceNumberAction: SequenceNumberActionType, sequenceNumber?: number, options?: PageBlobUpdateSequenceNumberOptions)

Paramètres

sequenceNumberAction: SequenceNumberActionType

Indique comment le service doit modifier le numéro séquentiel de l’objet blob.

sequenceNumber: number

Obligatoire si sequenceNumberAction est max ou update

options: PageBlobUpdateSequenceNumberOptions

Options de l’opération Numéro séquentiel de mise à jour de l’objet blob de pages.

Retours

Promise<PageBlobUpdateSequenceNumberResponse>

Données de réponse pour l’opération Numéro séquentiel de mise à jour de l’objet blob de pages.

uploadPages(HttpRequestBody, number, number, PageBlobUploadPagesOptions)

Écrit 1 ou plusieurs pages dans l’objet blob de pages. Les décalages de début et de fin doivent être un multiple de 512.

function uploadPages(body: HttpRequestBody, offset: number, count: number, options?: PageBlobUploadPagesOptions)

Paramètres

body: HttpRequestBody

Données à charger

offset: number

Décalage de l’objet blob de page de destination

count: number

Longueur du contenu du corps, également nombre d’octets à charger

options: PageBlobUploadPagesOptions

Options de l’opération Charger des pages d’objet blob de page.

Retours

Promise<PageBlobUploadPagesResponse>

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

uploadPagesFromURL(string, number, number, number, PageBlobUploadPagesFromURLOptions)

L’opération Charger des pages écrit une plage de pages dans un objet blob de pages où le contenu est lu à partir d’une URL.

function uploadPagesFromURL(sourceURL: string, sourceOffset: number, destOffset: number, count: number, options?: PageBlobUploadPagesFromURLOptions)

Paramètres

sourceURL: string

Spécifier une URL vers la source de copie, signature d’accès partagé (SAS) peut être nécessaire pour l’authentification

sourceOffset: number

Décalage source à partir duquel effectuer la copie. Passer 0 pour copier à partir du début de l’objet blob de page source

destOffset: number

Décalage de l’objet blob de page de destination

count: number

Nombre d’octets à charger à partir de l’objet blob de page source

options: PageBlobUploadPagesFromURLOptions

Retours

Promise<PageBlobUploadPagesFromURLResponse>

withSnapshot(string)

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

function withSnapshot(snapshot: string)

Paramètres

snapshot: string

Horodatage de l’instantané.

Retours

PageBlobClient

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

withVersion(string)

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

function withVersion(versionId: string)

Paramètres

versionId: string

VersionId.

Retours

BlobClient

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

Partager via

PageBlobClient class

Constructeurs

Propriétés

Méthodes

Détails du constructeur

PageBlobClient(string, PipelineLike)

Paramètres

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

Paramètres

PageBlobClient(string, string, string, StoragePipelineOptions)

Paramètres

Détails de la propriété

accountName

Valeur de propriété

containerName

Valeur de propriété

credential

Valeur de propriété

name

Valeur de propriété

url

Valeur de propriété

Détails de la méthode

abortCopyFromURL(string, BlobAbortCopyFromURLOptions)

Paramètres

Retours

beginCopyFromURL(string, BlobBeginCopyFromURLOptions)

Paramètres

Retours

clearPages(number, number, PageBlobClearPagesOptions)

Paramètres

Retours

create(number, PageBlobCreateOptions)

Paramètres

Retours

createIfNotExists(number, PageBlobCreateIfNotExistsOptions)

Paramètres

Retours

createSnapshot(BlobCreateSnapshotOptions)

Paramètres

Retours

delete(BlobDeleteOptions)

Paramètres

Retours

deleteIfExists(BlobDeleteOptions)

Paramètres

Retours

deleteImmutabilityPolicy(BlobDeleteImmutabilityPolicyOptions)

Paramètres

Retours

download(number, number, BlobDownloadOptions)

Paramètres

Retours

downloadToBuffer(Buffer, number, number, BlobDownloadToBufferOptions)

Paramètres

Retours

downloadToBuffer(number, number, BlobDownloadToBufferOptions)

Paramètres

Retours

downloadToFile(string, number, number, BlobDownloadOptions)

Paramètres

Retours

exists(BlobExistsOptions)

Paramètres

Retours

generateSasUrl(BlobGenerateSasUrlOptions)

Paramètres

Retours

getAppendBlobClient()

Retours

getBlobLeaseClient(string)

Paramètres

Retours

getBlockBlobClient()

Retours

getPageBlobClient()

Retours

getPageRanges(number, number, PageBlobGetPageRangesOptions)

Paramètres