Task - Add
Hiermee voegt u een taak toe aan de opgegeven taak.
De maximale levensduur van een taak vanaf aanvulling tot voltooiing is 180 dagen. Als een taak niet binnen 180 dagen na het toevoegen is voltooid, wordt deze beëindigd door de Batch-service en blijft deze in de toestand waarin deze zich op dat moment bevond.
POST {batchUrl}/jobs/{jobId}/tasks?api-version=2024-07-01.20.0
POST {batchUrl}/jobs/{jobId}/tasks?timeout={timeout}&api-version=2024-07-01.20.0
URI-parameters
Name | In | Vereist | Type | Description |
---|---|---|---|---|
batch
|
path | True |
string |
De basis-URL voor alle Azure Batch-serviceaanvragen. |
job
|
path | True |
string |
De id van de taak waaraan de taak moet worden toegevoegd. |
api-version
|
query | True |
string |
Client-API-versie. |
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. |
Aanvraagbody
Media Types: "application/json; odata=minimalmetadata"
Name | Vereist | Type | Description |
---|---|---|---|
commandLine | True |
string |
De opdrachtregel van de taak. |
id | True |
string |
Een tekenreeks die de taak uniek identificeert binnen de taak. |
affinityInfo |
Een localiteitshint die door de Batch-service kan worden gebruikt om een rekenknooppunt te selecteren waarop de nieuwe taak moet worden gestart. |
||
applicationPackageReferences |
Een lijst met pakketten die door de Batch-service worden geïmplementeerd in het rekenknooppunt voordat u de opdrachtregel uitvoert. |
||
authenticationTokenSettings |
De instellingen voor een verificatietoken dat de taak kan gebruiken om Batch-servicebewerkingen uit te voeren. |
||
constraints |
De uitvoeringsbeperkingen die van toepassing zijn op deze taak. |
||
containerSettings |
De instellingen voor de container waaronder de taak wordt uitgevoerd. |
||
dependsOn |
De taken waarop deze taak afhankelijk is. |
||
displayName |
string |
Een weergavenaam voor de taak. |
|
environmentSettings |
Een lijst met omgevingsvariabeleinstellingen voor de taak. |
||
exitConditions |
Hiermee geeft u op hoe de Batch-service moet reageren wanneer de taak is voltooid. |
||
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. |
||
outputFiles |
Een lijst met bestanden die de Batch-service vanaf het rekenknooppunt uploadt nadat de opdrachtregel is uitgevoerd. |
||
requiredSlots |
integer |
Het aantal planningssites dat de taak moet uitvoeren. |
|
resourceFiles |
Een lijst met bestanden die de Batch-service naar het rekenknooppunt downloadt voordat u de opdrachtregel uitvoert. |
||
userIdentity |
De gebruikersidentiteit waaronder de taak wordt uitgevoerd. |
Antwoorden
Name | Type | Description |
---|---|---|
201 Created |
De aanvraag voor de Batch-service is geslaagd. Kopteksten
|
|
Other Status Codes |
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
Add a basic task
Voorbeeldaanvraag
POST account.region.batch.azure.com/jobs/jobId/tasks?api-version=2024-07-01.20.0
{
"id": "task1",
"commandLine": "cmd /c echo task1"
}
Voorbeeldrespons
Add a container task with container data isolation
Voorbeeldaanvraag
POST account.region.batch.azure.com/jobs/jobId/tasks?api-version=2024-07-01.20.0
{
"id": "taskId",
"commandLine": "bash -c 'echo hello'",
"containerSettings": {
"imageName": "ubuntu",
"containerHostBatchBindMounts": [
{
"source": "Task",
"isReadOnly": true
}
]
},
"userIdentity": {
"autoUser": {
"scope": "task",
"elevationLevel": "nonadmin"
}
}
}
Voorbeeldrespons
Add a container task with container data isolation bad request duplicate sources
Voorbeeldaanvraag
POST account.region.batch.azure.com/jobs/jobId/tasks?api-version=2024-07-01.20.0
{
"id": "taskId",
"commandLine": "bash -c 'echo hello'",
"containerSettings": {
"imageName": "ubuntu",
"containerHostBatchBindMounts": [
{
"source": "Task",
"isReadOnly": true
},
{
"source": "Task",
"isReadOnly": true
}
]
},
"userIdentity": {
"autoUser": {
"scope": "task",
"elevationLevel": "nonadmin"
}
}
}
Voorbeeldrespons
Add a task with container settings
Voorbeeldaanvraag
POST account.region.batch.azure.com/jobs/jobId/tasks?api-version=2024-07-01.20.0
{
"id": "taskId",
"commandLine": "bash -c 'echo hello'",
"containerSettings": {
"imageName": "ubuntu",
"containerRunOptions": "--rm"
},
"userIdentity": {
"autoUser": {
"scope": "task",
"elevationLevel": "nonadmin"
}
}
}
Voorbeeldrespons
Add a task with exit conditions
Voorbeeldaanvraag
POST account.region.batch.azure.com/jobs/jobId/tasks?api-version=2024-07-01.20.0
{
"id": "taskId",
"commandLine": "cmd /c exit 3",
"exitConditions": {
"exitCodeRanges": [
{
"start": 2,
"end": 4,
"exitOptions": {
"jobAction": "terminate"
}
}
]
},
"userIdentity": {
"autoUser": {
"scope": "task",
"elevationLevel": "nonadmin"
}
}
}
Voorbeeldrespons
Add a task with extra slot requirement
Voorbeeldaanvraag
POST account.region.batch.azure.com/jobs/jobId/tasks?api-version=2024-07-01.20.0
{
"id": "task1",
"requiredSlots": 2,
"commandLine": "cmd /c echo task1"
}
Voorbeeldrespons
Definities
Name | Description |
---|---|
Access |
De Batch-resources waaraan het token toegang verleent. |
Affinity |
Een localiteitshint die door de Batch-service kan worden gebruikt om een rekenknooppunt te selecteren waarop een taak moet worden gestart. |
Application |
Een verwijzing naar een pakket dat moet worden geïmplementeerd op rekenknooppunten. |
Authentication |
De instellingen voor een verificatietoken dat de taak kan gebruiken om Batch-servicebewerkingen uit te voeren. |
Auto |
Het bereik voor de automatische gebruiker |
Auto |
Hiermee geeft u de parameters op voor de automatische gebruiker die een taak uitvoert in de Batch-service. |
Batch |
Er is een foutbericht ontvangen van de Azure Batch-service. |
Batch |
Een item met aanvullende informatie die is opgenomen in een Azure Batch-foutreactie. |
Compute |
De verwijzing naar een door de gebruiker toegewezen identiteit die is gekoppeld aan de Batch-pool die door een rekenknooppunt wordt gebruikt. |
Container |
De vermelding van het pad en de koppelingsmodus die u wilt koppelen aan de taakcontainer. |
Container |
De paden die worden gekoppeld aan de container van de containertaak. |
Container |
Een privécontainerregister. |
Container |
De locatie van de werkmap containertaak. |
Dependency |
Een actie die door de Batch-service wordt uitgevoerd op taken die afhankelijk zijn van deze taak. |
Elevation |
Het hoogteniveau van de gebruiker. |
Environment |
Een omgevingsvariabele die moet worden ingesteld voor een taakproces. |
Error |
Een foutbericht dat is ontvangen in een Azure Batch-foutreactie. |
Exit |
Hoe de Batch-service moet reageren als een taak wordt afgesloten met een bepaalde afsluitcode. |
Exit |
Een reeks afsluitcodes en hoe de Batch-service moet reageren op afsluitcodes binnen dat bereik. |
Exit |
Hiermee geeft u op hoe de Batch-service moet reageren wanneer de taak is voltooid. |
Exit |
Hiermee geeft u op hoe de Batch-service reageert op een bepaalde afsluitvoorwaarde. |
Http |
Een http-headernaam-waardepaar |
Job |
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'. |
Multi |
Instellingen die aangeven hoe een taak met meerdere exemplaren moet worden uitgevoerd. |
Output |
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. |
Output |
Hiermee geeft u een doel voor het uploaden van bestanden in een Azure Blob Storage-container op. |
Output |
Het doel waarnaar een bestand moet worden geüpload. |
Output |
De voorwaarden waaronder een taakuitvoerbestand of een set bestanden moet worden geüpload. |
Output |
Details over een uploadbewerking voor een uitvoerbestand, waaronder onder welke voorwaarden de upload moet worden uitgevoerd. |
Resource |
Eén bestand of meerdere bestanden die moeten worden gedownload naar een rekenknooppunt. |
Task |
Een Azure Batch-taak die moet worden toegevoegd. |
Task |
Uitvoeringsbeperkingen die van toepassing zijn op een taak. |
Task |
De containerinstellingen voor een taak. |
Task |
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. |
Task |
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. |
User |
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. |
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. |
version |
string |
De versie van de toepassing die moet worden geïmplementeerd. Als u dit weglaat, wordt de standaardversie geïmplementeerd. |
AuthenticationTokenSettings
De instellingen voor een verificatietoken dat de taak kan gebruiken om Batch-servicebewerkingen uit te voeren.
Name | Type | Description |
---|---|---|
access |
De Batch-resources waaraan het token toegang verleent. |
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 |
Het hoogteniveau van de automatische gebruiker. |
|
scope |
Het bereik voor de automatische gebruiker |
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 |
Een bericht met een beschrijving van de fout, bedoeld om te worden weergegeven in een gebruikersinterface. |
|
values |
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. |
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. |
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). |
source |
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 |
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. |
|
password |
string |
Het wachtwoord om u aan te melden bij de registerserver. |
registryServer |
string |
De register-URL. |
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. |
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 |
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 |
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 |
Hoe de Batch-service moet reageren als de taak mislukt met een afsluitvoorwaarde die niet wordt gedekt door een van de andere eigenschappen. |
|
exitCodeRanges |
Een lijst met afsluitcodebereiken voor taken en hoe de Batch-service hierop moet reageren. |
|
exitCodes |
Een lijst met afzonderlijke taakafsluitcodes en hoe de Batch-service erop moet reageren. |
|
fileUploadError |
Hoe de Batch-service moet reageren als er een bestandsuploadfout optreedt. |
|
preProcessingError |
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 |
Een actie die door de Batch-service wordt uitgevoerd op taken die afhankelijk zijn van deze taak. |
|
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'. |
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 |
Een lijst met bestanden die door de Batch-service worden gedownload voordat de opdrachtregel voor coördinatie wordt uitgevoerd. |
|
coordinationCommandLine |
string |
De opdrachtregel die moet worden uitgevoerd op alle rekenknooppunten, zodat deze kunnen worden gecoördineerd wanneer de primaire taakopdracht wordt uitgevoerd. |
numberOfInstances |
integer |
Het aantal rekenknooppunten dat door de taak is vereist. |
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 |
De bestemming voor de uitvoerbestand(en). |
|
filePattern |
string |
Een patroon dat aangeeft welke bestanden moeten worden geüpload. |
uploadOptions |
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. |
identityReference |
De verwijzing naar de door de gebruiker toegewezen identiteit die moet worden gebruikt voor toegang tot Azure Blob Storage die is opgegeven door containerUrl |
|
path |
string |
De doel-blob of virtuele map in de Azure Storage-container. |
uploadHeaders |
Een lijst met naam-waardeparen voor headers die moeten worden gebruikt bij het uploaden van uitvoerbestanden |
OutputFileDestination
Het doel waarnaar een bestand moet worden geüpload.
Name | Type | Description |
---|---|---|
container |
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 |
De voorwaarden waaronder het taakuitvoerbestand of de set bestanden moet worden geüpload. |
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. |
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. |
fileMode |
string |
Het kenmerk bestandsmachtigingsmodus in octale indeling. |
filePath |
string |
De locatie op het rekenknooppunt waarnaar u het bestand(en) wilt downloaden ten opzichte van de werkmap van de taak. |
httpUrl |
string |
De URL van het bestand dat u wilt downloaden. |
identityReference |
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 |
|
storageContainerUrl |
string |
De URL van de blobcontainer in Azure Blob Storage. |
TaskAddParameter
Een Azure Batch-taak die moet worden toegevoegd.
Name | Type | Description |
---|---|---|
affinityInfo |
Een localiteitshint die door de Batch-service kan worden gebruikt om een rekenknooppunt te selecteren waarop de nieuwe taak moet worden gestart. |
|
applicationPackageReferences |
Een lijst met pakketten die door de Batch-service worden geïmplementeerd in het rekenknooppunt voordat u de opdrachtregel uitvoert. |
|
authenticationTokenSettings |
De instellingen voor een verificatietoken dat de taak kan gebruiken om Batch-servicebewerkingen uit te voeren. |
|
commandLine |
string |
De opdrachtregel van de taak. |
constraints |
De uitvoeringsbeperkingen die van toepassing zijn op deze taak. |
|
containerSettings |
De instellingen voor de container waaronder de taak wordt uitgevoerd. |
|
dependsOn |
De taken waarop deze taak afhankelijk is. |
|
displayName |
string |
Een weergavenaam voor de taak. |
environmentSettings |
Een lijst met omgevingsvariabeleinstellingen voor de taak. |
|
exitConditions |
Hiermee geeft u op hoe de Batch-service moet reageren wanneer de taak is voltooid. |
|
id |
string |
Een tekenreeks die de taak uniek identificeert binnen de taak. |
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. |
|
outputFiles |
Een lijst met bestanden die de Batch-service vanaf het rekenknooppunt uploadt nadat de opdrachtregel is uitgevoerd. |
|
requiredSlots |
integer |
Het aantal planningssites dat de taak moet uitvoeren. |
resourceFiles |
Een lijst met bestanden die de Batch-service naar het rekenknooppunt downloadt voordat u de opdrachtregel uitvoert. |
|
userIdentity |
De gebruikersidentiteit waaronder de taak wordt uitgevoerd. |
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. |
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. |
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. |
TaskContainerSettings
De containerinstellingen voor een taak.
Name | Type | Description |
---|---|---|
containerHostBatchBindMounts |
De paden die u aan de containertaak wilt koppelen. |
|
containerRunOptions |
string |
Aanvullende opties voor de opdracht container maken. |
imageName |
string |
De installatiekopieën die moeten worden gebruikt om de container te maken waarin de taak wordt uitgevoerd. |
registry |
Het privéregister dat de containerinstallatiekopieën bevat. |
|
workingDirectory |
De locatie van de werkmap containertaak. |
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 |
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. |
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. |
UserIdentity
De definitie van de gebruikersidentiteit waaronder de taak wordt uitgevoerd.
Name | Type | Description |
---|---|---|
autoUser |
De automatische gebruiker waaronder de taak wordt uitgevoerd. |
|
username |
string |
De naam van de gebruikersidentiteit waaronder de taak wordt uitgevoerd. |