Partager via

BlobDownloadOptions interface

  • Référence
Paquet:
@azure/storage-blob

Options pour configurer l’opération de téléchargement .

Extends
CommonOptions

Propriétés

abortSignal

Implémentation de l’interface AbortSignalLike pour signaler la demande d’annulation de l’opération. Par exemple, utilisez le @azure/abort-controller pour créer un AbortSignal.
conditions

Conditions à remplir lors du téléchargement d’objets blob.
customerProvidedKey

Informations de clé fournies par le client.
maxRetryRequests

Optionnel. DISPONIBLE UNIQUEMENT DANS NODE.JS.

Nombre de nouvelles tentatives effectuées lorsque le flux de téléchargement du corps d’origine se termine de façon inattendue. Le type de terminaison ci-dessus ne déclenche pas la stratégie de nouvelle tentative définie dans un pipeline, car elles n’émettent pas d’erreurs réseau.

Avec cette option, chaque nouvelle tentative supplémentaire signifie qu’une demande supplémentaire FileClient.download() est effectuée à partir du point de rupture, jusqu’à ce que la plage demandée ait été correctement téléchargée ou que maxRetryRequests soit atteint.

La valeur par défaut est 5. Définissez une valeur plus élevée lors du chargement de fichiers volumineux dans un réseau médiocre.
onProgress

Rappelez-vous pour recevoir des événements sur la progression de l’opération de téléchargement.
rangeGetContentCrc64

Lorsque cette valeur est définie sur true et que la plage de téléchargement de l’objet blob est téléchargée, le service retourne le hachage CRC64 pour la plage, tant que la plage a une taille inférieure ou égale à 4 Mo.

rangeGetContentCrc64 et rangeGetContentMD5 ne peuvent pas être définis en même temps.
rangeGetContentMD5

Lorsque cette valeur est définie sur true et que la plage de téléchargement de l’objet blob est téléchargée, le service retourne le hachage MD5 pour la plage, tant que la plage est inférieure ou égale à 4 Mo.

rangeGetContentCrc64 et rangeGetContentMD5 ne peuvent pas être définis en même temps.
snapshot

Valeur de chaîne DateTime opaque qui, lorsqu’elle est présente, spécifie l’instantané d’objet blob à récupérer.

Propriétés héritées

tracingOptions

Options de configuration des étendues créées lorsque le suivi est activé.

Détails de la propriété

abortSignal

Implémentation de l’interface AbortSignalLike pour signaler la demande d’annulation de l’opération. Par exemple, utilisez le @azure/abort-controller pour créer un AbortSignal.

abortSignal?: AbortSignalLike

Valeur de propriété

AbortSignalLike

conditions

Conditions à remplir lors du téléchargement d’objets blob.

conditions?: BlobRequestConditions

Valeur de propriété

BlobRequestConditions

customerProvidedKey

Informations de clé fournies par le client.

customerProvidedKey?: CpkInfo

Valeur de propriété

CpkInfo

maxRetryRequests

Optionnel. DISPONIBLE UNIQUEMENT DANS NODE.JS.

Nombre de nouvelles tentatives effectuées lorsque le flux de téléchargement du corps d’origine se termine de façon inattendue. Le type de terminaison ci-dessus ne déclenche pas la stratégie de nouvelle tentative définie dans un pipeline, car elles n’émettent pas d’erreurs réseau.

Avec cette option, chaque nouvelle tentative supplémentaire signifie qu’une demande supplémentaire FileClient.download() est effectuée à partir du point de rupture, jusqu’à ce que la plage demandée ait été correctement téléchargée ou que maxRetryRequests soit atteint.

La valeur par défaut est 5. Définissez une valeur plus élevée lors du chargement de fichiers volumineux dans un réseau médiocre.

maxRetryRequests?: number

Valeur de propriété

number

onProgress

Rappelez-vous pour recevoir des événements sur la progression de l’opération de téléchargement.

onProgress?: (progress: TransferProgressEvent) => void

Valeur de propriété

(progress: TransferProgressEvent) => void

rangeGetContentCrc64

Lorsque cette valeur est définie sur true et que la plage de téléchargement de l’objet blob est téléchargée, le service retourne le hachage CRC64 pour la plage, tant que la plage a une taille inférieure ou égale à 4 Mo.

rangeGetContentCrc64 et rangeGetContentMD5 ne peuvent pas être définis en même temps.

rangeGetContentCrc64?: boolean

Valeur de propriété

boolean

rangeGetContentMD5

Lorsque cette valeur est définie sur true et que la plage de téléchargement de l’objet blob est téléchargée, le service retourne le hachage MD5 pour la plage, tant que la plage est inférieure ou égale à 4 Mo.

rangeGetContentCrc64 et rangeGetContentMD5 ne peuvent pas être définis en même temps.

rangeGetContentMD5?: boolean

Valeur de propriété

boolean

snapshot

Valeur de chaîne DateTime opaque qui, lorsqu’elle est présente, spécifie l’instantané d’objet blob à récupérer.

snapshot?: string

Valeur de propriété

string

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

tracingOptions

Options de configuration des étendues créées lorsque le suivi est activé.

tracingOptions?: OperationTracingOptions

Valeur de propriété

OperationTracingOptions

Hérité deCommonOptions.tracingOptions