Microsoft Azure Jobs API
The Jobs API from Microsoft Azure — 45 operation(s) for jobs.
Microsoft Azure Jobs 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 Job. 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 60 operations across 45 paths, and defines 336 schemas. It is described by OpenAPI 3.2.0, at version 2020-08-01-preview.
60 operations
45 paths
336 schemas
5 DELETE26 GET1 HEAD3 PATCH20 POST5 PUT
Metadata
The identity and technical contract details declared by the specification.
Paths & Operations 60
Across 45 paths, the API surfaces 60 operations — 5 DELETE, 26 GET, 1 HEAD, 3 PATCH, 20 POST, 5 PUT. Each is listed below with its method, path, parameters, and response codes.
Jobs 60
GET
/jobs
Microsoft Azure Lists All Of The Jobs In The Specified Account
POST
/jobs
Microsoft Azure Creates A Job To The Specified Account
GET
/jobs/{jobId}
Microsoft Azure Gets Information About The Specified Job
PUT
/jobs/{jobId}
Microsoft Azure Updates The Properties Of The Specified Job
PATCH
/jobs/{jobId}
Microsoft Azure Updates The Properties Of The Specified Job
DELETE
/jobs/{jobId}
Microsoft Azure Deletes A Job
POST
/jobs/{jobId}/addtaskcollection
Microsoft Azure Adds A Collection Of Tasks To The Specified Job
POST
/jobs/{jobId}/disable
Microsoft Azure Disables The Specified Job, Preventing New Tasks From Running
POST
/jobs/{jobId}/enable
Microsoft Azure Enables The Specified Job, Allowing New Tasks To Run
GET
/jobs/{jobId}/jobpreparationandreleasetaskstatus
Microsoft Azure Lists The Execution Status Of The Job Preparation And Job Release Task For The specified Job Across The Compute Nodes Where The Job Has Run
GET
/jobs/{jobId}/taskcounts
Microsoft Azure Gets The Task Counts For The Specified Job
GET
/jobs/{jobId}/tasks
Microsoft Azure Lists All Of The Tasks That Are Associated With The Specified Job
POST
/jobs/{jobId}/tasks
Microsoft Azure Creates A Task To The Specified Job
GET
/jobs/{jobId}/tasks/{taskId}
Microsoft Azure Gets Information About The Specified Task
PUT
/jobs/{jobId}/tasks/{taskId}
Microsoft Azure Put Jobs Jobid Tasks Taskid
DELETE
/jobs/{jobId}/tasks/{taskId}
Microsoft Azure Deletes A Task From The Specified Job
GET
/jobs/{jobId}/tasks/{taskId}/files
Microsoft Azure Lists The Files In A Task S Directory On Its Compute Node
GET
/jobs/{jobId}/tasks/{taskId}/files/{filePath}
Microsoft Azure Get Jobs Jobid Tasks Taskid Files Filepath
DELETE
/jobs/{jobId}/tasks/{taskId}/files/{filePath}
Microsoft Azure Deletes The Specified Task File From The Compute Node Where The Task Ran
HEAD
/jobs/{jobId}/tasks/{taskId}/files/{filePath}
Microsoft Azure Head Jobs Jobid Tasks Taskid Files Filepath
POST
/jobs/{jobId}/tasks/{taskId}/reactivate
Microsoft Azure Reactivates A Task, Allowing It To Run Again Even If Its Retry Count Has Been exhausted
GET
/jobs/{jobId}/tasks/{taskId}/subtasksinfo
Microsoft Azure Lists All Of The Subtasks That Are Associated With The Specified Multi Instance task
POST
/jobs/{jobId}/tasks/{taskId}/terminate
Microsoft Azure Terminates The Specified Task
POST
/jobs/{jobId}/terminate
Microsoft Azure Terminates The Specified Job, Marking It As Completed
GET
/jobs/{jobId}/devices
Microsoft Azure Get Device Statuses
PUT
/jobs/{jobId}/rerun/{rerunId}
Microsoft Azure Rerun A Job On Failed Devices
POST
/jobs/{jobId}/resume
Microsoft Azure Resume A Stopped Job
POST
/jobs/{jobId}/stop
Microsoft Azure Stop A Running Job
GET
/lifetimejobstats
Microsoft Azure Gets Lifetime Summary Statistics For All Of The Jobs In The Specified Account
GET
/jobschedules/{jobScheduleId}/jobs
Microsoft Azure Lists The Jobs That Have Been Created Under The Specified Job Schedule
GET
/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/{deviceName}/jobs/{name}
Microsoft Azure Gets The Details Of A Specified Job On A Data Box Edge Data Box Gateway Device
GET
/subscriptions/{subscriptionId}/providers/Microsoft.DataBox/jobs
Microsoft Azure Get Subscriptions Subscriptionid Providers Microsoft Databox Jobs
POST
/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataBox/jobs/{jobName}/mitigate
Microsoft Azure Post Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Databox Jobs Jobname Mitigate
POST
/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataBox/jobs/{jobName}/markDevicesShipped
Microsoft Azure Post Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Databox Jobs Jobname Markdevicesshipped
GET
/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataBox/jobs
Microsoft Azure Get Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Databox Jobs
GET
/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataBox/jobs/{jobName}
Microsoft Azure Get Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Databox Jobs Jobname
PUT
/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataBox/jobs/{jobName}
Microsoft Azure Put Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Databox Jobs Jobname
DELETE
/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataBox/jobs/{jobName}
Microsoft Azure Delete Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Databox Jobs Jobname
PATCH
/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataBox/jobs/{jobName}
Microsoft Azure Patch Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Databox Jobs Jobname
POST
/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataBox/jobs/{jobName}/bookShipmentPickUp
Microsoft Azure Post Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Databox Jobs Jobname Bookshipmentpickup
POST
/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataBox/jobs/{jobName}/cancel
Microsoft Azure Post Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Databox Jobs Jobname Cancel
POST
/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataBox/jobs/{jobName}/listCredentials
Microsoft Azure Post Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Databox Jobs Jobname Listcredentials
GET
/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.HybridData/dataManagers/{dataManagerName}/dataServices/{dataServiceName}/jobDefinitions/{jobDefinitionName}/jobs
Microsoft Azure Get Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Hybriddata Datamanagers Datamanagername Dataservices Dataservicename Jobdefinitions Jobdefinition…
GET
/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.HybridData/dataManagers/{dataManagerName}/dataServices/{dataServiceName}/jobDefinitions/{jobDefinitionName}/jobs/{jobId}
Microsoft Azure Get Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Hybriddata Datamanagers Datamanagername Dataservices Dataservicename Jobdefinitions Jobdefinition…
POST
/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.HybridData/dataManagers/{dataManagerName}/dataServices/{dataServiceName}/jobDefinitions/{jobDefinitionName}/jobs/{jobId}/cancel
Microsoft Azure Post Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Hybriddata Datamanagers Datamanagername Dataservices Dataservicename Jobdefinitions Jobdefinitio…
POST
/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.HybridData/dataManagers/{dataManagerName}/dataServices/{dataServiceName}/jobDefinitions/{jobDefinitionName}/jobs/{jobId}/resume
Microsoft Azure Post Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Hybriddata Datamanagers Datamanagername Dataservices Dataservicename Jobdefinitions Jobdefinitio…
GET
/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.HybridData/dataManagers/{dataManagerName}/dataServices/{dataServiceName}/jobs
Microsoft Azure Get Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Hybriddata Datamanagers Datamanagername Dataservices Dataservicename Jobs
GET
/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.HybridData/dataManagers/{dataManagerName}/jobs
Microsoft Azure Get Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Hybriddata Datamanagers Datamanagername Jobs
POST
/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecoveryServices/vaults/{vaultName}/backupJobsExport
Microsoft Azure Post Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Recoveryservices Vaults Vaultname Backupjobsexport
GET
/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Scheduler/jobCollections/{jobCollectionName}/jobs/{jobName}
Microsoft Azure Get Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Scheduler Jobcollections Jobcollectionname Jobs Jobname
PUT
/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Scheduler/jobCollections/{jobCollectionName}/jobs/{jobName}
Microsoft Azure Put Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Scheduler Jobcollections Jobcollectionname Jobs Jobname
PATCH
/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Scheduler/jobCollections/{jobCollectionName}/jobs/{jobName}
Microsoft Azure Patch Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Scheduler Jobcollections Jobcollectionname Jobs Jobname
DELETE
/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Scheduler/jobCollections/{jobCollectionName}/jobs/{jobName}
Microsoft Azure Delete Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Scheduler Jobcollections Jobcollectionname Jobs Jobname
POST
/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Scheduler/jobCollections/{jobCollectionName}/jobs/{jobName}/run
Microsoft Azure Post Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Scheduler Jobcollections Jobcollectionname Jobs Jobname Run
GET
/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Scheduler/jobCollections/{jobCollectionName}/jobs
Microsoft Azure Get Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Scheduler Jobcollections Jobcollectionname Jobs
GET
/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Scheduler/jobCollections/{jobCollectionName}/jobs/{jobName}/history
Microsoft Azure Get Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Scheduler Jobcollections Jobcollectionname Jobs Jobname History
GET
/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.StorSimple/managers/{managerName}/devices/{deviceName}/jobs
Microsoft Azure Get Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Storsimple Managers Managername Devices Devicename Jobs
GET
/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.StorSimple/managers/{managerName}/devices/{deviceName}/jobs/{jobName}
Microsoft Azure Get Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Storsimple Managers Managername Devices Devicename Jobs Jobname
POST
/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.StorSimple/managers/{managerName}/devices/{deviceName}/jobs/{jobName}/cancel
Microsoft Azure Post Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Storsimple Managers Managername Devices Devicename Jobs Jobname Cancel
GET
/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.StorSimple/managers/{managerName}/jobs
Microsoft Azure Get Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Storsimple Managers Managername Jobs
Schemas 336
The contract defines 336 schemas that model the data the API accepts and returns. The most detailed are BatchTask (27 properties), BatchJob (26 properties), CloudJob (24 properties), BatchPoolSpecificationUpdate (24 properties). Each schema is shown below with its type and property counts.
ErrorMessage
object
2 properties
BatchTaskCounts
object
The Task counts for a Job.
5 properties
5 required
JobStage
object
The details about the specific stage of a job.
4 properties
1 required
AuthenticationTokenSettings_2
object
1 property
JobDefinition_2
object
4 properties
AutoPoolSpecification
object
4 properties
1 required
ContactDetails
object
Contact Details.
6 properties
3 required
ErrorDetails
object
The detail information of the error.
4 properties
2 required
ManagedDiskUpdate
object
The managed disk parameters.
1 property
JobDelayDetails
object
Job Delay Notification details
5 properties
InboundEndpointProtocol_2
string
JobProperties_2
object
Job Properties
17 properties
1 required
OutputFileUploadCondition_2
string
MetadataItem_2
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
CloudError
object
An error response from the service.
1 property
PublicIPAddressConfiguration
object
The public IP Address configuration of the networking configuration of a Pool.
2 properties
UserAccount
object
Properties used to create a user used to execute Tasks on an Azure Batch Compute Node.
5 properties
2 required
BatchJobPreparationAndReleaseTaskStatus
object
The status of the Job Preparation and Job Release Tasks on a Compute Node.
5 properties
DataAccountDetails
object
Account details of the data to be transferred
2 properties
1 required
CloudJob
object
24 properties
JobErrorAction
object
6 properties
BatchTaskSlotCounts
object
The TaskSlot counts for a Job.
5 properties
5 required
DependencyAction
string
DependencyAction 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
AutoUserSpecification
object
Specifies the options for the auto user that runs an Azure Batch Task.
2 properties
JobState
string
BatchNodeInfo
object
Information about the Compute Node on which a Task ran.
6 properties
AuthenticationTokenSettings
object
The settings for an authentication token that the Task can use to perform Batch service operations.
1 property
CertificateReference
object
5 properties
2 required
TransferAllDetails
object
Details to transfer all data.
3 properties
1 required
OutputFileDestination
object
The destination to which a file should be uploaded.
1 property
ExitCodeMapping
object
How the Batch service should respond if a Task exits with a particular exit code.
2 properties
2 required
RollingUpgradePolicy
object
The configuration parameters used while performing a rolling upgrade.
7 properties
UpdateInstallProgress
object
Progress details during installation of updates.
3 properties
VMExtension
object
The configuration for virtual machine extensions.
9 properties
3 required
BatchTask
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…
27 properties
BatchJobPreparationAndReleaseTaskStatusListResult
object
The result of listing the status of the Job Preparation and Job Release Tasks for a Job.
2 properties
systemData
object
Provides details about resource creation and update time
6 properties
BatchErrorMessage
object
An error message received in an Azure Batch error response.
2 properties
CloudError_3
object
An error response from the Container Instance service.
1 property
JobResourceUpdateParameter
object
The JobResourceUpdateParameter.
3 properties
DataStatistics
object
The additional details related to the data related statistics of a job. Currently applicable only for Backup, Clone and Restore jobs.
4 properties
Job
object
The job definition.
13 properties
2 required
ErrorCategory_2
string
OnTaskFailure
string
A Task is considered to have failed if has a failureInfo. A failureInfo is set if the Task completes with a non-zero exit code after exhausting its retry count…
EncryptionPreferences
object
Preferences related to the Encryption.
2 properties
BatchPoolSpecification
object
Specification for creating a new Pool.
24 properties
1 required
HttpHeader
object
An HTTP header name-value pair
2 properties
1 required
BatchError_2
object
3 properties
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
ExitCodeRangeMapping
object
A range of exit codes and how the Batch service should respond to exit codes within that range.
3 properties
3 required
UserAssignedProperties
object
User assigned identity properties.
1 property
BatchError
object
An error response received from the Azure Batch service.
3 properties
1 required
BatchNodeCommunicationMode
string
BatchNodeCommunicationMode enums
NameValuePair_2
object
2 properties
BatchTaskDependencies
object
Specifies any dependencies of a Task. Any Task that is explicitly specified or within a dependency range must complete before the dependant Task will be schedu…
2 properties
PoolInformation
object
2 properties
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
BatchJobPreparationTaskExecutionInfo
object
Contains information about the execution of a Job Preparation Task on a Compute Node.
11 properties
3 required
ContainerConfiguration_2
object
3 properties
1 required
MountConfiguration
object
The file system to mount on each node.
4 properties
Details
object
2 properties
2 required
JobList_2
object
The collection of jobs.
2 properties
1 required
JobErrorDetails
object
The job error information containing the list of job errors.
3 properties
StorageQueueMessage
object
4 properties
DeviceErasureDetails
object
Device erasure details with erasure completion status and erasureordestructionlog sas key
2 properties
JobProperties_3
object
Job Properties
8 properties
1 required
BatchTaskConstraints
object
Execution constraints to apply to a Task.
3 properties
JobDetails_2
object
Job details.
4 properties
BatchTaskState
string
BatchTaskState enums
JobResource
object
Job Resource.
5 properties
1 required
JobData
object
The job data definition.
1 property
1 required
JobManagerTask
object
The Job Manager Task is automatically started when the Job is created. The Batch service tries to schedule the Job Manager Task before any other Tasks in the J…
15 properties
2 required
UnencryptedCredentials
object
Unencrypted credentials for accessing device.
2 properties
UserAccount_2
object
5 properties
2 required
ServiceBusBrokeredMessageProperties
object
13 properties
ContainerWorkingDirectory
string
ContainerWorkingDirectory enums
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
BatchTaskListResult
object
The result of listing the Tasks in a Job.
2 properties
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
BatchTaskAddCollectionResult
object
The result of adding a collection of Tasks to a Job.
1 property
WindowsConfiguration
object
Windows operating system settings to apply to the virtual machine.
1 property
BatchTaskCreateContent
object
Parameters for creating an Azure Batch Task.
16 properties
2 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
FileProperties
object
The properties of a file on a Compute Node.
5 properties
2 required
NotificationPreference
object
Notification preference for a job stage.
2 properties
2 required
BatchJobUpdateContent
object
Parameters for updating an Azure Batch Job.
7 properties
StartTask
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
JobReleaseTask
object
The Job Release Task runs when the Job ends, because of one of the following: The user calls the Terminate Job API, or the Delete Job API while the Job is stil…
8 properties
1 required
CachingType_2
string
The default value for caching is none. For information about the caching options see: https://blogs.msdn.microsoft.com/windowsazurestorage/2012/06/27/exploring…
SecurityProfile
object
Specifies the security profile settings for the virtual machine or virtual machine scale set.
3 properties
3 required
BatchJobDisableContent
object
Parameters for disabling an Azure Batch Job.
1 property
1 required
VirtualMachineConfiguration_2
object
7 properties
2 required
BatchPoolInfoUpdate
object
Specifies how a Job should be assigned to a Pool.
2 properties
JobHistoryDefinition
object
4 properties
Job_4
object
The job.
6 properties
2 required
OutputFileDestination_2
object
1 property
ResourceIdentity
object
Msi identity details of the resource
4 properties
DataExportDetails
object
Details of the data to be used for exporting data from azure.
3 properties
2 required
JobState_2
string
Gets or set the job state.
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
JobHistoryDefinitionProperties
object
8 properties
DatacenterAddressResponse
object
Datacenter address for given storage location.
3 properties
1 required
ContainerConfiguration
object
The configuration for container-enabled Pools.
3 properties
1 required
JobExecutionStatus
string
Gets the job execution status.
JobDefinition
object
Job Definition.
1 property
1 required
WindowsConfiguration_2
object
1 property
BatchNodeFile
object
Information about a file or directory on a Compute Node.
4 properties
BatchJobConstraints
object
The execution constraints for a Job.
2 properties
IdentityProperties
object
Managed identity properties.
2 properties
Schedule
object
Schedule for the job run.
2 properties
ApplicationPackageReference
object
2 properties
1 required
Job_3
object
Data service job.
5 properties
3 required
DmsBaseObject
object
Base class for all objects under DataManager Service
3 properties
JobErrorDetails_2
object
The job error details. Contains list of job error items.
3 properties
2 required
RetryPolicy
object
3 properties
ErrorDetail
object
4 properties
2 required
OnBatchTaskFailure
string
OnTaskFailure enums
ContactInfo
object
Contact Info.
4 properties
2 required
VirtualMachineConfiguration
object
The configuration for Compute Nodes in a Pool based on the Azure Virtual Machines infrastructure.
12 properties
2 required
InboundEndpointProtocol
string
InboundEndpointProtocol enums
NFSMountConfiguration
object
3 properties
2 required
NetworkConfiguration_2
object
The network configuration for a Pool.
4 properties
StorageAccountType
string
StorageAccountType enums
CancellationReason
object
Reason for cancellation.
1 property
1 required
PoolEndpointConfiguration
object
1 property
1 required
UpdateDownloadProgress
object
Details about the download progress of update.
6 properties
JobExecutionInformation
object
5 properties
1 required
BatchCertificateVisibility
string
BatchCertificateVisibility enums
ImageReference_2
object
5 properties
CloudServiceConfigurationUpdate
object
The configuration for Compute Nodes in a Pool based on the Azure Cloud Services platform.
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
OSDiskUpdate
object
Settings for the operating system disk of the compute node (VM).
5 properties
BatchTaskCountsResult
object
The Task and TaskSlot counts for a Job.
2 properties
2 required
JobDefinitionProperties
object
Job Definition
9 properties
3 required
BatchSubtask
object
Information about an Azure Batch subtask.
12 properties
ApiError
object
1 property
1 required
ErrorCategory
string
ErrorCategory 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
DcAccessSecurityCode
object
Dc access security code
2 properties
JobAction
object
7 properties
HttpRequest
object
5 properties
JobProperties
object
The properties for the job.
8 properties
BatchTaskListSubtasksResult
object
The result of listing the subtasks of a Task.
2 properties
JobNetworkConfiguration
object
1 property
1 required
BatchPoolSpecificationUpdate
object
Specification for creating a new Pool.
24 properties
BatchTaskAddResult
object
Result for a single Task added as part of an add Task collection operation.
6 properties
2 required
WindowsUserConfiguration_2
object
1 property
JobBatch
object
The job batch definition.
2 properties
2 required
NetworkConfiguration
object
The network configuration for a Pool.
5 properties
TransferFilterDetails
object
Details of the filtering the transfer of data.
4 properties
1 required
TaskConstraints
object
3 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
JobDeviceStatusCollection
object
The paged results of job device statuses.
2 properties
1 required
IPAddressProvisioningType
string
JobProgress
object
progress summary for a scheduled job.
4 properties
BatchPoolEndpointConfiguration
object
The endpoint configuration for a Pool.
1 property
1 required
OSDisk
object
Settings for the operating system disk of the compute node (VM).
5 properties
AzureBlobFileSystemConfiguration_2
object
6 properties
3 required
FilterFileDetails
object
Details of the filter files to be used for data transfer.
2 properties
2 required
PoolSpecification
object
21 properties
1 required
JobRecurrence
object
5 properties
OutputFileUploadOptions
object
1 property
1 required
BatchSubtaskState
string
BatchSubtaskState enums
UpdateJobProperties
object
Job Properties for update
1 property
IpAddressProvisioningType
string
IPAddressProvisioningType enums
BatchTaskSchedulingPolicyUpdate
object
Specifies how Tasks should be distributed across Compute Nodes.
1 property
PackageShippingDetails
object
package shipping details
3 properties
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
JobList
object
Job Collection.
2 properties
TransferConfiguration
object
Configuration for defining the transfer of data.
3 properties
1 required
BlobFilterDetails
object
Filter details to transfer Azure Blobs
3 properties
Job_2
object
A device job.
9 properties
CopyLogDetails
object
Details for log generated during copy.
1 property
1 required
StorageAccountType_2
string
ExitConditions
object
Specifies how the Batch service should respond when the Task completes.
5 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
BatchTaskContainerExecutionInfo
object
Contains information about the container which a Task is executing.
3 properties
LinuxUserConfiguration_2
object
3 properties
MountConfiguration_2
object
4 properties
AzureFileFilterDetails
object
Filter details to transfer Azure files
3 properties
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
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
BatchJobReleaseTaskState
string
BatchJobReleaseTaskState enums
ContainerRegistry_2
object
3 properties
2 required
Preferences
object
Preferences related to the order
5 properties
UserIdentity_2
object
Specify either the userName or autoUser property, but not both.
2 properties
AffinityInfo
object
A locality hint that can be used by the Batch service to select a Compute Node on which to start a Task.
1 property
1 required
JobStatistics
object
14 properties
14 required
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
Error_2
object
Top level error for the job.
2 properties
1 required
ServiceBusTopicMessage
object
1 property
CifsMountConfiguration
object
Information used to connect to a CIFS file system.
5 properties
4 required
Error
object
The response error definition.
1 property
1 required
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
BatchTaskAddStatus
string
BatchTaskAddStatus enums
TransportPreferences
object
Preferences related to the shipment logistics of the sku
2 properties
1 required
BatchPoolLifetimeOption
string
BatchPoolLifetimeOption enums
JobStages
object
Job stages.
6 properties
ServiceBusMessage
object
6 properties
NetworkSecurityGroupRule_2
object
4 properties
3 required
ServiceBusQueueMessage
object
1 property
MarkDevicesShippedRequest
object
The request body to provide the delivery package details of job
1 property
1 required
BatchTaskStatistics
object
Resource usage statistics for a Task.
11 properties
11 required
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
DiffDiskSettings
object
Specifies the ephemeral Disk Settings for the operating system disk used by the compute node (VM).
1 property
AutoUserScope
string
AutoUserScope enums
BatchTaskIdRange
object
The start and end of the range are inclusive. For example, if a range has start 9 and end 12, then it represents Tasks '9', '10', '11' and '12'.
2 properties
2 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
DiskEncryptionConfiguration_2
object
The disk encryption configuration applied on compute nodes in the pool. Disk encryption configuration is not supported on Linux pool created with Shared Image…
1 property
BatchNodeFillType
string
BatchNodeFillType enums
PackageCarrierInfo
object
package carrier info
2 properties
BatchTaskExecutionResult
string
BatchTaskExecutionResult enums
UpgradeMode
string
UpgradeMode enums
AzureFileShareConfiguration_2
object
5 properties
4 required
MitigateJobRequest
object
The Mitigate Job captured from request body for Mitigate API
2 properties
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
InboundNATPool_2
object
6 properties
5 required
JobDeliveryInfo
object
Additional delivery info.
1 property
Resource
object
Model of the Resource.
4 properties
2 required
VirtualMachineConfigurationUpdate
object
The configuration for Compute Nodes in a Pool based on the Azure Virtual Machines infrastructure.
12 properties
BatchJobListResult
object
The result of listing the Jobs in an Account.
2 properties
CachingType
string
CachingType enums
HttpAuthentication
object
1 property
1 required
Sku
object
The Sku.
4 properties
1 required
BatchNodeFileListResult
object
The result of listing the files on a Compute Node, or the files associated with a Task on a Compute Node.
2 properties
CloudErrorBody
object
An error response from the service.
3 properties
PackageCarrierDetails
object
Package carrier details.
3 properties
BatchJobAction
string
BatchJobAction enums
JobPreparationTask
object
You can use Job Preparation to prepare a Node to run Tasks for the Job. Activities commonly performed in Job Preparation include: Downloading common resource f…
9 properties
1 required
BatchCertificateStoreLocation
string
BatchCertificateStoreLocation enums
NetworkSecurityGroupRule
object
A network security group rule to apply to an inbound endpoint.
4 properties
3 required
CloudError_2
object
Provides additional information about an http error response.
5 properties
JobHistoryListResult
object
2 properties
LinuxUserConfiguration
object
Properties used to create a user Account on a Linux Compute Node.
3 properties
LastMitigationActionOnJob
object
Last Mitigation Action Performed On Job
3 properties
UefiSettings
object
Specifies the security settings like secure boot and vTPM used while creating the virtual machine.
2 properties
BatchJobState
string
BatchJobState enums
UpgradePolicy
object
Describes an upgrade policy - automatic, manual, or rolling.
3 properties
1 required
ContainerType
string
ContainerType enums
JobRecurrenceSchedule
object
5 properties
DataDisk_2
object
4 properties
2 required
NameValuePair
object
Represents a name-value pair.
2 properties
BatchTaskGroup
object
A collection of Azure Batch Tasks to add.
1 property
1 required
DynamicVNetAssignmentScope
string
DynamicVNetAssignmentScope enums
ErrorDetails_2
object
Error Details
4 properties
OutputFileBlobContainerDestination_2
object
2 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
BatchErrorDetail_2
object
2 properties
ExitOptions
object
Specifies how the Batch service responds to a particular exit condition.
2 properties
CustomerSecret
object
The pair of customer secret.
3 properties
3 required
BatchTaskFailureInfo
object
Information about a Task failure.
4 properties
1 required
BatchPoolEndpointConfigurationUpdate
object
The endpoint configuration for a Pool.
1 property
CloudServiceConfiguration
object
The configuration for Compute Nodes in a Pool based on the Azure Cloud Services platform.
2 properties
1 required
JobDetails
object
Job details.
20 properties
2 required
JobSchedulingError
object
4 properties
1 required
CloudJobListResult
object
2 properties
OutputFileBlobContainerDestination
object
Specifies a file upload destination within an Azure blob storage container.
4 properties
1 required
ServiceBusAuthentication
object
3 properties
OutputFile_2
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
BaseModel
object
Represents the base class for all other ARM object models
4 properties
ContainerConfigurationUpdate
object
The configuration for container-enabled Pools.
3 properties
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
KeyEncryptionKey
object
Encryption key containing details about key to encrypt different keys.
4 properties
1 required
ReverseShippingDetails
object
Reverse Shipping Address and contact details for a job.
3 properties
JobErrorItem
object
The job error items.
3 properties
EnvironmentSetting_2
object
2 properties
1 required
DisableBatchJobOption
string
DisableBatchJobOption enums
ElevationLevel
string
ElevationLevel enums
ShipmentPickUpRequest
object
Shipment pick up request details.
3 properties
3 required
JobProperties_5
object
The properties of the job.
10 properties
1 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
JobErrorItem_2
object
The job error items.
3 properties
2 required
UpdateJobDetails
object
Job details for update.
6 properties
JobSecrets
object
The base class for the secrets
3 properties
1 required
BatchTaskExecutionInfo
object
Information about the execution of a Task.
10 properties
2 required
JobConstraints
object
2 properties
JobStages_2
object
Job stages.
4 properties
1 required
BatchJobExecutionInfo
object
Contains information about the execution of a Job in the Azure Batch service.
5 properties
1 required
BatchJobTerminateContent
object
Parameters for terminating an Azure Batch Job.
1 property
JobListResult
object
2 properties
JobStatus
object
5 properties
OnAllTasksComplete
string
OutputFileUploadCondition
string
OutputFileUploadCondition enums
JobProperties_4
object
5 properties
AutoUserSpecification_2
object
2 properties
JobRecurrenceScheduleMonthlyOccurrence
object
2 properties
ElevationLevel_2
string
NetworkConfigurationUpdate
object
The network configuration for a Pool.
5 properties
BatchJob
object
An Azure Batch Job.
26 properties
1 required
ShipmentPickUpResponse
object
Shipment pick up response.
2 properties
BatchApplicationPackageReference
object
A reference to an Package to be deployed to Compute Nodes.
2 properties
1 required
DiskEncryptionTarget
string
DiskEncryptionTarget enums
BatchJobReleaseTaskExecutionInfo
object
Contains information about the execution of a Job Release Task on a Compute Node.
9 properties
2 required
CIFSMountConfiguration
object
5 properties
4 required
ShippingAddress
object
Shipping address where customer wishes to receive the device.
12 properties
2 required
AdditionalErrorInfo
object
This class represents additional info which Resource Providers pass when an error occurs.
2 properties
JobDeviceStatus
object
The job device status definition.
2 properties
TaskSchedulingPolicy
object
1 property
1 required
UserAssignedIdentity
object
Class defining User assigned identity details.
2 properties
BatchNodeIdentityReference
object
The reference to a user assigned identity associated with the Batch pool which a compute node will use.
1 property
JobResourceList
object
Job Resource Collection
2 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
BatchJobCreateContent
object
Parameters for creating an Azure Batch Job.
16 properties
2 required
CloudErrorBody_2
object
An error response from the Container Instance service.
5 properties
BatchJobPreparationTaskState
string
BatchJobPreparationTaskState enums
EnvironmentSetting
object
An environment variable to be set on a Task process.
2 properties
1 required
TaskContainerSettings
object
4 properties
1 required
JobCancellationThreshold
object
The job cancellation threshold definition.
3 properties
2 required
ResourceFile_2
object
6 properties
MultiInstanceSettings
object
Multi-instance Tasks are commonly used to support MPI Tasks. In the MPI case, if any of the subtasks fail (for example due to exiting with a non-zero exit code…
3 properties
1 required
UnencryptedCredentialsList
object
List of unencrypted credentials for accessing device.
2 properties
PublicIpAddressConfiguration
object
The public IP Address configuration of the networking configuration of a Pool.
2 properties
CloudServiceConfiguration_2
object
2 properties
1 required
BatchTaskSchedulingPolicy
object
Specifies how Tasks should be distributed across Compute Nodes.
1 property
1 required
DataImportDetails
object
Details of the data to be used for importing data to azure.
2 properties
1 required
SecurityProfileUpdate
object
Specifies the security profile settings for the virtual machine or virtual machine scale set.
3 properties
NfsMountConfiguration
object
Information used to connect to an NFS file system.
3 properties
2 required
BatchTaskContainerSettings
object
The container settings for a Task.
4 properties
1 required
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
#Job
Where this information came from
This is an independent, third-party profile of Microsoft Azure Jobs 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.