For the complete documentation index, see llms.txt. This page is also available as Markdown.

Apps

Eine App erstellen

Der erste Schritt besteht darin, eine App in PowerShell Universal zu erstellen. Dies ist der Container für alle Seiten und Komponenten Ihrer App-Website. Wir empfehlen, Apps in externen Umgebungen wie PowerShell 7 auszuführen, um sicherzustellen, dass sie vom restlichen Server isoliert sind. Um eine App zu erstellen, klicken Sie auf Apps \ Apps und dann auf Create New App.

Beim Erstellen müssen Sie einen eindeutigen Namen und eine URL für die App angeben. Alle anderen Eigenschaften sind optional. Nach dem Erstellen der App können Sie den App-Code bearbeiten. Versuchen Sie zum Beispiel, eine Komponente zu Ihrer App hinzuzufügen.

New-UDApp -Content {
   New-UDButton -Text 'Click Me' -OnClick {
       Show-UDToast "Ouch!"
   }
}

Sobald Sie Ihre App gespeichert haben, können Sie auf das Globus-Symbol klicken, um das Ergebnis anzuzeigen. Ein Klick auf die Schaltfläche zeigt eine Toast-Nachricht in Ihrem Browser an.

New-UDApp

Das Cmdlet der obersten Ebene für Dashboards ist New-UDApp. Sie müssen es aufrufen, wenn Sie eine App zurückgeben. Sie können es mit oder ohne Seiten verwenden.

Inhalt

Der Inhalt der App ist eine Reihe von Komponenten, die auf der Seite angezeigt werden. Es handelt sich um einen Skriptblock, der alle Komponenten in der Reihenfolge zurückgibt, in der sie auf der Seite gerendert werden. Sie können die Grid-Komponente verwenden, um Elemente anzuordnen und Dinge wie Text mit Typografie darzustellen.

New-UDApp -Title 'My New Dashboard' -Content {
    New-UDTypography -Text 'Hello!'
}

Anpassung der Kopfzeile

Sie können die Kopfzeile der App mit mehreren Parametern anpassen.

Position

Verwenden Sie den Parameter -HeaderPosition, um das Verhalten der Kopfzeile anzupassen.

  • absolute\fixed - Bleibt am oberen Rand der Seite, auch beim Scrollen

  • relative - Bleibt am oberen Rand der Seite. Beim Scrollen nicht sichtbar.

Farben

Sie können die Farben der Kopfzeile anpassen, indem Sie die Parameter -HeaderColor und -HeaderBackgroundColor angeben. Diese Farben überschreiben die Themenfarben.

Inhalt

Sie können mit dem Parameter -HeaderContent benutzerdefinierten Inhalt definieren, der in die Kopfzeile aufgenommen wird.

Themen-Umschalter deaktivieren

Sie können den Themen-Umschalter mit -DisableThemeToggle entfernen.

Sie können das Logo-Bild ändern, indem Sie dem Parameter -Logo eine URL übergeben.

Um das Navigationslayout zu ändern, verwenden Sie die Parameter -Navigation und -NavigationLayout.

Komponenten

Komponenten sind die einzelnen Widgets, die Sie in Ihrer App platzieren können. Es gibt Komponenten zum Anzeigen von Daten, zum Erfassen von Benutzereingaben, zum Hinzufügen von Text und Bildern und mehr. Komponenten können als PowerShell-Module heruntergeladen und Ihrer App hinzugefügt werden.

Komponenten werden mit der Standard-Verb-Name-Syntax wie bei jedem PowerShell-Cmdlet aufgerufen.

Erfahren Sie mehr über Komponenten hier.

Seiten

Sie können mehrere Seiten innerhalb einer App angeben. Jede Seite definiert eine Route. Ab v3 sind alle Seiten dynamisch. PowerShell wird bei jedem Seitenaufruf ausgeführt, um die neue Seite zu rendern. Da UD eine Single-Page-Anwendung ist, muss der Webbrowser beim Navigieren zwischen den verschiedenen App-Seiten nicht die gesamte Webseite aktualisieren.

Erfahren Sie mehr über Seiten hier.

Modul

Apps haben automatisch Zugriff auf alle Befehle, die innerhalb des PSModulePath verfügbar sind, sowie auf Module, die Sie direkt in die App selbst laden. Sie können jedoch auch Funktionen innerhalb der App selbst definieren. Diese Funktionen werden in ein Modul aufgenommen, das neben Ihrem App-Code gespeichert wird. Alle in dieser Datei definierten Funktionen werden automatisch in Ihre App aufgenommen.

Definieren Sie in der PowerShell Universal-Administrationskonsole Funktionen, Variablen und Aliase auf der Registerkarte Module. Alle definierten Funktionen werden in eine PSM1-Datei im selben Verzeichnis wie der Anwendungscode geschrieben.

Registerkarte Module

Integrierte Variablen

Integrierte Variablen finden Sie auf der Variablen-Seite.

Debugging

Sie können auch die Debugging-Werkzeuge mit Apps verwenden.

Beim Erstellen einer App werden Sie wahrscheinlich auf Probleme mit Cmdlet-Aufrufen oder der Syntax stoßen. Apps werden automatisch neu geladen, wenn Sie Änderungen an den App-Dateien vornehmen. Wenn eine App nicht startet, können Sie zur Administrationsseite navigieren, auf Apps klicken und die Schaltfläche Info neben Ihrer App anklicken.

Die Registerkarte Log zeigt alle Protokollierungen der PowerShell-Ausführung innerhalb Ihrer App. Dadurch sollten Sie Fehler und Warnungen aus Ihrer App leicht erkennen können.

Sie können Write-Debug verwenden, um Ihrer App zusätzliche Protokollmeldungen hinzuzufügen. Um die Debug-Protokollierung zu aktivieren, müssen Sie die Variable $DebugPreference am Anfang Ihres App-Skripts setzen.

Sie können das App-Menü mit dem Parameter -Menu anpassen.

Apps starten und stoppen

Ähnlich wie Jobs können Apps in separaten PowerShell-Prozessen ausgeführt werden. Sie können einen App-Prozess starten und stoppen, indem Sie auf der Seite Apps auf die Schaltfläche Start oder Stop klicken.

Persistente Runspaces

Persistente Runspaces ermöglichen es Ihnen, den Runspace-Status innerhalb Ihrer App-Event-Handler beizubehalten. Dies ist wichtig für Benutzer, die eine Art Initialisierung innerhalb ihrer Endpunkte durchführen, die bei nachfolgenden Aufrufen nicht erneut ausgeführt werden soll.

Standardmäßig werden Runspaces nach jeder Ausführung zurückgesetzt. Dies führt dazu, dass Variablen, Module und Funktionen, die während der Ausführung eines Endpunkts definiert wurden.

Um persistente Runspaces zu aktivieren, müssen Sie eine Umgebung für Ihre API konfigurieren. Setzen Sie den Parameter -PersistentRunspace, um diese Funktion zu aktivieren. Dies wird im Skript environments.ps1 konfiguriert.

Sie müssen sicherstellen, dass die Umgebung von der App verwendet wird.

App-Token automatisch gewähren

Sie können App-Token automatisch an Benutzer gewähren, die Apps besuchen. Dies ist nützlich, wenn Sie die Management-API von PowerShell Universal aus einer App aufrufen möchten. Für Ihre App muss die Authentifizierung aktiviert sein, und Sie müssen den Switch-Parameter -GrantAppToken bei New-PSUDashboard verwenden.

Aus Ihrer App heraus können Sie nun die Management-API aufrufen, ohne sich um die Verwaltung von App-Token kümmern zu müssen. Die API wird im Kontext des Benutzers aufgerufen, der die App besucht.

Fehler-Toasts deaktivieren

Standardmäßig zeigen Apps eine Toast-Nachricht an, wenn innerhalb eines Endpunkt-Skripts ein Fehler generiert wird. Um dieses Verhalten zu vermeiden, können Sie den Parameter -DisableErrorToast von New-UDApp verwenden

Startprotokollierung deaktivieren

Beim Starten einer App werden Informationen über die Variablen und Module im App-Protokoll angezeigt. Wenn Sie diese Informationen unterdrücken möchten, können Sie den Parameter -DisableStartupLogging verwenden.

Kritische Apps

Kritische Apps, die über den Parameter -Critical festgelegt werden, definieren Apps, die dazu führen, dass der Load-Balancer-Statusendpunkt einen 500-Antwortcode zurückgibt, wenn die App nicht ausgeführt wird. Der Load-Balancer-Statusendpunkt ist /api/v1/status .

Siehe auch

Zuletzt aktualisiert

War das hilfreich?