BlobDownloadOptions interface

Paket:

@azure/storage-blob

Optionen zum Konfigurieren des Download- Vorgangs.

Extends

CommonOptions

Eigenschaften

abortSignal	Eine Implementierung der AbortSignalLike Schnittstelle, um die Anforderung zum Abbrechen des Vorgangs zu signalisieren. Verwenden Sie beispielsweise den @azure/Abort-Controller, um eine AbortSignalzu erstellen.
conditions	Bedingungen, die beim Herunterladen von Blobs erfüllt werden sollen.
customerProvidedKey	Der Kunde hat wichtige Informationen bereitgestellt.
maxRetryRequests	Wahlfrei. NUR IN NODE.JS VERFÜGBAR. Wie viele Wiederholungen ausgeführt werden, wenn der ursprüngliche Textkörperdownloadstream unerwartet endet. Oberhalb der Art von Enden wird keine Wiederholungsrichtlinie ausgelöst, die in einer Pipeline definiert ist, da sie keine Netzwerkfehler ausgeben. Bei dieser Option bedeutet jeder zusätzliche Wiederholungsversuch, dass eine zusätzliche FileClient.download() Anforderung vom fehlerhaften Punkt aus vorgenommen wird, bis der angeforderte Bereich erfolgreich heruntergeladen wurde oder maxRetryRequests erreicht ist. Der Standardwert ist 5, bitte legen Sie einen größeren Wert fest, wenn große Dateien in einem schlechten Netzwerk geladen werden.
onProgress	Rufen Sie zurück, um Ereignisse zum Fortschritt des Downloadvorgangs zu empfangen.
rangeGetContentCrc64	Wenn dies auf "true" und "Downloadbereich" festgelegt ist, gibt der Dienst den CRC64-Hash für den Bereich zurück, solange der Bereich kleiner oder gleich 4 MB groß ist. rangeGetContentCrc64 und rangeGetContentMD5 können nicht gleichzeitig festgelegt werden.
rangeGetContentMD5	Wenn dies auf "true" und "Downloadbereich" des BLOB festgelegt ist, gibt der Dienst den MD5-Hash für den Bereich zurück, solange der Bereich kleiner oder gleich 4 MB groß ist. rangeGetContentCrc64 und rangeGetContentMD5 können nicht gleichzeitig festgelegt werden.
snapshot	Ein undurchsichtiger DateTime-Zeichenfolgenwert, der, wenn vorhanden, die blob-Momentaufnahme angibt, die abgerufen werden soll.

Geerbte Eigenschaften

tracingOptions

Optionen zum Konfigurieren von Spans created when tracing is enabled.

Details zur Eigenschaft

abortSignal

Eine Implementierung der AbortSignalLike Schnittstelle, um die Anforderung zum Abbrechen des Vorgangs zu signalisieren. Verwenden Sie beispielsweise den @azure/Abort-Controller, um eine AbortSignalzu erstellen.

abortSignal?: AbortSignalLike

Eigenschaftswert

AbortSignalLike

conditions

Bedingungen, die beim Herunterladen von Blobs erfüllt werden sollen.

conditions?: BlobRequestConditions

Eigenschaftswert

BlobRequestConditions

customerProvidedKey

Der Kunde hat wichtige Informationen bereitgestellt.

customerProvidedKey?: CpkInfo

Eigenschaftswert

CpkInfo

maxRetryRequests

Wahlfrei. NUR IN NODE.JS VERFÜGBAR.

Wie viele Wiederholungen ausgeführt werden, wenn der ursprüngliche Textkörperdownloadstream unerwartet endet. Oberhalb der Art von Enden wird keine Wiederholungsrichtlinie ausgelöst, die in einer Pipeline definiert ist, da sie keine Netzwerkfehler ausgeben.

Bei dieser Option bedeutet jeder zusätzliche Wiederholungsversuch, dass eine zusätzliche FileClient.download() Anforderung vom fehlerhaften Punkt aus vorgenommen wird, bis der angeforderte Bereich erfolgreich heruntergeladen wurde oder maxRetryRequests erreicht ist.

Der Standardwert ist 5, bitte legen Sie einen größeren Wert fest, wenn große Dateien in einem schlechten Netzwerk geladen werden.

maxRetryRequests?: number

Eigenschaftswert

number

onProgress

Rufen Sie zurück, um Ereignisse zum Fortschritt des Downloadvorgangs zu empfangen.

onProgress?: (progress: TransferProgressEvent) => void

Eigenschaftswert

(progress: TransferProgressEvent) => void

rangeGetContentCrc64

Wenn dies auf "true" und "Downloadbereich" festgelegt ist, gibt der Dienst den CRC64-Hash für den Bereich zurück, solange der Bereich kleiner oder gleich 4 MB groß ist.

rangeGetContentCrc64 und rangeGetContentMD5 können nicht gleichzeitig festgelegt werden.

rangeGetContentCrc64?: boolean

Eigenschaftswert

boolean

rangeGetContentMD5

Wenn dies auf "true" und "Downloadbereich" des BLOB festgelegt ist, gibt der Dienst den MD5-Hash für den Bereich zurück, solange der Bereich kleiner oder gleich 4 MB groß ist.

rangeGetContentCrc64 und rangeGetContentMD5 können nicht gleichzeitig festgelegt werden.

rangeGetContentMD5?: boolean

Eigenschaftswert

boolean

snapshot

Ein undurchsichtiger DateTime-Zeichenfolgenwert, der, wenn vorhanden, die blob-Momentaufnahme angibt, die abgerufen werden soll.

snapshot?: string

Eigenschaftswert

string

Geerbte Eigenschaftsdetails

tracingOptions

Optionen zum Konfigurieren von Spans created when tracing is enabled.

tracingOptions?: OperationTracingOptions

Eigenschaftswert

OperationTracingOptions

von"CommonOptions.tracingOptions" geerbt