Task - Add
Lägger till en aktivitet i det angivna jobbet.
Den maximala livslängden för en aktivitet från tillägg till slutförande är 180 dagar. Om en aktivitet inte har slutförts inom 180 dagar efter att den har lagts till avslutas den av Batch-tjänsten och lämnas i det tillstånd den befann sig i vid den tidpunkten.
POST {batchUrl}/jobs/{jobId}/tasks?api-version=2023-11-01.18.0
POST {batchUrl}/jobs/{jobId}/tasks?timeout={timeout}&api-version=2023-11-01.18.0
URI-parametrar
Name | I | Obligatorisk | Typ | Description |
---|---|---|---|---|
batch
|
path | True |
string |
Bas-URL:en för alla Azure Batch tjänstbegäranden. |
job
|
path | True |
string |
ID för jobbet som aktiviteten ska läggas till i. |
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. |
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 uttryckligen om du anropar REST-API:et direkt. |
Begärandetext
Media Types: "application/json; odata=minimalmetadata"
Name | Obligatorisk | Typ | Description |
---|---|---|---|
commandLine | True |
string |
Kommandoraden för uppgiften. |
id | True |
string |
En sträng som unikt identifierar uppgiften i jobbet. |
affinityInfo |
En lokalitetstips som kan användas av Batch-tjänsten för att välja en beräkningsnod som den nya aktiviteten ska startas på. |
||
applicationPackageReferences |
En lista över paket som Batch-tjänsten ska distribuera till beräkningsnoden innan du kör kommandoraden. |
||
authenticationTokenSettings |
Inställningarna för en autentiseringstoken som aktiviteten kan använda för att utföra Batch-tjänståtgärder. |
||
constraints |
De körningsbegränsningar som gäller för den här aktiviteten. |
||
containerSettings |
Inställningarna för containern som aktiviteten körs under. |
||
dependsOn |
De uppgifter som den här aktiviteten är beroende av. |
||
displayName |
string |
Ett visningsnamn för aktiviteten. |
|
environmentSettings |
En lista över miljövariabelinställningar för aktiviteten. |
||
exitConditions |
Anger hur Batch-tjänsten ska svara när uppgiften har slutförts. |
||
multiInstanceSettings |
Ett objekt som anger att aktiviteten är en aktivitet med flera instanser och innehåller information om hur du kör multiinstansaktiviteten. |
||
outputFiles |
En lista över filer som Batch-tjänsten laddar upp från beräkningsnoden när kommandoraden har körts. |
||
requiredSlots |
integer |
Antalet schemaläggningsplatser som aktiviteten måste köra. |
|
resourceFiles |
En lista över filer som Batch-tjänsten laddar ned till beräkningsnoden innan du kör kommandoraden. |
||
userIdentity |
Användaridentiteten som aktiviteten körs under. |
Svar
Name | Typ | Description |
---|---|---|
201 Created |
Begäran till Batch-tjänsten lyckades. Sidhuvuden
|
|
Other Status Codes |
Felet från Batch-tjänsten. |
Säkerhet
azure_auth
Microsoft Entra autentiseringskodflöde för 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
Add a basic task |
Add a task with container settings |
Add a task with exit conditions |
Add a task with extra slot requirement |
Add a basic task
Exempelbegäran
POST account.region.batch.azure.com/jobs/jobId/tasks?api-version=2023-11-01.18.0
{
"id": "task1",
"commandLine": "cmd /c echo task1"
}
Exempelsvar
Add a task with container settings
Exempelbegäran
POST account.region.batch.azure.com/jobs/jobId/tasks?api-version=2023-11-01.18.0
{
"id": "taskId",
"commandLine": "bash -c 'echo hello'",
"containerSettings": {
"imageName": "ubuntu",
"containerRunOptions": "--rm"
},
"userIdentity": {
"autoUser": {
"scope": "task",
"elevationLevel": "nonadmin"
}
}
}
Exempelsvar
Add a task with exit conditions
Exempelbegäran
POST account.region.batch.azure.com/jobs/jobId/tasks?api-version=2023-11-01.18.0
{
"id": "taskId",
"commandLine": "cmd /c exit 3",
"exitConditions": {
"exitCodeRanges": [
{
"start": 2,
"end": 4,
"exitOptions": {
"jobAction": "terminate"
}
}
]
},
"userIdentity": {
"autoUser": {
"scope": "task",
"elevationLevel": "nonadmin"
}
}
}
Exempelsvar
Add a task with extra slot requirement
Exempelbegäran
POST account.region.batch.azure.com/jobs/jobId/tasks?api-version=2023-11-01.18.0
{
"id": "task1",
"requiredSlots": 2,
"commandLine": "cmd /c echo task1"
}
Exempelsvar
Definitioner
Name | Description |
---|---|
Access |
De Batch-resurser som token ger åtkomst till. |
Affinity |
En lokalitetstips som kan användas av Batch-tjänsten för att välja en beräkningsnod som en aktivitet ska startas på. |
Application |
En referens till ett paket som ska distribueras till beräkningsnoder. |
Authentication |
Inställningarna för en autentiseringstoken som aktiviteten kan använda för att utföra Batch-tjänståtgärder. |
Auto |
Omfånget för den automatiska användaren |
Auto |
Anger parametrarna för den automatiska användare som kör en aktivitet i Batch-tjänsten. |
Batch |
Ett felsvar som tagits emot från Azure Batch-tjänsten. |
Batch |
Ett objekt med ytterligare information som ingår i ett Azure Batch felsvar. |
Compute |
Referensen till en användartilldelad identitet som är associerad med batchpoolen som en beräkningsnod ska använda. |
Container |
Ett privat containerregister. |
Container |
Platsen för containerns arbetskatalog för uppgift. |
Dependency |
En åtgärd som Batch-tjänsten utför på uppgifter som är beroende av den här uppgiften. |
Elevation |
Användarens höjdnivå. |
Environment |
En miljövariabel som ska anges i en uppgiftsprocess. |
Error |
Ett felmeddelande som togs emot i ett Azure Batch felsvar. |
Exit |
Hur Batch-tjänsten ska svara om en uppgift avslutas med en viss slutkod. |
Exit |
Ett intervall med slutkoder och hur Batch-tjänsten ska svara på slutkoder inom det intervallet. |
Exit |
Anger hur Batch-tjänsten ska svara när uppgiften har slutförts. |
Exit |
Anger hur Batch-tjänsten svarar på ett visst avslutsvillkor. |
Http |
Ett HTTP-huvudnamn/värde-par |
Job |
En åtgärd att vidta för jobbet som innehåller uppgiften, om aktiviteten slutförs med det angivna avslutsvillkoret och jobbets onTaskFailed-egenskap är "performExitOptionsJobAction". |
Multi |
Inställningar som anger hur du kör en aktivitet med flera instanser. |
Output |
En specifikation för att ladda upp filer från en Azure Batch Beräkningsnod till en annan plats när Batch-tjänsten har slutfört körningen av aktivitetsprocessen. |
Output |
Anger ett filuppladdningsmål i en Azure Blob Storage-container. |
Output |
Målet som en fil ska laddas upp till. |
Output |
De villkor under vilka en aktivitetsutdatafil eller uppsättning filer ska laddas upp. |
Output |
Information om en överföringsåtgärd för utdatafiler, inklusive under vilka villkor för att utföra uppladdningen. |
Resource |
En enskild fil eller flera filer som ska laddas ned till en beräkningsnod. |
Task |
En Azure Batch uppgift att lägga till. |
Task |
Körningsbegränsningar som ska tillämpas på en aktivitet. |
Task |
Containerinställningarna för en aktivitet. |
Task |
Anger eventuella beroenden för en aktivitet. Alla aktiviteter som uttryckligen anges eller inom ett beroendeintervall måste slutföras innan den beroende aktiviteten schemaläggs. |
Task |
Ett intervall med aktivitets-ID:t som en aktivitet kan vara beroende av. Alla aktiviteter med ID:t i intervallet måste slutföras innan den beroende aktiviteten kan schemaläggas. |
User |
Definitionen av den användaridentitet som aktiviteten körs under. |
AccessScope
De Batch-resurser som token ger åtkomst till.
Name | Typ | Description |
---|---|---|
job |
string |
Ger åtkomst till att utföra alla åtgärder i jobbet som innehåller uppgiften. |
AffinityInformation
En lokalitetstips som kan användas av Batch-tjänsten för att välja en beräkningsnod som en aktivitet ska startas på.
Name | Typ | Description |
---|---|---|
affinityId |
string |
En täckande sträng som representerar platsen för en beräkningsnod eller en aktivitet som har körts tidigare. |
ApplicationPackageReference
En referens till ett paket som ska distribueras till beräkningsnoder.
Name | Typ | Description |
---|---|---|
applicationId |
string |
ID för programmet som ska distribueras. |
version |
string |
Den version av programmet som ska distribueras. Om den utelämnas distribueras standardversionen. |
AuthenticationTokenSettings
Inställningarna för en autentiseringstoken som aktiviteten kan använda för att utföra Batch-tjänståtgärder.
Name | Typ | Description |
---|---|---|
access |
De Batch-resurser som token beviljar åtkomst till. |
AutoUserScope
Omfånget för den automatiska användaren
Name | Typ | Description |
---|---|---|
pool |
string |
Anger att aktiviteten körs som det vanliga automatiska användarkontot som skapas på varje beräkningsnod i en pool. |
task |
string |
Anger att tjänsten ska skapa en ny användare för uppgiften. |
AutoUserSpecification
Anger parametrarna för den automatiska användare som kör en aktivitet i Batch-tjänsten.
Name | Typ | Description |
---|---|---|
elevationLevel |
Den automatiska användarens höjdnivå. |
|
scope |
Omfånget för den automatiska användaren |
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 |
Ett meddelande som beskriver felet, avsett att vara lämpligt för visning i ett användargränssnitt. |
|
values |
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. |
ComputeNodeIdentityReference
Referensen till en användartilldelad identitet som är associerad med batchpoolen som en beräkningsnod ska använda.
Name | Typ | Description |
---|---|---|
resourceId |
string |
ARM-resurs-ID för den användartilldelade identiteten. |
ContainerRegistry
Ett privat containerregister.
Name | Typ | Description |
---|---|---|
identityReference |
Referensen till den användartilldelade identiteten som ska användas för att få åtkomst till en Azure Container Registry i stället för användarnamn och lösenord. |
|
password |
string |
Lösenordet för att logga in på registerservern. |
registryServer |
string |
Registrets URL. |
username |
string |
Användarnamnet för att logga in på registerservern. |
ContainerWorkingDirectory
Platsen för containerns arbetskatalog för uppgift.
Name | Typ | Description |
---|---|---|
containerImageDefault |
string |
Använd arbetskatalogen som definierats i containern Avbildning. Se till att den här katalogen inte innehåller de resursfiler som laddats ned av Batch. |
taskWorkingDirectory |
string |
Använd standardarbetskatalogen för Batch-tjänsten, som innehåller aktivitetsresursfilerna som fylls i av Batch. |
DependencyAction
En åtgärd som Batch-tjänsten utför på uppgifter som är beroende av den här uppgiften.
Name | Typ | Description |
---|---|---|
block |
string |
Blockerar aktiviteter som väntar på den här uppgiften, vilket förhindrar att de schemaläggs. |
satisfy |
string |
Uppfylla uppgifter som väntar på den här uppgiften. När alla beroenden är uppfyllda schemaläggs uppgiften att köras. |
ElevationLevel
Användarens höjdnivå.
Name | Typ | Description |
---|---|---|
admin |
string |
Användaren är en användare med förhöjd åtkomst och fungerar med fullständiga administratörsbehörigheter. |
nonadmin |
string |
Användaren är en standardanvändare utan förhöjd åtkomst. |
EnvironmentSetting
En miljövariabel som ska anges i en uppgiftsprocess.
Name | Typ | Description |
---|---|---|
name |
string |
Namnet på miljövariabeln. |
value |
string |
Värdet för miljövariabeln. |
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. |
ExitCodeMapping
Hur Batch-tjänsten ska svara om en uppgift avslutas med en viss slutkod.
Name | Typ | Description |
---|---|---|
code |
integer |
En processavslutskod. |
exitOptions |
Hur Batch-tjänsten ska svara om uppgiften avslutas med den här slutkoden. |
ExitCodeRangeMapping
Ett intervall med slutkoder och hur Batch-tjänsten ska svara på slutkoder inom det intervallet.
Name | Typ | Description |
---|---|---|
end |
integer |
Den sista slutkoden i intervallet. |
exitOptions |
Hur Batch-tjänsten ska svara om uppgiften avslutas med en slutkod i intervallet start till slut (inklusive). |
|
start |
integer |
Den första slutkoden i intervallet. |
ExitConditions
Anger hur Batch-tjänsten ska svara när uppgiften har slutförts.
Name | Typ | Description |
---|---|---|
default |
Hur Batch-tjänsten ska svara om aktiviteten misslyckas med ett avslutsvillkor som inte omfattas av någon av de andra egenskaperna. |
|
exitCodeRanges |
En lista över aktivitetsavslutskodintervall och hur Batch-tjänsten ska svara på dem. |
|
exitCodes |
En lista över enskilda aktivitetsavslutskoder och hur Batch-tjänsten ska svara på dem. |
|
fileUploadError |
Hur Batch-tjänsten ska svara om ett filuppladdningsfel inträffar. |
|
preProcessingError |
Hur Batch-tjänsten ska svara om uppgiften inte startar på grund av ett fel. |
ExitOptions
Anger hur Batch-tjänsten svarar på ett visst avslutsvillkor.
Name | Typ | Description |
---|---|---|
dependencyAction |
En åtgärd som Batch-tjänsten utför på uppgifter som är beroende av den här uppgiften. |
|
jobAction |
En åtgärd att vidta för jobbet som innehåller aktiviteten, om aktiviteten slutförs med det angivna avslutsvillkoret och jobbets onTaskFailed-egenskap är "performExitOptionsJobAction". |
HttpHeader
Ett HTTP-huvudnamn/värde-par
Name | Typ | Description |
---|---|---|
name |
string |
Det skiftlägesokänsliga namnet på rubriken som ska användas vid uppladdning av utdatafiler |
value |
string |
Värdet för rubriken som ska användas när utdatafiler laddas upp |
JobAction
En åtgärd att vidta för jobbet som innehåller uppgiften, om aktiviteten slutförs med det angivna avslutsvillkoret och jobbets onTaskFailed-egenskap är "performExitOptionsJobAction".
Name | Typ | Description |
---|---|---|
disable |
string |
Inaktivera jobbet. Detta motsvarar anropet av jobb-API:et disable, med värdet disableTasks på nytt. |
none |
string |
Vidta inga åtgärder. |
terminate |
string |
Avsluta jobbet. TerminateReason i jobbets executionInfo är inställt på "TaskFailed". |
MultiInstanceSettings
Inställningar som anger hur du kör en aktivitet med flera instanser.
Name | Typ | Description |
---|---|---|
commonResourceFiles |
En lista över filer som Batch-tjänsten laddar ned innan du kör kommandoraden för samordning. |
|
coordinationCommandLine |
string |
Kommandoraden som ska köras på alla beräkningsnoder så att de kan samordna när den primära kör huvuduppgiftskommandot. |
numberOfInstances |
integer |
Antalet beräkningsnoder som krävs av aktiviteten. |
OutputFile
En specifikation för att ladda upp filer från en Azure Batch Beräkningsnod till en annan plats när Batch-tjänsten har slutfört körningen av aktivitetsprocessen.
Name | Typ | Description |
---|---|---|
destination |
Målet för utdatafilerna. |
|
filePattern |
string |
Ett mönster som anger vilka filer som ska laddas upp. |
uploadOptions |
Ytterligare alternativ för uppladdningsåtgärden, inklusive under vilka villkor för att utföra uppladdningen. |
OutputFileBlobContainerDestination
Anger ett filuppladdningsmål i en Azure Blob Storage-container.
Name | Typ | Description |
---|---|---|
containerUrl |
string |
URL:en för containern i Azure Blob Storage som filen eller filerna ska laddas upp till. |
identityReference |
Referensen till den användartilldelade identitet som ska användas för att komma åt Azure Blob Storage som anges av containerUrl |
|
path |
string |
Målbloben eller den virtuella katalogen i Azure Storage-containern. |
uploadHeaders |
En lista över namn/värde-par för rubriker som ska användas för att ladda upp utdatafiler |
OutputFileDestination
Målet som en fil ska laddas upp till.
Name | Typ | Description |
---|---|---|
container |
En plats i Azure Blob Storage som filer laddas upp till. |
OutputFileUploadCondition
De villkor under vilka en aktivitetsutdatafil eller uppsättning filer ska laddas upp.
Name | Typ | Description |
---|---|---|
taskcompletion |
string |
Ladda upp filen eller filerna när uppgiftsprocessen har avslutats, oavsett vilken slutkod som var. |
taskfailure |
string |
Ladda upp filen eller filerna först när aktivitetsprocessen avslutas med en icke-zero-slutkod. |
tasksuccess |
string |
Ladda upp filen eller filerna först när aktivitetsprocessen avslutas med en slutkod på 0. |
OutputFileUploadOptions
Information om en överföringsåtgärd för utdatafiler, inklusive under vilka villkor för att utföra uppladdningen.
Name | Typ | Description |
---|---|---|
uploadCondition |
De villkor under vilka uppgiftsutdatafilen eller uppsättningen filer ska laddas upp. |
ResourceFile
En enskild fil eller flera filer som ska laddas ned till en beräkningsnod.
Name | Typ | Description |
---|---|---|
autoStorageContainerName |
string |
Namnet på lagringscontainern i det automatiska lagringskontot. |
blobPrefix |
string |
Blobprefixet som ska användas vid nedladdning av blobar från en Azure Storage-container. Endast de blobbar vars namn börjar med det angivna prefixet laddas ned. |
fileMode |
string |
Attributet för filbehörighetsläge i oktalt format. |
filePath |
string |
Platsen på beräkningsnoden som filen eller filerna ska laddas ned till i förhållande till aktivitetens arbetskatalog. |
httpUrl |
string |
URL:en för filen som ska laddas ned. |
identityReference |
Referensen till den användartilldelade identitet som ska användas för att komma åt Azure Blob Storage som anges av storageContainerUrl eller httpUrl |
|
storageContainerUrl |
string |
URL:en för blobcontainern i Azure Blob Storage. |
TaskAddParameter
En Azure Batch uppgift att lägga till.
Name | Typ | Description |
---|---|---|
affinityInfo |
En lokalitetstips som kan användas av Batch-tjänsten för att välja en beräkningsnod som den nya aktiviteten ska startas på. |
|
applicationPackageReferences |
En lista över paket som Batch-tjänsten distribuerar till beräkningsnoden innan kommandoraden körs. |
|
authenticationTokenSettings |
Inställningarna för en autentiseringstoken som aktiviteten kan använda för att utföra Batch-tjänståtgärder. |
|
commandLine |
string |
Kommandoraden för aktiviteten. |
constraints |
De körningsbegränsningar som gäller för den här aktiviteten. |
|
containerSettings |
Inställningarna för containern under vilken aktiviteten körs. |
|
dependsOn |
De aktiviteter som den här aktiviteten är beroende av. |
|
displayName |
string |
Ett visningsnamn för aktiviteten. |
environmentSettings |
En lista över miljövariabelinställningar för aktiviteten. |
|
exitConditions |
Anger hur Batch-tjänsten ska svara när uppgiften har slutförts. |
|
id |
string |
En sträng som unikt identifierar uppgiften i jobbet. |
multiInstanceSettings |
Ett objekt som anger att aktiviteten är en aktivitet med flera instanser och innehåller information om hur du kör multiinstansaktiviteten. |
|
outputFiles |
En lista över filer som Batch-tjänsten laddar upp från beräkningsnoden när kommandoraden har körts. |
|
requiredSlots |
integer |
Antalet schemaläggningsplatser som aktiviteten måste köra. |
resourceFiles |
En lista över filer som Batch-tjänsten laddar ned till beräkningsnoden innan du kör kommandoraden. |
|
userIdentity |
Användaridentiteten som aktiviteten körs under. |
TaskConstraints
Körningsbegränsningar som ska tillämpas på 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 dess slutkod inte är noll. |
maxWallClockTime |
string |
Den maximala förflutna 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. |
retentionTime |
string |
Den minsta tid det tar 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. |
TaskContainerSettings
Containerinställningarna för en aktivitet.
Name | Typ | Description |
---|---|---|
containerRunOptions |
string |
Ytterligare alternativ för kommandot container create. |
imageName |
string |
Avbildningen som ska användas för att skapa containern där aktiviteten ska köras. |
registry |
Det privata registret som innehåller containern Image. |
|
workingDirectory |
Platsen för containerns arbetskatalog för uppgift. |
TaskDependencies
Anger eventuella beroenden för en aktivitet. Alla aktiviteter som uttryckligen anges eller inom ett beroendeintervall måste slutföras innan den beroende aktiviteten schemaläggs.
Name | Typ | Description |
---|---|---|
taskIdRanges |
Listan över aktivitets-ID-intervall som den här aktiviteten är beroende av. Alla aktiviteter i alla intervall måste slutföras innan den beroende aktiviteten kan schemaläggas. |
|
taskIds |
string[] |
Listan över aktivitets-ID:t som den här aktiviteten är beroende av. Alla aktiviteter i den här listan måste slutföras innan den beroende aktiviteten kan schemaläggas. |
TaskIdRange
Ett intervall med aktivitets-ID:t som en aktivitet kan vara beroende av. Alla aktiviteter med ID:t i intervallet måste slutföras innan den beroende aktiviteten kan schemaläggas.
Name | Typ | Description |
---|---|---|
end |
integer |
Det sista aktivitets-ID:t i intervallet. |
start |
integer |
Det första aktivitets-ID:t i intervallet. |
UserIdentity
Definitionen av den användaridentitet som aktiviteten körs under.
Name | Typ | Description |
---|---|---|
autoUser |
Den automatiska användare som aktiviteten körs under. |
|
username |
string |
Namnet på den användaridentitet som aktiviteten körs under. |