Azure Automation Job Schedule API
The JobSchedule API from Azure Automation — 2 operation(s) for jobschedule.
The JobSchedule API from Azure Automation — 2 operation(s) for jobschedule.
Every API here is available over the APIs.io API and to AI agents over MCP.
One button, every client — Claude, Cursor, VS Code and the rest.
https://apis.io/mcp
find_apisBrowse and filter every API in the catalog.get_api_artifactsOne API's artifacts, grouped by type.get_openapiThe primary OpenAPI for this API.find_similar_apisAPIs that look like this one.apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.resolveTurn a domain, URL or GitHub org into the provider it belongs to.find_cohortsEvery scored population of providers in the catalog.curl "https://apis.io/api/v1/apis/microsoft-azure-automation:microsoft-azure-automation-jobschedule-api"
curl "https://apis.io/api/v1/apis?limit=25"
Calls without X-API-Key need no key. Calls with it need a paid plan — get a key.
Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.
A second provider on the same verified email joins the account you already have.
openapi: 3.2.0
info:
title: Microsoft Azure Automation Job Schedule API
version: '2024-10-23'
x-typespec-generated:
- emitter: '@azure-tools/typespec-autorest'
description: 'Operations tagged JobSchedule across 2 of this provider''s published API definitions: microsoft-azure-automation-openapi.json, microsoft-azure-automation-management-openapi.yml. Each path carries the servers of the definition it was published in.'
servers:
- url: https://management.azure.com
security:
- azure_auth:
- user_impersonation
tags:
- name: JobSchedule
paths:
? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Automation/automationAccounts/{automationAccountName}/jobSchedules
: get:
operationId: JobSchedule_ListByAutomationAccount
tags:
- JobSchedule
description: Retrieve a list of job schedules.
externalDocs:
url: http://aka.ms/azureautomationsdk/jobscheduleoperations
parameters:
- $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter
- $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter
- $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter
- name: automationAccountName
in: path
description: The name of the automation account.
required: true
schema:
type: string
- name: $filter
in: query
description: The filter to apply on the operation.
required: false
schema:
type: string
responses:
'200':
description: Azure operation completed successfully.
content:
application/json:
schema:
$ref: '#/components/schemas/JobScheduleListResult'
default:
description: An unexpected error response.
content:
application/json:
schema:
$ref: ../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse
x-ms-examples:
List all job schedules by automation account:
$ref: ./examples/listAllJobSchedulesByAutomationAccount.json
x-ms-pageable:
nextLinkName: nextLink
summary: Job schedule list by automation account
x-summary-source: derived
servers:
- url: https://management.azure.com
? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Automation/automationAccounts/{automationAccountName}/jobSchedules/{jobScheduleId}
: get:
operationId: JobSchedule_Get
tags:
- JobSchedule
description: Retrieve the job schedule identified by job schedule name.
externalDocs:
url: http://aka.ms/azureautomationsdk/jobscheduleoperations
parameters:
- $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter
- $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter
- $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter
- name: automationAccountName
in: path
description: The name of the automation account.
required: true
schema:
type: string
- name: jobScheduleId
in: path
description: The job schedule name.
required: true
schema:
type: string
format: uuid
responses:
'200':
description: Azure operation completed successfully.
content:
application/json:
schema:
$ref: '#/components/schemas/JobSchedule'
default:
description: An unexpected error response.
content:
application/json:
schema:
$ref: ../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse
x-ms-examples:
Get a job schedule:
$ref: ./examples/getJobSchedule.json
summary: Job schedule get
x-summary-source: derived
put:
operationId: JobSchedule_Create
tags:
- JobSchedule
description: Create a job schedule.
externalDocs:
url: http://aka.ms/azureautomationsdk/jobscheduleoperations
parameters:
- $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter
- $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter
- $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter
- name: automationAccountName
in: path
description: The name of the automation account.
required: true
schema:
type: string
- name: jobScheduleId
in: path
description: The job schedule name.
required: true
schema:
type: string
format: uuid
responses:
'201':
description: Resource 'JobSchedule' create operation succeeded
content:
application/json:
schema:
$ref: '#/components/schemas/JobSchedule'
default:
description: An unexpected error response.
content:
application/json:
schema:
$ref: ../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse
x-ms-examples:
Create a job schedule:
$ref: ./examples/createJobSchedule.json
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/JobScheduleCreateParameters'
description: The parameters supplied to the create job schedule operation.
required: true
summary: Job schedule create
x-summary-source: derived
delete:
operationId: JobSchedule_Delete
tags:
- JobSchedule
description: Delete the job schedule identified by job schedule name.
externalDocs:
url: http://aka.ms/azureautomationsdk/jobscheduleoperations
parameters:
- $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter
- $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter
- $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter
- name: automationAccountName
in: path
description: The name of the automation account.
required: true
schema:
type: string
- name: jobScheduleId
in: path
description: The job schedule name.
required: true
schema:
type: string
format: uuid
responses:
'200':
description: Resource deleted successfully.
default:
description: An unexpected error response.
content:
application/json:
schema:
$ref: ../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse
x-ms-examples:
Delete a job schedule:
$ref: ./examples/deleteJobSchedule.json
summary: Job schedule delete
x-summary-source: derived
servers:
- url: https://management.azure.com
components:
schemas:
ScheduleAssociationProperty:
type: object
description: The schedule property associated with the entity.
properties:
name:
type: string
description: Gets or sets the name of the Schedule.
JobScheduleProperties:
type: object
description: Definition of job schedule parameters.
properties:
jobScheduleId:
type: string
description: Gets or sets the id of job schedule.
schedule:
$ref: '#/components/schemas/ScheduleAssociationProperty'
description: Gets or sets the schedule.
runbook:
$ref: '#/components/schemas/RunbookAssociationProperty'
description: Gets or sets the runbook.
runOn:
type: string
description: Gets or sets the hybrid worker group that the scheduled job should run on.
parameters:
type: object
description: Gets or sets the parameters of the job schedule.
additionalProperties:
type: string
JobScheduleCreateParameters:
type: object
description: The parameters supplied to the create job schedule operation.
properties:
properties:
$ref: '#/components/schemas/JobScheduleCreateProperties'
description: Gets or sets the list of job schedule properties.
x-ms-client-flatten: true
required:
- properties
JobSchedule:
type: object
description: Definition of the job schedule.
properties:
properties:
$ref: '#/components/schemas/JobScheduleProperties'
description: Gets or sets the properties of the job schedule.
x-ms-client-flatten: true
allOf:
- $ref: ../../../../../../common-types/resource-management/v5/types.json#/definitions/ProxyResource
RunbookAssociationProperty:
type: object
description: The runbook property associated with the entity.
properties:
name:
type: string
description: Gets or sets the name of the runbook.
JobScheduleCreateProperties:
type: object
description: The parameters supplied to the create job schedule operation.
properties:
schedule:
$ref: '#/components/schemas/ScheduleAssociationProperty'
description: Gets or sets the schedule.
runbook:
$ref: '#/components/schemas/RunbookAssociationProperty'
description: Gets or sets the runbook.
runOn:
type: string
description: Gets or sets the hybrid worker group that the scheduled job should run on.
parameters:
type: object
description: Gets or sets a list of job properties.
additionalProperties:
type: string
required:
- schedule
- runbook
JobScheduleListResult:
type: object
description: The response of a JobSchedule list operation.
properties:
value:
type: array
description: The JobSchedule items on this page
items:
$ref: '#/components/schemas/JobSchedule'
nextLink:
type: string
format: uri
description: The link to the next page of items
required:
- value
securitySchemes:
azure_auth:
type: oauth2
flows:
implicit:
scopes:
user_impersonation: impersonate your user account
authorizationUrl: https://login.microsoftonline.com/common/oauth2/authorize
description: Azure Active Directory OAuth2 Flow.
x-refined-from:
- microsoft-azure-automation-openapi.json
- microsoft-azure-automation-management-openapi.yml