az automation runbook

Uwaga

Ta dokumentacja jest częścią rozszerzenia automatyzacji interfejsu wiersza polecenia platformy Azure (wersja 2.13.0 lub nowsza). Rozszerzenie automatycznie zainstaluje polecenie az automation runbook po raz pierwszy. Dowiedz się więcej o rozszerzeniach.

Element Runbook automatyzacji.

Polecenia

az automation runbook create	Utwórz element Runbook zidentyfikowany przez nazwę elementu Runbook.
az automation runbook delete	Usuń element Runbook według nazwy.
az automation runbook list	Pobieranie listy elementów Runbook.
az automation runbook publish	Publikowanie wersji roboczej elementu Runbook.
az automation runbook replace-content	Zastąp zawartość elementu Runbook.
az automation runbook revert-to-published	Przywróć zawartość elementu Runbook do ostatniego znanego stanu opublikowanego.
az automation runbook show	Pobierz element Runbook zidentyfikowany przez nazwę elementu Runbook.
az automation runbook start	Uruchom element Runbook.
az automation runbook update	Zaktualizuj element Runbook zidentyfikowany przez nazwę elementu Runbook.
az automation runbook wait	Umieść interfejs wiersza polecenia w stanie oczekiwania do momentu spełnienia warunku elementu Runbook automatyzacji.

az automation runbook create

Utwórz element Runbook zidentyfikowany przez nazwę elementu Runbook.

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]

Przykłady

Tworzenie elementu runbook

az automation runbook create --automation-account-name "myAutomationAccount" --resource-group "rg"                --name "myRunbook" --type "PowerShell" --location "East US 2"

Parametry wymagane

--automation-account-name

Nazwa konta usługi Automation.

--name --runbook-name -n

Nazwa elementu runbook.

--resource-group -g

Nazwa grupy zasobów. Grupę domyślną można skonfigurować przy użyciu polecenia az configure --defaults group=<name>.

--type

Typ elementu Runbook.

akceptowane wartości: Graph, GraphPowerShell, GraphPowerShellWorkflow, PowerShell, PowerShellWorkflow, Script

Parametry opcjonalne

--description

Opis elementu Runbook.

--location -l

Lokalizacja. Wartości z: az account list-locations. Lokalizację domyślną można skonfigurować przy użyciu polecenia az configure --defaults location=<location>.

--log-activity-trace

Opcje śledzenia na poziomie działania elementu Runbook.

--log-progress

Opcja dziennika postępu elementu Runbook.

akceptowane wartości: false, true

--log-verbose

Pełne opcje dziennika elementu Runbook.

akceptowane wartości: false, true

--tags

Tagi rozdzielone spacjami: klucz[=wartość] [klucz[=wartość] ...]. Użyj ciągu "", aby wyczyścić istniejące tagi.

Parametry globalne

--debug

Zwiększ szczegółowość rejestrowania, aby wyświetlić wszystkie dzienniki debugowania.

--help -h

Pokaż ten komunikat pomocy i zakończ pracę.

--only-show-errors

Pokaż tylko błędy, pomijając ostrzeżenia.

--output -o

Format danych wyjściowych.

--query

Ciąg zapytania JMESPath. Zobacz http://jmespath.org/ , aby uzyskać więcej informacji i przykładów.

--subscription

Nazwa lub identyfikator subskrypcji. Możesz skonfigurować domyślną subskrypcję przy użyciu polecenia az account set -s NAME_OR_ID.

--verbose

Zwiększ szczegółowość rejestrowania. Użyj polecenia --debug, aby uzyskać pełne dzienniki debugowania.

az automation runbook delete

Usuń element Runbook według nazwy.

az automation runbook delete --automation-account-name
                             --name
                             --resource-group
                             [--yes]

Przykłady

Usuwanie elementu Runbook

az automation runbook delete --automation-account-name "myAutomationAccount" --resource-group "rg"                --name "myRunbook"

Parametry wymagane

--automation-account-name

Nazwa konta usługi Automation.

--name --runbook-name -n

Nazwa elementu runbook.

--resource-group -g

Nazwa grupy zasobów. Grupę domyślną można skonfigurować przy użyciu polecenia az configure --defaults group=<name>.

Parametry opcjonalne

--yes -y

Nie monituj o potwierdzenie.

Parametry globalne

--debug

Zwiększ szczegółowość rejestrowania, aby wyświetlić wszystkie dzienniki debugowania.

--help -h

Pokaż ten komunikat pomocy i zakończ pracę.

--only-show-errors

Pokaż tylko błędy, pomijając ostrzeżenia.

--output -o

Format danych wyjściowych.

--query

Ciąg zapytania JMESPath. Zobacz http://jmespath.org/ , aby uzyskać więcej informacji i przykładów.

--subscription

Nazwa lub identyfikator subskrypcji. Możesz skonfigurować domyślną subskrypcję przy użyciu polecenia az account set -s NAME_OR_ID.

--verbose

Zwiększ szczegółowość rejestrowania. Użyj polecenia --debug, aby uzyskać pełne dzienniki debugowania.

az automation runbook list

Pobieranie listy elementów Runbook.

az automation runbook list --automation-account-name
                           --resource-group

Przykłady

Wyświetlanie listy elementów Runbook według konta usługi Automation

az automation runbook list --automation-account-name "myAutomationAccount" --resource-group "rg"

Parametry wymagane

--automation-account-name

Nazwa konta usługi Automation.

--resource-group -g

Nazwa grupy zasobów. Grupę domyślną można skonfigurować przy użyciu polecenia az configure --defaults group=<name>.

Parametry globalne

--debug

Zwiększ szczegółowość rejestrowania, aby wyświetlić wszystkie dzienniki debugowania.

--help -h

Pokaż ten komunikat pomocy i zakończ pracę.

--only-show-errors

Pokaż tylko błędy, pomijając ostrzeżenia.

--output -o

Format danych wyjściowych.

--query

Ciąg zapytania JMESPath. Zobacz http://jmespath.org/ , aby uzyskać więcej informacji i przykładów.

--subscription

Nazwa lub identyfikator subskrypcji. Możesz skonfigurować domyślną subskrypcję przy użyciu polecenia az account set -s NAME_OR_ID.

--verbose

Zwiększ szczegółowość rejestrowania. Użyj polecenia --debug, aby uzyskać pełne dzienniki debugowania.

az automation runbook publish

Publikowanie wersji roboczej elementu Runbook.

az automation runbook publish --automation-account-name
                              --name
                              --resource-group
                              [--no-wait]

Przykłady

Publikowanie wersji roboczej elementu Runbook

az automation runbook publish --automation-account-name "myAutomationAccount" --resource-group                "rg" --name "myRunbook"

Parametry wymagane

--automation-account-name

Nazwa konta usługi Automation.

--name --runbook-name -n

Parametry dostarczone do operacji publikowania elementu Runbook.

--resource-group -g

Nazwa grupy zasobów. Grupę domyślną można skonfigurować przy użyciu polecenia az configure --defaults group=<name>.

Parametry opcjonalne

--no-wait

Nie czekaj na zakończenie długotrwałej operacji.

Parametry globalne

--debug

Zwiększ szczegółowość rejestrowania, aby wyświetlić wszystkie dzienniki debugowania.

--help -h

Pokaż ten komunikat pomocy i zakończ pracę.

--only-show-errors

Pokaż tylko błędy, pomijając ostrzeżenia.

--output -o

Format danych wyjściowych.

--query

Ciąg zapytania JMESPath. Zobacz http://jmespath.org/ , aby uzyskać więcej informacji i przykładów.

--subscription

Nazwa lub identyfikator subskrypcji. Możesz skonfigurować domyślną subskrypcję przy użyciu polecenia az account set -s NAME_OR_ID.

--verbose

Zwiększ szczegółowość rejestrowania. Użyj polecenia --debug, aby uzyskać pełne dzienniki debugowania.

az automation runbook replace-content

Zastąp zawartość elementu Runbook.

az automation runbook replace-content --automation-account-name
                                      --content
                                      --name
                                      --resource-group
                                      [--no-wait]

Przykłady

Zastępowanie zawartości elementu Runbook

az automation runbook replace-content --automation-account-name "myAutomationAccount" --resource-group                "rg" --name "myRunbook" --content @/path/to/script

Parametry wymagane

--automation-account-name

Nazwa konta usługi Automation.

--content

Zawartość elementu Runbook.

--name --runbook-name -n

Nazwa elementu runbook.

--resource-group -g

Nazwa grupy zasobów. Grupę domyślną można skonfigurować przy użyciu polecenia az configure --defaults group=<name>.

Parametry opcjonalne

--no-wait

Nie czekaj na zakończenie długotrwałej operacji.

Parametry globalne

--debug

Zwiększ szczegółowość rejestrowania, aby wyświetlić wszystkie dzienniki debugowania.

--help -h

Pokaż ten komunikat pomocy i zakończ pracę.

--only-show-errors

Pokaż tylko błędy, pomijając ostrzeżenia.

--output -o

Format danych wyjściowych.

--query

Ciąg zapytania JMESPath. Zobacz http://jmespath.org/ , aby uzyskać więcej informacji i przykładów.

--subscription

Nazwa lub identyfikator subskrypcji. Możesz skonfigurować domyślną subskrypcję przy użyciu polecenia az account set -s NAME_OR_ID.

--verbose

Zwiększ szczegółowość rejestrowania. Użyj polecenia --debug, aby uzyskać pełne dzienniki debugowania.

az automation runbook revert-to-published

Przywróć zawartość elementu Runbook do ostatniego znanego stanu opublikowanego.

az automation runbook revert-to-published --automation-account-name
                                          --name
                                          --resource-group

Przykłady

Zastępowanie zawartości elementu Runbook

az automation runbook revert-to-published --automation-account-name "myAutomationAccount"                --resource-group "rg" --name "myRunbook"

Parametry wymagane

--automation-account-name

Nazwa konta usługi Automation.

--name --runbook-name -n

Nazwa elementu runbook.

--resource-group -g

Nazwa grupy zasobów. Grupę domyślną można skonfigurować przy użyciu polecenia az configure --defaults group=<name>.

Parametry globalne

--debug

Zwiększ szczegółowość rejestrowania, aby wyświetlić wszystkie dzienniki debugowania.

--help -h

Pokaż ten komunikat pomocy i zakończ pracę.

--only-show-errors

Pokaż tylko błędy, pomijając ostrzeżenia.

--output -o

Format danych wyjściowych.

--query

Ciąg zapytania JMESPath. Zobacz http://jmespath.org/ , aby uzyskać więcej informacji i przykładów.

--subscription

Nazwa lub identyfikator subskrypcji. Możesz skonfigurować domyślną subskrypcję przy użyciu polecenia az account set -s NAME_OR_ID.

--verbose

Zwiększ szczegółowość rejestrowania. Użyj polecenia --debug, aby uzyskać pełne dzienniki debugowania.

az automation runbook show

Pobierz element Runbook zidentyfikowany przez nazwę elementu Runbook.

az automation runbook show --automation-account-name
                           --name
                           --resource-group

Przykłady

Pobieranie elementu Runbook

az automation runbook show --automation-account-name "myAutomationAccount" --resource-group "rg"                --name "myRunbook"

Parametry wymagane

--automation-account-name

Nazwa konta usługi Automation.

--name --runbook-name -n

Nazwa elementu runbook.

--resource-group -g

Nazwa grupy zasobów. Grupę domyślną można skonfigurować przy użyciu polecenia az configure --defaults group=<name>.

Parametry globalne

--debug

Zwiększ szczegółowość rejestrowania, aby wyświetlić wszystkie dzienniki debugowania.

--help -h

Pokaż ten komunikat pomocy i zakończ pracę.

--only-show-errors

Pokaż tylko błędy, pomijając ostrzeżenia.

--output -o

Format danych wyjściowych.

--query

Ciąg zapytania JMESPath. Zobacz http://jmespath.org/ , aby uzyskać więcej informacji i przykładów.

--subscription

Nazwa lub identyfikator subskrypcji. Możesz skonfigurować domyślną subskrypcję przy użyciu polecenia az account set -s NAME_OR_ID.

--verbose

Zwiększ szczegółowość rejestrowania. Użyj polecenia --debug, aby uzyskać pełne dzienniki debugowania.

az automation runbook start

Uruchom element Runbook.

az automation runbook start --automation-account-name
                            --resource-group
                            [--name]
                            [--parameters]
                            [--run-on]

Przykłady

Uruchamianie elementu runbook

az automation runbook start --automation-account-name "myAutomationAccount" --resource-group "rg"                --name "myRunbook"

Parametry wymagane

--automation-account-name

Nazwa konta usługi Automation.

--resource-group -g

Nazwa grupy zasobów. Grupę domyślną można skonfigurować przy użyciu polecenia az configure --defaults group=<name>.

Parametry opcjonalne

--name --runbook-name -n

Nazwa elementu runbook.

--parameters

Parametry zadania. Oczekiwana wartość: KEY1=VALUE1 KEY2=VALUE2 ...

--run-on

RunOn, który określa nazwę grupy, w której ma zostać wykonane zadanie.

Parametry globalne

--debug

Zwiększ szczegółowość rejestrowania, aby wyświetlić wszystkie dzienniki debugowania.

--help -h

Pokaż ten komunikat pomocy i zakończ pracę.

--only-show-errors

Pokaż tylko błędy, pomijając ostrzeżenia.

--output -o

Format danych wyjściowych.

--query

Ciąg zapytania JMESPath. Zobacz http://jmespath.org/ , aby uzyskać więcej informacji i przykładów.

--subscription

Nazwa lub identyfikator subskrypcji. Możesz skonfigurować domyślną subskrypcję przy użyciu polecenia az account set -s NAME_OR_ID.

--verbose

Zwiększ szczegółowość rejestrowania. Użyj polecenia --debug, aby uzyskać pełne dzienniki debugowania.

az automation runbook update

Zaktualizuj element Runbook zidentyfikowany przez nazwę elementu Runbook.

az automation runbook update --automation-account-name
                             --name
                             --resource-group
                             [--description]
                             [--log-activity-trace]
                             [--log-progress {false, true}]
                             [--log-verbose {false, true}]
                             [--tags]

Przykłady

Aktualizowanie elementu 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"

Parametry wymagane

--automation-account-name

Nazwa konta usługi Automation.

--name --runbook-name -n

Nazwa elementu runbook.

--resource-group -g

Nazwa grupy zasobów. Grupę domyślną można skonfigurować przy użyciu polecenia az configure --defaults group=<name>.

Parametry opcjonalne

--description

Opis elementu Runbook.

--log-activity-trace

Opcje śledzenia na poziomie działania elementu Runbook.

--log-progress

Opcja dziennika postępu elementu Runbook.

akceptowane wartości: false, true

--log-verbose

Pełne opcje dziennika elementu Runbook.

akceptowane wartości: false, true

--tags

Tagi rozdzielone spacjami: klucz[=wartość] [klucz[=wartość] ...]. Użyj ciągu "", aby wyczyścić istniejące tagi.

Parametry globalne

--debug

Zwiększ szczegółowość rejestrowania, aby wyświetlić wszystkie dzienniki debugowania.

--help -h

Pokaż ten komunikat pomocy i zakończ pracę.

--only-show-errors

Pokaż tylko błędy, pomijając ostrzeżenia.

--output -o

Format danych wyjściowych.

--query

Ciąg zapytania JMESPath. Zobacz http://jmespath.org/ , aby uzyskać więcej informacji i przykładów.

--subscription

Nazwa lub identyfikator subskrypcji. Możesz skonfigurować domyślną subskrypcję przy użyciu polecenia az account set -s NAME_OR_ID.

--verbose

Zwiększ szczegółowość rejestrowania. Użyj polecenia --debug, aby uzyskać pełne dzienniki debugowania.

az automation runbook wait

Umieść interfejs wiersza polecenia w stanie oczekiwania do momentu spełnienia warunku elementu Runbook automatyzacji.

az automation runbook wait --automation-account-name
                           --name
                           --resource-group
                           [--created]
                           [--custom]
                           [--deleted]
                           [--exists]
                           [--interval]
                           [--timeout]
                           [--updated]

Przykłady

Wstrzymaj wykonywanie następnego wiersza polecenia skryptu interfejsu wiersza polecenia do momentu pomyślnego utworzenia elementu Runbook automatyzacji.

az automation runbook wait --automation-account-name "myAutomationAccount" --resource-group "rg"                --name "myRunbook" --created

Parametry wymagane

--automation-account-name

Nazwa konta usługi Automation.

--name --runbook-name -n

Nazwa elementu runbook.

--resource-group -g

Nazwa grupy zasobów. Grupę domyślną można skonfigurować przy użyciu polecenia az configure --defaults group=<name>.

Parametry opcjonalne

--created

Zaczekaj na utworzenie polecenia "provisioningState" w lokalizacji "Powodzenie".

--custom

Zaczekaj, aż warunek spełnia niestandardowe zapytanie JMESPath. Na przykład provisioningState!='InProgress', instanceView.statuses[?code=='PowerState/running'].

--deleted

Zaczekaj na usunięcie.

--exists

Zaczekaj, aż zasób istnieje.

--interval

Interwał sondowania w sekundach.

wartość domyślna: 30

--timeout

Maksymalny czas oczekiwania w sekundach.

wartość domyślna: 3600

--updated

Zaczekaj na aktualizację za pomocą parametru provisioningState w lokalizacji "Powodzenie".

Parametry globalne

--debug

Zwiększ szczegółowość rejestrowania, aby wyświetlić wszystkie dzienniki debugowania.

--help -h

Pokaż ten komunikat pomocy i zakończ pracę.

--only-show-errors

Pokaż tylko błędy, pomijając ostrzeżenia.

--output -o

Format danych wyjściowych.

--query

Ciąg zapytania JMESPath. Zobacz http://jmespath.org/ , aby uzyskać więcej informacji i przykładów.

--subscription

Nazwa lub identyfikator subskrypcji. Możesz skonfigurować domyślną subskrypcję przy użyciu polecenia az account set -s NAME_OR_ID.

--verbose

Zwiększ szczegółowość rejestrowania. Użyj polecenia --debug, aby uzyskać pełne dzienniki debugowania.