ServiceFabricClientGetServiceBackupListOptionalParams interface

Paket:

@azure/servicefabric

Optionale Parameter.

Extends

RequestOptionsBase

Eigenschaften

continuationToken	Der Fortsetzungstokenparameter wird verwendet, um den nächsten Satz von Ergebnissen abzurufen. Ein Fortsetzungstoken mit einem nicht leeren Wert ist in der Antwort der API enthalten, wenn die Ergebnisse des Systems nicht in eine einzelne Antwort passen. Wenn dieser Wert an den nächsten API-Aufruf übergeben wird, gibt die API den nächsten Satz von Ergebnissen zurück. Wenn keine weiteren Ergebnisse vorliegen, enthält das Fortsetzungstoken keinen Wert. Der Wert dieses Parameters sollte nicht URL-codiert sein.
endDateTimeFilter	Geben Sie die Enddatumszeit an, bis zu der Sicherungen im Datetime-Format aufgezählt werden sollen. Die Datumszeit muss im ISO8601 Format angegeben werden. Dies ist ein optionaler Parameter. Wenn nicht angegeben, erfolgt die Aufzählung bis zur letzten Sicherung.
latest	Gibt an, ob nur die neueste Sicherung für eine Partition für den angegebenen Zeitraum abgerufen werden soll. Standardwert: false.
maxResults	Die maximale Anzahl der Ergebnisse, die als Teil der seitenseitigen Abfragen zurückgegeben werden sollen. Dieser Parameter definiert die obere Grenze für die Anzahl der zurückgegebenen Ergebnisse. Die zurückgegebenen Ergebnisse können kleiner als die angegebenen maximalen Ergebnisse sein, wenn sie nicht gemäß den in der Konfiguration definierten Einschränkungen für die maximale Nachrichtengröße in die Nachricht passen. Wenn dieser Parameter null oder nicht angegeben ist, enthält die seitenseitige Abfrage so viele Ergebnisse wie möglich, die in die Rückgabenachricht passen. Standardwert: 0.
startDateTimeFilter	Geben Sie die Startdatumszeit an, von der Sicherungen im Datetime-Format aufgezählt werden sollen. Die Datumszeit muss im ISO8601 Format angegeben werden. Dies ist ein optionaler Parameter. Wenn nicht angegeben, werden alle Sicherungen von Anfang an aufgezählt.
timeoutParameter	Das Servertimeout für die Ausführung des Vorgangs in Sekunden. Dieses Timeout gibt die Zeitdauer an, die der Client bereit ist, auf den Abschluss des angeforderten Vorgangs zu warten. Der Standardwert für diesen Parameter beträgt 60 Sekunden. Standardwert: 60.

Geerbte Eigenschaften

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

Details zur Eigenschaft

continuationToken

Der Fortsetzungstokenparameter wird verwendet, um den nächsten Satz von Ergebnissen abzurufen. Ein Fortsetzungstoken mit einem nicht leeren Wert ist in der Antwort der API enthalten, wenn die Ergebnisse des Systems nicht in eine einzelne Antwort passen. Wenn dieser Wert an den nächsten API-Aufruf übergeben wird, gibt die API den nächsten Satz von Ergebnissen zurück. Wenn keine weiteren Ergebnisse vorliegen, enthält das Fortsetzungstoken keinen Wert. Der Wert dieses Parameters sollte nicht URL-codiert sein.

continuationToken?: string

Eigenschaftswert

string

endDateTimeFilter

Geben Sie die Enddatumszeit an, bis zu der Sicherungen im Datetime-Format aufgezählt werden sollen. Die Datumszeit muss im ISO8601 Format angegeben werden. Dies ist ein optionaler Parameter. Wenn nicht angegeben, erfolgt die Aufzählung bis zur letzten Sicherung.

endDateTimeFilter?: Date

Eigenschaftswert

Date

latest

Gibt an, ob nur die neueste Sicherung für eine Partition für den angegebenen Zeitraum abgerufen werden soll. Standardwert: false.

latest?: boolean

Eigenschaftswert

boolean

maxResults

Die maximale Anzahl der Ergebnisse, die als Teil der seitenseitigen Abfragen zurückgegeben werden sollen. Dieser Parameter definiert die obere Grenze für die Anzahl der zurückgegebenen Ergebnisse. Die zurückgegebenen Ergebnisse können kleiner als die angegebenen maximalen Ergebnisse sein, wenn sie nicht gemäß den in der Konfiguration definierten Einschränkungen für die maximale Nachrichtengröße in die Nachricht passen. Wenn dieser Parameter null oder nicht angegeben ist, enthält die seitenseitige Abfrage so viele Ergebnisse wie möglich, die in die Rückgabenachricht passen. Standardwert: 0.

maxResults?: number

Eigenschaftswert

number

startDateTimeFilter

Geben Sie die Startdatumszeit an, von der Sicherungen im Datetime-Format aufgezählt werden sollen. Die Datumszeit muss im ISO8601 Format angegeben werden. Dies ist ein optionaler Parameter. Wenn nicht angegeben, werden alle Sicherungen von Anfang an aufgezählt.

startDateTimeFilter?: Date

Eigenschaftswert

Date

timeoutParameter

Das Servertimeout für die Ausführung des Vorgangs in Sekunden. Dieses Timeout gibt die Zeitdauer an, die der Client bereit ist, auf den Abschluss des angeforderten Vorgangs zu warten. Der Standardwert für diesen Parameter beträgt 60 Sekunden. Standardwert: 60.

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 vor dem Senden der Anforderung angewendet werden.

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 Uploadfortschritt ausgelöst wird.

onUploadProgress?: (progress: TransferProgressEvent) => void

Eigenschaftswert

(progress: TransferProgressEvent) => void

geerbt von msRest.RequestOptionsBase.onUploadProgress

timeout

Die Anzahl der Millisekunden, die eine Anforderung annehmen kann, bevor sie automatisch beendet wird.

timeout?: number

Eigenschaftswert

number

geerbt von msRest.RequestOptionsBase.timeout