{ "swagger": "2.0", "info": { "title": "AutomationManagement", "version": "2015-10-31" }, "host": "management.azure.com", "schemes": [ "https" ], "consumes": [ "application/json" ], "produces": [ "application/json" ], "security": [ { "azure_auth": [ "user_impersonation" ] } ], "securityDefinitions": { "azure_auth": { "type": "oauth2", "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", "flow": "implicit", "description": "Azure Active Directory OAuth2 Flow", "scopes": { "user_impersonation": "impersonate your user account" } } }, "paths": { "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Automation/automationAccounts/{automationAccountName}": { "patch": { "tags": [ "AutomationAccount" ], "operationId": "AutomationAccount_Update", "description": "Update an automation account.", "externalDocs": { "url": "http://aka.ms/azureautomationsdk/automationaccountoperations" }, "x-ms-examples": { "Update an automation account": { "$ref": "./examples/updateAutomationAccount.json" } }, "parameters": [ { "name": "resourceGroupName", "in": "path", "required": true, "type": "string", "pattern": "^[-\\w\\._]+$", "description": "The resource group name." }, { "name": "automationAccountName", "in": "path", "required": true, "type": "string", "description": "Automation account name." }, { "name": "parameters", "in": "body", "required": true, "schema": { "$ref": "./definitions.json#/definitions/AutomationAccountUpdateParameters" }, "description": "Parameters supplied to the update automation account." }, { "$ref": "./definitions.json#/parameters/SubscriptionIdParameter" }, { "$ref": "./definitions.json#/parameters/ApiVersionParameter" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "./definitions.json#/definitions/AutomationAccount" } }, "default": { "description": "Automation error response describing why the operation failed.", "schema": { "$ref": "./definitions.json#/definitions/ErrorResponse" } } } }, "put": { "tags": [ "AutomationAccount" ], "operationId": "AutomationAccount_CreateOrUpdate", "description": "Create or update automation account.", "externalDocs": { "url": "http://aka.ms/azureautomationsdk/automationaccountoperations" }, "x-ms-examples": { "Create or update automation account": { "$ref": "./examples/createOrUpdateAutomationAccount.json" } }, "parameters": [ { "name": "resourceGroupName", "in": "path", "required": true, "type": "string", "pattern": "^[-\\w\\._]+$", "description": "The resource group name." }, { "name": "automationAccountName", "in": "path", "required": true, "type": "string", "description": "Parameters supplied to the create or update automation account." }, { "name": "parameters", "in": "body", "required": true, "schema": { "$ref": "./definitions.json#/definitions/AutomationAccountCreateOrUpdateParameters" }, "description": "Parameters supplied to the create or update automation account." }, { "$ref": "./definitions.json#/parameters/SubscriptionIdParameter" }, { "$ref": "./definitions.json#/parameters/ApiVersionParameter" } ], "responses": { "201": { "description": "Created", "schema": { "$ref": "./definitions.json#/definitions/AutomationAccount" } }, "200": { "description": "OK", "schema": { "$ref": "./definitions.json#/definitions/AutomationAccount" } }, "default": { "description": "Automation error response describing why the operation failed.", "schema": { "$ref": "./definitions.json#/definitions/ErrorResponse" } } } }, "delete": { "tags": [ "AutomationAccount" ], "operationId": "AutomationAccount_Delete", "description": "Delete an automation account.", "externalDocs": { "url": "http://aka.ms/azureautomationsdk/automationaccountoperations" }, "x-ms-examples": { "Delete automation account": { "$ref": "./examples/deleteAutomationAccount.json" } }, "parameters": [ { "name": "resourceGroupName", "in": "path", "required": true, "type": "string", "pattern": "^[-\\w\\._]+$", "description": "The resource group name." }, { "name": "automationAccountName", "in": "path", "required": true, "type": "string", "description": "Automation account name." }, { "$ref": "./definitions.json#/parameters/SubscriptionIdParameter" }, { "$ref": "./definitions.json#/parameters/ApiVersionParameter" } ], "responses": { "200": { "description": "OK" }, "204": { "description": "No Content" }, "default": { "description": "Automation error response describing why the operation failed.", "schema": { "$ref": "./definitions.json#/definitions/ErrorResponse" } } } }, "get": { "tags": [ "AutomationAccount" ], "operationId": "AutomationAccount_Get", "description": "Get information about an Automation Account.", "externalDocs": { "url": "http://aka.ms/azureautomationsdk/automationaccountoperations" }, "x-ms-examples": { "Get automation account": { "$ref": "./examples/getAutomationAccount.json" } }, "parameters": [ { "name": "resourceGroupName", "in": "path", "required": true, "type": "string", "pattern": "^[-\\w\\._]+$", "description": "The resource group name." }, { "name": "automationAccountName", "in": "path", "required": true, "type": "string", "description": "The automation account name." }, { "$ref": "./definitions.json#/parameters/SubscriptionIdParameter" }, { "$ref": "./definitions.json#/parameters/ApiVersionParameter" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "./definitions.json#/definitions/AutomationAccount" } }, "default": { "description": "Automation error response describing why the operation failed.", "schema": { "$ref": "./definitions.json#/definitions/ErrorResponse" } } } } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Automation/automationAccounts": { "get": { "tags": [ "AutomationAccount" ], "operationId": "AutomationAccount_ListByResourceGroup", "description": "Retrieve a list of accounts within a given resource group.", "externalDocs": { "url": "http://aka.ms/azureautomationsdk/automationaccountoperations" }, "x-ms-examples": { "List automation accounts by resource group": { "$ref": "./examples/listAutomationAccountsByResourceGroup.json" } }, "parameters": [ { "name": "resourceGroupName", "in": "path", "required": true, "type": "string", "pattern": "^[-\\w\\._]+$", "description": "The resource group name." }, { "$ref": "./definitions.json#/parameters/SubscriptionIdParameter" }, { "$ref": "./definitions.json#/parameters/ApiVersionParameter" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "./definitions.json#/definitions/AutomationAccountListResult" } }, "default": { "description": "Automation error response describing why the operation failed.", "schema": { "$ref": "./definitions.json#/definitions/ErrorResponse" } } }, "x-ms-pageable": { "nextLinkName": "nextLink" } } }, "/providers/Microsoft.Automation/operations": { "get": { "tags": [ "Operations" ], "description": "Lists all of the available Automation REST API operations.", "operationId": "Operations_List", "parameters": [ { "$ref": "./definitions.json#/parameters/ApiVersionParameter" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "./definitions.json#/definitions/OperationListResult" } }, "default": { "description": "Automation error response describing why the operation failed.", "schema": { "$ref": "./definitions.json#/definitions/ErrorResponse" } } }, "x-ms-pageable": { "nextLinkName": null } } }, "/subscriptions/{subscriptionId}/providers/Microsoft.Automation/automationAccounts": { "get": { "tags": [ "AutomationAccount" ], "summary": "Lists the Automation Accounts within an Azure subscription.", "operationId": "AutomationAccount_List", "description": "Retrieve a list of accounts within a given subscription.", "x-ms-examples": { "List automation accounts by resource group": { "$ref": "./examples/listAutomationAccountsBySubscription.json" } }, "parameters": [ { "$ref": "./definitions.json#/parameters/SubscriptionIdParameter" }, { "$ref": "./definitions.json#/parameters/ApiVersionParameter" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "./definitions.json#/definitions/AutomationAccountListResult" } }, "default": { "description": "Error response describing why the operation failed.", "schema": { "$ref": "./definitions.json#/definitions/ErrorResponse" } } }, "x-ms-pageable": { "nextLinkName": "nextLink" } } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Automation/automationAccounts/{automationAccountName}/statistics": { "get": { "tags": [ "Statistics" ], "operationId": "Statistics_ListByAutomationAccount", "description": "Retrieve the statistics for the account.", "externalDocs": { "url": "http://aka.ms/azureautomationsdk/statisticsoperations" }, "x-ms-examples": { "Get statistics of an automation account": { "$ref": "./examples/getStatisticsOfAutomationAccount.json" } }, "parameters": [ { "name": "resourceGroupName", "in": "path", "required": true, "type": "string", "pattern": "^[-\\w\\._]+$", "description": "The resource group name." }, { "name": "automationAccountName", "in": "path", "required": true, "type": "string", "description": "The automation account name." }, { "name": "$filter", "in": "query", "required": false, "type": "string", "description": "The filter to apply on the operation." }, { "$ref": "./definitions.json#/parameters/SubscriptionIdParameter" }, { "$ref": "./definitions.json#/parameters/ApiVersionParameter" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "./definitions.json#/definitions/StatisticsListResult" } }, "default": { "description": "Error response describing why the operation failed.", "schema": { "$ref": "./definitions.json#/definitions/ErrorResponse" } } }, "x-ms-pageable": { "nextLinkName": null } } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Automation/automationAccounts/{automationAccountName}/usages": { "get": { "tags": [ "Usages" ], "operationId": "Usages_ListByAutomationAccount", "description": "Retrieve the usage for the account id.", "externalDocs": { "url": "http://aka.ms/azureautomationsdk/usageoperations" }, "x-ms-examples": { "Get usages of an automation account": { "$ref": "./examples/getUsagesOfAutomationAccount.json" } }, "parameters": [ { "name": "resourceGroupName", "in": "path", "required": true, "type": "string", "pattern": "^[-\\w\\._]+$", "description": "The resource group name." }, { "name": "automationAccountName", "in": "path", "required": true, "type": "string", "description": "The automation account name." }, { "$ref": "./definitions.json#/parameters/SubscriptionIdParameter" }, { "$ref": "./definitions.json#/parameters/ApiVersionParameter" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "./definitions.json#/definitions/UsageListResult" } }, "default": { "description": "Error response describing why the operation failed.", "schema": { "$ref": "./definitions.json#/definitions/ErrorResponse" } } }, "x-ms-pageable": { "nextLinkName": null } } } }, "definitions": {}, "parameters": {} }