BatchJobCreateOptions interface

Pakket:

@azure-rest/batch

Parameters voor het maken van een Azure Batch-taak.

Eigenschappen

allowTaskPreemption	Of taken in deze taak kunnen worden verschoven door andere taken met hoge prioriteit. (Deze eigenschap is niet standaard beschikbaar. Neem contact op met de ondersteuning voor meer informatie) Als de waarde is ingesteld op True, hebben andere taken met hoge prioriteit die naar het systeem worden verzonden, voorrang en kunnen taken van deze taak opnieuw in de wachtrij worden geplaatst. U kunt de allowTaskPreemption van een taak bijwerken nadat deze is gemaakt met behulp van de api voor de updatetaak.
commonEnvironmentSettings	De lijst met algemene omgevingsvariabeleinstellingen. Deze omgevingsvariabelen worden ingesteld voor alle taken in de taak (inclusief jobbeheer, jobvoorbereiding en jobreleasetaken). Afzonderlijke taken kunnen een omgevingsinstelling die hier is opgegeven overschrijven door dezelfde instellingsnaam met een andere waarde op te geven.
constraints	De uitvoeringsbeperkingen voor de taak.
displayName	De weergavenaam voor de taak. De weergavenaam hoeft niet uniek te zijn en mag unicode-tekens bevatten tot een maximale lengte van 1024.
id	Een tekenreeks waarmee de taak in het account uniek wordt geïdentificeerd. De id kan elke combinatie van alfanumerieke tekens bevatten, inclusief afbreekstreepjes en onderstrepingstekens, en mag niet meer dan 64 tekens bevatten. De id is niet hoofdlettergevoelig en niet hoofdlettergevoelig (u hebt mogelijk geen twee id's binnen een account die alleen per geval verschillen).
jobManagerTask	Details van een Job Manager-taak die moet worden gestart wanneer de taak wordt gestart. Als de taak geen Job Manager-taak opgeeft, moet de gebruiker expliciet taken toevoegen aan de taak. Als de taak wel een Job Manager-taak opgeeft, maakt de Batch-service de Job Manager-taak wanneer de taak wordt gemaakt en probeert de Job Manager-taak te plannen voordat andere taken in de taak worden gepland. Het typische doel van de Job Manager-taak is het beheren en/of bewaken van taakuitvoering, bijvoorbeeld door te bepalen welke extra taken moeten worden uitgevoerd, te bepalen wanneer het werk is voltooid, enzovoort. (Een Job Manager-taak is echter niet beperkt tot deze activiteiten- het is een volwaardige taak in het systeem en het uitvoeren van de acties die nodig zijn voor de taak.) Een Job Manager-taak kan bijvoorbeeld een bestand downloaden dat is opgegeven als parameter, de inhoud van dat bestand analyseren en aanvullende taken verzenden op basis van die inhoud.
jobPreparationTask	De jobvoorbereidingstaak. Als een taak een taakvoorbereidingstaak heeft, voert de Batch-service de jobvoorbereidingstaak uit op een knooppunt voordat u taken van die taak op dat rekenknooppunt start.
jobReleaseTask	De taak voor het vrijgeven van de taak. Een jobreleasetaak kan niet worden opgegeven zonder ook een taakvoorbereidingstaak voor de taak op te geven. De Batch-service voert de jobreleasetaak uit op de knooppunten waarop de jobvoorbereidingstaak is uitgevoerd. Het primaire doel van de jobreleasetaak is het ongedaan maken van wijzigingen in rekenknooppunten die door de jobvoorbereidingstaak zijn aangebracht. Voorbeelden van activiteiten zijn het verwijderen van lokale bestanden of het afsluiten van services die zijn gestart als onderdeel van jobvoorbereiding.
maxParallelTasks	Het maximum aantal taken dat parallel voor de taak kan worden uitgevoerd. (Deze eigenschap is niet standaard beschikbaar. Neem contact op met de ondersteuning voor meer informatie) De waarde van maxParallelTasks moet -1 of groter zijn dan 0, indien opgegeven. Als dit niet is opgegeven, is de standaardwaarde -1, wat betekent dat er geen limiet is voor het aantal taken dat tegelijk kan worden uitgevoerd. U kunt de maxParallelTasks van een taak bijwerken nadat deze is gemaakt met behulp van de api voor de updatetaak.
metadata	Een lijst met naam-waardeparen die zijn gekoppeld aan de taak als metagegevens. De Batch-service wijst geen betekenis toe aan metagegevens; deze is uitsluitend bedoeld voor het gebruik van gebruikerscode.
networkConfiguration	(Deze eigenschap is niet standaard beschikbaar. Neem contact op met de ondersteuning voor meer informatie) De netwerkconfiguratie voor de taak.
onAllTasksComplete	De actie die de Batch-service moet uitvoeren wanneer alle taken in de taak de status Voltooid hebben. Houd er rekening mee dat als een taak geen taken bevat, alle taken als voltooid worden beschouwd. Deze optie wordt daarom meestal gebruikt met een Job Manager-taak; Als u automatische beëindiging van taken zonder Job Manager wilt gebruiken, moet u in eerste instantie opAllTasksComplete instellen op noaction en de eigenschappen van de taak bijwerken zodat deze opAllTasksComplete zijn ingesteld om de taak te beëindigen zodra u klaar bent met het toevoegen van taken. De standaardwaarde is noaction. Mogelijke waarden: "noaction", "terminatejob"
onTaskFailure	De actie die de Batch-service moet uitvoeren wanneer een taak in de taak mislukt. Een taak wordt beschouwd als mislukt als er een failureInfo is. Er wordt een failureInfo ingesteld als de taak is voltooid met een afsluitcode die niet nul is voltooid nadat het aantal nieuwe pogingen is uitgeput of als er een fout is opgetreden bij het starten van de taak, bijvoorbeeld vanwege een fout bij het downloaden van een resourcebestand. De standaardwaarde is noaction. Mogelijke waarden: "noaction", "performexitoptionsjobaction"
poolInfo	De pool waarop de Batch-service de taken van de taak uitvoert.
priority	De prioriteit van de taak. Prioriteitswaarden kunnen variëren van -1000 tot 1000, waarbij -1000 de laagste prioriteit is en 1000 de hoogste prioriteit is. De standaardwaarde is 0.
usesTaskDependencies	Of taken in de taak afhankelijkheden op elkaar kunnen definiëren. De standaardwaarde is onwaar.

Eigenschapdetails

allowTaskPreemption

Of taken in deze taak kunnen worden verschoven door andere taken met hoge prioriteit. (Deze eigenschap is niet standaard beschikbaar. Neem contact op met de ondersteuning voor meer informatie) Als de waarde is ingesteld op True, hebben andere taken met hoge prioriteit die naar het systeem worden verzonden, voorrang en kunnen taken van deze taak opnieuw in de wachtrij worden geplaatst. U kunt de allowTaskPreemption van een taak bijwerken nadat deze is gemaakt met behulp van de api voor de updatetaak.

allowTaskPreemption?: boolean

Waarde van eigenschap

boolean

commonEnvironmentSettings

De lijst met algemene omgevingsvariabeleinstellingen. Deze omgevingsvariabelen worden ingesteld voor alle taken in de taak (inclusief jobbeheer, jobvoorbereiding en jobreleasetaken). Afzonderlijke taken kunnen een omgevingsinstelling die hier is opgegeven overschrijven door dezelfde instellingsnaam met een andere waarde op te geven.

commonEnvironmentSettings?: EnvironmentSetting[]

Waarde van eigenschap

EnvironmentSetting[]

constraints

De uitvoeringsbeperkingen voor de taak.

constraints?: BatchJobConstraints

Waarde van eigenschap

BatchJobConstraints

displayName

De 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

id

Een tekenreeks waarmee de taak in het account uniek wordt geïdentificeerd. De id kan elke combinatie van alfanumerieke tekens bevatten, inclusief afbreekstreepjes en onderstrepingstekens, en mag niet meer dan 64 tekens bevatten. De id is niet hoofdlettergevoelig en niet hoofdlettergevoelig (u hebt mogelijk geen twee id's binnen een account die alleen per geval verschillen).

id: string

Waarde van eigenschap

string

jobManagerTask

Details van een Job Manager-taak die moet worden gestart wanneer de taak wordt gestart. Als de taak geen Job Manager-taak opgeeft, moet de gebruiker expliciet taken toevoegen aan de taak. Als de taak wel een Job Manager-taak opgeeft, maakt de Batch-service de Job Manager-taak wanneer de taak wordt gemaakt en probeert de Job Manager-taak te plannen voordat andere taken in de taak worden gepland. Het typische doel van de Job Manager-taak is het beheren en/of bewaken van taakuitvoering, bijvoorbeeld door te bepalen welke extra taken moeten worden uitgevoerd, te bepalen wanneer het werk is voltooid, enzovoort. (Een Job Manager-taak is echter niet beperkt tot deze activiteiten- het is een volwaardige taak in het systeem en het uitvoeren van de acties die nodig zijn voor de taak.) Een Job Manager-taak kan bijvoorbeeld een bestand downloaden dat is opgegeven als parameter, de inhoud van dat bestand analyseren en aanvullende taken verzenden op basis van die inhoud.

jobManagerTask?: BatchJobManagerTask

Waarde van eigenschap

BatchJobManagerTask

jobPreparationTask

De jobvoorbereidingstaak. Als een taak een taakvoorbereidingstaak heeft, voert de Batch-service de jobvoorbereidingstaak uit op een knooppunt voordat u taken van die taak op dat rekenknooppunt start.

jobPreparationTask?: BatchJobPreparationTask

Waarde van eigenschap

BatchJobPreparationTask

jobReleaseTask

De taak voor het vrijgeven van de taak. Een jobreleasetaak kan niet worden opgegeven zonder ook een taakvoorbereidingstaak voor de taak op te geven. De Batch-service voert de jobreleasetaak uit op de knooppunten waarop de jobvoorbereidingstaak is uitgevoerd. Het primaire doel van de jobreleasetaak is het ongedaan maken van wijzigingen in rekenknooppunten die door de jobvoorbereidingstaak zijn aangebracht. Voorbeelden van activiteiten zijn het verwijderen van lokale bestanden of het afsluiten van services die zijn gestart als onderdeel van jobvoorbereiding.

jobReleaseTask?: BatchJobReleaseTask

Waarde van eigenschap

BatchJobReleaseTask

maxParallelTasks

Het maximum aantal taken dat parallel voor de taak kan worden uitgevoerd. (Deze eigenschap is niet standaard beschikbaar. Neem contact op met de ondersteuning voor meer informatie) De waarde van maxParallelTasks moet -1 of groter zijn dan 0, indien opgegeven. Als dit niet is opgegeven, is de standaardwaarde -1, wat betekent dat er geen limiet is voor het aantal taken dat tegelijk kan worden uitgevoerd. U kunt de maxParallelTasks van een taak bijwerken nadat deze is gemaakt met behulp van de api voor de updatetaak.

maxParallelTasks?: number

Waarde van eigenschap

number

metadata

Een lijst met naam-waardeparen die zijn gekoppeld aan de taak als metagegevens. De Batch-service wijst geen betekenis toe aan metagegevens; deze is uitsluitend bedoeld voor het gebruik van gebruikerscode.

metadata?: BatchMetadataItem[]

Waarde van eigenschap

BatchMetadataItem[]

networkConfiguration

(Deze eigenschap is niet standaard beschikbaar. Neem contact op met de ondersteuning voor meer informatie) De netwerkconfiguratie voor de taak.

networkConfiguration?: BatchJobNetworkConfiguration

Waarde van eigenschap

BatchJobNetworkConfiguration

onAllTasksComplete

De actie die de Batch-service moet uitvoeren wanneer alle taken in de taak de status Voltooid hebben. Houd er rekening mee dat als een taak geen taken bevat, alle taken als voltooid worden beschouwd. Deze optie wordt daarom meestal gebruikt met een Job Manager-taak; Als u automatische beëindiging van taken zonder Job Manager wilt gebruiken, moet u in eerste instantie opAllTasksComplete instellen op noaction en de eigenschappen van de taak bijwerken zodat deze opAllTasksComplete zijn ingesteld om de taak te beëindigen zodra u klaar bent met het toevoegen van taken. De standaardwaarde is noaction.

Mogelijke waarden: "noaction", "terminatejob"

onAllTasksComplete?: string

Waarde van eigenschap

string

onTaskFailure

De actie die de Batch-service moet uitvoeren wanneer een taak in de taak mislukt. Een taak wordt beschouwd als mislukt als er een failureInfo is. Er wordt een failureInfo ingesteld als de taak is voltooid met een afsluitcode die niet nul is voltooid nadat het aantal nieuwe pogingen is uitgeput of als er een fout is opgetreden bij het starten van de taak, bijvoorbeeld vanwege een fout bij het downloaden van een resourcebestand. De standaardwaarde is noaction.

Mogelijke waarden: "noaction", "performexitoptionsjobaction"

onTaskFailure?: string

Waarde van eigenschap

string

poolInfo

De pool waarop de Batch-service de taken van de taak uitvoert.

poolInfo: BatchPoolInfo

Waarde van eigenschap

BatchPoolInfo

priority

De prioriteit van de taak. Prioriteitswaarden kunnen variëren van -1000 tot 1000, waarbij -1000 de laagste prioriteit is en 1000 de hoogste prioriteit is. De standaardwaarde is 0.

priority?: number

Waarde van eigenschap

number

usesTaskDependencies

Of taken in de taak afhankelijkheden op elkaar kunnen definiëren. De standaardwaarde is onwaar.

usesTaskDependencies?: boolean

Waarde van eigenschap

boolean