Changes for page Microservice Cmdlets

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

From 3.2 to 4.1 From 4.4 to 4.5

From version 4.1

edited by jklein
on 2025/06/23 10:40

Change comment: There is no comment for this version

To version 4.4

edited by jklein
on 2025/06/24 10:55

Change comment: There is no comment for this version

Raw
Rendered

Summary

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

Details

Page properties

Content

@@ -533,7 +533,6 @@
  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. Wird die Standardverbindung verwendet, wenn nicht angegeben.
  |-SupervisorId|String|❌|Keine|Gibt die ID des Supervisors an, dessen zugehörige Microservices gestoppt werden sollen. Obligatorisch für Parametersatz `UseSupervisorIdParameterSet`.
@@ -591,10 +591,155 @@
  == 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. Wird die Standardverbindung verwendet, wenn nicht angegeben.
++
++=== **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. Wird die Standardverbindung verwendet, wenn nicht angegeben.
++|-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"}}
++
++{{/apimacro}}
++
++=== **Rückgabewerte** ===
++
++Bei erfolgreicher Anwendung bekommt man 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="Rcükgabewerte der Template-Konfiguration"}}
++
++{{/apimacro}}
++
++**Beispiel Template Konfiguration**
++
++|(((
++1
++
++2
++
++3
++
++4
++
++5
++
++6
++
++7
++
++8
++
++9
++
++10
++
++11
++
++12
++
++13
++
++14
++)))|(((
++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
++)))
++
++
++
  == Export-MicroserviceTemplateConfig ==
  == Get-AESBMicroserviceTemplateConfig ==