Microservice Cmdlets

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

Instances

Add-AESBMicroservice

Mit diesem Cmdlet wird eine neue Microservice-Instanz auf Grundlage einer bestimmten Vorlage hinzugefügt.

Parameter Parameter-SetsDatentypErforderlichAliasBeschreibung
-ConnectionNameKeineStringCDer Name der Verbindung, über die die Microservice-Instanz hinzugefügt werden soll. Wenn nicht angegeben, wird die Standardverbindung verwendet.
-InstanceNameKeineStringKeineDer Name der Instanz.
-TemplateNameUseTemplateNameStringKeineDer Name für die Vorlage der Instanz.
-TemplateIdUseTemplateIdStringKeineDie Id für die Vorlage der Instanz.
-SupervisorIdKeineStringKeineDie Id des Supervisors zu der die Instanz hinzugefügt werden soll.
-StartupTypeKeineInstanceStartTypeKeineSetzt die Art der Zeitplanung der Instanz.
-StoppedAfterCreationKeineBoolKeineSetzt den Wert um die Instanz direkt nach der Erstellung zu starten.

Parameter-Sets

Das Cmdlet verwendet Parameter-Sets, um verschiedene Möglichkeiten zum Hinzufügen von Microservices zu ermöglichen:

UseTemplateName: Ermöglicht das Hinzufügen von Microservice-Instanzen über den Vorlagen-Namen

UseTemplateId: Ermöglicht das Hinzufügen von Microservice-Instanzen über die Vorlagen-Id

Beispiele

Beispiel 1: Microservice über Vorlagen-Name hinzufügen

Add-AESBMicroservice -InstanceName "Test" -TemplateName "Tester"

Dieses Beispiel fügt eine neue Instanz mithilfe des Vorlagen-Namen hinzu. Die Standardverbindung wird verwendet.

Beispiel 2: Microservice über Vorlagen-Id hinzufügen

Add-AESBMicroservice -InstanceName "Test" -TemplateId "ffffffff-ffff-ffff-ffff-ffffffffffff"

Dieses Beispiel fügt eine neue Instanz mithilfe der Vorlagen-Id hinzu. Die Standardverbindung wird verwendet.

Beispiel 3: Microservice-StartUpType beim Hinzufügen setzen

Add-AESBMicroservice -InstanceName "Test" -TemplateId "ffffffff-ffff-ffff-ffff-ffffffffffff" -StartupType Manual

Dieses Beispiel fügt eine neue Instanz mithilfe der Vorlagen-Id hinzu und setzt den StartupType auf Manuell. Die Standardverbindung wird verwendet.

Beispiel 4: Microservice mit SupervisorId setzen

Add-AESBMicroservice -InstanceName "Test" -TemplateId "ffffffff-ffff-ffff-ffff-ffffffffffff" -SupervisorId "ffffffff-ffff-ffff-ffff-ffffffffffff"

Dieses Beispiel fügt eine neue Instanz einem bestimmten Supervisor hinzu, der über die Supervisor-Id angegeben wird. Die Standardverbindung wird verwendet.

Beispiel 5: Microservice mit StoppedAfterCreation setze

Add-AESBMicroservice -InstanceName "Test" -TemplateId "ffffffff-ffff-ffff-ffff-ffffffffffff" -StoppedAfterCreation false

Dieses Beispiel fügt eine neue Instanz hinzu und setzt den Wert von StoppedAfterCreation auf false, womit der Start nach dem Hinzufügen des Microservices verhindert wird. Die Standardverbindung wird verwendet.

Beispiel 6: Microservice mit vielen Parametern

Add-AESBMicroservice -InstanceName "Test" -TemplateId "ffffffff-ffff-ffff-ffff-ffffffffffff" -SupervisorId "ffffffff-ffff-ffff-ffff-ffffffffffff" -StartupType Manual -StoppedAfterCreation false

Dieses Beispiel fügt eine neue Instanz zu einem angegebenen Supervisor hinzu, setzt den StartupType auf Manuell und den Wert von StoppedAfterCreation auf false. Die Standardverbindung wird verwendet

Get-AESBMicroservices

Mit diesem Cmdlet erhalten Sie eine Liste mit allen installierten und registrierten Microservices des AESB. In dieser Liste finden Sie detaillierte Informationen zu jedem Microservice, einschließlich seines Namens, des zugehörigen Pakets, der Version, des aktuellen Zustands und der Ressourcennutzung.
Diese Informationen sind nützlich für die Überwachung, Fehlerbehebung und Verwaltung der Microservice-Infrastruktur.

Mit den optionalen Parametern können Sie die Ausgabe filtern und spezifische Microservices oder Instanzen abrufen.

Parameter Parameter-SetsDatentypErforderlichAliasBeschreibung
-ConnectionNameKeineStringCDer Name der Verbindung, über welche die Informationen zu Microservice-Instanzen abgerufen werden sollen. Wenn nicht angegeben, wird die Standardverbindung verwendet.
-InstanceNamesInstanceNamesParameterSetString[] Gibt die Namen der Microservice-Instanzen an, die abgerufen werden sollen. Du kannst einen oder mehrere Instanznamen als String-Array übergeben.
-SupervisorIdsSupervisorsParameterSetString[] Filtert Microservices basierend auf den IDs ihrer übergeordneten Supervisoren. Du musst eine oder mehrere Supervisor-IDs als String-Array übergeben.
-ShowAllInstancesNotRequiredParameterSetSwitchParameter Wenn dieser Parameter angegeben wird, zeigt das Cmdlet alle Instanzen von Microservices an, einschließlich derer, die normalerweise ausgeblendet oder als inaktiv betrachtet werden könnten. 

Parameter-Sets

Das Cmdlet verwendet Parameter-Sets, um verschiedene Möglichkeiten zur Abfrage von Microservices zu ermöglichen:

  • InstanceNamesParameterSet: Ermöglicht das Abrufen von Microservices, basierend auf ihren Instanz-Namen.
  • SupervisorsParameterSet: Ermöglicht das Abrufen von Microservices, die bestimmten Supervisor-IDs zugeordnet sind.
  • NotRequiredParameterSet: Dient hauptsächlich dazu, die ShowAllInstances-Option zu ermöglichen.

Sie können immer nur Parameter aus einem dieser Sets gleichzeitig verwenden.

Beispiele

Beispiel 1: Alle Microservices auflisten

Get-AESBMicroservices

Dieser Befehl ruft alle registrierten AESB Microservices ab und zeigt deren detaillierte Informationen an. Ohne explizite Parameterauswahl fällt dies in das NotRequiredParameterSetName.

Beispiel 2: Einen spezifischen Microservice nach Namen abrufen

Get-AESBMicroservices -InstanceNames "TestMicroservice"

Dieser Befehl ruft Informationen nur für die Microservice-Instanz mit dem Namen "TestMicroservice" ab. Hier wird das InstanceNamesParameterSetName verwendet.

Beispiel 3: Mehrere Microservices nach Namen abrufen

Get-AESBMicroservices -InstanceNames "TestMicroservice1", "TestMicroservice2"

Dieser Befehl ruft Informationen für die Microservice-Instanzen "TestMicroservice1" und "TestMicroservice2" ab, ebenfalls unter Verwendung des InstanceNamesParameterSetName.

Beispiel 4: Alle Microservices inklusive inaktiver Instanzen anzeigen

Get-AESBMicroservices -ShowAllInstances

Dieser Befehl zeigt alle Microservice-Instanzen an, auch diejenigen, die normalerweise ausgeblendet würden. Dies nutzt das NotRequiredParameterSetName.

Beispiel 5: Microservices nach Supervisor-ID (GUID) filtern

Get-AESBMicroservices -SupervisorIds "ffffffff-ffff-ffff-ffff-ffffffffffff"

Rückgabewerte

Das Cmdlet gibt eine Sammlung von Objekten zurück, die jeweils die folgenden Eigenschaften für einen Microservice enthalten:

  • Name: Der eindeutige Name der Microservice-Instanz.
  • Package: Der Name des Pakets, zu dem der Microservice gehört.
  • PackageVersion: Die Version des zugehörigen Pakets.
  • TemplateName: Der Name der Vorlage, die zum Erstellen dieser Microservice-Instanz verwendet wurde.
  • InstanceId: Eine eindeutige ID der Microservice-Instanz (GUID).
  • Routing: Informationen zum Routing des Microservices (in der Regel ein leeres Array, wenn keine spezifischen Routing-Regeln konfiguriert sind).
  • IndividualSicsCredentials: Zeigt an, ob der Microservice individuelle SICS-Anmeldeinformationen verwendet (True/False).
  • LoggingEnabled: Zeigt an, ob die Protokollierung für den Microservice aktiviert ist (True/False).
  • StartupType: Der Starttyp des Microservices (z.B. Manuell oder Automatisch).
  • Scheduling: Informationen zur Zeitplanung des Microservices (z.B. NotAvailable, wenn keine Zeitplanung konfiguriert ist).
  • ServiceState: Der aktuelle Zustand des Microservices (z.B. Stopped, Running).
  • ProcessId: Die Prozess-ID des Microservices, wenn er ausgeführt wird.
  • SicsUsername: Der SICS-Benutzername, der vom Microservice verwendet wird.
  • CpuUsage: Die aktuelle CPU-Auslastung des Microservices in Prozent.
  • MemoryUsage: Die aktuelle Speicherauslastung des Microservices in Bytes.

Edit-AESBMicroservice

Dieses Cmdlet ermöglicht die Bearbeitung der Konfiguration eines spezifischen Microservice. Derzeit unterstützt es die Änderung des Starttyps (StartupType) und optional die Konfiguration von Anmeldeinformationen (Credentials) für den Microservice. Dies ist besonders nützlich, um das Startverhalten von Microservices zu steuern oder SICS-Anmeldeinformationen zu aktualisieren.

Parameter Parameter-SetsDatentypErforderlichBeschreibung
-ConnectionNameKeineStringDer Name der Verbindung, über die Microservice-Instanzen bearbeitet werden sollen. Wenn nicht angegeben, wird die Standardverbindung verwendet.
-InstanceNameNoCredentialParameterSet,
CredentialParameterSet
StringGibt den eindeutigen Namen der Microservice-Instanz an, deren Konfiguration geändert werden soll. Dieser Parameter ist in beiden Parametersets obligatorisch.
-UseCredentialsCredentialParameterSetSwitchParameterGibt an, dass Anmeldeinformationen für den Microservice konfiguriert werden sollen. Dieser Parameter gehört zum CredentialParameterSetName und ist obligatorisch, wenn dieses Set verwendet wird.
-UserNameCredentialParameterSetStringGibt den Benutzernamen an, der verwendet werden soll, wenn UseCredentials aktiviert ist. Dieser Parameter gehört zum CredentialParameterSetName und ist obligatorisch, wenn dieses Set verwendet wird.
-PasswordCredentialParameterSetSecureStringGibt das Passwort für den angegebenen Benutzernamen an. Das Passwort muss als SecureString-Objekt übergeben werden. Dieser Parameter gehört zum CredentialParameterSetName und ist obligatorisch, wenn dieses Set verwendet wird.
-StartupTypeNoCredentialParameterSet,
CredentialParameterSet
EnumLegt fest, wie sich der Microservice beim Systemstart verhalten soll. Dies ist ein Enum-Wert vom Typ InstanceStartType. Gängige Werte sind Automatic (startet automatisch mit dem System) und Manual (muss manuell gestartet werden).

Parameter-Sets

Das Cmdlet verwendet Parameter-Sets, um zwei Hauptszenarien zu unterstützen:

  • NoCredentialParameterSet: Ermöglicht die Bearbeitung des Starttyps ohne die Angabe von Anmeldeinformationen.
  • CredentialParameterSet: Ermöglicht die Bearbeitung des Starttyps und die Konfiguration von Anmeldeinformationen für den Microservice.

Sie können immer nur Parameter aus einem dieser Sets gleichzeitig verwenden.

Beispiele

Beispiel 1: Starttyp eines Microservice auf "Automatisch" ändern

Edit-AESBMicroservice -InstanceName "TestMicroservice1" -StartupType Automatic

Dieser Befehl ändert den Starttyp des Microservice mit dem Namen "TestMicroservice" auf "Automatisch". Hier wird das NoCredentialParameterSetName verwendet.

Beispiel 2: Starttyp ändern und individuelle Anmeldeinformationen festlegen

1
2
$password = ConvertTo-SecureString "YourSecurePassword" -AsPlainText -Force
Edit-AESBMicroservice -InstanceName "TestMicroservice" -UseCredentials -Username "MySicsUser" -Password $password -StartupType Automatic

Dieser Befehl ändert den Starttyp des Microservice "TestMicroservice" auf "Automatisch" und konfiguriert individuelle SICS-Anmeldeinformationen mit dem angegebenen Benutzernamen und Passwort. Hier wird das CredentialParameterSetName verwendet.

Kill-AESBMicroservices

Mit diesem Cmdlet können Sie laufende Microservices gezielt beenden. Dies ist nützlich für die Wartung, Fehlerbehebung oder das Herunterfahren bestimmter Microservice-Instanzen. Das Cmdlet bietet zwei Methoden zum Ansprechen der zu beendenden Microservices: entweder direkt über deren Instanz-IDs oder indirekt über die ID ihres Supervisoren, wodurch alle zugehörigen Microservices beendet werden.

Parameter Parameter-SetsDatentypErforderlichBeschreibung
-ConnectionNameKeineStringDer Name der Verbindung, über welche die Ausführung von Microservice-Instanzen abgebrochen werden soll. Wenn nicht angegeben, wird die Standardverbindung verwendet.
-InstanceIdsUseMicroservicesIdListParameterSetString[]Gibt eine Liste von eindeutigen Instanz-IDs (GUIDs als String) der Microservices an, die beendet werden sollen. 
-SupervisorIdUseSupervisorIdParameterSetStringDer SupervisorId-Parameter gibt die eindeutige ID (GUID als String) des Supervisors an. Alle Microservices, die von diesem spezifischen Supervisor verwaltet werden, werden beendet.

Parameter-Sets

Das Cmdlet verwendet Parameter-Sets, um diese beiden Betriebsmodi zu unterscheiden:

  • UseMicroservicesIdListParameterSet: Ermöglicht das Ansprechen von Microservices über eine Liste ihrer eindeutigen Instanz-IDs.
  • UseSupervisorIdParameterSet: Ermöglicht das Ansprechen von Microservices durch Angabe der ID ihres Supervisoren. Alle Microservices, die diesem Supervisor zugeordnet sind, werden beendet.

Sie können immer nur Parameter aus einem dieser Sets gleichzeitig verwenden.

Beispiele

Beispiel 1: Einen spezifischen Microservice mit seiner Instanz-ID beenden

Kill-AESBMicroservices -InstanceIds "ffffffff-ffff-ffff-ffff-ffffffffffff"

Dieser Befehl versucht, den Microservice mit der angegebenen Instanz-ID zu beenden. Die Beispielausgabe zeigt, dass der Microservice bereits gestoppt war. Hier wird das UseMicroservicesIdListParameterSet verwendet.

Beispiel 2: Mehrere Microservices mit ihren Instanz-IDs beenden

Kill-AESBMicroservices -InstanceIds "ffffffff-ffff-ffff-ffff-fffffffffff1", "ffffffff-ffff-ffff-ffff-fffffffffff2"

Dieser Befehl versucht, die Microservices mit den angegebenen Instanz-IDs zu beenden.

Beispiel 3: Alle Microservices beenden, die einem bestimmten Supervisor zugeordnet sin

Kill-AESBMicroservices -SupervisorId "ffffffff-ffff-ffff-ffff-ffffffffffff"

Dieser Befehl beendet alle Microservices, die dem Supervisor mit der angegebenen ID zugeordnet sind. Hier wird das UseSupervisorIdParameterSet verwendet.

Rückgabewerte

Das Cmdlet gibt eine Sammlung von Objekten zurück, die den Status der Beendigung für jeden angesprochenen Microservice anzeigen. Die Ausgabe im Beispiel zeigt folgende Eigenschaften:

  • Status: Der Status der Beendigungsoperation (z.B. Unchanged/Changed).
  • InstanceId: Die eindeutige ID der betroffenen Microservice-Instanz.
  • InstanceState: Der Zustand des Microservice nach der Operation (z.B. Stopped/Already stopped).
  • Error: Eine Fehlermeldung, falls die Operation nicht erfolgreich war oder ein Problem aufgetreten ist.

Move-AESBMicroservice

Mit diesem Cmdlet können Sie eine oder mehrere Microservice-Instanzen auf einen anderen Supervisor verschieben. Es unterstützt optionale Parameter für Timeout und asynchrone Ausführung.

Parameter DatentypErforderlichAliasBeschreibung
-ConnectionNameStringCDer Name der Verbindung, über die Microservice-Instanzen verschoben werden sollen. Wenn nicht angegeben, wird die Standardverbindung verwendet.
-InstanceIdsString Die IDs der zu verschiebenden Microservice-Instanzen (Pflichtfeld, unterstützt mehrere Werte).
-SupervisorIdString Die Id des Ziel-Supervisors, auf den die Instanzen verschoben werden sollen.
-TimeoutString Optionales Timeout für die Operation (Standard: "30s").
-NoWaitSwitchParameter Gibt an, ob das Cmdlet auf den Abschluss der Operation warten soll (asynchron).

Beispiele

Beispiel 1: Einen Microservice zu einem neuen Supervisor verschieben

Move-AESBMicroservice -InstanceIds "aaaaaaaa-ffff-ffff-ffff-ffffffffffff" -SupervisorId "ffffffff-ffff-ffff-ffff-aaaaaaaa"

Dieser Befehl verschiebt den Microservice mit der Instanz-ID "aaaaaaaa-ffff-ffff-ffff-ffffffffffff" zu dem Supervisor mit der ID "ffffffff-ffff-ffff-ffff-aaaaaaaa".

Das Cmdlet wartet, bis der Vorgang abgeschlossen ist (Standard-Timeout von 30 Sekunden).

Beispiel 2: Mehrere Microservices zu einem neuen Supervisor verschieben und nicht auf Abschluss warten.

Move-AESBMicroservice -InstanceIds "aaaaaaaa-ffff-ffff-ffff-fffffffffff1", "aaaaaaaa-ffff-ffff-ffff-fffffffffff2" -SupervisorId "ffffffff-ffff-ffff-ffff-aaaaaaaa" -NoWait

Dieser Befehl initiiert die Verschiebung der Microservices mit den Instanz-IDs "aaaaaaaa-ffff-ffff-ffff-fffffffffff1" und "aaaaaaaa-ffff-ffff-ffff-fffffffffff2" zu "ffffffff-ffff-ffff-ffff-aaaaaaaa" und kehrt sofort zurück, ohne auf den Abschluss des Vorgangs zu warten.

Beispiel 3: Einen Microservice verschieben mit längerem Timeout

Move-AESBMicroservice -InstanceIds "aaaaaaaa-ffff-ffff-ffff-fffffffffff1" -SupervisorId "ffffffff-ffff-ffff-ffff-aaaaaaaa" -Timeout "5m"

Dieser Befehl versucht, "aaaaaaaa-ffff-ffff-ffff-fffffffffff1" zu "ffffffff-ffff-ffff-ffff-aaaaaaaa" zu verschieben und wartet bis zu 5 Minuten auf den Abschluss des Vorgangs.

Rückgabewerte

Das Cmdlet gibt für jede verschobene Instanz ein Objekt mit folgenden Eigenschaften zurück:

  • InstanceId: Die ID der verschobenen Microservice-Instanz
  • SicsUsername: Der zugehörige Benutzername (z. B. für die Verbindung)
  • IsIdentified: Gibt an, ob die Instanz eindeutig identifiziert wurde
  • ProcessState: Aktueller Prozessstatus der Instanz (z. B. Stopped)
  • LastUpdate: Zeitpunkt der letzten Statusänderung
  • Timestamp: Zeitstempel der letzten Änderung
  • ProcessId: (Optional) Prozess-ID der Instanz
  • CpuUsage: (Optional) CPU-Auslastung der Instanz
  • RamUsage: (Optional) RAM-Auslastung der Instanz

Remove-AESBMicroservices

Dieses Cmdlet entfernt die angegebenen Microservice-Instanzen. Die zu entfernenden Microservices können entweder über ihre Instanz-Namen oder ihre Instanz-IDs identifiziert werden. Es muss einer der Parameter -InstanceNames oder -InstanceIds angegeben werden. Die Parameter können nicht zusammen verwendet werden.

Parameter Parameter-SetsDatentypErforderlichAliasBeschreibung
-ConnectionNameKeineStringCDer Name der Verbindung, über die Microservice-Instanzen entfernt werden sollen. Wenn nicht angegeben, wird die Standardverbindung verwendet.
-InstanceNamesInstanceNamesParameterSetString[]KeineGibt die Namen der Microservices an, die entfernt werden sollen. Es kann ein einzelner Name oder ein Array von Namen übergeben werden. Obligatorisch für den Parameter-Satz ByInstanceName.
-InstanceIdsInstanceIdsParameterSetString[]KeineGibt 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 den Parameter-Satz ByInstanceId.

Parameter-Sets

Das Cmdlet verwendet Parameter-Sets, um verschiedene Möglichkeiten zur Abfrage von Microservices zu ermöglichen:

  • InstanceNamesParameterSet: Ermöglicht das Abrufen von Microservices, basierend auf ihren Instanz-Namen.
  • InstanceIdsParameterSet: Ermöglicht das Abrufen von Microservices, basierend auf ihren eindeutigen Instanz-IDs.

Beispiele

Beispiel 1: Einen Microservice anhand seiner Instanz-ID entfernen

Remove-AESBMicroservices -InstanceIds "aaaaaaaa-ffff-ffff-ffff-fffffffffff1"

Dieser Befehl entfernt den Microservice mit der Instanz-ID "b6cb7044-b6b2-4a64-9997-29f0ea5283db". Die Ausgabe zeigt die Instanz und das Ergebnis "Success".

Beispiel 2: Mehrere Microservices anhand ihrer Instanz-IDs entfernen

Remove-AESBMicroservices -InstanceIds "aaaaaaaa-ffff-ffff-ffff-fffffffffff1"

Dieser Befehl entfernt zwei Microservices, die durch ihre jeweiligen Instanz-IDs identifiziert werden.

Beispiel 3: Einen Microservice anhand seines Namens entfernen

Remove-AESBMicroservices -InstanceNames "MeinService"

Dieser Befehl entfernt den Microservice mit dem Namen "MeinService".

Beispiel 4: Mehrere Microservices anhand ihrer Namen entfernen und Bestätigung anfordern

Remove-AESBMicroservices -InstanceNames "Service1", "Service2" -Confirm

Dieser Befehl versucht, die Microservices "Service1" und "Service2" zu entfernen. Vor dem eigentlichen Entfernen wird der Benutzer um Bestätigung gebeten.

Beispiel 5: Microservices über die Pipeline anhand von Instanz-IDs entfernen

"aaaaaaaa-ffff-ffff-ffff-fffffffffff1", "aaaaaaaa-ffff-ffff-ffff-fffffffffff2" | Remove-AESBMicroservices -InstanceIds

Dieser Befehl übergibt zwei Instanz-IDs über die Pipeline an `Remove-Microservices`, um die entsprechenden Microservices zu entfernen.

Rückgabewerte

Das Cmdlet gibt für jeden versuchten Entfernungsvorgang ein Objekt zurück. Dieses Objekt enthält typischerweise die folgenden Informationen:

  • Instance: Die ID oder der Name des Microservices.
  • Result: Das Ergebnis des Entfernungsvorgangs (z.B. "Success", "Failed").

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.

Parameter Parameter-SetsDatentypErforderlichAliasBeschreibung
-ConnectionNameKeineStringCDer Name der Verbindung, über die Microservice-Instanzen neugestartet werden sollen. Wenn nicht angegeben, wird die Standardverbindung verwendet.
-InstanceIdsInstanceNamesParameterSetString[]KeineGibt 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.
-SupervisorIdSupervisorParameterSetString[]KeineDer SupervisorId-Parameter gibt die eindeutige ID (GUID als String) des Supervisors an. Alle Microservices, die von diesem spezifischen Supervisor verwaltet werden, werden neugestartet.
-TimeoutKeineStringKeineGibt die maximale Wartezeit für den Neustartvorgang an (z.B. "30s", "1m"). Standardwert: "30s".
-NoWaitKeineSwitchParameterKeineWenn dieser Parameter angegeben ist, wartet das Cmdlet nicht auf den Abschluss des Neustartvorgangs, sondern kehrt sofort zurück.

Parameter-Sets

Das Cmdlet verwendet Parameter-Sets, um verschiedene Möglichkeiten zur Abfrage von Microservices zu ermöglichen:

  • InstanceIdsParameterSet: Ermöglicht das Abrufen von Microservices, basierend auf ihren eindeutigen Instanz-IDs.
  • SupervisorParameterSet: Ermöglicht das Abrufen von Microservices, die bestimmten Supervisor-IDs zugeordnet sind.

Beispiele

Beispiel 1: Einen Microservice anhand seiner Instanz-ID neu starten

Restart-AESBMicroservices -InstanceIds "aaaaaaaa-ffff-ffff-ffff-fffffffffff1"

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

Restart-AESBMicroservices -InstanceIds "aaaaaaaa-ffff-ffff-ffff-fffffffffff1", "aaaaaaaa-ffff-ffff-ffff-fffffffffff2" -Timeout "1m"

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

Restart-AESBMicroservices -SupervisorId "aaaaaaaa-ffff-ffff-ffff-fffffffffff1" -NoWait

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

"aaaaaaaa-ffff-ffff-ffff-fffffffffff1", "aaaaaaaa-ffff-ffff-ffff-fffffffffff2" | Restart-AESBMicroservices

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.

Parameter Parameter-SetsDatentypErforderlichAliasBeschreibung
-ConnectionNameKeineStringCDer Name der Verbindung, über die das Logging von Microservice-Instanzen aktiviert / deaktiviert werden soll. Wenn nicht angegeben, wird die Standardverbindung verwendet.
-InstanceIdsInstanceIdsParameterSetString[]KeineGibt 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.
-EnableKeineSwitchParameterKeineAktiviert das Logging für die angegebenen Microservices. Obligatorisch für Parametersatz `SwitchEnable`. Kann nicht zusammen mit `-Disable` verwendet werden.
-DisableKeineSwitchParameterKeineDeaktiviert das Logging für die angegebenen Microservices. Obligatorisch für Parametersatz `SwitchDisable`. Kann nicht zusammen mit `-Enable` verwendet werden.

Parameter-Sets

Das Cmdlet verwendet Parameter-Sets, um verschiedene Möglichkeiten zur Abfrage von Microservices zu ermöglichen:

  • InstanceIdsParameterSet: Ermöglicht das Abrufen von Microservices, basierend auf ihren eindeutigen Instanz-IDs.

Beispiele

Beispiel 1: Logging für einen Microservice aktivieren

Set-AESBMicroserviceLogging -InstanceIds "aaaaaaaa-ffff-ffff-ffff-fffffffffff1" -Enable

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

Set-AESBMicroserviceLogging -InstanceIds "aaaaaaaa-ffff-ffff-ffff-fffffffffff1", "aaaaaaaa-ffff-ffff-ffff-fffffffffff2" -Disable

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

"aaaaaaaa-ffff-ffff-ffff-fffffffffff1" | Set-AESBMicroserviceLogging -Enable

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.

Parameter Parameter-SetsDatentypErforderlichAliasBeschreibung
-ConnectionNameKeineStringCDer Name der Verbindung, über die Microservice-Instanzen gestartet werden sollen. Wenn nicht angegeben, wird die Standardverbindung verwendet.
-InstanceIdsInstanceIdsParameterSetString[]KeineGibt 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 `InstanceIdsParameterset`.
-SupervisorIdSupervisorParameterSetStringKeineGibt die ID des Supervisors an, dessen zugehörige Microservices gestartet werden sollen. Obligatorisch für Parametersatz `SupervisorParameterset`.
-TimeoutKeineStringKeineGibt die maximale Wartezeit für den Startvorgang an (z.B. "30s", "1m"). Standardwert: "30s".
-NoWait      KeineSwitchParameterKeineWenn dieser Parameter angegeben ist, wartet das Cmdlet nicht auf den Abschluss des Startvorgangs, sondern kehrt sofort zurück.

Parameter-Sets

Das Cmdlet verwendet Parameter-Sets, um verschiedene Möglichkeiten zur Abfrage von Microservices zu ermöglichen:

  • InstanceIdsParameterSet: Ermöglicht das Abrufen von Microservices, basierend auf ihren eindeutigen Instanz-IDs.
  • SupervisorParameterSet: Ermöglicht das Abrufen von Microservices, die bestimmten Supervisor-IDs zugeordnet sind.

Beispiele

Beispiel 1: Einen Microservice anhand seiner Instanz-ID starten

Start-AESBMicroservices -InstanceIds "aaaaaaaa-ffff-ffff-ffff-fffffff1"

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

Start-AESBMicroservices -InstanceIds "aaaaaaaa-ffff-ffff-ffff-fffffff1", "aaaaaaaa-ffff-ffff-ffff-fffffff2" -Timeout "1m"

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

Start-AESBMicroservices -SupervisorId "ffffffff-ffff-ffff-ffff-aaaaaaaa" -NoWait

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

"aaaaaaaa-ffff-ffff-ffff-fffffff1", "aaaaaaaa-ffff-ffff-ffff-fffffff2" | Start-AESBMicroservices

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

Mit diesem Cmdlet werden die angegebenen, laufenden Microservice-Instanzen gestoppt. Die zu stoppenden Microservices können entweder über ihre `InstanceIds` oder über eine `SupervisorId` (die alle zugehörigen Instanzen stoppt) identifiziert werden. Es muss einer der Parameter `-InstanceIds` oder `-SupervisorId` angegeben werden.

Parameter Parameter-SetsDatentypErforderlichAliasBeschreibung
-ConnectionNameKeineStringCDer Name der Verbindung, über die Microservice-Instanzen gestoppt werden sollen. Wenn nicht angegeben, wird die Standardverbindung verwendet.
-InstanceIdsUseMicroservicesIdListParameterSetString[]KeineGibt die eindeutigen Instanz-IDs (GUIDs) der Microservices an, die gestoppt werden sollen. Es kann eine einzelne ID oder ein Array von IDs übergeben werden. Obligatorisch für Parametersatz `UseMicroservicesIdListParameterSet`.
-SupervisorIdUseSupervisorIdParameterSetStringKeineGibt die ID des Supervisors an, dessen zugehörige Microservices gestoppt werden sollen. Obligatorisch für Parametersatz `UseSupervisorIdParameterSet`.
-TimeoutKeineStringKeineGibt die maximale Wartezeit für den Stoppvorgang an (z.B. "5s", "1m"). Standardwert: "5s".
-NoWait      KeineSwitchParameterKeineWenn dieser Parameter angegeben ist, wartet das Cmdlet nicht auf den Abschluss des Stoppvorgangs, sondern kehrt sofort zurück.

Parameter-Sets

Das Cmdlet verwendet Parameter-Sets, um verschiedene Möglichkeiten zur Abfrage von Microservices zu ermöglichen:

  • UseMicroservicesIdListParameterSet: Ermöglicht das Abrufen von Microservices, basierend auf ihren eindeutigen Instanz-IDs.
  • UseSupervisorIdParameterSet`: Ermöglicht das Abrufen von Microservices, die bestimmten Supervisor-IDs zugeordnet sind.

Beispiele

Beispiel 1: Einen Microservice anhand seiner Instanz-ID stoppen

Stop-AESBMicroservices -InstanceIds "c7e323e9-abc1-4150-a4a3-afb4e57e9cb1"

Dieser Befehl stoppt den Microservice mit der Instanz-ID "c7e323e9-abc1-4150-a4a3-afb4e57e9cb1" und wartet auf das Ergebnis.

Beispiel 2: Mehrere Microservices anhand ihrer Instanz-IDs stoppen mit Timeout

Stop-AESBMicroservices -InstanceIds "01234567-89ab-cdef-0123-456789abcdef", "fedcba98-7654-3210-fedc-ba9876543210" -Timeout "10s"

Dieser Befehl stoppt zwei Microservices und setzt das Timeout für den Vorgang auf zehn Sekunden.

Beispiel 3: Alle Microservices eines Supervisors stoppen, ohne auf den Abschluss zu warten

Stop-AESBMicroservices -SupervisorId "FinanceSupervisor" -NoWait

Dieser Befehl initiiert den Stoppvorgang aller Microservices, die vom Supervisor "FinanceSupervisor" verwaltet werden, und kehrt sofort zurück.

Beispiel 4: Microservices über die Pipeline anhand von Instanz-IDs stoppen

"c7e323e9-abc1-4150-a4a3-afb4e57e9cb1", "another-guid-for-stop" | Stop-AESBMicroservices

Dieser Befehl übergibt zwei Instanz-IDs über die Pipeline an `Stop-AESBMicroservices`, um die entsprechenden Microservices zu stoppen.

Rückgabewert

Das Cmdlet gibt für jeden versuchten Stoppvorgang ein Objekt zurück. Dieses Objekt enthält typischerweise die folgenden Informationen:

  • Status: Der Status der Operation (z.B. "Changed", "Unchanged", "Failed")
  • InstanceId: Die Instanz-ID des Microservices.
  • InstanceState: Der Zustand des Microservices nach dem versuchten Stoppvorgang (z.B. "Stopped", "Running").
  • Error: Fehlermeldungen, falls der Stoppvorgang nicht erfolgreich war.

Packages

Get-AESBMicroservicePackages

Dieses Cmdlet ruft eine Liste aller verfügbaren Microservice-Pakete und deren Versionen ab. Es sind keine spezifischen Parameter erforderlich.

Parameter DatentypErforderlichAliasBeschreibung
-ConnectionNameStringCDer Name der Verbindung, über die Informationen zu Microservice-Paketen abgerufen werden soll. Wenn nicht angegeben, wird die Standardverbindung verwendet.

Beispiele

Beispiel 1: Alle verfügbaren Microservice-Pakete auflisten

Get-AESBMicroservicePackages

Dieser Befehl ruft alle verfügbaren Microservice-Pakete und die zugehörigen Versionen ab.

Rückgabewert

Das Cmdlet gibt für jedes gefundene Microservice-Paket ein Objekt zurück. Dieses Objekt enthält typischerweise die folgenden Informationen:

  • PackageName: Der Name des Microservice-Pakets.
  • PackageVersions: Eine Liste der verfügbaren Versionen für dieses Paket.

Templates

Add-AESBMicroserviceTemplate

Dieses Cmdlet fügt eine Microservice-Vorlage auf Basis der beigefügten Vorlagen-Konfiguration hinzu.

Parameter DatentypErforderlichAliasBeschreibung
-ConnectionNameStringCDer Name der Verbindung, über die eine Vorlage hinzugefügt werden soll. Wenn nicht angegeben, wird die Standardverbindung verwendet.
-TemplateNameStringKeineDer Name für die Vorlage.
-TemplateConfigXmlDocumentKeineDie Konfiguration der Vorlage.

Beispiele

Beispiel 1: Fügt ein neue Microservice-Vorlage hinzu

Add-AESBMicroserviceTemplate -TemplateName "Test" -TemplateConfig $templateConfig

Dieses Beispiel fügt eine neue Vorlagen-konfiguration mit dem Namen "Test" auf Basis des $templateConfig-Objekts hinzu. Die Standardverbindung wird verwendet.

Beispiel der Funktion in PowerShell
Beispiel der Vorlagen-Konfiguration

Rückgabewerte

Bei erfolgreicher Anwendung erhalten Sie zwei Objekte zurück.

  • String
    • Erfolgreiche Statusmeldung
  • TemplateInfo
    • TemplateId
      • ID der Vorlage
    • Configuration
      • Aktuelle Konfiguration der Vorlage
    • Name
      • Name der Vorlage
    • Type
      • Der Typ der Vorlage
    • Version
      • Die Versionierung der Vorlage
Rückgabewerte der Vorlagen-Konfiguration

Export-MicroserviceTemplateConfig

Dieses Cmdlet ermöglicht es, die Konfiguration einer Microservice-Vorlagen zu exportieren.

Parameter DatentypErforderlichAliasBeschreibung
-ConnectionNameStringCDer Name der Verbindung, über die die Microservice-Vorlagen-Konfiguration exportiert werden soll. Wenn nicht angegeben, wird die Standardverbindung verwendet.
-TemplateConfigXmlDocumentKeineDie Konfiguration, die exportiert werden soll.
-PathStringKeineDer Pfad, unter dem die Microservice-Vorlagen-Konfiguration gespeichert werden soll.

Beispiele

Beispiel 1: Microservice-Vorlage exportieren

Export-AESBMicroserviceTemplateConfig -TemplateConfig $templateConfig -Path $path

In diesem Beispiel wird die $templateConfig am Speicherort "C:\Test.xml" exportiert.

1
2
3
4
5
6
7
8
9
10
11
12
13
function Export-MicroserviceTemplateConfig {
   param (
       [string]$Path
    )

   $microserviceTemplates = Get-AESBMicroserviceTemplates

   $microserviceTemplateConfig = Get-AESBMicroserviceTemplateConfig -TemplateName $microserviceTemplates[0].Name

   $exportMicroserviceTemplateConfigResult = Export-AESBMicroserviceTemplateConfig -TemplateConfig $microserviceTemplateConfig -Path $Path

   return $exportMicroserviceTemplateConfigResult
}
Beispielhafte XML-Datei nach dem Exportieren

Rückgabewerte

Nach erfolgreichem Exportieren erhalten Sie eine Statusmeldung zurück.

Writing the file was successful.

Get-AESBMicroserviceTemplateConfig

Dieses Cmdlet fragt die TemplateConfig einer bestimmten Microservice-Vorlage ab.

Parameter DatentypErforderlichAliasBeschreibung
-ConnectionNameStringCDer Name der Verbindung, über die die Microservice-Vorlagen-Konfiguration exportiert werden soll. Wenn nicht angegeben, wird die Standardverbindung verwendet.
-TemplateNameStringKeineDer Name der Vorlage für die gewünschte Konfiguration.

Beispiele

Beispiel 1: Konfiguration der Microservice-Vorlage von $templateName anfragen

Get-AESBMicroserviceTemplateConfig -TemplateName $templateName

Dieses Beispiel fragt die Vorlagen-Konfiguration mit dem Namen $templateName an. Die Standardverbindung wird verwendet.

1
2
3
4
5
6
7
8
function Get-MicroserviceTemplateConfig {

   $aesbMicroserviceTemplates = Get-AESBMicroserviceTemplates

   $microserviceTemplateConfig = Get-AESBMicroserviceTemplateConfig -TemplateName $aesbMicroserviceTemplates[0].Name

   return $microserviceTemplateConfig
}

Rückgabewerte

Bei erfolgreicher Anwendung erhalten Sie die gewünschte Microservice-Konfiguration zurück:

  • MicroserviceConfiguration
    • Version
      • Die jeweilige Version des Microservices
    • Type
      • Der Typ des Microservices
    • TypeConfiguration
      • Die jeweilige Typ-Konfiguration des Microservices
$microserviceTemplateConfig

MicroserviceConfiguration
-------------------------
MicroserviceConfiguration

$microserviceTemplateConfig.MicroserviceConfiguration

Version    Type          SnmpConnectorConfiguration
-------    ----          --------------------------
1.11.0.895 SnmpConnector SnmpConnectorConfiguration

Get-AESBMicroserviceTemplates

Dieses Cmdlet fragt die vorhandenen Microservice-Vorlagen ab und listet sie auf.

Parameter DatentypErforderlichAliasBeschreibung
-ConnectionNameStringCDer Name der Verbindung, über die die Microservices-Vorlagen-Konfiguration importiert werden soll. Wenn nicht angegeben, wird die Standardverbindung verwendet.
-PackageNameString Der Name des Microservice-Pakets, dessen Vorlagen geholt werden sollen
-PackageVersionString Die Version des Pakets, dessen Vorlagen geholt werden sollen

Beispiele

Beispiel 1: Alle vorhandenen Microservice-Vorlagen anzeigen

Get-AESBMicroserviceTemplates

Dieses Beispiel listet alle vorhandenen Microservice-Vorlagen auf. Die Standardverbindung wird verwendet. Falls keine Vorlagen vorhanden sind, wird ein Fehler angezeigt.

Beispiel 2: Die Vorlagen eines bestimmten Microservice-Pakets einer bestimmten Version auflisten

Get-AESBMicroserviceTemplates -PackageName "SnmpConnector" -PackageVersion "1.11.0.895"

 Dieses Beispiel listet alle vorhandenen Microservice-Vorlagen des Pakets "SnmpConnector" in der Version "1.11.0.895" auf. Die Standardverbindung wird verwendet.

Rückgabewerte

Bei erfolgreicher Anwendung werden die gewünschten Microservice-Vorlagen als Objekte aufgelistet.

  • MicroserviceTemplate
    • Name
      • Der Name der Vorlage
    • Id
      • Die Id der Vorlage
    • PackageName
      • Der Name des Microservice-Pakets
    • PackageVersion
      • Die Version des Microservice-Pakets
Name                Id                                   PackageName         PackageVersion

----                --                                   -----------         --------------

SnmpConnector      a6e37f49-5a15-4213-96f5-e23cc03209a8 SnmpConnector        1.11.0.895

PS_Microservice1   33618fc3-60f2-484b-b6c9-b9f19c5eb4fa PS_Microservice1     1.1.0.1

Import-AESBMicroserviceTemplateConfig

Dieses Cmdlet importiert die Vorlagen-Konfiguration vom angegebenen Pfad.

Parameter DatentypErforderlichAliasBeschreibung
-ConnectionNameStringCDer Name der Verbindung, über die die Microservices-Vorlagen-Konfiguration importiert werden soll. Wenn nicht angegeben, wird die Standardverbindung verwendet.
-PathStringKeineDer Pfad, von dem die Konfiguration importiert werden soll.

Beispiele

Beispiel 1: Vorlagen-Konfiguration von $path laden

Import-AESBMicroserviceTemplateConfig -Path $path

Dieses Beispiel importiert die Vorlagen-Konfiguration beim hinterlegten Pfad. Die Standardverbindung wird verwendet.

Rückgabewerte

Bei erfolgreicher Anwendung erhalten Sie die gewünschte MicroserviceConfiguration zurück:

  • MicroserviceConfiguration
    • Version
      • Die jeweilige Version des Microservices
    • Type
      • Der Typ des Microservices
    • TypeConfiguration
      • Die jeweilige Typ-Konfiguration des Microservices
$microserviceTemplateConfig

MicroserviceConfiguration
-------------------------
MicroserviceConfiguration

$microserviceTemplateConfig.MicroserviceConfiguration

Version    Type          SnmpConnectorConfiguration
-------    ----          --------------------------
1.11.0.895 SnmpConnector SnmpConnectorConfiguration

Migrate-AESBMicroserviceTemplate

Mit diesem Cmdlet werden bestehende Vorlagen auf die gewünschte Zielversion übertragen.

Parameter DatentypErforderlichAliasBeschreibung
-ConnectionNameStringCDer Name der Verbindung, über die Microservice-Vorlagen migriert werden sollen. Wenn nicht angegeben, wird die Standardverbindung verwendet.
-TemplateNamesString[]KeineHier sind die Namen der Vorlagen, die übertragen werden sollen.
-TargetVersionStringKeineDie Zielversion, auf die die Vorlagen migriert werden sollen.
-KeepTemplateIdsSwitchParameterKeineHier wird festgelegt, ob die bestehenden Template-IDs gleich bleiben oder beim Migrieren neu erstellt werden sollen.

Beispiele

Beispiel 1: Mehrere Vorlagen auf Version $templateVersion migrieren

Migrate-AESBMicroserviceTemplates -TemplateNames $templateNames -TargetVersion $templateVersion

Dieses Beispiel migriert alle Vorlagen, die in $templateNames stehen, auf die Version $templateVersion.

Rückgabewerte

Bei erfolgreicher Anwendung erhalten Sie eine Liste von Vorlagen-Informationen mit den neuen Daten der erfolgreich migrierten Vorlagen:

  • TemplateInfo
    • TemplateId
      • Die neu erstellte / gleichbleibende Id der Vorlage
    • Configuration
      • Die aktuelle Konfiguration der Vorlage
    • Name
      • Der neue Name der Vorlage
    • Type
      • Der Typ der Vorlage
    • Version
      • Die neue Version der Vorlage
TemplateId    : ffffffff-ffff-ffff-ffff-ffffffffffff"
Configuration : <Configuration>
                  <SchedulingConfig>
                    <SchedulingConfig_Scheduling>Disabled</SchedulingConfig_Scheduling>
                  </SchedulingConfig>
                </Configuration>
Name          : TestTest_1_0_0_1
Type          : Test
Version       : 1.0.0.1

New-AESBMicroserviceTemplateConfig

Mit diesem Cmdlet wird eine neue Vorlagen-Konfiguration auf Basis des Pakets erstellt.

Parameter DatentypErforderlichAliasBeschreibung
-ConnectionNameStringCDer Name der Verbindung, über die die Microservice-Vorlagen-Konfiguration erstellt werden soll. Wenn nicht angegeben, wird die Standardverbindung verwendet.
-PackageNameStringKeineDer Name des Pakets.
-PackageVersionStringKeineDie Version des Pakets.

Beispiele

Beispiel 1: MicroserviceTemplateConfig erstellen

1
2
3
4
$packageVersion = "1.0.0.0"
$packageName = "Test"

New-AESBMicroserviceTemplateConfig -PackageName $packageName -PackageVersion $packageVersion

Dieses Beispiel erstellt eine Vorlagen-Konfiguration auf Basis des angegebenen Microservice-Pakets.

Rückgabewerte

  • MicroserviceConfiguration
    • Version
      • Die neue Version der Vorlage
    • Type
      • Der Typ der Vorlage
    • Configuration
      • Die aktuelle Konfiguration der Vorlage
1
2
3
4
5
6
7
8
9
10
11
$microserviceTemplateConfig = New-AESBMicroserviceTemplateConfig -PackageName $packageName -PackageVersion $packageVersion

MicroserviceConfiguration
-------------------------
MicroserviceConfiguration

$microserviceTemplateConfig.MicroserviceConfiguration

Version Type Configuration
------- ---- -------------
1.0.0.0 Test Configuration

Remove-AESBMicroserviceTemplate

Mit diesem Cmdlet können Sie Microservice-Vorlagen löschen.

Parameter DatentypErforderlichAliasBeschreibung
-ConnectionNameStringCDer Name der Verbindung, über die die Microservice-Vorlagen gelöscht werden sollen. Wenn nicht angegeben, wird die Standardverbindung verwendet.
-TemplateIdsString[]KeineDie ID's der Vorlagen, die zu löschen sind.
-RemoveReferencesSwitchParameterKeineGibt an ob alle erstellten Referenzen der Vorlagen mitgelöscht werden sollen.

Beispiele

Beispiel 1: Vorlage löschen

Remove-AESBMicroserviceTemplate -TemplateIds 4b016fd1-47fb-4f24-87dd-4e365fe870d3

Dieses Beispiel löscht eine Microservice-Vorlage auf Basis der angegebenen Id.

Beispiel 2: Vorlagen löschen

Remove-AESBMicroserviceTemplate -TemplateIds "4b016fd1-47fb-4f24-87dd-4e365fe870d3", "D1936807-E1B0-4F8B-AB7F-98ECD202CF8F"

Dieses Beispiel löscht mehrere Microservice-Vorlagen auf Basis der angegebenen Ids.

Beispiel 3: Vorlagen löschen mitsamt den Referenzen

Remove-AESBMicroserviceTemplate -TemplateIds "4b016fd1-47fb-4f24-87dd-4e365fe870d3" -RemoveReferences

Dieses Beispiel löscht eine Microservice-Vorlage mitsamt den erstellten Referenzen der Vorlage .

Rückgabewerte

  • RemoveMicroserviceTemplateStatusData
    • StatusResult
      • Ergebnis des Resultats des Vorgangs
    • TemplateId
      • Die erfolgreich gelöschte Id der Vorlage
    • Message
      • Status Nachricht 
StatusResult TemplateId                           Message
------------ ----------                           -------
     Success bde8016f-8557-4438-a165-ab05a4a78db4 The template was successfully removed.

Update-AESBMicroserviceTemplate

Dieses Cmdlet aktualisiert die Microservice-Vorlage mittels der beigefügten Microservice-Vorlagen-Konfiguration. 

Parameter DatentypErforderlichAliasBeschreibung
-ConnectionNameStringCDer Name der Verbindung, über die die Microservice-Vorlage aktualisiert werden soll. Wenn nicht angegeben, wird die Standardverbindung verwendet.
-TemplateIdStringKeineDie ID der Vorlage, die aktualisiert werden soll.
-TemplateConfigXmlDocumentKeineDie neue Microservices-Vorlagen-Konfiguration, die die aktuelle Konfiguration überschreiben soll.  

Beispiele

Beispiel 1: Vorlage updaten

1
2
3
4
5
6
7
8
9
10
$templateConfiguration = <MicroserviceConfiguration Version="1.0.0.0" Type="Test" SessionKey="72962557bb8bbd00b53dcb53d99cea685ed636bf">
  <Configuration>
    <SchedulingConfig>
      <SchedulingConfig_Scheduling>Enabled</SchedulingConfig_Scheduling>
    </SchedulingConfig>
  </Configuration>
</MicroserviceConfiguration>


Update-AESBMicroserviceTemplate -TemplateId "838fb7e2-e293-4004-9602-7223aaa3854a" -TemplateConfig $templateConfiguration

Dieses Beispiel updated die Vorlage mit der beigefügten Konfiguration.

Rückgabewerte

  • Templateinfo
    • TemplateId
    • Configuration
    • Name
    • Type
    • Version
TemplateId    : 838fb7e2-e293-4004-9602-7223aaa3854a
Configuration : <Configuration>
                  <SchedulingConfig>
                    <SchedulingConfig_Scheduling>Enabled</SchedulingConfig_Scheduling>
                  </SchedulingConfig>
                </Configuration>
Name          : ASDASDASD
Type          : ASD
Version       : 1.0.0.0
© Aagon GmbH 2025
Besuchen Sie unsere Aagon-Community