ServiceFabricClientGetClusterHealthOptionalParams interface

Paket:

@azure/servicefabric

Optionale Parameter.

Extends

RequestOptionsBase

Eigenschaften

applicationsHealthStateFilter	Ermöglicht das Filtern der Anwendungsintegritätsstatusobjekte, die im Ergebnis der Clusterintegritätsabfrage basierend auf ihrem Integritätszustand zurückgegeben werden. Die möglichen Werte für diesen Parameter umfassen ganzzahlige Werte, die von Membern oder bitweisen Vorgängen für Elemente der HealthStateFilter-Aufzählung abgerufen werden. Es werden nur Anwendungen zurückgegeben, die dem Filter entsprechen. Alle Anwendungen werden verwendet, um den aggregierten Integritätszustand auszuwerten. Wenn nicht angegeben, werden alle Einträge zurückgegeben. Die Statuswerte sind flagbasierte Aufzählung, sodass der Wert eine Kombination dieser Werte sein könnte, die mit bitweisem Operator "OR" abgerufen werden. Wenn der angegebene Wert beispielsweise 6 ist, werden der Integritätszustand von Anwendungen mit dem Integritätsstatuswert OK (2) und der Warnung (4) zurückgegeben. Standard - Standardwert. Übereinstimmung mit "HealthState". Der Wert ist Null. Keine – Filter, der keinem HealthState-Wert entspricht. Wird verwendet, um keine Ergebnisse für eine bestimmte Auflistung von Zuständen zurückzugeben. Der Wert ist 1. Ok – Filter, der mit der Eingabe mit dem HealthState-Wert ok übereinstimmt. Der Wert ist 2. Warnung – Filter, der mit der Eingabe mit der HealthState-Wertwarnung übereinstimmt. Der Wert ist 4. Fehler – Filter, der mit der Eingabe mit dem HealthState-Wert übereinstimmt. Der Wert ist 8. Alle – Filter, der mit der Eingabe mit einem beliebigen HealthState-Wert übereinstimmt. Der Wert ist 65535. Standardwert: 0.
eventsHealthStateFilter	Ermöglicht das Filtern der Auflistung von HealthEvent-Objekten, die basierend auf dem Integritätszustand zurückgegeben werden. Die möglichen Werte für diesen Parameter enthalten einen ganzzahligen Wert eines der folgenden Integritätszustände. Es werden nur Ereignisse zurückgegeben, die dem Filter entsprechen. Alle Ereignisse werden verwendet, um den aggregierten Integritätszustand auszuwerten. Wenn nicht angegeben, werden alle Einträge zurückgegeben. Die Statuswerte sind flagbasierte Aufzählung, sodass der Wert eine Kombination dieser Werte sein könnte, die mit dem bitweisen Operator "OR" abgerufen wird. Wenn der angegebene Wert beispielsweise 6 ist, werden alle Ereignisse mit dem Integritätsstatuswert OK (2) und der Warnung (4) zurückgegeben. Standard - Standardwert. Übereinstimmung mit "HealthState". Der Wert ist Null. Keine – Filter, der keinem HealthState-Wert entspricht. Wird verwendet, um keine Ergebnisse für eine bestimmte Auflistung von Zuständen zurückzugeben. Der Wert ist 1. Ok – Filter, der mit der Eingabe mit dem HealthState-Wert ok übereinstimmt. Der Wert ist 2. Warnung – Filter, der mit der Eingabe mit der HealthState-Wertwarnung übereinstimmt. Der Wert ist 4. Fehler – Filter, der mit der Eingabe mit dem HealthState-Wert übereinstimmt. Der Wert ist 8. Alle – Filter, der mit der Eingabe mit einem beliebigen HealthState-Wert übereinstimmt. Der Wert ist 65535. Standardwert: 0.
excludeHealthStatistics	Gibt an, ob die Integritätsstatistiken als Teil des Abfrageergebnisses zurückgegeben werden sollen. False standardmäßig. Die Statistik zeigt die Anzahl der untergeordneten Entitäten im Integritätszustand "OK", "Warnung" und "Fehler". Standardwert: false.
includeSystemApplicationHealthStatistics	Gibt an, ob die Integritätsstatistiken die Fabric:/Systemanwendungsintegritätsstatistik enthalten sollen. False standardmäßig. Wenn IncludeSystemApplicationHealthStatistics auf "true" festgelegt ist, enthalten die Integritätsstatistiken die Entitäten, die zur Fabric:/System-Anwendung gehören. Andernfalls enthält das Abfrageergebnis nur Integritätsstatistiken für Benutzeranwendungen. Die Integritätsstatistiken müssen in das Abfrageergebnis einbezogen werden, damit dieser Parameter angewendet werden kann. Standardwert: false.
nodesHealthStateFilter	Ermöglicht das Filtern der Knotenstatusobjekte, die im Ergebnis der Clusterintegritätsabfrage basierend auf ihrem Integritätsstatus zurückgegeben werden. Die möglichen Werte für diesen Parameter enthalten einen ganzzahligen Wert eines der folgenden Integritätszustände. Es werden nur Knoten zurückgegeben, die dem Filter entsprechen. Alle Knoten werden verwendet, um den aggregierten Integritätszustand auszuwerten. Wenn nicht angegeben, werden alle Einträge zurückgegeben. Die Statuswerte sind flagbasierte Aufzählung, sodass der Wert eine Kombination dieser Werte sein könnte, die mit bitweisem Operator "OR" abgerufen werden. Wenn der angegebene Wert beispielsweise 6 ist, werden der Integritätszustand von Knoten mit dem Integritätsstatuswert OK (2) und der Warnung (4) zurückgegeben. Standard - Standardwert. Übereinstimmung mit "HealthState". Der Wert ist Null. Keine – Filter, der keinem HealthState-Wert entspricht. Wird verwendet, um keine Ergebnisse für eine bestimmte Auflistung von Zuständen zurückzugeben. Der Wert ist 1. Ok – Filter, der mit der Eingabe mit dem HealthState-Wert ok übereinstimmt. Der Wert ist 2. Warnung – Filter, der mit der Eingabe mit der HealthState-Wertwarnung übereinstimmt. Der Wert ist 4. Fehler – Filter, der mit der Eingabe mit dem HealthState-Wert übereinstimmt. Der Wert ist 8. Alle – Filter, der mit der Eingabe mit einem beliebigen HealthState-Wert übereinstimmt. Der Wert ist 65535. 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

applicationsHealthStateFilter

Ermöglicht das Filtern der Anwendungsintegritätsstatusobjekte, die im Ergebnis der Clusterintegritätsabfrage basierend auf ihrem Integritätszustand zurückgegeben werden. Die möglichen Werte für diesen Parameter umfassen ganzzahlige Werte, die von Membern oder bitweisen Vorgängen für Elemente der HealthStateFilter-Aufzählung abgerufen werden. Es werden nur Anwendungen zurückgegeben, die dem Filter entsprechen. Alle Anwendungen werden verwendet, um den aggregierten Integritätszustand auszuwerten. Wenn nicht angegeben, werden alle Einträge zurückgegeben. Die Statuswerte sind flagbasierte Aufzählung, sodass der Wert eine Kombination dieser Werte sein könnte, die mit bitweisem Operator "OR" abgerufen werden. Wenn der angegebene Wert beispielsweise 6 ist, werden der Integritätszustand von Anwendungen mit dem Integritätsstatuswert OK (2) und der Warnung (4) zurückgegeben.

• Standard - Standardwert. Übereinstimmung mit "HealthState". Der Wert ist Null.
• Keine – Filter, der keinem HealthState-Wert entspricht. Wird verwendet, um keine Ergebnisse für eine bestimmte Auflistung von Zuständen zurückzugeben. Der Wert ist 1.
• Ok – Filter, der mit der Eingabe mit dem HealthState-Wert ok übereinstimmt. Der Wert ist 2.
• Warnung – Filter, der mit der Eingabe mit der HealthState-Wertwarnung übereinstimmt. Der Wert ist 4.
• Fehler – Filter, der mit der Eingabe mit dem HealthState-Wert übereinstimmt. Der Wert ist 8.
• Alle – Filter, der mit der Eingabe mit einem beliebigen HealthState-Wert übereinstimmt. Der Wert ist 65535. Standardwert: 0.

applicationsHealthStateFilter?: number

Eigenschaftswert

number

eventsHealthStateFilter

Ermöglicht das Filtern der Auflistung von HealthEvent-Objekten, die basierend auf dem Integritätszustand zurückgegeben werden. Die möglichen Werte für diesen Parameter enthalten einen ganzzahligen Wert eines der folgenden Integritätszustände. Es werden nur Ereignisse zurückgegeben, die dem Filter entsprechen. Alle Ereignisse werden verwendet, um den aggregierten Integritätszustand auszuwerten. Wenn nicht angegeben, werden alle Einträge zurückgegeben. Die Statuswerte sind flagbasierte Aufzählung, sodass der Wert eine Kombination dieser Werte sein könnte, die mit dem bitweisen Operator "OR" abgerufen wird. Wenn der angegebene Wert beispielsweise 6 ist, werden alle Ereignisse mit dem Integritätsstatuswert OK (2) und der Warnung (4) zurückgegeben.

• Standard - Standardwert. Übereinstimmung mit "HealthState". Der Wert ist Null.
• Keine – Filter, der keinem HealthState-Wert entspricht. Wird verwendet, um keine Ergebnisse für eine bestimmte Auflistung von Zuständen zurückzugeben. Der Wert ist 1.
• Ok – Filter, der mit der Eingabe mit dem HealthState-Wert ok übereinstimmt. Der Wert ist 2.
• Warnung – Filter, der mit der Eingabe mit der HealthState-Wertwarnung übereinstimmt. Der Wert ist 4.
• Fehler – Filter, der mit der Eingabe mit dem HealthState-Wert übereinstimmt. Der Wert ist 8.
• Alle – Filter, der mit der Eingabe mit einem beliebigen HealthState-Wert übereinstimmt. Der Wert ist 65535. Standardwert: 0.

eventsHealthStateFilter?: number

Eigenschaftswert

number

excludeHealthStatistics

Gibt an, ob die Integritätsstatistiken als Teil des Abfrageergebnisses zurückgegeben werden sollen. False standardmäßig. Die Statistik zeigt die Anzahl der untergeordneten Entitäten im Integritätszustand "OK", "Warnung" und "Fehler". Standardwert: false.

excludeHealthStatistics?: boolean

Eigenschaftswert

boolean

includeSystemApplicationHealthStatistics

Gibt an, ob die Integritätsstatistiken die Fabric:/Systemanwendungsintegritätsstatistik enthalten sollen. False standardmäßig. Wenn IncludeSystemApplicationHealthStatistics auf "true" festgelegt ist, enthalten die Integritätsstatistiken die Entitäten, die zur Fabric:/System-Anwendung gehören. Andernfalls enthält das Abfrageergebnis nur Integritätsstatistiken für Benutzeranwendungen. Die Integritätsstatistiken müssen in das Abfrageergebnis einbezogen werden, damit dieser Parameter angewendet werden kann. Standardwert: false.

includeSystemApplicationHealthStatistics?: boolean

Eigenschaftswert

boolean

nodesHealthStateFilter

Ermöglicht das Filtern der Knotenstatusobjekte, die im Ergebnis der Clusterintegritätsabfrage basierend auf ihrem Integritätsstatus zurückgegeben werden. Die möglichen Werte für diesen Parameter enthalten einen ganzzahligen Wert eines der folgenden Integritätszustände. Es werden nur Knoten zurückgegeben, die dem Filter entsprechen. Alle Knoten werden verwendet, um den aggregierten Integritätszustand auszuwerten. Wenn nicht angegeben, werden alle Einträge zurückgegeben. Die Statuswerte sind flagbasierte Aufzählung, sodass der Wert eine Kombination dieser Werte sein könnte, die mit bitweisem Operator "OR" abgerufen werden. Wenn der angegebene Wert beispielsweise 6 ist, werden der Integritätszustand von Knoten mit dem Integritätsstatuswert OK (2) und der Warnung (4) zurückgegeben.

• Standard - Standardwert. Übereinstimmung mit "HealthState". Der Wert ist Null.
• Keine – Filter, der keinem HealthState-Wert entspricht. Wird verwendet, um keine Ergebnisse für eine bestimmte Auflistung von Zuständen zurückzugeben. Der Wert ist 1.
• Ok – Filter, der mit der Eingabe mit dem HealthState-Wert ok übereinstimmt. Der Wert ist 2.
• Warnung – Filter, der mit der Eingabe mit der HealthState-Wertwarnung übereinstimmt. Der Wert ist 4.
• Fehler – Filter, der mit der Eingabe mit dem HealthState-Wert übereinstimmt. Der Wert ist 8.
• Alle – Filter, der mit der Eingabe mit einem beliebigen HealthState-Wert übereinstimmt. Der Wert ist 65535. Standardwert: 0.

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