az automation runbook

  • Kísérleti
  • Referencia

Feljegyzés

Ez a hivatkozás az Azure CLI automatizálási bővítményének része (2.55.0-s vagy újabb verzió). A bővítmény automatikusan telepíti az az automation runbook parancs első futtatásakor. További információ a bővítményekről.

Ez a parancscsoport kísérleti és fejlesztés alatt áll. Referencia- és támogatási szintek: https://aka.ms/CLI_refstatus

Automation Runbook.

Parancsok

Name Description Típus Állapot
az automation runbook create

Hozza létre a runbook nevével azonosított runbookot.

 Mellék Kísérleti
az automation runbook delete

Törölje a runbookot név szerint.

 Mellék Kísérleti
az automation runbook list

Runbookok listájának lekérése.

 Mellék Kísérleti
az automation runbook publish

Runbook-vázlat közzététele.

 Mellék Kísérleti
az automation runbook replace-content

Cserélje le a runbook tartalmát.

 Mellék Kísérleti
az automation runbook revert-to-published

Állítsa vissza a runbook tartalmát a legutóbb ismert közzétett állapotra.

 Mellék Kísérleti
az automation runbook show

Kérje le a runbook nevével azonosított runbookot.

 Mellék Kísérleti
az automation runbook start

Indítsa el a runbookot.

 Mellék Kísérleti
az automation runbook update

Frissítse a runbook nevével azonosított runbookot.

 Mellék Kísérleti
az automation runbook wait

Helyezze a parancssori felületet várakozási állapotba, amíg az automatizálási runbook egy állapota meg nem teljesül.

 Mellék Kísérleti

az automation runbook create

Kísérleti

Az "automation runbook" parancscsoport kísérleti és fejlesztés alatt áll. Referencia- és támogatási szintek: https://aka.ms/CLI_refstatus

Hozza létre a runbook nevével azonosított runbookot.

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éldák

Runbook létrehozása

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

Kötelező paraméterek

--automation-account-name

Az automation-fiók neve.

--name --runbook-name -n

A runbook neve.

--resource-group -g

Az erőforráscsoport neve. Az alapértelmezett csoportot konfigurálhatja a következővel az configure --defaults group=<name>: .

--type

A runbook típusa.

elfogadott értékek: Graph, GraphPowerShell, GraphPowerShellWorkflow, PowerShell, PowerShellWorkflow, Python2, Python3, Script

Opcionális paraméterek

--description

A runbook leírása.

--location -l

Tartózkodási hely beállításnál. Értékek: az account list-locations. Az alapértelmezett helyet a következővel az configure --defaults location=<location>konfigurálhatja: .

--log-activity-trace

A runbook tevékenységszintű nyomkövetési beállításai.

--log-progress

A runbook folyamatnapló-beállítása.

elfogadott értékek: false, true
--log-verbose

A runbook részletes naplóbeállítása.

elfogadott értékek: false, true
--tags

Szóközzel elválasztott címkék: key[=value] [key[=value] ...]. Meglévő címkék törlése a "" használatával.

Globális paraméterek
--debug

Növelje a naplózás részletességét az összes hibakeresési napló megjelenítéséhez.

--help -h

Jelenítse meg ezt a súgóüzenetet, és lépjen ki.

--only-show-errors

Csak a hibák megjelenítése, a figyelmeztetések mellőzése.

--output -o

Kimeneti formátum.

elfogadott értékek: json, jsonc, none, table, tsv, yaml, yamlc
alapértelmezett érték: json
--query

JMESPath lekérdezési sztring. További információkért és példákért lásd http://jmespath.org/ .

--subscription

Az előfizetés neve vagy azonosítója. Az alapértelmezett előfizetést konfigurálhatja a következővel az account set -s NAME_OR_ID: .

--verbose

A naplózás részletességének növelése. Használja a --debug parancsot a teljes hibakeresési naplókhoz.

az automation runbook delete

Kísérleti

Az "automation runbook" parancscsoport kísérleti és fejlesztés alatt áll. Referencia- és támogatási szintek: https://aka.ms/CLI_refstatus

Törölje a runbookot név szerint.

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

Példák

Runbook törlése

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

Opcionális paraméterek

--automation-account-name

Az automation-fiók neve.

--ids

Egy vagy több erőforrásazonosító (szóközzel tagolt). Teljes erőforrás-azonosítónak kell lennie, amely tartalmazza az "Erőforrás-azonosító" argumentumok összes információját. Adjon meg --ids vagy más "Erőforrás-azonosító" argumentumot.

--name --runbook-name -n

A runbook neve.

--resource-group -g

Az erőforráscsoport neve. Az alapértelmezett csoportot konfigurálhatja a következővel az configure --defaults group=<name>: .

--subscription

Az előfizetés neve vagy azonosítója. Az alapértelmezett előfizetést konfigurálhatja a következővel az account set -s NAME_OR_ID: .

--yes -y

Ne kérje a megerősítést.

alapértelmezett érték: False
Globális paraméterek
--debug

Növelje a naplózás részletességét az összes hibakeresési napló megjelenítéséhez.

--help -h

Jelenítse meg ezt a súgóüzenetet, és lépjen ki.

--only-show-errors

Csak a hibák megjelenítése, a figyelmeztetések mellőzése.

--output -o

Kimeneti formátum.

elfogadott értékek: json, jsonc, none, table, tsv, yaml, yamlc
alapértelmezett érték: json
--query

JMESPath lekérdezési sztring. További információkért és példákért lásd http://jmespath.org/ .

--subscription

Az előfizetés neve vagy azonosítója. Az alapértelmezett előfizetést konfigurálhatja a következővel az account set -s NAME_OR_ID: .

--verbose

A naplózás részletességének növelése. Használja a --debug parancsot a teljes hibakeresési naplókhoz.

az automation runbook list

Kísérleti

Az "automation runbook" parancscsoport kísérleti és fejlesztés alatt áll. Referencia- és támogatási szintek: https://aka.ms/CLI_refstatus

Runbookok listájának lekérése.

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

Példák

Runbookok listázása automation-fiók szerint

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

Kötelező paraméterek

--automation-account-name

Az automation-fiók neve.

--resource-group -g

Az erőforráscsoport neve. Az alapértelmezett csoportot konfigurálhatja a következővel az configure --defaults group=<name>: .

Globális paraméterek
--debug

Növelje a naplózás részletességét az összes hibakeresési napló megjelenítéséhez.

--help -h

Jelenítse meg ezt a súgóüzenetet, és lépjen ki.

--only-show-errors

Csak a hibák megjelenítése, a figyelmeztetések mellőzése.

--output -o

Kimeneti formátum.

elfogadott értékek: json, jsonc, none, table, tsv, yaml, yamlc
alapértelmezett érték: json
--query

JMESPath lekérdezési sztring. További információkért és példákért lásd http://jmespath.org/ .

--subscription

Az előfizetés neve vagy azonosítója. Az alapértelmezett előfizetést konfigurálhatja a következővel az account set -s NAME_OR_ID: .

--verbose

A naplózás részletességének növelése. Használja a --debug parancsot a teljes hibakeresési naplókhoz.

az automation runbook publish

Kísérleti

Az "automation runbook" parancscsoport kísérleti és fejlesztés alatt áll. Referencia- és támogatási szintek: https://aka.ms/CLI_refstatus

Runbook-vázlat közzététele.

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

Példák

Runbook-piszkozat közzététele

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

Opcionális paraméterek

--automation-account-name

Az automation-fiók neve.

--ids

Egy vagy több erőforrásazonosító (szóközzel tagolt). Teljes erőforrás-azonosítónak kell lennie, amely tartalmazza az "Erőforrás-azonosító" argumentumok összes információját. Adjon meg --ids vagy más "Erőforrás-azonosító" argumentumot.

--name --runbook-name -n

A runbook-közzétételi művelethez megadott paraméterek.

--no-wait

Ne várja meg, amíg a hosszú ideig futó művelet befejeződik.

alapértelmezett érték: False
--resource-group -g

Az erőforráscsoport neve. Az alapértelmezett csoportot konfigurálhatja a következővel az configure --defaults group=<name>: .

--subscription

Az előfizetés neve vagy azonosítója. Az alapértelmezett előfizetést konfigurálhatja a következővel az account set -s NAME_OR_ID: .

Globális paraméterek
--debug

Növelje a naplózás részletességét az összes hibakeresési napló megjelenítéséhez.

--help -h

Jelenítse meg ezt a súgóüzenetet, és lépjen ki.

--only-show-errors

Csak a hibák megjelenítése, a figyelmeztetések mellőzése.

--output -o

Kimeneti formátum.

elfogadott értékek: json, jsonc, none, table, tsv, yaml, yamlc
alapértelmezett érték: json
--query

JMESPath lekérdezési sztring. További információkért és példákért lásd http://jmespath.org/ .

--subscription

Az előfizetés neve vagy azonosítója. Az alapértelmezett előfizetést konfigurálhatja a következővel az account set -s NAME_OR_ID: .

--verbose

A naplózás részletességének növelése. Használja a --debug parancsot a teljes hibakeresési naplókhoz.

az automation runbook replace-content

Kísérleti

Az "automation runbook" parancscsoport kísérleti és fejlesztés alatt áll. Referencia- és támogatási szintek: https://aka.ms/CLI_refstatus

Cserélje le a runbook tartalmát.

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

Példák

A runbook tartalmának cseréje

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

Kötelező paraméterek

--content

A runbook tartalma.

Opcionális paraméterek

--automation-account-name

Az automation-fiók neve.

--ids

Egy vagy több erőforrásazonosító (szóközzel tagolt). Teljes erőforrás-azonosítónak kell lennie, amely tartalmazza az "Erőforrás-azonosító" argumentumok összes információját. Adjon meg --ids vagy más "Erőforrás-azonosító" argumentumot.

--name --runbook-name -n

A runbook neve.

--no-wait

Ne várja meg, amíg a hosszú ideig futó művelet befejeződik.

alapértelmezett érték: False
--resource-group -g

Az erőforráscsoport neve. Az alapértelmezett csoportot konfigurálhatja a következővel az configure --defaults group=<name>: .

--subscription

Az előfizetés neve vagy azonosítója. Az alapértelmezett előfizetést konfigurálhatja a következővel az account set -s NAME_OR_ID: .

Globális paraméterek
--debug

Növelje a naplózás részletességét az összes hibakeresési napló megjelenítéséhez.

--help -h

Jelenítse meg ezt a súgóüzenetet, és lépjen ki.

--only-show-errors

Csak a hibák megjelenítése, a figyelmeztetések mellőzése.

--output -o

Kimeneti formátum.

elfogadott értékek: json, jsonc, none, table, tsv, yaml, yamlc
alapértelmezett érték: json
--query

JMESPath lekérdezési sztring. További információkért és példákért lásd http://jmespath.org/ .

--subscription

Az előfizetés neve vagy azonosítója. Az alapértelmezett előfizetést konfigurálhatja a következővel az account set -s NAME_OR_ID: .

--verbose

A naplózás részletességének növelése. Használja a --debug parancsot a teljes hibakeresési naplókhoz.

az automation runbook revert-to-published

Kísérleti

Az "automation runbook" parancscsoport kísérleti és fejlesztés alatt áll. Referencia- és támogatási szintek: https://aka.ms/CLI_refstatus

Állítsa vissza a runbook tartalmát a legutóbb ismert közzétett állapotra.

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

Példák

A runbook tartalmának cseréje

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

Opcionális paraméterek

--automation-account-name

Az automation-fiók neve.

--ids

Egy vagy több erőforrásazonosító (szóközzel tagolt). Teljes erőforrás-azonosítónak kell lennie, amely tartalmazza az "Erőforrás-azonosító" argumentumok összes információját. Adjon meg --ids vagy más "Erőforrás-azonosító" argumentumot.

--name --runbook-name -n

A runbook neve.

--resource-group -g

Az erőforráscsoport neve. Az alapértelmezett csoportot konfigurálhatja a következővel az configure --defaults group=<name>: .

--subscription

Az előfizetés neve vagy azonosítója. Az alapértelmezett előfizetést konfigurálhatja a következővel az account set -s NAME_OR_ID: .

Globális paraméterek
--debug

Növelje a naplózás részletességét az összes hibakeresési napló megjelenítéséhez.

--help -h

Jelenítse meg ezt a súgóüzenetet, és lépjen ki.

--only-show-errors

Csak a hibák megjelenítése, a figyelmeztetések mellőzése.

--output -o

Kimeneti formátum.

elfogadott értékek: json, jsonc, none, table, tsv, yaml, yamlc
alapértelmezett érték: json
--query

JMESPath lekérdezési sztring. További információkért és példákért lásd http://jmespath.org/ .

--subscription

Az előfizetés neve vagy azonosítója. Az alapértelmezett előfizetést konfigurálhatja a következővel az account set -s NAME_OR_ID: .

--verbose

A naplózás részletességének növelése. Használja a --debug parancsot a teljes hibakeresési naplókhoz.

az automation runbook show

Kísérleti

Az "automation runbook" parancscsoport kísérleti és fejlesztés alatt áll. Referencia- és támogatási szintek: https://aka.ms/CLI_refstatus

Kérje le a runbook nevével azonosított runbookot.

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

Példák

Runbook lekérése

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

Opcionális paraméterek

--automation-account-name

Az automation-fiók neve.

--ids

Egy vagy több erőforrásazonosító (szóközzel tagolt). Teljes erőforrás-azonosítónak kell lennie, amely tartalmazza az "Erőforrás-azonosító" argumentumok összes információját. Adjon meg --ids vagy más "Erőforrás-azonosító" argumentumot.

--name --runbook-name -n

A runbook neve.

--resource-group -g

Az erőforráscsoport neve. Az alapértelmezett csoportot konfigurálhatja a következővel az configure --defaults group=<name>: .

--subscription

Az előfizetés neve vagy azonosítója. Az alapértelmezett előfizetést konfigurálhatja a következővel az account set -s NAME_OR_ID: .

Globális paraméterek
--debug

Növelje a naplózás részletességét az összes hibakeresési napló megjelenítéséhez.

--help -h

Jelenítse meg ezt a súgóüzenetet, és lépjen ki.

--only-show-errors

Csak a hibák megjelenítése, a figyelmeztetések mellőzése.

--output -o

Kimeneti formátum.

elfogadott értékek: json, jsonc, none, table, tsv, yaml, yamlc
alapértelmezett érték: json
--query

JMESPath lekérdezési sztring. További információkért és példákért lásd http://jmespath.org/ .

--subscription

Az előfizetés neve vagy azonosítója. Az alapértelmezett előfizetést konfigurálhatja a következővel az account set -s NAME_OR_ID: .

--verbose

A naplózás részletességének növelése. Használja a --debug parancsot a teljes hibakeresési naplókhoz.

az automation runbook start

Kísérleti

Az "automation runbook" parancscsoport kísérleti és fejlesztés alatt áll. Referencia- és támogatási szintek: https://aka.ms/CLI_refstatus

Indítsa el a runbookot.

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

Példák

A runbook indítása

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

Opcionális paraméterek

--automation-account-name

Az automation-fiók neve.

--ids

Egy vagy több erőforrásazonosító (szóközzel tagolt). Teljes erőforrás-azonosítónak kell lennie, amely tartalmazza az "Erőforrás-azonosító" argumentumok összes információját. Adjon meg --ids vagy más "Erőforrás-azonosító" argumentumot.

--name --runbook-name -n

A runbook neve.

--parameters

A feladat paraméterei. Várható érték: KEY1=VALUE1 KEY2=VALUE2 ...

--resource-group -g

Az erőforráscsoport neve. Az alapértelmezett csoportot konfigurálhatja a következővel az configure --defaults group=<name>: .

--run-on

RunOn, amely megadja a csoport nevét, ahol a feladatot végre kell hajtani.

--subscription

Az előfizetés neve vagy azonosítója. Az alapértelmezett előfizetést konfigurálhatja a következővel az account set -s NAME_OR_ID: .

Globális paraméterek
--debug

Növelje a naplózás részletességét az összes hibakeresési napló megjelenítéséhez.

--help -h

Jelenítse meg ezt a súgóüzenetet, és lépjen ki.

--only-show-errors

Csak a hibák megjelenítése, a figyelmeztetések mellőzése.

--output -o

Kimeneti formátum.

elfogadott értékek: json, jsonc, none, table, tsv, yaml, yamlc
alapértelmezett érték: json
--query

JMESPath lekérdezési sztring. További információkért és példákért lásd http://jmespath.org/ .

--subscription

Az előfizetés neve vagy azonosítója. Az alapértelmezett előfizetést konfigurálhatja a következővel az account set -s NAME_OR_ID: .

--verbose

A naplózás részletességének növelése. Használja a --debug parancsot a teljes hibakeresési naplókhoz.

az automation runbook update

Kísérleti

Az "automation runbook" parancscsoport kísérleti és fejlesztés alatt áll. Referencia- és támogatási szintek: https://aka.ms/CLI_refstatus

Frissítse a runbook nevével azonosított runbookot.

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éldák

Runbook frissítése

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"

Opcionális paraméterek

--automation-account-name

Az automation-fiók neve.

--description

A runbook leírása.

--ids

Egy vagy több erőforrásazonosító (szóközzel tagolt). Teljes erőforrás-azonosítónak kell lennie, amely tartalmazza az "Erőforrás-azonosító" argumentumok összes információját. Adjon meg --ids vagy más "Erőforrás-azonosító" argumentumot.

--log-activity-trace

A runbook tevékenységszintű nyomkövetési beállításai.

--log-progress

A runbook folyamatnapló-beállítása.

elfogadott értékek: false, true
--log-verbose

A runbook részletes naplóbeállítása.

elfogadott értékek: false, true
--name --runbook-name -n

A runbook neve.

--resource-group -g

Az erőforráscsoport neve. Az alapértelmezett csoportot konfigurálhatja a következővel az configure --defaults group=<name>: .

--subscription

Az előfizetés neve vagy azonosítója. Az alapértelmezett előfizetést konfigurálhatja a következővel az account set -s NAME_OR_ID: .

--tags

Szóközzel elválasztott címkék: key[=value] [key[=value] ...]. Meglévő címkék törlése a "" használatával.

Globális paraméterek
--debug

Növelje a naplózás részletességét az összes hibakeresési napló megjelenítéséhez.

--help -h

Jelenítse meg ezt a súgóüzenetet, és lépjen ki.

--only-show-errors

Csak a hibák megjelenítése, a figyelmeztetések mellőzése.

--output -o

Kimeneti formátum.

elfogadott értékek: json, jsonc, none, table, tsv, yaml, yamlc
alapértelmezett érték: json
--query

JMESPath lekérdezési sztring. További információkért és példákért lásd http://jmespath.org/ .

--subscription

Az előfizetés neve vagy azonosítója. Az alapértelmezett előfizetést konfigurálhatja a következővel az account set -s NAME_OR_ID: .

--verbose

A naplózás részletességének növelése. Használja a --debug parancsot a teljes hibakeresési naplókhoz.

az automation runbook wait

Kísérleti

Az "automation runbook" parancscsoport kísérleti és fejlesztés alatt áll. Referencia- és támogatási szintek: https://aka.ms/CLI_refstatus

Helyezze a parancssori felületet várakozási állapotba, amíg az automatizálási runbook egy állapota meg nem teljesül.

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

Példák

A parancssori felület következő sorának futtatását szüneteltetheti, amíg az automation runbook sikeresen létre nem jön.

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

Opcionális paraméterek

--automation-account-name

Az automation-fiók neve.

--created

Várjon, amíg létre nem jön a "provisioningState" a "Sikeres" helyen.

alapértelmezett érték: False
--custom

Várjon, amíg a feltétel megfelel egy egyéni JMESPath-lekérdezésnek. Pl. provisioningState!='InProgress', instanceView.statuses[?code=='PowerState/running"?.

--deleted

Várjon a törlésig.

alapértelmezett érték: False
--exists

Várjon, amíg az erőforrás létezik.

alapértelmezett érték: False
--ids

Egy vagy több erőforrásazonosító (szóközzel tagolt). Teljes erőforrás-azonosítónak kell lennie, amely tartalmazza az "Erőforrás-azonosító" argumentumok összes információját. Adjon meg --ids vagy más "Erőforrás-azonosító" argumentumot.

--interval

Lekérdezési időköz másodpercben.

alapértelmezett érték: 30
--name --runbook-name -n

A runbook neve.

--resource-group -g

Az erőforráscsoport neve. Az alapértelmezett csoportot konfigurálhatja a következővel az configure --defaults group=<name>: .

--subscription

Az előfizetés neve vagy azonosítója. Az alapértelmezett előfizetést konfigurálhatja a következővel az account set -s NAME_OR_ID: .

--timeout

Maximális várakozás másodpercben.

alapértelmezett érték: 3600
--updated

Várjon, amíg frissül a provisioningState a következő helyen: "Sikeres".

alapértelmezett érték: False
Globális paraméterek
--debug

Növelje a naplózás részletességét az összes hibakeresési napló megjelenítéséhez.

--help -h

Jelenítse meg ezt a súgóüzenetet, és lépjen ki.

--only-show-errors

Csak a hibák megjelenítése, a figyelmeztetések mellőzése.

--output -o

Kimeneti formátum.

elfogadott értékek: json, jsonc, none, table, tsv, yaml, yamlc
alapértelmezett érték: json
--query

JMESPath lekérdezési sztring. További információkért és példákért lásd http://jmespath.org/ .

--subscription

Az előfizetés neve vagy azonosítója. Az alapértelmezett előfizetést konfigurálhatja a következővel az account set -s NAME_OR_ID: .

--verbose

A naplózás részletességének növelése. Használja a --debug parancsot a teljes hibakeresési naplókhoz.