PowerShell API-Wrapper Tutorial - Versionsgeschichte

Dweuthen am 18. September 2014 um 13:21 Uhr

2014-09-18T13:21:32Z

Dweuthen: Der Seiteninhalt wurde durch einen anderen Text ersetzt: „{{:en:PowerShell API Wrapper Tutorial}} de:PowerShell API-Wrapper Tutorial en:PowerShell API Wrapper Tutorial“

2014-06-23T09:34:17Z

Der Seiteninhalt wurde durch einen anderen Text ersetzt: „{{:en:PowerShell API Wrapper Tutorial}} de:PowerShell API-Wrapper Tutorial en:PowerShell API Wrapper Tutorial“

Änderungen zeigen

Admin am 9. April 2014 um 08:37 Uhr

2014-04-09T08:37:51Z

Admin am 9. April 2014 um 08:25 Uhr

2014-04-09T08:25:37Z

Admin am 14. Februar 2014 um 10:41 Uhr

2014-02-14T10:41:39Z

Admin: Admin verschob Seite PowerShell-API-Wrapper Tutorial nach PowerShell API-Wrapper Tutorial

2014-02-10T10:10:41Z

Admin verschob Seite PowerShell-API-Wrapper Tutorial nach PowerShell API-Wrapper Tutorial

Admin am 10. Februar 2014 um 10:10 Uhr

2014-02-10T10:10:04Z

Admin am 7. Februar 2014 um 16:49 Uhr

2014-02-07T16:49:53Z

Admin: /* API Wrapper PowerShell Jobs asynchron verarbeiten */

2014-02-05T11:10:00Z

API Wrapper PowerShell Jobs asynchron verarbeiten

Admin: /* API Wrapper PowerShell Jobs synchron verarbeiten */

2014-02-05T11:09:24Z

API Wrapper PowerShell Jobs synchron verarbeiten

@@ Zeile 1: / Zeile 1: @@
-{{:en:PowerShell API Wrapper Tutorial}}
+{{raw::en:PowerShell API Wrapper Tutorial}}
 [[de:PowerShell API-Wrapper Tutorial]]
 [[en:PowerShell API Wrapper Tutorial]]

← Nächstältere Version		Version vom 9. April 2014, 08:37 Uhr
Zeile 184:		Zeile 184:
	Durch diese Mechanismen kann das Skript im Vordergrund weitere Aufgaben ausführen, während im Hintergrund der Serverprozess überwacht wird. Auch die Ausführung und Behandlung mehrerer asynchroner API Befehle ist so möglich.		Durch diese Mechanismen kann das Skript im Vordergrund weitere Aufgaben ausführen, während im Hintergrund der Serverprozess überwacht wird. Auch die Ausführung und Behandlung mehrerer asynchroner API Befehle ist so möglich.

		+	[[de:PowerShell API-Wrapper Tutorial]]
	[[en:PowerShell API Wrapper Tutorial]]		[[en:PowerShell API Wrapper Tutorial]]

← Nächstältere Version		Version vom 9. April 2014, 08:25 Uhr
Zeile 184:		Zeile 184:
	Durch diese Mechanismen kann das Skript im Vordergrund weitere Aufgaben ausführen, während im Hintergrund der Serverprozess überwacht wird. Auch die Ausführung und Behandlung mehrerer asynchroner API Befehle ist so möglich.		Durch diese Mechanismen kann das Skript im Vordergrund weitere Aufgaben ausführen, während im Hintergrund der Serverprozess überwacht wird. Auch die Ausführung und Behandlung mehrerer asynchroner API Befehle ist so möglich.

−	~~[[de:PowerShell API-Wrapper Tutorial]]~~
	[[en:PowerShell API Wrapper Tutorial]]		[[en:PowerShell API Wrapper Tutorial]]

← Nächstältere Version		Version vom 14. Februar 2014, 10:41 Uhr
Zeile 183:		Zeile 183:

	Durch diese Mechanismen kann das Skript im Vordergrund weitere Aufgaben ausführen, während im Hintergrund der Serverprozess überwacht wird. Auch die Ausführung und Behandlung mehrerer asynchroner API Befehle ist so möglich.		Durch diese Mechanismen kann das Skript im Vordergrund weitere Aufgaben ausführen, während im Hintergrund der Serverprozess überwacht wird. Auch die Ausführung und Behandlung mehrerer asynchroner API Befehle ist so möglich.
		+
		+	[[de:PowerShell API-Wrapper Tutorial]]
		+	[[en:PowerShell API Wrapper Tutorial]]

@@ Zeile 3: / Zeile 3: @@
 Dieses Tutorial erläutert anhand einfacher Beispiele den Umgang mit der [[MailStore Server Administration API]] mittels Windows PowerShell Skripten. Grundlegende MailStore Server, Windows und PowerShell Kenntnisse werden dabei vorausgesetzt.
-Der im Tutorial verwendete API Wrapper stellt eine Beispielimplementierung eines MailStore Server Administration API Clients dar. Da die Kommunikation mit der Administration API in Form von Web Requests mittels HTTPS erfolgt, können selbstverständlich auch eigene Implementierungen verwendet werden, welche mit entsprechenden PowerShell Cmdlets arbeiten. Diese Möglichkeit wird hier allerdings nicht weiter betrachtet.
+Der im Tutorial verwendete API-Wrapper stellt eine Beispielimplementierung eines MailStore Server Administration API Clients dar. Da die Kommunikation mit der Administration API in Form von Web Requests mittels HTTPS erfolgt, können selbstverständlich auch eigene Implementierungen verwendet werden, welche mit entsprechenden PowerShell Cmdlets arbeiten. Diese Möglichkeit wird hier allerdings nicht weiter betrachtet.
 <p class=msnote>'''Hinweis:''' Es wird empfohlen, für dieses Tutorial und grundsätzlich für die Skriptentwicklung eine eigene, nicht produktive Installation von MailStore Server in einer Testumgebung zu verwenden, um Probleme und Datenverluste in der Produktivumgebung zu vermeiden. Hierfür eignet sich z.B. die voll funktionsfähige, 30-Tage-Testversion von MailStore Server.</p>
@@ Zeile 9: / Zeile 9: @@
 = Installation der benötigten Komponenten =
-Die gezeigten Beispiele nutzen den MailStore PowerShell API Wrapper und sind wie dieser auf Windows PowerShell ab Version 3.0 lauffähig. Abhängig von der verwendeten Windows Version muss eine kompatible PowerShell Version zunächst heruntergeladen und installiert werden. Die für das Tutorial benötigten Komponenten finden Sie hier:
+Die gezeigten Beispiele nutzen den MailStore PowerShell API-Wrapper und sind wie dieser auf Windows PowerShell ab Version 3.0 lauffähig. Abhängig von der verwendeten Windows Version muss eine kompatible PowerShell Version zunächst heruntergeladen und installiert werden. Die für das Tutorial benötigten Komponenten finden Sie hier:
-* [ftp://ftp.mailstore.com/pub/Scripts/PowerShell/MailStore_Server_Scripting_Tutorial.zip MailStore PowerShell API Wrapper und Tutorial Beispielskripte]
+* [ftp://ftp.mailstore.com/pub/Scripts/PowerShell/MailStore_Server_Scripting_Tutorial.zip MailStore PowerShell API-Wrapper und Tutorial Beispielskripte]
 * [http://www.microsoft.com/en-us/download/details.aspx?id=34595 Windows Management Framework 3.0] (enthält die PowerShell 3.0)
 * [http://www.microsoft.com/de-de/download/details.aspx?id=40855 Windows Management Framework 4.0] (alternativ, enthält die PowerShell 4.0)
@@ Zeile 19: / Zeile 19: @@
 <p class=msnote><span class=mswarning>'''Wichtiger Hinweis:''' Die Installation eines Windows Management Frameworks wird auf Systemen, welche eine bestimmte PowerShell Version voraussetzen und erweitern, wie beispielsweise Microsoft Exchange Server, nicht unterstützt und kann die Funktion dieser Systeme massiv beeinträchtigen oder zum Erliegen bringen.</span></p>
-Nach dem Herunterladen und ggf. der Installation der PowerShell entpacken Sie bitte den MailStore PowerShell API Wrapper und die Beispielskripte (standardmäßig nach ''C:\MailStore Server Scripting Tutorial\PowerShell\'').
+Nach dem Herunterladen und ggf. der Installation der PowerShell entpacken Sie bitte den MailStore PowerShell API-Wrapper und die Beispielskripte (standardmäßig nach ''C:\MailStore Server Scripting Tutorial\PowerShell\'').
-Der MailStore PowerShell API Wrapper und die Beispielskripte sind nicht digital signiert. Daher muss zunächst die Ausführung solcher Skripte in einer administrativen PowerShell Session mittels
+Der MailStore PowerShell API-Wrapper und die Beispielskripte sind nicht digital signiert. Daher muss zunächst die Ausführung solcher Skripte in einer administrativen PowerShell Session mittels
 <source lang="powershell" smart-tabs="true" toolbar="false" gutter="false">
@@ Zeile 29: / Zeile 29: @@
 zugelassen werden.
-= Einbinden des MailStore PowerShell API Wrappers =
+= Einbinden des MailStore PowerShell API-Wrappers =
-Der MailStore PowerShell API Wrapper ist als PowerShell Script Module (''MSS.PS.Lib.psm1'') implementiert und wird daher über sein Manifest (''MSS.PS.Lib.psd1'') per ''Import-Module'' in eine PowerShell Session eingebunden.
+Der MailStore PowerShell API-Wrapper ist als PowerShell Script Module (''MSS.PS.Lib.psm1'') implementiert und wird daher über sein Manifest (''MSS.PS.Lib.psd1'') per ''Import-Module'' in eine PowerShell Session eingebunden.
-Öffnen Sie eine PowerShell Session und binden Sie das API Wrapper Modul mit folgenden Befehl ein:
+Öffnen Sie eine PowerShell Session und binden Sie das API-Wrapper Modul mit folgenden Befehl ein:
 <source lang="powershell" smart-tabs="true" toolbar="false" gutter="false">
@@ Zeile 39: / Zeile 39: @@
 </source>
-== Informationen zum MailStore PowerShell API Wrapper abrufen ==
+== Informationen zum MailStore PowerShell API-Wrapper abrufen ==
-Der MailStore PowerShell API Wrapper stellt einige Funktionen und Variablen zur Verfügung, um gemäß PowerShell Konventionen auf die MailStore Server Administration API zugreifen zu können. Geben Sie folgenden Befehl ein, um Informationen hierüber abzurufen:
+Der MailStore PowerShell API-Wrapper stellt einige Funktionen und Variablen zur Verfügung, um gemäß PowerShell Konventionen auf die MailStore Server Administration API zugreifen zu können. Geben Sie folgenden Befehl ein, um Informationen hierüber abzurufen:
 <source lang="powershell" smart-tabs="true" toolbar="false" gutter="false">
@@ Zeile 60: / Zeile 60: @@
 </source>
-stellt der MailStore PowerShell API Wrapper für seine Funktionen Inline-Hilfen (nur auf Englisch verfügbar) bereit.
+stellt der MailStore PowerShell API-Wrapper für seine Funktionen Inline-Hilfen (nur auf Englisch verfügbar) bereit.
-= Verwendung der API Wrapper Funktionen =
+= Verwendung der API-Wrapper Funktionen =
-Anhand des folgenden Beispielskripts soll die grundlegende Verwendung der MailStore PowerShell API Wrapper Funktionen veranschaulicht werden. Dieses Skript finden Sie im Beispielskriptpaket als ''Example1.ps1''.
+Anhand des folgenden Beispielskripts soll die grundlegende Verwendung der MailStore PowerShell API-Wrapper Funktionen veranschaulicht werden. Dieses Skript finden Sie im Beispielskriptpaket als ''Example1.ps1''.
 <source lang="powershell" smart-tabs="true" toolbar="false" gutter="false">
@@ Zeile 89: / Zeile 89: @@
    machineName : DEMO
-== API Wrapper Funktionen mit Parametern aufrufen ==
+== API-Wrapper Funktionen mit Parametern aufrufen ==
-Viele MailStore Server Administration API Befehle erfordern die Angabe von Parametern. Selbstverständlich ist der MailStore PowerShell API Wrapper in der Lage, diese mittels ''Invoke-MSSApiCall'' zu übermitteln. Zur Erläuterung soll das folgende Skript dienen, das im Beispielskriptpaket als ''Example2.ps1'' enthalten ist.
+Viele MailStore Server Administration API Befehle erfordern die Angabe von Parametern. Selbstverständlich ist der MailStore PowerShell API-Wrapper in der Lage, diese mittels ''Invoke-MSSApiCall'' zu übermitteln. Zur Erläuterung soll das folgende Skript dienen, das im Beispielskriptpaket als ''Example2.ps1'' enthalten ist.
 <source lang="powershell" smart-tabs="true" toolbar="false" gutter="false">
@@ Zeile 100: / Zeile 100: @@
 </source>
-Das Skript liefert Details über die in MailStore Server angelegten Benutzer zurück und gibt sie als Liste aus. Es macht sich dabei zunutze, dass der MailStore PowerShell API Wrapper die Antworten der MailStore Server Management API direkt in Objekte konvertiert, deren Eigenschaften dann direkt weiterverwendet werden können.
+Das Skript liefert Details über die in MailStore Server angelegten Benutzer zurück und gibt sie als Liste aus. Es macht sich dabei zunutze, dass der MailStore PowerShell API-Wrapper die Antworten der MailStore Server Management API direkt in Objekte konvertiert, deren Eigenschaften dann direkt weiterverwendet werden können.
 Der im Skript aufgerufene API Befehl ''[[MailStore_Server_Administration_API_Commands#GetUserInfo|GetUserInfo]]'' erfordert einen Parameter ''userName''. Die Funktion ''Invoke-MSSApiCall'' erwartet Parameter als Hashtable, also z.B. in der Form ''@{Parametername1 = Wert1; Parametername2 = Wert2;...}''. Die Parameternamen sind dabei case sensitive.
@@ Zeile 123: / Zeile 123: @@
 An der ''privilegesOnFolders'' Eigenschaft ist gut erkennbar, dass die zurückgegebenen Objekte durchaus tiefer verschachtelt sein und ihrerseits weitere Objekte enthalten können.
-= API Wrapper Funktionen für asynchron ausgeführte API Befehle aufrufen =
+= API-Wrapper Funktionen für asynchron ausgeführte API Befehle aufrufen =
-MailStore Server Administration API-Befehle, deren Ausführung typischerweise länger dauert, werden vom Server asynchron ausgeführt. Der MailStore PowerShell API Wrapper erkennt den Aufruf dieser [[MailStore_Server_Administration_API#Asynchron_ausgef.C3.BChrte_Befehle|asynchron ausgeführten API Befehle]] und führt diese als [http://technet.microsoft.com/en-us/library/hh847783%28v=wps.620%29.aspx PowerShell Job] im Hintergrund aus.
+MailStore Server Administration API-Befehle, deren Ausführung typischerweise länger dauert, werden vom Server asynchron ausgeführt. Der MailStore PowerShell API-Wrapper erkennt den Aufruf dieser [[MailStore_Server_Administration_API#Asynchron_ausgef.C3.BChrte_Befehle|asynchron ausgeführten API Befehle]] und führt diese als [http://technet.microsoft.com/en-us/library/hh847783%28v=wps.620%29.aspx PowerShell Job] im Hintergrund aus.
-== API Wrapper PowerShell Jobs synchron verarbeiten ==
+== API-Wrapper PowerShell Jobs synchron verarbeiten ==
-Die weitere Skriptausführung kann unterbrochen werden, bis ein vom API Wrapper erzeugter PowerShell Job abgeschlossen wurde. Das Skript ''Example3.ps1'' aus dem Beispielskriptpaket verdeutlicht diese Funktionalität:
+Die weitere Skriptausführung kann unterbrochen werden, bis ein vom API-Wrapper erzeugter PowerShell Job abgeschlossen wurde. Das Skript ''Example3.ps1'' aus dem Beispielskriptpaket verdeutlicht diese Funktionalität:
 <source lang="powershell" smart-tabs="true" toolbar="false" gutter="false">
@@ Zeile 160: / Zeile 160: @@
 <p class=msnote>'''Hinweis:''' Die ''RunspaceId'' wird von der PowerShell automatisch erzeugt und kann hier ignoriert werden.</p>
-== API Wrapper PowerShell Jobs asynchron verarbeiten ==
+== API-Wrapper PowerShell Jobs asynchron verarbeiten ==
-Anstatt die Ausführung eines Skripts zu unterbrechen, kann auch auf die vom API Wrapper erzeugten PowerShell Jobs reagiert werden, während diese im Hintergrund ausgeführt werden. Diese Jobs triggern mit jedem abgefragten Status ein PowerShell EngineEvent, welches vom Skript abonniert werden kann, um bei dessen Eintritt weiteren Code auszuführen. Hierzu muss das vorherige Skript geringfügig angepasst werden (''Example4.ps1'' aus dem Beispielskriptpaket):
+Anstatt die Ausführung eines Skripts zu unterbrechen, kann auch auf die vom API-Wrapper erzeugten PowerShell Jobs reagiert werden, während diese im Hintergrund ausgeführt werden. Diese Jobs triggern mit jedem abgefragten Status ein PowerShell EngineEvent, welches vom Skript abonniert werden kann, um bei dessen Eintritt weiteren Code auszuführen. Hierzu muss das vorherige Skript geringfügig angepasst werden (''Example4.ps1'' aus dem Beispielskriptpaket):
 <source lang="powershell" smart-tabs="true" toolbar="false" gutter="false">

← Nächstältere Version	Version vom 10. Februar 2014, 10:10 Uhr
(kein Unterschied)

← Nächstältere Version		Version vom 7. Februar 2014, 16:49 Uhr
Zeile 1:		Zeile 1:
	__NOTOC__		__NOTOC__
−	~~++ Under construction ++~~

	Dieses Tutorial erläutert anhand einfacher Beispiele den Umgang mit der [[MailStore Server Administration API]] mittels Windows PowerShell Skripten. Grundlegende MailStore Server, Windows und PowerShell Kenntnisse werden dabei vorausgesetzt.		Dieses Tutorial erläutert anhand einfacher Beispiele den Umgang mit der [[MailStore Server Administration API]] mittels Windows PowerShell Skripten. Grundlegende MailStore Server, Windows und PowerShell Kenntnisse werden dabei vorausgesetzt.

@@ Zeile 166: / Zeile 166: @@
 <source lang="powershell" smart-tabs="true" toolbar="false" gutter="false">
-   Import-Module 'C:\MailStore Scripting Tutorial\PowerShell\API-Wrapper\MSS.PS.Lib.psd1'
+   Import-Module '..\API-Wrapper\MSS.PS.Lib.psd1'
    $mssapiclient = New-MSSApiClient -Username admin -Password admin -MailStoreServer localhost -Port 8463 -Code JSON -IgnoreInvalidSSLCerts
    $return = invoke-MSSApiCall $mssapiclient "VerifyStore" @{id = "1"}
-   $return|fl
+   $return | fl
    if ($return.Type -eq "JOB") {
        $mssevent = Register-EngineEvent -SourceIdentifier $return.Token -Action {write-host $event.MessageData.Data}