Partager via

Task - Update

  • Référence
Service:
Batch Service
Version d'API:
2024-07-01.20.0

Met à jour les propriétés de la tâche spécifiée.

PUT {batchUrl}/jobs/{jobId}/tasks/{taskId}?api-version=2024-07-01.20.0
Avec des paramètres facultatifs: 
PUT {batchUrl}/jobs/{jobId}/tasks/{taskId}?timeout={timeout}&api-version=2024-07-01.20.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 contenant la tâche.
taskId
 path True

string

ID de la tâche à mettre à jour.
api-version
 query True

string

Version de l’API cliente.
timeout
 query

integer

int32

Durée maximale pendant laquelle le serveur peut passer le traitement de la requête, en secondes. La valeur par défaut est de 30 secondes. Si la valeur est supérieure à 30, la valeur par défaut est utilisée à la place.

En-tête de la demande

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

Nom Obligatoire Type Description
client-request-id

string

uuid

L’identité de requête générée par l’appelant, sous la forme d’un GUID sans décoration telle que les accolades, par exemple 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0.
return-client-request-id

boolean

Indique si le serveur doit retourner l’ID 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 de l’horloge système actuelle ; définissez-le 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 n’est effectuée que 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 n’est effectuée que 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 dernière modification de la ressource connue du client. L’opération n’est effectuée que 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 dernière modification de la ressource connue du client. L’opération n’est effectuée que 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 Type Description
constraints

TaskConstraints

Contraintes qui s’appliquent à cette tâche.
Si elle est omise, la tâche reçoit les contraintes par défaut. Pour les tâches multi-instances, la mise à jour de l’heure de rétention s’applique uniquement à la tâche principale et non aux tâches subordonnées.

Réponses

Nom Type Description
200 OK

La demande adressée au service Batch a réussi.

En-têtes

  • 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 Microsoft Entra OAuth 2.0

Type: oauth2
Flux: implicit
URL d’autorisation: https://login.microsoftonline.com/common/oauth2/authorize

Étendues

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

Authorization

Type: apiKey
Dans: header

Exemples

Task update

Exemple de requête

PUT account.region.batch.azure.com/jobs/jobId/tasks/taskId?api-version=2024-07-01.20.0



{
  "constraints": {
    "maxWallClockTime": "PT1H",
    "maxTaskRetryCount": 3,
    "retentionTime": "PT1H"
  }
}

Exemple de réponse

Code d’état:
200

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.
ErrorMessage

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

Contraintes d’exécution à appliquer à une tâche.
TaskUpdateParameter

Ensemble de modifications à apporter à une tâche.

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 programme.
message

ErrorMessage

Message décrivant l’erreur, destiné à être adapté à l’affichage 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.

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.

TaskConstraints

Contraintes d’exécution à appliquer à une tâche.

Nom Type Description
maxTaskRetryCount

integer

Nombre maximal de nouvelles tentatives de la tâche. Le service Batch retente une tâche si son code de sortie n’est pas différent de zéro.
Notez que cette valeur contrôle spécifiquement le nombre de nouvelles tentatives pour l’exécutable de tâche en raison d’un code de sortie différent de zéro. Le service Batch essaiera la tâche une seule fois et peut ensuite réessayer jusqu’à cette limite. Par exemple, si le nombre maximal de nouvelles tentatives est égal à 3, Batch tente la tâche jusqu’à 4 fois (une tentative initiale et 3 nouvelles tentatives). Si le nombre maximal de nouvelles tentatives est égal à 0, le service Batch ne réessaye pas la tâche après la première tentative. Si le nombre maximal de nouvelles tentatives est -1, le service Batch retente la tâche sans limite, mais cela n’est pas recommandé pour une tâche de démarrage ou une tâche. La valeur par défaut est 0 (aucune nouvelle tentative).
maxWallClockTime

string

Durée maximale écoulée pendant laquelle la tâche peut s’exécuter, mesurée à partir du moment où la tâche démarre. Si la tâche ne se termine pas dans le délai imparti, le service Batch l’arrête.
S’il n’est pas spécifié, il n’existe aucune limite de temps sur la durée pendant laquelle la tâche peut s’exécuter.
retentionTime

string

Durée minimale de conservation du répertoire des tâches sur le nœud de calcul où elle s’est exécutée, à partir du moment où elle termine l’exécution. Après cette période, le service Batch peut supprimer le répertoire des tâches et tout son contenu.
La valeur par défaut est de 7 jours, c’est-à-dire que le répertoire des tâches est conservé pendant 7 jours, sauf si le nœud de calcul est supprimé ou si le travail est supprimé.

TaskUpdateParameter

Ensemble de modifications à apporter à une tâche.

Nom Type Description
constraints

TaskConstraints

Contraintes qui s’appliquent à cette tâche.
Si elle est omise, la tâche reçoit les contraintes par défaut. Pour les tâches multi-instances, la mise à jour de l’heure de rétention s’applique uniquement à la tâche principale et non aux tâches subordonnées.