az automation runbook
Hinweis
Diese Referenz ist Teil der Automatisierungserweiterung für die Azure CLI (Version 2.55.0 oder höher). Die Erweiterung wird automatisch installiert, wenn Sie einen Az Automation Runbook-Befehl zum ersten Mal ausführen. Weitere Informationen zu Erweiterungen
Diese Befehlsgruppe ist experimentell und wird entwickelt. Referenz- und Supportebenen: https://aka.ms/CLI_refstatus
Automation-Runbook.
Befehle
Name | Beschreibung | Typ | Status |
---|---|---|---|
az automation runbook create |
Erstellen Sie das durch den Runbooknamen identifizierte Runbook. |
Erweiterung | Experimentell |
az automation runbook delete |
Löschen Sie das Runbook anhand des Namens. |
Erweiterung | Experimentell |
az automation runbook list |
Dient zum Abrufen einer Liste von Runbooks. |
Erweiterung | Experimentell |
az automation runbook publish |
Runbook-Entwurf veröffentlichen. |
Erweiterung | Experimentell |
az automation runbook replace-content |
Ersetzen Sie den Inhalt des Runbook. |
Erweiterung | Experimentell |
az automation runbook revert-to-published |
Stellen Sie den Runbook-Inhalt auf den letzten bekannten veröffentlichten Zustand zurück. |
Erweiterung | Experimentell |
az automation runbook show |
Rufen Sie das durch den Runbooknamen identifizierte Runbook ab. |
Erweiterung | Experimentell |
az automation runbook start |
Starten Sie das Runbook. |
Erweiterung | Experimentell |
az automation runbook update |
Aktualisieren Sie das runbook, das durch den Namen des Runbook identifiziert wurde. |
Erweiterung | Experimentell |
az automation runbook wait |
Platzieren Sie die CLI in einem Wartezustand, bis eine Bedingung des Automatisierungs-Runbook erfüllt ist. |
Erweiterung | Experimentell |
az automation runbook create
Befehlsgruppe "Automatisierungsrunbook" ist experimentell und wird entwickelt. Referenz- und Supportebenen: https://aka.ms/CLI_refstatus
Erstellen Sie das durch den Runbooknamen identifizierte Runbook.
az automation runbook create --automation-account-name
--name
--resource-group
--type {Graph, GraphPowerShell, GraphPowerShellWorkflow, PowerShell, PowerShellWorkflow, Python2, Python3, 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 Name des Runbook.
Name der Ressourcengruppe Sie können die Standardgruppe mit az configure --defaults group=<name>
konfigurieren.
Typ des Runbook.
Optionale Parameter
Beschreibung des Runbook.
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.
Durch Leerzeichen getrennte Tags: key[=value] [key[=value] ...]. Verwenden Sie "", um vorhandene Tags zu löschen.
Globale Parameter
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
Befehlsgruppe "Automatisierungsrunbook" ist experimentell und wird entwickelt. Referenz- und Supportebenen: https://aka.ms/CLI_refstatus
Löschen Sie das Runbook anhand des Namens.
az automation runbook delete [--automation-account-name]
[--ids]
[--name]
[--resource-group]
[--subscription]
[--yes]
Beispiele
Löschen eines Runbook
az automation runbook delete --automation-account-name "myAutomationAccount" --resource-group "rg" --name "myRunbook"
Optionale Parameter
Der Name des Automatisierungskontos.
Eine oder mehrere Ressourcen-IDs (durch Leerzeichen getrennt). Dabei sollte es sich um eine vollständige Ressourcen-ID mit allen Informationen der Argumente "Ressourcen-ID" sein. Sie sollten entweder --ids oder andere Argumente für die Ressourcen-ID angeben.
Der Name des Runbook.
Name der Ressourcengruppe Sie können die Standardgruppe mit az configure --defaults group=<name>
konfigurieren.
Der Name oder die ID des Abonnements. Sie können das standardmäßig verwendete Abonnement mittels az account set -s NAME_OR_ID
konfigurieren.
Nicht zur Bestätigung auffordern
Globale Parameter
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
Befehlsgruppe "Automatisierungsrunbook" ist experimentell und wird entwickelt. Referenz- und Supportebenen: https://aka.ms/CLI_refstatus
Dient zum Abrufen einer Liste von Runbooks.
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.
Globale Parameter
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
Befehlsgruppe "Automatisierungsrunbook" ist experimentell und wird entwickelt. Referenz- und Supportebenen: https://aka.ms/CLI_refstatus
Runbook-Entwurf veröffentlichen.
az automation runbook publish [--automation-account-name]
[--ids]
[--name]
[--no-wait]
[--resource-group]
[--subscription]
Beispiele
Runbook-Entwurf veröffentlichen
az automation runbook publish --automation-account-name "myAutomationAccount" --resource-group "rg" --name "myRunbook"
Optionale Parameter
Der Name des Automatisierungskontos.
Eine oder mehrere Ressourcen-IDs (durch Leerzeichen getrennt). Dabei sollte es sich um eine vollständige Ressourcen-ID mit allen Informationen der Argumente "Ressourcen-ID" sein. Sie sollten entweder --ids oder andere Argumente für die Ressourcen-ID angeben.
Die Parameter, die für den Veröffentlichungs-Runbook-Vorgang bereitgestellt werden.
Nicht auf den Abschluss lang andauernder Vorgänge warten
Name der Ressourcengruppe Sie können die Standardgruppe mit az configure --defaults group=<name>
konfigurieren.
Der Name oder die ID des Abonnements. Sie können das standardmäßig verwendete Abonnement mittels az account set -s NAME_OR_ID
konfigurieren.
Globale Parameter
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
Befehlsgruppe "Automatisierungsrunbook" ist experimentell und wird entwickelt. Referenz- und Supportebenen: https://aka.ms/CLI_refstatus
Ersetzen Sie den Inhalt des Runbook.
az automation runbook replace-content --content
[--automation-account-name]
[--ids]
[--name]
[--no-wait]
[--resource-group]
[--subscription]
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 Runbookinhalt.
Optionale Parameter
Der Name des Automatisierungskontos.
Eine oder mehrere Ressourcen-IDs (durch Leerzeichen getrennt). Dabei sollte es sich um eine vollständige Ressourcen-ID mit allen Informationen der Argumente "Ressourcen-ID" sein. Sie sollten entweder --ids oder andere Argumente für die Ressourcen-ID angeben.
Der Name des Runbook.
Nicht auf den Abschluss lang andauernder Vorgänge warten
Name der Ressourcengruppe Sie können die Standardgruppe mit az configure --defaults group=<name>
konfigurieren.
Der Name oder die ID des Abonnements. Sie können das standardmäßig verwendete Abonnement mittels az account set -s NAME_OR_ID
konfigurieren.
Globale Parameter
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
Befehlsgruppe "Automatisierungsrunbook" ist experimentell und wird entwickelt. Referenz- und Supportebenen: https://aka.ms/CLI_refstatus
Stellen Sie den Runbook-Inhalt auf den letzten bekannten veröffentlichten Zustand zurück.
az automation runbook revert-to-published [--automation-account-name]
[--ids]
[--name]
[--resource-group]
[--subscription]
Beispiele
Ersetzen des Inhalts des Runbook
az automation runbook revert-to-published --automation-account-name "myAutomationAccount" --resource-group "rg" --name "myRunbook"
Optionale Parameter
Der Name des Automatisierungskontos.
Eine oder mehrere Ressourcen-IDs (durch Leerzeichen getrennt). Dabei sollte es sich um eine vollständige Ressourcen-ID mit allen Informationen der Argumente "Ressourcen-ID" sein. Sie sollten entweder --ids oder andere Argumente für die Ressourcen-ID angeben.
Der Name des Runbook.
Name der Ressourcengruppe Sie können die Standardgruppe mit az configure --defaults group=<name>
konfigurieren.
Der Name oder die ID des Abonnements. Sie können das standardmäßig verwendete Abonnement mittels az account set -s NAME_OR_ID
konfigurieren.
Globale Parameter
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
Befehlsgruppe "Automatisierungsrunbook" ist experimentell und wird entwickelt. Referenz- und Supportebenen: https://aka.ms/CLI_refstatus
Rufen Sie das durch den Runbooknamen identifizierte Runbook ab.
az automation runbook show [--automation-account-name]
[--ids]
[--name]
[--resource-group]
[--subscription]
Beispiele
Runbook abrufen
az automation runbook show --automation-account-name "myAutomationAccount" --resource-group "rg" --name "myRunbook"
Optionale Parameter
Der Name des Automatisierungskontos.
Eine oder mehrere Ressourcen-IDs (durch Leerzeichen getrennt). Dabei sollte es sich um eine vollständige Ressourcen-ID mit allen Informationen der Argumente "Ressourcen-ID" sein. Sie sollten entweder --ids oder andere Argumente für die Ressourcen-ID angeben.
Der Name des Runbook.
Name der Ressourcengruppe Sie können die Standardgruppe mit az configure --defaults group=<name>
konfigurieren.
Der Name oder die ID des Abonnements. Sie können das standardmäßig verwendete Abonnement mittels az account set -s NAME_OR_ID
konfigurieren.
Globale Parameter
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
Befehlsgruppe "Automatisierungsrunbook" ist experimentell und wird entwickelt. Referenz- und Supportebenen: https://aka.ms/CLI_refstatus
Starten Sie das Runbook.
az automation runbook start [--automation-account-name]
[--ids]
[--name]
[--parameters]
[--resource-group]
[--run-on]
[--subscription]
Beispiele
Starten des Runbooks
az automation runbook start --automation-account-name "myAutomationAccount" --resource-group "rg" --name "myRunbook"
Optionale Parameter
Der Name des Automatisierungskontos.
Eine oder mehrere Ressourcen-IDs (durch Leerzeichen getrennt). Dabei sollte es sich um eine vollständige Ressourcen-ID mit allen Informationen der Argumente "Ressourcen-ID" sein. Sie sollten entweder --ids oder andere Argumente für die Ressourcen-ID angeben.
Der Name des Runbook.
Parameter des Auftrags. Wert erwarten: KEY1=WERT1 KEY2=WERT2 ...
Name der Ressourcengruppe Sie können die Standardgruppe mit az configure --defaults group=<name>
konfigurieren.
RunOn, der den Gruppennamen angibt, in dem der Auftrag ausgeführt werden soll.
Der Name oder die ID des Abonnements. Sie können das standardmäßig verwendete Abonnement mittels az account set -s NAME_OR_ID
konfigurieren.
Globale Parameter
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
Befehlsgruppe "Automatisierungsrunbook" ist experimentell und wird entwickelt. Referenz- und Supportebenen: https://aka.ms/CLI_refstatus
Aktualisieren Sie das runbook, das durch den Namen des Runbook identifiziert wurde.
az automation runbook update [--automation-account-name]
[--description]
[--ids]
[--log-activity-trace]
[--log-progress {false, true}]
[--log-verbose {false, true}]
[--name]
[--resource-group]
[--subscription]
[--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"
Optionale Parameter
Der Name des Automatisierungskontos.
Beschreibung des Runbook.
Eine oder mehrere Ressourcen-IDs (durch Leerzeichen getrennt). Dabei sollte es sich um eine vollständige Ressourcen-ID mit allen Informationen der Argumente "Ressourcen-ID" sein. Sie sollten entweder --ids oder andere Argumente für die Ressourcen-ID angeben.
Optionen für die Ablaufverfolgung auf Aktivitätsebene des Runbook.
Statusprotokolloption des Runbook.
Ausführliche Protokolloption des Runbook.
Der Name des Runbook.
Name der Ressourcengruppe Sie können die Standardgruppe mit az configure --defaults group=<name>
konfigurieren.
Der Name oder die ID des Abonnements. Sie können das standardmäßig verwendete Abonnement mittels az account set -s NAME_OR_ID
konfigurieren.
Durch Leerzeichen getrennte Tags: key[=value] [key[=value] ...]. Verwenden Sie "", um vorhandene Tags zu löschen.
Globale Parameter
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
Befehlsgruppe "Automatisierungsrunbook" ist experimentell und wird entwickelt. Referenz- und Supportebenen: https://aka.ms/CLI_refstatus
Platzieren Sie die CLI in einem Wartezustand, bis eine Bedingung des Automatisierungs-Runbook erfüllt ist.
az automation runbook wait [--automation-account-name]
[--created]
[--custom]
[--deleted]
[--exists]
[--ids]
[--interval]
[--name]
[--resource-group]
[--subscription]
[--timeout]
[--updated]
Beispiele
Anhalten der Ausführung der nächsten Zeile des CLI-Skripts, bis das Automatisierungsrunbook erfolgreich erstellt wurde.
az automation runbook wait --automation-account-name "myAutomationAccount" --resource-group "rg" --name "myRunbook" --created
Optionale Parameter
Der Name des Automatisierungskontos.
Warten Sie, bis sie mit 'provisioningState' unter 'Succeeded' erstellt wurde.
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.
Eine oder mehrere Ressourcen-IDs (durch Leerzeichen getrennt). Dabei sollte es sich um eine vollständige Ressourcen-ID mit allen Informationen der Argumente "Ressourcen-ID" sein. Sie sollten entweder --ids oder andere Argumente für die Ressourcen-ID angeben.
Abrufintervall in Sekunden.
Der Name des Runbook.
Name der Ressourcengruppe Sie können die Standardgruppe mit az configure --defaults group=<name>
konfigurieren.
Der Name oder die ID des Abonnements. Sie können das standardmäßig verwendete Abonnement mittels az account set -s NAME_OR_ID
konfigurieren.
Maximale Wartezeit in Sekunden.
Warten Sie, bis sie mit provisioningState unter 'Succeeded' aktualisiert wurde.
Globale Parameter
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.