BatchTaskOutput interface

Pakket:

@azure-rest/batch

Batch voert taken opnieuw uit wanneer een herstelbewerking wordt geactiveerd op een knooppunt. Voorbeelden van herstelbewerkingen zijn (maar zijn niet beperkt tot) wanneer een beschadigd knooppunt opnieuw wordt opgestart of een rekenknooppunt is verdwenen vanwege een hostfout. Nieuwe pogingen vanwege herstelbewerkingen zijn onafhankelijk van en worden niet meegeteld voor maxTaskRetryCount. Zelfs als maxTaskRetryCount 0 is, kan er een interne nieuwe poging worden uitgevoerd vanwege een herstelbewerking. Daarom moeten alle taken idempotent zijn. Dit betekent dat taken moeten worden onderbroken en opnieuw moeten worden gestart zonder beschadiging of dubbele gegevens te veroorzaken. De aanbevolen procedure voor langlopende taken is om een vorm van controlepunten te gebruiken.

Eigenschappen

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. 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	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	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	De uitvoeringsbeperkingen die van toepassing zijn op deze taak.
containerSettings	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	De aanmaaktijd van de taak.
dependsOn	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	Een weergavenaam voor de taak. De weergavenaam hoeft niet uniek te zijn en mag unicode-tekens bevatten tot een maximale lengte van 1024.
environmentSettings	Een lijst met omgevingsvariabeleinstellingen voor de taak.
eTag	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.
executionInfo	Informatie over de uitvoering van de taak.
exitConditions	Hoe de Batch-service moet reageren wanneer de taak is voltooid.
id	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	De laatste wijzigingstijd van 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.
nodeInfo	Informatie over het rekenknooppunt waarop de taak is uitgevoerd.
outputFiles	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	De vorige status van de taak. Deze eigenschap is niet ingesteld als de taak de oorspronkelijke actieve status heeft. Mogelijke waarden: "actief", "prepare", "running", "completed"
previousStateTransitionTime	Het tijdstip waarop de taak de vorige status heeft ingevoerd. Deze eigenschap is niet ingesteld als de taak de oorspronkelijke actieve status heeft.
requiredSlots	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	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	De huidige status van de taak. Mogelijke waarden: "actief", "prepare", "running", "completed"
stateTransitionTime	Het tijdstip waarop de taak de huidige status heeft ingevoerd.
stats	Statistieken over resourcegebruik voor de taak.
url	De URL van de taak.
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.

Eigenschapdetails

affinityInfo

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

affinityInfo?: BatchAffinityInfoOutput

Waarde van eigenschap

BatchAffinityInfoOutput

applicationPackageReferences

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.

applicationPackageReferences?: BatchApplicationPackageReferenceOutput[]

Waarde van eigenschap

BatchApplicationPackageReferenceOutput[]

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.

authenticationTokenSettings?: AuthenticationTokenSettingsOutput

Waarde van eigenschap

AuthenticationTokenSettingsOutput

commandLine

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

commandLine: string

Waarde van eigenschap

string

constraints

De uitvoeringsbeperkingen die van toepassing zijn op deze taak.

constraints?: BatchTaskConstraintsOutput

Waarde van eigenschap

BatchTaskConstraintsOutput

containerSettings

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.

containerSettings?: BatchTaskContainerSettingsOutput

Waarde van eigenschap

BatchTaskContainerSettingsOutput

creationTime

De aanmaaktijd van de taak.

creationTime: string

Waarde van eigenschap

string

dependsOn

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.

dependsOn?: BatchTaskDependenciesOutput

Waarde van eigenschap

BatchTaskDependenciesOutput

displayName

Een weergavenaam voor de taak. De weergavenaam hoeft niet uniek te zijn en mag unicode-tekens bevatten tot een maximale lengte van 1024.

displayName?: string

Waarde van eigenschap

string

environmentSettings

Een lijst met omgevingsvariabeleinstellingen voor de taak.

environmentSettings?: EnvironmentSettingOutput[]

Waarde van eigenschap

EnvironmentSettingOutput[]

eTag

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.

eTag: string

Waarde van eigenschap

string

executionInfo

Informatie over de uitvoering van de taak.

executionInfo?: BatchTaskExecutionInfoOutput

Waarde van eigenschap

BatchTaskExecutionInfoOutput

exitConditions

Hoe de Batch-service moet reageren wanneer de taak is voltooid.

exitConditions?: ExitConditionsOutput

Waarde van eigenschap

ExitConditionsOutput

id

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.

id: string

Waarde van eigenschap

string

lastModified

De laatste wijzigingstijd van de taak.

lastModified: string

Waarde van eigenschap

string

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.

multiInstanceSettings?: MultiInstanceSettingsOutput

Waarde van eigenschap

MultiInstanceSettingsOutput

nodeInfo

Informatie over het rekenknooppunt waarop de taak is uitgevoerd.

nodeInfo?: BatchNodeInfoOutput

Waarde van eigenschap

BatchNodeInfoOutput

outputFiles

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.

outputFiles?: OutputFileOutput[]

Waarde van eigenschap

OutputFileOutput[]

previousState

De vorige status van de taak. Deze eigenschap is niet ingesteld als de taak de oorspronkelijke actieve status heeft.

Mogelijke waarden: "actief", "prepare", "running", "completed"

previousState?: string

Waarde van eigenschap

string

previousStateTransitionTime

Het tijdstip waarop de taak de vorige status heeft ingevoerd. Deze eigenschap is niet ingesteld als de taak de oorspronkelijke actieve status heeft.

previousStateTransitionTime?: string

Waarde van eigenschap

string

requiredSlots

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.

requiredSlots?: number

Waarde van eigenschap

number

resourceFiles

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.

resourceFiles?: ResourceFileOutput[]

Waarde van eigenschap

ResourceFileOutput[]

state

De huidige status van de taak.

Mogelijke waarden: "actief", "prepare", "running", "completed"

state: string

Waarde van eigenschap

string

stateTransitionTime

Het tijdstip waarop de taak de huidige status heeft ingevoerd.

stateTransitionTime: string

Waarde van eigenschap

string

stats

Statistieken over resourcegebruik voor de taak.

stats?: BatchTaskStatisticsOutput

Waarde van eigenschap

BatchTaskStatisticsOutput

url

De URL van de taak.

url: string

Waarde van eigenschap

string

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.

userIdentity?: UserIdentityOutput

Waarde van eigenschap

UserIdentityOutput