ServiceFabricClientGetApplicationInfoListOptionalParams interface

Paket:

@azure/servicefabric

Optionale Parameter.

Extends

RequestOptionsBase

Eigenschaften

applicationDefinitionKindFilter	Wird verwendet, um nach ApplicationDefinitionKind zu filtern, bei dem es sich um den Mechanismus handelt, mit dem eine Service Fabric-Anwendung definiert wird. Standardwert: Standardwert, der dieselbe Funktion wie "Alle" ausführt. Der Wert ist Alle – Filter, der eingaben mit einem beliebigen ApplicationDefinitionKind-Wert übereinstimmt. Der Wert ist ServiceFabricApplicationDescription – Filter, der mit dem ApplicationDefinitionKind-Wert ServiceFabricApplicationDescription übereinstimmt. Der Wert ist 1. Verfassen – Filter, der mit der Eingabe mit dem ApplicationDefinitionKind-Wert "Verfassen" übereinstimmt. Der Wert ist 2. Standardwert: 0.
applicationTypeName	Der Name des Anwendungstyps, der verwendet wird, um die Anwendungen zu filtern, nach der gesucht werden soll. Dieser Wert sollte nicht die Anwendungstypversion enthalten.
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.
excludeApplicationParameters	Das Flag, das angibt, ob Anwendungsparameter vom Ergebnis ausgeschlossen werden. 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.
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

applicationDefinitionKindFilter

Wird verwendet, um nach ApplicationDefinitionKind zu filtern, bei dem es sich um den Mechanismus handelt, mit dem eine Service Fabric-Anwendung definiert wird.

• Standardwert: Standardwert, der dieselbe Funktion wie "Alle" ausführt. Der Wert ist

• Alle – Filter, der eingaben mit einem beliebigen ApplicationDefinitionKind-Wert übereinstimmt. Der Wert ist

• ServiceFabricApplicationDescription – Filter, der mit dem ApplicationDefinitionKind-Wert ServiceFabricApplicationDescription übereinstimmt. Der Wert ist 1.
• Verfassen – Filter, der mit der Eingabe mit dem ApplicationDefinitionKind-Wert "Verfassen" übereinstimmt. Der Wert ist 2. Standardwert: 0.

applicationDefinitionKindFilter?: number

Eigenschaftswert

number

applicationTypeName

Der Name des Anwendungstyps, der verwendet wird, um die Anwendungen zu filtern, nach der gesucht werden soll. Dieser Wert sollte nicht die Anwendungstypversion enthalten.

applicationTypeName?: string

Eigenschaftswert

string

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

excludeApplicationParameters

Das Flag, das angibt, ob Anwendungsparameter vom Ergebnis ausgeschlossen werden. Standardwert: false.

excludeApplicationParameters?: 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

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