openapi-directory
Version:
Building & bundling https://github.com/APIs-guru/openapi-directory for easy use from JS
1 lines • 63 kB
JSON
{"openapi":"3.0.0","info":{"title":"AutomationManagement","version":"2018-06-30","x-apisguru-categories":["cloud"],"x-logo":{"url":"https://assets.onestore.ms/cdnfiles/onestorerolling-1606-01000/shell/v3/images/logo/microsoft.png"},"x-origin":[{"format":"swagger","url":"https://raw.githubusercontent.com/Azure/azure-rest-api-specs/master/specification/automation/resource-manager/Microsoft.Automation/stable/2018-06-30/runbook.json","version":"2.0"}],"x-preferred":true,"x-providerName":"azure.com","x-serviceName":"automation-runbook","x-tags":["Azure","Microsoft"]},"security":[{"azure_auth":["user_impersonation"]}],"paths":{"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Automation/automationAccounts/{automationAccountName}/runbooks":{"get":{"description":"Retrieve a list of runbooks.","externalDocs":{"url":"http://aka.ms/azureautomationsdk/runbookoperations"},"operationId":"Runbook_ListByAutomationAccount","parameters":[{"description":"Gets subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call.","in":"path","name":"subscriptionId","required":true,"schema":{"type":"string"},"examples":{"List runbooks by automation account":{"value":"subid"}}},{"description":"Name of an Azure Resource group.","in":"path","name":"resourceGroupName","required":true,"x-ms-parameter-location":"method","schema":{"type":"string","minLength":1,"maxLength":90,"pattern":"^[-\\w\\._]+$"},"examples":{"List runbooks by automation account":{"value":"rg"}}},{"description":"The name of the automation account.","in":"path","name":"automationAccountName","required":true,"x-ms-parameter-location":"method","schema":{"type":"string"},"examples":{"List runbooks by automation account":{"value":"ContoseAutomationAccount"}}},{"description":"Client Api Version.","in":"query","name":"api-version","required":true,"schema":{"type":"string"},"examples":{"List runbooks by automation account":{"value":"2018-06-30"}}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunbookListResult"},"examples":{"List runbooks by automation account":{"$ref":"#/components/examples/List_runbooks_by_automation_account"}}}}},"default":{"description":"Automation error response describing why the operation failed.","content":{"application/json":{"schema":{"description":"Error response of an operation failure","properties":{"code":{"description":"Error code","type":"string"},"message":{"description":"Error message indicating why the operation failed.","type":"string"}},"type":"object"}}}}},"tags":["Runbook"],"x-ms-pageable":{"nextLinkName":"nextLink"}}},"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Automation/automationAccounts/{automationAccountName}/runbooks/{runbookName}":{"delete":{"description":"Delete the runbook by name.","externalDocs":{"url":"http://aka.ms/azureautomationsdk/runbookoperations"},"operationId":"Runbook_Delete","parameters":[{"description":"Gets subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call.","in":"path","name":"subscriptionId","required":true,"schema":{"type":"string"},"examples":{"Delete a runbook":{"value":"subid"}}},{"description":"Name of an Azure Resource group.","in":"path","name":"resourceGroupName","required":true,"x-ms-parameter-location":"method","schema":{"type":"string","minLength":1,"maxLength":90,"pattern":"^[-\\w\\._]+$"},"examples":{"Delete a runbook":{"value":"rg"}}},{"description":"The name of the automation account.","in":"path","name":"automationAccountName","required":true,"x-ms-parameter-location":"method","schema":{"type":"string"},"examples":{"Delete a runbook":{"value":"ContoseAutomationAccount"}}},{"description":"The runbook name.","in":"path","name":"runbookName","required":true,"schema":{"type":"string"},"examples":{"Delete a runbook":{"value":"Get-AzureVMTutorial"}}},{"description":"Client Api Version.","in":"query","name":"api-version","required":true,"schema":{"type":"string"},"examples":{"Delete a runbook":{"value":"2018-06-30"}}}],"responses":{"200":{"description":"OK"},"204":{"description":"No Content"},"default":{"description":"Automation error response describing why the operation failed.","content":{"application/json":{"schema":{"description":"Error response of an operation failure","properties":{"code":{"description":"Error code","type":"string"},"message":{"description":"Error message indicating why the operation failed.","type":"string"}},"type":"object"}}}}},"tags":["Runbook"]},"get":{"description":"Retrieve the runbook identified by runbook name.","externalDocs":{"url":"http://aka.ms/azureautomationsdk/runbookoperations"},"operationId":"Runbook_Get","parameters":[{"description":"Gets subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call.","in":"path","name":"subscriptionId","required":true,"schema":{"type":"string"},"examples":{"Get runbook":{"value":"subid"}}},{"description":"Name of an Azure Resource group.","in":"path","name":"resourceGroupName","required":true,"x-ms-parameter-location":"method","schema":{"type":"string","minLength":1,"maxLength":90,"pattern":"^[-\\w\\._]+$"},"examples":{"Get runbook":{"value":"rg"}}},{"description":"The name of the automation account.","in":"path","name":"automationAccountName","required":true,"x-ms-parameter-location":"method","schema":{"type":"string"},"examples":{"Get runbook":{"value":"ContoseAutomationAccount"}}},{"description":"The runbook name.","in":"path","name":"runbookName","required":true,"schema":{"type":"string"},"examples":{"Get runbook":{"value":"Get-AzureVMTutorial"}}},{"description":"Client Api Version.","in":"query","name":"api-version","required":true,"schema":{"type":"string"},"examples":{"Get runbook":{"value":"2018-06-30"}}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Runbook"},"examples":{"Get runbook":{"$ref":"#/components/examples/Get_runbook"}}}}},"default":{"description":"Automation error response describing why the operation failed.","content":{"application/json":{"schema":{"description":"Error response of an operation failure","properties":{"code":{"description":"Error code","type":"string"},"message":{"description":"Error message indicating why the operation failed.","type":"string"}},"type":"object"}}}}},"tags":["Runbook"]},"patch":{"description":"Update the runbook identified by runbook name.","externalDocs":{"url":"http://aka.ms/azureautomationsdk/runbookoperations"},"operationId":"Runbook_Update","parameters":[{"description":"Gets subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call.","in":"path","name":"subscriptionId","required":true,"schema":{"type":"string"},"examples":{"Update runbook":{"value":"subid"}}},{"description":"Name of an Azure Resource group.","in":"path","name":"resourceGroupName","required":true,"x-ms-parameter-location":"method","schema":{"type":"string","minLength":1,"maxLength":90,"pattern":"^[-\\w\\._]+$"},"examples":{"Update runbook":{"value":"rg"}}},{"description":"The name of the automation account.","in":"path","name":"automationAccountName","required":true,"x-ms-parameter-location":"method","schema":{"type":"string"},"examples":{"Update runbook":{"value":"ContoseAutomationAccount"}}},{"description":"The runbook name.","in":"path","name":"runbookName","required":true,"schema":{"type":"string"},"examples":{"Update runbook":{"value":"Get-AzureVMTutorial"}}},{"description":"Client Api Version.","in":"query","name":"api-version","required":true,"schema":{"type":"string"},"examples":{"Update runbook":{"value":"2018-06-30"}}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunbookUpdateParameters"}}},"description":"The update parameters for runbook.","required":true},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Runbook"}}}},"default":{"description":"Automation error response describing why the operation failed.","content":{"application/json":{"schema":{"description":"Error response of an operation failure","properties":{"code":{"description":"Error code","type":"string"},"message":{"description":"Error message indicating why the operation failed.","type":"string"}},"type":"object"}}}}},"tags":["Runbook"]},"put":{"description":"Create the runbook identified by runbook name.","externalDocs":{"url":"http://aka.ms/azureautomationsdk/runbookoperations"},"operationId":"Runbook_CreateOrUpdate","parameters":[{"description":"Gets subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call.","in":"path","name":"subscriptionId","required":true,"schema":{"type":"string"},"examples":{"Create or update runbook and publish it":{"value":"subid"},"Create runbook as draft":{"value":"subid"}}},{"description":"Name of an Azure Resource group.","in":"path","name":"resourceGroupName","required":true,"x-ms-parameter-location":"method","schema":{"type":"string","minLength":1,"maxLength":90,"pattern":"^[-\\w\\._]+$"},"examples":{"Create or update runbook and publish it":{"value":"rg"},"Create runbook as draft":{"value":"rg"}}},{"description":"The name of the automation account.","in":"path","name":"automationAccountName","required":true,"x-ms-parameter-location":"method","schema":{"type":"string"},"examples":{"Create or update runbook and publish it":{"value":"ContoseAutomationAccount"},"Create runbook as draft":{"value":"ContoseAutomationAccount"}}},{"description":"The runbook name.","in":"path","name":"runbookName","required":true,"schema":{"type":"string"},"examples":{"Create or update runbook and publish it":{"value":"Get-AzureVMTutorial"},"Create runbook as draft":{"value":"Get-AzureVMTutorial"}}},{"description":"Client Api Version.","in":"query","name":"api-version","required":true,"schema":{"type":"string"},"examples":{"Create or update runbook and publish it":{"value":"2018-06-30"},"Create runbook as draft":{"value":"2018-06-30"}}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunbookCreateOrUpdateParameters"}}},"description":"The create or update parameters for runbook. Provide either content link for a published runbook or draft, not both.","required":true},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Runbook"},"examples":{"Create or update runbook and publish it":{"$ref":"#/components/examples/Create_or_update_runbook_and_publish_it"},"Create runbook as draft":{"$ref":"#/components/examples/Create_runbook_as_draft"}}}}},"201":{"description":"Created","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Runbook"},"examples":{"Create or update runbook and publish it":{"$ref":"#/components/examples/Create_or_update_runbook_and_publish_it"},"Create runbook as draft":{"$ref":"#/components/examples/Create_runbook_as_draft"}}}}},"default":{"description":"Automation error response describing why the operation failed.","content":{"application/json":{"schema":{"description":"Error response of an operation failure","properties":{"code":{"description":"Error code","type":"string"},"message":{"description":"Error message indicating why the operation failed.","type":"string"}},"type":"object"}}}}},"tags":["Runbook"]}},"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Automation/automationAccounts/{automationAccountName}/runbooks/{runbookName}/content":{"get":{"description":"Retrieve the content of runbook identified by runbook name.","externalDocs":{"url":"http://aka.ms/azureautomationsdk/runbookoperations"},"operationId":"Runbook_GetContent","parameters":[{"description":"Gets subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call.","in":"path","name":"subscriptionId","required":true,"schema":{"type":"string"},"examples":{"Get runbook content":{"value":"subid"}}},{"description":"Name of an Azure Resource group.","in":"path","name":"resourceGroupName","required":true,"x-ms-parameter-location":"method","schema":{"type":"string","minLength":1,"maxLength":90,"pattern":"^[-\\w\\._]+$"},"examples":{"Get runbook content":{"value":"rg"}}},{"description":"The name of the automation account.","in":"path","name":"automationAccountName","required":true,"x-ms-parameter-location":"method","schema":{"type":"string"},"examples":{"Get runbook content":{"value":"ContoseAutomationAccount"}}},{"description":"The runbook name.","in":"path","name":"runbookName","required":true,"schema":{"type":"string"},"examples":{"Get runbook content":{"value":"Get-AzureVMTutorial"}}},{"description":"Client Api Version.","in":"query","name":"api-version","required":true,"schema":{"type":"string"},"examples":{"Get runbook content":{"value":"2018-06-30"}}}],"responses":{"200":{"description":"OK","content":{"text/powershell":{"schema":{"type":"string","format":"binary"},"examples":{"Get runbook content":{"$ref":"#/components/examples/Get_runbook_content"}}}}},"default":{"description":"Automation error response describing why the operation failed.","content":{"text/powershell":{"schema":{"description":"Error response of an operation failure","properties":{"code":{"description":"Error code","type":"string"},"message":{"description":"Error message indicating why the operation failed.","type":"string"}},"type":"object"}}}}},"tags":["Runbook"]}},"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Automation/automationAccounts/{automationAccountName}/runbooks/{runbookName}/draft":{"get":{"description":"Retrieve the runbook draft identified by runbook name.","externalDocs":{"url":"http://aka.ms/azureautomationsdk/runbookdraftoperations"},"operationId":"RunbookDraft_Get","parameters":[{"description":"Gets subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call.","in":"path","name":"subscriptionId","required":true,"schema":{"type":"string"},"examples":{"Get runbook draft":{"value":"subid"}}},{"description":"Name of an Azure Resource group.","in":"path","name":"resourceGroupName","required":true,"x-ms-parameter-location":"method","schema":{"type":"string","minLength":1,"maxLength":90,"pattern":"^[-\\w\\._]+$"},"examples":{"Get runbook draft":{"value":"rg"}}},{"description":"The name of the automation account.","in":"path","name":"automationAccountName","required":true,"x-ms-parameter-location":"method","schema":{"type":"string"},"examples":{"Get runbook draft":{"value":"ContoseAutomationAccount"}}},{"description":"The runbook name.","in":"path","name":"runbookName","required":true,"schema":{"type":"string"},"examples":{"Get runbook draft":{"value":"Get-AzureVMTutorial"}}},{"description":"Client Api Version.","in":"query","name":"api-version","required":true,"schema":{"type":"string"},"examples":{"Get runbook draft":{"value":"2018-06-30"}}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunbookDraft"},"examples":{"Get runbook draft":{"$ref":"#/components/examples/Get_runbook_draft"}}}}},"default":{"description":"Automation error response describing why the operation failed.","content":{"application/json":{"schema":{"description":"Error response of an operation failure","properties":{"code":{"description":"Error code","type":"string"},"message":{"description":"Error message indicating why the operation failed.","type":"string"}},"type":"object"}}}}},"tags":["RunbookDraft"]}},"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Automation/automationAccounts/{automationAccountName}/runbooks/{runbookName}/draft/content":{"get":{"description":"Retrieve the content of runbook draft identified by runbook name.","externalDocs":{"url":"http://aka.ms/azureautomationsdk/runbookdraftoperations"},"operationId":"RunbookDraft_GetContent","parameters":[{"description":"Gets subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call.","in":"path","name":"subscriptionId","required":true,"schema":{"type":"string"},"examples":{"Get runbook draft content":{"value":"subid"}}},{"description":"Name of an Azure Resource group.","in":"path","name":"resourceGroupName","required":true,"x-ms-parameter-location":"method","schema":{"type":"string","minLength":1,"maxLength":90,"pattern":"^[-\\w\\._]+$"},"examples":{"Get runbook draft content":{"value":"rg"}}},{"description":"The name of the automation account.","in":"path","name":"automationAccountName","required":true,"x-ms-parameter-location":"method","schema":{"type":"string"},"examples":{"Get runbook draft content":{"value":"ContoseAutomationAccount"}}},{"description":"The runbook name.","in":"path","name":"runbookName","required":true,"schema":{"type":"string"},"examples":{"Get runbook draft content":{"value":"Get-AzureVMTutorial"}}},{"description":"Client Api Version.","in":"query","name":"api-version","required":true,"schema":{"type":"string"},"examples":{"Get runbook draft content":{"value":"2018-06-30"}}}],"responses":{"200":{"description":"OK","content":{"text/powershell":{"schema":{"type":"string","format":"binary"},"examples":{"Get runbook draft content":{"$ref":"#/components/examples/Get_runbook_draft_content"}}}}},"default":{"description":"Automation error response describing why the operation failed.","content":{"text/powershell":{"schema":{"description":"Error response of an operation failure","properties":{"code":{"description":"Error code","type":"string"},"message":{"description":"Error message indicating why the operation failed.","type":"string"}},"type":"object"}}}}},"tags":["RunbookDraft"]},"put":{"description":"Replaces the runbook draft content.","externalDocs":{"url":"http://aka.ms/azureautomationsdk/runbookdraftoperations"},"operationId":"RunbookDraft_ReplaceContent","parameters":[{"description":"Gets subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call.","in":"path","name":"subscriptionId","required":true,"schema":{"type":"string"},"examples":{"Create or update runbook draft":{"value":"subid"}}},{"description":"Name of an Azure Resource group.","in":"path","name":"resourceGroupName","required":true,"x-ms-parameter-location":"method","schema":{"type":"string","minLength":1,"maxLength":90,"pattern":"^[-\\w\\._]+$"},"examples":{"Create or update runbook draft":{"value":"rg"}}},{"description":"The name of the automation account.","in":"path","name":"automationAccountName","required":true,"x-ms-parameter-location":"method","schema":{"type":"string"},"examples":{"Create or update runbook draft":{"value":"ContoseAutomationAccount"}}},{"description":"The runbook name.","in":"path","name":"runbookName","required":true,"schema":{"type":"string"},"examples":{"Create or update runbook draft":{"value":"Get-AzureVMTutorial"}}},{"description":"Client Api Version.","in":"query","name":"api-version","required":true,"schema":{"type":"string"},"examples":{"Create or update runbook draft":{"value":"2018-06-30"}}}],"requestBody":{"content":{"text/powershell":{"schema":{"format":"file","type":"object"}}},"description":"The runbook draft content.","required":true},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"string","format":"binary"}}}},"202":{"description":"Accepted and the operation will complete asynchronously.","headers":{"location":{"description":"URL to query for status of the operation.","schema":{"type":"string"}}}},"default":{"description":"Automation error response describing why the operation failed.","content":{"application/json":{"schema":{"description":"Error response of an operation failure","properties":{"code":{"description":"Error code","type":"string"},"message":{"description":"Error message indicating why the operation failed.","type":"string"}},"type":"object"}}}}},"tags":["RunbookDraft"],"x-ms-long-running-operation":true}},"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Automation/automationAccounts/{automationAccountName}/runbooks/{runbookName}/draft/testJob":{"get":{"description":"Retrieve the test job for the specified runbook.","externalDocs":{"url":"http://aka.ms/azureautomationsdk/testjoboperations"},"operationId":"TestJob_Get","parameters":[{"description":"Gets subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call.","in":"path","name":"subscriptionId","required":true,"schema":{"type":"string"},"examples":{"Get test job":{"value":"51766542-3ed7-4a72-a187-0c8ab644ddab"}}},{"description":"Name of an Azure Resource group.","in":"path","name":"resourceGroupName","required":true,"x-ms-parameter-location":"method","schema":{"type":"string","minLength":1,"maxLength":90,"pattern":"^[-\\w\\._]+$"},"examples":{"Get test job":{"value":"mygroup"}}},{"description":"The name of the automation account.","in":"path","name":"automationAccountName","required":true,"x-ms-parameter-location":"method","schema":{"type":"string"},"examples":{"Get test job":{"value":"ContoseAutomationAccount"}}},{"description":"The runbook name.","in":"path","name":"runbookName","required":true,"schema":{"type":"string"},"examples":{"Get test job":{"value":"Get-AzureVMTutorial"}}},{"description":"Client Api Version.","in":"query","name":"api-version","required":true,"schema":{"type":"string"},"examples":{"Get test job":{"value":"2018-06-30"}}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TestJob"},"examples":{"Get test job":{"$ref":"#/components/examples/Get_test_job"}}}}},"default":{"description":"Automation error response describing why the operation failed.","content":{"application/json":{"schema":{"description":"Error response of an operation failure","properties":{"code":{"description":"Error code","type":"string"},"message":{"description":"Error message indicating why the operation failed.","type":"string"}},"type":"object"}}}}},"tags":["TestJob"]},"put":{"description":"Create a test job of the runbook.","externalDocs":{"url":"http://aka.ms/azureautomationsdk/testjoboperations"},"operationId":"TestJob_Create","parameters":[{"description":"Gets subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call.","in":"path","name":"subscriptionId","required":true,"schema":{"type":"string"},"examples":{"Create test job":{"value":"51766542-3ed7-4a72-a187-0c8ab644ddab"}}},{"description":"Name of an Azure Resource group.","in":"path","name":"resourceGroupName","required":true,"x-ms-parameter-location":"method","schema":{"type":"string","minLength":1,"maxLength":90,"pattern":"^[-\\w\\._]+$"},"examples":{"Create test job":{"value":"mygroup"}}},{"description":"The name of the automation account.","in":"path","name":"automationAccountName","required":true,"x-ms-parameter-location":"method","schema":{"type":"string"},"examples":{"Create test job":{"value":"ContoseAutomationAccount"}}},{"description":"The parameters supplied to the create test job operation.","in":"path","name":"runbookName","required":true,"schema":{"type":"string"},"examples":{"Create test job":{"value":"Get-AzureVMTutorial"}}},{"description":"Client Api Version.","in":"query","name":"api-version","required":true,"schema":{"type":"string"},"examples":{"Create test job":{"value":"2018-06-30"}}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/TestJobCreateParameters"}}},"description":"The parameters supplied to the create test job operation.","required":true},"responses":{"201":{"description":"Created","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TestJob"},"examples":{"Create test job":{"$ref":"#/components/examples/Create_test_job"}}}}},"default":{"description":"Automation error response describing why the operation failed.","content":{"application/json":{"schema":{"description":"Error response of an operation failure","properties":{"code":{"description":"Error code","type":"string"},"message":{"description":"Error message indicating why the operation failed.","type":"string"}},"type":"object"}}}}},"tags":["TestJob"]}},"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Automation/automationAccounts/{automationAccountName}/runbooks/{runbookName}/draft/testJob/resume":{"post":{"description":"Resume the test job.","externalDocs":{"url":"http://aka.ms/azureautomationsdk/testjoboperations"},"operationId":"TestJob_Resume","parameters":[{"description":"Gets subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call.","in":"path","name":"subscriptionId","required":true,"schema":{"type":"string"},"examples":{"Resume test job":{"value":"51766542-3ed7-4a72-a187-0c8ab644ddab"}}},{"description":"Name of an Azure Resource group.","in":"path","name":"resourceGroupName","required":true,"x-ms-parameter-location":"method","schema":{"type":"string","minLength":1,"maxLength":90,"pattern":"^[-\\w\\._]+$"},"examples":{"Resume test job":{"value":"mygroup"}}},{"description":"The name of the automation account.","in":"path","name":"automationAccountName","required":true,"x-ms-parameter-location":"method","schema":{"type":"string"},"examples":{"Resume test job":{"value":"ContoseAutomationAccount"}}},{"description":"The runbook name.","in":"path","name":"runbookName","required":true,"schema":{"type":"string"},"examples":{"Resume test job":{"value":"Get-AzureVMTutorial"}}},{"description":"Client Api Version.","in":"query","name":"api-version","required":true,"schema":{"type":"string"},"examples":{"Resume test job":{"value":"2018-06-30"}}}],"responses":{"200":{"description":"OK"},"default":{"description":"Automation error response describing why the operation failed.","content":{"application/json":{"schema":{"description":"Error response of an operation failure","properties":{"code":{"description":"Error code","type":"string"},"message":{"description":"Error message indicating why the operation failed.","type":"string"}},"type":"object"}}}}},"tags":["TestJob"]}},"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Automation/automationAccounts/{automationAccountName}/runbooks/{runbookName}/draft/testJob/stop":{"post":{"description":"Stop the test job.","externalDocs":{"url":"http://aka.ms/azureautomationsdk/testjoboperations"},"operationId":"TestJob_Stop","parameters":[{"description":"Gets subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call.","in":"path","name":"subscriptionId","required":true,"schema":{"type":"string"},"examples":{"Stop test job":{"value":"51766542-3ed7-4a72-a187-0c8ab644ddab"}}},{"description":"Name of an Azure Resource group.","in":"path","name":"resourceGroupName","required":true,"x-ms-parameter-location":"method","schema":{"type":"string","minLength":1,"maxLength":90,"pattern":"^[-\\w\\._]+$"},"examples":{"Stop test job":{"value":"mygroup"}}},{"description":"The name of the automation account.","in":"path","name":"automationAccountName","required":true,"x-ms-parameter-location":"method","schema":{"type":"string"},"examples":{"Stop test job":{"value":"ContoseAutomationAccount"}}},{"description":"The runbook name.","in":"path","name":"runbookName","required":true,"schema":{"type":"string"},"examples":{"Stop test job":{"value":"Get-AzureVMTutorial"}}},{"description":"Client Api Version.","in":"query","name":"api-version","required":true,"schema":{"type":"string"},"examples":{"Stop test job":{"value":"2018-06-30"}}}],"responses":{"200":{"description":"OK"},"default":{"description":"Automation error response describing why the operation failed.","content":{"application/json":{"schema":{"description":"Error response of an operation failure","properties":{"code":{"description":"Error code","type":"string"},"message":{"description":"Error message indicating why the operation failed.","type":"string"}},"type":"object"}}}}},"tags":["TestJob"]}},"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Automation/automationAccounts/{automationAccountName}/runbooks/{runbookName}/draft/testJob/streams":{"get":{"description":"Retrieve a list of test job streams identified by runbook name.","externalDocs":{"url":"http://aka.ms/azureautomationsdk/jobstreamoperations"},"operationId":"TestJobStreams_ListByTestJob","parameters":[{"description":"Gets subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call.","in":"path","name":"subscriptionId","required":true,"schema":{"type":"string"},"examples":{"List job streams by job name":{"value":"51766542-3ed7-4a72-a187-0c8ab644ddab"}}},{"description":"Name of an Azure Resource group.","in":"path","name":"resourceGroupName","required":true,"x-ms-parameter-location":"method","schema":{"type":"string","minLength":1,"maxLength":90,"pattern":"^[-\\w\\._]+$"},"examples":{"List job streams by job name":{"value":"mygroup"}}},{"description":"The name of the automation account.","in":"path","name":"automationAccountName","required":true,"x-ms-parameter-location":"method","schema":{"type":"string"},"examples":{"List job streams by job name":{"value":"ContoseAutomationAccount"}}},{"description":"The runbook name.","in":"path","name":"runbookName","required":true,"schema":{"type":"string"},"examples":{"List job streams by job name":{"value":"Get-AzureVMTutorial"}}},{"description":"The filter to apply on the operation.","in":"query","name":"$filter","required":false,"schema":{"type":"string"}},{"description":"Client Api Version.","in":"query","name":"api-version","required":true,"schema":{"type":"string"},"examples":{"List job streams by job name":{"value":"2018-06-30"}}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/JobStreamListResult"},"examples":{"List job streams by job name":{"$ref":"#/components/examples/List_job_streams_by_job_name"}}}}},"default":{"description":"Automation error response describing why the operation failed.","content":{"application/json":{"schema":{"description":"Error response of an operation failure","properties":{"code":{"description":"Error code","type":"string"},"message":{"description":"Error message indicating why the operation failed.","type":"string"}},"type":"object"}}}}},"tags":["TestJobStream"],"x-ms-pageable":{"nextLinkName":"nextLink"}}},"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Automation/automationAccounts/{automationAccountName}/runbooks/{runbookName}/draft/testJob/streams/{jobStreamId}":{"get":{"description":"Retrieve a test job stream of the test job identified by runbook name and stream id.","externalDocs":{"url":"http://aka.ms/azureautomationsdk/jobstreamoperations"},"operationId":"TestJobStreams_Get","parameters":[{"description":"Gets subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call.","in":"path","name":"subscriptionId","required":true,"schema":{"type":"string"},"examples":{"Get test job stream":{"value":"51766542-3ed7-4a72-a187-0c8ab644ddab"}}},{"description":"Name of an Azure Resource group.","in":"path","name":"resourceGroupName","required":true,"x-ms-parameter-location":"method","schema":{"type":"string","minLength":1,"maxLength":90,"pattern":"^[-\\w\\._]+$"},"examples":{"Get test job stream":{"value":"mygroup"}}},{"description":"The name of the automation account.","in":"path","name":"automationAccountName","required":true,"x-ms-parameter-location":"method","schema":{"type":"string"},"examples":{"Get test job stream":{"value":"ContoseAutomationAccount"}}},{"description":"The runbook name.","in":"path","name":"runbookName","required":true,"schema":{"type":"string"},"examples":{"Get test job stream":{"value":"Get-AzureVMTutorial"}}},{"description":"The job stream id.","in":"path","name":"jobStreamId","required":true,"schema":{"type":"string"},"examples":{"Get test job stream":{"value":"851b2101-686f-40e2-8a4b-5b8df08afbd1_00636535684910693884_00000000000000000001"}}},{"description":"Client Api Version.","in":"query","name":"api-version","required":true,"schema":{"type":"string"},"examples":{"Get test job stream":{"value":"2018-06-30"}}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/JobStream"},"examples":{"Get test job stream":{"$ref":"#/components/examples/Get_test_job_stream"}}}}},"default":{"description":"Automation error response describing why the operation failed.","content":{"application/json":{"schema":{"description":"Error response of an operation failure","properties":{"code":{"description":"Error code","type":"string"},"message":{"description":"Error message indicating why the operation failed.","type":"string"}},"type":"object"}}}}},"tags":["TestJobStream"]}},"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Automation/automationAccounts/{automationAccountName}/runbooks/{runbookName}/draft/testJob/suspend":{"post":{"description":"Suspend the test job.","externalDocs":{"url":"http://aka.ms/azureautomationsdk/testjoboperations"},"operationId":"TestJob_Suspend","parameters":[{"description":"Gets subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call.","in":"path","name":"subscriptionId","required":true,"schema":{"type":"string"},"examples":{"Suspend test job":{"value":"51766542-3ed7-4a72-a187-0c8ab644ddab"}}},{"description":"Name of an Azure Resource group.","in":"path","name":"resourceGroupName","required":true,"x-ms-parameter-location":"method","schema":{"type":"string","minLength":1,"maxLength":90,"pattern":"^[-\\w\\._]+$"},"examples":{"Suspend test job":{"value":"mygroup"}}},{"description":"The name of the automation account.","in":"path","name":"automationAccountName","required":true,"x-ms-parameter-location":"method","schema":{"type":"string"},"examples":{"Suspend test job":{"value":"ContoseAutomationAccount"}}},{"description":"The runbook name.","in":"path","name":"runbookName","required":true,"schema":{"type":"string"},"examples":{"Suspend test job":{"value":"Get-AzureVMTutorial"}}},{"description":"Client Api Version.","in":"query","name":"api-version","required":true,"schema":{"type":"string"},"examples":{"Suspend test job":{"value":"2018-06-30"}}}],"responses":{"200":{"description":"OK"},"default":{"description":"Automation error response describing why the operation failed.","content":{"application/json":{"schema":{"description":"Error response of an operation failure","properties":{"code":{"description":"Error code","type":"string"},"message":{"description":"Error message indicating why the operation failed.","type":"string"}},"type":"object"}}}}},"tags":["TestJob"]}},"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Automation/automationAccounts/{automationAccountName}/runbooks/{runbookName}/draft/undoEdit":{"post":{"description":"Undo draft edit to last known published state identified by runbook name.","externalDocs":{"url":"http://aka.ms/azureautomationsdk/runbookdraftoperations"},"operationId":"RunbookDraft_UndoEdit","parameters":[{"description":"Gets subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call.","in":"path","name":"subscriptionId","required":true,"schema":{"type":"string"},"examples":{"Undo draft edit to last known published state":{"value":"subid"}}},{"description":"Name of an Azure Resource group.","in":"path","name":"resourceGroupName","required":true,"x-ms-parameter-location":"method","schema":{"type":"string","minLength":1,"maxLength":90,"pattern":"^[-\\w\\._]+$"},"examples":{"Undo draft edit to last known published state":{"value":"rg"}}},{"description":"The name of the automation account.","in":"path","name":"automationAccountName","required":true,"x-ms-parameter-location":"method","schema":{"type":"string"},"examples":{"Undo draft edit to last known published state":{"value":"ContoseAutomationAccount"}}},{"description":"The runbook name.","in":"path","name":"runbookName","required":true,"schema":{"type":"string"},"examples":{"Undo draft edit to last known published state":{"value":"Get-AzureVMTutorial"}}},{"description":"Client Api Version.","in":"query","name":"api-version","required":true,"schema":{"type":"string"},"examples":{"Undo draft edit to last known published state":{"value":"2018-06-30"}}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunbookDraftUndoEditResult"}}}},"default":{"description":"Automation error response describing why the operation failed.","content":{"application/json":{"schema":{"description":"Error response of an operation failure","properties":{"code":{"description":"Error code","type":"string"},"message":{"description":"Error message indicating why the operation failed.","type":"string"}},"type":"object"}}}}},"tags":["RunbookDraft"]}},"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Automation/automationAccounts/{automationAccountName}/runbooks/{runbookName}/publish":{"post":{"description":"Publish runbook draft.","externalDocs":{"url":"http://aka.ms/azureautomationsdk/runbookdraftoperations"},"operationId":"Runbook_Publish","parameters":[{"description":"Gets subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call.","in":"path","name":"subscriptionId","required":true,"schema":{"type":"string"},"examples":{"Publish runbook draft":{"value":"subid"}}},{"description":"Name of an Azure Resource group.","in":"path","name":"resourceGroupName","required":true,"x-ms-parameter-location":"method","schema":{"type":"string","minLength":1,"maxLength":90,"pattern":"^[-\\w\\._]+$"},"examples":{"Publish runbook draft":{"value":"rg"}}},{"description":"The name of the automation account.","in":"path","name":"automationAccountName","required":true,"x-ms-parameter-location":"method","schema":{"type":"string"},"examples":{"Publish runbook draft":{"value":"ContoseAutomationAccount"}}},{"description":"The parameters supplied to the publish runbook operation.","in":"path","name":"runbookName","required":true,"schema":{"type":"string"},"examples":{"Publish runbook draft":{"value":"Get-AzureVMTutorial"}}},{"description":"Client Api Version.","in":"query","name":"api-version","required":true,"schema":{"type":"string"},"examples":{"Publish runbook draft":{"value":"2018-06-30"}}}],"responses":{"202":{"description":"Accepted and the operation will complete asynchronously.","headers":{"location":{"description":"URL to query for status of the operation.","schema":{"type":"string"}}}},"default":{"description":"Automation error response describing why the operation failed.","content":{"application/json":{"schema":{"description":"Error response of an operation failure","properties":{"code":{"description":"Error code","type":"string"},"message":{"description":"Error message indicating why the operation failed.","type":"string"}},"type":"object"}}}}},"tags":["Runbook"],"x-ms-long-running-operation":true}}},"servers":[{"url":"https://management.azure.com"}],"components":{"examples":{"List_runbooks_by_automation_account":{"value":{"value":[{"id":"/subscriptions/subid/resourceGroups/rg/providers/Microsoft.Automation/automationAccounts/ContoseAutomationAccount/runbooks/ASR-AddPublicIp","location":"East US 2","name":"ASR-AddPublicIp","properties":{"creationTime":"2017-03-28T21:32:25.78+00:00","lastModifiedTime":"2017-03-28T21:32:25.81+00:00","logActivityTrace":1,"logProgress":true,"logVerbose":true,"runbookType":"PowerShell","state":"Published"},"type":"Microsoft.Automation/AutomationAccounts/Runbooks"},{"id":"/subscriptions/subid/resourceGroups/rg/providers/Microsoft.Automation/automationAccounts/ContoseAutomationAccount/runbooks/AutoExport","location":"East US 2","name":"AutoExport","properties":{"creationTime":"2017-03-28T21:32:27.327+00:00","lastModifiedTime":"2017-03-28T21:32:27.327+00:00","logActivityTrace":1,"logProgress":true,"logVerbose":true,"runbookType":"PowerShell","state":"Published"},"type":"Microsoft.Automation/AutomationAccounts/Runbooks"},{"id":"/subscriptions/subid/resourceGroups/rg/providers/Microsoft.Automation/automationAccounts/ContoseAutomationAccount/runbooks/Get-AzureVMTutorial","location":"East US 2","name":"Get-AzureVMTutorial","properties":{"creationTime":"2017-03-28T21:32:23.75+00:00","lastModifiedTime":"2017-03-28T21:32:23.75+00:00","logActivityTrace":1,"logProgress":true,"logVerbose":false,"runbookType":"PowerShellWorkflow","state":"Published"},"type":"Microsoft.Automation/AutomationAccounts/Runbooks"}]}},"Get_runbook":{"value":{"etag":"\"636263335437500000\"","id":"/subscriptions/subid/resourceGroups/rg/providers/Microsoft.Automation/automationAccounts/ContoseAutomationAccount/runbooks/Get-AzureVMTutorial","location":"East US 2","name":"Get-AzureVMTutorial","properties":{"creationTime":"2017-03-28T21:32:23.75+00:00","description":"Description of the Runbook","jobCount":0,"lastModifiedBy":"myEmaild@microsoft.com","lastModifiedTime":"2017-03-28T21:32:23.75+00:00","logActivityTrace":1,"logProgress":true,"logVerbose":false,"outputTypes":[],"parameters":{},"provisioningState":"Succeeded","runbookType":"PowerShellWorkflow","state":"Published"},"tags":{"tag01":"value01","tag02":"value02"},"type":"Microsoft.Automation/AutomationAccounts/Runbooks"}},"Create_or_update_runbook_and_publish_it":{"value":{"etag":"\"636263318837230000\"","id":"/subscriptions/subid/resourceGroups/rg/providers/Microsoft.Automation/automationAccounts/ContoseAutomationAccount/runbooks/Get-AzureVMTutorial","location":"East US 2","name":"Get-AzureVMTutorial","properties":{"creationTime":"2017-03-28T21:04:43.66+00:00","description":"Description of the Runbook","jobCount":0,"lastModifiedBy":"myEmaild@microsoft.com","lastModifiedTime":"2017-03-28T21:04:43.723+00:00","logActivityTrace":1,"logProgress":true,"logVerbose":false,"outputTypes":[],"parameters":{},"provisioningState":"Succeeded","runbookType":"PowerShellWorkflow","state":"Published"},"tags":{"tag01":"value01","tag02":"value02"},"type":"Microsoft.Automation/AutomationAccounts/Runbooks"}},"Create_runbook_as_draft":{"value":{"etag":"\"636263318837230000\"","id":"/subscriptions/subid/resourceGroups/rg/providers/Microsoft.Automation/automationAccounts/ContoseAutomationAccount/runbooks/Get-AzureVMTutorial","location":"East US 2","name":"Get-AzureVMTutorial","properties":{"creationTime":"2018-02-09T03:25:59.097+00:00","description":"Description of the Runbook","jobCount":0,"lastModifiedTime":"2018-02-09T03:25:59.097+00:00","logActivityTrace":0,"logProgress":false,"logVerbose":false,"outputTypes":[],"parameters":{},"provisioningState":"Succeeded","runbookType":"Script","state":"New"},"tags":{"tag01":"value01","tag02":"value02"},"type":"Microsoft.Automation/AutomationAccounts/Runbooks"}},"Get_runbook_content":{"value":"<#\r\n .DESCRIPTION\r\n An example runbook which prints out the first10 Azure VMs in your subscription (ordered alphabetically).\r\n For more information about how this runbook authenticates to your Azure subscription, see our documentation here: http: //aka.ms/fxu3mn\r\n\r\n .NOTES\r\n AUTHOR: Azure Automation Team\r\n LASTEDIT: Mar27,\r\n 2015\r\n#>\r\nworkflow Get-AzureVMTutorial{\r\n #The name of the Automation Credential Asset this runbook will use to authenticate to Azure.\r\n $CredentialAssetName = 'DefaultAzureCredential'\r\n\r\n #Get the credential with the above name from the Automation Asset store\r\n $Cred = Get-AutomationPSCredential -Name $CredentialAssetName\r\n if(!$Cred){\r\n Throw\"Could not find an Automation Credential Asset named '${CredentialAssetName}'. Make sure you have created one in this Automation Account.\"\r\n }\r\n\r\n #Connect to your Azure Account\r\n $Account = Add-AzureAccount -Credential $Cred\r\n if(!$Account){\r\n Throw\"Could not authenticate to Azure using the credential asset '${CredentialAssetName}'. Make sure the user name and password are correct.\"\r\n }\r\n\r\n #TODO (optional): pick the right subscription to use. Without this line, the default subscription for your Azure Account will be used.\r\n #Select-AzureSubscription -SubscriptionName\"TODO: your Azure subscription name here\"\r\n \r\n #Get all the VMs you have in your Azure subscription\r\n $VMs = Get-AzureVM\r\n\r\n #Print out up to10 of those VMs\r\n if(!$VMs){\r\n Write-Output\"No VMs were found in your subscription.\"\r\n } else{\r\n Write-Output $VMs[0..9\r\n ]\r\n }\r\n }"},"Get_runbook_draft":{"value":{"creationTime":"2018-02-09T03:25:59.11+00:00","inEdit":true,"lastModifiedTime":"2018-02-09T04:48:56.43+00:00","outputTypes":[],"parameters":{}}},"Get_runbook_draft_content":{"value":"<#\r\n .DESCRIPTION\r\n An example runbook which prints out the first10 Azure VMs in your subscription (ordered alphabetically).\r\n For more information about how this runbook authenticates to your Azure subscription, see our documentation here: http: //aka.ms/fxu3mn\r\n\r\n .NOTES\r\n AUTHOR: Azure Automation Team\r\n LASTEDIT: Mar27,\r\n 2015\r\n#>\r\nworkflow Get-AzureVMTutorial{\r\n #The name of the Automation Credential Asset this runbook will use to authenticate to Azure.\r\n $CredentialAssetName = 'DefaultAzureCredential'\r\n\r\n #Get the credential with the above name from the Automation Asset store\r\n $Cred = Get-AutomationPSCredential -Name $CredentialAssetName\r\n if(!$Cred){\r\n Throw\"Could not find an Automation Credential Asset named '${CredentialAssetName}'. Make sure you have created one in this Automation Account.\"\r\n }\r\n\r\n #Connect to your Azure Account\r\n $Account = Add-AzureAccount -Credential $Cred\r\n if(!$Account){\r\n Throw\"Could not authenticate to Azure using the credential asset '${CredentialAssetName}'. Make sure the user name and password are correct.\"\r\n }\r\n\r\n #TODO (optional): pick the right subscription to use. Without this line, the default subscription for your Azure Account will be used.\r\n #Select-AzureSubscription -SubscriptionName\"TODO: your Azure subscription name here\"\r\n \r\n #Get all the VMs you have in your Azure subscription\r\n $VMs = Get-AzureVM\r\n\r\n #Print out up to10 of those VMs\r\n if(!$VMs){\r\n Write-Output\"No VMs were found in your subscription.\"\r\n } else{\r\n Write-Output $VMs[0..9\r\n ]\r\n }\r\n }"},"Create_or_update_runbook_draft":{"value":{}},"Get_test_job":{"value":{"creationTime":"2018-02-09T05:52:00.9344172+00:00","endTime":"2018-02-09T05:55:16.7827254+00:00","lastModifiedTime":"2018-02-09T05:55:16.7827254+00:00","lastStatusModifiedTime":"2018-02-09T05:55:16.7827254+00:00","parameters":{},"startTime":"2018-02-09T05:55:10.8344743+00:00","status":"Completed","statusDetails":"None"}},"Create_test_job":{"value":{"creationTime":"2018-02-09T05:51:59.82+00:00","lastModifiedTime":"2018-02-09T05:51:59.82+00:00","lastStatusModifiedTime":"2018-02-09T05:51:59.82+00:00","parameters":{},"status":"New","statusDetails":"None"}},"List_job_streams_by_job_name":{"value":{"value":[{"id":"/subscriptions/51766542-3ed7-4a72-a187-0c8ab644ddab/resourcegroups/mygroup/providers/Microsoft.Automation/automationAccounts/ContoseAutomationAccount/jobs/jobName/streams/24456a8a-2857-4af6-932c-3455f38bd05e_00636535675981232703_00000000000000000001","properties":{"jobStreamId":"24456a8a-2857-4af6-932c-3455f38bd05e_00636535675981232703_00000000000000000001","streamType":"Output","time":"2018-02-07T02:33:18.1232703+00:00"}},{"id":"/subscriptions/51766542-3ed7-4a72-a187-0c8ab644ddab/resourcegroups/mygroup/providers/Microsoft.Automation/automationAccounts/ContoseAutomationAccount/jobs/jobName/streams/24456a8a-2857-4af6-932c-3455f38bd05e_00636535675984691350_00000000000000000002","properties":{"jobStreamId":"24456a8a-2857-4af6-932c-3455f38bd05e_00636535675984691350_00000000000000000002","streamType":"Output","time":"2018-02-07T02:33:18.469135+00:00"}}]}},"Get_test_job_stream":{"value":{"id":"/subscriptions/51766542-3ed7-4a72-a187-0c8ab644ddab/resourcegroups/mygroup/providers/Microsoft.Automation/automationAccounts/ContoseAutomationAccount/runbooks/foo/draft/testJob/streams/851b2101-686f-40e2-8a4b-5b8df08afbd1_00636535684910693884_00000000000000000001","properties":{"jobStreamId":"851b2101-686f-40e2-8a4b-5b8df08afbd1:00636535684910693884:00000000000000000001","streamText":"","streamType":"Output","time":"2018-02-07T02:48:11.0693884+00:00","value":{}}}}},"securitySchemes":{"azure_auth":{"description":"Azure Active Directory OAuth2 Flow","type":"oauth2