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=2024-07-01.20.0
POST {batchUrl}/jobs/{jobId}/tasks?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 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. 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.

Begärandetext

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

Name Obligatorisk Typ Description
commandLine True

string

Kommandoraden för uppgiften.
För aktiviteter med flera instanser körs kommandoraden som den primära aktiviteten, efter att den primära aktiviteten och alla underaktiviteter har kört samordningskommandoraden. Kommandoraden körs inte under ett gränssnitt och kan därför inte dra nytta av gränssnittsfunktioner som miljövariabelexpansion. Om du vill dra nytta av sådana funktioner bör du anropa gränssnittet på kommandoraden, till exempel med hjälp av "cmd /c MyCommand" i Windows eller "/bin/sh -c MyCommand" i Linux. Om kommandoraden refererar till filsökvägar bör den använda en relativ sökväg (i förhållande till arbetskatalogen Uppgift) eller använda miljövariabeln i Batch (https://docs.microsoft.com/azure/batch/batch-compute-node-environment-variables).

id True

string

En sträng som unikt identifierar uppgiften i jobbet.
ID:t kan innehålla valfri kombination av alfanumeriska tecken, inklusive bindestreck och understreck, och får inte innehålla fler än 64 tecken. ID:t är skiftlägesbevarande och skiftlägesokänsligt (dvs. du kanske inte har två ID:n i ett jobb som endast skiljer sig åt från fall till fall).

affinityInfo

AffinityInformation

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

ApplicationPackageReference[]

En lista över paket som Batch-tjänsten distribuerar till beräkningsnoden innan kommandoraden körs.
Programpaket laddas ned och distribueras till en delad katalog, inte arbetskatalogen Aktivitet. Om ett refererat paket redan finns på noden och är uppdaterat laddas det därför inte ned igen. den befintliga kopian på beräkningsnoden används. Om det inte går att installera ett refererat paket, till exempel på grund av att paketet har tagits bort eller eftersom nedladdningen misslyckades, misslyckas uppgiften.

authenticationTokenSettings

AuthenticationTokenSettings

Inställningarna för en autentiseringstoken som aktiviteten kan använda för att utföra Batch-tjänståtgärder.
Om den här egenskapen anges tillhandahåller Batch-tjänsten uppgiften med en autentiseringstoken som kan användas för att autentisera Batch-tjänståtgärder utan att kräva en kontoåtkomstnyckel. Token tillhandahålls via miljövariabeln AZ_BATCH_AUTHENTICATION_TOKEN. Vilka åtgärder som aktiviteten kan utföra med hjälp av token beror på inställningarna. En aktivitet kan till exempel begära jobbbehörigheter för att lägga till andra aktiviteter i jobbet, eller kontrollera status för jobbet eller andra aktiviteter under jobbet.

constraints

TaskConstraints

De körningsbegränsningar som gäller för den här aktiviteten.
Om du inte anger begränsningar är maxTaskRetryCount det maxTaskRetryCount som angetts för jobbet, maxWallClockTime är oändligt och retentionTime är 7 dagar.

containerSettings

TaskContainerSettings

Inställningarna för containern som aktiviteten körs under.
Om den pool som ska köra den här aktiviteten har containerConfiguration inställd måste även detta anges. Om den pool som ska köra den här aktiviteten inte har containerConfiguration inställd får detta inte anges. När detta anges mappas alla kataloger rekursivt under AZ_BATCH_NODE_ROOT_DIR (roten för Azure Batch-kataloger på noden) till containern, alla miljövariabler för aktivitet mappas till containern och kommandoraden Aktivitet körs i containern. Filer som skapas i containern utanför AZ_BATCH_NODE_ROOT_DIR kanske inte återspeglas på värddisken, vilket innebär att Batch-fil-API:er inte kommer att kunna komma åt dessa filer.

dependsOn

TaskDependencies

Vilka uppgifter den här aktiviteten är beroende av.
Den här aktiviteten schemaläggs inte förrän alla aktiviteter som den är beroende av har slutförts. Om någon av dessa uppgifter misslyckas och uttömmer antalet återförsök kommer den här aktiviteten aldrig att schemaläggas. Om jobbet inte har usesTaskDependencies inställt på true, och det här elementet finns, misslyckas begäran med felkoden TaskDependenciesNotSpecifiedOnJob.

displayName

string

Ett visningsnamn för aktiviteten.
Visningsnamnet behöver inte vara unikt och kan innehålla unicode-tecken upp till en maximal längd på 1024.

environmentSettings

EnvironmentSetting[]

En lista över miljövariabelinställningar för aktiviteten.

exitConditions

ExitConditions

Anger hur Batch-tjänsten ska svara när uppgiften är klar.
Hur Batch-tjänsten ska svara när uppgiften är klar.

multiInstanceSettings

MultiInstanceSettings

Ett objekt som anger att uppgiften är en aktivitet med flera instanser och innehåller information om hur du kör aktiviteten för flera instanser.
Aktiviteter med flera instanser används ofta för att stödja MPI-uppgifter. I MPI-fallet, om någon av underaktiviteterna misslyckas (till exempel på grund av att avsluta med en slutkod som inte är noll) misslyckas hela aktiviteten med flera instanser. Aktiviteten för flera instanser avslutas och görs om, upp till gränsen för återförsök.

outputFiles

OutputFile[]

En lista över filer som Batch-tjänsten laddar upp från beräkningsnoden när kommandoraden har körts.
För aktiviteter med flera instanser laddas filerna bara upp från beräkningsnoden där den primära aktiviteten körs.

requiredSlots

integer

Antalet schemaläggningsplatser som aktiviteten måste köra.
Standardvärdet är 1. En aktivitet kan bara schemaläggas att köras på en beräkningsnod om noden har tillräckligt med lediga schemaläggningsplatser tillgängliga. För uppgifter med flera instanser måste detta vara 1.

resourceFiles

ResourceFile[]

En lista över filer som Batch-tjänsten laddar ned till beräkningsnoden innan du kör kommandoraden.
För aktiviteter med flera instanser laddas resursfilerna bara ned till beräkningsnoden där den primära aktiviteten körs. Det finns en maximal storlek för listan över resursfiler. När maxstorleken överskrids misslyckas begäran och svarsfelkoden requestEntityTooLarge. Om detta inträffar måste samlingen av ResourceFiles minskas i storlek. Detta kan uppnås med hjälp av .zip filer, programpaket eller Docker-containrar.

userIdentity

UserIdentity

Användaridentiteten som aktiviteten körs under.
Om den utelämnas körs aktiviteten som en icke-administrativ användare som är unik för aktiviteten.

Svar

Name Typ Description
201 Created

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

Add a basic task
Add a container task with container data isolation
Add a container task with container data isolation bad request duplicate sources
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=2024-07-01.20.0



{
  "id": "task1",
  "commandLine": "cmd /c echo task1"
}

Exempelsvar

Add a container task with container data isolation

Exempelbegäran

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



{
  "id": "taskId",
  "commandLine": "bash -c 'echo hello'",
  "containerSettings": {
    "imageName": "ubuntu",
    "containerHostBatchBindMounts": [
      {
        "source": "Task",
        "isReadOnly": true
      }
    ]
  },
  "userIdentity": {
    "autoUser": {
      "scope": "task",
      "elevationLevel": "nonadmin"
    }
  }
}

Exempelsvar

Add a container task with container data isolation bad request duplicate sources

Exempelbegäran

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



{
  "id": "taskId",
  "commandLine": "bash -c 'echo hello'",
  "containerSettings": {
    "imageName": "ubuntu",
    "containerHostBatchBindMounts": [
      {
        "source": "Task",
        "isReadOnly": true
      },
      {
        "source": "Task",
        "isReadOnly": true
      }
    ]
  },
  "userIdentity": {
    "autoUser": {
      "scope": "task",
      "elevationLevel": "nonadmin"
    }
  }
}

Exempelsvar

Add a task with container settings

Exempelbegäran

POST account.region.batch.azure.com/jobs/jobId/tasks?api-version=2024-07-01.20.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=2024-07-01.20.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=2024-07-01.20.0



{
  "id": "task1",
  "requiredSlots": 2,
  "commandLine": "cmd /c echo task1"
}

Exempelsvar

Definitioner

Name Description
AccessScope

De Batch-resurser som token ger åtkomst till.

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

ApplicationPackageReference

En referens till ett paket som ska distribueras till beräkningsnoder.

AuthenticationTokenSettings

Inställningarna för en autentiseringstoken som aktiviteten kan använda för att utföra Batch-tjänståtgärder.

AutoUserScope

Omfånget för den automatiska användaren

AutoUserSpecification

Anger parametrarna för den automatiska användare som kör en uppgift i Batch-tjänsten.

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.

ComputeNodeIdentityReference

Referensen till en användartilldelad identitet som är associerad med Batch-poolen som en beräkningsnod ska använda.

ContainerHostBatchBindMountEntry

Posten för sökvägen och monteringsläget som du vill montera i aktivitetscontainern.

ContainerHostDataPath

Sökvägarna som ska monteras på containeraktivitetens container.

ContainerRegistry

Ett privat containerregister.

ContainerWorkingDirectory

Platsen för containerns arbetskatalog för uppgift.

DependencyAction

En åtgärd som Batch-tjänsten utför på uppgifter som är beroende av den här uppgiften.

ElevationLevel

Användarens höjdnivå.

EnvironmentSetting

En miljövariabel som ska anges för en aktivitetsprocess.

ErrorMessage

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

ExitCodeMapping

Hur Batch-tjänsten ska svara om en uppgift avslutas med en viss slutkod.

ExitCodeRangeMapping

Ett intervall med slutkoder och hur Batch-tjänsten ska svara på slutkoder inom det intervallet.

ExitConditions

Anger hur Batch-tjänsten ska svara när uppgiften är klar.

ExitOptions

Anger hur Batch-tjänsten svarar på ett visst avslutningsvillkor.

HttpHeader

Ett HTTP-huvudnamn/värde-par

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

MultiInstanceSettings

Inställningar som anger hur du kör en aktivitet med flera instanser.

OutputFile

En specifikation för att ladda upp filer från en Azure Batch Compute-nod till en annan plats när Batch-tjänsten har slutfört körningen av aktivitetsprocessen.

OutputFileBlobContainerDestination

Anger ett filuppladdningsmål i en Azure Blob Storage-container.

OutputFileDestination

Målet som en fil ska laddas upp till.

OutputFileUploadCondition

De villkor under vilka en aktivitetsutdatafil eller uppsättning filer ska laddas upp.

OutputFileUploadOptions

Information om en uppladdningsåtgärd för utdatafiler, inklusive under vilka villkor uppladdningen ska utföras.

ResourceFile

En enda fil eller flera filer som ska laddas ned till en beräkningsnod.

TaskAddParameter

En Azure Batch-uppgift att lägga till.

TaskConstraints

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

TaskContainerSettings

Containerinställningarna för en aktivitet.

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.

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.

UserIdentity

Definitionen av användaridentiteten 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 uppgift som har körts tidigare.
Du kan skicka affinityId för en nod för att ange att den här aktiviteten måste köras på beräkningsnoden. Observera att detta bara är en mjuk tillhörighet. Om målberäkningens nod är upptagen eller otillgänglig när aktiviteten schemaläggs schemaläggs aktiviteten någon annanstans.

ApplicationPackageReference

En referens till ett paket som ska distribueras till beräkningsnoder.

Name Typ Description
applicationId

string

ID:t för programmet som ska distribueras.
När du skapar en pool måste paketets program-ID vara fullständigt kvalificerat (/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Batch/batchAccounts/{accountName}/applications/{applicationName}).

version

string

Den version av programmet som ska distribueras. Om den utelämnas distribueras standardversionen.
Om detta utelämnas i en pool och ingen standardversion har angetts för det här programmet misslyckas begäran med felkoden InvalidApplicationPackageReferences och HTTP-statuskod 409. Om detta utelämnas för en aktivitet och ingen standardversion har angetts för det här programmet misslyckas uppgiften med ett förbearbetningsfel.

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

AccessScope[]

De Batch-resurser som token ger åtkomst till.
Autentiseringstoken ger åtkomst till en begränsad uppsättning Batch-tjänståtgärder. För närvarande är det enda värdet som stöds för åtkomstegenskapen "jobb", vilket ger åtkomst till alla åtgärder som är relaterade till jobbet som innehåller aktiviteten.

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 uppgift i Batch-tjänsten.

Name Typ Description
elevationLevel

ElevationLevel

Den automatiska användarens höjdnivå.
Standardvärdet är nonAdmin.

scope

AutoUserScope

Omfånget för den automatiska användaren
Standardvärdet är pool. Om poolen kör Windows ska värdet Aktivitet anges om striktare isolering mellan aktiviteter krävs. Om uppgiften till exempel muterar registret på ett sätt som kan påverka andra uppgifter, eller om certifikat har angetts i poolen som inte ska vara tillgängliga för normala uppgifter men bör vara tillgängliga av StartTasks.

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.

ComputeNodeIdentityReference

Referensen till en användartilldelad identitet som är associerad med Batch-poolen som en beräkningsnod ska använda.

Name Typ Description
resourceId

string

ARM-resurs-ID för den användartilldelade identiteten.

ContainerHostBatchBindMountEntry

Posten för sökvägen och monteringsläget som du vill montera i aktivitetscontainern.

Name Typ Description
isReadOnly

boolean

Montera den här källsökvägen som skrivskyddat läge eller inte. Standardvärdet är falskt (läs-/skrivläge).
För Linux, om du monterar den här sökvägen som ett läs-/skrivläge betyder det inte att alla användare i containern har läs-/skrivåtkomst för sökvägen, det beror på åtkomsten i den virtuella värddatorn. Om den här sökvägen är skrivskyddad kan inte alla användare i containern ändra sökvägen.

source

ContainerHostDataPath

Sökvägen som monteras på containerkund kan välja.

ContainerHostDataPath

Sökvägarna som ska monteras på containeraktivitetens container.

Name Typ Description
Applications

string

Programsökvägen.

JobPrep

string

Jobbförberedelseaktivitetssökvägen.

Shared

string

Sökvägen för uppgift för flera instanser att dela sina filer.

Startup

string

Sökvägen för startaktiviteten.

Task

string

Aktivitetssökvägen.

VfsMounts

string

Sökvägen innehåller alla virtuella filsystem som är monterade på den här noden.

ContainerRegistry

Ett privat containerregister.

Name Typ Description
identityReference

ComputeNodeIdentityReference

Referensen till den användartilldelade identitet som ska användas för att komma åt ett Azure Container Registry i stället för användarnamn och lösenord.
Referensen till en användartilldelad identitet som är associerad med Batch-poolen som en beräkningsnod ska använda.

password

string

Lösenordet för att logga in på registerservern.

registryServer

string

Registrets URL.
Om det utelämnas är standardvärdet "docker.io".

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 Image. Se upp för 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 aktiviteten 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ändig administratörsbehörighet.

nonadmin

string

Användaren är en standardanvändare utan förhöjd åtkomst.

EnvironmentSetting

En miljövariabel som ska anges för en aktivitetsprocess.

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

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

ExitOptions

Hur Batch-tjänsten ska svara om aktiviteten 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 är klar.

Name Typ Description
default

ExitOptions

Hur Batch-tjänsten ska svara om aktiviteten misslyckas med ett avslutningsvillkor som inte omfattas av någon av de andra egenskaperna.
Det här värdet används om aktiviteten avslutas med någon icke-zero-slutkod som inte anges i samlingen exitCodes eller exitCodeRanges, med ett förbearbetningsfel om egenskapen preProcessingError inte finns eller med ett filuppladdningsfel om egenskapen fileUploadError inte finns. Om du vill ha ett beteende som inte är standard för slutkod 0 måste du uttryckligen ange det med hjälp av samlingen exitCodes eller exitCodeRanges.

exitCodeRanges

ExitCodeRangeMapping[]

En lista över kodintervall för aktivitetsavslut och hur Batch-tjänsten ska svara på dem.

exitCodes

ExitCodeMapping[]

En lista över enskilda aktivitetsavslutskoder och hur Batch-tjänsten ska svara på dem.

fileUploadError

ExitOptions

Hur Batch-tjänsten ska svara om ett filuppladdningsfel inträffar.
Om uppgiften avslutades med en slutkod som angavs via exitCodes eller exitCodeRanges och sedan påträffade ett filuppladdningsfel, har åtgärden som anges av slutkoden företräde.

preProcessingError

ExitOptions

Hur Batch-tjänsten ska svara om aktiviteten inte startar på grund av ett fel.

ExitOptions

Anger hur Batch-tjänsten svarar på ett visst avslutningsvillkor.

Name Typ Description
dependencyAction

DependencyAction

En åtgärd som Batch-tjänsten utför på uppgifter som är beroende av den här uppgiften.
Möjliga värden är "tillfredsställa" (så att beroende uppgifter kan fortsätta) och "blockera" (beroende aktiviteter fortsätter att vänta). Batch stöder ännu inte annullering av beroende uppgifter.

jobAction

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".
Standardvärdet är ingen för slutkod 0 och avsluta för alla andra avslutningsvillkor. Om jobbets onTaskFailed-egenskap är noaction returnerar du ett fel när du anger den här egenskapen och lägg till uppgiftsbegäran misslyckas med ett ogiltigt egenskapsvärdefel. Om du anropar REST-API:et direkt är HTTP-statuskoden 400 (felaktig begäran).

HttpHeader

Ett HTTP-huvudnamn/värde-par

Name Typ Description
name

string

Det skiftlägeskänsliga namnet på rubriken som ska användas vid uppladdning av utdatafiler

value

string

Värdet för rubriken som ska användas vid uppladdning av utdatafiler

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

Name Typ Description
disable

string

Inaktivera jobbet. Detta motsvarar att anropa inaktivera jobb-API:et med värdet disableTasks för att fråga igen.

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

ResourceFile[]

En lista över filer som Batch-tjänsten laddar ned innan du kör kommandoraden för samordning.
Skillnaden mellan vanliga resursfiler och aktivitetsresursfiler är att vanliga resursfiler laddas ned för alla underaktiviteter, inklusive den primära, medan resursfiler för aktiviteter endast laddas ned för den primära. Observera också att dessa resursfiler inte laddas ned till arbetskatalogen Uppgift, utan i stället laddas ned till rotkatalogen Aktivitet (en katalog ovanför arbetskatalogen). Det finns en maximal storlek för listan över resursfiler. När maxstorleken överskrids misslyckas begäran och svarsfelkoden requestEntityTooLarge. Om detta inträffar måste samlingen av ResourceFiles minskas i storlek. Detta kan uppnås med hjälp av .zip filer, programpaket eller Docker-containrar.

coordinationCommandLine

string

Kommandoraden som ska köras på alla beräkningsnoder så att de kan samordnas när den primära kör huvuduppgiftskommandot.
En typisk samordningskommandorad startar en bakgrundstjänst och verifierar att tjänsten är redo att bearbeta meddelanden mellan noder.

numberOfInstances

integer

Antalet beräkningsnoder som krävs av aktiviteten.
Om det utelämnas är standardvärdet 1.

OutputFile

En specifikation för att ladda upp filer från en Azure Batch Compute-nod till en annan plats när Batch-tjänsten har slutfört körningen av aktivitetsprocessen.

Name Typ Description
destination

OutputFileDestination

Målet för utdatafilerna.

filePattern

string

Ett mönster som anger vilka filer som ska laddas upp.
Både relativa och absoluta sökvägar stöds. Relativa sökvägar är relativa till arbetskatalogen Aktivitet. Följande jokertecken stöds: * matchar 0 eller fler tecken (till exempel mönster abc* skulle matcha abc eller abcdef), ** matchar alla kataloger, ? matchar ett enskilt tecken, [abc] matchar ett tecken inom hakparenteserna, och [a-c] matchar ett tecken i intervallet. Hakparenteser kan innehålla en negation som matchar alla tecken som inte har angetts (till exempel [!abc] matchar alla tecken utom a, b eller c). Om ett filnamn börjar med "." ignoreras det som standard men kan matchas genom att ange det explicit (till exempel matchar .gif inte .a.gif, men ..gif kommer att göra det). Ett enkelt exempel: ***.txt matchar alla filer som inte startas i och slutar med .txt i arbetskatalogen Aktivitet eller någon underkatalog. Om filnamnet innehåller ett jokertecken kan det inte användas med hakparenteser (till exempel abc[] skulle matcha en fil med namnet abc). Observera att både \ och/behandlas som katalogavgränsare i Windows, men endast /finns i Linux. Miljövariabler (%var% i Windows eller $var på Linux) expanderas innan mönstret tillämpas.

uploadOptions

OutputFileUploadOptions

Ytterligare alternativ för uppladdningsåtgärden, inklusive under vilka villkor som ska 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.
Om den inte använder en hanterad identitet måste URL:en innehålla en signatur för delad åtkomst (SAS) som beviljar skrivbehörighet till containern.

identityReference

ComputeNodeIdentityReference

Referensen till den användartilldelade identitet som ska användas för åtkomst till Azure Blob Storage som anges av containerUrl
Identiteten måste ha skrivåtkomst till Azure Blob Storage-containern

path

string

Målbloben eller den virtuella katalogen i Azure Storage-containern.
Om filePattern refererar till en specifik fil (dvs. innehåller inga jokertecken) är sökvägen namnet på den blob som filen ska laddas upp till. Om filePattern innehåller ett eller flera jokertecken (och därför kan matcha flera filer) är sökvägen namnet på den virtuella blobkatalogen (som förbereds för varje blobnamn) som filen eller filerna ska laddas upp till. Om de utelämnas laddas filer upp till containerns rot med ett blobnamn som matchar deras filnamn.

uploadHeaders

HttpHeader[]

En lista över namn/värde-par för rubriker som ska användas vid uppladdning av utdatafiler
Dessa huvuden anges när filer laddas upp till Azure Storage. Officiellt dokument om tillåtna rubriker vid uppladdning av blobar: https://docs.microsoft.com/rest/api/storageservices/put-blob#request-headers-all-blob-types

OutputFileDestination

Målet som en fil ska laddas upp till.

Name Typ Description
container

OutputFileBlobContainerDestination

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 efter att aktivitetsprocessen har avslutats, oavsett vilken slutkod det var.

taskfailure

string

Ladda upp filen eller filerna först när aktivitetsprocessen avslutas med en icke-nollavslutskod.

tasksuccess

string

Ladda upp filen eller filerna först när aktivitetsprocessen avslutas med en slutkod på 0.

OutputFileUploadOptions

Information om en uppladdningsåtgärd för utdatafiler, inklusive under vilka villkor uppladdningen ska utföras.

Name Typ Description
uploadCondition

OutputFileUploadCondition

De villkor under vilka aktivitetsutdatafilen eller uppsättningen filer ska laddas upp.
Standardvärdet är taskcompletion.

ResourceFile

En enda fil eller flera filer som ska laddas ned till en beräkningsnod.

Name Typ Description
autoStorageContainerName

string

Namnet på lagringscontainern i det automatiska lagringskontot.
Egenskaperna autoStorageContainerName, storageContainerUrl och httpUrl är ömsesidigt uteslutande och en av dem måste anges.

blobPrefix

string

Blobprefixet som ska användas vid nedladdning av blobar från en Azure Storage-container. Endast de blobar vars namn börjar med det angivna prefixet laddas ned.
Egenskapen är endast giltig när autoStorageContainerName eller storageContainerUrl används. Det här prefixet kan vara ett partiellt filnamn eller en underkatalog. Om inget prefix har angetts laddas alla filer i containern ned.

fileMode

string

Attributet för filbehörighetsläge i oktalt format.
Den här egenskapen gäller endast filer som laddas ned till Linux-beräkningsnoder. Den ignoreras om den har angetts för en resourceFile som laddas ned till en Windows-beräkningsnod. Om den här egenskapen inte har angetts för en Linux-beräkningsnod tillämpas standardvärdet 0770 på filen.

filePath

string

Platsen på beräkningsnoden som filen eller filerna ska laddas ned till i förhållande till aktivitetens arbetskatalog.
Om egenskapen httpUrl har angetts krävs filePath och beskriver sökvägen som filen ska laddas ned till, inklusive filnamnet. Om egenskapen autoStorageContainerName eller storageContainerUrl har angetts är filePath valfritt och är den katalog som filerna ska laddas ned till. Om filePath används som en katalog behålls alla katalogstrukturer som redan är associerade med indata i sin helhet och läggs till i den angivna filePath-katalogen. Den angivna relativa sökvägen kan inte bryta sig ut från aktivitetens arbetskatalog (till exempel med hjälp av ..).

httpUrl

string

URL:en för filen som ska laddas ned.
Egenskaperna autoStorageContainerName, storageContainerUrl och httpUrl är ömsesidigt uteslutande och en av dem måste anges. Om URL:en pekar på Azure Blob Storage måste den vara läsbar från beräkningsnoder. Det finns tre sätt att hämta en sådan URL för en blob i Azure Storage: inkludera en signatur för delad åtkomst (SAS) som beviljar läsbehörigheter för blobben, använda en hanterad identitet med läsbehörighet eller ange ACL för blobben eller dess container för att tillåta offentlig åtkomst.

identityReference

ComputeNodeIdentityReference

Referensen till den användartilldelade identitet som ska användas för åtkomst till Azure Blob Storage som anges av storageContainerUrl eller httpUrl
Referensen till en användartilldelad identitet som är associerad med Batch-poolen som en beräkningsnod ska använda.

storageContainerUrl

string

URL:en för blobcontainern i Azure Blob Storage.
Egenskaperna autoStorageContainerName, storageContainerUrl och httpUrl är ömsesidigt uteslutande och en av dem måste anges. Den här URL:en måste vara läsbar och listbar från beräkningsnoder. Det finns tre sätt att hämta en sådan URL för en container i Azure Storage: inkludera en signatur för delad åtkomst (SAS) som beviljar läs- och listbehörigheter för containern, använder en hanterad identitet med läs- och listbehörigheter eller anger ACL för containern för att tillåta offentlig åtkomst.

TaskAddParameter

En Azure Batch-uppgift att lägga till.

Name Typ Description
affinityInfo

AffinityInformation

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

ApplicationPackageReference[]

En lista över paket som Batch-tjänsten distribuerar till beräkningsnoden innan kommandoraden körs.
Programpaket laddas ned och distribueras till en delad katalog, inte arbetskatalogen Aktivitet. Om ett refererat paket redan finns på noden och är uppdaterat laddas det därför inte ned igen. den befintliga kopian på beräkningsnoden används. Om det inte går att installera ett refererat paket, till exempel på grund av att paketet har tagits bort eller eftersom nedladdningen misslyckades, misslyckas uppgiften.

authenticationTokenSettings

AuthenticationTokenSettings

Inställningarna för en autentiseringstoken som aktiviteten kan använda för att utföra Batch-tjänståtgärder.
Om den här egenskapen anges tillhandahåller Batch-tjänsten uppgiften med en autentiseringstoken som kan användas för att autentisera Batch-tjänståtgärder utan att kräva en kontoåtkomstnyckel. Token tillhandahålls via miljövariabeln AZ_BATCH_AUTHENTICATION_TOKEN. Vilka åtgärder som aktiviteten kan utföra med hjälp av token beror på inställningarna. En aktivitet kan till exempel begära jobbbehörigheter för att lägga till andra aktiviteter i jobbet, eller kontrollera status för jobbet eller andra aktiviteter under jobbet.

commandLine

string

Kommandoraden för uppgiften.
För aktiviteter med flera instanser körs kommandoraden som den primära aktiviteten, efter att den primära aktiviteten och alla underaktiviteter har kört samordningskommandoraden. Kommandoraden körs inte under ett gränssnitt och kan därför inte dra nytta av gränssnittsfunktioner som miljövariabelexpansion. Om du vill dra nytta av sådana funktioner bör du anropa gränssnittet på kommandoraden, till exempel med hjälp av "cmd /c MyCommand" i Windows eller "/bin/sh -c MyCommand" i Linux. Om kommandoraden refererar till filsökvägar bör den använda en relativ sökväg (i förhållande till arbetskatalogen Uppgift) eller använda miljövariabeln i Batch (https://docs.microsoft.com/azure/batch/batch-compute-node-environment-variables).

constraints

TaskConstraints

De körningsbegränsningar som gäller för den här aktiviteten.
Om du inte anger begränsningar är maxTaskRetryCount det maxTaskRetryCount som angetts för jobbet, maxWallClockTime är oändligt och retentionTime är 7 dagar.

containerSettings

TaskContainerSettings

Inställningarna för containern som aktiviteten körs under.
Om den pool som ska köra den här aktiviteten har containerConfiguration inställd måste även detta anges. Om den pool som ska köra den här aktiviteten inte har containerConfiguration inställd får detta inte anges. När detta anges mappas alla kataloger rekursivt under AZ_BATCH_NODE_ROOT_DIR (roten för Azure Batch-kataloger på noden) till containern, alla miljövariabler för aktivitet mappas till containern och kommandoraden Aktivitet körs i containern. Filer som skapas i containern utanför AZ_BATCH_NODE_ROOT_DIR kanske inte återspeglas på värddisken, vilket innebär att Batch-fil-API:er inte kommer att kunna komma åt dessa filer.

dependsOn

TaskDependencies

Vilka uppgifter den här aktiviteten är beroende av.
Den här aktiviteten schemaläggs inte förrän alla aktiviteter som den är beroende av har slutförts. Om någon av dessa uppgifter misslyckas och uttömmer antalet återförsök kommer den här aktiviteten aldrig att schemaläggas. Om jobbet inte har usesTaskDependencies inställt på true, och det här elementet finns, misslyckas begäran med felkoden TaskDependenciesNotSpecifiedOnJob.

displayName

string

Ett visningsnamn för aktiviteten.
Visningsnamnet behöver inte vara unikt och kan innehålla unicode-tecken upp till en maximal längd på 1024.

environmentSettings

EnvironmentSetting[]

En lista över miljövariabelinställningar för aktiviteten.

exitConditions

ExitConditions

Anger hur Batch-tjänsten ska svara när uppgiften är klar.
Hur Batch-tjänsten ska svara när uppgiften är klar.

id

string

En sträng som unikt identifierar uppgiften i jobbet.
ID:t kan innehålla valfri kombination av alfanumeriska tecken, inklusive bindestreck och understreck, och får inte innehålla fler än 64 tecken. ID:t är skiftlägesbevarande och skiftlägesokänsligt (dvs. du kanske inte har två ID:n i ett jobb som endast skiljer sig åt från fall till fall).

multiInstanceSettings

MultiInstanceSettings

Ett objekt som anger att uppgiften är en aktivitet med flera instanser och innehåller information om hur du kör aktiviteten för flera instanser.
Aktiviteter med flera instanser används ofta för att stödja MPI-uppgifter. I MPI-fallet, om någon av underaktiviteterna misslyckas (till exempel på grund av att avsluta med en slutkod som inte är noll) misslyckas hela aktiviteten med flera instanser. Aktiviteten för flera instanser avslutas och görs om, upp till gränsen för återförsök.

outputFiles

OutputFile[]

En lista över filer som Batch-tjänsten laddar upp från beräkningsnoden när kommandoraden har körts.
För aktiviteter med flera instanser laddas filerna bara upp från beräkningsnoden där den primära aktiviteten körs.

requiredSlots

integer

Antalet schemaläggningsplatser som aktiviteten måste köra.
Standardvärdet är 1. En aktivitet kan bara schemaläggas att köras på en beräkningsnod om noden har tillräckligt med lediga schemaläggningsplatser tillgängliga. För uppgifter med flera instanser måste detta vara 1.

resourceFiles

ResourceFile[]

En lista över filer som Batch-tjänsten laddar ned till beräkningsnoden innan du kör kommandoraden.
För aktiviteter med flera instanser laddas resursfilerna bara ned till beräkningsnoden där den primära aktiviteten körs. Det finns en maximal storlek för listan över resursfiler. När maxstorleken överskrids misslyckas begäran och svarsfelkoden requestEntityTooLarge. Om detta inträffar måste samlingen av ResourceFiles minskas i storlek. Detta kan uppnås med hjälp av .zip filer, programpaket eller Docker-containrar.

userIdentity

UserIdentity

Användaridentiteten som aktiviteten körs under.
Om den utelämnas körs aktiviteten som en icke-administrativ användare som är unik för aktiviteten.

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.

TaskContainerSettings

Containerinställningarna för en aktivitet.

Name Typ Description
containerHostBatchBindMounts

ContainerHostBatchBindMountEntry[]

Sökvägarna som du vill montera på containeraktiviteten.
Om den här matrisen är null eller inte finns monterar containeraktiviteten hela den tillfälliga diskenheten i Windows (eller AZ_BATCH_NODE_ROOT_DIR i Linux). Den monterar inga datasökvägar i containern om den här matrisen har angetts som tom.

containerRunOptions

string

Ytterligare alternativ för kommandot container create.
Dessa ytterligare alternativ anges som argument till kommandot "docker create", utöver de som styrs av Batch-tjänsten.

imageName

string

Avbildningen som ska användas för att skapa containern där aktiviteten ska köras.
Det här är den fullständiga avbildningsreferensen, som skulle anges till "docker pull". Om ingen tagg anges som en del av avbildningsnamnet används taggen ":latest" som standard.

registry

ContainerRegistry

Det privata registret som innehåller containeravbildningen.
Den här inställningen kan utelämnas om den redan angavs när poolen skapades.

workingDirectory

ContainerWorkingDirectory

Platsen för containerns arbetskatalog för uppgift.
Standardvärdet är "taskWorkingDirectory".

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

TaskIdRange[]

Listan över aktivitets-ID-intervall som 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 aktiviteten är beroende av. Alla aktiviteter i den här listan måste slutföras innan den beroende aktiviteten kan schemaläggas.
Samlingen taskIds är begränsad till totalt 64 000 tecken (dvs. den kombinerade längden på alla aktivitets-ID:n). Om taskIds-samlingen överskrider den maximala längden misslyckas lägg till uppgiftsbegäran med felkoden TaskDependencyListTooLong. I det här fallet bör du använda aktivitets-ID-intervall i stället.

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 användaridentiteten som aktiviteten körs under.

Name Typ Description
autoUser

AutoUserSpecification

Den automatiska användare under vilken aktiviteten körs.
Egenskaperna userName och autoUser är ömsesidigt uteslutande. du måste ange en men inte båda.

username

string

Namnet på den användaridentitet som aktiviteten körs under.
Egenskaperna userName och autoUser är ömsesidigt uteslutande. du måste ange en men inte båda.