Authentication - batch-batchservice API | Specway Docs

Own Workload? Customize your docs with AI search, analytics, and more.

Claim your docs

Back to APIs Authentication

Endpoints

Gets information about the specified Application.GET
Lists all of the applications available in the specified Account.GET

Adds a Certificate to the specified Account.POST
Lists all of the Certificates that have been added to the specified Account.GET

Cancels a failed deletion of a Certificate from the specified Account.POST
Certificate_GetGET
Deletes a Certificate from the specified Account.DELETE

Adds a collection of Tasks to the specified Job.POST
Adds a Job to the specified Account.POST
Adds a Task to the specified Job.POST
Deletes a Job.DELETE
Deletes a Task from the specified Job.DELETE
Deletes the specified Task file from the Compute Node where the Task ran.DELETE
Disables the specified Job, preventing new Tasks from running.POST
Enables the specified Job, allowing new Tasks to run.POST
File_GetFromTaskGET
Gets information about the specified Job.GET
Gets information about the specified Task.GET
Gets the Task counts for the specified Job.GET
Lists all of the Jobs in the specified Account.GET
Lists all of the subtasks that are associated with the specified multi-instance Task.GET
Lists all of the Tasks that are associated with the specified Job.GET
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
Lists the files in a Task's directory on its Compute Node.GET
Reactivates a Task, allowing it to run again even if its retry count has been exhausted.POST
Task_UpdatePUT
Terminates the specified Job, marking it as completed.POST
Terminates the specified Task.POST
Updates the properties of the specified Job.PUT
Updates the properties of the specified Job.PATCH

Adds a Job Schedule to the specified Account.POST
Deletes a Job Schedule from the specified Account.DELETE
Disables a Job Schedule.POST
Enables a Job Schedule.POST
JobSchedule_GetGET
Lists all of the Job Schedules in the specified Account.GET
Lists the Jobs that have been created under the specified Job Schedule.GET
Terminates a Job Schedule.POST
Updates the properties of the specified Job Schedule.PUT
Updates the properties of the specified Job Schedule.PATCH

Gets lifetime summary statistics for all of the Jobs in the specified Account.GET

Gets lifetime summary statistics for all of the Pools in the specified Account.GET

Account_ListPoolNodeCountsGET

Adds a Pool to the specified Account.POST
Adds a user Account to the specified Compute Node.POST
Changes the number of Compute Nodes that are assigned to a Pool.POST
Deletes a Pool from the specified Account.DELETE
Deletes a user Account from the specified Compute Node.DELETE
Deletes the specified file from the Compute Node.DELETE
Disables automatic scaling for a Pool.POST
Disables Task scheduling on the specified Compute Node.POST
Enables automatic scaling for a Pool.POST
Enables Task scheduling on the specified Compute Node.POST
File_GetFromComputeNodeGET
Gets information about the specified Compute Node.GET
Gets the Remote Desktop Protocol file for the specified Compute Node.GET
Gets the result of evaluating an automatic scaling formula on the Pool.POST
Gets the settings required for remote login to a Compute Node.GET
Lists all of the files in Task directories on the specified Compute Node.GET
Lists all of the Pools in the specified Account.GET
Lists the Compute Nodes in the specified Pool.GET
Pool_GetGET
Reinstalls the operating system on the specified Compute Node.POST
Removes Compute Nodes from the specified Pool.POST
Restarts the specified Compute Node.POST
Stops an ongoing resize operation on the Pool.POST
Updates the password and expiration time of a user Account on the specified Compute Node.PUT
Updates the properties of the specified Pool.PATCH
Updates the properties of the specified Pool.POST
Upload Azure Batch service log files from the specified Compute Node to Azure Blob Storage.POST

Lists the usage metrics, aggregated by Pool across individual time intervals, for the specified Account.GET

Lists all Virtual Machine Images supported by the Azure Batch service.GET

Authentication

How to authenticate with the BatchService API.

API Key

API Key

This API uses API key authentication. Include your API key in requests to authenticate.

Workload

Powered by Specway

Own Workload? Customize your docs with AI search, analytics, and more.

Claim your docs

Back to APIs Authentication

Endpoints

Gets information about the specified Application.GET
Lists all of the applications available in the specified Account.GET

Adds a Certificate to the specified Account.POST
Lists all of the Certificates that have been added to the specified Account.GET

Cancels a failed deletion of a Certificate from the specified Account.POST
Certificate_GetGET
Deletes a Certificate from the specified Account.DELETE

Adds a collection of Tasks to the specified Job.POST
Adds a Job to the specified Account.POST
Adds a Task to the specified Job.POST
Deletes a Job.DELETE
Deletes a Task from the specified Job.DELETE
Deletes the specified Task file from the Compute Node where the Task ran.DELETE
Disables the specified Job, preventing new Tasks from running.POST
Enables the specified Job, allowing new Tasks to run.POST
File_GetFromTaskGET
Gets information about the specified Job.GET
Gets information about the specified Task.GET
Gets the Task counts for the specified Job.GET
Lists all of the Jobs in the specified Account.GET
Lists all of the subtasks that are associated with the specified multi-instance Task.GET
Lists all of the Tasks that are associated with the specified Job.GET
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
Lists the files in a Task's directory on its Compute Node.GET
Reactivates a Task, allowing it to run again even if its retry count has been exhausted.POST
Task_UpdatePUT
Terminates the specified Job, marking it as completed.POST
Terminates the specified Task.POST
Updates the properties of the specified Job.PUT
Updates the properties of the specified Job.PATCH

Adds a Job Schedule to the specified Account.POST
Deletes a Job Schedule from the specified Account.DELETE
Disables a Job Schedule.POST
Enables a Job Schedule.POST
JobSchedule_GetGET
Lists all of the Job Schedules in the specified Account.GET
Lists the Jobs that have been created under the specified Job Schedule.GET
Terminates a Job Schedule.POST
Updates the properties of the specified Job Schedule.PUT
Updates the properties of the specified Job Schedule.PATCH

Gets lifetime summary statistics for all of the Jobs in the specified Account.GET

Gets lifetime summary statistics for all of the Pools in the specified Account.GET

Account_ListPoolNodeCountsGET

Adds a Pool to the specified Account.POST
Adds a user Account to the specified Compute Node.POST
Changes the number of Compute Nodes that are assigned to a Pool.POST
Deletes a Pool from the specified Account.DELETE
Deletes a user Account from the specified Compute Node.DELETE
Deletes the specified file from the Compute Node.DELETE
Disables automatic scaling for a Pool.POST
Disables Task scheduling on the specified Compute Node.POST
Enables automatic scaling for a Pool.POST
Enables Task scheduling on the specified Compute Node.POST
File_GetFromComputeNodeGET
Gets information about the specified Compute Node.GET
Gets the Remote Desktop Protocol file for the specified Compute Node.GET
Gets the result of evaluating an automatic scaling formula on the Pool.POST
Gets the settings required for remote login to a Compute Node.GET
Lists all of the files in Task directories on the specified Compute Node.GET
Lists all of the Pools in the specified Account.GET
Lists the Compute Nodes in the specified Pool.GET
Pool_GetGET
Reinstalls the operating system on the specified Compute Node.POST
Removes Compute Nodes from the specified Pool.POST
Restarts the specified Compute Node.POST
Stops an ongoing resize operation on the Pool.POST
Updates the password and expiration time of a user Account on the specified Compute Node.PUT
Updates the properties of the specified Pool.PATCH
Updates the properties of the specified Pool.POST
Upload Azure Batch service log files from the specified Compute Node to Azure Blob Storage.POST

Lists the usage metrics, aggregated by Pool across individual time intervals, for the specified Account.GET

Lists all Virtual Machine Images supported by the Azure Batch service.GET

Authentication

How to authenticate with the BatchService API.

API Key

API Key

This API uses API key authentication. Include your API key in requests to authenticate.

Workload

Powered by Specway