Changes for page Microservice Cmdlets

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

From 3.1 to 2.9 From 8.1 to 7.1

From version 7.1

edited by jklein
on 2025/07/16 09:56

Change comment: There is no comment for this version

To version 3.1

edited by jklein
on 2025/06/20 11:01

Change comment: There is no comment for this version

Raw
Rendered

Summary

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

Details

Page properties

Content

@@ -7,7 +7,7 @@
  Mit diesem Cmdlet wird eine neue Microservice-Instanz nach der Vorlage eines Templates hinzugefügt.
  |=(% style="width: 213px;" %)Parameter |=(% style="width: 209px;" %)ParameterSetName|=(% style="width: 217px;" %)Datentyp|=Optional|=Alias|=Beschreibung
--|-ConnectionName|Keine|String|✅|C|Der Name der Verbindung, über die die Microservice-Instanz hinzugefügt werden soll. Wenn nicht angegeben, wird die Standardverbindung verwendet.
++|-ConnectionName|Keine|String|✅|C|Der Name der Verbindung, über die die Microservice-Instanz hinzugefügt werden soll. Wird die Standardverbindung verwendet, wenn nicht angegeben.
  |-InstanceName|Keine|String|❌|Keine|Der Name der Instanz.
  |-TemplateName|UseTemplateName|String|❌|Keine|Der Name des Templates für die Vorlage der Instanz.
  |-TemplateId|UseTemplateId|String|❌|Keine|Die Id des Templates für die Vorlage der Instanz.
@@ -77,7 +77,7 @@
  Mit den optionalen Parametern können Sie die Ausgabe filtern und spezifische Microservices oder Instanzen abrufen.
  |=(% style="width: 213px;" %)Parameter |=(% style="width: 217px;" %)Datentyp|=Optional|=Alias|=Beschreibung
--|-ConnectionName|String|✅|C|Der Name der Verbindung, Informationen zu Microservice-Instanzen abgerufen werden sollen. Wenn nicht angegeben, wird die Standardverbindung verwendet.
++|-ConnectionName|String|✅|C|Der Name der Verbindung, Informationen zu Microservice-Instanzen abgerufen werden sollen. Wird die Standardverbindung verwendet, wenn nicht angegeben.
  |-InstanceNames|String[]|✅❌| |Gibt die Namen der Microservice-Instanzen an, die abgerufen werden sollen. Du kannst einen oder mehrere Instanznamen als String-Array übergeben.
  |-SupervisorIds|String[]|✅❌| |Filtert Microservices basierend auf den IDs ihrer übergeordneten Supervisoren. Du musst eine oder mehrere Supervisor-IDs als String-Array übergeben.
  |-ShowAllInstances|SwitchParameter|✅| |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.
@@ -155,12 +155,12 @@
  * **CpuUsage**: Die aktuelle CPU-Auslastung des Microservices in Prozent.
  * **MemoryUsage**: Die aktuelle Speicherauslastung des Microservices in Bytes.
--== Edit-AESBMicroservice ==
++== Edit-AESBMicroservices ==
  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.
  |=(% style="width: 213px;" %)Parameter |=(% style="width: 209px;" %)ParameterSetName|=Datentyp|=Optional|=Beschreibung
--|-ConnectionName| |String|✅|Der Name der Verbindung, über die Microservice-Instanzen bearbeitet werden sollen. Wenn nicht angegeben, wird die Standardverbindung verwendet.
++|-ConnectionName| |String|✅|Der Name der Verbindung, über die Microservice-Instanzen bearbeitet werden sollen. Wird die Standardverbindung verwendet, wenn nicht angegeben.
  |-InstanceName|NoCredentialParameterSetName,
  CredentialParameterSetName|String|❌|Gibt den eindeutigen Namen der Microservice-Instanz an, deren Konfiguration geändert werden soll. Dieser Parameter ist in beiden Parametersets obligatorisch.
  |-UseCredentials|CredentialParameterSetName|SwitchParameter|✅❌|Gibt an, dass Anmeldeinformationen für den Microservice konfiguriert werden sollen. Dieser Parameter gehört zum CredentialParameterSetName und ist obligatorisch, wenn dieses Set verwendet wird.
@@ -203,7 +203,7 @@
  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.
  |=(% style="width: 213px;" %)Parameter |=(% style="width: 209px;" %)ParameterSetName|=Datentyp|=Optional|=Beschreibung
--|-ConnectionName| |String|✅|Der Name der Verbindung, über welche die Ausführung von Microservice-Instanzen abgebrochen werden soll. Wenn nicht angegeben, wird die Standardverbindung verwendet.
++|-ConnectionName| |String|✅|Der Name der Verbindung, über welche die Ausführung von Microservice-Instanzen abgebrochen werden soll. Wird die Standardverbindung verwendet, wenn nicht angegeben.
  |-InstanceIds|UseMicroservicesIdListParameterSet|String[]|✅❌|Gibt eine Liste von eindeutigen Instanz-IDs (GUIDs als String) der Microservices an, die beendet werden sollen.
  |-SupervisorId|UseSupervisorIdParameterSet|String|✅❌|Der **SupervisorId**-Parameter gibt die eindeutige ID (GUID als String) des Supervisors an. Alle Microservices, die von diesem spezifischen Supervisor verwaltet werden, werden beendet.
@@ -259,7 +259,7 @@
  |=(% style="width: 213px;" %)Parameter |=(% style="width: 217px;" %)Datentyp|=Optional|=Alias|=Beschreibung
--|-ConnectionName|String|✅|C|Der Name der Verbindung, über die Microservice-Instanzen verschoben werden sollen. Wenn nicht angegeben, wird die Standardverbindung verwendet.
++|-ConnectionName|String|✅|C|Der Name der Verbindung, über die Microservice-Instanzen verschoben werden sollen. Wird die Standardverbindung verwendet, wenn nicht angegeben.
  |-InstanceIds|String[]|❌| |Die IDs der zu verschiebenden Microservice-Instanzen (Pflichtfeld, unterstützt mehrere Werte)
  |-SupervisorId|String|❌| |Die Ziel-SupervisorId, auf die die Instanzen verschoben werden sollen
  |-Timeout|String|✅| |Optionales Timeout für die Operation (Standard: "30s")
@@ -373,7 +373,7 @@
  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. Wenn nicht angegeben, wird die Standardverbindung verwendet.
++|-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".
@@ -426,670 +426,28 @@
  == 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. Wenn nicht angegeben, wird die Standardverbindung verwendet.
--|-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. Wenn nicht angegeben, wird die Standardverbindung verwendet.
--|-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 ==
--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.
--
--|=(% style="width: 213px;" %)Parameter |=(% style="width: 217px;" %)Datentyp|=Optional|=Alias|=Beschreibung
--|-ConnectionName|String|✅|C|Der Name der Verbindung, über die Microservice-Instanzen gestoppt werden sollen. Wenn nicht angegeben, wird die Standardverbindung verwendet.
--|-SupervisorId|String|❌|Keine|Gibt die ID des Supervisors an, dessen zugehörige Microservices gestoppt werden sollen. Obligatorisch für Parametersatz `UseSupervisorIdParameterSet`.
--|-InstanceIds|String[]|❌|Keine|Gibt 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`.
--|-Timeout|String|✅|Keine|Gibt die maximale Wartezeit für den Stoppvorgang an (z.B. "5s", "1m"). Standardwert: "5s".
--|-NoWait      |SwitchParameter|✅|Keine|Wenn dieser Parameter angegeben ist, wartet das Cmdlet nicht auf den Abschluss des Stoppvorgangs, sondern kehrt sofort zurück.
--
--=== **Beispiele** ===
--
--Beispiel 1: Einen Microservice anhand seiner Instanz-ID stoppen
--
--{{code language="PowerShell"}}
--Stop-AESBMicroservices -InstanceIds "c7e323e9-abc1-4150-a4a3-afb4e57e9cb1"
--{{/code}}
--
--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
--
--{{code language="PowerShell"}}
--Stop-AESBMicroservices -InstanceIds "01234567-89ab-cdef-0123-456789abcdef", "fedcba98-7654-3210-fedc-ba9876543210" -Timeout "10s"
--
--{{/code}}
--
--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
--
--{{code language="PowerShell"}}
--Stop-AESBMicroservices -SupervisorId "FinanceSupervisor" -NoWait
--
--{{/code}}
--
--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
--
--{{code language="PowerShell"}}
--"c7e323e9-abc1-4150-a4a3-afb4e57e9cb1", "another-guid-for-stop" | Stop-AESBMicroservices
--
--{{/code}}
--
--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.
--
--|=(% style="width: 213px;" %)Parameter |=(% style="width: 217px;" %)Datentyp|=Optional|=Alias|=Beschreibung
--|-ConnectionName|String|✅|C|Der 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
--
--{{code language="PowerShell"}}
--Get-AESBMicroservicePackages
--
--{{/code}}
--
--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.
--
--|=(% style="width: 213px;" %)Parameter |=(% style="width: 217px;" %)Datentyp|=Optional|=Alias|=Beschreibung
--|-ConnectionName|String|✅|C|Der Name der Verbindung, über die eine Vorlage hinzugefügt werden soll. Wenn nicht angegeben, wird die Standardverbindung verwendet.
--|-TemplateName|String|❌|Keine|Der Name für die Vorlage.
--|-TemplateConfig|XmlDocument|❌|Keine|Die Konfiguration der Vorlage.
--
--=== **Beispiele** ===
--
--Beispiel 1: Fügt ein neues Microservice-Template hinzu
--
--{{code language="PowerShell"}}
--Add-AESBMicroserviceTemplate -TemplateName "Test" -TemplateConfig $templateConfig
--{{/code}}
--
--Dieses Beispiel fügt eine neue Templatekonfiguration mit dem Namen "Test" auf Basis des $templateConfig-Objekts hinzu. Die Standardverbindung wird verwendet.
--
--{{apimacro title="Beispiel der Funktion in PowerShell"}}
--{{code language="PowerShell" layout="LINENUMBERS"}}
--function Add-MicroserviceTemplate {
--    param (
--        [string]$Name
--    )
--
--    $packages = Get-AESBMicroservicePackages
--
--    $microserviceTemplateConfig = New-AESBMicroserviceTemplateConfig -PackageName $packages[0].PackageName -PackageVersion $packages[0].PackageVersions[0]
--
--    $addMicroserviceResult = Add-AESBMicroserviceTemplate -TemplateName $Name -TemplateConfig $microserviceTemplateConfig
--
--    return $addMicroserviceResult
--}
--{{/code}}
--{{/apimacro}}
--
--{{apimacro title="Beispiel der Template-Konfiguration"}}
--{{code language="PowerShell" layout="LINENUMBERS"}}
--$templateConfig = "<MicroserviceConfiguration Version=`"1.11.0.895`" Type=`"SnmpConnector`" SessionKey=`"bcafdb4e94f2572eed78525430ad0e0275229f98`">
--  <SnmpConnectorConfiguration>
--    <SnmpReader>
--      <ParallelRequests>10</ParallelRequests>
--      <SchedulingConfig>
--        <SchedulingConfig_Scheduling>Interval</SchedulingConfig_Scheduling>
--        <SchedulingConfig_Interval>P1D</SchedulingConfig_Interval>
--        <SchedulingConfig_IgnoreLastExecutionTime>false</SchedulingConfig_IgnoreLastExecutionTime>
--      </SchedulingConfig>
--      <Groups />
--      <GlobalCredentialLists>
--        <GlobalCredentials />
--        <GlobalCredentialsNoPriv />
--        <GlobalCredentialsNoAuthNoPriv />
--      </GlobalCredentialLists>
--    </SnmpReader>
--    <SnmpWriters>
--      <DescriptionWriteMode>Keep</DescriptionWriteMode>
--      <LocationWriteMode>Ignore</LocationWriteMode>
--      <ContactWriteMode>Ignore</ContactWriteMode>
--      <ProcessorWriter />
--      <DispatcherStarter />
--      <FileDumper />
--    </SnmpWriters>
--  </SnmpConnectorConfiguration>
--</MicroserviceConfiguration>"
--{{/code}}
--{{/apimacro}}
--
--=== **Rückgabewerte** ===
--
--Bei erfolgreicher Anwendung erhalten Sie zwei Objekte zurück.
--
--* String
--** Erfolgreiche Statusmeldung
--* TemplateInfo
--** TemplateId
--*** ID des Templates
--** Configuration
--*** Aktuelle Konfiguration des Templates
--** Name
--*** Name des Templates
--** Type
--*** Der Typ des Templates
--** Version
--*** Die Versionierung des Templates
--
--{{apimacro title="Rückgabewerte der Template-Konfiguration"}}
--{{code language="PowerShell" layout="LINENUMBERS"}}
--Successfully added template 'Test'.
--
--TemplateId    : 119398aa-8108-43bd-811b-bd3e703e7f5c
--Configuration : <SnmpConnectorConfiguration><SnmpReader><ParallelRequests>10</ParallelRequests><SchedulingConfig><Sched
--                ulingConfig_Scheduling>Interval</SchedulingConfig_Scheduling><SchedulingConfig_Interval>P1D</Scheduling
--                Config_Interval><SchedulingConfig_IgnoreLastExecutionTime>false</SchedulingConfig_IgnoreLastExecutionTi
--                me></SchedulingConfig><Groups /><GlobalCredentialLists><GlobalCredentials /><GlobalCredentialsNoPriv
--                /><GlobalCredentialsNoAuthNoPriv /></GlobalCredentialLists></SnmpReader><SnmpWriters><DescriptionWriteM
--                ode>Keep</DescriptionWriteMode><LocationWriteMode>Ignore</LocationWriteMode><ContactWriteMode>Ignore</C
--                ontactWriteMode><ProcessorWriter /><DispatcherStarter /><FileDumper
--                /></SnmpWriters></SnmpConnectorConfiguration>
--Name          : Test
--Type          : SnmpConnector
--Version       : 1.11.0.895
--{{/code}}
--{{/apimacro}}
--
  == Export-MicroserviceTemplateConfig ==
--Dieses Cmdlet ermöglicht es, die Konfiguration einer Microservice-Vorlagen zu exportieren.
--
--|=(% style="width: 213px;" %)Parameter |=(% style="width: 217px;" %)Datentyp|=Optional|=Alias|=Beschreibung
--|-ConnectionName|String|✅|C|Der Name der Verbindung, über die die Microservice-Vorlagen-Konfiguration exportiert werden soll. Wenn nicht angegeben, wird die Standardverbindung verwendet.
--|-TemplateConfig|XmlDocument|❌|Keine|Die Konfiguration, die exportiert werden soll.
--|-Path|String|❌|Keine|Der Pfad, unter dem die Microservice-Vorlagen-Konfiguration gespeichert werden soll.
--
--=== **Beispiele** ===
--
--Beispiel 1: MicroserviceTemplate exportieren
--
--{{code language="PowerShell"}}
--Export-AESBMicroserviceTemplateConfig -TemplateConfig $templateConfig -Path $path
--
--{{/code}}
--
--In diesem Beispiel wird die //$templateConfig// am Speicherort "C:\Test.xml" exportiert.
--
--{{code language="PowerShell" layout="LINENUMBERS"}}
--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
--}
--{{/code}}
--
--{{apimacro title="Beispielhafte XML-Datei nach dem Exportieren"}}
--{{code language="XML" layout="LINENUMBERS"}}
--<MicroserviceConfiguration Version="1.11.0.895" Type="SnmpConnector" SessionKey="bcafdb4e94f2572eed78525430ad0e0275229f98">
--  <SnmpConnectorConfiguration>
--    <SnmpReader>
--      <ParallelRequests>10</ParallelRequests>
--      <SchedulingConfig>
--        <SchedulingConfig_Scheduling>Interval</SchedulingConfig_Scheduling>
--        <SchedulingConfig_Interval>P1D</SchedulingConfig_Interval>
--        <SchedulingConfig_IgnoreLastExecutionTime>false</SchedulingConfig_IgnoreLastExecutionTime>
--      </SchedulingConfig>
--      <Groups />
--      <GlobalCredentialLists>
--        <GlobalCredentials />
--        <GlobalCredentialsNoPriv />
--        <GlobalCredentialsNoAuthNoPriv />
--      </GlobalCredentialLists>
--    </SnmpReader>
--    <SnmpWriters>
--      <DescriptionWriteMode>Keep</DescriptionWriteMode>
--      <LocationWriteMode>Ignore</LocationWriteMode>
--      <ContactWriteMode>Ignore</ContactWriteMode>
--      <ProcessorWriter />
--      <DispatcherStarter />
--      <FileDumper />
--    </SnmpWriters>
--  </SnmpConnectorConfiguration>
--</MicroserviceConfiguration>
--{{/code}}
--{{/apimacro}}
--
--=== Rückgabewerte ===
--
--Nach erfolgreichem Exportieren erhalten Sie eine Statusmeldung zurück.
--
--{{code language="none"}}
--Writing the file was successful.
--
--{{/code}}
--
  == Get-AESBMicroserviceTemplateConfig ==
--Dieses Cmdlet fragt die TemplateConfig einer bestimmten Microservice-Vorlage ab.
--
--|=(% style="width: 213px;" %)Parameter |=(% style="width: 217px;" %)Datentyp|=Optional|=Alias|=Beschreibung
--|-ConnectionName|String|✅|C|Der Name der Verbindung, über die die Microservice-Vorlagen-Konfiguration exportiert werden soll. Wenn nicht angegeben, wird die Standardverbindung verwendet.
--|-TemplateName|String|❌|Keine|Der Name der Vorlage für die gewünschte Konfiguration.
--
--=== Beispiele ===
--
--Beispiel 1: MicroserviceTemplateConfig von //$templateName// anfragen
--
--{{code language="PowerShell"}}
--Get-AESBMicroserviceTemplateConfig -TemplateName $templateName
--{{/code}}
--
--Dieses Beispiel fragt die Templatekonfiguration mit dem Namen //$templateName// an. Die Standardverbindung wird verwendet.
--
--{{code language="PowerShell" layout="LINENUMBERS"}}
--function Get-MicroserviceTemplateConfig {
--
--    $aesbMicroserviceTemplates = Get-AESBMicroserviceTemplates
--
--    $microserviceTemplateConfig = Get-AESBMicroserviceTemplateConfig -TemplateName $aesbMicroserviceTemplates[0].Name
--
--    return $microserviceTemplateConfig
--}
--{{/code}}
--
--=== Rückgabewerte ===
--
--Bei erfolgreicher Anwendung erhalten Sie die gewünschte Microservice-Konfiguration zurück:
--
--* MicroserviceConfiguration
--** Version
--*** Die jeweilige Versionierung des Microservices
--** Type
--*** Der Typ des Microservices
--** TypeConfiguration
--*** Die jeweilige Typ-Konfiguration des Microservices
--
--{{code language="PowerShell"}}
--$microserviceTemplateConfig
--
--MicroserviceConfiguration
---------------------------
--MicroserviceConfiguration
--
--$microserviceTemplateConfig.MicroserviceConfiguration
--
--Version    Type          SnmpConnectorConfiguration
---------    ----          --------------------------
--1.11.0.895 SnmpConnector SnmpConnectorConfiguration
--{{/code}}
--
  == Import-AESBMicroserviceTemplateConfig ==
--Dieses Cmdlet importiert die Templatekonfiguration vom angegebenen Pfad.
--
--|=(% style="width: 213px;" %)Parameter |=(% style="width: 217px;" %)Datentyp|=Optional|=Alias|=Beschreibung
--|-ConnectionName|String|✅|C|Der Name der Verbindung, über die die Microservices-Vorlagen-Konfiguration importiert werden soll. Wenn nicht angegeben, wird die Standardverbindung verwendet.
--|-Path|String|❌|Keine|Der Pfad, von dem die Konfiguration importiert werden soll.
--
--=== Beispiele ===
--
--Beispiel 1: Templatekonfiguration von //$path// laden
--
--{{code language="PowerShell"}}
--Import-AESBMicroserviceTemplateConfig -Path $path
--
--{{/code}}
--
--Dieses Beispiel importiert die Templatekonfiguration beim hinterlegten Pfad. Die Standardverbindung wird verwendet.
--
--=== Rückgabewerte ===
--
--Bei erfolgreicher Anwendung erhalten Sie die gewünschte MicroserviceConfiguration zurück:
--
--* MicroserviceConfiguration
--** Version
--*** Die jeweilige Versionierung des Microservices
--** Type
--*** Der Typ des Microservices
--** TypeConfiguration
--*** Die jeweilige Typ-Konfiguration des Microservices
--
--{{code language="PowerShell"}}
--$microserviceTemplateConfig
--
--MicroserviceConfiguration
---------------------------
--MicroserviceConfiguration
--
--$microserviceTemplateConfig.MicroserviceConfiguration
--
--Version    Type          SnmpConnectorConfiguration
---------    ----          --------------------------
--1.11.0.895 SnmpConnector SnmpConnectorConfiguration
--{{/code}}
--
  == Migrate-AESBMicroserviceTemplate ==
--Mit diesem Cmdlet werden bestehende Vorlagen auf die gewünschte Zielversion übertragen.
--
--|=(% style="width: 213px;" %)Parameter |=(% style="width: 217px;" %)Datentyp|=Optional|=Alias|=Beschreibung
--|-ConnectionName|String|✅|C|Der Name der Verbindung, über die Microservice-Vorlagen migriert werden sollen. Wenn nicht angegeben, wird die Standardverbindung verwendet.
--|-TemplateNames|String[]|❌|Keine|Hier sind die Namen der Vorlagen, die übertragen werden sollen.
--|-TargetVersion|String|❌|Keine|Die Zielversion, auf die die Vorlagen migriert werden sollen.
--|-KeepTemplateIds|SwitchParameter|✅|Keine|Hier wird festgelegt, ob die bestehenden Template-IDs gleich bleiben oder beim Migrieren neu erstellt werden sollen.
--
--=== Beispiele ===
--
--Beispiel 1: Mehrere Templates auf Version //$templateVersion// migrieren
--
--{{code language="PowerShell"}}
--Migrate-AESBMicroserviceTemplates -TemplateNames $templateNames -TargetVersion $templateVersion
--
--{{/code}}
--
--Dieses Beispiel migriert alle Templates die in //$templateNames// stehen auf die Version //$templateVersion//.
--
--=== Rückgabewerte ===
--
--Bei erfolgreicher Anwendung erhalten Sie eine Liste von Template-Informationen mit den neuen Daten der erfolgreich migrierten Templates:
--
--* TemplateInfo
--** TemplateId
--*** Die neu erstellte / gleichbleibende Id des Templates
--** Configuration
--*** Die aktuelle Konfiguration des Templates
--** Name
--*** Der neue Name des Template
--** Type
--*** Der Typ des Templates
--** Version
--*** Die neue Version des Templates
--
--{{code language="PowerShell"}}
--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
--{{/code}}
--
  == New-AESBMicroserviceTemplateConfig ==
--Mit diesem Cmdlet wird eine neue Vorlagen-Konfiguration auf Basis des Pakets erstellt.
--
--|=(% style="width: 213px;" %)Parameter |=(% style="width: 217px;" %)Datentyp|=Optional|=Alias|=Beschreibung
--|-ConnectionName|String|✅|C|Der Name der Verbindung, über die die Microservice-Vorlagen-Konfiguration erstellt werden soll. Wenn nicht angegeben, wird die Standardverbindung verwendet.
--|-PackageName|String|❌|Keine|Der Name des Pakets.
--|-PackageVersion|String|❌|Keine|Die Version des Pakets.
--
--=== Beispiele ===
--
--Beispiel 1: MicroserviceTemplateConfig erstellen
--
--{{code language="PowerShell" layout="LINENUMBERS"}}
--$packageVersion = "1.0.0.0"
--$packageName = "Test"
--
--New-AESBMicroserviceTemplateConfig -PackageName $packageName -PackageVersion $packageVersion
--{{/code}}
--
--Dieses Beispiel erstellt eine Template-Konfiguration auf Basis des angegebenen Microservicepackage.
--
--=== Rückgabewerte ===
--
--* MicroserviceConfiguration
--** Version
--*** Die neue Version des Templates
--** Type
--*** Der Typ des Templates
--** Configuration
--*** Die aktuelle Konfiguration des Templates
--
--{{code language="PowerShell" layout="LINENUMBERS"}}
--$microserviceTemplateConfig = New-AESBMicroserviceTemplateConfig -PackageName $packageName -PackageVersion $packageVersion
--
--MicroserviceConfiguration
---------------------------
--MicroserviceConfiguration
--
--$microserviceTemplateConfig.MicroserviceConfiguration
--
--Version Type Configuration
--------- ---- -------------
--1.0.0.0 Test Configuration
--{{/code}}
--
  == Remove-AESBMicroserviceTemplate ==
--Mit diesem Cmdlet können Sie Microservice-Vorlagen löschen.
--
--
--|=(% style="width: 213px;" %)Parameter |=(% style="width: 217px;" %)Datentyp|=Optional|=Alias|=Beschreibung
--|-ConnectionName|String|✅|C|Der Name der Verbindung, über die die Microservice-Vorlagen gelöscht werden sollen. Wenn nicht angegeben, wird die Standardverbindung verwendet.
--|-TemplateIds|String[]|❌|Keine|Die ID's der Vorlagen, die zu löschen sind.
--|-RemoveReferences|SwitchParameter|✅|Keine|Gibt an ob alle erstellten Referenzen der Vorlagen mitgelöscht werden sollen.
--
--=== Beispiele ===
--
--Beispiel 1: Template löschen
--
--{{code language="PowerShell"}}
--Remove-AESBMicroserviceTemplate -TemplateIds 4b016fd1-47fb-4f24-87dd-4e365fe870d3
--
--{{/code}}
--
--Dieses Beispiel löscht ein Microservice Template auf Basis der angegebenen Id.
--
--Beispiel 2: Templates löschen
--
--{{code language="PowerShell"}}
--Remove-AESBMicroserviceTemplate -TemplateIds "4b016fd1-47fb-4f24-87dd-4e365fe870d3", "D1936807-E1B0-4F8B-AB7F-98ECD202CF8F"
--{{/code}}
--
--Dieses Beispiel löscht mehrere Microservice Templates auf Basis der angegebenen Ids.
--
--Beispiel 3: Templates löschen mitsamt den Referenzen
--
--{{code language="PowerShell"}}
--Remove-AESBMicroserviceTemplate -TemplateIds "4b016fd1-47fb-4f24-87dd-4e365fe870d3" -RemoveReferences
--
--{{/code}}
--
--Dieses Beispiel löscht ein Microservice Template misamt den erstellten Referenzen des Templates.
--
--=== Rückgabewerte ===
--
--* RemoveMicroserviceTemplateStatusData
--** StatusResult
--*** Ergebnis des Resultats des Vorgangs
--** TemplateId
--*** Die erfolgreich gelöschte Id des Templates
--** Message
--*** Status Nachricht
--
--{{code language="PowerShell"}}
--StatusResult TemplateId                           Message
-------------- ----------                           -------
--     Success bde8016f-8557-4438-a165-ab05a4a78db4 The template was successfully removed.
--{{/code}}
--
  == Update-AESBMicroserviceTemplate ==
--
--Dieses Cmdlet aktualisiert die Microservice-Vorlage mittels der beigefügten Microservice-Vorlagen-Konfiguration.
--
--|=(% style="width: 213px;" %)Parameter |=(% style="width: 217px;" %)Datentyp|=Optional|=Alias|=Beschreibung
--|-ConnectionName|String|✅|C|Der Name der Verbindung, über die die Microservice-Vorlage aktualisiert werden soll. Wenn nicht angegeben, wird die Standardverbindung verwendet.
--|-TemplateId|String|❌|Keine|Die ID der Vorlage, die aktualisiert werden soll.
--|-TemplateConfig|XmlDocument|❌|Keine|Die neue Microservices-Vorlagen-Konfiguration, die die aktuelle Konfiguration überschreiben soll.
--
--=== Beispiele ===
--
--Beispiel 1: Template updaten
--
--{{code language="PowerShell" layout="LINENUMBERS"}}
--$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
--{{/code}}
--
--Dieses Beispiel updated das Template mit der beigefügten Konfiguration.
--
--=== Rückgabewerte ===
--
--* Templateinfo
--** TemplateId
--** Configuration
--** Name
--** Type
--** Version
--
--{{code language="PowerShell"}}
--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
--{{/code}}