Task - Get

Service:

Batch Service

API Version:

2022-01-01.15.0

Hämtar information om den angivna aktiviteten.
Information som affinityId, executionInfo och nodeInfo för aktiviteter med flera instanser refererar till den primära aktiviteten. Använd API:et för listunderaktiviteter för att hämta information om underaktiviteter.

GET {batchUrl}/jobs/{jobId}/tasks/{taskId}?api-version=2022-01-01.15.0

With optional parameters:

GET {batchUrl}/jobs/{jobId}/tasks/{taskId}?$select={$select}&$expand={$expand}&timeout={timeout}&api-version=2022-01-01.15.0

URI-parametrar

Name	In	Required	Type	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 för att få information om.
api-version	query	True	string	Klient-API-version.
$expand	query		string	En OData-$expand-sats.
$select	query		string	En OData-$select-sats.
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	Required	Type	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.
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 för tjänsten inte matchar det värde som anges av klienten.
If-Modified-Since		string date-time-rfc1123	En tidsstämpel som anger den senast ändrade tiden för resursen som är känd för klienten. Åtgärden utförs endast om resursen på tjänsten har ändrats sedan den angivna tiden.
If-Unmodified-Since		string date-time-rfc1123	En tidsstämpel som anger den senast ä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.

Svar

Name	Type	Description
200 OK	CloudTask	Ett svar som innehåller uppgiften. Headers 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

Azure Active Directory OAuth2 Flow

Type: oauth2
Flow: implicit
Authorization URL: https://login.microsoftonline.com/common/oauth2/authorize

Scopes

Name	Description
user_impersonation	Personifiera ditt användarkonto

Authorization

Type: apiKey
In: header

Exempel

Task get

Sample Request

HTTP

GET account.region.batch.azure.com/jobs/jobId/tasks/taskId?api-version=2022-01-01.15.0

Sample Response

Status code:

200

{
  "id": "testTask",
  "url": "https://account.region.batch.azure.com/jobs/jobId/tasks/taskId",
  "eTag": "0x8D3D62350711C55",
  "creationTime": "2016-09-06T06:59:15.1161429Z",
  "lastModified": "2016-09-06T06:59:15.1161429Z",
  "state": "active",
  "stateTransitionTime": "2016-09-06T06:59:15.1161429Z",
  "commandLine": "cmd /c hostname",
  "userIdentity": {
    "autoUser": {
      "scope": "task",
      "elevationLevel": "nonadmin"
    }
  },
  "multiInstanceSettings": {
    "numberOfInstances": 3,
    "coordinationCommandLine": "cmd /c echo coordinating"
  },
  "constraints": {
    "maxWallClockTime": "P10675199DT2H48M5.4775807S",
    "retentionTime": "P10675199DT2H48M5.4775807S",
    "maxTaskRetryCount": 0
  },
  "requiredSlots": 2,
  "executionInfo": {
    "retryCount": 0,
    "requeueCount": 0
  }
}

Definitioner

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 aktivitet 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.
CloudTask	En Azure Batch uppgift.
ComputeNodeIdentityReference	Referensen till en användartilldelad identitet som är associerad med batchpoolen som en beräkningsnod ska använda.
ComputeNodeInformation	Information om beräkningsnoden som en aktivitet kördes på.
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 uppgiftsprocess.
ErrorCategory	Kategorin för felet.
ErrorMessage	Ett felmeddelande som togs emot i ett Azure Batch felsvar.
ExitCodeMapping	Hur Batch-tjänsten ska svara om en aktivitet 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 har slutförts.
ExitOptions	Anger hur Batch-tjänsten svarar på ett visst avslutsvillkor.
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.
NameValuePair	Representerar ett namn/värde-par.
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.
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 överföringsåtgärd för utdatafiler, inklusive under vilka villkor för att utföra uppladdningen.
ResourceFile	En enda fil eller flera filer som ska laddas ned till en beräkningsnod.
TaskConstraints	Körningsbegränsningar som ska gälla för en aktivitet.
TaskContainerExecutionInformation	Innehåller information om containern som en uppgift körs i.
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.
TaskExecutionInformation	Information om körningen av en aktivitet.
TaskExecutionResult	Resultatet av aktivitetskörningen.
TaskFailureInformation	Information om ett aktivitetsfel.
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.
TaskState	Status för uppgiften.
TaskStatistics	Resursanvändningsstatistik för en aktivitet.
UserIdentity	Definitionen av den användaridentitet som aktiviteten körs under.

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	Type	Description
affinityId	string	En täckande sträng som representerar platsen för en beräkningsnod eller en aktivitet som har körts tidigare. Du kan skicka affinityId för en nod för att ange att aktiviteten måste köras på beräkningsnoden. Observera att detta bara är en mjuk tillhörighet. Om målnoden för beräkningsnoden är upptagen eller inte tillgänglig vid den tidpunkt då aktiviteten schemaläggs schemaläggs aktiviteten någon annanstans.

ApplicationPackageReference

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

Name	Type	Description
applicationId	string	ID:t för programmet som ska distribueras.
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	Type	Description
access	string[]	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 uppgiften.

AutoUserScope

Omfånget för den automatiska användaren

Name	Type	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	Type	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örs 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 aktiviteter, eller om certifikat har angetts i poolen som inte ska vara tillgängliga för normala uppgifter, men som ska vara tillgängliga av StartTasks.

BatchError

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

Name	Type	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	Type	Description
key	string	En identifierare som anger innebörden av egenskapen Value.
value	string	Den ytterligare information som ingår i felsvaret.

CloudTask

En Azure Batch uppgift.

Name	Type	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 ska distribuera till beräkningsnoden innan kommandoraden körs. Programpaket laddas ned och distribueras till en delad katalog, inte till 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 när 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 Batch som tillhandahålls (https://docs.microsoft.com/en-us/azure/batch/batch-compute-node-environment-variables).
constraints	TaskConstraints	De körningsbegränsningar som gäller för den här aktiviteten.
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 den anges. Om den pool som ska köra den här aktiviteten inte har containerConfiguration inställd får den 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 kan komma åt dessa filer.
creationTime	string	Skapandetiden för uppgiften.
dependsOn	TaskDependencies	De uppgifter som 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 de här aktiviteterna misslyckas och deras återförsök räknas kommer den här aktiviteten aldrig att schemaläggas.
displayName	string	Ett visningsnamn för aktiviteten. Visningsnamnet behöver inte vara unikt och kan innehålla alla Unicode-tecken upp till en maximal längd på 1024.
eTag	string	ETag för uppgiften. Det här är en täckande sträng. Du kan använda den för att identifiera om aktiviteten har ändrats mellan begäranden. Du kan i synnerhet skicka ETag när du uppdaterar en aktivitet för att ange att ändringarna ska börja gälla endast om ingen annan har ändrat aktiviteten under tiden.
environmentSettings	EnvironmentSetting[]	En lista över miljövariabelinställningar för aktiviteten.
executionInfo	TaskExecutionInformation	Information om körningen av uppgiften.
exitConditions	ExitConditions	Anger hur Batch-tjänsten ska svara när uppgiften har slutförts. Hur Batch-tjänsten ska svara när uppgiften har slutförts.
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.
lastModified	string	Senast ändrad tid för aktiviteten.
multiInstanceSettings	MultiInstanceSettings	Ett objekt som anger att aktiviteten är en aktivitet med flera instanser och innehåller information om hur du kör multiinstansaktiviteten. Uppgifter med flera instanser används ofta för att stödja MPI-uppgifter. I MPI-fallet misslyckas hela aktiviteten med flera instanser om någon av underaktiviteterna misslyckas (till exempel på grund av att den avslutas med en slutkod som inte är noll). Aktiviteten med flera instanser avslutas och görs om, upp till gränsen för återförsök.
nodeInfo	ComputeNodeInformation	Information om beräkningsnoden som aktiviteten kördes på.
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.
previousState	TaskState	Det tidigare tillståndet för uppgiften. Den här egenskapen anges inte om aktiviteten är i sitt ursprungliga aktiva tillstånd.
previousStateTransitionTime	string	Den tidpunkt då aktiviteten angav sitt tidigare tillstånd. Den här egenskapen anges inte om aktiviteten är i sitt ursprungliga aktiva tillstånd.
requiredSlots	integer	Antalet schemaläggningsplatser som aktiviteten kräver för att köras. Standard ä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 är RequestEntityTooLarge. Om detta inträffar måste samlingen resourcefiles minskas i storlek. Detta kan uppnås med hjälp av .zip filer, programpaket eller Docker-containrar.
state	TaskState	Aktivitetens aktuella tillstånd.
stateTransitionTime	string	Den tidpunkt då aktiviteten övergick till sitt aktuella tillstånd.
stats	TaskStatistics	Resursanvändningsstatistik för aktiviteten.
url	string	Url:en för uppgiften.
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.

ComputeNodeIdentityReference

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

Name	Type	Description
resourceId	string	ARM-resurs-ID för den användartilldelade identiteten.

ComputeNodeInformation

Information om beräkningsnoden som en aktivitet kördes på.

Name	Type	Description
affinityId	string	En identifierare för noden som aktiviteten kördes på, som kan skickas när en aktivitet läggs till för att begära att aktiviteten schemaläggs på den här beräkningsnoden.
nodeId	string	ID:t för beräkningsnoden som aktiviteten kördes på.
nodeUrl	string	URL:en för beräkningsnoden som aktiviteten kördes på.
poolId	string	ID:t för poolen som aktiviteten kördes på.
taskRootDirectory	string	Rotkatalogen för aktiviteten på beräkningsnoden.
taskRootDirectoryUrl	string	URL:en till rotkatalogen för aktiviteten på beräkningsnoden.

ContainerRegistry

Ett privat containerregister.

Name	Type	Description
identityReference	ComputeNodeIdentityReference	Referensen till den användartilldelade identitet som ska användas för att komma åt en Azure Container Registry i stället för användarnamn och lösenord. Referensen till en användartilldelad identitet som är associerad med batchpoolen 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	Type	Description
containerImageDefault	string	Använd arbetskatalogen som definierats i containern Avbildning. Se upp för att den här katalogen inte innehåller de resursfiler som laddats ned av Batch.
taskWorkingDirectory	string	Använd arbetskatalogen för Batch-tjänstens standardtjänst, som innehåller de aktivitetsresursfiler 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	Type	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	Type	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 för en uppgiftsprocess.

Name	Type	Description
name	string	Namnet på miljövariabeln.
value	string	Värdet för miljövariabeln.

ErrorCategory

Kategorin för felet.

Name	Type	Description
servererror	string	Felet beror på ett internt serverproblem.
usererror	string	Felet beror på ett användarproblem, till exempel felkonfiguration.

ErrorMessage

Ett felmeddelande som togs emot i ett Azure Batch felsvar.

Name	Type	Description
lang	string	Språkkoden för felmeddelandet
value	string	Texten i meddelandet.

ExitCodeMapping

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

Name	Type	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	Type	Description
end	integer	Den sista slutkoden i intervallet.
exitOptions	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	Type	Description
default	ExitOptions	Hur Batch-tjänsten ska svara om uppgiften misslyckas med ett avslutsvillkor som inte omfattas av någon av de andra egenskaperna. Det här värdet används om aktiviteten avslutas med någon icke-nollavslutskod 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 samlingen exitCodes eller exitCodeRanges.
exitCodeRanges	ExitCodeRangeMapping[]	En lista över aktivitetsavslutskodintervall 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 uppgiften inte startar på grund av ett fel.

ExitOptions

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

Name	Type	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 "uppfyller" (så att beroende aktiviteter kan fortsätta) och "blockera" (beroende aktiviteter fortsätter att vänta). Batch stöder ännu inte annullering av beroende aktiviteter.
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 avslutas för alla andra avslutningsvillkor. Om jobbets onTaskFailed-egenskap inte är någon åtgärd 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 direkt är HTTP-statuskoden 400 (felaktig begäran).

HttpHeader

Ett HTTP-huvudnamn/värde-par

Name	Type	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 aktiviteten, om aktiviteten slutförs med det angivna avslutsvillkoret och jobbets onTaskFailed-egenskap är "performExitOptionsJobAction".

Name	Type	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	Type	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 aktivitetsresursfiler endast laddas ned för den primära. Observera också att dessa resursfiler inte laddas ned till arbetskatalogen Aktivitet, 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 är RequestEntityTooLarge. Om detta inträffar måste samlingen 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 samordna 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.

NameValuePair

Representerar ett namn/värde-par.

Name	Type	Description
name	string	Namnet i namn/värde-paret.
value	string	Värdet i namn/värde-paret.

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	Type	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 startar i och slutar med .txt i arbetskatalogen Aktivitet eller någon underkatalog. Om filnamnet innehåller ett jokertecken kan det undantas med hakparenteser (till exempel abc[] matchar en fil med namnet abc). Observera att både \ och / behandlas som katalogavgränsare på Windows, men endast / finns i Linux. Miljövariabler (%var% på Windows eller $var i Linux) utökas innan mönstret tillämpas.
uploadOptions	OutputFileUploadOptions	Ytterligare alternativ för uppladdningsåtgärden, inklusive under vilka villkor överföringen ska utföras.

OutputFileBlobContainerDestination

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

Name	Type	Description
containerUrl	string	URL:en för containern i Azure Blob Storage som filen eller filerna ska laddas upp till. Om du 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 att komma åt Azure Blob Storage som anges av containerUrl Identiteten måste ha skrivbehörighet 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. inte innehåller några 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 läggs till i 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 för att ladda upp utdatafiler Dessa rubriker anges när filer laddas upp till Azure Storage. Mer information finns i Begärandehuvuden (alla blobtyper).

OutputFileDestination

Målet som en fil ska laddas upp till.

Name	Type	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	Type	Description
taskcompletion	string	Upload filen eller filerna när aktivitetsprocessen har avslutats, oavsett vad slutkoden var.
taskfailure	string	Upload filen(erna) först när aktivitetsprocessen avslutas med en icke-nollavslutskod.
tasksuccess	string	Upload 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	Type	Description
uploadCondition	OutputFileUploadCondition	De villkor under vilka uppgiftsutdatafilen eller uppsättningen filer ska laddas upp. Standardvärdet är uppgiftskomplettering.

ResourceFile

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

Name	Type	Description
autoStorageContainerName	string	Namnet på lagringscontainern i det automatiska lagringskontot. Egenskaperna autoStorageContainerName, storageContainerUrl och httpUrl utesluter varandra 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 anges laddas alla filer i containern ned.
fileMode	string	Attributet för filbehörighetsläge i oktalt format. Den här egenskapen gäller endast för filer som laddas ned till Linux-beräkningsnoder. Den ignoreras om den anges 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/filerna ska laddas ned till i förhållande till aktivitetens arbetskatalog. Om egenskapen httpUrl anges krävs filePath och den sökväg som filen laddas ned till, inklusive filnamnet. Om egenskapen autoStorageContainerName eller storageContainerUrl anges ä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 ur aktivitetens arbetskatalog (till exempel med hjälp av .. ).
httpUrl	string	URL:en för filen som ska laddas ned. Egenskaperna autoStorageContainerName, storageContainerUrl och httpUrl utesluter varandra 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 bloben, använder en hanterad identitet med läsbehörighet eller anger ACL för bloben eller dess container för att tillåta offentlig åtkomst.
identityReference	ComputeNodeIdentityReference	Referensen till den användartilldelade identitet som ska användas för att komma åt Azure Blob Storage som anges av storageContainerUrl eller httpUrl Referensen till en användartilldelad identitet som är associerad med den Batch-pool som en beräkningsnod ska använda.
storageContainerUrl	string	URL:en för blobcontainern i Azure Blob Storage. Egenskaperna autoStorageContainerName, storageContainerUrl och httpUrl utesluter varandra 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.

TaskConstraints

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

Name	Type	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 slutkod som inte är noll. Batch-tjänsten provar uppgiften en gång och kan sedan försöka igen upp till den här gränsen. 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 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. Om detta inte anges finns det ingen tidsgräns för hur länge aktiviteten kan köras.
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 katalogen Aktivitet och allt dess innehåll. Standardvärdet är 7 dagar, d.v.s. Aktivitetskatalogen behålls i 7 dagar om inte beräkningsnoden tas bort eller jobbet tas bort.

TaskContainerExecutionInformation

Innehåller information om containern som en uppgift körs i.

Name	Type	Description
containerId	string	Containerns ID.
error	string	Detaljerad felinformation om containern. Det här är den detaljerade felsträngen från Docker-tjänsten, om den är tillgänglig. Det motsvarar felfältet som returneras av "docker inspect".
state	string	Containerns tillstånd. Det här är containerns tillstånd enligt Docker-tjänsten. Det motsvarar statusfältet som returneras av "docker inspect".

TaskContainerSettings

Containerinställningarna för en aktivitet.

Name	Type	Description
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 containern Image. 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	Type	Description
taskIdRanges	TaskIdRange[]	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. TaskIds-samlingen ä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 överväga att använda aktivitets-ID-intervall i stället.

TaskExecutionInformation

Information om körningen av en aktivitet.

Name	Type	Description
containerInfo	TaskContainerExecutionInformation	Information om containern under vilken aktiviteten körs. Den här egenskapen anges endast om aktiviteten körs i en containerkontext.
endTime	string	Tidpunkten då uppgiften slutfördes. Den här egenskapen anges endast om aktiviteten är i tillståndet Slutförd.
exitCode	integer	Slutkoden för programmet som anges på kommandoraden Aktivitet. Den här egenskapen anges endast om aktiviteten är i slutfört tillstånd. I allmänhet återspeglar slutkoden för en process den specifika konvention som implementeras av programutvecklaren för den processen. Om du använder slutkodsvärdet för att fatta beslut i koden ska du vara säker på att du känner till den avslutningskodskonvention som används av programprocessen. Men om Batch-tjänsten avslutar aktiviteten (på grund av timeout eller användaravslutning via API:et) kan du se en operativsystemdefinierad slutkod.
failureInfo	TaskFailureInformation	Information som beskriver eventuella aktivitetsfel. Den här egenskapen anges endast om aktiviteten är i slutfört tillstånd och påträffade ett fel.
lastRequeueTime	string	Den senaste gången som aktiviteten har ställts i kö av Batch-tjänsten som ett resultat av en användarbegäran. Den här egenskapen anges endast om requeueCount inte är noll.
lastRetryTime	string	Den senaste tiden då ett nytt försök av aktiviteten började köras. Det här elementet finns bara om aktiviteten gjordes om (dvs. retryCount är inte noll). Om det finns är detta vanligtvis samma som startTime, men kan skilja sig om aktiviteten har startats om av andra orsaker än att försöka igen. Om beräkningsnoden till exempel startades om under ett nytt försök uppdateras startTime men inte lastRetryTime.
requeueCount	integer	Antalet gånger som aktiviteten har ställts till svars av Batch-tjänsten som ett resultat av en användarbegäran. När användaren tar bort beräkningsnoder från en pool (genom att ändra storlek på/krympa poolen) eller när jobbet inaktiveras kan användaren ange att aktiviteter som körs på beräkningsnoderna ska placeras i kö igen för körning. Det här antalet spårar hur många gånger uppgiften har ställts in på nytt av dessa skäl.
result	TaskExecutionResult	Resultatet av aktivitetskörningen. Om värdet är "failed" (misslyckades) finns information om felet i egenskapen failureInfo.
retryCount	integer	Antalet gånger som Batch-tjänsten har försökt utföra uppgiften på nytt. Fel i aktivitetsprogram (slutkod som inte är noll) görs om, förbearbetningsfel (aktiviteten kunde inte köras) och filuppladdningsfel görs inte igen. Batch-tjänsten försöker utföra uppgiften igen upp till den gräns som anges av begränsningarna.
startTime	string	Tidpunkten då aktiviteten började köras. "Körs" motsvarar körningstillståndet, så om aktiviteten anger resursfiler eller paket visar starttiden den tidpunkt då aktiviteten började ladda ned eller distribuera dessa. Om aktiviteten har startats om eller gjorts om är det här den senaste gången som aktiviteten började köras. Den här egenskapen finns bara för uppgifter som körs eller är i slutfört tillstånd.

TaskExecutionResult

Resultatet av aktivitetskörningen.

Name	Type	Description
failure	string	Ett fel uppstod under bearbetningen av aktiviteten. Felet kan ha inträffat innan aktivitetsprocessen startades, medan aktivitetsprocessen kördes eller när aktivitetsprocessen avslutades.
success	string	Uppgiften kördes korrekt.

TaskFailureInformation

Information om ett aktivitetsfel.

Name	Type	Description
category	ErrorCategory	Kategorin för aktivitetsfelet.
code	string	En identifierare för aktivitetsfelet. Koder är invarianta och är avsedda att användas programmatiskt.
details	NameValuePair[]	En lista med ytterligare information om felet.
message	string	Ett meddelande som beskriver aktivitetsfelet, avsett att vara lämpligt för visning i ett användargränssnitt.

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	Type	Description
end	integer	Det sista aktivitets-ID:t i intervallet.
start	integer	Det första aktivitets-ID:t i intervallet.

TaskState

Status för uppgiften.

Name	Type	Description
active	string	Uppgiften placeras i kö och kan köras, men är för närvarande inte tilldelad till en beräkningsnod. En aktivitet anger det här tillståndet när den skapas, när den är aktiverad efter att den har inaktiverats eller när den väntar på ett nytt försök efter en misslyckad körning.
completed	string	Aktiviteten är inte längre berättigad att köras, vanligtvis på grund av att aktiviteten har slutförts, eller så har aktiviteten slutförts utan framgång och har uttömt sin återförsöksgräns. En aktivitet markeras också som slutförd om ett fel uppstod när aktiviteten startades eller när aktiviteten har avslutats.
preparing	string	Uppgiften har tilldelats till en beräkningsnod, men väntar på att en obligatorisk jobbförberedelseaktivitet ska slutföras på beräkningsnoden. Om jobbförberedelseaktiviteten lyckas flyttas aktiviteten till att köras. Om jobbförberedelseaktiviteten misslyckas återgår aktiviteten till aktiv och är berättigad att tilldelas till en annan beräkningsnod.
running	string	Uppgiften körs på en beräkningsnod. Detta inkluderar förberedelse på aktivitetsnivå, till exempel nedladdning av resursfiler eller distribution av paket som anges i aktiviteten – det betyder inte nödvändigtvis att kommandoraden Aktivitet har börjat köras.

TaskStatistics

Resursanvändningsstatistik för en aktivitet.

Name	Type	Description
kernelCPUTime	string	Den totala cpu-tiden för kernelläge (summerad över alla kärnor och alla beräkningsnoder) som används av aktiviteten.
lastUpdateTime	string	Tidpunkten då statistiken senast uppdaterades. All statistik är begränsad till intervallet mellan startTime och lastUpdateTime.
readIOGiB	number	Det totala antalet gibibyte som lästs från disken av aktiviteten.
readIOps	integer	Det totala antalet diskläsningsåtgärder som aktiviteten utför.
startTime	string	Starttiden för det tidsintervall som omfattas av statistiken.
url	string	URL:en för statistiken.
userCPUTime	string	Den totala cpu-tiden för användarläge (summerad över alla kärnor och alla beräkningsnoder) som används av aktiviteten.
waitTime	string	Den totala väntetiden för aktiviteten. Väntetiden för en aktivitet definieras som den förflutna tiden mellan skapandet av aktiviteten och starten av körningen av aktiviteten. (Om aktiviteten görs om på grund av fel är väntetiden den senaste aktivitetskörningen.)
wallClockTime	string	Den totala klocktiden för aktiviteten. Tiden för väggklockan är den tid som förflutit från när aktiviteten började köras på en beräkningsnod till när den var klar (eller till sista gången statistiken uppdaterades, om aktiviteten inte hade slutförts då). Om uppgiften gjordes på nytt inkluderar detta klocktiden för alla återförsök i aktiviteten.
writeIOGiB	number	Det totala antalet gibibyte som skrivits till disken av aktiviteten.
writeIOps	integer	Det totala antalet diskskrivningsåtgärder som aktiviteten utför.

UserIdentity

Definitionen av den användaridentitet som aktiviteten körs under.

Name	Type	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.