{"@context": "https://schema.org", "@type": "WebAPI", "name": "BatchService API", "description": "A client for issuing REST requests to the Azure Batch service.", "provider": {"@type": "Organization", "name": "windows.net"}, "documentation": "https://raw.githubusercontent.com/Azure/azure-rest-api-specs/master/specification/batch/data-plane/Microsoft.Batch/stable/2018-08-01.7.0/BatchService.json"}
Index / APIs / windows.net

BatchService API

A client for issuing REST requests to the Azure Batch service.

Every row below was read from the vendor's own OpenAPI document. The summary text is theirs. What this registry adds is that each operation is indexed with its method, path, base URL and auth scheme, so a search for a capability can answer with a call rather than a name, and that the endpoint is probed on a schedule.

Specifications as held by the APIs.guru corpus, whose newest record is 2023-04-21. Operations the vendor has added since are not listed here; the origin links above are the vendor's own current documents.

base URLs: https://batch.core.windows.net https://graph.windows.net

auth: o a u t h 2

find it by capability: POST /search {"query":{"text":"..."}} returns these operations with their invocation detail. Connect any agent client.

BatchService v2018-08-01.7.0

A client for issuing REST requests to the Azure Batch service.

methodpathwhat the vendor says it does
GET/applicationsLists all of the applications available in the specified account. This operation returns only applications and
GET/applications/{applicationId}Gets information about the specified application. This operation returns only applications and versions that a
GET/certificatesLists all of the certificates that have been added to the specified account. Certificates
POST/certificatesAdds a certificate to the specified account. Certificates
GET/certificates(thumbprintAlgorithm={thumbprintAlgorithm},thumbprint={thumbprint})Gets information about the specified certificate. Certificates
DELETE/certificates(thumbprintAlgorithm={thumbprintAlgorithm},thumbprint={thumbprint})Deletes a certificate from the specified account. You cannot delete a certificate if a resource (pool or compu
POST/certificates(thumbprintAlgorithm={thumbprintAlgorithm},thumbprint={thumbprint})/canceldeleteCancels a failed deletion of a certificate from the specified account. If you try to delete a certificate that
GET/jobsLists all of the jobs in the specified account. Jobs
POST/jobsAdds a job to the specified account. The Batch service supports two ways to control the work done as part of a
GET/jobs/{jobId}Gets information about the specified job. Jobs
PUT/jobs/{jobId}Updates the properties of the specified job. This fully replaces all the updatable properties of the job. For
PATCH/jobs/{jobId}Updates the properties of the specified job. This replaces only the job properties specified in the request. F
DELETE/jobs/{jobId}Deletes a job. Deleting a job also deletes all tasks that are part of that job, and all job statistics. This a
POST/jobs/{jobId}/addtaskcollectionAdds a collection of tasks to the specified job. Note that each task must have a unique ID. The Batch service
POST/jobs/{jobId}/disableDisables the specified job, preventing new tasks from running. The Batch Service immediately moves the job to
POST/jobs/{jobId}/enableEnables the specified job, allowing new tasks to run. When you call this API, the Batch service sets a disable
GET/jobs/{jobId}/jobpreparationandreleasetaskstatusLists the execution status of the Job Preparation and Job Release task for the specified job across the comput
GET/jobs/{jobId}/taskcountsGets the task counts for the specified job. Task counts provide a count of the tasks by active, running or com
GET/jobs/{jobId}/tasksLists all of the tasks that are associated with the specified job. For multi-instance tasks, information such
POST/jobs/{jobId}/tasksAdds a task to the specified job. The maximum lifetime of a task from addition to completion is 7 days. If a t
GET/jobs/{jobId}/tasks/{taskId}Gets information about the specified task. For multi-instance tasks, information such as affinityId, execution
PUT/jobs/{jobId}/tasks/{taskId}Updates the properties of the specified task. Tasks
DELETE/jobs/{jobId}/tasks/{taskId}Deletes a task from the specified job. When a task is deleted, all of the files in its directory on the comput
GET/jobs/{jobId}/tasks/{taskId}/filesLists the files in a task's directory on its compute node. Files
GET/jobs/{jobId}/tasks/{taskId}/files/{filePath}Returns the content of the specified task file. Files
DELETE/jobs/{jobId}/tasks/{taskId}/files/{filePath}Deletes the specified task file from the compute node where the task ran. Files
POST/jobs/{jobId}/tasks/{taskId}/reactivateReactivates a task, allowing it to run again even if its retry count has been exhausted. Reactivation makes a
GET/jobs/{jobId}/tasks/{taskId}/subtasksinfoLists all of the subtasks that are associated with the specified multi-instance task. If the task is not a mul
POST/jobs/{jobId}/tasks/{taskId}/terminateTerminates the specified task. When the task has been terminated, it moves to the completed state. For multi-i
POST/jobs/{jobId}/terminateTerminates the specified job, marking it as completed. When a Terminate Job request is received, the Batch ser
GET/jobschedulesLists all of the job schedules in the specified account. JobSchedules
POST/jobschedulesAdds a job schedule to the specified account. JobSchedules
GET/jobschedules/{jobScheduleId}Gets information about the specified job schedule. JobSchedules
PUT/jobschedules/{jobScheduleId}Updates the properties of the specified job schedule. This fully replaces all the updatable properties of the
PATCH/jobschedules/{jobScheduleId}Updates the properties of the specified job schedule. This replaces only the job schedule properties specified
DELETE/jobschedules/{jobScheduleId}Deletes a job schedule from the specified account. When you delete a job schedule, this also deletes all jobs
POST/jobschedules/{jobScheduleId}/disableDisables a job schedule. No new jobs will be created until the job schedule is enabled again. JobSchedules
POST/jobschedules/{jobScheduleId}/enableEnables a job schedule. JobSchedules
GET/jobschedules/{jobScheduleId}/jobsLists the jobs that have been created under the specified job schedule. Jobs
POST/jobschedules/{jobScheduleId}/terminateTerminates a job schedule. JobSchedules

and 33 more operation(s) in this specification, all searchable.

specification origin: https://raw.githubusercontent.com/Azure/azure-rest-api-specs/master/specification/batch/da

GraphRbacManagementClient v1.6

The Graph RBAC Management Client

methodpathwhat the vendor says it does
GET/{tenantID}/applicationsLists applications by filter parameters. Application
POST/{tenantID}/applicationsCreate a new application. Application
GET/{tenantID}/applications/{applicationObjectId}Get an application by object ID. Application
PATCH/{tenantID}/applications/{applicationObjectId}Update an existing application. Application
DELETE/{tenantID}/applications/{applicationObjectId}Delete an application. Application
POST/{tenantID}/applications/{applicationObjectId}/$links/ownersAdd an owner to an application. ApplicationOwners
DELETE/{tenantID}/applications/{applicationObjectId}/$links/owners/{ownerObjectId}Remove a member from owners. ApplicationOwners
GET/{tenantID}/applications/{applicationObjectId}/keyCredentialsGet the keyCredentials associated with an application. ApplicationKeyCredentials
PATCH/{tenantID}/applications/{applicationObjectId}/keyCredentialsUpdate the keyCredentials associated with an application. ApplicationKeyCredentials
GET/{tenantID}/applications/{applicationObjectId}/ownersDirectory objects that are owners of the application. The owners are a set of non-admin users who are allowed
GET/{tenantID}/applications/{applicationObjectId}/passwordCredentialsGet the passwordCredentials associated with an application. ApplicationPasswordCredentials
PATCH/{tenantID}/applications/{applicationObjectId}/passwordCredentialsUpdate passwordCredentials associated with an application. ApplicationPasswordCredentials
GET/{tenantID}/deletedApplicationsGets a list of deleted applications in the directory. deletedApplications
DELETE/{tenantID}/deletedApplications/{applicationObjectId}Hard-delete an application. Application
POST/{tenantID}/deletedApplications/{objectId}/restoreRestores the deleted application in the directory. deletedApplications
GET/{tenantID}/domainsGets a list of domains for the current tenant. Domain
GET/{tenantID}/domains/{domainName}Gets a specific domain in the current tenant. Domain
POST/{tenantID}/getObjectsByObjectIdsGets the directory objects specified in a list of object IDs. You can also specify which resource collections
GET/{tenantID}/groupsGets list of groups for the current tenant. Group
POST/{tenantID}/groupsCreate a group in the directory. Group
POST/{tenantID}/groups/{groupObjectId}/$links/membersAdd a member to a group. Group
DELETE/{tenantID}/groups/{groupObjectId}/$links/members/{memberObjectId}Remove a member from a group. Group
GET/{tenantID}/groups/{objectId}Gets group information from the directory. Group
DELETE/{tenantID}/groups/{objectId}Delete a group from the directory. Group
POST/{tenantID}/groups/{objectId}/$links/ownersAdd an owner to a group. GroupsOwners
DELETE/{tenantID}/groups/{objectId}/$links/owners/{ownerObjectId}Remove a member from owners. GroupsOwners
POST/{tenantID}/groups/{objectId}/getMemberGroupsGets a collection of object IDs of groups of which the specified group is a member. Group
GET/{tenantID}/groups/{objectId}/membersGets the members of a group. Group
GET/{tenantID}/groups/{objectId}/ownersDirectory objects that are owners of the group. The owners are a set of non-admin users who are allowed to mod
POST/{tenantID}/isMemberOfChecks whether the specified user, group, contact, or service principal is a direct or transitive member of th
GET/{tenantID}/meGets the details for the currently logged-in user. SignedInUser
GET/{tenantID}/me/ownedObjectsGet the list of directory objects that are owned by the user. SignedInUser
GET/{tenantID}/oauth2PermissionGrantsQueries OAuth2 permissions grants for the relevant SP ObjectId of an app. OAuth2PermissionGrant_List
POST/{tenantID}/oauth2PermissionGrantsGrants OAuth2 permissions for the relevant resource Ids of an app. OAuth2PermissionGrant_Create
DELETE/{tenantID}/oauth2PermissionGrants/{objectId}Delete a OAuth2 permission grant for the relevant resource Ids of an app. OAuth2PermissionGrant_delete
GET/{tenantID}/servicePrincipalsGets a list of service principals from the current tenant. ServicePrincipal
POST/{tenantID}/servicePrincipalsCreates a service principal in the directory. ServicePrincipal
GET/{tenantID}/servicePrincipals/{objectId}Gets service principal information from the directory. Query by objectId or pass a filter to query by appId Se
PATCH/{tenantID}/servicePrincipals/{objectId}Updates a service principal in the directory. ServicePrincipal
DELETE/{tenantID}/servicePrincipals/{objectId}Deletes a service principal from the directory. ServicePrincipal

and 16 more operation(s) in this specification, all searchable.

specification origin: https://raw.githubusercontent.com/Azure/azure-rest-api-specs/master/specification/graphrba

nothing on this page is a rating, an endorsement or a claim about quality. Reachability is what our probes observed from one network; answering is a floor under usefulness, not a measure of it.