az automation runbook
Notitie
Deze verwijzing maakt deel uit van de Automation-extensie voor Azure CLI en vereist versie 2.13.0 of hoger. De extensie wordt automatisch geïnstalleerd wanneer u de opdracht az automation runbook voor het eerst gebruikt. Meer informatie over extensies.
Automation-runbook.
Opdracht
| az automation runbook create |
Maak het runbook dat wordt geïdentificeerd door de naam van het runbook. |
| az automation runbook delete |
Verwijder het runbook op naam. |
| az automation runbook list |
Een lijst met runbooks ophalen. |
| az automation runbook publish |
Runbook-concept publiceren. |
| az automation runbook replace-content |
Vervang de inhoud van het runbook. |
| az automation runbook revert-to-published |
De runbookinhoud terugdraaien naar de laatst bekende gepubliceerde status. |
| az automation runbook show |
Haal het runbook op dat wordt geïdentificeerd door de naam van het runbook. |
| az automation runbook start |
Start het runbook. |
| az automation runbook update |
Werk het runbook bij dat wordt geïdentificeerd door de naam van het runbook. |
| az automation runbook wait |
Plaats de CLI in een wachttoestand totdat aan een voorwaarde van het Automation-runbook wordt voldaan. |
az automation runbook create
Maak het runbook dat wordt geïdentificeerd door de naam van het 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]
Voorbeelden
Een runbook maken
az automation runbook create --automation-account-name "myAutomationAccount" --resource-group "rg" --name "myRunbook" --type "PowerShell" --location "East US 2"
Vereiste parameters
De naam van het Automation-account.
De naam van het runbook.
De naam van de resourcegroep. U kunt de standaardgroep configureren met az configure --defaults group=<name> behulp van .
Type runbook.
Optionele parameters
Beschrijving van het runbook.
Locatie. Waarden van: az account list-locations . U kunt de standaardlocatie configureren met az configure --defaults location=<location> behulp van .
Traceringsopties op activiteitsniveau van het runbook.
De optie Voortgangslogboek van het runbook.
Uitgebreide logboekoptie van het runbook.
Door spatie gescheiden tags: sleutel[=waarde] [sleutel[=waarde] ...]. Gebruik '' om bestaande tags te verwijderen.
Vergroot de logboekbebossing om alle logboeken voor foutopsporing weer te geven.
Laat dit Help-bericht zien en sluit af.
Alleen fouten weergeven, waarschuwingen onderdrukken.
Uitvoerindeling.
JMESPath-queryreeks. Zie http://jmespath.org/ voor meer informatie en voorbeelden.
Vergroot de logboekverkenbaarheid. Gebruik --debug voor volledige logboeken voor foutopsporing.
az automation runbook delete
Verwijder het runbook op naam.
az automation runbook delete --automation-account-name
--name
--resource-group
[--yes]
Voorbeelden
Een runbook verwijderen
az automation runbook delete --automation-account-name "myAutomationAccount" --resource-group "rg" --name "myRunbook"
Vereiste parameters
De naam van het Automation-account.
De naam van het runbook.
De naam van de resourcegroep. U kunt de standaardgroep configureren met az configure --defaults group=<name> behulp van .
Optionele parameters
Niet vragen om bevestiging.
Vergroot de logboekbebossing om alle logboeken voor foutopsporing weer te geven.
Laat dit Help-bericht zien en sluit af.
Alleen fouten weergeven, waarschuwingen onderdrukken.
Uitvoerindeling.
JMESPath-queryreeks. Zie http://jmespath.org/ voor meer informatie en voorbeelden.
Vergroot de logboekverkenbaarheid. Gebruik --debug voor volledige logboeken voor foutopsporing.
az automation runbook list
Een lijst met runbooks ophalen.
az automation runbook list --automation-account-name
--resource-group
Voorbeelden
Runbooks per Automation-account weergeven
az automation runbook list --automation-account-name "myAutomationAccount" --resource-group "rg"
Vereiste parameters
De naam van het Automation-account.
De naam van de resourcegroep. U kunt de standaardgroep configureren met az configure --defaults group=<name> behulp van .
Vergroot de logboekbebossing om alle logboeken voor foutopsporing weer te geven.
Laat dit Help-bericht zien en sluit af.
Alleen fouten weergeven, waarschuwingen onderdrukken.
Uitvoerindeling.
JMESPath-queryreeks. Zie http://jmespath.org/ voor meer informatie en voorbeelden.
Vergroot de logboekverkenbaarheid. Gebruik --debug voor volledige logboeken voor foutopsporing.
az automation runbook publish
Runbook-concept publiceren.
az automation runbook publish --automation-account-name
--name
--resource-group
[--no-wait]
Voorbeelden
Runbook-concept publiceren
az automation runbook publish --automation-account-name "myAutomationAccount" --resource-group "rg" --name "myRunbook"
Vereiste parameters
De naam van het Automation-account.
De parameters die zijn opgegeven voor de bewerking voor het publiceren van het runbook.
De naam van de resourcegroep. U kunt de standaardgroep configureren met az configure --defaults group=<name> behulp van .
Optionele parameters
Wacht niet tot de langlopende bewerking is uitgevoerd.
Vergroot de logboekbebossing om alle logboeken voor foutopsporing weer te geven.
Laat dit Help-bericht zien en sluit af.
Alleen fouten weergeven, waarschuwingen onderdrukken.
Uitvoerindeling.
JMESPath-queryreeks. Zie http://jmespath.org/ voor meer informatie en voorbeelden.
Vergroot de logboekverkenbaarheid. Gebruik --debug voor volledige logboeken voor foutopsporing.
az automation runbook replace-content
Vervang de inhoud van het runbook.
az automation runbook replace-content --automation-account-name
--content
--name
--resource-group
[--no-wait]
Voorbeelden
Inhoud van het runbook vervangen
az automation runbook replace-content --automation-account-name "myAutomationAccount" --resource-group "rg" --name "myRunbook" --content @/path/to/script
Vereiste parameters
De naam van het Automation-account.
De inhoud van het runbook.
De naam van het runbook.
De naam van de resourcegroep. U kunt de standaardgroep configureren met az configure --defaults group=<name> behulp van .
Optionele parameters
Wacht niet tot de langlopende bewerking is uitgevoerd.
Vergroot de logboekbebossing om alle logboeken voor foutopsporing weer te geven.
Laat dit Help-bericht zien en sluit af.
Alleen fouten weergeven, waarschuwingen onderdrukken.
Uitvoerindeling.
JMESPath-queryreeks. Zie http://jmespath.org/ voor meer informatie en voorbeelden.
Vergroot de logboekverkenbaarheid. Gebruik --debug voor volledige logboeken voor foutopsporing.
az automation runbook revert-to-published
De runbookinhoud terugdraaien naar de laatst bekende gepubliceerde status.
az automation runbook revert-to-published --automation-account-name
--name
--resource-group
Voorbeelden
Inhoud van het runbook vervangen
az automation runbook revert-to-published --automation-account-name "myAutomationAccount" --resource-group "rg" --name "myRunbook"
Vereiste parameters
De naam van het Automation-account.
De naam van het runbook.
De naam van de resourcegroep. U kunt de standaardgroep configureren met az configure --defaults group=<name> behulp van .
Vergroot de logboekbebossing om alle logboeken voor foutopsporing weer te geven.
Laat dit Help-bericht zien en sluit af.
Alleen fouten weergeven, waarschuwingen onderdrukken.
Uitvoerindeling.
JMESPath-queryreeks. Zie http://jmespath.org/ voor meer informatie en voorbeelden.
Vergroot de logboekverkenbaarheid. Gebruik --debug voor volledige logboeken voor foutopsporing.
az automation runbook show
Haal het runbook op dat wordt geïdentificeerd door de naam van het runbook.
az automation runbook show --automation-account-name
--name
--resource-group
Voorbeelden
Runbook downloaden
az automation runbook show --automation-account-name "myAutomationAccount" --resource-group "rg" --name "myRunbook"
Vereiste parameters
De naam van het Automation-account.
De naam van het runbook.
De naam van de resourcegroep. U kunt de standaardgroep configureren met az configure --defaults group=<name> behulp van .
Vergroot de logboekbebossing om alle logboeken voor foutopsporing weer te geven.
Laat dit Help-bericht zien en sluit af.
Alleen fouten weergeven, waarschuwingen onderdrukken.
Uitvoerindeling.
JMESPath-queryreeks. Zie http://jmespath.org/ voor meer informatie en voorbeelden.
Vergroot de logboekverkenbaarheid. Gebruik --debug voor volledige logboeken voor foutopsporing.
az automation runbook start
Start het runbook.
az automation runbook start --automation-account-name
--resource-group
[--name]
[--parameters]
[--run-on]
Voorbeelden
Het runbook starten
az automation runbook start --automation-account-name "myAutomationAccount" --resource-group "rg" --name "myRunbook"
Vereiste parameters
De naam van het Automation-account.
De naam van de resourcegroep. U kunt de standaardgroep configureren met az configure --defaults group=<name> behulp van .
Optionele parameters
De naam van het runbook.
Parameters van de taak. Waarde verwachten: KEY1=VALUE1 KEY2=VALUE2 ...
RunOn waarmee de groepsnaam wordt opgegeven waar de taak moet worden uitgevoerd.
Vergroot de logboekbebossing om alle logboeken voor foutopsporing weer te geven.
Laat dit Help-bericht zien en sluit af.
Alleen fouten weergeven, waarschuwingen onderdrukken.
Uitvoerindeling.
JMESPath-queryreeks. Zie http://jmespath.org/ voor meer informatie en voorbeelden.
Vergroot de logboekverkenbaarheid. Gebruik --debug voor volledige logboeken voor foutopsporing.
az automation runbook update
Werk het runbook bij dat wordt geïdentificeerd door de naam van het runbook.
az automation runbook update --automation-account-name
--name
--resource-group
[--description]
[--log-activity-trace]
[--log-progress {false, true}]
[--log-verbose {false, true}]
[--tags]
Voorbeelden
Een runbook bijwerken
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"
Vereiste parameters
De naam van het Automation-account.
De naam van het runbook.
De naam van de resourcegroep. U kunt de standaardgroep configureren met az configure --defaults group=<name> behulp van .
Optionele parameters
Beschrijving van het runbook.
Traceringsopties op activiteitsniveau van het runbook.
De optie Voortgangslogboek van het runbook.
Uitgebreide logboekoptie van het runbook.
Door spatie gescheiden tags: sleutel[=waarde] [sleutel[=waarde] ...]. Gebruik '' om bestaande tags te verwijderen.
Vergroot de logboekbebossing om alle logboeken voor foutopsporing weer te geven.
Laat dit Help-bericht zien en sluit af.
Alleen fouten weergeven, waarschuwingen onderdrukken.
Uitvoerindeling.
JMESPath-queryreeks. Zie http://jmespath.org/ voor meer informatie en voorbeelden.
Vergroot de logboekverkenbaarheid. Gebruik --debug voor volledige logboeken voor foutopsporing.
az automation runbook wait
Plaats de CLI in een wachttoestand totdat aan een voorwaarde van het Automation-runbook wordt voldaan.
az automation runbook wait --automation-account-name
--name
--resource-group
[--created]
[--custom]
[--deleted]
[--exists]
[--interval]
[--timeout]
[--updated]
Voorbeelden
Pauzeer de volgende regel van het CLI-script totdat het Automation-runbook is gemaakt.
az automation runbook wait --automation-account-name "myAutomationAccount" --resource-group "rg" --name "myRunbook" --created
Vereiste parameters
De naam van het Automation-account.
De naam van het runbook.
De naam van de resourcegroep. U kunt de standaardgroep configureren met az configure --defaults group=<name> behulp van .
Optionele parameters
Wacht totdat u met provisioningState bij Succeeded hebt gemaakt.
Wacht totdat de voorwaarde voldoet aan een aangepaste JMESPath-query. Bijvoorbeeld provisioningState!='InProgress', instanceView.statuses[?code=='PowerState/running'].
Wacht totdat u deze hebt verwijderd.
Wacht totdat de resource bestaat.
Pollinginterval in seconden.
Maximale wachttijd in seconden.
Wacht totdat de provisioningState is bijgewerkt op 'Succeeded'.
Vergroot de logboekbebossing om alle logboeken voor foutopsporing weer te geven.
Laat dit Help-bericht zien en sluit af.
Alleen fouten weergeven, waarschuwingen onderdrukken.
Uitvoerindeling.
JMESPath-queryreeks. Zie http://jmespath.org/ voor meer informatie en voorbeelden.
Vergroot de logboekverkenbaarheid. Gebruik --debug voor volledige logboeken voor foutopsporing.