Erstellen von grafischen Azure Automation-Runbooks
Wichtig
Ausführende Azure Automation-Konten, einschließlich der klassischen ausführenden Konten, wurden am 30. September 2023 eingestellt und durch Managed Identities ersetzt. Sie können keine ausführenden Konten mehr über das Azure-Portal erstellen oder verlängern. Weitere Informationen finden Sie unter Migration von vorhandenen ausführenden Konten zur verwalteten Identität.
Alle Runbooks in Azure Automation sind Windows PowerShell-Workflows. Grafische Runbooks und grafische PowerShell-Workflow-Runbooks generieren PowerShell-Code, den die Automation-Worker ausführen, Sie jedoch weder anzeigen noch ändern können. Sie können ein grafisches Runbook in ein grafisches PowerShell-Workflow-Runbook konvertieren und umgekehrt. Diese Runbooks können jedoch nicht in ein Textrunbook konvertiert werden. Außerdem kann der grafische Automatisierungs-Editor kein Textrunbook importieren.
Mithilfe der grafischen Erstellung können Sie ohne die Komplexität des zugrunde liegenden Windows PowerShell- oder PowerShell-Workflow-Codes Runbooks für Azure Automation erstellen. Sie können der Canvas Aktivitäten aus einer Bibliothek mit Cmdlets und Runbooks hinzufügen, Verknüpfungen erstellen und die Elemente konfigurieren, um einen Workflow zu erhalten. Wenn Sie schon einmal mit System Center Orchestrator oder Service Management Automation (SMA) gearbeitet haben, dürfte Ihnen die grafischen Erstellung bekannt vorkommen. Dieser Artikel bietet eine Einführung in die Konzepte, die Sie für den Einstieg in die Erstellung eines grafischen Runbooks benötigen.
Hinweis
Sie können einem grafischen Runbook keine digitale Signatur hinzufügen. Diese Funktion wird in Azure Automation nicht unterstützt.
Übersicht über den grafischen Editor
Sie können den grafischen Editor im Azure-Portal öffnen, indem Sie ein grafisches Runbook erstellen oder bearbeiten.
Die folgenden Abschnitte beschreiben die Steuerelemente im grafischen Editor.
Canvas-Steuerelement
Das Canvas-Steuerelement ermöglicht Ihnen, Ihr Runbook zu entwerfen. Sie können über die Knoten im Steuerelement „Bibliothek“ dem Runbook Aktivitäten hinzufügen und mit Verknüpfungen Verbindungen mit ihnen herstellen, um die Logik des Runbooks zu definieren. Über die Steuerelemente am unteren Rand der Canvas können Sie die Ansicht vergrößern und verkleinern.
Steuerelement "Bibliothek"
Über das Steuerelement Bibliothek können Sie die Aktivitäten auswählen, die Ihrem Runbook hinzugefügt werden sollen. Sie fügen diese der Canvas hinzu, wo Sie sie mit anderen Aktivitäten verbinden können. Das Steuerelement „Bibliothek“ enthält die in der folgenden Tabelle definierten Abschnitte.
| Abschnitt | Beschreibung |
|---|---|
| Cmdlets | Alle Cmdlets, die in Ihrem Runbook verwendet werden können. Die Cmdlets sind nach Modul angeordnet. Es sind alle Module verfügbar, die Sie in Ihrem Automation-Konto installiert haben. |
| Runbooks | Die Runbooks in Ihrem Automation-Konto. Sie können diese Runbooks der Canvas hinzufügen, damit sie als untergeordnete Runbooks verwendet werden. Es werden nur Runbooks angezeigt, deren Kerntyp mit dem des bearbeiteten Runbooks identisch ist. Für grafische Runbooks werden nur PowerShell-basierte Runbooks angezeigt. Für grafische PowerShell-Workflow-Runbooks werden nur Runbooks auf PowerShell-Workflow-Basis angezeigt. |
| Objekte | Die Automation-Objekte in Ihrem Automation-Konto, die Sie in Ihrem Runbook verwenden können. Wenn Sie Ihrem Runbook ein Objekt hinzufügen, fügt es eine Workflowaktivität zum Abrufen des ausgewählten Objekts hinzu. Im Fall von Variablenobjekten können Sie auswählen, ob Sie eine Aktivität zum Abrufen der Variable oder eine Aktivität zum Festlegen der Variable hinzufügen möchten. |
| Steuerelement "Runbook" | Steuerelementaktivitäten, die im aktuellen Runbook verwendet werden können. Eine Aktivität vom Typ „Verbindung“ akzeptiert mehrere Eingaben und wartet, bis sämtliche dieser Eingaben abgeschlossen wurden, bevor der Workflow fortgesetzt wird. Eine Aktivität vom Typ „Code“ führt abhängig vom Typ des grafischen Runbooks mindestens eine PowerShell- oder PowerShell-Workflow-Codezeile aus. Sie können diese Aktivität für benutzerdefinierten Code oder für Funktionen nutzen, die sich mit anderen Aktivitäten nur schwer umsetzen lassen. |
Konfigurationssteuerung
Mit dem Steuerelement „Konfiguration“ können Sie Details für ein auf der Canvas ausgewähltes Objekt angeben. Welche Eigenschaften in diesem Steuerelement zur Verfügung stehen, hängt von der Art des ausgewählten Objekts ab. Wenn Sie im Steuerelement „Konfiguration“ eine Option wählen, werden zusätzliche Blätter zum Angeben weiterer Informationen geöffnet.
Steuerelement "Test"
Das Steuerelement "Test" wird beim ersten Start des grafischen Editors nicht angezeigt. Es wird geöffnet, wenn Sie ein grafisches Runbook interaktiv testen.
Verwenden von Aktivitäten
Aktivitäten sind die Bausteine eines Runbooks. Bei einer Aktivität kann es sich um ein PowerShell-Cmdlet, um ein untergeordnetes Runbook oder einen Workflow handeln. Sie können dem Runbook eine Aktivität hinzufügen, indem Sie mit der rechten Maustaste im Steuerelement „Bibliothek“ auf das Runbook klicken und die Option Zur Canvas hinzufügenauswählen. Anschließend können Sie die Aktivität per Drag & Drop an einer beliebigen Stelle auf der Canvas platzieren. Die Position der Aktivität auf der Canvas hat keinen Einfluss auf den Vorgang im Runbook. Sie können das Layout Ihres Runbooks so gestalten, wie es Ihnen zur visuellen Darstellung der Vorgänge am geeignetsten erscheint.
Wählen Sie eine Aktivität auf der Canvas aus, um ihre Eigenschaften und Parameter im Blatt „Konfiguration“ zu konfigurieren. Sie können die Bezeichnung der Aktivität in einen für Sie aussagekräftigen Namen ändern. Das Runbook führt weiterhin das ursprüngliche Cmdlet aus. Sie ändern einfach den Anzeigenamen, der im grafischen Editor verwendet wird. Beachten Sie, dass die Bezeichnung innerhalb des Runbooks eindeutig sein muss.
Parametersätze
Ein Parametersatz definiert die erforderlichen und optionalen Parameter, die Werte für ein bestimmtes Cmdlet akzeptieren. Alle Cmdlets müssen über mindestens einen Parametersatz verfügen, einige enthalten mehrere Sätze. Wenn ein Cmdlet mehrere Parametersätze aufweist, können Sie Parameter erst konfigurieren, nachdem Sie den zu verwendenden Parametersatz ausgewählt haben. Sie ändern den durch eine Aktivität verwendeten Parametersatz, indem Sie Parametersatz auswählen und einen anderen Satz angeben. In diesem Fall gehen alle bereits konfigurierten Parameterwerte verloren.
Im folgenden Beispiel besitzt das Cmdlet Get-AzVM drei Parametersätze. Das Beispiel verwendet ein Set mit dem Namen ListLocationVirtualMachinesParamSet, mit einem einzigen optionalen Parameter, der den Speicherort für die aufzulistenden virtuellen Maschinen zurückgibt. Im Beispiel wird auch der Parametersatz GetVirtualMachineInResourceGroupParamSet verwendet, um den zurückzugebenden virtuellen Computer anzugeben. Dieser Satz verfügt über zwei obligatorische Parameter und einen optionalen Parameter.
Parameterwerte
Wenn Sie einen Wert für einen Parameter angeben, wählen Sie eine Datenquelle aus, um festzulegen, wie der Wert angegeben wird. Die für einen bestimmten Parameter verfügbaren Datenquellen richten sich nach den gültigen Werten für diesen Parameter. Beispielsweise ist NULL keine verfügbare Option für einen Parameter, der keine NULL-Werte zulässt.
| Data Source | Beschreibung |
|---|---|
| Konstanter Wert | Geben Sie einen Wert für den Parameter ein. Diese Datenquelle ist nur für die folgenden Datentypen verfügbar: Int32, Int64, String, Boolean, DateTime, Switch. |
| Aktivitätsausgabe | Verwenden Sie die Ausgabe einer Aktivität, die der aktuellen Aktivität im Workflow vorausgeht. Alle gültigen Aktivitäten werden aufgelistet. Verwenden Sie für den Parameterwert nur die Aktivität, die die Ausgabe erzeugt. Wenn es sich bei der Aktivitätsausgabe um ein Objekt mit mehreren Eigenschaften handelt, können Sie nach Auswahl der Aktivität den Namen einer bestimmten Eigenschaft eingeben. |
| Runbookeingabe | Wählen Sie eine Runbookeingabe als Eingabe für den Aktivitätsparameter aus. |
| Variablenobjekt | Wählen Sie eine Automation-Variable als Eingabe aus. |
| Anmeldeinformationsobjekt | Wählen Sie ein Automation-Anmeldeinformationsobjekt als Eingabe aus. |
| Zertifikatobjekt | Wählen Sie ein Automation-Zertifikatobjekt als Eingabe aus. |
| Verbindungsobjekt | Wählen Sie ein Automation-Verbindungsobjekt als Eingabe aus. |
| PowerShell Expression | Geben Sie einen einfachen PowerShell-Ausdruck an. Der Ausdruck wird vor der Aktivität ausgewertet, und das Ergebnis wird für den Parameterwert verwendet. Sie können Variablen verwenden, um auf die Ausgabe einer Aktivität oder einen Eingabeparameter für ein Runbook zu verweisen. |
| Nicht konfiguriert | Löscht einen Wert, der zuvor konfiguriert wurde. |
Optionale zusätzliche Parameter
Alle Cmdlets bieten die Möglichkeit, zusätzliche Parameter festzulegen. Hierbei handelt es sich um allgemeine PowerShell-Parameter oder andere benutzerdefinierte Parameter. Der grafische Editor zeigt ein Textfeld an, in dem Sie unter Verwendung der PowerShell-Syntax Parameter bereitstellen können. Um beispielsweise den allgemeinen Parameter Verbose zu verwenden, geben Sie -Verbose:$True an.
Wiederholen der Aktivität
Die Wiederholungsfunktion für eine Aktivität ermöglicht deren mehrmalige Ausführung, bis eine bestimmte Bedingung erfüllt ist (ähnlich wie bei einer Schleife). Sie können dieses Feature für Aktivitäten nutzen, die mehrmals ausgeführt werden müssen, fehleranfällig sind oder möglicherweise mehrere Versuche für eine erfolgreiche Ausführung benötigen. Sie können mit diesem Feature auch die Gültigkeit der ausgegebenen Informationen überprüfen.
Wenn Sie eine Wiederholung für eine Aktivität aktivieren, können Sie eine Verzögerung und eine Bedingung festlegen. Die Verzögerung ist die Zeit (gemessen in Sekunden oder Minuten), die das Runbook wartet, bevor die Aktivität erneut ausgeführt wird. Wenn Sie keine Verzögerung angeben, wird die Aktivität sofort nach Abschluss des Vorgangs erneut ausgeführt.
Die Wiederholungsbedingung ist ein PowerShell-Ausdruck, der nach jeder Ausführung der Aktivität ausgewertet wird. Wenn der Ausdruck „True“ ergibt, wird die Aktivität erneut ausgeführt. Wenn der Ausdruck „False“ ergibt, wird die Aktivität nicht erneut ausgeführt, und das Runbook fährt mit der nächsten Aktivität fort.
Die Wiederholungsbedingung kann eine Variable namens RetryData enthalten, die Zugriff auf Informationen zu den Aktivitätswiederholungen bereitstellt. Diese Variable weist die in der folgenden Tabelle aufgeführten Eigenschaften auf:
| Eigenschaft | Beschreibung |
|---|---|
NumberOfAttempts |
Häufigkeit, mit der die Aktivität ausgeführt wurde. |
Output |
Die Ausgabe nach der letzten Ausführung der Aktivität. |
TotalDuration |
Vergangene Zeit seit dem ersten Start der Aktivität. |
StartedAt |
Uhrzeit (im UTC-Format), zu der die Aktivität zuerst gestartet wurde. |
Es folgen Beispiele von Bedingungen für die Wiederholung von Aktivitäten.
# Run the activity exactly 10 times.
$RetryData.NumberOfAttempts -ge 10
# Run the activity repeatedly until it produces any output.
$RetryData.Output.Count -ge 1
# Run the activity repeatedly until 2 minutes has elapsed.
$RetryData.TotalDuration.TotalMinutes -ge 2
Wenn Sie eine Wiederholungsbedingung für eine Aktivität konfiguriert haben, verfügt die Aktivität über zwei optische Hinweise, um Sie daran zu erinnern. Einer wird in der Aktivität angezeigt, der andere beim Überprüfen der Aktivitätskonfiguration.
Steuerelement "Workflowskript"
Bei einem Workflowskript-Steuerelement handelt es sich um eine spezielle Aktivität, die je nach Art des zu erstellenden grafischen Runbooks ein PowerShell- oder PowerShell-Workflow-Skript akzeptiert. Dieses Steuerelement bietet Funktionen, die andernfalls möglicherweise nicht verfügbar wären. Es kann keine Parameter akzeptieren, kann jedoch Variablen für die Aktivitätsausgabe und Runbookeingabeparameter verwenden. Alle Ausgaben der Aktivität werden dem Datenbus hinzugefügt. Eine Ausnahme ist die Ausgabe ohne ausgehende Verknüpfung. In diesem Fall wird die Ausgabe der Ausgabe des Runbooks hinzugefügt.
Der folgende Code beispielsweise führt Datumsberechnungen unter Verwendung einer Runbookeingabevariable namens NumberOfDays durch. Anschließend wird ein berechneter DateTime-Wert als Ausgabe an nachfolgende Aktivitäten im Runbook gesendet.
$DateTimeNow = (Get-Date).ToUniversalTime()
$DateTimeStart = ($DateTimeNow).AddDays(-$NumberOfDays)}
$DateTimeStart
Verwenden von Links für Workflows
Eine Verknüpfung in einem grafischen Runbook verbindet zwei Aktivitäten miteinander. Sie wird auf der Canvas als Pfeil dargestellt, der von der Quellaktivität zur Zielaktivität zeigt. Die Aktivitäten werden in Richtung des Pfeils ausgeführt, wobei die Zielaktivität gestartet wird, sobald die Quellaktivität abgeschlossen wurde.
Erstellen eines Links
Sie können eine Verknüpfung zwischen zwei Aktivitäten erstellen, indem Sie die Quellaktivität auswählen und auf den Kreis am unteren Ende der Form klicken. Ziehen Sie den Pfeil bis zur Zielaktivität, und lassen Sie die Maustaste los.
Wählen Sie die Verknüpfung aus, um ihre Eigenschaften im Blatt "Konfiguration" zu konfigurieren. Zu den Eigenschaften zählt beispielsweise der Verknüpfungstyp, der in der folgenden Tabelle beschrieben wird.
| Verknüpfungstyp | Beschreibung |
|---|---|
| Pipeline | Die Zielaktivität wird einmal für jede Objektausgabe der Quellaktivität ausgeführt. Die Zielaktivität wird nicht ausgeführt, wenn die Quellaktivität zu keiner Ausgabe führt. Die Ausgabe der Quellaktivität steht als Objekt zur Verfügung. |
| Sequenz | Die Zielaktivität wird nur einmal ausgeführt, wenn sie die Ausgabe der Quellaktivität empfängt. Die Ausgabe der Quellaktivität steht als Array aus Objekten zur Verfügung. |
Starten einer Runbookaktivität
Ein grafisches Runbook wird mit allen Aktivitäten gestartet, die keine eingehende Verknüpfung besitzen. Es gibt oft nur eine Aktivität, die als Startaktivität für das Runbook dient. Wenn mehrere Aktivitäten keine eingehende Verknüpfung aufweisen, wird das Runbook durch eine parallele Ausführung dieser Aktivitäten gestartet. Die Verknüpfungen werden durchlaufen, um nach jeder Beendigung einer Aktivität weitere Aktivitäten auszuführen.
Angeben von Verknüpfungsbedingungen
Wenn Sie für eine Verknüpfung eine Bedingung angeben, wird die Zielaktivität nur ausgeführt, wenn die Bedingung als „True“ ausgewertet wird. Sie verwenden üblicherweise eine ActivityOutput-Variable in einer Bedingung, um die Ausgabe der Quellaktivität abzurufen.
Für eine Pipelineverknüpfung müssen Sie eine Bedingung für ein einzelnes Objekt angeben. Das Runbook wertet die Bedingung für jedes Objekt aus, das von der Quellaktivität ausgegeben wird. Dann führt es die Zielaktivität für jedes Objekt aus, das die Bedingung erfüllt. Wenn Sie beispielsweise Get-AzVM als Quellaktivität verwenden, kann die folgende Syntax für eine bedingte Pipelineverknüpfung verwendet werden, um nur virtuelle Computer aus der Ressourcengruppe Group1 abzurufen.
$ActivityOutput['Get Azure VMs'].Name -match "Group1"
Bei einer Sequenzverknüpfung wertet das Runbook die Bedingung nur einmal aus, da ein einzelnes Array mit sämtlichen Objekten zurückgegeben wird, die von der Quellaktivität ausgegeben werden. Aus diesem Grund kann das Runbook zum Filtern keine Sequenzverknüpfung verwenden, wie dies bei einer Pipelineverknüpfung der Fall ist. Die Sequenzverknüpfung kann einfach bestimmen, ob die nächste Aktivität ausgeführt wird.
Betrachten Sie beispielsweise den folgende Reihe von Aktivitäten aus unserem Runbook Start VM:
Das Runbook verwendet drei verschiedene Sequenzverknüpfungen, die Werte der Eingabeparameter VMName und ResourceGroupName überprüfen, um die entsprechende Aktion zu bestimmen. Mögliche Aktionen sind Starten eines einzelnen virtuellen Computers, Starten aller virtuellen Computer in der Ressourcengruppe oder Starten aller VMs in einem Abonnement. Für die Sequenzverknüpfung zwischen Connect to Azure und Get single VMgilt die folgende Bedingungslogik:
<#
Both VMName and ResourceGroupName runbook input parameters have values
#>
(
(($VMName -ne $null) -and ($VMName.Length -gt 0))
) -and (
(($ResourceGroupName -ne $null) -and ($ResourceGroupName.Length -gt 0))
)
Wenn Sie eine bedingte Verknüpfung verwenden, werden die verfügbaren Daten aus der Quellaktivität für andere Aktivitäten in dieser Verzweigung durch die Bedingung gefiltert. Wenn eine Aktivität die Quelle für mehrere Verknüpfungen ist, richten sich die für Aktivitäten verfügbaren Daten in jeder Verzweigung nach der Bedingung in der Verknüpfung, die mit dieser Verzweigung verbunden ist.
So startet beispielsweise die Aktivität Start-AzVM im nachstehenden Runbook alle virtuellen Computer. Sie verfügt über zwei bedingte Verknüpfungen: Die erste bedingte Verknüpfung verwendet den Ausdruck $ActivityOutput['Start-AzVM'].IsSuccessStatusCode -eq $true, um zu filtern, ob die Start-AzVM-Aktivität erfolgreich abgeschlossen wurde. Die zweite bedingte Verknüpfung verwendet den Ausdruck $ActivityOutput['Start-AzVM'].IsSuccessStatusCode -ne $true, um zu filtern, ob die Start-AzVm-Aktivität den virtuellen Computer nicht starten kann.
Alle Aktivitäten, die auf die erste Verknüpfung folgen und die Aktivitätsausgabe von Get-AzureVM verwenden, empfangen nur die virtuellen Computer, die zum Zeitpunkt der Ausführung von Get-AzureVM gestartet wurden. Alle Aktivitäten, die der zweiten Verknüpfung folgen, rufen nur die virtuellen Computer ab, die zum Zeitpunkt der Ausführung von Get-AzureVM beendet waren. Alle Aktivitäten, die der dritten Verknüpfung folgen, rufen alle virtuellen Computer ab, unabhängig von deren Ausführungsstatus.
Verwenden von Verbindungen
Eine Verbindung ist eine spezielle Aktivität, die wartet, bis alle eingehenden Verzweigungen abgeschlossen wurden. Auf diese Weise kann das Runbook mehrere Aktivitäten parallel ausführen, und vor dem Fortfahren sicherstellen, dass alle Aktivitäten abgeschlossen wurden.
Wenngleich eine Verbindung eine unbegrenzte Anzahl von eingehenden Verknüpfungen aufweisen kann, darf nur eine dieser Verknüpfungen eine Pipeline sein. Für die Anzahl der eingehenden Sequenzverknüpfungen gilt keine Beschränkung. Sie können die Verbindung mit mehreren eingehenden Pipelineverknüpfungen erstellen und das Runbook speichern, bei der Ausführung tritt jedoch ein Fehler auf.
Das nachstehende Beispiel ist ein Teil eines Runbooks, das einen Satz virtueller Computer startet, während gleichzeitig Patches heruntergeladen werden, die auf diese Computer angewendet werden sollen. Es nutzt eine Verbindung, um sicherzustellen, dass beide Prozesse abgeschlossen sind, bevor das Runbook fortgesetzt wird.
Arbeit mit Zyklen
Wenn eine Zielaktivität eine Verknüpfung zurück auf die Quellaktivität oder eine andere Aktivität aufweist, die letztlich eine Verknüpfung mit der zugehörigen Quellaktivität aufweist, wird ein Zyklus gebildet. Die grafische Erstellung unterstützt derzeit keine Zyklen. Wenn Ihr Runbook einen Zyklus aufweist, wird dieser ordnungsgemäß gespeichert, empfängt bei der Ausführung jedoch einen Fehler.
Freigeben von Daten zwischen Aktivitäten
Sämtliche Daten, die von einer Aktivität mit ausgehender Verknüpfung ausgegeben werden, werden in den Datenbus für das Runbook geschrieben. Alle Aktivitäten im Runbook können die Daten im Datenbus zum Auffüllen von Parameterwerten oder zur Nutzung in Skriptcode verwenden. Eine Aktivität kann auf die Ausgabe einer beliebigen vorherigen Aktivität im Workflow zugreifen.
Wie die Daten in den Datenbus geschrieben werden, richtet sich nach dem Typ der Verknüpfung der Aktivität. Bei einer Pipelineverknüpfung werden die Daten als mehrere Objekte ausgegeben. Bei einer Sequenzverknüpfung werden die Daten als Array ausgegeben. Wenn nur ein Wert vorliegt, wird dieser als ein einzelnes Elementarray ausgegeben.
Ihr Runbook bietet zwei Möglichkeiten für den Zugriff auf Daten im Datenbus:
- Verwenden Sie eine Aktivitätsausgabe-Datenquelle.
- Verwenden Sie einen PowerShell-Ausdruck als Datenquelle.
Der erste Mechanismus verwendet eine Aktivitätsausgabe-Datenquelle, um einen Parameter einer anderen Aktivität aufzufüllen. Wenn es sich bei der Ausgabe um ein Objekt handelt, kann das Runbook eine einzelne Eigenschaft festlegen.
Der zweite Datenzugriffsmechanismus ruft die Ausgabe einer Aktivität in einer PowerShell-Ausdrucksdatenquelle oder einer Workflowskriptaktivität mit einer ActivityOutput-Variablen mithilfe der unten gezeigten Syntax ab. Wenn es sich bei der Ausgabe um ein Objekt handelt, kann das Runbook eine einzelne Eigenschaft festlegen.
$ActivityOutput['Activity Label']
$ActivityOutput['Activity Label'].PropertyName
Verwenden von Prüfpunkten
Sie können Prüfpunkte in einem grafischen PowerShell-Workflow-Runbook festlegen, indem Sie für eine beliebige Aktivität die Option Prüfpunkt für Runbook auswählen. Dadurch wird ein Prüfpunkt festgelegt, nachdem die Aktivität ausgeführt wurde.
Prüfpunkte stehen nur in grafischen PowerShell-Workflow-Runbooks zur Verfügung, nicht in grafischen Runbooks. Wenn das Runbook Azure-Cmdlets verwendet, sollte auf jede Aktivität, nach der ein Prüfpunkt festgelegt wird, eine Connect-AzAccount-Aktivität folgen. Der Verbindungsvorgang wird verwendet, wenn das Runbook angehalten wird und von diesem Prüfpunkt auf einem anderen Worker neu gestartet werden muss.
Verarbeiten von Runbookeingaben
Ein Runbook erfordert Eingaben durch den Benutzer, der es über das Azure-Portal oder (wenn das aktuelle Runbook als untergeordnetes Runbook verwendet wird) aus einem anderen Runbook startet. Beispielsweise muss der Benutzer für ein Runbook, das einen virtuellen Computer erstellt, bei jedem Start des Runbooks möglicherweise Informationen wie den Namen des virtuellen Computers und andere Eigenschaften bereitstellen.
Das Runbook akzeptiert die Eingabe bei Definition eines oder mehrerer Eingabeparameter. Der Benutzer stellt bei jedem Start des Runbooks Werte für diese Parameter bereit. Wenn der Benutzer das Runbook mithilfe des Azure-Portals startet, wird der Benutzer aufgefordert, Werte für jeden Eingabeparameter anzugeben, der vom Runbook unterstützt wird.
Beim Erstellen Ihres Runbooks können Sie auf dessen Eingabeparameter zugreifen, indem Sie auf Eingabe und Ausgabe auf der Symbolleiste des Runbooks klicken. Daraufhin wird das Steuerelement „Eingabe und Ausgabe“ geöffnet, in dem Sie einen vorhandenen Eingabeparameter bearbeiten oder durch Klicken auf Eingabe hinzufügen einen neuen Eingabeparameter erstellen können.
Jeder Eingabeparameter wird durch die Eigenschaften in der folgenden Tabelle definiert:
| Eigenschaft | Beschreibung |
|---|---|
| Name | Erforderlich. Der Name des Parameters. Der Name muss innerhalb des Runbooks eindeutig sein. Er muss mit einem Buchstaben beginnen und darf nur Buchstaben, Zahlen und Unterstriche enthalten. Der Name darf kein Leerzeichen enthalten. |
| Beschreibung | Optional. Beschreibung zum Zweck des Eingabeparameters. |
| Typ | Optional. Der für den Parameterwert erwartete Datentyp. Das Azure-Portal bietet ein geeignetes Steuerelement zum Eingeben des jeweiligen Datentyps für jeden Parameter. Folgende Parametertypen werden unterstützt: String, Int32, Int64, Decimal, Boolean, DateTime und Object. Wenn kein Datentyp ausgewählt wird, wird standardmäßig „String“ verwendet. |
| Obligatorisch. | Optional. Die Einstellung gibt an, ob ein Wert für den Parameter angegeben werden muss. Wenn Sie yes auswählen, muss beim Starten des Runbooks ein Wert angegeben werden. Wenn Sie no auswählen, ist beim Starten des Runbooks kein Wert erforderlich, und es kann ein Standardwert verwendet werden. Das Runbook kann nicht gestartet werden, wenn der Wert für einen erforderlichen Parameter fehlt, für den kein Standardwert definiert wurde. |
| Standardwert | Optional. Der Wert, der für einen Parameter verwendet wird, wenn dieser beim Start des Runbooks nicht übergeben wird. Wählen Sie Custom aus, um einen Standardwert festzulegen. Wählen Sie None aus, wenn Sie keinen Standardwert angeben möchten. |
Verarbeiten von Runbookausgaben
Die grafische Erstellung speichert Daten, die von einer Aktivität ohne ausgehende Verknüpfung erstellt werden, in der Ausgabe des Runbooks. Die Ausgabe wird mit dem Runbookauftrag gespeichert und steht einem übergeordneten Runbook zur Verfügung, wenn das Runbook als untergeordnetes Runbook verwendet wird.
Arbeiten mit PowerShell-Ausdrücken
Einer der Vorteile der grafischen Erstellung ist, dass Sie ein Runbook erstellen können, wenn Sie nur über wenig PowerShell-Kenntnisse verfügen. Derzeit benötigen Sie aber einige PowerShell-Kenntnisse, um bestimmte Parameterwerte einzufügen und Verknüpfungsbedingungen festzulegen. Dieser Abschnitt enthält eine kurze Einführung in PowerShell-Ausdrücke. Alle Details von PowerShell sind unter Skripterstellung mit Windows PowerShellverfügbar.
Verwenden eines PowerShell-Ausdrucks als Datenquelle
Sie können einen PowerShell-Ausdruck als Datenquelle verwenden, um den Wert eines Aktivitätsparameters mit den Ergebnissen von PowerShell-Code zu füllen. Bei dem Ausdruck kann es sich um eine einzelne Codezeile handeln, mit der eine einfache Funktion durchgeführt wird, oder um mehrere Zeilen, mit denen die Schritte einer komplexen Logik ausgeführt werden. Alle Ausgaben eines Befehls, der keiner Variablen zugewiesen ist, werden an den Parameterwert ausgegeben.
Mit dem folgenden Befehl wird beispielsweise das aktuelle Datum ausgegeben.
Get-Date
Mit den nächsten Codeausschnitten wird aus dem aktuellen Datum eine Zeichenfolge erstellt und einer Variablen zugewiesen. Der Code sendet die Inhalte der Variablen an die Ausgabe.
$string = "The current date is " + (Get-Date)
$string
Mit den folgenden Befehlen wird das aktuelle Datum ausgewertet, und es wird eine Zeichenfolge zurückgegeben, die angibt, ob der aktuelle Tag ein Tag am Wochenende oder ein Wochentag ist.
$date = Get-Date
if (($date.DayOfWeek = "Saturday") -or ($date.DayOfWeek = "Sunday")) { "Weekend" }
else { "Weekday" }
Verwenden von Aktivitätsausgaben
Zum Verwenden der Ausgabe einer vorherigen Aktivität in Ihrem Runbook verwenden Sie die ActivityOutput-Variable mit der unten angegebenen Syntax.
$ActivityOutput['Activity Label'].PropertyName
Beispielsweise können Sie über eine Aktivität mit einer Eigenschaft verfügen, die den Namen eines virtuellen Computers erfordert. In diesem Fall kann das Runbook den folgenden Ausdruck verwenden.
$ActivityOutput['Get-AzureVM'].Name
Falls für die Eigenschaft anstelle eines einfachen Namens das Objekt des virtuellen Computers erforderlich ist, gibt das Runbook das gesamte Objekt mit der folgenden Syntax zurückgeben.
$ActivityOutput['Get-AzureVM']
Das Runbook kann die Ausgabe einer Aktivität in einen komplexeren Ausdruck wie den folgenden verwenden. Dieser Ausdruck verkettet Text zum Namen der VM.
"The computer name is " + $ActivityOutput['Get-AzureVM'].Name
Vergleichen von Werten
Verwenden Sie Vergleichsoperatoren , um Werte zu vergleichen, oder bestimmen Sie, ob ein Wert mit einem bestimmten Muster übereinstimmt. Bei einem Vergleich wird entweder der Wert „True“ oder „False“ zurückgegeben.
Mit der folgenden Bedingung wird beispielsweise bestimmt, ob der virtuelle Computer einer Aktivität mit dem Namen Get-AzureVM derzeit beendet ist.
$ActivityOutput["Get-AzureVM"].PowerState -eq "Stopped"
Die folgende Bedingung bestimmt, ob sich derselbe virtuelle Computer in einem anderen Zustand als „Beendet“ befindet.
$ActivityOutput["Get-AzureVM"].PowerState -ne "Stopped"
Sie können in Ihrem Runbook mehrere Bedingungen mit einem logischen Operator wie -and oder -or verknüpfen. Mit der folgenden Bedingung wird beispielsweise überprüft, ob sich der virtuelle Computer aus dem vorherigen Beispiel im Zustand „Beendet“ oder „Wird beendet“ befindet.
($ActivityOutput["Get-AzureVM"].PowerState -eq "Stopped") -or ($ActivityOutput["Get-AzureVM"].PowerState -eq "Stopping")
Verwenden von Hashtabellen
Hashtabellen sind Name-Wert-Paare, die zum Zurückgeben einer Gruppe von Werten hilfreich sind. Es kann auch vorkommen, dass eine Hashtabelle als Wörterbuch bezeichnet wird. Eigenschaften für bestimmte Aktivitäten erwarten anstelle eines einfachen Werts eine Hashtabelle.
Erstellen Sie eine Hashtabelle mit der folgenden Syntax. Sie kann eine beliebige Anzahl von Einträgen enthalten, die aber jeweils durch einen Namen und einen Wert definiert sind.
@{ <name> = <value>; [<name> = <value> ] ...}
Mit dem folgenden Ausdruck wird beispielsweise eine Hashtabelle erstellt, die in der Datenquelle für einen Aktivitätsparameter verwendet wird, der eine Hashtabelle mit Werten für eine Internetsuche erwartet.
$query = "Azure Automation"
$count = 10
$h = @{'q'=$query; 'lr'='lang_ja'; 'count'=$Count}
$h
Im folgenden Beispiel wird die Ausgabe einer Aktivität mit dem Namen Get X Connection zum Auffüllen einer Hashtabelle mit Werten verwendet.
@{'ApiKey'=$ActivityOutput['Get X Connection'].ConsumerAPIKey;
'ApiSecret'=$ActivityOutput['Get X Connection'].ConsumerAPISecret;
'AccessToken'=$ActivityOutput['Get X Connection'].AccessToken;
'AccessTokenSecret'=$ActivityOutput['Get X Connection'].AccessTokenSecret}
Authentifizieren bei Azure-Ressourcen
Zur Verwaltung von Azure-Ressourcen verwendete Runbooks in Azure Automation erfordern eine Authentifizierung bei Azure. Managed Identities ist der Standardmechanismus, den ein Automation Runbook für den Zugriff auf Azure Resource Manager-Ressourcen in Ihrem Abonnement verwendet. Sie können diese Funktionalität zu einem grafischen Runbook hinzufügen, indem Sie das folgende Runbook in das Automatisierungskonto importieren, das die vom System zugewiesene Managed Identity des Automation-Kontos zur Authentifizierung und zum Zugriff auf Azure-Ressourcen nutzt.
wget https://raw.githubusercontent.com/azureautomation/runbooks/master/Utility/AzMI/AzureAutomationTutorialWithIdentityGraphical.graphrunbook -outfile AzureAutomationTutorialWithIdentityGraphical.graphrunbook
Exportieren eines grafischen Runbooks
Sie können nur die veröffentlichte Version eines grafisch Runbooks exportieren. Wenn das Runbook noch nicht veröffentlicht wurde, ist die Schaltfläche Exportieren deaktiviert. Beim Klicken auf die Schaltfläche Exportieren wird das Runbook auf Ihren lokalen Computer heruntergeladen. Der Name der Datei entspricht dem Namen des Runbooks mit der Erweiterung .graphrunbook.
Importieren eines grafischen Runbooks
Sie können eine Datei für ein grafisches Runbook oder für ein grafisches PowerShell-Workflow-Runbook importieren, indem Sie beim Hinzufügen eines Runbooks die Option Importieren auswählen. Wenn Sie die zu importierende Datei auswählen, können Sie den Namen beibehalten oder einen neuen vergeben. Im Feld Runbooktyp wird der Typ des Runbooks angezeigt, nachdem die ausgewählte Datei bewertet wurde. Wenn Sie versuchen, einen anderen Typ auszuwählen, der nicht korrekt ist, zeigt der grafische Editor eine Meldung an, die auf potenzielle Konflikte hinweist und darauf, dass während der Konvertierung Syntaxfehler auftreten können.
Testen eines grafischen Runbooks
Jedes grafische Runbook in Azure Automation umfasst eine Entwurfsversion und eine veröffentlichte Version. Sie können nur die veröffentlichte Version ausführen, während Sie nur die Entwurfsversion bearbeiten können. Die veröffentlichte Version bleibt von Änderungen an der Entwurfsversion unberührt. Wenn die Entwurfsversion zur Nutzung bereit ist, können Sie sie veröffentlichen und auf diese Weise die derzeit veröffentlichte Version mit Ihrer Entwurfsversion überschreiben.
Sie können die Entwurfsversion eines Runbooks im Azure-Portal testen, während die veröffentlichte Version unverändert bleibt. Alternativ können Sie ein neues Runbook testen, bevor es veröffentlicht wird, damit Sie überprüfen können, ob das Runbook vor den Versionsersetzungen ordnungsgemäß funktionierte. Beim Testen eines Runbooks wird die Entwurfsversion ausgeführt und sichergestellt, dass alle ausgeführten Aktionen abgeschlossen werden. Es wird kein Auftragsverlauf erstellt, aber im Fensterbereich „Testausgabe“ wird die Ausgabe angezeigt.
Sie öffnen das Steuerelement „Test“ für Ihr grafisches Runbook, indem Sie das Runbook zur Bearbeitung öffnen und dann auf Testbereich klicken. Das Steuerelement „Test“ fordert alle benötigten Eingabeparameter an, und Sie können das Runbook starten, indem Sie auf Start klicken.
Veröffentlichen eines grafischen Runbooks
Veröffentlichen Sie ein grafisches Runbook, indem Sie das Runbook zur Bearbeitung öffnen und dann auf Veröffentlichen klicken. Mögliche Statuswerte für das Runbook sind:
- Neu: Das Runbook wurde noch nicht veröffentlicht.
- Veröffentlicht: Das Runbook wurde veröffentlicht.
- In Bearbeitung: Das Runbook wurde nach der Veröffentlichung bearbeitet und die Entwurfsversion und die veröffentlichte Version unterscheiden sich voneinander.
Sie haben die Möglichkeit, ein Runbook auf die veröffentlichte Version zurückzusetzen. Damit werden alle Änderungen, die seit der letzten Veröffentlichung des Runbooks vorgenommen wurden, verworfen. Die Entwurfsversion des Runbooks wird durch die veröffentlichte Version ersetzt.
Nächste Schritte
- Informationen zu den ersten Schritten mit grafischen Runbooks finden Sie unter Tutorial: Erstellen eines grafischen Runbooks.
- Weitere Informationen zu den verschiedenen Runbooktypen sowie zu ihren Vorteilen und Einschränkungen finden Sie unter Azure Automation-Runbooktypen.
- Eine Referenz zu den PowerShell-Cmdlets finden Sie unter Az.Automation.