openapi-directory/api/azure.com/automation-watcher.json

Building & bundling https://github.com/APIs-guru/openapi-directory for easy use from JS

{"openapi":"3.0.0","info":{"title":"AutomationManagement","version":"2015-10-31","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/2015-10-31/watcher.json","version":"2.0"}],"x-providerName":"azure.com","x-serviceName":"automation-watcher","x-tags":["Azure","Microsoft"]},"security":[{"azure_auth":["user_impersonation"]}],"paths":{"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Automation/automationAccounts/{automationAccountName}/watchers":{"get":{"description":"Retrieve a list of watchers.","externalDocs":{"url":"http://aka.ms/azureautomationsdk/watcheroperations"},"operationId":"Watcher_ListByAutomationAccount","parameters":[{"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 watchers 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 watchers by Automation Account":{"value":"MyTestAutomationAccount"}}},{"description":"The filter to apply on the operation.","in":"query","name":"$filter","required":false,"schema":{"type":"string"}},{"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 watchers by Automation Account":{"value":"subid"}}},{"description":"Client Api Version.","in":"query","name":"api-version","required":true,"schema":{"type":"string"},"examples":{"List watchers by Automation Account":{"value":"2015-10-31"}}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/WatcherListResult"},"examples":{"List watchers by Automation Account":{"$ref":"#/components/examples/List_watchers_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":["Watcher"],"x-ms-odata":"#/components/schemas/Watcher","x-ms-pageable":{"nextLinkName":"nextLink"}}},"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Automation/automationAccounts/{automationAccountName}/watchers/{watcherName}":{"delete":{"description":"Delete the watcher by name.","externalDocs":{"url":"http://aka.ms/azureautomationsdk/watcheroperations"},"operationId":"Watcher_Delete","parameters":[{"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 watcher":{"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 watcher":{"value":"MyTestAutomationAccount"}}},{"description":"The watcher name.","in":"path","name":"watcherName","required":true,"schema":{"type":"string"},"examples":{"Delete watcher":{"value":"MyTestWatcher"}}},{"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 watcher":{"value":"subid"}}},{"description":"Client Api Version.","in":"query","name":"api-version","required":true,"schema":{"type":"string"},"examples":{"Delete watcher":{"value":"2015-10-31"}}}],"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":["Watcher"]},"get":{"description":"Retrieve the watcher identified by watcher name.","externalDocs":{"url":"http://aka.ms/azureautomationsdk/watcheroperations"},"operationId":"Watcher_Get","parameters":[{"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 watcher":{"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 watcher":{"value":"MyTestAutomationAccount"}}},{"description":"The watcher name.","in":"path","name":"watcherName","required":true,"schema":{"type":"string"},"examples":{"Get watcher":{"value":"MyTestWatcher"}}},{"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 watcher":{"value":"subid"}}},{"description":"Client Api Version.","in":"query","name":"api-version","required":true,"schema":{"type":"string"},"examples":{"Get watcher":{"value":"2015-10-31"}}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Watcher"},"examples":{"Get watcher":{"$ref":"#/components/examples/Get_watcher"}}}}},"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":["Watcher"]},"patch":{"description":"Update the watcher identified by watcher name.","externalDocs":{"url":"http://aka.ms/azureautomationsdk/watcheroperations"},"operationId":"Watcher_Update","parameters":[{"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 watcher":{"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 watcher":{"value":"MyTestAutomationAccount"}}},{"description":"The watcher name.","in":"path","name":"watcherName","required":true,"schema":{"type":"string"},"examples":{"Update watcher":{"value":"MyTestWatcher"}}},{"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 watcher":{"value":"subid"}}},{"description":"Client Api Version.","in":"query","name":"api-version","required":true,"schema":{"type":"string"},"examples":{"Update watcher":{"value":"2015-10-31"}}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/WatcherUpdateParameters"}}},"description":"The update parameters for watcher.","required":true},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Watcher"},"examples":{"Update watcher":{"$ref":"#/components/examples/Update_watcher"}}}}},"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":["Watcher"]},"put":{"description":"Create the watcher identified by watcher name.","externalDocs":{"url":"http://aka.ms/azureautomationsdk/watcheroperations"},"operationId":"Watcher_CreateOrUpdate","parameters":[{"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 watcher":{"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 watcher":{"value":"MyTestAutomationAccount"}}},{"description":"The watcher name.","in":"path","name":"watcherName","required":true,"schema":{"type":"string"},"examples":{"Create or update watcher":{"value":"MyTestWatcher"}}},{"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 watcher":{"value":"subid"}}},{"description":"Client Api Version.","in":"query","name":"api-version","required":true,"schema":{"type":"string"},"examples":{"Create or update watcher":{"value":"2015-10-31"}}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Watcher"}}},"description":"The create or update parameters for watcher.","required":true},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Watcher"},"examples":{"Create or update watcher":{"$ref":"#/components/examples/Create_or_update_watcher"}}}}},"201":{"description":"Created","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Watcher"},"examples":{"Create or update watcher":{"$ref":"#/components/examples/Create_or_update_watcher"}}}}},"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":["Watcher"]}},"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Automation/automationAccounts/{automationAccountName}/watchers/{watcherName}/start":{"post":{"description":"Resume the watcher identified by watcher name.","externalDocs":{"url":"http://aka.ms/azureautomationsdk/watcheroperations"},"operationId":"Watcher_Start","parameters":[{"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":{"Start Watcher":{"value":"rg"}}},{"description":"The name of the automation account.","in":"path","name":"automationAccountName","required":true,"x-ms-parameter-location":"method","schema":{"type":"string"},"examples":{"Start Watcher":{"value":"MyTestAutomationAccount"}}},{"description":"The watcher name.","in":"path","name":"watcherName","required":true,"schema":{"type":"string"},"examples":{"Start Watcher":{"value":"MyTestWatcher"}}},{"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":{"Start Watcher":{"value":"subid"}}},{"description":"Client Api Version.","in":"query","name":"api-version","required":true,"schema":{"type":"string"},"examples":{"Start Watcher":{"value":"2015-10-31"}}}],"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":["Watcher"]}},"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Automation/automationAccounts/{automationAccountName}/watchers/{watcherName}/stop":{"post":{"description":"Resume the watcher identified by watcher name.","externalDocs":{"url":"http://aka.ms/azureautomationsdk/watcheroperations"},"operationId":"Watcher_Stop","parameters":[{"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":{"Start Watcher":{"value":"rg"}}},{"description":"The name of the automation account.","in":"path","name":"automationAccountName","required":true,"x-ms-parameter-location":"method","schema":{"type":"string"},"examples":{"Start Watcher":{"value":"MyTestAutomationAccount"}}},{"description":"The watcher name.","in":"path","name":"watcherName","required":true,"schema":{"type":"string"},"examples":{"Start Watcher":{"value":"MyTestWatcher"}}},{"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":{"Start Watcher":{"value":"subid"}}},{"description":"Client Api Version.","in":"query","name":"api-version","required":true,"schema":{"type":"string"},"examples":{"Start Watcher":{"value":"2018-01-15"}}}],"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":["Watcher"]}}},"servers":[{"url":"https://management.azure.com"}],"components":{"examples":{"List_watchers_by_Automation_Account":{"value":{"value":[{"id":"/subscriptions/subid/resourceGroups/rg/providers/Microsoft.Automation/automationAccounts/MyTestAutomationAccount/watchers/MyTestWatcher","name":"MyTestWatcher","properties":{"creationTime":"2016-12-20T21:36:48.597+00:00","description":"This is a test watcher.","executionFrequencyInSeconds":60,"lastModifiedTime":"2016-12-20T21:36:48.597+00:00","scriptName":"MyTestWatcher","scriptRunOn":"MyTestHybridWorkerGroup"}},{"id":"/subscriptions/subid/resourceGroups/rg/providers/Microsoft.Automation/automationAccounts/MyTestAutomationAccount/watchers/MyTestWatcher01","name":"MyTestWatcher01","properties":{"creationTime":"2016-12-20T20:47:24.697+00:00","description":"This is a test watcher.","executionFrequencyInSeconds":60,"lastModifiedTime":"2016-12-20T20:47:24.697+00:00","scriptName":"MyTestWatcher","scriptRunOn":"MyTestHybridWorkerGroup"}},{"id":"/subscriptions/subid/resourceGroups/rg/providers/Microsoft.Automation/automationAccounts/MyTestAutomationAccount/watchers/MyTestWatcher02","name":"MyTestWatcher02","properties":{"creationTime":"2016-12-20T21:26:35.647+00:00","description":"This is a test watcher.","executionFrequencyInSeconds":60,"lastModifiedTime":"2016-12-20T21:26:35.647+00:00","scriptName":"MyTestWatcher","scriptRunOn":"MyTestHybridWorkerGroup"}}]}},"Get_watcher":{"value":{"id":"/subscriptions/subId/resourceGroups/rg/providers/Microsoft.Automation/automationAccounts/MyTestAutomationAccount/watchers/MyTestWatcher","name":"MyTestWatcher","properties":{"creationTime":"2017-11-30T18:50:17.163+00:00","description":"","executionFrequencyInSeconds":60,"lastModifiedTime":"2017-11-30T18:50:17.163+00:00","scriptName":"MyTestWatcherRunbook","scriptParameters":{},"scriptRunOn":"MyTestHybridWorkerGroup","status":"Running"},"tags":{}}},"Update_watcher":{"value":{"id":"/subscriptions/subId/resourceGroups/rg/providers/Microsoft.Automation/automationAccounts/MyTestAutomationAccount/watchers/MyTestWatcher","name":"MyTestWatcher","properties":{"creationTime":"2018-05-14T21:33:02.197+00:00","description":"This is a test watcher.","executionFrequencyInSeconds":600,"lastModifiedTime":"2018-05-14T22:29:57.65+00:00","scriptName":"MyTestWatcherRunbook","scriptParameters":{},"scriptRunOn":"MyTestHybridWorkerGroup","status":"New"},"tags":{}}},"Create_or_update_watcher":{"value":{"id":"/subscriptions/subId/resourceGroups/rg/providers/Microsoft.Automation/automationAccounts/MyTestAutomationAccount/watchers/MyTestWatcher","name":"MyTestWatcher","properties":{"creationTime":"2018-05-14T21:14:09.607+00:00","description":"This is a test watcher.","executionFrequencyInSeconds":60,"lastModifiedTime":"2018-05-14T21:14:09.607+00:00","scriptName":"MyTestWatcherRunbook","scriptRunOn":"MyTestHybridWorkerGroup","status":"New"},"tags":{}}}},"securitySchemes":{"azure_auth":{"description":"Azure Active Directory OAuth2 Flow","type":"oauth2","flows":{"implicit":{"authorizationUrl":"https://login.microsoftonline.com/common/oauth2/authorize","scopes":{"user_impersonation":"impersonate your user account"}}}}},"schemas":{"Watcher":{"allOf":[{"allOf":[{"description":"The core properties of ARM resources","properties":{"id":{"description":"Fully qualified resource Id for the resource","readOnly":true,"type":"string"},"name":{"description":"The name of the resource","readOnly":true,"type":"string"},"type":{"description":"The type of the resource.","readOnly":true,"type":"string"}},"type":"object","x-ms-azure-resource":true}],"description":"The resource model definition for a ARM tracked top level resource","properties":{"location":{"description":"The Azure Region where the resource lives","type":"string","x-ms-mutability":["read","create"]},"tags":{"additionalProperties":{"type":"string"},"description":"Resource tags.","type":"object","x-ms-mutability":["read","create","update"]}},"type":"object"}],"description":"Definition of the watcher type.","properties":{"etag":{"description":"Gets or sets the etag of the resource.","type":"string"},"properties":{"$ref":"#/components/schemas/WatcherProperties"}}},"WatcherListResult":{"description":"The response model for the list watcher operation.","properties":{"nextLink":{"description":"Gets or sets the next link.","type":"string"},"value":{"description":"Gets or sets a list of watchers.","items":{"$ref":"#/components/schemas/Watcher"},"type":"array"}}},"WatcherProperties":{"description":"Definition of the watcher properties","properties":{"creationTime":{"description":"Gets or sets the creation time.","format":"date-time","readOnly":true,"type":"string","nullable":false},"description":{"description":"Gets or sets the description.","type":"string"},"executionFrequencyInSeconds":{"description":"Gets or sets the frequency at which the watcher is invoked.","format":"int64","type":"integer"},"lastModifiedBy":{"description":"Details of the user who last modified the watcher.","readOnly":true,"type":"string"},"lastModifiedTime":{"description":"Gets or sets the last modified time.","format":"date-time","readOnly":true,"type":"string","nullable":false},"scriptName":{"description":"Gets or sets the name of the script the watcher is attached to, i.e. the name of an existing runbook.","type":"string"},"scriptParameters":{"additionalProperties":{"type":"string"},"description":"Gets or sets the parameters of the script.","type":"object"},"scriptRunOn":{"description":"Gets or sets the name of the hybrid worker group the watcher will run on.","type":"string"},"status":{"description":"Gets the current status of the watcher.","readOnly":true,"type":"string"}}},"WatcherUpdateParameters":{"properties":{"name":{"description":"Gets or sets the name of the resource.","type":"string"},"properties":{"$ref":"#/components/schemas/WatcherUpdateProperties"}}},"WatcherUpdateProperties":{"description":"The properties of the update watcher operation.","properties":{"executionFrequencyInSeconds":{"description":"Gets or sets the frequency at which the watcher is invoked.","format":"int64","type":"integer"}}}}}}