Automation REST API Reference
The Azure Automation service provides a highly reliable and scalable workflow execution engine to automate frequently repeated management tasks. The processes are automated through runbooks, which are Windows PowerShell Workflows run in the Azure Automation execution engine. You can use this API to create, update, read, and delete automation resources, including runbooks and runbook jobs. In addition you can manage assets such as variables, schedules, Windows PowerShell modules, credentials, and certificates.
Rest Operation Groups
The Automation REST API provides operations for working with the following resources.
| Operation Group | Description |
|---|---|
| Activity | Manage activities available from a module imported in an Automation account. |
| Agent registration information | Manage the Automation agent registration information. |
| Automation account | Manage and provide information about Automation accounts in a resource group. |
| Certificate | Manage and provide information about certificate assets. |
| Connection | Manage and provide information about connections. |
| Connection type | Manage and provide information about connection types that service connections. |
| Credential | Manage credential assets to authenticate for any resource or purpose. |
| DSC compilation job | Manage and provide information about compilation jobs for DSC configurations. |
| DSC compilation jobstream | Manage and provide information about compilation jobstreams for DSC configurations. |
| DSC configuration | Manage and provide information about DSC configurations. |
| DSC node | Manage and provide information about DSC nodes. |
| DSC node configuration | Configure and provide information abut DSC nodes. |
| Fields | Review details of modules in an Automation account. |
| Hybrid Runbook Worker group | Manage Hybrid Runbook Worker groups. |
| Job | Manage runbook jobs. |
| Job schedule | Manage job schedules. |
| Job stream | Review job stream for a runbook job. |
| Keys | List automation keys for an Automation Account. |
| LinkedWorkspace | Retrieve the linked workspace for an Automation Account. |
| Module | Operations for managing Windows PowerShell workflow modules. |
| Node count information | Get counts for DSC nodes. |
| Node reports | Review DSC reports sent from a DSC node to Automation. |
| Object data types | Review details of modules in an Automation account. |
| Operations | Review all of the available REST API options for Automation. |
| Runbook | Operations for managing runbooks and draft runbooks. |
| Runbook draft | Operations for managing runbooks in Automation. |
| Schedule | Schedule operations for runbooks. |
| Software Update Configuration Machine Runs | Provide information for Software Update Configuration Machine Runs. |
| Software Update Configuration Runs | Provide information for Software Update Configuration Runs. |
| Software Update Configurations | Manage Software Update Configurations. |
| Source Control | Manage and provide information for Source Control. |
| Source Control Sync Job | Manage and provide information for Source Control Sync Jobs. |
| Source Control Sync Job Streams | Manage and provide information Source Control Sync Job Streams |
| Statistics | Review statistics for an Automation Account. |
| Test jobs | Manage test jobs for a runbook. |
| Test job streams | Review job streams for a runbook job. |
| Usages | Review job run time minutes used for an Automation account. |
| Variable | Manage data that you want to store in an Automation account. |
| Watcher | Manage and provide information about Watcher Tasks. |
| Webhook | Utilize APIs to manage webhooks in an Automation account. |