Job - Disable

Service:

Batch Service

API Version:

2023-11-01.18.0

Désactive le travail spécifié, empêchant l’exécution de nouvelles tâches.
Le service Batch déplace immédiatement le travail à l’état de désactivation. Batch utilise ensuite le paramètre disableTasks pour déterminer ce qu’il faut faire avec les tâches en cours d’exécution du travail. Le travail reste à l’état de désactivation jusqu’à ce que l’opération de désactivation soit terminée et que toutes les tâches aient été traitées conformément à l’option disableTasks ; Le travail passe ensuite à l’état désactivé. Aucune nouvelle tâche n’est démarrée sous le travail tant qu’il ne revient pas à l’état actif. Si vous essayez de désactiver un travail qui se trouve dans un état autre que actif, désactivé ou désactivé, la requête échoue avec status code 409.

POST {batchUrl}/jobs/{jobId}/disable?api-version=2023-11-01.18.0

With optional parameters:

POST {batchUrl}/jobs/{jobId}/disable?timeout={timeout}&api-version=2023-11-01.18.0

Paramètres URI

Nom	Dans	Obligatoire	Type	Description
batchUrl	path	True	string	URL de base pour toutes les demandes de service Azure Batch.
jobId	path	True	string	ID du travail à désactiver.
api-version	query	True	string	Version de l’API cliente.
timeout	query		integer int32	Durée maximale que le serveur peut consacrer au traitement de la demande, en secondes. La valeur par défaut est 30 secondes.

En-tête de la demande

Media Types: "application/json; odata=minimalmetadata"

Nom	Obligatoire	Type	Description
client-request-id		string uuid	Identité de requête générée par l’appelant, sous la forme d’un GUID sans décoration telle que des accolades, par exemple 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0.
return-client-request-id		boolean	Indique si le serveur doit retourner le client-request-id dans la réponse.
ocp-date		string date-time-rfc1123	Heure à laquelle la demande a été émise. Les bibliothèques clientes définissent généralement cette valeur sur l’heure actuelle de l’horloge système ; définissez-la explicitement si vous appelez directement l’API REST.
If-Match		string	Valeur ETag associée à la version de la ressource connue du client. L’opération est effectuée uniquement si l’ETag actuel de la ressource sur le service correspond exactement à la valeur spécifiée par le client.
If-None-Match		string	Valeur ETag associée à la version de la ressource connue du client. L’opération est effectuée uniquement si l’ETag actuel de la ressource sur le service ne correspond pas à la valeur spécifiée par le client.
If-Modified-Since		string date-time-rfc1123	Horodatage indiquant l’heure de la dernière modification de la ressource connue du client. L’opération est effectuée uniquement si la ressource sur le service a été modifiée depuis l’heure spécifiée.
If-Unmodified-Since		string date-time-rfc1123	Horodatage indiquant l’heure de la dernière modification de la ressource connue du client. L’opération est effectuée uniquement si la ressource sur le service n’a pas été modifiée depuis l’heure spécifiée.

Corps de la demande

Media Types: "application/json; odata=minimalmetadata"

Nom	Obligatoire	Type	Description
disableTasks	True	DisableJobOption	Que faire avec les tâches actives associées au travail.

Réponses

Nom	Type	Description
202 Accepted		La demande adressée au service Batch a réussi. Headers client-request-id: string request-id: string ETag: string Last-Modified: string DataServiceId: string
Other Status Codes	BatchError	Erreur du service Batch.

Sécurité

azure_auth

flux de code d’authentification OAuth 2.0 Microsoft Entra

Type: oauth2
Flow: implicit
Authorization URL: https://login.microsoftonline.com/common/oauth2/authorize

Scopes

Nom	Description
user_impersonation	Emprunter l’identité de votre compte d’utilisateur

Authorization

Type: apiKey
In: header

Exemples

Job disable

Sample Request

HTTP

POST account.region.batch.azure.com/jobs/jobId/disable?api-version=2023-11-01.18.0



{
  "disableTasks": "terminate"
}

Sample Response

Status code:

202

Définitions

Nom	Description
BatchError	Réponse d’erreur reçue du service Azure Batch.
BatchErrorDetail	Élément d’informations supplémentaires inclus dans une réponse d’erreur Azure Batch.
DisableJobOption	Que faire avec les tâches actives associées au travail.
ErrorMessage	Message d’erreur reçu dans une réponse d’erreur Azure Batch.
JobDisableParameter	Options lors de la désactivation d’un travail.

BatchError

Réponse d’erreur reçue du service Azure Batch.

Nom	Type	Description
code	string	Identificateur de l'erreur. Les codes sont invariants et sont destinés à être consommés par programmation.
message	ErrorMessage	Message décrivant l’erreur, destiné à être affiché dans une interface utilisateur.
values	BatchErrorDetail[]	Collection de paires clé-valeur contenant des détails supplémentaires sur l’erreur.

BatchErrorDetail

Élément d’informations supplémentaires inclus dans une réponse d’erreur Azure Batch.

Nom	Type	Description
key	string	Identificateur spécifiant la signification de la propriété Value.
value	string	Informations supplémentaires incluses dans la réponse d’erreur.

DisableJobOption

Que faire avec les tâches actives associées au travail.

Nom	Type	Description
requeue	string	Arrêtez l’exécution des tâches et remettez-les en file d’attente. Les tâches s’exécutent à nouveau lorsque le travail est activé.
terminate	string	Arrêtez l’exécution des tâches. Les tâches seront terminées avec failureInfo, indiquant qu’elles ont été arrêtées et ne s’exécuteront pas à nouveau.
wait	string	Autoriser l’exécution des tâches en cours d’exécution.

ErrorMessage

Message d’erreur reçu dans une réponse d’erreur Azure Batch.

Nom	Type	Description
lang	string	Code de langue du message d’erreur
value	string	Texte du message.

JobDisableParameter

Options lors de la désactivation d’un travail.

Nom	Type	Description
disableTasks	DisableJobOption	Que faire avec les tâches actives associées au travail.