Task - Update

Service:

Batch Service

API-versie:

2024-07-01.20.0

Hiermee worden de eigenschappen van de opgegeven taak bijgewerkt.

PUT {batchUrl}/jobs/{jobId}/tasks/{taskId}?api-version=2024-07-01.20.0

Met optionele parameters:

PUT {batchUrl}/jobs/{jobId}/tasks/{taskId}?timeout={timeout}&api-version=2024-07-01.20.0

URI-parameters

Name	In	Vereist	Type	Description
batchUrl	path	True	string	De basis-URL voor alle Azure Batch-serviceaanvragen.
jobId	path	True	string	De id van de taak die de taak bevat.
taskId	path	True	string	De id van de taak die moet worden bijgewerkt.
api-version	query	True	string	Client-API-versie.
timeout	query		integer int32	De maximale tijd die de server kan besteden aan het verwerken van de aanvraag, in seconden. De standaardwaarde is 30 seconden. Als de waarde groter is dan 30, wordt in plaats daarvan de standaardwaarde gebruikt.

Aanvraagkoptekst

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

Name	Vereist	Type	Description
client-request-id		string uuid	De door de aanroeper gegenereerde aanvraagidentiteit, in de vorm van een GUID zonder decoratie, zoals accolades, bijvoorbeeld 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0.
return-client-request-id		boolean	Of de server de clientaanvraag-id in het antwoord moet retourneren.
ocp-date		string date-time-rfc1123	Het tijdstip waarop de aanvraag is uitgegeven. Clientbibliotheken stellen dit doorgaans in op de huidige kloktijd van het systeem; stel deze expliciet in als u de REST API rechtstreeks aanroept.
If-Match		string	Een ETag-waarde die is gekoppeld aan de versie van de resource die bekend is bij de client. De bewerking wordt alleen uitgevoerd als de huidige ETag van de resource op de service exact overeenkomt met de waarde die is opgegeven door de client.
If-None-Match		string	Een ETag-waarde die is gekoppeld aan de versie van de resource die bekend is bij de client. De bewerking wordt alleen uitgevoerd als de huidige ETag van de resource op de service niet overeenkomt met de waarde die is opgegeven door de client.
If-Modified-Since		string date-time-rfc1123	Een tijdstempel die de laatst gewijzigde tijd aangeeft van de resource die bekend is bij de client. De bewerking wordt alleen uitgevoerd als de resource op de service is gewijzigd sinds de opgegeven tijd.
If-Unmodified-Since		string date-time-rfc1123	Een tijdstempel die de laatst gewijzigde tijd aangeeft van de resource die bekend is bij de client. De bewerking wordt alleen uitgevoerd als de resource op de service niet is gewijzigd sinds de opgegeven tijd.

Aanvraagbody

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

Name	Type	Description
constraints	TaskConstraints	Beperkingen die van toepassing zijn op deze taak. Als u dit weglaat, krijgt de taak de standaardbeperkingen. Voor taken met meerdere exemplaren geldt het bijwerken van de bewaartijd alleen voor de primaire taak en niet voor subtaken.

Antwoorden

Name	Type	Description
200 OK		De aanvraag voor de Batch-service is geslaagd. Kopteksten client-request-id: string request-id: string ETag: string Last-Modified: string DataServiceId: string
Other Status Codes	BatchError	De fout van de Batch-service.

Beveiliging

azure_auth

Microsoft Entra OAuth 2.0-verificatiecodestroom

Type: oauth2
Stroom: implicit
Autorisatie-URL: https://login.microsoftonline.com/common/oauth2/authorize

Bereiken

Name	Description
user_impersonation	Uw gebruikersaccount imiteren

Authorization

Type: apiKey
In: header

Voorbeelden

Task update

Voorbeeldaanvraag

HTTP

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



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

Voorbeeldrespons

Statuscode:

200

Definities

Name	Description
BatchError	Er is een foutbericht ontvangen van de Azure Batch-service.
BatchErrorDetail	Een item met aanvullende informatie die is opgenomen in een Azure Batch-foutreactie.
ErrorMessage	Een foutbericht dat is ontvangen in een Azure Batch-foutreactie.
TaskConstraints	Uitvoeringsbeperkingen die van toepassing zijn op een taak.
TaskUpdateParameter	De set wijzigingen die moeten worden aangebracht in een taak.

BatchError

Er is een foutbericht ontvangen van de Azure Batch-service.

Name	Type	Description
code	string	Een id voor de fout. Codes zijn invariant en zijn bedoeld om programmatisch te worden gebruikt.
message	ErrorMessage	Een bericht met een beschrijving van de fout, bedoeld om te worden weergegeven in een gebruikersinterface.
values	BatchErrorDetail[]	Een verzameling sleutel-waardeparen met aanvullende informatie over de fout.

BatchErrorDetail

Een item met aanvullende informatie die is opgenomen in een Azure Batch-foutreactie.

Name	Type	Description
key	string	Een id die de betekenis van de eigenschap Waarde aangeeft.
value	string	De aanvullende informatie die is opgenomen in het foutbericht.

ErrorMessage

Een foutbericht dat is ontvangen in een Azure Batch-foutreactie.

Name	Type	Description
lang	string	De taalcode van het foutbericht
value	string	De tekst van het bericht.

TaskConstraints

Uitvoeringsbeperkingen die van toepassing zijn op een taak.

Name	Type	Description
maxTaskRetryCount	integer	Het maximum aantal keren dat de taak opnieuw kan worden geprobeerd. De Batch-service probeert een taak opnieuw uit te voeren als de afsluitcode niet-nul is. Houd er rekening mee dat deze waarde specifiek het aantal nieuwe pogingen voor het uitvoerbare taakbestand bepaalt vanwege een niet-nul-afsluitcode. De Batch-service probeert de taak eenmaal uit en probeert vervolgens opnieuw tot deze limiet. Als het maximumaantal nieuwe pogingen bijvoorbeeld 3 is, probeert Batch de taak maximaal 4 keer (één eerste poging en drie nieuwe pogingen). Als het maximumaantal nieuwe pogingen 0 is, voert de Batch-service de taak na de eerste poging niet opnieuw uit. Als het maximumaantal nieuwe pogingen -1 is, probeert de Batch-service de taak opnieuw zonder limiet, maar dit wordt niet aanbevolen voor een begintaak of een andere taak. De standaardwaarde is 0 (geen nieuwe pogingen).
maxWallClockTime	string	De maximale verstreken tijd die de taak kan uitvoeren, gemeten vanaf het moment dat de taak wordt gestart. Als de taak niet binnen de tijdslimiet is voltooid, beëindigt de Batch-service deze. Als dit niet is opgegeven, is er geen tijdslimiet voor hoe lang de taak kan worden uitgevoerd.
retentionTime	string	De minimale tijd voor het behouden van de taakmap op het rekenknooppunt waarop het is uitgevoerd, vanaf het moment dat de uitvoering is voltooid. Na deze tijd kan de Batch-service de map Taak en alle inhoud ervan verwijderen. De standaardwaarde is 7 dagen, d.w. de map Taak wordt 7 dagen bewaard, tenzij het rekenknooppunt wordt verwijderd of de taak wordt verwijderd.

TaskUpdateParameter

De set wijzigingen die moeten worden aangebracht in een taak.

Name	Type	Description
constraints	TaskConstraints	Beperkingen die van toepassing zijn op deze taak. Als u dit weglaat, krijgt de taak de standaardbeperkingen. Voor taken met meerdere exemplaren geldt het bijwerken van de bewaartijd alleen voor de primaire taak en niet voor subtaken.