Job - Disable

Désactive la tâche spécifiée, ce qui empêche l’exécution de nouvelles tâches.
Le service batch déplace immédiatement le travail vers l’état de désactivation. Batch utilise ensuite le paramètre disableTasks pour déterminer la marche à suivre pour les tâches en cours d’exécution du travail. Le travail reste dans l’état désactivé jusqu’à ce que l’opération de désactivation soit terminée et que toutes les tâches ont é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 jusqu’à ce qu’elle repasse à l’état actif. Si vous essayez de désactiver un travail qui est dans un État autre que actif, désactivé ou désactivé, la demande échoue avec le code d’État 409.

POST {batchUrl}/jobs/{jobId}/disable?api-version=2020-09-01.12.0
POST {batchUrl}/jobs/{jobId}/disable?timeout={timeout}&api-version=2020-09-01.12.0

Paramètres URI

Name In Required 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 pendant laquelle le serveur peut consacrer le traitement de la requête, en secondes. La valeur par défaut est 30 secondes.

En-tête de la demande

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

Name Required Type Description
client-request-id
  • string
uuid

Identité de demande générée par l’appelant, sous la forme d’un GUID sans décoration, par exemple 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. En général, les bibliothèques clientes le définissent sur l’horloge système actuelle ; Définissez-la explicitement si vous appelez l’API REST directement.

If-Match
  • string

Valeur ETag associée à la version de la ressource connue du client. L’opération sera exécuté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 sera exécuté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

Horodateur qui indique l’heure de la dernière modification de la ressource connue du client. L’opération sera exécuté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

Horodateur qui indique l’heure de la dernière modification de la ressource connue du client. L’opération sera exécuté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"

Name Required Type Description
disableTasks True

Que faire avec les tâches actives associées à la tâche.

Réponses

Name Type Description
202 Accepted

La demande au service batch a réussi.

Headers

  • client-request-id: string
  • request-id: string
  • ETag: string
  • Last-Modified: string
  • DataServiceId: string
Other Status Codes

Erreur du service batch.

Sécurité

azure_auth

Azure Active Directory le Flow OAuth2

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

Scopes

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

Authorization

Type: apiKey
In: header

Exemples

Job disable

Sample Request

POST account.region.batch.azure.com/jobs/jobId/disable?api-version=2020-09-01.12.0
client-request-id: 00000000-0000-0000-0000-000000000000
ocp-date: Fri, 17 Feb 2017 00:00:00 GMT
{
  "disableTasks": "terminate"
}

Sample Response

Définitions

BatchError

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

BatchErrorDetail

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

DisableJobOption

Que faire avec les tâches actives associées à la tâche.

ErrorMessage

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

JobDisableParameter

Options de désactivation d’un travail.

BatchError

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

Name Type Description
code
  • string

Identificateur de l'erreur. Les codes sont invariants et sont destinés à être consommés par programmation.

message

Message décrivant l’erreur, destiné à être adapté à l’affichage dans une interface utilisateur.

values

Collection de paires clé-valeur contenant des détails supplémentaires sur l’erreur.

BatchErrorDetail

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

Name 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 à la tâche.

Name Type Description
requeue
  • string

Mettre fin aux tâches en cours d’exécution et les remettre en file d’attente. Les tâches sont réexécutées lorsque le travail est activé.

terminate
  • string

Terminer les tâches en cours d’exécution. Les tâches sont exécutées avec failureInfo indiquant qu’elles ont été arrêtées et ne sont pas exécutées à nouveau.

wait
  • string

Autoriser l’achèvement des tâches en cours d’exécution.

ErrorMessage

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

Name Type Description
lang
  • string

Code de langue du message d’erreur

value
  • string

Texte du message.

JobDisableParameter

Options de désactivation d’un travail.

Name Type Description
disableTasks

Que faire avec les tâches actives associées à la tâche.