Microsoft Azure Jobschedules API
The Jobschedules API from Microsoft Azure — 6 operation(s) for jobschedules.
Microsoft Azure Jobschedules API is one of 1667 APIs that Microsoft Azure publishes on the APIs.io network, described by a machine-readable OpenAPI specification.
Tagged areas include Jobschedules. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, an API reference, pricing, a JSON-LD context, and a getting-started guide.
This API exposes 11 operations across 6 paths, and defines 125 schemas. It is described by OpenAPI 3.2.0, at version 2020-08-01-preview.
11 operations
6 paths
125 schemas
1 DELETE3 GET1 HEAD1 PATCH4 POST1 PUT
Metadata
The identity and technical contract details declared by the specification.
Paths & Operations 11
Across 6 paths, the API surfaces 11 operations — 1 DELETE, 3 GET, 1 HEAD, 1 PATCH, 4 POST, 1 PUT. Each is listed below with its method, path, parameters, and response codes.
Jobschedules 11
GET
/jobschedules
Microsoft Azure Lists All Of The Job Schedules In The Specified Account
POST
/jobschedules
Microsoft Azure Creates A Job Schedule To The Specified Account
GET
/jobschedules/{jobScheduleId}
Microsoft Azure Get Jobschedules Jobscheduleid
PUT
/jobschedules/{jobScheduleId}
Microsoft Azure Updates The Properties Of The Specified Job Schedule
PATCH
/jobschedules/{jobScheduleId}
Microsoft Azure Updates The Properties Of The Specified Job Schedule
DELETE
/jobschedules/{jobScheduleId}
Microsoft Azure Deletes A Job Schedule From The Specified Account
HEAD
/jobschedules/{jobScheduleId}
Microsoft Azure Checks The Specified Job Schedule Exists
POST
/jobschedules/{jobScheduleId}/disable
Microsoft Azure Disables A Job Schedule
POST
/jobschedules/{jobScheduleId}/enable
Microsoft Azure Enables A Job Schedule
GET
/jobschedules/{jobScheduleId}/jobs
Microsoft Azure Lists The Jobs That Have Been Created Under The Specified Job Schedule
POST
/jobschedules/{jobScheduleId}/terminate
Microsoft Azure Terminates A Job Schedule
Schemas 125
The contract defines 125 schemas that model the data the API accepts and returns. The most detailed are BatchJob (26 properties), BatchPoolSpecificationUpdate (24 properties), BatchPoolSpecification (24 properties), BatchJobSpecification (15 properties). Each schema is shown below with its type and property counts.
BatchCertificateStoreLocation
string
BatchCertificateStoreLocation enums
WindowsConfiguration
object
Windows operating system settings to apply to the virtual machine.
1 property
NetworkSecurityGroupRule
object
A network security group rule to apply to an inbound endpoint.
4 properties
3 required
BatchAutoPoolSpecificationUpdate
object
Specifies characteristics for a temporary 'auto pool'. The Batch service will create this auto Pool when the Job is submitted.
4 properties
BatchJobScheduleCreateContent
object
Parameters for creating an Azure Batch Job Schedule
5 properties
3 required
SecurityProfile
object
Specifies the security profile settings for the virtual machine or virtual machine scale set.
3 properties
3 required
LinuxUserConfiguration
object
Properties used to create a user Account on a Linux Compute Node.
3 properties
IpAddressProvisioningType
string
IPAddressProvisioningType enums
BatchTaskSchedulingPolicyUpdate
object
Specifies how Tasks should be distributed across Compute Nodes.
1 property
UefiSettings
object
Specifies the security settings like secure boot and vTPM used while creating the virtual machine.
2 properties
ManagedDiskUpdate
object
The managed disk parameters.
1 property
BatchJobState
string
BatchJobState enums
UpgradePolicy
object
Describes an upgrade policy - automatic, manual, or rolling.
3 properties
1 required
ContainerType
string
ContainerType enums
BatchCertificateReference
object
A reference to a Certificate to be installed on Compute Nodes in a Pool. Warning: This object is deprecated and will be removed after February, 2024. Please us…
5 properties
2 required
BatchPoolInfoUpdate
object
Specifies how a Job should be assigned to a Pool.
2 properties
BatchJobManagerTaskUpdate
object
Specifies details of a Job Manager Task. The Job Manager Task is automatically started when the Job is created. The Batch service tries to schedule the Job Man…
15 properties
BatchJobPreparationTaskUpdate
object
A Job Preparation Task to run before any Tasks of the Job on any given Compute Node. You can use Job Preparation to prepare a Node to run Tasks for the Job. Ac…
9 properties
NameValuePair
object
Represents a name-value pair.
2 properties
UserAccount
object
Properties used to create a user used to execute Tasks on an Azure Batch Compute Node.
5 properties
2 required
BatchJobSchedule
object
A Job Schedule that allows recurring Jobs by specifying when to run Jobs and a specification used to create each Job.
15 properties
1 required
RecentBatchJob
object
Information about the most recent Job to run under the Job Schedule.
2 properties
BatchTaskContainerSettingsUpdate
object
The container settings for a Task.
4 properties
BatchPoolInfo
object
Specifies how a Job should be assigned to a Pool.
2 properties
DynamicVNetAssignmentScope
string
DynamicVNetAssignmentScope enums
BatchJobPreparationTask
object
A Job Preparation Task to run before any Tasks of the Job on any given Compute Node. You can use Job Preparation to prepare a Node to run Tasks for the Job. Ac…
9 properties
1 required
OutputFile
object
On every file uploads, Batch service writes two log files to the compute node, 'fileuploadout.txt' and 'fileuploaderr.txt'. These log files are used to learn m…
3 properties
3 required
BatchJobScheduleState
string
BatchJobScheduleState enums
DataDisk
object
Settings which will be used by the data disks associated to Compute Nodes in the Pool. When using attached data disks, you need to mount and format the disks f…
4 properties
2 required
BatchJobScheduleExecutionInfo
object
Contains information about Jobs that have been and will be run under a Job Schedule.
3 properties
BatchPoolEndpointConfigurationUpdate
object
The endpoint configuration for a Pool.
1 property
ContainerConfiguration
object
The configuration for container-enabled Pools.
3 properties
1 required
BatchStartTaskUpdate
object
Batch will retry Tasks when a recovery operation is triggered on a Node. Examples of recovery operations include (but are not limited to) when an unhealthy Nod…
7 properties
CloudServiceConfiguration
object
The configuration for Compute Nodes in a Pool based on the Azure Cloud Services platform.
2 properties
1 required
AutoUserSpecification
object
Specifies the options for the auto user that runs an Azure Batch Task.
2 properties
OnAllBatchTasksComplete
string
The action the Batch service should take when all Tasks in the Job are in the completed state.
ContainerRegistry
object
A private container registry.
4 properties
BatchJobScheduleUpdateContent
object
Parameters for updating an Azure Batch Job Schedule.
3 properties
AuthenticationTokenSettings
object
The settings for an authentication token that the Task can use to perform Batch service operations.
1 property
BatchJobReleaseTaskUpdate
object
A Job Release Task to run on Job completion on any Compute Node where the Job has run. The Job Release Task runs when the Job ends, because of one of the follo…
8 properties
OutputFileBlobContainerDestination
object
Specifies a file upload destination within an Azure blob storage container.
4 properties
1 required
ContainerConfigurationUpdate
object
The configuration for container-enabled Pools.
3 properties
BatchJobConstraints
object
The execution constraints for a Job.
2 properties
OutputFileDestination
object
The destination to which a file should be uploaded.
1 property
SecurityTypes
string
Specifies the SecurityType of the virtual machine. It has to be set to any specified value to enable UefiSettings.
BatchJobSchedulingError
object
An error encountered by the Batch service when scheduling a Job.
4 properties
1 required
ResourceFile
object
A single file or multiple files to be downloaded to a Compute Node.
7 properties
BatchJobSpecification
object
Specifies details of the Jobs to be created on a schedule.
15 properties
1 required
RollingUpgradePolicy
object
The configuration parameters used while performing a rolling upgrade.
7 properties
VMExtension
object
The configuration for virtual machine extensions.
9 properties
3 required
BatchErrorMessage
object
An error message received in an Azure Batch error response.
2 properties
OutputFileUploadConfig
object
Options for an output file upload operation, including under what conditions to perform the upload.
1 property
1 required
LoginMode
string
LoginMode enums
ElevationLevel
string
ElevationLevel enums
OnBatchTaskFailure
string
OnTaskFailure enums
CifsMountConfiguration
object
Information used to connect to a CIFS file system.
5 properties
4 required
InboundNATPool
object
A inbound NAT Pool that can be used to address specific ports on Compute Nodes in a Batch Pool externally.
6 properties
5 required
BatchPoolSpecification
object
Specification for creating a new Pool.
24 properties
1 required
VirtualMachineConfiguration
object
The configuration for Compute Nodes in a Pool based on the Azure Virtual Machines infrastructure.
12 properties
2 required
BatchJobScheduleListResult
object
The result of listing the Job Schedules in an Account.
2 properties
InboundEndpointProtocol
string
InboundEndpointProtocol enums
ManagedDisk
object
The managed disk parameters.
1 property
1 required
AutomaticOsUpgradePolicy
object
The configuration parameters used for performing automatic OS upgrade.
4 properties
DiffDiskPlacement
string
AccessDiffDiskPlacementScope enums
AzureFileShareConfiguration
object
Information used to connect to an Azure Fileshare.
5 properties
4 required
HttpHeader
object
An HTTP header name-value pair
2 properties
1 required
BatchPoolLifetimeOption
string
BatchPoolLifetimeOption enums
BatchJobExecutionInfo
object
Contains information about the execution of a Job in the Azure Batch service.
5 properties
1 required
BatchJobNetworkConfigurationUpdate
object
The network configuration for the Job.
1 property
StorageAccountType
string
StorageAccountType enums
OutputFileUploadCondition
string
OutputFileUploadCondition enums
WindowsUserConfiguration
object
Properties used to create a user Account on a Windows Compute Node.
1 property
BatchJobNetworkConfiguration
object
The network configuration for the Job.
1 property
1 required
BatchError
object
An error response received from the Azure Batch service.
3 properties
1 required
BatchCertificateVisibility
string
BatchCertificateVisibility enums
CloudServiceConfigurationUpdate
object
The configuration for Compute Nodes in a Pool based on the Azure Cloud Services platform.
2 properties
BatchNodeCommunicationMode
string
BatchNodeCommunicationMode enums
NetworkConfigurationUpdate
object
The network configuration for a Pool.
5 properties
UserIdentity
object
The definition of the user identity under which the Task is run. Specify either the userName or autoUser property, but not both.
2 properties
BatchAutoPoolSpecification
object
Specifies characteristics for a temporary 'auto pool'. The Batch service will create this auto Pool when the Job is submitted.
4 properties
1 required
BatchJob
object
An Azure Batch Job.
26 properties
1 required
DiffDiskSettings
object
Specifies the ephemeral Disk Settings for the operating system disk used by the compute node (VM).
1 property
OSDiskUpdate
object
Settings for the operating system disk of the compute node (VM).
5 properties
BatchApplicationPackageReference
object
A reference to an Package to be deployed to Compute Nodes.
2 properties
1 required
DiskEncryptionTarget
string
DiskEncryptionTarget enums
ErrorCategory
string
ErrorCategory enums
AutoUserScope
string
AutoUserScope enums
DiskEncryptionConfiguration
object
The disk encryption configuration applied on compute nodes in the pool. Disk encryption configuration is not supported on Linux pool created with Azure Compute…
1 property
NetworkSecurityGroupRuleAccess
string
NetworkSecurityGroupRuleAccess enums
AccessScope
string
AccessScope enums
BatchJobReleaseTask
object
A Job Release Task to run on Job completion on any Compute Node where the Job has run. The Job Release Task runs when the Job ends, because of one of the follo…
8 properties
1 required
BatchErrorDetail
object
An item of additional information included in an Azure Batch error response.
2 properties
UpgradePolicyUpdate
object
Describes an upgrade policy - automatic, manual, or rolling.
3 properties
BatchStartTask
object
Batch will retry Tasks when a recovery operation is triggered on a Node. Examples of recovery operations include (but are not limited to) when an unhealthy Nod…
7 properties
1 required
BatchNodePlacementPolicyType
string
BatchNodePlacementPolicyType enums
ImageReference
object
A reference to an Azure Virtual Machines Marketplace Image or a Azure Compute Gallery Image. To get the list of all Azure Marketplace Image references verified…
6 properties
BatchJobScheduleConfiguration
object
The schedule according to which Jobs will be created. All times are fixed respective to UTC and are not impacted by daylight saving time.
4 properties
BatchNodeFillType
string
BatchNodeFillType enums
UpgradeMode
string
UpgradeMode enums
MountConfiguration
object
The file system to mount on each node.
4 properties
BatchNodeIdentityReference
object
The reference to a user assigned identity associated with the Batch pool which a compute node will use.
1 property
BatchJobSpecificationUpdate
object
Specifies details of the Jobs to be created on a schedule.
15 properties
ServiceArtifactReferenceUpdate
object
Specifies the service artifact reference id used to set same image version for all virtual machines in the scale set when using 'latest' image version.
1 property
ServiceArtifactReference
object
Specifies the service artifact reference id used to set same image version for all virtual machines in the scale set when using 'latest' image version.
1 property
1 required
BatchJobStatistics
object
Resource usage statistics for a Job.
14 properties
14 required
BatchPoolSpecificationUpdate
object
Specification for creating a new Pool.
24 properties
BatchJobScheduleStatistics
object
Resource usage statistics for a Job Schedule.
14 properties
14 required
EnvironmentSetting
object
An environment variable to be set on a Task process.
2 properties
1 required
NetworkConfiguration
object
The network configuration for a Pool.
5 properties
BatchTaskConstraints
object
Execution constraints to apply to a Task.
3 properties
BatchJobListResult
object
The result of listing the Jobs in an Account.
2 properties
VirtualMachineConfigurationUpdate
object
The configuration for Compute Nodes in a Pool based on the Azure Virtual Machines infrastructure.
12 properties
CachingType
string
CachingType enums
PublicIpAddressConfiguration
object
The public IP Address configuration of the networking configuration of a Pool.
2 properties
BatchNodePlacementConfiguration
object
For regional placement, nodes in the pool will be allocated in the same region. For zonal placement, nodes in the pool will be spread across different zones wi…
1 property
BatchTaskSchedulingPolicy
object
Specifies how Tasks should be distributed across Compute Nodes.
1 property
1 required
ContainerWorkingDirectory
string
ContainerWorkingDirectory enums
SecurityProfileUpdate
object
Specifies the security profile settings for the virtual machine or virtual machine scale set.
3 properties
BatchJobManagerTask
object
Specifies details of a Job Manager Task. The Job Manager Task is automatically started when the Job is created. The Batch service tries to schedule the Job Man…
15 properties
2 required
NfsMountConfiguration
object
Information used to connect to an NFS file system.
3 properties
2 required
BatchPoolEndpointConfiguration
object
The endpoint configuration for a Pool.
1 property
1 required
MetadataItem
object
The Batch service does not assign any meaning to this metadata; it is solely for the use of user code.
2 properties
2 required
BatchTaskContainerSettings
object
The container settings for a Task.
4 properties
1 required
OSDisk
object
Settings for the operating system disk of the compute node (VM).
5 properties
AzureBlobFileSystemConfiguration
object
Information used to connect to an Azure Storage Container using Blobfuse.
7 properties
3 required
Specification
The full machine-readable OpenAPI contract behind this narrative.
Source
More from Microsoft Azure 12
Other APIs Microsoft Azure publishes across the network.
Microsoft Azure AI Search API
Microsoft Azure Communication Services API
Microsoft Azure Event Grid API
Microsoft Azure Functions API
Microsoft Azure DevOps REST API
Microsoft Azure AI Foundry API
Microsoft Azure Resource JSON Schema
Microsoft Azure JSON-LD Context
Microsoft Azure AccessConnector API
Microsoft Azure AccessControlRecords API
Microsoft Azure AccessPolicies API
Microsoft Azure AccessReviewInstanceAcceptRecommmendations API
#Jobschedules
Where this information came from
This is an independent, third-party profile of Microsoft Azure Jobschedules API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.
The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.
Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.
info@apievangelist.com
·
Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and
you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.