AutomationManagement
Connect to AutomationManagement with 1 MCP tools for AI-powered API automation.
COMMUNITYBEARER0 INSTALLS
OpenAPI Specificationv3.0
{
"swagger": "2.0",
"schemes": [
"https"
],
"host": "management.azure.com",
"info": {
"title": "AutomationManagement",
"version": "2015-10-31",
"x-apisguru-categories": [
"cloud"
],
"x-logo": {
"url": "https://api.apis.guru/v2/cache/logo/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/jobSchedule.json",
"version": "2.0"
}
],
"x-providerName": "azure.com",
"x-serviceName": "automation-jobSchedule",
"x-tags": [
"Azure",
"Microsoft"
]
},
"consumes": [
"application/json"
],
"produces": [
"application/json"
],
"securityDefinitions": {
"azure_auth": {
"authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize",
"description": "Azure Active Directory OAuth2 Flow",
"flow": "implicit",
"scopes": {
"user_impersonation": "impersonate your user account"
},
"type": "oauth2"
}
},
"security": [
{
"azure_auth": [
"user_impersonation"
]
}
],
"parameters": {},
"paths": {
"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Automation/automationAccounts/{automationAccountName}/jobSchedules": {
"get": {
"description": "Retrieve a list of job schedules.",
"externalDocs": {
"url": "http://aka.ms/azureautomationsdk/jobscheduleoperations"
},
"operationId": "JobSchedule_ListByAutomationAccount",
"parameters": [
{
"description": "Name of an Azure Resource group.",
"in": "path",
"maxLength": 90,
"minLength": 1,
"name": "resourceGroupName",
"pattern": "^[-\\w\\._]+$",
"required": true,
"type": "string",
"x-ms-parameter-location": "method"
},
{
"description": "The name of the automation account.",
"in": "path",
"name": "automationAccountName",
"required": true,
"type": "string",
"x-ms-parameter-location": "method"
},
{
"description": "The filter to apply on the operation.",
"in": "query",
"name": "$filter",
"required": false,
"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,
"type": "string"
},
{
"description": "Client Api Version.",
"in": "query",
"name": "api-version",
"required": true,
"type": "string"
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#/definitions/JobScheduleListResult"
}
},
"default": {
"description": "Automation error response describing why the operation failed.",
"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": [
"JobSchedule"
],
"x-ms-examples": {
"List all job schedules by automation account": {
"parameters": {
"api-version": "2015-10-31",
"automationAccountName": "ContoseAutomationAccount",
"resourceGroupName": "rg",
"subscriptionId": "subid"
},
"responses": {
"200": {
"body": {
"value": [
{
"id": "/subscriptions/subid/resourceGroups/rg/providers/Microsoft.Automation/automationAccounts/ContoseAutomationAccount/jobSchedules/2f4d8f35-ecd5-44ee-a019-2382fec58fb7",
"properties": {
"jobScheduleId": "2f4d8f35-ecd5-44ee-a019-2382fec58fb7",
"parameters": null,
"runOn": null,
"runbook": {
"name": "TestRunbook"
},
"schedule": {
"name": "JobScheduleforTestRunbook"
}
}
},
{
"id": "/subscriptions/subid/resourceGroups/rg/providers/Microsoft.Automation/automationAccounts/ContoseAutomationAccount/jobSchedules/446f7a33-86ff-45a1-b71c-f998f701b443",
"properties": {
"jobScheduleId": "446f7a33-86ff-45a1-b71c-f998f701b443",
"parameters": null,
"runOn": null,
"runbook": {
"name": "TestRunbook"
},
"schedule": {
"name": "TestSchedule"
}
}
},
{
"id": "/subscriptions/subid/resourceGroups/rg/providers/Microsoft.Automation/automationAccounts/ContoseAutomationAccount/jobSchedules/0fa462ba-3aa2-4138-83ca-9ebc3bc55cdc",
"properties": {
"jobScheduleId": "0fa462ba-3aa2-4138-83ca-9ebc3bc55cdc",
"parameters": null,
"runOn": null,
"runbook": {
"name": "TestRunbook"
},
"schedule": {
"name": "ScheduleNameGoesHere332204b5-debe-4348-a5c7-6357457189f2"
}
}
}
]
},
"headers": {}
}
}
}
},
"x-ms-odata": "#/definitions/JobSchedule",
"x-ms-pageable": {
"nextLinkName": "nextLink"
}
}
},
"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Automation/automationAccounts/{automationAccountName}/jobSchedules/{jobScheduleId}": {
"delete": {
"description": "Delete the job schedule identified by job schedule name.",
"externalDocs": {
"url": "http://aka.ms/azureautomationsdk/jobscheduleoperations"
},
"operationId": "JobSchedule_Delete",
"parameters": [
{
"description": "Name of an Azure Resource group.",
"in": "path",
"maxLength": 90,
"minLength": 1,
"name": "resourceGroupName",
"pattern": "^[-\\w\\._]+$",
"required": true,
"type": "string",
"x-ms-parameter-location": "method"
},
{
"description": "The name of the automation account.",
"in": "path",
"name": "automationAccountName",
"required": true,
"type": "string",
"x-ms-parameter-location": "method"
},
{
"description": "The job schedule name.",
"format": "uuid",
"in": "path",
"name": "jobScheduleId",
"required": true,
"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,
"type": "string"
},
{
"description": "Client Api Version.",
"in": "query",
"name": "api-version",
"required": true,
"type": "string"
}
],
"responses": {
"200": {
"description": "OK"
},
"default": {
"description": "Automation error response describing why the operation failed.",
"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": [
"JobSchedule"
],
"x-ms-examples": {
"Delete a job schedule": {
"parameters": {
"api-version": "2015-10-31",
"automationAccountName": "ContoseAutomationAccount",
"jobScheduleId": "0fa462ba-3aa2-4138-83ca-9ebc3bc55cdc",
"resourceGroupName": "rg",
"subscriptionId": "subid"
},
"responses": {
"200": {}
}
}
}
},
"get": {
"description": "Retrieve the job schedule identified by job schedule name.",
"externalDocs": {
"url": "http://aka.ms/azureautomationsdk/jobscheduleoperations"
},
"operationId": "JobSchedule_Get",
"parameters": [
{
"description": "Name of an Azure Resource group.",
"in": "path",
"maxLength": 90,
"minLength": 1,
"name": "resourceGroupName",
"pattern": "^[-\\w\\._]+$",
"required": true,
"type": "string",
"x-ms-parameter-location": "method"
},
{
"description": "The name of the automation account.",
"in": "path",
"name": "automationAccountName",
"required": true,
"type": "string",
"x-ms-parameter-location": "method"
},
{
"description": "The job schedule name.",
"format": "uuid",
"in": "path",
"name": "jobScheduleId",
"required": true,
"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,
"type": "string"
},
{
"description": "Client Api Version.",
"in": "query",
"name": "api-version",
"required": true,
"type": "string"
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#/definitions/JobSchedule"
}
},
"default": {
"description": "Automation error response describing why the operation failed.",
"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": [
"JobSchedule"
],
"x-ms-examples": {
"Get a job schedule": {
"parameters": {
"api-version": "2015-10-31",
"automationAccountName": "ContoseAutomationAccount",
"jobScheduleId": "0fa462ba-3aa2-4138-83ca-9ebc3bc55cdc",
"resourceGroupName": "rg",
"subscriptionId": "subid"
},
"responses": {
"200": {
"body": {
"id": "/subscriptions/subid/resourceGroups/rg/providers/Microsoft.Automation/automationAccounts/ContoseAutomationAccount/jobSchedules/0fa462ba-3aa2-4138-83ca-9ebc3bc55cdc",
"properties": {
"jobScheduleId": "0fa462ba-3aa2-4138-83ca-9ebc3bc55cdc",
"parameters": {
"jobscheduletag01": "jobschedulevalue01",
"jobscheduletag02": "jobschedulevalue02"
},
"runOn": null,
"runbook": {
"name": "TestRunbook"
},
"schedule": {
"name": "ScheduleNameGoesHere332204b5-debe-4348-a5c7-6357457189f2"
}
}
},
"headers": {}
}
}
}
}
},
"put": {
"description": "Create a job schedule.",
"externalDocs": {
"url": "http://aka.ms/azureautomationsdk/jobscheduleoperations"
},
"operationId": "JobSchedule_Create",
"parameters": [
{
"description": "Name of an Azure Resource group.",
"in": "path",
"maxLength": 90,
"minLength": 1,
"name": "resourceGroupName",
"pattern": "^[-\\w\\._]+$",
"required": true,
"type": "string",
"x-ms-parameter-location": "method"
},
{
"description": "The name of the automation account.",
"in": "path",
"name": "automationAccountName",
"required": true,
"type": "string",
"x-ms-parameter-location": "method"
},
{
"description": "The job schedule name.",
"format": "uuid",
"in": "path",
"name": "jobScheduleId",
"required": true,
"type": "string"
},
{
"description": "The parameters supplied to the create job schedule operation.",
"in": "body",
"name": "parameters",
"required": true,
"schema": {
"$ref": "#/definitions/JobScheduleCreateParameters"
}
},
{
"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,
"type": "string"
},
{
"description": "Client Api Version.",
"in": "query",
"name": "api-version",
"required": true,
"type": "string"
}
],
"responses": {
"201": {
"description": "Created",
"schema": {
"$ref": "#/definitions/JobSchedule"
}
},
"default": {
"description": "Automation error response describing why the operation failed.",
"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": [
"JobSchedule"
],
"x-ms-examples": {
"Create a job schedule": {
"parameters": {
"api-version": "2015-10-31",
"automationAccountName": "ContoseAutomationAccount",
"jobScheduleId": "0fa462ba-3aa2-4138-83ca-9ebc3bc55cdc",
"parameters": {
"properties": {
"parameters": {
"jobscheduletag01": "jobschedulevalue01",
"jobscheduletag02": "jobschedulevalue02"
},
"runbook": {
"name": "TestRunbook"
},
"schedule": {
"name": "ScheduleNameGoesHere332204b5-debe-4348-a5c7-6357457189f2"
}
}
},
"resourceGroupName": "rg",
"subscriptionId": "subid"
},
"responses": {
"201": {
"body": {
"id": "/subscriptions/subid/resourceGroups/rg/providers/Microsoft.Automation/automationAccounts/ContoseAutomationAccount/jobSchedules/0fa462ba-3aa2-4138-83ca-9ebc3bc55cdc",
"properties": {
"jobScheduleId": "0fa462ba-3aa2-4138-83ca-9ebc3bc55cdc",
"parameters": {
"jobscheduletag01": "jobschedulevalue01",
"jobscheduletag02": "jobschedulevalue02"
},
"runOn": null,
"runbook": {
"name": "TestRunbook"
},
"schedule": {
"name": "ScheduleNameGoesHere332204b5-debe-4348-a5c7-6357457189f2"
}
}
},
"headers": {}
}
}
}
}
}
}
},
"definitions": {
"JobSchedule": {
"description": "Definition of the job schedule.",
"properties": {
"id": {
"description": "Gets the id of the resource.",
"readOnly": true,
"type": "string"
},
"name": {
"description": "Gets the name of the variable.",
"readOnly": true,
"type": "string"
},
"properties": {
"$ref": "#/definitions/JobScheduleProperties",
"description": "Gets or sets the properties of the job schedule.",
"x-ms-client-flatten": true
},
"type": {
"description": "Resource type",
"readOnly": true,
"type": "string"
}
}
},
"JobScheduleCreateParameters": {
"description": "The parameters supplied to the create job schedule operation.",
"properties": {
"properties": {
"$ref": "#/definitions/JobScheduleCreateProperties",
"description": "Gets or sets the list of job schedule properties.",
"x-ms-client-flatten": true
}
},
"required": [
"properties"
]
},
"JobScheduleCreateProperties": {
"description": "The parameters supplied to the create job schedule operation.",
"properties": {
"parameters": {
"additionalProperties": {
"type": "string"
},
"description": "Gets or sets a list of job properties.",
"type": "object"
},
"runOn": {
"description": "Gets or sets the hybrid worker group that the scheduled job should run on.",
"type": "string"
},
"runbook": {
"$ref": "#/definitions/RunbookAssociationProperty",
"description": "Gets or sets the runbook."
},
"schedule": {
"$ref": "#/definitions/ScheduleAssociationProperty",
"description": "Gets or sets the schedule."
}
},
"required": [
"schedule",
"runbook"
]
},
"JobScheduleListResult": {
"description": "The response model for the list job schedule operation.",
"properties": {
"nextLink": {
"description": "Gets or sets the next link.",
"type": "string"
},
"value": {
"description": "Gets or sets a list of job schedules.",
"items": {
"$ref": "#/definitions/JobSchedule"
},
"type": "array"
}
}
},
"JobScheduleProperties": {
"description": "Definition of job schedule parameters.",
"properties": {
"jobScheduleId": {
"description": "Gets or sets the id of job schedule.",
"type": "string"
},
"parameters": {
"additionalProperties": {
"type": "string"
},
"description": "Gets or sets the parameters of the job schedule.",
"type": "object"
},
"runOn": {
"description": "Gets or sets the hybrid worker group that the scheduled job should run on.",
"type": "string"
},
"runbook": {
"$ref": "#/definitions/RunbookAssociationProperty",
"description": "Gets or sets the runbook."
},
"schedule": {
"$ref": "#/definitions/ScheduleAssociationProperty",
"description": "Gets or sets the schedule."
}
}
},
"RunbookAssociationProperty": {
"description": "The runbook property associated with the entity.",
"properties": {
"name": {
"description": "Gets or sets the name of the runbook.",
"type": "string"
}
}
},
"ScheduleAssociationProperty": {
"description": "The schedule property associated with the entity.",
"properties": {
"name": {
"description": "Gets or sets the name of the Schedule.",
"type": "string"
}
}
}
}
}