Sdílet prostřednictvím


az automation runbook

Poznámka:

Tento odkaz je součástí rozšíření automatizace pro Azure CLI (verze 2.55.0 nebo vyšší). Rozšíření se automaticky nainstaluje při prvním spuštění příkazu az automation runbook . Přečtěte si další informace o rozšířeních.

Tato skupina příkazů je experimentální a ve vývoji. Referenční úrovně a úrovně podpory: https://aka.ms/CLI_refstatus

Runbook automation

Příkazy

Name Description Typ Stav
az automation runbook create

Vytvořte runbook identifikovaný názvem runbooku.

Rozšíření Experimentální
az automation runbook delete

Odstraňte runbook podle názvu.

Rozšíření Experimentální
az automation runbook list

Načte seznam runbooků.

Rozšíření Experimentální
az automation runbook publish

Publikování konceptu runbooku

Rozšíření Experimentální
az automation runbook replace-content

Nahraďte obsah runbooku.

Rozšíření Experimentální
az automation runbook revert-to-published

Vraťte obsah runbooku k naposledy známému publikovanému stavu.

Rozšíření Experimentální
az automation runbook show

Načtěte runbook identifikovaný názvem runbooku.

Rozšíření Experimentální
az automation runbook start

Spusťte runbook.

Rozšíření Experimentální
az automation runbook update

Aktualizujte runbook identifikovaný názvem runbooku.

Rozšíření Experimentální
az automation runbook wait

Umístěte rozhraní příkazového řádku do stavu čekání, dokud nebude splněna podmínka runbooku automation.

Rozšíření Experimentální

az automation runbook create

Experimentální

Příkazová skupina Automation Runbook je experimentální a probíhá vývoj. Referenční úrovně a úrovně podpory: https://aka.ms/CLI_refstatus

Vytvořte runbook identifikovaný názvem runbooku.

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]

Příklady

Vytvoření runbooku

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

Povinné parametry

--automation-account-name

Název účtu Automation.

--name --runbook-name -n

Název runbooku.

--resource-group -g

Název skupiny prostředků. Výchozí skupinu můžete nakonfigurovat pomocí az configure --defaults group=<name>.

--type

Typ runbooku

Přípustné hodnoty: Graph, GraphPowerShell, GraphPowerShellWorkflow, PowerShell, PowerShellWorkflow, Python2, Python3, Script

Volitelné parametry

--description

Popis runbooku

--location -l

Umístění. Hodnoty z: az account list-locations. Výchozí umístění můžete nakonfigurovat pomocí .az configure --defaults location=<location>

--log-activity-trace

Možnosti trasování na úrovni aktivity runbooku

--log-progress

Možnost protokolu průběhu runbooku

Přípustné hodnoty: false, true
--log-verbose

Podrobná možnost protokolu runbooku

Přípustné hodnoty: false, true
--tags

Značky oddělené mezerami: klíč[=hodnota] [klíč[=hodnota] ...]. K vymazání existujících značek použijte "".

Globální parametry
--debug

Zvyšte úroveň podrobností protokolování, aby se zobrazily všechny protokoly ladění.

--help -h

Zobrazte tuto zprávu nápovědy a ukončete ji.

--only-show-errors

Zobrazují se pouze chyby, potlačení upozornění.

--output -o

Výstupní formát

Přípustné hodnoty: json, jsonc, none, table, tsv, yaml, yamlc
Default value: json
--query

Řetězec dotazu JMESPath Další http://jmespath.org/ informace a příklady najdete v tématu.

--subscription

Název nebo ID předplatného. Výchozí předplatné můžete nakonfigurovat pomocí az account set -s NAME_OR_ID.

--verbose

Zvyšte úroveň podrobností protokolování. K úplnému ladění protokolů použijte příkaz --debug.

az automation runbook delete

Experimentální

Příkazová skupina Automation Runbook je experimentální a probíhá vývoj. Referenční úrovně a úrovně podpory: https://aka.ms/CLI_refstatus

Odstraňte runbook podle názvu.

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

Příklady

Odstranění runbooku

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

Volitelné parametry

--automation-account-name

Název účtu Automation.

--ids

Jedno nebo více ID prostředků (oddělených mezerami) Mělo by se jednat o úplné ID prostředku obsahující všechny informace o argumentech ID prostředku. Měli byste zadat argumenty --ids nebo jiné argumenty ID prostředku.

--name --runbook-name -n

Název runbooku.

--resource-group -g

Název skupiny prostředků. Výchozí skupinu můžete nakonfigurovat pomocí az configure --defaults group=<name>.

--subscription

Název nebo ID předplatného. Výchozí předplatné můžete nakonfigurovat pomocí az account set -s NAME_OR_ID.

--yes -y

Nezotvádejte výzvu k potvrzení.

Default value: False
Globální parametry
--debug

Zvyšte úroveň podrobností protokolování, aby se zobrazily všechny protokoly ladění.

--help -h

Zobrazte tuto zprávu nápovědy a ukončete ji.

--only-show-errors

Zobrazují se pouze chyby, potlačení upozornění.

--output -o

Výstupní formát

Přípustné hodnoty: json, jsonc, none, table, tsv, yaml, yamlc
Default value: json
--query

Řetězec dotazu JMESPath Další http://jmespath.org/ informace a příklady najdete v tématu.

--subscription

Název nebo ID předplatného. Výchozí předplatné můžete nakonfigurovat pomocí az account set -s NAME_OR_ID.

--verbose

Zvyšte úroveň podrobností protokolování. K úplnému ladění protokolů použijte příkaz --debug.

az automation runbook list

Experimentální

Příkazová skupina Automation Runbook je experimentální a probíhá vývoj. Referenční úrovně a úrovně podpory: https://aka.ms/CLI_refstatus

Načte seznam runbooků.

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

Příklady

Výpis runbooků podle účtu Automation

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

Povinné parametry

--automation-account-name

Název účtu Automation.

--resource-group -g

Název skupiny prostředků. Výchozí skupinu můžete nakonfigurovat pomocí az configure --defaults group=<name>.

Globální parametry
--debug

Zvyšte úroveň podrobností protokolování, aby se zobrazily všechny protokoly ladění.

--help -h

Zobrazte tuto zprávu nápovědy a ukončete ji.

--only-show-errors

Zobrazují se pouze chyby, potlačení upozornění.

--output -o

Výstupní formát

Přípustné hodnoty: json, jsonc, none, table, tsv, yaml, yamlc
Default value: json
--query

Řetězec dotazu JMESPath Další http://jmespath.org/ informace a příklady najdete v tématu.

--subscription

Název nebo ID předplatného. Výchozí předplatné můžete nakonfigurovat pomocí az account set -s NAME_OR_ID.

--verbose

Zvyšte úroveň podrobností protokolování. K úplnému ladění protokolů použijte příkaz --debug.

az automation runbook publish

Experimentální

Příkazová skupina Automation Runbook je experimentální a probíhá vývoj. Referenční úrovně a úrovně podpory: https://aka.ms/CLI_refstatus

Publikování konceptu runbooku

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

Příklady

Publikování konceptu runbooku

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

Volitelné parametry

--automation-account-name

Název účtu Automation.

--ids

Jedno nebo více ID prostředků (oddělených mezerami) Mělo by se jednat o úplné ID prostředku obsahující všechny informace o argumentech ID prostředku. Měli byste zadat argumenty --ids nebo jiné argumenty ID prostředku.

--name --runbook-name -n

Parametry zadané operaci publikování runbooku.

--no-wait

Nečekejte na dokončení dlouhotrvající operace.

Default value: False
--resource-group -g

Název skupiny prostředků. Výchozí skupinu můžete nakonfigurovat pomocí az configure --defaults group=<name>.

--subscription

Název nebo ID předplatného. Výchozí předplatné můžete nakonfigurovat pomocí az account set -s NAME_OR_ID.

Globální parametry
--debug

Zvyšte úroveň podrobností protokolování, aby se zobrazily všechny protokoly ladění.

--help -h

Zobrazte tuto zprávu nápovědy a ukončete ji.

--only-show-errors

Zobrazují se pouze chyby, potlačení upozornění.

--output -o

Výstupní formát

Přípustné hodnoty: json, jsonc, none, table, tsv, yaml, yamlc
Default value: json
--query

Řetězec dotazu JMESPath Další http://jmespath.org/ informace a příklady najdete v tématu.

--subscription

Název nebo ID předplatného. Výchozí předplatné můžete nakonfigurovat pomocí az account set -s NAME_OR_ID.

--verbose

Zvyšte úroveň podrobností protokolování. K úplnému ladění protokolů použijte příkaz --debug.

az automation runbook replace-content

Experimentální

Příkazová skupina Automation Runbook je experimentální a probíhá vývoj. Referenční úrovně a úrovně podpory: https://aka.ms/CLI_refstatus

Nahraďte obsah runbooku.

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

Příklady

Nahrazení obsahu runbooku

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

Povinné parametry

--content

Obsah runbooku.

Volitelné parametry

--automation-account-name

Název účtu Automation.

--ids

Jedno nebo více ID prostředků (oddělených mezerami) Mělo by se jednat o úplné ID prostředku obsahující všechny informace o argumentech ID prostředku. Měli byste zadat argumenty --ids nebo jiné argumenty ID prostředku.

--name --runbook-name -n

Název runbooku.

--no-wait

Nečekejte na dokončení dlouhotrvající operace.

Default value: False
--resource-group -g

Název skupiny prostředků. Výchozí skupinu můžete nakonfigurovat pomocí az configure --defaults group=<name>.

--subscription

Název nebo ID předplatného. Výchozí předplatné můžete nakonfigurovat pomocí az account set -s NAME_OR_ID.

Globální parametry
--debug

Zvyšte úroveň podrobností protokolování, aby se zobrazily všechny protokoly ladění.

--help -h

Zobrazte tuto zprávu nápovědy a ukončete ji.

--only-show-errors

Zobrazují se pouze chyby, potlačení upozornění.

--output -o

Výstupní formát

Přípustné hodnoty: json, jsonc, none, table, tsv, yaml, yamlc
Default value: json
--query

Řetězec dotazu JMESPath Další http://jmespath.org/ informace a příklady najdete v tématu.

--subscription

Název nebo ID předplatného. Výchozí předplatné můžete nakonfigurovat pomocí az account set -s NAME_OR_ID.

--verbose

Zvyšte úroveň podrobností protokolování. K úplnému ladění protokolů použijte příkaz --debug.

az automation runbook revert-to-published

Experimentální

Příkazová skupina Automation Runbook je experimentální a probíhá vývoj. Referenční úrovně a úrovně podpory: https://aka.ms/CLI_refstatus

Vraťte obsah runbooku k naposledy známému publikovanému stavu.

az automation runbook revert-to-published [--automation-account-name]
                                          [--ids]
                                          [--name]
                                          [--resource-group]
                                          [--subscription]

Příklady

Nahrazení obsahu runbooku

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

Volitelné parametry

--automation-account-name

Název účtu Automation.

--ids

Jedno nebo více ID prostředků (oddělených mezerami) Mělo by se jednat o úplné ID prostředku obsahující všechny informace o argumentech ID prostředku. Měli byste zadat argumenty --ids nebo jiné argumenty ID prostředku.

--name --runbook-name -n

Název runbooku.

--resource-group -g

Název skupiny prostředků. Výchozí skupinu můžete nakonfigurovat pomocí az configure --defaults group=<name>.

--subscription

Název nebo ID předplatného. Výchozí předplatné můžete nakonfigurovat pomocí az account set -s NAME_OR_ID.

Globální parametry
--debug

Zvyšte úroveň podrobností protokolování, aby se zobrazily všechny protokoly ladění.

--help -h

Zobrazte tuto zprávu nápovědy a ukončete ji.

--only-show-errors

Zobrazují se pouze chyby, potlačení upozornění.

--output -o

Výstupní formát

Přípustné hodnoty: json, jsonc, none, table, tsv, yaml, yamlc
Default value: json
--query

Řetězec dotazu JMESPath Další http://jmespath.org/ informace a příklady najdete v tématu.

--subscription

Název nebo ID předplatného. Výchozí předplatné můžete nakonfigurovat pomocí az account set -s NAME_OR_ID.

--verbose

Zvyšte úroveň podrobností protokolování. K úplnému ladění protokolů použijte příkaz --debug.

az automation runbook show

Experimentální

Příkazová skupina Automation Runbook je experimentální a probíhá vývoj. Referenční úrovně a úrovně podpory: https://aka.ms/CLI_refstatus

Načtěte runbook identifikovaný názvem runbooku.

az automation runbook show [--automation-account-name]
                           [--ids]
                           [--name]
                           [--resource-group]
                           [--subscription]

Příklady

Získání runbooku

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

Volitelné parametry

--automation-account-name

Název účtu Automation.

--ids

Jedno nebo více ID prostředků (oddělených mezerami) Mělo by se jednat o úplné ID prostředku obsahující všechny informace o argumentech ID prostředku. Měli byste zadat argumenty --ids nebo jiné argumenty ID prostředku.

--name --runbook-name -n

Název runbooku.

--resource-group -g

Název skupiny prostředků. Výchozí skupinu můžete nakonfigurovat pomocí az configure --defaults group=<name>.

--subscription

Název nebo ID předplatného. Výchozí předplatné můžete nakonfigurovat pomocí az account set -s NAME_OR_ID.

Globální parametry
--debug

Zvyšte úroveň podrobností protokolování, aby se zobrazily všechny protokoly ladění.

--help -h

Zobrazte tuto zprávu nápovědy a ukončete ji.

--only-show-errors

Zobrazují se pouze chyby, potlačení upozornění.

--output -o

Výstupní formát

Přípustné hodnoty: json, jsonc, none, table, tsv, yaml, yamlc
Default value: json
--query

Řetězec dotazu JMESPath Další http://jmespath.org/ informace a příklady najdete v tématu.

--subscription

Název nebo ID předplatného. Výchozí předplatné můžete nakonfigurovat pomocí az account set -s NAME_OR_ID.

--verbose

Zvyšte úroveň podrobností protokolování. K úplnému ladění protokolů použijte příkaz --debug.

az automation runbook start

Experimentální

Příkazová skupina Automation Runbook je experimentální a probíhá vývoj. Referenční úrovně a úrovně podpory: https://aka.ms/CLI_refstatus

Spusťte runbook.

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

Příklady

Spuštění runbooku

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

Volitelné parametry

--automation-account-name

Název účtu Automation.

--ids

Jedno nebo více ID prostředků (oddělených mezerami) Mělo by se jednat o úplné ID prostředku obsahující všechny informace o argumentech ID prostředku. Měli byste zadat argumenty --ids nebo jiné argumenty ID prostředku.

--name --runbook-name -n

Název runbooku.

--parameters

Parametry úlohy Očekávaná hodnota: KEY1=HODNOTA1 KLÍČ2=HODNOTA2 ...

--resource-group -g

Název skupiny prostředků. Výchozí skupinu můžete nakonfigurovat pomocí az configure --defaults group=<name>.

--run-on

RunOn, který určuje název skupiny, ve které se má úloha spustit.

--subscription

Název nebo ID předplatného. Výchozí předplatné můžete nakonfigurovat pomocí az account set -s NAME_OR_ID.

Globální parametry
--debug

Zvyšte úroveň podrobností protokolování, aby se zobrazily všechny protokoly ladění.

--help -h

Zobrazte tuto zprávu nápovědy a ukončete ji.

--only-show-errors

Zobrazují se pouze chyby, potlačení upozornění.

--output -o

Výstupní formát

Přípustné hodnoty: json, jsonc, none, table, tsv, yaml, yamlc
Default value: json
--query

Řetězec dotazu JMESPath Další http://jmespath.org/ informace a příklady najdete v tématu.

--subscription

Název nebo ID předplatného. Výchozí předplatné můžete nakonfigurovat pomocí az account set -s NAME_OR_ID.

--verbose

Zvyšte úroveň podrobností protokolování. K úplnému ladění protokolů použijte příkaz --debug.

az automation runbook update

Experimentální

Příkazová skupina Automation Runbook je experimentální a probíhá vývoj. Referenční úrovně a úrovně podpory: https://aka.ms/CLI_refstatus

Aktualizujte runbook identifikovaný názvem runbooku.

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]

Příklady

Aktualizace runbooku

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"

Volitelné parametry

--automation-account-name

Název účtu Automation.

--description

Popis runbooku

--ids

Jedno nebo více ID prostředků (oddělených mezerami) Mělo by se jednat o úplné ID prostředku obsahující všechny informace o argumentech ID prostředku. Měli byste zadat argumenty --ids nebo jiné argumenty ID prostředku.

--log-activity-trace

Možnosti trasování na úrovni aktivity runbooku

--log-progress

Možnost protokolu průběhu runbooku

Přípustné hodnoty: false, true
--log-verbose

Podrobná možnost protokolu runbooku

Přípustné hodnoty: false, true
--name --runbook-name -n

Název runbooku.

--resource-group -g

Název skupiny prostředků. Výchozí skupinu můžete nakonfigurovat pomocí az configure --defaults group=<name>.

--subscription

Název nebo ID předplatného. Výchozí předplatné můžete nakonfigurovat pomocí az account set -s NAME_OR_ID.

--tags

Značky oddělené mezerami: klíč[=hodnota] [klíč[=hodnota] ...]. K vymazání existujících značek použijte "".

Globální parametry
--debug

Zvyšte úroveň podrobností protokolování, aby se zobrazily všechny protokoly ladění.

--help -h

Zobrazte tuto zprávu nápovědy a ukončete ji.

--only-show-errors

Zobrazují se pouze chyby, potlačení upozornění.

--output -o

Výstupní formát

Přípustné hodnoty: json, jsonc, none, table, tsv, yaml, yamlc
Default value: json
--query

Řetězec dotazu JMESPath Další http://jmespath.org/ informace a příklady najdete v tématu.

--subscription

Název nebo ID předplatného. Výchozí předplatné můžete nakonfigurovat pomocí az account set -s NAME_OR_ID.

--verbose

Zvyšte úroveň podrobností protokolování. K úplnému ladění protokolů použijte příkaz --debug.

az automation runbook wait

Experimentální

Příkazová skupina Automation Runbook je experimentální a probíhá vývoj. Referenční úrovně a úrovně podpory: https://aka.ms/CLI_refstatus

Umístěte rozhraní příkazového řádku do stavu čekání, dokud nebude splněna podmínka runbooku automation.

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

Příklady

Pozastavte provádění dalšího řádku skriptu rozhraní příkazového řádku, dokud se runbook automation úspěšně nevytvořil.

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

Volitelné parametry

--automation-account-name

Název účtu Automation.

--created

Počkejte na vytvoření s 'provisioningState' v 'Succeeded'.

Default value: False
--custom

Počkejte, až podmínka splňuje vlastní dotaz JMESPath. Například provisioningState!='InProgress', instanceView.statuses[?code=='PowerState/running'].

--deleted

Počkejte na odstranění.

Default value: False
--exists

Počkejte, až prostředek existuje.

Default value: False
--ids

Jedno nebo více ID prostředků (oddělených mezerami) Mělo by se jednat o úplné ID prostředku obsahující všechny informace o argumentech ID prostředku. Měli byste zadat argumenty --ids nebo jiné argumenty ID prostředku.

--interval

Interval dotazování v sekundách

Default value: 30
--name --runbook-name -n

Název runbooku.

--resource-group -g

Název skupiny prostředků. Výchozí skupinu můžete nakonfigurovat pomocí az configure --defaults group=<name>.

--subscription

Název nebo ID předplatného. Výchozí předplatné můžete nakonfigurovat pomocí az account set -s NAME_OR_ID.

--timeout

Maximální čekání v sekundách.

Default value: 3600
--updated

Počkejte, dokud se neaktualizuje stav zřizování ve stavu Úspěch.

Default value: False
Globální parametry
--debug

Zvyšte úroveň podrobností protokolování, aby se zobrazily všechny protokoly ladění.

--help -h

Zobrazte tuto zprávu nápovědy a ukončete ji.

--only-show-errors

Zobrazují se pouze chyby, potlačení upozornění.

--output -o

Výstupní formát

Přípustné hodnoty: json, jsonc, none, table, tsv, yaml, yamlc
Default value: json
--query

Řetězec dotazu JMESPath Další http://jmespath.org/ informace a příklady najdete v tématu.

--subscription

Název nebo ID předplatného. Výchozí předplatné můžete nakonfigurovat pomocí az account set -s NAME_OR_ID.

--verbose

Zvyšte úroveň podrobností protokolování. K úplnému ladění protokolů použijte příkaz --debug.