Dela via

az automation runbook

  • Experimentell
  • Referens

Kommentar

Den här referensen är en del av automationstillägget för Azure CLI (version 2.55.0 eller senare). Tillägget installeras automatiskt första gången du kör ett az automation runbook-kommando . Läs mer om tillägg.

Den här kommandogruppen är experimentell och under utveckling. Referens- och supportnivåer: https://aka.ms/CLI_refstatus

Automation Runbook.

Kommandon

Name Description Typ Status
az automation runbook create

Skapa runbooken som identifieras med runbook-namnet.

 Anknytning Experimentell
az automation runbook delete

Ta bort runbooken efter namn.

 Anknytning Experimentell
az automation runbook list

Hämta en lista över runbooks.

 Anknytning Experimentell
az automation runbook publish

Publicera runbook-utkast.

 Anknytning Experimentell
az automation runbook replace-content

Ersätt innehållet i runbooken.

 Anknytning Experimentell
az automation runbook revert-to-published

Återställ runbook-innehållet till det senast kända publicerade tillståndet.

 Anknytning Experimentell
az automation runbook show

Hämta runbooken som identifieras med runbook-namnet.

 Anknytning Experimentell
az automation runbook start

Starta runbooken.

 Anknytning Experimentell
az automation runbook update

Uppdatera runbooken som identifieras med runbook-namnet.

 Anknytning Experimentell
az automation runbook wait

Placera CLI i vänteläge tills ett villkor för Automation Runbook uppfylls.

 Anknytning Experimentell

az automation runbook create

Experimentell

Kommandogruppen Automation Runbook är experimentell och under utveckling. Referens- och supportnivåer: https://aka.ms/CLI_refstatus

Skapa runbooken som identifieras med runbook-namnet.

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]

Exempel

Skapa en runbook

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

Obligatoriska parametrar

--automation-account-name

Namnet på automationskontot.

--name --runbook-name -n

Runbook-namnet.

--resource-group -g

Namnet på resursgruppen. Du kan konfigurera standardgruppen med .az configure --defaults group=<name>

--type

Typ av runbook.

accepterade värden: Graph, GraphPowerShell, GraphPowerShellWorkflow, PowerShell, PowerShellWorkflow, Python2, Python3, Script

Valfria parametrar

--description

Beskrivning av runbooken.

--location -l

Plats. Värden från: az account list-locations. Du kan konfigurera standardplatsen med hjälp av az configure --defaults location=<location>.

--log-activity-trace

Spårningsalternativ på aktivitetsnivå för runbooken.

--log-progress

Förloppsloggalternativet för runbooken.

accepterade värden: false, true
--log-verbose

Utförligt loggalternativ för runbooken.

accepterade värden: false, true
--tags

Blankstegsavgränsade taggar: key[=value] [key[=value] ...]. Använd "" för att rensa befintliga taggar.

Globala parametrar
--debug

Öka loggningsverositeten för att visa alla felsökningsloggar.

--help -h

Visa det här hjälpmeddelandet och avsluta.

--only-show-errors

Visa bara fel och ignorera varningar.

--output -o

Utdataformat.

accepterade värden: json, jsonc, none, table, tsv, yaml, yamlc
standardvärde: json
--query

JMESPath-frågesträng. Mer http://jmespath.org/ information och exempel finns i.

--subscription

Namn eller ID för prenumerationen. Du kan konfigurera standardprenumerationen med .az account set -s NAME_OR_ID

--verbose

Öka loggningsverbositeten. Använd --debug för fullständiga felsökningsloggar.

az automation runbook delete

Experimentell

Kommandogruppen Automation Runbook är experimentell och under utveckling. Referens- och supportnivåer: https://aka.ms/CLI_refstatus

Ta bort runbooken efter namn.

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

Exempel

Ta bort en runbook

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

Valfria parametrar

--automation-account-name

Namnet på automationskontot.

--ids

Ett eller flera resurs-ID:t (utrymmesavgränsade). Det bör vara ett fullständigt resurs-ID som innehåller all information om argumenten "Resurs-ID". Du bör ange antingen --id eller andra "Resurs-ID"-argument.

--name --runbook-name -n

Runbook-namnet.

--resource-group -g

Namnet på resursgruppen. Du kan konfigurera standardgruppen med .az configure --defaults group=<name>

--subscription

Namn eller ID för prenumerationen. Du kan konfigurera standardprenumerationen med .az account set -s NAME_OR_ID

--yes -y

Fråga inte efter bekräftelse.

standardvärde: False
Globala parametrar
--debug

Öka loggningsverositeten för att visa alla felsökningsloggar.

--help -h

Visa det här hjälpmeddelandet och avsluta.

--only-show-errors

Visa bara fel och ignorera varningar.

--output -o

Utdataformat.

accepterade värden: json, jsonc, none, table, tsv, yaml, yamlc
standardvärde: json
--query

JMESPath-frågesträng. Mer http://jmespath.org/ information och exempel finns i.

--subscription

Namn eller ID för prenumerationen. Du kan konfigurera standardprenumerationen med .az account set -s NAME_OR_ID

--verbose

Öka loggningsverbositeten. Använd --debug för fullständiga felsökningsloggar.

az automation runbook list

Experimentell

Kommandogruppen Automation Runbook är experimentell och under utveckling. Referens- och supportnivåer: https://aka.ms/CLI_refstatus

Hämta en lista över runbooks.

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

Exempel

Visa en lista över runbooks efter automationskonto

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

Obligatoriska parametrar

--automation-account-name

Namnet på automationskontot.

--resource-group -g

Namnet på resursgruppen. Du kan konfigurera standardgruppen med .az configure --defaults group=<name>

Globala parametrar
--debug

Öka loggningsverositeten för att visa alla felsökningsloggar.

--help -h

Visa det här hjälpmeddelandet och avsluta.

--only-show-errors

Visa bara fel och ignorera varningar.

--output -o

Utdataformat.

accepterade värden: json, jsonc, none, table, tsv, yaml, yamlc
standardvärde: json
--query

JMESPath-frågesträng. Mer http://jmespath.org/ information och exempel finns i.

--subscription

Namn eller ID för prenumerationen. Du kan konfigurera standardprenumerationen med .az account set -s NAME_OR_ID

--verbose

Öka loggningsverbositeten. Använd --debug för fullständiga felsökningsloggar.

az automation runbook publish

Experimentell

Kommandogruppen Automation Runbook är experimentell och under utveckling. Referens- och supportnivåer: https://aka.ms/CLI_refstatus

Publicera runbook-utkast.

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

Exempel

Publicera runbook-utkast

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

Valfria parametrar

--automation-account-name

Namnet på automationskontot.

--ids

Ett eller flera resurs-ID:t (utrymmesavgränsade). Det bör vara ett fullständigt resurs-ID som innehåller all information om argumenten "Resurs-ID". Du bör ange antingen --id eller andra "Resurs-ID"-argument.

--name --runbook-name -n

Parametrarna som angetts för publiceringen av runbook-åtgärden.

--no-wait

Vänta inte tills den långvariga åtgärden har slutförts.

standardvärde: False
--resource-group -g

Namnet på resursgruppen. Du kan konfigurera standardgruppen med .az configure --defaults group=<name>

--subscription

Namn eller ID för prenumerationen. Du kan konfigurera standardprenumerationen med .az account set -s NAME_OR_ID

Globala parametrar
--debug

Öka loggningsverositeten för att visa alla felsökningsloggar.

--help -h

Visa det här hjälpmeddelandet och avsluta.

--only-show-errors

Visa bara fel och ignorera varningar.

--output -o

Utdataformat.

accepterade värden: json, jsonc, none, table, tsv, yaml, yamlc
standardvärde: json
--query

JMESPath-frågesträng. Mer http://jmespath.org/ information och exempel finns i.

--subscription

Namn eller ID för prenumerationen. Du kan konfigurera standardprenumerationen med .az account set -s NAME_OR_ID

--verbose

Öka loggningsverbositeten. Använd --debug för fullständiga felsökningsloggar.

az automation runbook replace-content

Experimentell

Kommandogruppen Automation Runbook är experimentell och under utveckling. Referens- och supportnivåer: https://aka.ms/CLI_refstatus

Ersätt innehållet i runbooken.

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

Exempel

Ersätt innehållet i runbooken

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

Obligatoriska parametrar

--content

Runbook-innehållet.

Valfria parametrar

--automation-account-name

Namnet på automationskontot.

--ids

Ett eller flera resurs-ID:t (utrymmesavgränsade). Det bör vara ett fullständigt resurs-ID som innehåller all information om argumenten "Resurs-ID". Du bör ange antingen --id eller andra "Resurs-ID"-argument.

--name --runbook-name -n

Runbook-namnet.

--no-wait

Vänta inte tills den långvariga åtgärden har slutförts.

standardvärde: False
--resource-group -g

Namnet på resursgruppen. Du kan konfigurera standardgruppen med .az configure --defaults group=<name>

--subscription

Namn eller ID för prenumerationen. Du kan konfigurera standardprenumerationen med .az account set -s NAME_OR_ID

Globala parametrar
--debug

Öka loggningsverositeten för att visa alla felsökningsloggar.

--help -h

Visa det här hjälpmeddelandet och avsluta.

--only-show-errors

Visa bara fel och ignorera varningar.

--output -o

Utdataformat.

accepterade värden: json, jsonc, none, table, tsv, yaml, yamlc
standardvärde: json
--query

JMESPath-frågesträng. Mer http://jmespath.org/ information och exempel finns i.

--subscription

Namn eller ID för prenumerationen. Du kan konfigurera standardprenumerationen med .az account set -s NAME_OR_ID

--verbose

Öka loggningsverbositeten. Använd --debug för fullständiga felsökningsloggar.

az automation runbook revert-to-published

Experimentell

Kommandogruppen Automation Runbook är experimentell och under utveckling. Referens- och supportnivåer: https://aka.ms/CLI_refstatus

Återställ runbook-innehållet till det senast kända publicerade tillståndet.

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

Exempel

Ersätt innehållet i runbooken

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

Valfria parametrar

--automation-account-name

Namnet på automationskontot.

--ids

Ett eller flera resurs-ID:t (utrymmesavgränsade). Det bör vara ett fullständigt resurs-ID som innehåller all information om argumenten "Resurs-ID". Du bör ange antingen --id eller andra "Resurs-ID"-argument.

--name --runbook-name -n

Runbook-namnet.

--resource-group -g

Namnet på resursgruppen. Du kan konfigurera standardgruppen med .az configure --defaults group=<name>

--subscription

Namn eller ID för prenumerationen. Du kan konfigurera standardprenumerationen med .az account set -s NAME_OR_ID

Globala parametrar
--debug

Öka loggningsverositeten för att visa alla felsökningsloggar.

--help -h

Visa det här hjälpmeddelandet och avsluta.

--only-show-errors

Visa bara fel och ignorera varningar.

--output -o

Utdataformat.

accepterade värden: json, jsonc, none, table, tsv, yaml, yamlc
standardvärde: json
--query

JMESPath-frågesträng. Mer http://jmespath.org/ information och exempel finns i.

--subscription

Namn eller ID för prenumerationen. Du kan konfigurera standardprenumerationen med .az account set -s NAME_OR_ID

--verbose

Öka loggningsverbositeten. Använd --debug för fullständiga felsökningsloggar.

az automation runbook show

Experimentell

Kommandogruppen Automation Runbook är experimentell och under utveckling. Referens- och supportnivåer: https://aka.ms/CLI_refstatus

Hämta runbooken som identifieras med runbook-namnet.

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

Exempel

Hämta runbook

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

Valfria parametrar

--automation-account-name

Namnet på automationskontot.

--ids

Ett eller flera resurs-ID:t (utrymmesavgränsade). Det bör vara ett fullständigt resurs-ID som innehåller all information om argumenten "Resurs-ID". Du bör ange antingen --id eller andra "Resurs-ID"-argument.

--name --runbook-name -n

Runbook-namnet.

--resource-group -g

Namnet på resursgruppen. Du kan konfigurera standardgruppen med .az configure --defaults group=<name>

--subscription

Namn eller ID för prenumerationen. Du kan konfigurera standardprenumerationen med .az account set -s NAME_OR_ID

Globala parametrar
--debug

Öka loggningsverositeten för att visa alla felsökningsloggar.

--help -h

Visa det här hjälpmeddelandet och avsluta.

--only-show-errors

Visa bara fel och ignorera varningar.

--output -o

Utdataformat.

accepterade värden: json, jsonc, none, table, tsv, yaml, yamlc
standardvärde: json
--query

JMESPath-frågesträng. Mer http://jmespath.org/ information och exempel finns i.

--subscription

Namn eller ID för prenumerationen. Du kan konfigurera standardprenumerationen med .az account set -s NAME_OR_ID

--verbose

Öka loggningsverbositeten. Använd --debug för fullständiga felsökningsloggar.

az automation runbook start

Experimentell

Kommandogruppen Automation Runbook är experimentell och under utveckling. Referens- och supportnivåer: https://aka.ms/CLI_refstatus

Starta runbooken.

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

Exempel

Starta runbook

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

Valfria parametrar

--automation-account-name

Namnet på automationskontot.

--ids

Ett eller flera resurs-ID:t (utrymmesavgränsade). Det bör vara ett fullständigt resurs-ID som innehåller all information om argumenten "Resurs-ID". Du bör ange antingen --id eller andra "Resurs-ID"-argument.

--name --runbook-name -n

Runbook-namnet.

--parameters

Parametrar för jobbet. Förvänta dig värde: KEY1=VALUE1 KEY2=VALUE2 ...

--resource-group -g

Namnet på resursgruppen. Du kan konfigurera standardgruppen med .az configure --defaults group=<name>

--run-on

RunOn som anger gruppnamnet där jobbet ska köras.

--subscription

Namn eller ID för prenumerationen. Du kan konfigurera standardprenumerationen med .az account set -s NAME_OR_ID

Globala parametrar
--debug

Öka loggningsverositeten för att visa alla felsökningsloggar.

--help -h

Visa det här hjälpmeddelandet och avsluta.

--only-show-errors

Visa bara fel och ignorera varningar.

--output -o

Utdataformat.

accepterade värden: json, jsonc, none, table, tsv, yaml, yamlc
standardvärde: json
--query

JMESPath-frågesträng. Mer http://jmespath.org/ information och exempel finns i.

--subscription

Namn eller ID för prenumerationen. Du kan konfigurera standardprenumerationen med .az account set -s NAME_OR_ID

--verbose

Öka loggningsverbositeten. Använd --debug för fullständiga felsökningsloggar.

az automation runbook update

Experimentell

Kommandogruppen Automation Runbook är experimentell och under utveckling. Referens- och supportnivåer: https://aka.ms/CLI_refstatus

Uppdatera runbooken som identifieras med runbook-namnet.

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]

Exempel

Uppdatera en 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"

Valfria parametrar

--automation-account-name

Namnet på automationskontot.

--description

Beskrivning av runbooken.

--ids

Ett eller flera resurs-ID:t (utrymmesavgränsade). Det bör vara ett fullständigt resurs-ID som innehåller all information om argumenten "Resurs-ID". Du bör ange antingen --id eller andra "Resurs-ID"-argument.

--log-activity-trace

Spårningsalternativ på aktivitetsnivå för runbooken.

--log-progress

Förloppsloggalternativet för runbooken.

accepterade värden: false, true
--log-verbose

Utförligt loggalternativ för runbooken.

accepterade värden: false, true
--name --runbook-name -n

Runbook-namnet.

--resource-group -g

Namnet på resursgruppen. Du kan konfigurera standardgruppen med .az configure --defaults group=<name>

--subscription

Namn eller ID för prenumerationen. Du kan konfigurera standardprenumerationen med .az account set -s NAME_OR_ID

--tags

Blankstegsavgränsade taggar: key[=value] [key[=value] ...]. Använd "" för att rensa befintliga taggar.

Globala parametrar
--debug

Öka loggningsverositeten för att visa alla felsökningsloggar.

--help -h

Visa det här hjälpmeddelandet och avsluta.

--only-show-errors

Visa bara fel och ignorera varningar.

--output -o

Utdataformat.

accepterade värden: json, jsonc, none, table, tsv, yaml, yamlc
standardvärde: json
--query

JMESPath-frågesträng. Mer http://jmespath.org/ information och exempel finns i.

--subscription

Namn eller ID för prenumerationen. Du kan konfigurera standardprenumerationen med .az account set -s NAME_OR_ID

--verbose

Öka loggningsverbositeten. Använd --debug för fullständiga felsökningsloggar.

az automation runbook wait

Experimentell

Kommandogruppen Automation Runbook är experimentell och under utveckling. Referens- och supportnivåer: https://aka.ms/CLI_refstatus

Placera CLI i vänteläge tills ett villkor för Automation Runbook uppfylls.

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

Exempel

Pausa körningen av nästa rad i CLI-skriptet tills automation-runbooken har skapats.

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

Valfria parametrar

--automation-account-name

Namnet på automationskontot.

--created

Vänta tills du har skapat med "provisioningState" på "Lyckades".

standardvärde: False
--custom

Vänta tills villkoret uppfyller en anpassad JMESPath-fråga. T.ex. provisioningState!='InProgress', instanceView.statuses[?code=='PowerState/running'].

--deleted

Vänta tills den har tagits bort.

standardvärde: False
--exists

Vänta tills resursen finns.

standardvärde: False
--ids

Ett eller flera resurs-ID:t (utrymmesavgränsade). Det bör vara ett fullständigt resurs-ID som innehåller all information om argumenten "Resurs-ID". Du bör ange antingen --id eller andra "Resurs-ID"-argument.

--interval

Avsökningsintervall i sekunder.

standardvärde: 30
--name --runbook-name -n

Runbook-namnet.

--resource-group -g

Namnet på resursgruppen. Du kan konfigurera standardgruppen med .az configure --defaults group=<name>

--subscription

Namn eller ID för prenumerationen. Du kan konfigurera standardprenumerationen med .az account set -s NAME_OR_ID

--timeout

Maximal väntetid i sekunder.

standardvärde: 3600
--updated

Vänta tills det har uppdaterats med provisioningState på Lyckades.

standardvärde: False
Globala parametrar
--debug

Öka loggningsverositeten för att visa alla felsökningsloggar.

--help -h

Visa det här hjälpmeddelandet och avsluta.

--only-show-errors

Visa bara fel och ignorera varningar.

--output -o

Utdataformat.

accepterade värden: json, jsonc, none, table, tsv, yaml, yamlc
standardvärde: json
--query

JMESPath-frågesträng. Mer http://jmespath.org/ information och exempel finns i.

--subscription

Namn eller ID för prenumerationen. Du kan konfigurera standardprenumerationen med .az account set -s NAME_OR_ID

--verbose

Öka loggningsverbositeten. Använd --debug för fullständiga felsökningsloggar.