Changes for page Microservice Cmdlets

Last modified by jklein on 2025/08/15 09:48

From 2.7 to 2.6 From 4.1 to 3.2

From version 3.2

edited by jklein
on 2025/06/23 09:57

Change comment: There is no comment for this version

To version 2.7

edited by jklein
on 2025/06/20 10:14

Change comment: There is no comment for this version

Raw
Rendered

Summary

Page properties (1 modified, 0 added, 0 removed)

Details

Page properties

Content

@@ -370,165 +370,10 @@
  == Restart-AESBMicroservices ==
--Mit diesem Cmdlet können Sie die angegebenen Microservice-Instanzen neu starten. Die neu zu startenden Microservices können entweder über ihre `InstanceIds` oder über eine `SupervisorId` (die alle zugehörigen Instanzen neu startet) identifiziert werden. Es muss einer der Parameter `-InstanceIds` oder `-SupervisorId` angegeben werden.
--
--|=(% style="width: 213px;" %)Parameter |=(% style="width: 217px;" %)Datentyp|=Optional|=Alias|=Beschreibung
--|-ConnectionName|String|✅|C|Der Name der Verbindung, über die Microservice-Instanzen neugestartet werden sollen. Wird die Standardverbindung verwendet, wenn nicht angegeben.
--|-SupervisorId|String[]|❌|Keine|Gibt die Namen der Microservices an, die entfernt werden sollen. Es kann ein einzelner Name oder ein Array von Namen übergeben werden. Obligatorisch für Parametersatz ByInstanceName.
--|-InstanceIds|String[]|❌|Keine|Gibt die eindeutigen Instanz-IDs (GUIDs) der Microservices an, die entfernt werden sollen. Es kann eine einzelne ID oder ein Array von IDs übergeben werden. Obligatorisch für Parametersatz ByInstanceId.
--|-Timeout|String|✅|Keine|Gibt die maximale Wartezeit für den Neustartvorgang an (z.B. "30s", "1m"). Standardwert: "30s".
--|-NoWait|SwitchParameter|✅|Keine|Wenn dieser Parameter angegeben ist, wartet das Cmdlet nicht auf den Abschluss des Neustartvorgangs, sondern kehrt sofort zurück.
--
--==== **Beispiele** ====
--
--Beispiel 1: Einen Microservice anhand seiner Instanz-ID neu starten
--
--{{code language="PowerShell"}}
--Restart-AESBMicroservices -InstanceIds "aaaaaaaa-ffff-ffff-ffff-fffffffffff1"
--{{/code}}
--
--Dieser Befehl startet den Microservice mit der Instanz-ID "aaaaaaaa-ffff-ffff-ffff-fffffffffff1" neu und wartet auf das Ergebnis.
--
--Beispiel 2: Mehrere Microservices anhand ihrer Instanz-IDs neu starten mit Timeout
--
--{{code language="PowerShell"}}
--Restart-AESBMicroservices -InstanceIds "aaaaaaaa-ffff-ffff-ffff-fffffffffff1", "aaaaaaaa-ffff-ffff-ffff-fffffffffff2" -Timeout "1m"
--
--{{/code}}
--
--Dieser Befehl startet zwei Microservices neu und setzt das Timeout für den Vorgang auf eine Minute.
--
--Beispiel 3: Alle Microservices eines Supervisors neu starten, ohne auf den Abschluss zu warten
--
--{{code language="PowerShell"}}
--Restart-AESBMicroservices -SupervisorId "aaaaaaaa-ffff-ffff-ffff-fffffffffff1" -NoWait
--{{/code}}
--
--Dieser Befehl initiiert den Neustart aller Microservices, die vom Supervisor "aaaaaaaa-ffff-ffff-ffff-fffffffffff1" verwaltet werden, und kehrt sofort zurück.
--
--Beispiel 4: Microservices über die Pipeline anhand von Instanz-IDs neu starten
--
--{{code language="PowerShell"}}
--"aaaaaaaa-ffff-ffff-ffff-fffffffffff1", "aaaaaaaa-ffff-ffff-ffff-fffffffffff2" | Restart-AESBMicroservices
--{{/code}}
--
--Dieser Befehl übergibt zwei Instanz-IDs über die Pipeline an `Restart-Microservices`, um die entsprechenden Microservices neu zu starten.
--
--=== Rückgabewert ===
--
--Das Cmdlet gibt für jeden versuchten Neustartvorgang ein Objekt zurück. Dieses Objekt enthält typischerweise die folgenden Informationen:
--
--* **Name**: Der Name des Microservices.
--* **InstanceId**: Die Instanz-ID des Microservices.
--* **RestartRequested**: Zeitstempel, wann der Neustart angefordert wurde.
--* **RestartSucceeded**: Zeitstempel, wann der Neustart erfolgreich war (oder leer/Fehlerdatum bei Misserfolg).
--* **Status**: Das Ergebnis des Neustartvorgangs (z.B. "Success", "Failed", "InProgress").
--
  == Set-AESBMicroserviceLogging ==
--Mit diesem Cmdlet können Sie die Logging-Einstellungen für die angegebenen Microservice-Instanzen konfigurieren. Es kann verwendet werden, um das Logging entweder zu aktivieren (mit `-Enable`) oder zu deaktivieren (mit `-Disable`). Dabei muss einer der Parameter `-Enable` oder `-Disable` zusammen mit `-InstanceIds` angegeben werden.
--
--|=(% style="width: 213px;" %)Parameter |=(% style="width: 217px;" %)Datentyp|=Optional|=Alias|=Beschreibung
--|-ConnectionName|String|✅|C|Der Name der Verbindung, über die das Logging von Microservice-Instanzen aktiviert / deaktiviert werden soll. Wird die Standardverbindung verwendet, wenn nicht angegeben.
--|-InstanceIds|String[]|❌|Keine|Gibt die eindeutigen Instanz-IDs (GUIDs) der Microservices an, die entfernt werden sollen. Es kann eine einzelne ID oder ein Array von IDs übergeben werden. Obligatorisch für Parametersatz ByInstanceId.
--|-Enable|SwitchParameter|✅❌|Keine|Aktiviert das Logging für die angegebenen Microservices. Obligatorisch für Parametersatz `SwitchEnable`. Kann nicht zusammen mit `-Disable` verwendet werden.
--|-Disable|SwitchParameter|✅❌|Keine|Deaktiviert das Logging für die angegebenen Microservices. Obligatorisch für Parametersatz `SwitchDisable`. Kann nicht zusammen mit `-Enable` verwendet werden.
--
--=== **Beispiele** ===
--
--Beispiel 1: Logging für einen Microservice aktivieren
--
--{{code language="PowerShell"}}
--Set-AESBMicroserviceLogging -InstanceIds "aaaaaaaa-ffff-ffff-ffff-fffffffffff1" -Enable
--{{/code}}
--
--Dieser Befehl aktiviert das Logging für den Microservice mit der Instanz-ID "aaaaaaaa-ffff-ffff-ffff-fffffffffff1".
--
--Beispiel 2: Logging für mehrere Microservices deaktivieren
--
--{{code language="PowerShell"}}
--Set-AESBMicroserviceLogging -InstanceIds "aaaaaaaa-ffff-ffff-ffff-fffffffffff1", "aaaaaaaa-ffff-ffff-ffff-fffffffffff2" -Disable
--
--{{/code}}
--
--Dieser Befehl deaktiviert das Logging für die Microservices mit den angegebenen Instanz-IDs.
--
--Beispiel 3: Logging für einen Microservice über die Pipeline aktivieren
--
--{{code language="PowerShell"}}
--"aaaaaaaa-ffff-ffff-ffff-fffffffffff1" | Set-AESBMicroserviceLogging -Enable
--
--{{/code}}
--
--Dieser Befehl übergibt eine Instanz-ID über die Pipeline an `Set-MicroserviceLogging`, um das Logging für den entsprechenden Microservice zu aktivieren.
--
--=== Rückgabewerte ===
--
--Das Cmdlet gibt für jede Instanz, deren Logging-Status geändert wurde, ein Objekt zurück. Dieses Objekt enthält typischerweise die folgenden Informationen:
--
--* **Status**: Der Status der Operation (z.B. "Changed", "Unchanged", "Failed").
--* **MicroserviceId**: Die Instanz-ID des Microservices.
--* **MicroserviceName**: Der Name des Microservices.
--* **Logging**: Der neue Logging-Status (True oder False).
--
  == Start-AESBMicroservices ==
--Mit diesem Cmdlet starten Sie die angegebenen, zuvor gestoppten Microservice-Instanzen. Die zu startenden Microservices können entweder über ihre `InstanceIds` oder über eine `SupervisorId` (die alle zugehörigen Instanzen startet) identifiziert werden. Es muss einer der Parameter `-InstanceIds` oder `-SupervisorId` angegeben werden.
--
--
--|=(% style="width: 213px;" %)Parameter |=(% style="width: 217px;" %)Datentyp|=Optional|=Alias|=Beschreibung
--|ConnectionName|String|✅|C|Der Name der Verbindung, über die Microservice-Instanzen gestartet werden sollen. Wird die Standardverbindung verwendet, wenn nicht angegeben.
--|-SupervisorId|String|❌|Keine|Gibt die ID des Supervisors an, dessen zugehörige Microservices gestartet werden sollen. Obligatorisch für Parametersatz `SupervisorParametersetName`.
--|-InstanceIds|String[]|❌|Keine|Gibt die eindeutigen Instanz-IDs (GUIDs) der Microservices an, die gestartet werden sollen. Es kann eine einzelne ID oder ein Array von IDs übergeben werden. Obligatorisch für Parametersatz `InstanceIdsParametersetName`.
--|-Timeout|String|✅|Keine|Gibt die maximale Wartezeit für den Startvorgang an (z.B. "30s", "1m"). Standardwert: "30s".
--|-NoWait      |SwitchParameter|✅|Keine|Wenn dieser Parameter angegeben ist, wartet das Cmdlet nicht auf den Abschluss des Startvorgangs, sondern kehrt sofort zurück.
--
--=== **Beispiele** ===
--
--Beispiel 1: Einen Microservice anhand seiner Instanz-ID starten
--
--{{code language="PowerShell"}}
--Start-AESBMicroservices -InstanceIds "aaaaaaaa-ffff-ffff-ffff-fffffff1"
--
--{{/code}}
--
--Dieser Befehl startet den Microservice mit der Instanz-ID "aaaaaaaa-ffff-ffff-ffff-fffffff1" und wartet auf das Ergebnis.
--
--Beispiel 2: Mehrere Microservices anhand ihrer Instanz-IDs starten mit Timeout
--
--{{code language="PowerShell"}}
--Start-AESBMicroservices -InstanceIds "aaaaaaaa-ffff-ffff-ffff-fffffff1", "aaaaaaaa-ffff-ffff-ffff-fffffff2" -Timeout "1m"
--
--{{/code}}
--
--Dieser Befehl startet zwei Microservices und setzt das Timeout für den Vorgang auf eine Minute.
--
--Beispiel 3: Alle Microservices eines Supervisors starten, ohne auf den Abschluss zu warten
--
--{{code language="PowerShell"}}
--Start-AESBMicroservices -SupervisorId "ffffffff-ffff-ffff-ffff-aaaaaaaa" -NoWait
--
--{{/code}}
--
--Dieser Befehl initiiert den Start aller Microservices, die vom Supervisor "ffffffff-ffff-ffff-ffff-aaaaaaaa" verwaltet werden, und kehrt sofort zurück.
--
--Beispiel 4: Microservices über die Pipeline anhand von Instanz-IDs starten
--
--{{code language="PowerShell"}}
--"aaaaaaaa-ffff-ffff-ffff-fffffff1", "aaaaaaaa-ffff-ffff-ffff-fffffff2" | Start-AESBMicroservices
--
--{{/code}}
--
--Dieser Befehl übergibt zwei Instanz-IDs über die Pipeline an `Start-Microservices`, um die entsprechenden Microservices zu starten.
--
--=== **Rückgabewert** ===
--
--Das Cmdlet gibt für jeden versuchten Startvorgang ein Objekt zurück. Dieses Objekt enthält typischerweise die folgenden Informationen:
--
--* **InstanceName**: Der Name des Microservices.
--* **InstanceId:** Die Instanz-ID des Microservices.
--* **Status**: Das Ergebnis des Startvorgangs (z.B. "Started", "Failed", "AlreadyRunning").
--
  == Stop-AESBMicroservices ==
  = Packages =