DirectoryListHandlesOptionalParams interface

Paket:

@azure/storage-file

Optionale Parameter.

Extends

RequestOptionsBase

Eigenschaften

marker	Ein Zeichenfolgenwert, der den Teil der Liste angibt, der mit dem nächsten Auflistungsvorgang zurückgegeben wird. Der Vorgang gibt im Antworttext einen Markerwert zurück, wenn die zurückgegebene Liste nicht vollständig war. Der Markerwert kann in einem folgenden Aufruf verwendet werden, um den nächsten Satz von Listenelementen anzufordern. Der Markerwert ist für den Client nicht transparent.
maxresults	Gibt die maximale Anzahl der zurückzugebenden Einträge an. Wenn die Anforderung maxresults nicht angibt oder einen Wert größer als 5.000 angibt, gibt der Server bis zu 5.000 Elemente zurück.
recursive	Gibt an, dass der Vorgang auf das im URI angegebene Verzeichnis, seine Dateien, seine Unterverzeichnisse und deren Dateien angewendet werden soll.
sharesnapshot	Der snapshot-Parameter ist ein undurchsichtiger DateTime-Wert, der, sofern vorhanden, die abzufragende Freigabemomentaufnahme angibt.
timeoutParameter	Der timeout-Parameter wird in Sekunden angegeben. Weitere Informationen finden Sie unter Festlegen von Timeouts für Dateidienstvorgänge.

Geerbte Eigenschaften

abortSignal	Das Signal, das zum Abbrechen von Anforderungen verwendet werden kann.
customHeaders	Benutzerdefinierte Anforderungsheader, die angewendet werden, bevor die Anforderung gesendet wird.
onDownloadProgress	Rückruf, der beim Downloadfortschritt ausgelöst wird.
onUploadProgress	Rückruf, der beim Uploadvorgang ausgelöst wird.
timeout	Die Anzahl von Millisekunden, die eine Anforderung dauern kann, bevor sie automatisch beendet wird.

Details zur Eigenschaft

marker

Ein Zeichenfolgenwert, der den Teil der Liste angibt, der mit dem nächsten Auflistungsvorgang zurückgegeben wird. Der Vorgang gibt im Antworttext einen Markerwert zurück, wenn die zurückgegebene Liste nicht vollständig war. Der Markerwert kann in einem folgenden Aufruf verwendet werden, um den nächsten Satz von Listenelementen anzufordern. Der Markerwert ist für den Client nicht transparent.

marker?: string

Eigenschaftswert

string

maxresults

Gibt die maximale Anzahl der zurückzugebenden Einträge an. Wenn die Anforderung maxresults nicht angibt oder einen Wert größer als 5.000 angibt, gibt der Server bis zu 5.000 Elemente zurück.

maxresults?: number

Eigenschaftswert

number

recursive

Gibt an, dass der Vorgang auf das im URI angegebene Verzeichnis, seine Dateien, seine Unterverzeichnisse und deren Dateien angewendet werden soll.

recursive?: boolean

Eigenschaftswert

boolean

sharesnapshot

Der snapshot-Parameter ist ein undurchsichtiger DateTime-Wert, der, sofern vorhanden, die abzufragende Freigabemomentaufnahme angibt.

sharesnapshot?: string

Eigenschaftswert

string

timeoutParameter

Der timeout-Parameter wird in Sekunden angegeben. Weitere Informationen finden Sie unter Festlegen von Timeouts für Dateidienstvorgänge.

timeoutParameter?: number

Eigenschaftswert

number

Geerbte Eigenschaftsdetails

abortSignal

Das Signal, das zum Abbrechen von Anforderungen verwendet werden kann.

abortSignal?: AbortSignalLike

Eigenschaftswert

AbortSignalLike

Geerbt von msRest.RequestOptionsBase.abortSignal

customHeaders

Benutzerdefinierte Anforderungsheader, die angewendet werden, bevor die Anforderung gesendet wird.

customHeaders?: {[key: string]: string}

Eigenschaftswert

{[key: string]: string}

Geerbt von msRest.RequestOptionsBase.customHeaders

onDownloadProgress

Rückruf, der beim Downloadfortschritt ausgelöst wird.

onDownloadProgress?: (progress: TransferProgressEvent) => void

Eigenschaftswert

(progress: TransferProgressEvent) => void

Geerbt von msRest.RequestOptionsBase.onDownloadProgress

onUploadProgress

Rückruf, der beim Uploadvorgang ausgelöst wird.

onUploadProgress?: (progress: TransferProgressEvent) => void

Eigenschaftswert

(progress: TransferProgressEvent) => void

Geerbt von msRest.RequestOptionsBase.onUploadProgress

timeout

Die Anzahl von Millisekunden, die eine Anforderung dauern kann, bevor sie automatisch beendet wird.

timeout?: number

Eigenschaftswert

number

Geerbt von msRest.RequestOptionsBase.timeout