Dela via

Task - Update

  • Referens
Tjänst:
Batch Service
API-version:
2024-07-01.20.0

Uppdaterar egenskaperna för den angivna aktiviteten.

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

URI-parametrar

Name I Obligatorisk Typ Description
batchUrl
 path True

string

Bas-URL:en för alla Azure Batch-tjänstbegäranden.
jobId
 path True

string

ID:t för jobbet som innehåller uppgiften.
taskId
 path True

string

ID:t för uppgiften som ska uppdateras.
api-version
 query True

string

Klient-API-version.
timeout
 query

integer

int32

Den maximala tid som servern kan ägna åt att bearbeta begäran i sekunder. Standardvärdet är 30 sekunder. Om värdet är större än 30 används standardvärdet i stället.

Begärandehuvud

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

Name Obligatorisk Typ Description
client-request-id

string

uuid

Den anropargenererade begärandeidentiteten i form av ett GUID utan dekoration, till exempel klammerparenteser, t.ex. 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0.
return-client-request-id

boolean

Om servern ska returnera klient-request-id i svaret.
ocp-date

string

date-time-rfc1123

Den tid då begäran utfärdades. Klientbibliotek anger vanligtvis detta till den aktuella systemklockatiden. ange det explicit om du anropar REST-API:et direkt.
If-Match

string

Ett ETag-värde som är associerat med den version av resursen som är känd för klienten. Åtgärden utförs endast om resursens aktuella ETag på tjänsten exakt matchar det värde som anges av klienten.
If-None-Match

string

Ett ETag-värde som är associerat med den version av resursen som är känd för klienten. Åtgärden utförs endast om resursens aktuella ETag på tjänsten inte matchar det värde som anges av klienten.
If-Modified-Since

string

date-time-rfc1123

En tidsstämpel som anger den senaste ändrade tiden för resursen som är känd för klienten. Åtgärden utförs endast om resursen i tjänsten har ändrats sedan den angivna tiden.
If-Unmodified-Since

string

date-time-rfc1123

En tidsstämpel som anger den senaste ändrade tiden för resursen som är känd för klienten. Åtgärden utförs endast om resursen på tjänsten inte har ändrats sedan den angivna tiden.

Begärandetext

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

Name Typ Description
constraints

TaskConstraints

Begränsningar som gäller för den här uppgiften.
Om den utelämnas får aktiviteten standardbegränsningarna. För aktiviteter med flera instanser gäller uppdatering av kvarhållningstiden endast för den primära aktiviteten och inte underaktiviteter.

Svar

Name Typ Description
200 OK

Begäran till Batch-tjänsten lyckades.

Sidhuvuden

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

BatchError

Felet från Batch-tjänsten.

Säkerhet

azure_auth

Autentiseringskodflöde för Microsoft Entra OAuth 2.0

Typ: oauth2
Flow: implicit
Auktoriseringswebbadress: https://login.microsoftonline.com/common/oauth2/authorize

Omfattningar

Name Description
user_impersonation Personifiera ditt användarkonto

Authorization

Typ: apiKey
I: header

Exempel

Task update

Exempelbegäran

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



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

Exempelsvar

Statuskod:
200

Definitioner

Name Description
BatchError

Ett felsvar som tagits emot från Azure Batch-tjänsten.
BatchErrorDetail

Ett objekt med ytterligare information som ingår i ett Azure Batch-felsvar.
ErrorMessage

Ett felmeddelande som togs emot i ett Azure Batch-felsvar.
TaskConstraints

Körningsbegränsningar som ska gälla för en aktivitet.
TaskUpdateParameter

Den uppsättning ändringar som ska göras i en aktivitet.

BatchError

Ett felsvar som tagits emot från Azure Batch-tjänsten.

Name Typ Description
code

string

En identifierare för felet. Koder är invarianta och är avsedda att användas programmatiskt.
message

ErrorMessage

Ett meddelande som beskriver felet, avsett att vara lämpligt för visning i ett användargränssnitt.
values

BatchErrorDetail[]

En samling nyckel/värde-par som innehåller ytterligare information om felet.

BatchErrorDetail

Ett objekt med ytterligare information som ingår i ett Azure Batch-felsvar.

Name Typ Description
key

string

En identifierare som anger innebörden av egenskapen Value.
value

string

Den ytterligare information som ingår i felsvaret.

ErrorMessage

Ett felmeddelande som togs emot i ett Azure Batch-felsvar.

Name Typ Description
lang

string

Språkkoden för felmeddelandet
value

string

Texten i meddelandet.

TaskConstraints

Körningsbegränsningar som ska gälla för en aktivitet.

Name Typ Description
maxTaskRetryCount

integer

Det maximala antalet gånger som aktiviteten kan försökas igen. Batch-tjänsten försöker utföra en aktivitet igen om slutkoden inte är noll.
Observera att det här värdet specifikt styr antalet återförsök för den körbara aktiviteten på grund av en icke-nollavslutskod. Batch-tjänsten provar uppgiften en gång och kan sedan försöka upp till den här gränsen igen. Om det maximala antalet återförsök till exempel är 3, försöker Batch aktiviteten upp till 4 gånger (ett första försök och 3 återförsök). Om det maximala antalet återförsök är 0 försöker Batch-tjänsten inte aktiviteten igen efter det första försöket. Om det maximala antalet återförsök är -1 försöker Batch-tjänsten aktiviteten utan begränsning igen, men detta rekommenderas inte för en startaktivitet eller någon aktivitet. Standardvärdet är 0 (inga återförsök).
maxWallClockTime

string

Den maximala tiden som aktiviteten kan köras, mätt från den tidpunkt då aktiviteten startar. Om aktiviteten inte slutförs inom tidsgränsen avslutar Batch-tjänsten den.
Om detta inte anges finns det ingen tidsgräns för hur länge aktiviteten kan köras.
retentionTime

string

Den minsta tiden för att behålla aktivitetskatalogen på den beräkningsnod där den kördes, från den tidpunkt då körningen slutfördes. Efter den här tiden kan Batch-tjänsten ta bort aktivitetskatalogen och allt dess innehåll.
Standardvärdet är 7 dagar, dvs. Aktivitetskatalogen behålls i 7 dagar om inte beräkningsnoden tas bort eller jobbet tas bort.

TaskUpdateParameter

Den uppsättning ändringar som ska göras i en aktivitet.

Name Typ Description
constraints

TaskConstraints

Begränsningar som gäller för den här uppgiften.
Om den utelämnas får aktiviteten standardbegränsningarna. För aktiviteter med flera instanser gäller uppdatering av kvarhållningstiden endast för den primära aktiviteten och inte underaktiviteter.