Azure Automation: Runbook
Azure Automation: Runbook endpoints from Microsoft Azure
Fork copies the collection into your workspace, without the publisher's secrets, so you can add your own key and send requests. Star saves it to your starred APIs (Account › Marketplace) and helps others find it.
Overview
Azure Automation: Runbook endpoints from Microsoft Azure
Endpoints 18
RunbookDraft
- GETRunbookDraft_GetContent
/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.Automation/automationAccounts/:automationAccountName/runbooks/:runbookName/draft/contentRetrieve the content of runbook draft identified by runbook name. - PUTRunbookDraft_ReplaceContent
/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.Automation/automationAccounts/:automationAccountName/runbooks/:runbookName/draft/contentReplaces the runbook draft content. - GETRunbookDraft_Get
/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.Automation/automationAccounts/:automationAccountName/runbooks/:runbookName/draftRetrieve the runbook draft identified by runbook name. - POSTRunbookDraft_UndoEdit
/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.Automation/automationAccounts/:automationAccountName/runbooks/:runbookName/draft/undoEditUndo draft edit to last known published state identified by runbook name.
Runbook
- POSTRunbook_Publish
/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.Automation/automationAccounts/:automationAccountName/runbooks/:runbookName/publishPublish runbook draft. - GETRunbook_GetContent
/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.Automation/automationAccounts/:automationAccountName/runbooks/:runbookName/contentRetrieve the content of runbook identified by runbook name. - GETRunbook_Get
/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.Automation/automationAccounts/:automationAccountName/runbooks/:runbookNameRetrieve the runbook identified by runbook name. - PUTRunbook_CreateOrUpdate
/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.Automation/automationAccounts/:automationAccountName/runbooks/:runbookNameCreate the runbook identified by runbook name. - DELETERunbook_Delete
/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.Automation/automationAccounts/:automationAccountName/runbooks/:runbookNameDelete the runbook by name. - PATCHRunbook_Update
/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.Automation/automationAccounts/:automationAccountName/runbooks/:runbookNameUpdate the runbook identified by runbook name. - GETRunbook_ListByAutomationAccount
/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.Automation/automationAccounts/:automationAccountName/runbooksRetrieve a list of runbooks.
TestJobStream
- GETTestJobStreams_Get
/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.Automation/automationAccounts/:automationAccountName/runbooks/:runbookName/draft/testJob/streams/:jobStreamIdRetrieve a test job stream of the test job identified by runbook name and stream id. - GETTestJobStreams_ListByTestJob
/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.Automation/automationAccounts/:automationAccountName/runbooks/:runbookName/draft/testJob/streams?$filter=stringRetrieve a list of test job streams identified by runbook name.
TestJob
- GETTestJob_Get
/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.Automation/automationAccounts/:automationAccountName/runbooks/:runbookName/draft/testJobRetrieve the test job for the specified runbook. - PUTTestJob_Create
/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.Automation/automationAccounts/:automationAccountName/runbooks/:runbookName/draft/testJobCreate a test job of the runbook. - POSTTestJob_Resume
/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.Automation/automationAccounts/:automationAccountName/runbooks/:runbookName/draft/testJob/resumeResume the test job. - POSTTestJob_Stop
/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.Automation/automationAccounts/:automationAccountName/runbooks/:runbookName/draft/testJob/stopStop the test job. - POSTTestJob_Suspend
/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.Automation/automationAccounts/:automationAccountName/runbooks/:runbookName/draft/testJob/suspendSuspend the test job.
API details
- Base URL
https://management.azure.com- Authentication
- OAuth 2.0 (implicit flow) with 1 scope
- Operations
- 18 operations on 13 pathsGET 8POST 5PUT 3PATCH 1DELETE 1
- Main resources
- Runbook 7TestJob 5RunbookDraft 4TestJobStream 2
- Response formats
application/json- Description format
- Swagger 2.0, API version
2023-11-01 - Links
- OpenAPI document
How to test the Azure Automation: Runbook in Swastik Codes
- Open the APISelect “Fork & run in Swastik Codes” on this page. Sign in or create a free account if asked.
- Fork it into your workspaceChoose a workspace. You get your own copy of the Azure Automation: Runbook collection, without the publisher's secrets.
- Add your credentialsThis API uses OAuth 2.0 (implicit flow) with 1 scope. Add yours in the collection's variables or an environment; the requests already reference it.
- Send a requestPick an endpoint, for example “RunbookDraft_GetContent” (GET /subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.Automation/automationAccounts/:automationAccountName/runbooks/:runbookName/draft/content), and press Send. Check the response, add tests and run the whole collection with the runner.
Frequently asked questions
What is the Azure Automation: Runbook?
Azure Automation: Runbook endpoints from Microsoft Azure It is listed under Developer tools and has 18 endpoints.
Who publishes the Azure Automation: Runbook?
It is listed from Microsoft Azure's public API description (an OpenAPI document), not published by Microsoft Azure on Swastik Codes. Anyone who controls azure.com can claim the profile by adding a DNS TXT record.
What is the base URL of the Azure Automation: Runbook?
Requests go to https://management.azure.com. Endpoint paths are added to this base URL.
How do I authenticate with the Azure Automation: Runbook?
With OAuth 2.0 (implicit flow) with 1 scope.
How many endpoints does the Azure Automation: Runbook have?
18 operations on 13 paths (8 GET, 5 POST, 3 PUT, 1 PATCH, 1 DELETE). The largest groups are Runbook, TestJob, RunbookDraft, TestJobStream.
Is forking the Azure Automation: Runbook free?
Yes. Forking copies the collection into your workspace for free. It has been starred 0 times and forked 0 times.