When a job is disabled, the DisableJobOption.Wait parameter is documented incorrectly.

Question

When a job is disabled, the DisableJobOption.Wait parameter is documented incorrectly.

Nore Gabbidon 20

With the option of disabling a job there are three options in the DisableJobOption enum:

requeue
terminate
wait

The 'wait' option specifies the following in the documentation and SDK:

Allow currently running Tasks to complete.

I determined this to mean that all currently running tasks will complete, but any active tasks that were not running will remain, and the job will be disabled. This is NOT the case, instead ALL tasks within the Job at the time the job was marked as disabled will eventually complete, so the job will not disable until all tasks are completed.

This is highly misleading and has lead to issues with my approach. I was relying on the ability to be able to pause a job and restart it. However, I'm pretty sure now this is not the case. I think the documentation needs to be amended to make it clearer.

If there is a way to be able to pause and resume a job then any advice would be welcome.

Nore Gabbidon 20 Reputation points

2025-07-25T13:42:05.1066667+00:00

Hi

Thanks for the clarification. I do think the documentation should be amended so it's clearer. The current description implies only running tasks are waited to complete, and there's a clear distinction between task states in Azure Batch. For my part, as long as I've added appropriate guardrails and/or idempotency in my tasks, then I can achieve my original goal. I still think it would be a good feature to have: the ability to disable and subsequently pause all tasks that haven't run, and only have the currently running tasks run to their completion.
Durga Reshma Malthi 9,355 Reputation points Microsoft External Staff Moderator

2025-07-25T14:13:46.8233333+00:00

Hi Nore Gabbidon

You are right. You can share the insights via developer community - https://developercommunity.visualstudio.com/homeIf you found the information helpful, please click "Upvote" on the post to let us know and consider accepting the answer as the token of appreciation. Thank You.
Durga Reshma Malthi 9,355 Reputation points Microsoft External Staff Moderator

2025-07-28T08:24:08.5233333+00:00

Hi Nore Gabbidon

Just checking in to see if you had a chance to review the response provided to your question.

Feel free to reach out if you have any further queries.

If you found the information helpful, please click "Upvote" on the post to let us know and consider accepting the answer as the token of appreciation. Thank You.

Accepted answer

0 additional answers

Your answer

Nore Gabbidon 20 Reputation points

2025-07-25T13:42:05.1066667+00:00

Hi

Thanks for the clarification. I do think the documentation should be amended so it's clearer. The current description implies only running tasks are waited to complete, and there's a clear distinction between task states in Azure Batch. For my part, as long as I've added appropriate guardrails and/or idempotency in my tasks, then I can achieve my original goal. I still think it would be a good feature to have: the ability to disable and subsequently pause all tasks that haven't run, and only have the currently running tasks run to their completion.
Durga Reshma Malthi 9,355 Reputation points Microsoft External Staff Moderator

2025-07-25T14:13:46.8233333+00:00

Hi Nore Gabbidon

You are right. You can share the insights via developer community - https://developercommunity.visualstudio.com/homeIf you found the information helpful, please click "Upvote" on the post to let us know and consider accepting the answer as the token of appreciation. Thank You.
Durga Reshma Malthi 9,355 Reputation points Microsoft External Staff Moderator

2025-07-28T08:24:08.5233333+00:00

Hi Nore Gabbidon

Just checking in to see if you had a chance to review the response provided to your question.

Feel free to reach out if you have any further queries.

If you found the information helpful, please click "Upvote" on the post to let us know and consider accepting the answer as the token of appreciation. Thank You.

Answer 1

Durga Reshma Malthi 9,355 Microsoft External Staff Moderator

Hi Nore Gabbidon

As per this document - https://learn.microsoft.com/en-us/dotnet/api/microsoft.azure.batch.common.disablejoboption?view=azure-dotnet

requeue: This option typically allows the job to be requeued for execution later, effectively canceling the current execution and placing it back in the queue.
terminate: This option immediately stops the job and all associated tasks, regardless of their current state.
wait: As you noted, this option allows currently running tasks to complete. However, it appears that the job will not be marked as disabled until all tasks (including those that are queued or pending) have completed.

You are right, it would be beneficial for the documentation to clarify this point.

If your goal is to pause and resume a job, the current behavior of the wait option may not meet your needs.

Hope this helps!

Please Let me know if you have any queries.

Durga Reshma Malthi 9,355 Reputation points Microsoft External Staff Moderator

2025-07-29T08:06:25.0133333+00:00

Hi Nore Gabbidon

Just checking in to see if you had a chance to review the response provided to your question.

Feel free to reach out if you have any further queries.

If you found the information helpful, please click "Upvote" on the post to let us know and consider accepting the answer as the token of appreciation. Thank You.
Durga Reshma Malthi 9,355 Reputation points Microsoft External Staff Moderator

2025-07-29T10:52:50.7266667+00:00

Hi Nore Gabbidon

We have noticed that you have rated an answer as not helpful. We appreciate your feedback and are committed to improving your experience with the Q&A. Any specific details or clarification you are expecting please let us know.

Share via

When a job is disabled, the DisableJobOption.Wait parameter is documented incorrectly.

0 additional answers

Your answer