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

--automation-account-name

Der Name des Automatisierungskontos.

--name --runbook-name -n

Der Runbookname.

--resource-group -g

Name der Ressourcengruppe Sie können die Standardgruppe mit az configure --defaults group=<name> konfigurieren.

--type

Typ des Runbook.

Zulässige Werte: Graph, GraphPowerShell, GraphPowerShellWorkflow, PowerShell, PowerShellWorkflow, Script

Optionale Parameter

--description

Beschreibung des Runbook.

--location -l

Der Standort. Werte aus: az account list-locations. Sie können den standardmäßig verwendeten Standort mit az configure --defaults location=<location> konfigurieren.

--log-activity-trace

Optionen für die Ablaufverfolgung auf Aktivitätsebene des Runbook.

--log-progress

Statusprotokolloption des Runbook.

Zulässige Werte: false, true
--log-verbose

Ausführliche Protokolloption des Runbook.

Zulässige Werte: false, true
--tags

Leerzeichentrennte Tags: key[=value] [key[=value] ...]. Verwenden Sie "", um vorhandene Tags zu löschen.

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

--automation-account-name

Der Name des Automatisierungskontos.

--name --runbook-name -n

Der Runbookname.

--resource-group -g

Name der Ressourcengruppe Sie können die Standardgruppe mit az configure --defaults group=<name> konfigurieren.

Optionale Parameter

--yes -y

Nicht zur Bestätigung auffordern

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

--automation-account-name

Der Name des Automatisierungskontos.

--resource-group -g

Name der Ressourcengruppe Sie können die Standardgruppe mit az configure --defaults group=<name> konfigurieren.

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

--automation-account-name

Der Name des Automatisierungskontos.

--name --runbook-name -n

Die Parameter, die für den Veröffentlichungs-Runbook-Vorgang bereitgestellt werden.

--resource-group -g

Name der Ressourcengruppe Sie können die Standardgruppe mit az configure --defaults group=<name> konfigurieren.

Optionale Parameter

--no-wait

Nicht auf den Abschluss lang andauernder Vorgänge warten

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

--automation-account-name

Der Name des Automatisierungskontos.

--content

Der Runbook-Inhalt.

--name --runbook-name -n

Der Runbookname.

--resource-group -g

Name der Ressourcengruppe Sie können die Standardgruppe mit az configure --defaults group=<name> konfigurieren.

Optionale Parameter

--no-wait

Nicht auf den Abschluss lang andauernder Vorgänge warten

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

--automation-account-name

Der Name des Automatisierungskontos.

--name --runbook-name -n

Der Runbookname.

--resource-group -g

Name der Ressourcengruppe Sie können die Standardgruppe mit az configure --defaults group=<name> konfigurieren.

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

--automation-account-name

Der Name des Automatisierungskontos.

--name --runbook-name -n

Der Runbookname.

--resource-group -g

Name der Ressourcengruppe Sie können die Standardgruppe mit az configure --defaults group=<name> konfigurieren.

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

--automation-account-name

Der Name des Automatisierungskontos.

--resource-group -g

Name der Ressourcengruppe Sie können die Standardgruppe mit az configure --defaults group=<name> konfigurieren.

Optionale Parameter

--name --runbook-name -n

Der Runbookname.

--parameters

Parameter des Auftrags. Wert erwarten: KEY1=WERT1=WERT1 KEY2=WERT2 ...

--run-on

RunOn, der den Gruppennamen angibt, an dem der Auftrag ausgeführt werden soll.

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

--automation-account-name

Der Name des Automatisierungskontos.

--name --runbook-name -n

Der Runbookname.

--resource-group -g

Name der Ressourcengruppe Sie können die Standardgruppe mit az configure --defaults group=<name> konfigurieren.

Optionale Parameter

--description

Beschreibung des Runbook.

--log-activity-trace

Optionen für die Ablaufverfolgung auf Aktivitätsebene des Runbook.

--log-progress

Statusprotokolloption des Runbook.

Zulässige Werte: false, true
--log-verbose

Ausführliche Protokolloption des Runbook.

Zulässige Werte: false, true
--tags

Leerzeichentrennte Tags: key[=value] [key[=value] ...]. Verwenden Sie "", um vorhandene Tags zu löschen.

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

--automation-account-name

Der Name des Automatisierungskontos.

--name --runbook-name -n

Der Runbook-Name.

--resource-group -g

Name der Ressourcengruppe Sie können die Standardgruppe mit az configure --defaults group=<name> konfigurieren.

Optionale Parameter

--created

Warten Sie, bis Sie mit "provisioningState" unter "Erfolgreich" erstellt wurden.

--custom

Warten Sie, bis die Bedingung eine benutzerdefinierte JMESPath-Abfrage erfüllt. Beispiel: provisioningState!='InProgress', instanceView.statuses[?code=='PowerState/running'].

--deleted

Warten Sie, bis sie gelöscht wurde.

--exists

Warten Sie, bis die Ressource vorhanden ist.

--interval

Abfrageintervall in Sekunden.

Standardwert: 30
--timeout

Maximale Wartezeit in Sekunden.

Standardwert: 3600
--updated

Warten Sie, bis sie mit provisioningState unter "Erfolgreich" aktualisiert wurde.