Task - List

Service:

Batch Service

API-versie:

2024-07-01.20.0

Een lijst met alle taken die zijn gekoppeld aan de opgegeven taak.
Voor taken met meerdere exemplaren verwijst informatie zoals affinityId, executionInfo en nodeInfo naar de primaire taak. Gebruik de API voor lijstsubtaken om informatie over subtaken op te halen.

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

Met optionele parameters:

GET {batchUrl}/jobs/{jobId}/tasks?$filter={$filter}&$select={$select}&$expand={$expand}&maxresults={maxresults}&timeout={timeout}&api-version=2024-07-01.20.0

URI-parameters

Name	In	Vereist	Type	Description
batchUrl	path	True	string	De basis-URL voor alle Azure Batch-serviceaanvragen.
jobId	path	True	string	De id van de taak.
api-version	query	True	string	Client-API-versie.
$expand	query		string	Een OData-$expand-component.
$filter	query		string	Een OData-$filter-component. Zie https://learn.microsoft.com/rest/api/batchservice/odata-filters-in-batch#list-tasksvoor meer informatie over het maken van dit filter.
$select	query		string	Een OData-$select-component.
maxresults	query		integer int32	Het maximum aantal items dat moet worden geretourneerd in het antwoord. Er kunnen maximaal 1000 taken worden geretourneerd.
timeout	query		integer int32	De maximale tijd die de server kan besteden aan het verwerken van de aanvraag, in seconden. De standaardwaarde is 30 seconden. Als de waarde groter is dan 30, wordt in plaats daarvan de standaardwaarde gebruikt.

Aanvraagkoptekst

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

Name	Vereist	Type	Description
client-request-id		string uuid	De door de aanroeper gegenereerde aanvraagidentiteit, in de vorm van een GUID zonder decoratie, zoals accolades, bijvoorbeeld 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0.
return-client-request-id		boolean	Of de server de clientaanvraag-id in het antwoord moet retourneren.
ocp-date		string date-time-rfc1123	Het tijdstip waarop de aanvraag is uitgegeven. Clientbibliotheken stellen dit doorgaans in op de huidige kloktijd van het systeem; stel deze expliciet in als u de REST API rechtstreeks aanroept.

Antwoorden

Name	Type	Description
200 OK	CloudTaskListResult	Een antwoord met de lijst met taken. Kopteksten client-request-id: string request-id: string ETag: string Last-Modified: string
Other Status Codes	BatchError	De fout van de Batch-service.

Beveiliging

azure_auth

Microsoft Entra OAuth 2.0-verificatiecodestroom

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

Bereiken

Name	Description
user_impersonation	Uw gebruikersaccount imiteren

Authorization

Type: apiKey
In: header

Voorbeelden

Task list

Voorbeeldaanvraag

HTTP

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

Voorbeeldrespons

Statuscode:

200

{
  "value": [
    {
      "id": "task1",
      "url": "https://account.region.batch.azure.com/jobs/jobId/tasks/task1",
      "eTag": "0x8D4125FD1A825A4",
      "creationTime": "2016-11-21T22:43:31.4733476Z",
      "lastModified": "2016-11-21T22:43:31.4733476Z",
      "state": "active",
      "stateTransitionTime": "2016-11-21T22:43:31.4733476Z",
      "commandLine": "cmd /c echo task1",
      "userIdentity": {
        "autoUser": {
          "scope": "task",
          "elevationLevel": "nonadmin"
        }
      },
      "constraints": {
        "maxWallClockTime": "P10675199DT2H48M5.4775807S",
        "retentionTime": "P10675199DT2H48M5.4775807S",
        "maxTaskRetryCount": 0
      },
      "requiredSlots": 2,
      "executionInfo": {
        "retryCount": 0,
        "requeueCount": 0
      }
    },
    {
      "id": "task2",
      "url": "https://account.region.batch.azure.com/jobs/jobId/tasks/task2",
      "eTag": "0x8D4125FD2153345",
      "creationTime": "2016-11-21T22:43:31.6736345Z",
      "lastModified": "2016-11-21T22:43:32.1880389Z",
      "state": "active",
      "stateTransitionTime": "2016-11-21T22:43:31.6736345Z",
      "commandLine": "cmd /c echo task2",
      "userIdentity": {
        "autoUser": {
          "scope": "task",
          "elevationLevel": "nonadmin"
        }
      },
      "constraints": {
        "maxWallClockTime": "P10675199DT2H48M5.4775807S",
        "retentionTime": "P10675199DT2H48M5.4775807S",
        "maxTaskRetryCount": 3
      },
      "requiredSlots": 2,
      "executionInfo": {
        "retryCount": 0,
        "requeueCount": 0
      }
    }
  ]
}

Definities

Name	Description
AccessScope	De Batch-resources waaraan het token toegang verleent.
AffinityInformation	Een localiteitshint die door de Batch-service kan worden gebruikt om een rekenknooppunt te selecteren waarop een taak moet worden gestart.
ApplicationPackageReference	Een verwijzing naar een pakket dat moet worden geïmplementeerd op rekenknooppunten.
AuthenticationTokenSettings	De instellingen voor een verificatietoken dat de taak kan gebruiken om Batch-servicebewerkingen uit te voeren.
AutoUserScope	Het bereik voor de automatische gebruiker
AutoUserSpecification	Hiermee geeft u de parameters op voor de automatische gebruiker die een taak uitvoert in de Batch-service.
BatchError	Er is een foutbericht ontvangen van de Azure Batch-service.
BatchErrorDetail	Een item met aanvullende informatie die is opgenomen in een Azure Batch-foutreactie.
CloudTask	Een Azure Batch-taak.
CloudTaskListResult	Het resultaat van het weergeven van de taken in een taak.
ComputeNodeIdentityReference	De verwijzing naar een door de gebruiker toegewezen identiteit die is gekoppeld aan de Batch-pool die door een rekenknooppunt wordt gebruikt.
ComputeNodeInformation	Informatie over het rekenknooppunt waarop een taak is uitgevoerd.
ContainerHostBatchBindMountEntry	De vermelding van het pad en de koppelingsmodus die u wilt koppelen aan de taakcontainer.
ContainerHostDataPath	De paden die worden gekoppeld aan de container van de containertaak.
ContainerRegistry	Een privécontainerregister.
ContainerWorkingDirectory	De locatie van de werkmap containertaak.
DependencyAction	Een actie die door de Batch-service wordt uitgevoerd op taken die afhankelijk zijn van deze taak.
ElevationLevel	Het hoogteniveau van de gebruiker.
EnvironmentSetting	Een omgevingsvariabele die moet worden ingesteld voor een taakproces.
ErrorCategory	De categorie van de fout.
ErrorMessage	Een foutbericht dat is ontvangen in een Azure Batch-foutreactie.
ExitCodeMapping	Hoe de Batch-service moet reageren als een taak wordt afgesloten met een bepaalde afsluitcode.
ExitCodeRangeMapping	Een reeks afsluitcodes en hoe de Batch-service moet reageren op afsluitcodes binnen dat bereik.
ExitConditions	Hiermee geeft u op hoe de Batch-service moet reageren wanneer de taak is voltooid.
ExitOptions	Hiermee geeft u op hoe de Batch-service reageert op een bepaalde afsluitvoorwaarde.
HttpHeader	Een http-headernaam-waardepaar
JobAction	Een actie die moet worden uitgevoerd op de taak die de taak bevat, als de taak is voltooid met de opgegeven afsluitvoorwaarde en de eigenschap onTaskFailed van de taak is 'performExitOptionsJobAction'.
MultiInstanceSettings	Instellingen die aangeven hoe een taak met meerdere exemplaren moet worden uitgevoerd.
NameValuePair	Vertegenwoordigt een naam-waardepaar.
OutputFile	Een specificatie voor het uploaden van bestanden van een Azure Batch Compute-knooppunt naar een andere locatie nadat de Batch-service klaar is met het uitvoeren van het taakproces.
OutputFileBlobContainerDestination	Hiermee geeft u een doel voor het uploaden van bestanden in een Azure Blob Storage-container op.
OutputFileDestination	Het doel waarnaar een bestand moet worden geüpload.
OutputFileUploadCondition	De voorwaarden waaronder een taakuitvoerbestand of een set bestanden moet worden geüpload.
OutputFileUploadOptions	Details over een uploadbewerking voor een uitvoerbestand, waaronder onder welke voorwaarden de upload moet worden uitgevoerd.
ResourceFile	Eén bestand of meerdere bestanden die moeten worden gedownload naar een rekenknooppunt.
TaskConstraints	Uitvoeringsbeperkingen die van toepassing zijn op een taak.
TaskContainerExecutionInformation	Bevat informatie over de container die een taak uitvoert.
TaskContainerSettings	De containerinstellingen voor een taak.
TaskDependencies	Hiermee geeft u eventuele afhankelijkheden van een taak op. Elke taak die expliciet of binnen een afhankelijkheidsbereik is opgegeven, moet worden voltooid voordat de afhankelijke taak wordt gepland.
TaskExecutionInformation	Informatie over de uitvoering van een taak.
TaskExecutionResult	Het resultaat van taakuitvoering.
TaskFailureInformation	Informatie over een taakfout.
TaskIdRange	Een reeks taak-id's waarvan een taak afhankelijk kan zijn. Alle taken met id's in het bereik moeten worden voltooid voordat de afhankelijke taak kan worden gepland.
TaskState	De status van de taak.
TaskStatistics	Statistieken over resourcegebruik voor een taak.
UserIdentity	De definitie van de gebruikersidentiteit waaronder de taak wordt uitgevoerd.

AccessScope

De Batch-resources waaraan het token toegang verleent.

Name	Type	Description
job	string	Verleent toegang om alle bewerkingen uit te voeren op de taak die de taak bevat.

AffinityInformation

Een localiteitshint die door de Batch-service kan worden gebruikt om een rekenknooppunt te selecteren waarop een taak moet worden gestart.

Name	Type	Description
affinityId	string	Een ondoorzichtige tekenreeks die de locatie van een rekenknooppunt of een taak vertegenwoordigt die eerder is uitgevoerd. U kunt de affinityId van een knooppunt doorgeven om aan te geven dat deze taak moet worden uitgevoerd op dat rekenknooppunt. Houd er rekening mee dat dit slechts een zachte affiniteit is. Als het doel-rekenknooppunt bezet is of niet beschikbaar is op het moment dat de taak is gepland, wordt de taak elders gepland.

ApplicationPackageReference

Een verwijzing naar een pakket dat moet worden geïmplementeerd op rekenknooppunten.

Name	Type	Description
applicationId	string	De id van de toepassing die moet worden geïmplementeerd. Bij het maken van een pool moet de toepassings-id van het pakket volledig zijn gekwalificeerd (/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Batch/batchAccounts/{accountName}/applications/{applicationName}).
version	string	De versie van de toepassing die moet worden geïmplementeerd. Als u dit weglaat, wordt de standaardversie geïmplementeerd. Als dit wordt weggelaten in een pool en er geen standaardversie is opgegeven voor deze toepassing, mislukt de aanvraag met de foutcode InvalidApplicationPackageReferences en HTTP-statuscode 409. Als dit wordt weggelaten bij een taak en er geen standaardversie is opgegeven voor deze toepassing, mislukt de taak met een fout vóór de verwerking.

AuthenticationTokenSettings

De instellingen voor een verificatietoken dat de taak kan gebruiken om Batch-servicebewerkingen uit te voeren.

Name	Type	Description
access	AccessScope[]	De Batch-resources waaraan het token toegang verleent. Het verificatietoken verleent toegang tot een beperkte set Batch-servicebewerkingen. Momenteel is de enige ondersteunde waarde voor de toegangseigenschap 'job', die toegang verleent tot alle bewerkingen die betrekking hebben op de taak die de taak bevat.

AutoUserScope

Het bereik voor de automatische gebruiker

Name	Type	Description
pool	string	Hiermee geeft u op dat de taak wordt uitgevoerd als het algemene automatische gebruikersaccount dat wordt gemaakt op elk rekenknooppunt in een pool.
task	string	Hiermee geeft u op dat de service een nieuwe gebruiker voor de taak moet maken.

AutoUserSpecification

Hiermee geeft u de parameters op voor de automatische gebruiker die een taak uitvoert in de Batch-service.

Name	Type	Description
elevationLevel	ElevationLevel	Het hoogteniveau van de automatische gebruiker. De standaardwaarde is nietAdmin.
scope	AutoUserScope	Het bereik voor de automatische gebruiker De standaardwaarde is pool. Als de pool Windows uitvoert, moet een waarde van Taak worden opgegeven als strengere isolatie tussen taken vereist is. Als de taak bijvoorbeeld het register op een manier muteert die van invloed kan zijn op andere taken, of als certificaten zijn opgegeven in de pool die niet toegankelijk moet zijn voor normale taken, maar toegankelijk moeten zijn voor StartTasks.

BatchError

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

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

BatchErrorDetail

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

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

CloudTask

Een Azure Batch-taak.

Name	Type	Description
affinityInfo	AffinityInformation	Een localiteitshint die door de Batch-service kan worden gebruikt om een rekenknooppunt te selecteren waarop de nieuwe taak moet worden gestart.
applicationPackageReferences	ApplicationPackageReference[]	Een lijst met pakketten die door de Batch-service worden geïmplementeerd in het rekenknooppunt voordat u de opdrachtregel uitvoert. Toepassingspakketten worden gedownload en geïmplementeerd in een gedeelde map, niet in de werkmap Taak. Dus als een pakket waarnaar wordt verwezen al op het knooppunt staat en up-to-date is, wordt het niet opnieuw gedownload; de bestaande kopie op het rekenknooppunt wordt gebruikt. Als een pakket waarnaar wordt verwezen niet kan worden geïnstalleerd, bijvoorbeeld omdat het pakket is verwijderd of omdat het downloaden is mislukt, mislukt de taak.
authenticationTokenSettings	AuthenticationTokenSettings	De instellingen voor een verificatietoken dat de taak kan gebruiken om Batch-servicebewerkingen uit te voeren. Als deze eigenschap is ingesteld, biedt de Batch-service de taak een verificatietoken dat kan worden gebruikt voor het verifiëren van Batch-servicebewerkingen zonder dat hiervoor een accounttoegangssleutel is vereist. Het token wordt geleverd via de omgevingsvariabele AZ_BATCH_AUTHENTICATION_TOKEN. De bewerkingen die de taak kan uitvoeren met behulp van het token, zijn afhankelijk van de instellingen. Een taak kan bijvoorbeeld taakmachtigingen aanvragen om andere taken aan de taak toe te voegen of de status van de taak of van andere taken onder de taak te controleren.
commandLine	string	De opdrachtregel van de taak. Voor taken met meerdere exemplaren wordt de opdrachtregel uitgevoerd als de primaire taak, nadat de primaire taak en alle subtaken de coördinatieopdrachtregel hebben voltooid. De opdrachtregel wordt niet uitgevoerd onder een shell en kan daarom niet profiteren van shell-functies zoals uitbreiding van omgevingsvariabelen. Als u van dergelijke functies wilt profiteren, moet u de shell aanroepen op de opdrachtregel, bijvoorbeeld met 'cmd /c MyCommand' in Windows of '/bin/sh -c MyCommand' in Linux. Als de opdrachtregel verwijst naar bestandspaden, moet deze een relatief pad gebruiken (ten opzichte van de werkmap Taak) of de door Batch geleverde omgevingsvariabele (https://learn.microsoft.com/azure/batch/batch-compute-node-environment-variables).
constraints	TaskConstraints	De uitvoeringsbeperkingen die van toepassing zijn op deze taak.
containerSettings	TaskContainerSettings	De instellingen voor de container waaronder de taak wordt uitgevoerd. Als voor de pool die deze taak wordt uitgevoerd, een containerconfiguratieset is ingesteld, moet dit ook worden ingesteld. Als de pool die deze taak uitvoert, geen containerConfiguration-set heeft, mag dit niet worden ingesteld. Wanneer dit is opgegeven, worden alle mappen recursief onder de AZ_BATCH_NODE_ROOT_DIR (de hoofdmap van Azure Batch-mappen op het knooppunt) toegewezen aan de container, worden alle omgevingsvariabelen van de taak toegewezen aan de container en wordt de opdrachtregel Taak uitgevoerd in de container. Bestanden die worden geproduceerd in de container buiten AZ_BATCH_NODE_ROOT_DIR worden mogelijk niet weergegeven op de hostschijf, wat betekent dat Batch-bestands-API's geen toegang hebben tot deze bestanden.
creationTime	string	De aanmaaktijd van de taak.
dependsOn	TaskDependencies	De taken waarop deze taak afhankelijk is. Deze taak wordt pas gepland als alle taken waarvoor deze afhankelijk is, zijn voltooid. Als een van deze taken mislukt en het aantal nieuwe pogingen uitput, wordt deze taak nooit gepland.
displayName	string	Een weergavenaam voor de taak. De weergavenaam hoeft niet uniek te zijn en mag unicode-tekens bevatten tot een maximale lengte van 1024.
eTag	string	De ETag van de taak. Dit is een ondoorzichtige tekenreeks. U kunt deze gebruiken om te detecteren of de taak is gewijzigd tussen aanvragen. In het bijzonder kunt u de ETag doorgeven wanneer u een taak bijwerkt om op te geven dat uw wijzigingen alleen van kracht moeten worden als niemand anders de taak in de tussentijd heeft gewijzigd.
environmentSettings	EnvironmentSetting[]	Een lijst met omgevingsvariabeleinstellingen voor de taak.
executionInfo	TaskExecutionInformation	Informatie over de uitvoering van de taak.
exitConditions	ExitConditions	Hiermee geeft u op hoe de Batch-service moet reageren wanneer de taak is voltooid. Hoe de Batch-service moet reageren wanneer de taak is voltooid.
id	string	Een tekenreeks die de taak uniek identificeert binnen de taak. De id kan elke combinatie van alfanumerieke tekens bevatten, inclusief afbreekstreepjes en onderstrepingstekens, en mag niet meer dan 64 tekens bevatten.
lastModified	string	De laatste wijzigingstijd van de taak.
multiInstanceSettings	MultiInstanceSettings	Een object dat aangeeft dat de taak een taak met meerdere exemplaren is en informatie bevat over het uitvoeren van de taak met meerdere exemplaren. Taken met meerdere exemplaren worden vaak gebruikt ter ondersteuning van MPI-taken. Als in het MPI-geval een van de subtaken mislukt (bijvoorbeeld door afsluiten met een afsluitcode zonder nul) mislukt de hele taak met meerdere exemplaren. De taak met meerdere exemplaren wordt vervolgens beëindigd en opnieuw geprobeerd, tot aan de limiet voor opnieuw proberen.
nodeInfo	ComputeNodeInformation	Informatie over het rekenknooppunt waarop de taak is uitgevoerd.
outputFiles	OutputFile[]	Een lijst met bestanden die de Batch-service vanaf het rekenknooppunt uploadt nadat de opdrachtregel is uitgevoerd. Voor taken met meerdere exemplaren worden de bestanden alleen geüpload vanuit het rekenknooppunt waarop de primaire taak wordt uitgevoerd.
previousState	TaskState	De vorige status van de taak. Deze eigenschap is niet ingesteld als de taak de oorspronkelijke actieve status heeft.
previousStateTransitionTime	string	Het tijdstip waarop de taak de vorige status heeft ingevoerd. Deze eigenschap is niet ingesteld als de taak de oorspronkelijke actieve status heeft.
requiredSlots	integer	Het aantal planningssites dat de taak moet uitvoeren. De standaardwaarde is 1. Een taak kan alleen worden gepland om te worden uitgevoerd op een rekenknooppunt als het knooppunt voldoende vrije planningssites beschikbaar heeft. Voor taken met meerdere exemplaren moet dit 1 zijn.
resourceFiles	ResourceFile[]	Een lijst met bestanden die de Batch-service naar het rekenknooppunt downloadt voordat u de opdrachtregel uitvoert. Voor taken met meerdere exemplaren worden de resourcebestanden alleen gedownload naar het rekenknooppunt waarop de primaire taak wordt uitgevoerd. Er is een maximale grootte voor de lijst met resourcebestanden. Wanneer de maximale grootte wordt overschreden, mislukt de aanvraag en is de antwoordfoutcode RequestEntityTooLarge. Als dit het geval is, moet de verzameling ResourceFiles worden verkleind. Dit kan worden bereikt met behulp van .zip bestanden, toepassingspakketten of Docker-containers.
state	TaskState	De huidige status van de taak.
stateTransitionTime	string	Het tijdstip waarop de taak de huidige status heeft ingevoerd.
stats	TaskStatistics	Statistieken over resourcegebruik voor de taak.
url	string	De URL van de taak.
userIdentity	UserIdentity	De gebruikersidentiteit waaronder de taak wordt uitgevoerd. Als u dit weglaat, wordt de taak uitgevoerd als een niet-gebruiker met beheerdersrechten die uniek is voor de taak.

CloudTaskListResult

Het resultaat van het weergeven van de taken in een taak.

Name	Type	Description
odata.nextLink	string	De URL voor het ophalen van de volgende set resultaten.
value	CloudTask[]	De lijst met taken.

ComputeNodeIdentityReference

De verwijzing naar een door de gebruiker toegewezen identiteit die is gekoppeld aan de Batch-pool die door een rekenknooppunt wordt gebruikt.

Name	Type	Description
resourceId	string	De ARM-resource-id van de door de gebruiker toegewezen identiteit.

ComputeNodeInformation

Informatie over het rekenknooppunt waarop een taak is uitgevoerd.

Name	Type	Description
affinityId	string	Een id voor het knooppunt waarop de taak is uitgevoerd, die kan worden doorgegeven bij het toevoegen van een taak om aan te vragen of de taak op dit rekenknooppunt moet worden gepland.
nodeId	string	De id van het rekenknooppunt waarop de taak is uitgevoerd.
nodeUrl	string	De URL van het rekenknooppunt waarop de taak is uitgevoerd.
poolId	string	De id van de pool waarop de taak is uitgevoerd.
taskRootDirectory	string	De hoofdmap van de taak op het rekenknooppunt.
taskRootDirectoryUrl	string	De URL naar de hoofdmap van de taak op het rekenknooppunt.

ContainerHostBatchBindMountEntry

De vermelding van het pad en de koppelingsmodus die u wilt koppelen aan de taakcontainer.

Name	Type	Description
isReadOnly	boolean	Koppel dit bronpad als alleen-lezenmodus of niet. De standaardwaarde is onwaar (lees-/schrijfmodus). Als u voor Linux dit pad koppelt als een lees-/schrijfmodus, betekent dit niet dat alle gebruikers in de container de lees-/schrijftoegang voor het pad hebben, afhankelijk van de toegang in de host-VM. Als dit pad is gekoppeld met het kenmerk Alleen-lezen, kunnen alle gebruikers in de container het pad niet wijzigen.
source	ContainerHostDataPath	Het pad dat aan de containerklant wordt gekoppeld, kan worden geselecteerd.

ContainerHostDataPath

De paden die worden gekoppeld aan de container van de containertaak.

Name	Type	Description
Applications	string	Het pad naar toepassingen.
JobPrep	string	Het taakpad voor de taakvoorbereiding.
Shared	string	Het pad voor de taak met meerdere exemplaren om hun bestanden te delen.
Startup	string	Het pad voor de begintaak.
Task	string	Het taakpad.
VfsMounts	string	Het pad bevat alle virtuele bestandssystemen die op dit knooppunt zijn gekoppeld.

ContainerRegistry

Een privécontainerregister.

Name	Type	Description
identityReference	ComputeNodeIdentityReference	De verwijzing naar de door de gebruiker toegewezen identiteit die moet worden gebruikt voor toegang tot een Azure Container Registry in plaats van een gebruikersnaam en wachtwoord. De verwijzing naar een door de gebruiker toegewezen identiteit die is gekoppeld aan de Batch-pool die door een rekenknooppunt wordt gebruikt.
password	string	Het wachtwoord om u aan te melden bij de registerserver.
registryServer	string	De register-URL. Als u dit weglaat, is de standaardwaarde 'docker.io'.
username	string	De gebruikersnaam om u aan te melden bij de registerserver.

ContainerWorkingDirectory

De locatie van de werkmap containertaak.

Name	Type	Description
containerImageDefault	string	Gebruik de werkmap die is gedefinieerd in de containerinstallatiekopieën. Let erop dat deze map niet de resourcebestanden bevat die door Batch zijn gedownload.
taskWorkingDirectory	string	Gebruik de standaardwerkmap batchservicetaak, die de taakresourcebestanden bevat die door Batch zijn ingevuld.

DependencyAction

Een actie die door de Batch-service wordt uitgevoerd op taken die afhankelijk zijn van deze taak.

Name	Type	Description
block	string	Hiermee blokkeert u taken die op deze taak wachten, waardoor ze niet kunnen worden gepland.
satisfy	string	Voldoen aan taken die wachten op deze taak; zodra aan alle afhankelijkheden is voldaan, wordt de taak gepland om te worden uitgevoerd.

ElevationLevel

Het hoogteniveau van de gebruiker.

Name	Type	Description
admin	string	De gebruiker is een gebruiker met verhoogde toegang en werkt met volledige beheerdersmachtigingen.
nonadmin	string	De gebruiker is een standaardgebruiker zonder verhoogde toegang.

EnvironmentSetting

Een omgevingsvariabele die moet worden ingesteld voor een taakproces.

Name	Type	Description
name	string	De naam van de omgevingsvariabele.
value	string	De waarde van de omgevingsvariabele.

ErrorCategory

De categorie van de fout.

Name	Type	Description
servererror	string	De fout wordt veroorzaakt door een probleem met de interne server.
usererror	string	De fout wordt veroorzaakt door een gebruikersprobleem, zoals onjuiste configuratie.

ErrorMessage

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

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

ExitCodeMapping

Hoe de Batch-service moet reageren als een taak wordt afgesloten met een bepaalde afsluitcode.

Name	Type	Description
code	integer	Een afsluitcode voor proces.
exitOptions	ExitOptions	Hoe de Batch-service moet reageren als de taak wordt afgesloten met deze afsluitcode.

ExitCodeRangeMapping

Een reeks afsluitcodes en hoe de Batch-service moet reageren op afsluitcodes binnen dat bereik.

Name	Type	Description
end	integer	De laatste afsluitcode in het bereik.
exitOptions	ExitOptions	Hoe de Batch-service moet reageren als de taak wordt afgesloten met een afsluitcode in het bereik begint te eindigen (inclusief).
start	integer	De eerste afsluitcode in het bereik.

ExitConditions

Hiermee geeft u op hoe de Batch-service moet reageren wanneer de taak is voltooid.

Name	Type	Description
default	ExitOptions	Hoe de Batch-service moet reageren als de taak mislukt met een afsluitvoorwaarde die niet wordt gedekt door een van de andere eigenschappen. Deze waarde wordt gebruikt als de taak wordt afgesloten met een niet-nul-afsluitcode die niet wordt vermeld in de verzameling exitCodes of exitCodeRanges, met een preverwerkingsfout als de eigenschap preProcessingError niet aanwezig is of als de eigenschap fileUploadError niet aanwezig is. Als u niet-standaardgedrag wilt bij afsluitcode 0, moet u deze expliciet vermelden met behulp van de exitCodes- of exitCodeRanges-verzameling.
exitCodeRanges	ExitCodeRangeMapping[]	Een lijst met afsluitcodebereiken voor taken en hoe de Batch-service hierop moet reageren.
exitCodes	ExitCodeMapping[]	Een lijst met afzonderlijke taakafsluitcodes en hoe de Batch-service erop moet reageren.
fileUploadError	ExitOptions	Hoe de Batch-service moet reageren als er een bestandsuploadfout optreedt. Als de taak is afgesloten met een afsluitcode die is opgegeven via exitCodes of exitCodeRanges, en er vervolgens een fout is opgetreden bij het uploaden van bestanden, heeft de actie die is opgegeven door de afsluitcode voorrang.
preProcessingError	ExitOptions	Hoe de Batch-service moet reageren als de taak niet kan worden gestart vanwege een fout.

ExitOptions

Hiermee geeft u op hoe de Batch-service reageert op een bepaalde afsluitvoorwaarde.

Name	Type	Description
dependencyAction	DependencyAction	Een actie die door de Batch-service wordt uitgevoerd op taken die afhankelijk zijn van deze taak. Mogelijke waarden zijn 'voldoen' (afhankelijke taken kunnen worden voortgezet) en 'blokkeren' (afhankelijke taken blijven wachten). Batch biedt nog geen ondersteuning voor annulering van afhankelijke taken.
jobAction	JobAction	Een actie die moet worden uitgevoerd op de taak die de taak bevat, als de taak is voltooid met de opgegeven afsluitvoorwaarde en de eigenschap onTaskFailed van de taak is 'performExitOptionsJobAction'. De standaardwaarde is geen voor afsluitcode 0 en wordt beëindigd voor alle andere afsluitvoorwaarden. Als de eigenschap onTaskFailed van de taak geen actie is, retourneert het opgeven van deze eigenschap een fout en mislukt de taakaanvraag toevoegen met een ongeldige eigenschapswaardefout; als u de REST API rechtstreeks aanroept, is de HTTP-statuscode 400 (Ongeldige aanvraag).

HttpHeader

Een http-headernaam-waardepaar

Name	Type	Description
name	string	De hoofdlettergevoelige naam van de header die moet worden gebruikt tijdens het uploaden van uitvoerbestanden
value	string	De waarde van de header die moet worden gebruikt tijdens het uploaden van uitvoerbestanden

JobAction

Een actie die moet worden uitgevoerd op de taak die de taak bevat, als de taak is voltooid met de opgegeven afsluitvoorwaarde en de eigenschap onTaskFailed van de taak is 'performExitOptionsJobAction'.

Name	Type	Description
disable	string	Schakel de taak uit. Dit komt overeen met het aanroepen van de taak-API voor uitschakelen, met een disableTasks-waarde van requeue.
none	string	Geen actie ondernemen.
terminate	string	Beëindig de taak. De terminateReason in de executionInfo van de taak is ingesteld op 'TaskFailed'.

MultiInstanceSettings

Instellingen die aangeven hoe een taak met meerdere exemplaren moet worden uitgevoerd.

Name	Type	Description
commonResourceFiles	ResourceFile[]	Een lijst met bestanden die door de Batch-service worden gedownload voordat de opdrachtregel voor coördinatie wordt uitgevoerd. Het verschil tussen algemene resourcebestanden en taakresourcebestanden is dat algemene resourcebestanden worden gedownload voor alle subtaken, inclusief de primaire, terwijl taakresourcebestanden alleen voor de primaire worden gedownload. Houd er ook rekening mee dat deze resourcebestanden niet worden gedownload naar de werkmap Taak, maar in plaats daarvan worden gedownload naar de hoofdmap van de taak (één map boven de werkmap). Er is een maximale grootte voor de lijst met resourcebestanden. Wanneer de maximale grootte wordt overschreden, mislukt de aanvraag en is de antwoordfoutcode RequestEntityTooLarge. Als dit het geval is, moet de verzameling ResourceFiles worden verkleind. Dit kan worden bereikt met behulp van .zip bestanden, toepassingspakketten of Docker-containers.
coordinationCommandLine	string	De opdrachtregel die moet worden uitgevoerd op alle rekenknooppunten, zodat deze kunnen worden gecoördineerd wanneer de primaire taakopdracht wordt uitgevoerd. Een typische coördinatieopdrachtregel start een achtergrondservice en controleert of de service gereed is voor het verwerken van berichten tussen knooppunten.
numberOfInstances	integer	Het aantal rekenknooppunten dat door de taak is vereist. Als u dit weglaat, is de standaardwaarde 1.

NameValuePair

Vertegenwoordigt een naam-waardepaar.

Name	Type	Description
name	string	De naam in het naam-waardepaar.
value	string	De waarde in het naam-waardepaar.

OutputFile

Een specificatie voor het uploaden van bestanden van een Azure Batch Compute-knooppunt naar een andere locatie nadat de Batch-service klaar is met het uitvoeren van het taakproces.

Name	Type	Description
destination	OutputFileDestination	De bestemming voor de uitvoerbestand(en).
filePattern	string	Een patroon dat aangeeft welke bestanden moeten worden geüpload. Zowel relatieve als absolute paden worden ondersteund. Relatieve paden zijn relatief ten opzichte van de werkmap Taak. De volgende jokertekens worden ondersteund: * komt overeen met 0 of meer tekens (bijvoorbeeld patroon abc* komt overeen met abc of abcdef), ** komt overeen met een map? komt overeen met één teken, [abc] komt overeen met één teken tussen de haken en [a-c] komt overeen met één teken in het bereik. Vierkante haken kunnen een negatie bevatten die overeenkomt met een willekeurig teken dat niet is opgegeven (bijvoorbeeld [!abc] komt overeen met een willekeurig teken, maar een, b of c). Als een bestandsnaam begint met '.' wordt deze standaard genegeerd, maar kan worden vergeleken door deze expliciet op te geven (bijvoorbeeld .gif komt niet overeen met .a.gif, maar ..gif wel). Een eenvoudig voorbeeld: ***.txt komt overeen met elk bestand dat niet begint in '.' en eindigt met .txt in de werkmap Taak of een submap. Als de bestandsnaam een jokerteken bevat, kan deze worden ontsnapt met behulp van vierkante haken (bijvoorbeeld abc[] komt overeen met een bestand met de naam abc). Houd er rekening mee dat zowel \ als / worden behandeld als mapscheidingstekens in Windows, maar alleen / zich op Linux bevindt. Omgevingsvariabelen (%var% in Windows of $var op Linux) worden uitgebreid voordat het patroon wordt toegepast.
uploadOptions	OutputFileUploadOptions	Aanvullende opties voor de uploadbewerking, waaronder onder welke voorwaarden de upload moet worden uitgevoerd.

OutputFileBlobContainerDestination

Hiermee geeft u een doel voor het uploaden van bestanden in een Azure Blob Storage-container op.

Name	Type	Description
containerUrl	string	De URL van de container in Azure Blob Storage waarnaar u het bestand(en) wilt uploaden. Als u geen beheerde identiteit gebruikt, moet de URL een SAS (Shared Access Signature) bevatten die schrijfmachtigingen verleent aan de container.
identityReference	ComputeNodeIdentityReference	De verwijzing naar de door de gebruiker toegewezen identiteit die moet worden gebruikt voor toegang tot Azure Blob Storage die is opgegeven door containerUrl De identiteit moet schrijftoegang hebben tot de Azure Blob Storage-container
path	string	De doel-blob of virtuele map in de Azure Storage-container. Als filePattern verwijst naar een specifiek bestand (dat wil gezegd geen jokertekens bevat), is het pad de naam van de blob waarnaar het bestand moet worden geüpload. Als filePattern een of meer jokertekens bevat (en dus mogelijk overeenkomt met meerdere bestanden), is het pad de naam van de virtuele blobmap (die is voorafgegaan aan elke blobnaam) waarnaar de bestanden moeten worden geüpload. Als u dit weglaat, worden bestanden geüpload naar de hoofdmap van de container met een blobnaam die overeenkomt met de bestandsnaam.
uploadHeaders	HttpHeader[]	Een lijst met naam-waardeparen voor headers die moeten worden gebruikt bij het uploaden van uitvoerbestanden Deze headers worden opgegeven bij het uploaden van bestanden naar Azure Storage. Officieel document over toegestane headers bij het uploaden van blobs: https://learn.microsoft.com/rest/api/storageservices/put-blob#request-headers-all-blob-types

OutputFileDestination

Het doel waarnaar een bestand moet worden geüpload.

Name	Type	Description
container	OutputFileBlobContainerDestination	Een locatie in Azure Blob Storage waarnaar bestanden worden geüpload.

OutputFileUploadCondition

De voorwaarden waaronder een taakuitvoerbestand of een set bestanden moet worden geüpload.

Name	Type	Description
taskcompletion	string	Upload het bestand(en) nadat het taakproces is afgesloten, ongeacht wat de afsluitcode was.
taskfailure	string	Upload het bestand(en) pas nadat het taakproces is afgesloten met een niet-nul-afsluitcode.
tasksuccess	string	Upload het bestand(en) pas nadat het taakproces is afgesloten met een afsluitcode van 0.

OutputFileUploadOptions

Details over een uploadbewerking voor een uitvoerbestand, waaronder onder welke voorwaarden de upload moet worden uitgevoerd.

Name	Type	Description
uploadCondition	OutputFileUploadCondition	De voorwaarden waaronder het taakuitvoerbestand of de set bestanden moet worden geüpload. De standaardwaarde is taakcompletion.

ResourceFile

Eén bestand of meerdere bestanden die moeten worden gedownload naar een rekenknooppunt.

Name	Type	Description
autoStorageContainerName	string	De naam van de opslagcontainer in het automatische opslagaccount. De eigenschappen autoStorageContainerName, storageContainerUrl en httpUrl sluiten elkaar wederzijds uit en een van deze moet worden opgegeven.
blobPrefix	string	Het blobvoorvoegsel dat moet worden gebruikt bij het downloaden van blobs uit een Azure Storage-container. Alleen de blobs waarvan de namen beginnen met het opgegeven voorvoegsel, worden gedownload. De eigenschap is alleen geldig wanneer autoStorageContainerName of storageContainerUrl wordt gebruikt. Dit voorvoegsel kan een gedeeltelijke bestandsnaam of een submap zijn. Als er geen voorvoegsel is opgegeven, worden alle bestanden in de container gedownload.
fileMode	string	Het kenmerk bestandsmachtigingsmodus in octale indeling. Deze eigenschap is alleen van toepassing op bestanden die worden gedownload naar Linux-rekenknooppunten. Deze wordt genegeerd als deze is opgegeven voor een resourceFile die wordt gedownload naar een Windows Compute-knooppunt. Als deze eigenschap niet is opgegeven voor een Linux-rekenknooppunt, wordt een standaardwaarde van 0770 toegepast op het bestand.
filePath	string	De locatie op het rekenknooppunt waarnaar u het bestand(en) wilt downloaden ten opzichte van de werkmap van de taak. Als de eigenschap httpUrl is opgegeven, is het filePath vereist en wordt het pad beschreven waarnaar het bestand wordt gedownload, inclusief de bestandsnaam. Als anders de eigenschap autoStorageContainerName of storageContainerUrl is opgegeven, is filePath optioneel en is het de map waarin de bestanden moeten worden gedownload. In het geval dat filePath wordt gebruikt als map, wordt elke mapstructuur die al aan de invoergegevens is gekoppeld, volledig bewaard en toegevoegd aan de opgegeven filePath-map. Het opgegeven relatieve pad kan niet worden uitgesplitsd uit de werkmap van de taak (bijvoorbeeld met '..').
httpUrl	string	De URL van het bestand dat u wilt downloaden. De eigenschappen autoStorageContainerName, storageContainerUrl en httpUrl sluiten elkaar wederzijds uit en een van deze moet worden opgegeven. Als de URL verwijst naar Azure Blob Storage, moet deze leesbaar zijn vanuit rekenknooppunten. Er zijn drie manieren om een dergelijke URL op te halen voor een blob in Azure Storage: neem een SAS (Shared Access Signature) die leesmachtigingen voor de blob verleent, gebruik een beheerde identiteit met leesmachtigingen of stel de ACL voor de blob of de container in om openbare toegang toe te staan.
identityReference	ComputeNodeIdentityReference	De verwijzing naar de door de gebruiker toegewezen identiteit die moet worden gebruikt voor toegang tot Azure Blob Storage die is opgegeven door storageContainerUrl of httpUrl De verwijzing naar een door de gebruiker toegewezen identiteit die is gekoppeld aan de Batch-pool die door een rekenknooppunt wordt gebruikt.
storageContainerUrl	string	De URL van de blobcontainer in Azure Blob Storage. De eigenschappen autoStorageContainerName, storageContainerUrl en httpUrl sluiten elkaar wederzijds uit en een van deze moet worden opgegeven. Deze URL moet kunnen worden gelezen en vermeld vanuit rekenknooppunten. Er zijn drie manieren om een dergelijke URL op te halen voor een container in Azure Storage: neem een SAS (Shared Access Signature) op die lees- en lijstmachtigingen voor de container verleent, gebruik een beheerde identiteit met lees- en lijstmachtigingen of stel de ACL voor de container in om openbare toegang toe te staan.

TaskConstraints

Uitvoeringsbeperkingen die van toepassing zijn op een taak.

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

TaskContainerExecutionInformation

Bevat informatie over de container die een taak uitvoert.

Name	Type	Description
containerId	string	De id van de container.
error	string	Gedetailleerde foutinformatie over de container. Dit is de gedetailleerde fouttekenreeks van de Docker-service, indien beschikbaar. Het is gelijk aan het foutveld dat wordt geretourneerd door 'docker inspect'.
state	string	De status van de container. Dit is de status van de container volgens de Docker-service. Het is gelijk aan het statusveld dat wordt geretourneerd door 'docker inspect'.

TaskContainerSettings

De containerinstellingen voor een taak.

Name	Type	Description
containerHostBatchBindMounts	ContainerHostBatchBindMountEntry[]	De paden die u aan de containertaak wilt koppelen. Als deze matrix null is of niet aanwezig is, koppelt de containertaak een volledig tijdelijk schijfstation in Windows (of AZ_BATCH_NODE_ROOT_DIR in Linux). Er worden geen gegevenspaden in de container geplaatst als deze matrix is ingesteld als leeg.
containerRunOptions	string	Aanvullende opties voor de opdracht container maken. Deze extra opties worden geleverd als argumenten voor de opdracht Docker create, naast de opties die worden beheerd door de Batch-service.
imageName	string	De installatiekopieën die moeten worden gebruikt om de container te maken waarin de taak wordt uitgevoerd. Dit is de volledige verwijzing naar de installatiekopie, zoals wordt opgegeven voor 'docker pull'. Als er geen tag wordt opgegeven als onderdeel van de naam van de installatiekopieën, wordt de tag ':latest' als standaard gebruikt.
registry	ContainerRegistry	Het privéregister dat de containerinstallatiekopieën bevat. Deze instelling kan worden weggelaten als deze al is opgegeven bij het maken van de pool.
workingDirectory	ContainerWorkingDirectory	De locatie van de werkmap containertaak. De standaardwaarde is taskWorkingDirectory.

TaskDependencies

Hiermee geeft u eventuele afhankelijkheden van een taak op. Elke taak die expliciet of binnen een afhankelijkheidsbereik is opgegeven, moet worden voltooid voordat de afhankelijke taak wordt gepland.

Name	Type	Description
taskIdRanges	TaskIdRange[]	De lijst met taak-id-bereiken waarvan deze taak afhankelijk is. Alle taken in alle bereiken moeten worden voltooid voordat de afhankelijke taak kan worden gepland.
taskIds	string[]	De lijst met taak-id's waarvan deze taak afhankelijk is. Alle taken in deze lijst moeten worden voltooid voordat de afhankelijke taak kan worden gepland. De verzameling taskIds is beperkt tot het totaal van 64000 tekens (de gecombineerde lengte van alle taak-id's). Als de verzameling taskIds de maximumlengte overschrijdt, mislukt de aanvraag Taak toevoegen met foutcode TaskDependencyListTooLong. In dit geval kunt u in plaats daarvan taak-id-bereiken gebruiken.

TaskExecutionInformation

Informatie over de uitvoering van een taak.

Name	Type	Description
containerInfo	TaskContainerExecutionInformation	Informatie over de container waaronder de taak wordt uitgevoerd. Deze eigenschap is alleen ingesteld als de taak wordt uitgevoerd in een containercontext.
endTime	string	Het tijdstip waarop de taak is voltooid. Deze eigenschap is alleen ingesteld als de taak de status Voltooid heeft.
exitCode	integer	De afsluitcode van het programma dat is opgegeven op de opdrachtregel Taak. Deze eigenschap is alleen ingesteld als de taak de status Voltooid heeft. Over het algemeen weerspiegelt de afsluitcode voor een proces de specifieke conventie die door de toepassingsontwikkelaar voor dat proces is geïmplementeerd. Als u de waarde van de afsluitcode gebruikt om beslissingen te nemen in uw code, moet u ervoor zorgen dat u de afsluitcodeconventie kent die wordt gebruikt door het toepassingsproces. Als de Batch-service echter de taak beëindigt (vanwege een time-out of door gebruikersbeëindiging via de API), ziet u mogelijk een door het besturingssysteem gedefinieerde afsluitcode.
failureInfo	TaskFailureInformation	Informatie over de taakfout, indien van toepassing. Deze eigenschap is alleen ingesteld als de taak de status Voltooid heeft en er een fout is opgetreden.
lastRequeueTime	string	Het meest recente tijdstip waarop de taak door de Batch-service opnieuw in de wachtrij is geplaatst als gevolg van een gebruikersaanvraag. Deze eigenschap is alleen ingesteld als requeueCount niet-nul is.
lastRetryTime	string	Het meest recente tijdstip waarop een nieuwe poging van de taak is gestart. Dit element is alleen aanwezig als de taak opnieuw is geprobeerd (bijvoorbeeld retryCount is niet-nul). Indien aanwezig, is dit meestal hetzelfde als startTime, maar kan dit anders zijn als de taak om andere redenen dan opnieuw is opgestart; Als het rekenknooppunt bijvoorbeeld opnieuw is opgestart tijdens een nieuwe poging, wordt de startTime bijgewerkt, maar de lastRetryTime niet.
requeueCount	integer	Het aantal keren dat de taak opnieuw in de wachtrij is geplaatst door de Batch-service als gevolg van een gebruikersaanvraag. Wanneer de gebruiker rekenknooppunten verwijdert uit een pool (door het formaat van de pool te wijzigen/verkleinen) of wanneer de taak wordt uitgeschakeld, kan de gebruiker opgeven dat taken op de rekenknooppunten opnieuw in de wachtrij worden geplaatst voor uitvoering. Met dit aantal wordt bijgehouden hoe vaak de taak om deze redenen opnieuw in de wachtrij is gezet.
result	TaskExecutionResult	Het resultaat van de taakuitvoering. Als de waarde 'mislukt' is, kunt u de details van de fout vinden in de eigenschap failureInfo.
retryCount	integer	Het aantal keren dat de taak opnieuw is geprobeerd door de Batch-service. Mislukte taaktoepassingen (niet-nul afsluitcode) worden opnieuw geprobeerd, fouten vooraf verwerken (de taak kan niet worden uitgevoerd) en fouten bij het uploaden van bestanden worden niet opnieuw geprobeerd. De Batch-service voert de taak opnieuw uit tot de limiet die is opgegeven door de beperkingen.
startTime	string	Het tijdstip waarop de taak wordt uitgevoerd. 'Wordt uitgevoerd' komt overeen met de status Actief, dus als de taak resourcebestanden of pakketten opgeeft, geeft de begintijd het tijdstip aan waarop de taak is begonnen met het downloaden of implementeren van deze. Als de taak opnieuw is gestart of opnieuw is geprobeerd, is dit het meest recente tijdstip waarop de taak is gestart. Deze eigenschap is alleen aanwezig voor taken die de status Actief of Voltooid hebben.

TaskExecutionResult

Het resultaat van taakuitvoering.

Name	Type	Description
failure	string	Er is een fout opgetreden tijdens de verwerking van de taak. De fout is mogelijk opgetreden voordat het taakproces werd gestart, terwijl het taakproces werd uitgevoerd of nadat het taakproces is afgesloten.
success	string	De taak is uitgevoerd.

TaskFailureInformation

Informatie over een taakfout.

Name	Type	Description
category	ErrorCategory	De categorie van de taakfout.
code	string	Een id voor de taakfout. Codes zijn invariant en zijn bedoeld om programmatisch te worden gebruikt.
details	NameValuePair[]	Een lijst met aanvullende details met betrekking tot de fout.
message	string	Een bericht met een beschrijving van de taakfout, die is bedoeld om te worden weergegeven in een gebruikersinterface.

TaskIdRange

Een reeks taak-id's waarvan een taak afhankelijk kan zijn. Alle taken met id's in het bereik moeten worden voltooid voordat de afhankelijke taak kan worden gepland.

Name	Type	Description
end	integer	De laatste taak-id in het bereik.
start	integer	De eerste taak-id in het bereik.

TaskState

De status van de taak.

Name	Type	Description
active	string	De taak wordt in de wachtrij geplaatst en kan worden uitgevoerd, maar is momenteel niet toegewezen aan een rekenknooppunt. Een taak voert deze status in wanneer deze wordt gemaakt, wanneer deze is ingeschakeld nadat deze is uitgeschakeld of wanneer deze wacht op een nieuwe poging na een mislukte uitvoering.
completed	string	De taak komt niet meer in aanmerking voor uitvoering, meestal omdat de taak is voltooid of de taak is voltooid en de limiet voor opnieuw proberen is uitgeput. Een taak wordt ook gemarkeerd als voltooid als er een fout is opgetreden bij het starten van de taak of wanneer de taak is beëindigd.
preparing	string	De taak is toegewezen aan een rekenknooppunt, maar wacht tot een vereiste taakvoorbereidingstaak is voltooid op het rekenknooppunt. Als de taakvoorbereidingstaak slaagt, wordt de taak verplaatst naar actief. Als de taakvoorbereidingstaak mislukt, keert de taak terug naar actief en komt deze in aanmerking voor toewijzing aan een ander rekenknooppunt.
running	string	De taak wordt uitgevoerd op een rekenknooppunt. Dit omvat voorbereiding op taakniveau, zoals het downloaden van resourcebestanden of het implementeren van pakketten die zijn opgegeven voor de taak. Dit betekent niet noodzakelijkerwijs dat de opdrachtregel Taak is gestart met uitvoeren.

TaskStatistics

Statistieken over resourcegebruik voor een taak.

Name	Type	Description
kernelCPUTime	string	De totale CPU-tijd van de kernelmodus (opgeteld voor alle kernen en alle rekenknooppunten) die door de taak worden verbruikt.
lastUpdateTime	string	Het tijdstip waarop de statistieken voor het laatst zijn bijgewerkt. Alle statistieken zijn beperkt tot het bereik tussen startTime en lastUpdateTime.
readIOGiB	number	Het totale aantal gibibytes dat is gelezen van schijf door de taak.
readIOps	integer	Het totale aantal schijfleesbewerkingen dat door de taak is uitgevoerd.
startTime	string	De begintijd van het tijdsbereik waarop de statistieken betrekking hebben.
url	string	De URL van de statistieken.
userCPUTime	string	De totale CPU-tijd van de gebruikersmodus (opgeteld voor alle kernen en alle rekenknooppunten) die door de taak worden verbruikt.
waitTime	string	De totale wachttijd van de taak. De wachttijd voor een taak wordt gedefinieerd als de verstreken tijd tussen het maken van de taak en het begin van de taakuitvoering. (Als de taak opnieuw wordt geprobeerd vanwege fouten, is de wachttijd de tijd tot de meest recente taakuitvoering.)
wallClockTime	string	De totale kloktijd van de wand van de taak. De kloktijd van de wand is de verstreken tijd vanaf het moment waarop de taak werd uitgevoerd op een rekenknooppunt tot aan het moment dat de statistieken zijn bijgewerkt (of tot de laatste keer dat de statistieken zijn bijgewerkt, als de taak daarna niet was voltooid). Als de taak opnieuw is geprobeerd, bevat dit de kloktijd van de wand van alle nieuwe pogingen van de taak.
writeIOGiB	number	Het totale aantal gibibytes dat door de taak naar de schijf is geschreven.
writeIOps	integer	Het totale aantal schrijfbewerkingen van de schijf dat door de taak is uitgevoerd.

UserIdentity

De definitie van de gebruikersidentiteit waaronder de taak wordt uitgevoerd.

Name	Type	Description
autoUser	AutoUserSpecification	De automatische gebruiker waaronder de taak wordt uitgevoerd. De eigenschappen userName en autoUser sluiten elkaar wederzijds uit; u moet één, maar niet beide opgeven.
username	string	De naam van de gebruikersidentiteit waaronder de taak wordt uitgevoerd. De eigenschappen userName en autoUser sluiten elkaar wederzijds uit; u moet één, maar niet beide opgeven.