JobAddParameter interface
Een interface die JobAddParameter vertegenwoordigt.
Eigenschappen
| common |
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. |
| display |
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). |
| job |
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. |
| job |
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. |
| job |
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. |
| 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. |
| network |
De netwerkconfiguratie voor de taak. |
| on |
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 zijn: 'noAction', 'terminateJob' |
| on |
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 zijn: 'noAction', 'performExitOptionsJobAction' |
| pool |
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. |
| uses |
Of taken in de taak afhankelijkheden op elkaar kunnen definiëren. De standaardwaarde is onwaar. |
Eigenschapdetails
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
constraints
De uitvoeringsbeperkingen voor de taak.
constraints?: JobConstraintsWaarde van eigenschap
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?: stringWaarde 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: stringWaarde 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?: JobManagerTaskWaarde van eigenschap
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?: JobPreparationTaskWaarde van eigenschap
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?: JobReleaseTaskWaarde van eigenschap
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?: MetadataItem[]Waarde van eigenschap
networkConfiguration
De netwerkconfiguratie voor de taak.
networkConfiguration?: JobNetworkConfigurationWaarde van eigenschap
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 zijn: 'noAction', 'terminateJob'
onAllTasksComplete?: OnAllTasksCompleteWaarde van eigenschap
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 zijn: 'noAction', 'performExitOptionsJobAction'
onTaskFailure?: OnTaskFailureWaarde van eigenschap
poolInfo
De pool waarop de Batch-service de taken van de taak uitvoert.
poolInfo: PoolInformationWaarde van eigenschap
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?: numberWaarde van eigenschap
number
usesTaskDependencies
Of taken in de taak afhankelijkheden op elkaar kunnen definiëren. De standaardwaarde is onwaar.
usesTaskDependencies?: booleanWaarde van eigenschap
boolean