az automation runbook
Hinweis
Dieser Verweis ist Teil der Automatisierungserweiterung für die Azure CLI (Version 2.13.0 oder höher). Die Erweiterung wird automatisch installiert, wenn Sie zum ersten Mal einen Az-Automatisierungs-Runbook-Befehl ausführen. Weitere Informationen zu Erweiterungen
Automatisierungs-Runbook.
Befehle
| az automation runbook create |
Erstellen Sie das runbook, das durch den Namen des Runbook identifiziert wird. |
| az automation runbook delete |
Löschen Sie das Runbook nach Name. |
| az automation runbook list |
Rufen Sie eine Liste von Runbooks ab. |
| az automation runbook publish |
Veröffentlichen Sie den Runbook-Entwurf. |
| az automation runbook replace-content |
Ersetzen Sie den Inhalt des Runbook. |
| az automation runbook revert-to-published |
Stellen Sie den Runbook-Inhalt auf den letzten bekannten veröffentlichten Zustand zurück. |
| az automation runbook show |
Rufen Sie das vom Runbook-Namen identifizierte Runbook ab. |
| az automation runbook start |
Starten Sie das Runbook. |
| az automation runbook update |
Aktualisieren Sie das runbook, das durch den Namen des Runbook identifiziert wurde. |
| az automation runbook wait |
Platzieren Sie die CLI in einem Wartezustand, bis eine Bedingung des Automatisierungs-Runbook erfüllt ist. |
az automation runbook create
Erstellen Sie das runbook, das durch den Namen des Runbook identifiziert wird.
az automation runbook create --automation-account-name
--name
--resource-group
--type {Graph, GraphPowerShell, GraphPowerShellWorkflow, PowerShell, PowerShellWorkflow, Script}
[--description]
[--location]
[--log-activity-trace]
[--log-progress {false, true}]
[--log-verbose {false, true}]
[--tags]
Beispiele
Erstellen eines Runbooks
az automation runbook create --automation-account-name "myAutomationAccount" --resource-group "rg" --name "myRunbook" --type "PowerShell" --location "East US 2"
Erforderliche Parameter
Der Name des Automatisierungskontos.
Der Runbookname.
Name der Ressourcengruppe Sie können die Standardgruppe mit az configure --defaults group=<name> konfigurieren.
Typ des Runbook.
Optionale Parameter
Beschreibung des Runbook.
Der Standort. Werte aus: az account list-locations. Sie können den standardmäßig verwendeten Standort mit az configure --defaults location=<location> konfigurieren.
Optionen für die Ablaufverfolgung auf Aktivitätsebene des Runbook.
Statusprotokolloption des Runbook.
Ausführliche Protokolloption des Runbook.
Leerzeichentrennte Tags: key[=value] [key[=value] ...]. Verwenden Sie "", um vorhandene Tags zu löschen.
Ausführlichkeit der Protokollierung erhöhen, um alle Debugprotokolle anzuzeigen.
Zeigen Sie diese Hilfemeldung an, und schließen Sie sie.
Nur Fehler anzeigen und Warnungen unterdrücken.
Ausgabeformat.
JMESPath-Abfragezeichenfolge. Weitere Informationen und Beispiele finden Sie unter http://jmespath.org/.
Der Name oder die ID des Abonnements. Sie können das standardmäßig verwendete Abonnement mittels az account set -s NAME_OR_ID konfigurieren.
Ausführlichkeit der Protokollierung erhöhen. „--debug“ für vollständige Debugprotokolle verwenden.
az automation runbook delete
Löschen Sie das Runbook nach Name.
az automation runbook delete --automation-account-name
--name
--resource-group
[--yes]
Beispiele
Löschen eines Runbook
az automation runbook delete --automation-account-name "myAutomationAccount" --resource-group "rg" --name "myRunbook"
Erforderliche Parameter
Der Name des Automatisierungskontos.
Der Runbookname.
Name der Ressourcengruppe Sie können die Standardgruppe mit az configure --defaults group=<name> konfigurieren.
Optionale Parameter
Nicht zur Bestätigung auffordern
Ausführlichkeit der Protokollierung erhöhen, um alle Debugprotokolle anzuzeigen.
Zeigen Sie diese Hilfemeldung an, und schließen Sie sie.
Nur Fehler anzeigen und Warnungen unterdrücken.
Ausgabeformat.
JMESPath-Abfragezeichenfolge. Weitere Informationen und Beispiele finden Sie unter http://jmespath.org/.
Der Name oder die ID des Abonnements. Sie können das standardmäßig verwendete Abonnement mittels az account set -s NAME_OR_ID konfigurieren.
Ausführlichkeit der Protokollierung erhöhen. „--debug“ für vollständige Debugprotokolle verwenden.
az automation runbook list
Rufen Sie eine Liste von Runbooks ab.
az automation runbook list --automation-account-name
--resource-group
Beispiele
Auflisten von Runbooks nach Automatisierungskonto
az automation runbook list --automation-account-name "myAutomationAccount" --resource-group "rg"
Erforderliche Parameter
Der Name des Automatisierungskontos.
Name der Ressourcengruppe Sie können die Standardgruppe mit az configure --defaults group=<name> konfigurieren.
Ausführlichkeit der Protokollierung erhöhen, um alle Debugprotokolle anzuzeigen.
Zeigen Sie diese Hilfemeldung an, und schließen Sie sie.
Nur Fehler anzeigen und Warnungen unterdrücken.
Ausgabeformat.
JMESPath-Abfragezeichenfolge. Weitere Informationen und Beispiele finden Sie unter http://jmespath.org/.
Der Name oder die ID des Abonnements. Sie können das standardmäßig verwendete Abonnement mittels az account set -s NAME_OR_ID konfigurieren.
Ausführlichkeit der Protokollierung erhöhen. „--debug“ für vollständige Debugprotokolle verwenden.
az automation runbook publish
Veröffentlichen Sie den Runbook-Entwurf.
az automation runbook publish --automation-account-name
--name
--resource-group
[--no-wait]
Beispiele
Runbook-Entwurf veröffentlichen
az automation runbook publish --automation-account-name "myAutomationAccount" --resource-group "rg" --name "myRunbook"
Erforderliche Parameter
Der Name des Automatisierungskontos.
Die Parameter, die für den Veröffentlichungs-Runbook-Vorgang bereitgestellt werden.
Name der Ressourcengruppe Sie können die Standardgruppe mit az configure --defaults group=<name> konfigurieren.
Optionale Parameter
Nicht auf den Abschluss lang andauernder Vorgänge warten
Ausführlichkeit der Protokollierung erhöhen, um alle Debugprotokolle anzuzeigen.
Zeigen Sie diese Hilfemeldung an, und schließen Sie sie.
Nur Fehler anzeigen und Warnungen unterdrücken.
Ausgabeformat.
JMESPath-Abfragezeichenfolge. Weitere Informationen und Beispiele finden Sie unter http://jmespath.org/.
Der Name oder die ID des Abonnements. Sie können das standardmäßig verwendete Abonnement mittels az account set -s NAME_OR_ID konfigurieren.
Ausführlichkeit der Protokollierung erhöhen. „--debug“ für vollständige Debugprotokolle verwenden.
az automation runbook replace-content
Ersetzen Sie den Inhalt des Runbook.
az automation runbook replace-content --automation-account-name
--content
--name
--resource-group
[--no-wait]
Beispiele
Ersetzen des Inhalts des Runbook
az automation runbook replace-content --automation-account-name "myAutomationAccount" --resource-group "rg" --name "myRunbook" --content @/path/to/script
Erforderliche Parameter
Der Name des Automatisierungskontos.
Der Runbook-Inhalt.
Der Runbookname.
Name der Ressourcengruppe Sie können die Standardgruppe mit az configure --defaults group=<name> konfigurieren.
Optionale Parameter
Nicht auf den Abschluss lang andauernder Vorgänge warten
Ausführlichkeit der Protokollierung erhöhen, um alle Debugprotokolle anzuzeigen.
Zeigen Sie diese Hilfemeldung an, und schließen Sie sie.
Nur Fehler anzeigen und Warnungen unterdrücken.
Ausgabeformat.
JMESPath-Abfragezeichenfolge. Weitere Informationen und Beispiele finden Sie unter http://jmespath.org/.
Der Name oder die ID des Abonnements. Sie können das standardmäßig verwendete Abonnement mittels az account set -s NAME_OR_ID konfigurieren.
Ausführlichkeit der Protokollierung erhöhen. „--debug“ für vollständige Debugprotokolle verwenden.
az automation runbook revert-to-published
Stellen Sie den Runbook-Inhalt auf den letzten bekannten veröffentlichten Zustand zurück.
az automation runbook revert-to-published --automation-account-name
--name
--resource-group
Beispiele
Ersetzen des Inhalts des Runbook
az automation runbook revert-to-published --automation-account-name "myAutomationAccount" --resource-group "rg" --name "myRunbook"
Erforderliche Parameter
Der Name des Automatisierungskontos.
Der Runbookname.
Name der Ressourcengruppe Sie können die Standardgruppe mit az configure --defaults group=<name> konfigurieren.
Ausführlichkeit der Protokollierung erhöhen, um alle Debugprotokolle anzuzeigen.
Zeigen Sie diese Hilfemeldung an, und schließen Sie sie.
Nur Fehler anzeigen und Warnungen unterdrücken.
Ausgabeformat.
JMESPath-Abfragezeichenfolge. Weitere Informationen und Beispiele finden Sie unter http://jmespath.org/.
Der Name oder die ID des Abonnements. Sie können das standardmäßig verwendete Abonnement mittels az account set -s NAME_OR_ID konfigurieren.
Ausführlichkeit der Protokollierung erhöhen. „--debug“ für vollständige Debugprotokolle verwenden.
az automation runbook show
Rufen Sie das vom Runbook-Namen identifizierte Runbook ab.
az automation runbook show --automation-account-name
--name
--resource-group
Beispiele
Runbook abrufen
az automation runbook show --automation-account-name "myAutomationAccount" --resource-group "rg" --name "myRunbook"
Erforderliche Parameter
Der Name des Automatisierungskontos.
Der Runbookname.
Name der Ressourcengruppe Sie können die Standardgruppe mit az configure --defaults group=<name> konfigurieren.
Ausführlichkeit der Protokollierung erhöhen, um alle Debugprotokolle anzuzeigen.
Zeigen Sie diese Hilfemeldung an, und schließen Sie sie.
Nur Fehler anzeigen und Warnungen unterdrücken.
Ausgabeformat.
JMESPath-Abfragezeichenfolge. Weitere Informationen und Beispiele finden Sie unter http://jmespath.org/.
Der Name oder die ID des Abonnements. Sie können das standardmäßig verwendete Abonnement mittels az account set -s NAME_OR_ID konfigurieren.
Ausführlichkeit der Protokollierung erhöhen. „--debug“ für vollständige Debugprotokolle verwenden.
az automation runbook start
Starten Sie das Runbook.
az automation runbook start --automation-account-name
--resource-group
[--name]
[--parameters]
[--run-on]
Beispiele
Starten des Runbooks
az automation runbook start --automation-account-name "myAutomationAccount" --resource-group "rg" --name "myRunbook"
Erforderliche Parameter
Der Name des Automatisierungskontos.
Name der Ressourcengruppe Sie können die Standardgruppe mit az configure --defaults group=<name> konfigurieren.
Optionale Parameter
Der Runbookname.
Parameter des Auftrags. Wert erwarten: KEY1=WERT1=WERT1 KEY2=WERT2 ...
RunOn, der den Gruppennamen angibt, an dem der Auftrag ausgeführt werden soll.
Ausführlichkeit der Protokollierung erhöhen, um alle Debugprotokolle anzuzeigen.
Zeigen Sie diese Hilfemeldung an, und schließen Sie sie.
Nur Fehler anzeigen und Warnungen unterdrücken.
Ausgabeformat.
JMESPath-Abfragezeichenfolge. Weitere Informationen und Beispiele finden Sie unter http://jmespath.org/.
Der Name oder die ID des Abonnements. Sie können das standardmäßig verwendete Abonnement mittels az account set -s NAME_OR_ID konfigurieren.
Ausführlichkeit der Protokollierung erhöhen. „--debug“ für vollständige Debugprotokolle verwenden.
az automation runbook update
Aktualisieren Sie das runbook, das durch den Namen des Runbook identifiziert wurde.
az automation runbook update --automation-account-name
--name
--resource-group
[--description]
[--log-activity-trace]
[--log-progress {false, true}]
[--log-verbose {false, true}]
[--tags]
Beispiele
Aktualisieren eines Runbook
az automation runbook update --automation-account-name "myAutomationAccount" --description "Runbook Description" --log-activity-trace 1 --log-progress true --log-verbose false --resource-group "rg" --runbook-name "myRunbook"
Erforderliche Parameter
Der Name des Automatisierungskontos.
Der Runbookname.
Name der Ressourcengruppe Sie können die Standardgruppe mit az configure --defaults group=<name> konfigurieren.
Optionale Parameter
Beschreibung des Runbook.
Optionen für die Ablaufverfolgung auf Aktivitätsebene des Runbook.
Statusprotokolloption des Runbook.
Ausführliche Protokolloption des Runbook.
Leerzeichentrennte Tags: key[=value] [key[=value] ...]. Verwenden Sie "", um vorhandene Tags zu löschen.
Ausführlichkeit der Protokollierung erhöhen, um alle Debugprotokolle anzuzeigen.
Zeigen Sie diese Hilfemeldung an, und schließen Sie sie.
Nur Fehler anzeigen und Warnungen unterdrücken.
Ausgabeformat.
JMESPath-Abfragezeichenfolge. Weitere Informationen und Beispiele finden Sie unter http://jmespath.org/.
Der Name oder die ID des Abonnements. Sie können das standardmäßig verwendete Abonnement mittels az account set -s NAME_OR_ID konfigurieren.
Ausführlichkeit der Protokollierung erhöhen. „--debug“ für vollständige Debugprotokolle verwenden.
az automation runbook wait
Platzieren Sie die CLI in einem Wartenstatus, bis eine Bedingung des Automatisierungs-Runbook erfüllt ist.
az automation runbook wait --automation-account-name
--name
--resource-group
[--created]
[--custom]
[--deleted]
[--exists]
[--interval]
[--timeout]
[--updated]
Beispiele
Anhalten der Ausführung der nächsten Cli-Skriptzeile, bis das Automatisierungs-Runbook erfolgreich erstellt wird.
az automation runbook wait --automation-account-name "myAutomationAccount" --resource-group "rg" --name "myRunbook" --created
Erforderliche Parameter
Der Name des Automatisierungskontos.
Der Runbook-Name.
Name der Ressourcengruppe Sie können die Standardgruppe mit az configure --defaults group=<name> konfigurieren.
Optionale Parameter
Warten Sie, bis Sie mit "provisioningState" unter "Erfolgreich" erstellt wurden.
Warten Sie, bis die Bedingung eine benutzerdefinierte JMESPath-Abfrage erfüllt. Beispiel: provisioningState!='InProgress', instanceView.statuses[?code=='PowerState/running'].
Warten Sie, bis sie gelöscht wurde.
Warten Sie, bis die Ressource vorhanden ist.
Abfrageintervall in Sekunden.
Maximale Wartezeit in Sekunden.
Warten Sie, bis sie mit provisioningState unter "Erfolgreich" aktualisiert wurde.
Ausführlichkeit der Protokollierung erhöhen, um alle Debugprotokolle anzuzeigen.
Zeigen Sie diese Hilfemeldung an, und schließen Sie sie.
Nur Fehler anzeigen und Warnungen unterdrücken.
Ausgabeformat.
JMESPath-Abfragezeichenfolge. Weitere Informationen und Beispiele finden Sie unter http://jmespath.org/.
Der Name oder die ID des Abonnements. Sie können das standardmäßig verwendete Abonnement mittels az account set -s NAME_OR_ID konfigurieren.
Ausführlichkeit der Protokollierung erhöhen. „--debug“ für vollständige Debugprotokolle verwenden.
Feedback
Feedback senden und anzeigen für