Partager via


FileDownloadOptions interface

Options de configuration du fichier - Opérations de téléchargement.

Consultez l'article :

Extends

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.

leaseAccessConditions

Conditions d’accès au bail.

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. Les fins ci-dessus ne déclenchent 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 requête ShareFileClient.download() supplémentaire sera effectuée à partir du point cassé, 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

Télécharger le gestionnaire d’événements de mise à jour de la progression.

rangeGetContentMD5

Lorsque cet en-tête est défini sur true et spécifié avec l’en-tête Range, le service retourne le hachage MD5 pour la plage, tant que la plage est inférieure ou égale à 4 Mo.

Propriétés héritées

tracingOptions

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é

leaseAccessConditions

Conditions d’accès au bail.

leaseAccessConditions?: LeaseAccessConditions

Valeur de propriété

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. Les fins ci-dessus ne déclenchent 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 requête ShareFileClient.download() supplémentaire sera effectuée à partir du point cassé, 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

Télécharger le gestionnaire d’événements de mise à jour de la progression.

onProgress?: (progress: TransferProgressEvent) => void

Valeur de propriété

(progress: TransferProgressEvent) => void

rangeGetContentMD5

Lorsque cet en-tête est défini sur true et spécifié avec l’en-tête Range, le service retourne le hachage MD5 pour la plage, tant que la plage est inférieure ou égale à 4 Mo.

rangeGetContentMD5?: boolean

Valeur de propriété

boolean

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

tracingOptions

tracingOptions?: OperationTracingOptions

Valeur de propriété

Hérité deCommonOptions.tracingOptions