BatchClient class

new BatchClient(endpointParam: string, credential: TokenCredential | AzureNamedKeyCredential, options?: BatchClientOptionalParams)

Parameters

De Batch-service ondersteunt twee manieren om het werk dat als onderdeel van een Job wordt uitgevoerd te controleren. In de eerste benadering specificeert de gebruiker een Taakbeheertaak. De Batch-service start deze taak wanneer hij klaar is om de taak te starten. De Taakbeheer-taak beheert alle andere taken die onder deze taak draaien, door gebruik te maken van de Taak-API's. In de tweede benadering bestuurt de gebruiker direct de uitvoering van taken onder een actieve taak, door gebruik te maken van de Taak-API's. Let ook op: bij het benoemen van banen moet je gevoelige informatie vermijden zoals gebruikersnamen of geheime projectnamen. Deze informatie kan voorkomen in telemetrielogboeken die toegankelijk zijn voor Microsoft Ondersteuning-ingenieurs.

function createJob(job: BatchJobCreateOptions, options?: CreateJobOptionalParams): Promise<void>

Parameters

Retouren

Maakt een taakschema aan voor het opgegeven account.

function createJobSchedule(jobSchedule: BatchJobScheduleCreateOptions, options?: CreateJobScheduleOptionalParams): Promise<void>

Parameters

Retouren

Je kunt een gebruikersaccount alleen toevoegen aan een Compute Node als deze in de idle of running state is. Voordat je op afstand kunt inloggen op een Compute Node, moet je toegangspoorten configureren voor SSH en RDP. Zie https://dotnet.territoriali.olinfo.it/azure/batch/pool-endpoint-configuration voor meer informatie

function createNodeUser(poolId: string, nodeId: string, user: BatchNodeUserCreateOptions, options?: CreateNodeUserOptionalParams): Promise<void>

Parameters

Retouren

Vermijd bij het benoemen van groepen gevoelige informatie, zoals gebruikersnamen of geheime projectnamen. Deze informatie kan voorkomen in telemetrielogboeken die toegankelijk zijn voor Microsoft Ondersteuning-ingenieurs.

function createPool(pool: BatchPoolCreateOptions, options?: CreatePoolOptionalParams): Promise<void>

Parameters

Retouren

De maximale levensduur van een taak van optelling tot voltooiing is 180 dagen. Als een taak niet binnen 180 dagen na toevoeging is voltooid, wordt deze door de batchservice beëindigd en blijft hij in de staat waarin hij zich op dat moment bevond.

function createTask(jobId: string, task: BatchTaskCreateOptions, options?: CreateTaskOptionalParams): Promise<void>

Parameters

Retouren

Let op dat elke taak een unieke ID moet hebben. De batchservice kan de resultaten voor elke taak niet in dezelfde volgorde teruggeven als wanneer de taken in dit verzoek zijn ingediend. Als de server uitvalt of de verbinding wordt gesloten tijdens het verzoek, kan het verzoek gedeeltelijk of volledig zijn verwerkt, of helemaal niet. In zulke gevallen dient de gebruiker het verzoek opnieuw te sturen. Let op: het is aan de gebruiker om fouten correct te behandelen bij het opnieuw uitsturen van een verzoek. Je moet bijvoorbeeld dezelfde Taak-ID's gebruiken tijdens een herpoging, zodat als de vorige operatie slaagde, de herpoging niet onverwacht extra taken aanmaakt. Als het antwoord taken bevat die niet zijn toegevoegd, kan een client het verzoek opnieuw proberen. Bij een herhaling is het het meest efficiënt om alleen taken opnieuw in te dienen die niet zijn toegevoegd, en taken die bij de eerste poging succesvol zijn toegevoegd, weg te laten. De maximale levensduur van een taak van optelling tot voltooiing is 180 dagen. Als een taak niet binnen 180 dagen na toevoeging is voltooid, wordt deze door de batchservice beëindigd en blijft hij in de staat waarin hij zich op dat moment bevond.

function createTaskCollection(jobId: string, taskCollection: BatchTaskGroup, options?: CreateTaskCollectionOptionalParams): Promise<BatchCreateTaskCollectionResult>

Parameters

Retouren

U kunt de toewijzing van een rekenknooppunt alleen ongedaan maken als het een niet-actieve of actieve status heeft.

function deallocateNode(poolId: string, nodeId: string, options?: DeallocateNodeOptionalParams): PollerLike<OperationState<void>, void>

Parameters

Retouren

Het verwijderen van een taak verwijdert ook alle taken die deel uitmaken van die taak, evenals alle taakstatistieken. Dit overschrijft ook de retentieperiode voor taakgegevens; dat wil zeggen, als de Job taken bevat die nog steeds op Compute Nodes worden bewaard, verwijdert de Batch-services de werkmappen van die Tasks en al hun inhoud. Wanneer een Verwijder-taakverzoek wordt ontvangen, zet de Batch-service de Taak op de verwijderingsstatus. Alle updatebewerkingen op een taak die in verwijderingstoestand is, falen met statuscode 409 (Conflict), met aanvullende informatie die aangeeft dat de taak wordt verwijderd.

function deleteJob(jobId: string, options?: DeleteJobOptionalParams): PollerLike<OperationState<void>, void>

Parameters

Retouren

Wanneer u een taakplanning verwijdert, worden ook alle taken en taken onder die planning verwijderd. Wanneer taken worden verwijderd, worden alle bestanden in hun werkmappen op de rekenknooppunten ook verwijderd (de bewaarperiode wordt genegeerd). De taakplanningsstatistieken zijn niet meer toegankelijk zodra de taakplanning is verwijderd, hoewel ze nog steeds worden meegeteld bij de levensduur van het account.

function deleteJobSchedule(jobScheduleId: string, options?: DeleteJobScheduleOptionalParams): PollerLike<OperationState<void>, void>

Parameters

Retouren

Hiermee verwijdert u het opgegeven bestand uit het rekenknooppunt.

function deleteNodeFile(poolId: string, nodeId: string, filePath: string, options?: DeleteNodeFileOptionalParams): Promise<void>

Parameters

Retouren

U kunt een gebruikersaccount alleen verwijderen naar een rekenknooppunt wanneer het inactief of actief is. Voordat je op afstand kunt inloggen op een Compute Node, moet je toegangspoorten configureren voor SSH en RDP. Zie https://dotnet.territoriali.olinfo.it/azure/batch/pool-endpoint-configuration voor meer informatie

function deleteNodeUser(poolId: string, nodeId: string, userName: string, options?: DeleteNodeUserOptionalParams): Promise<void>

Parameters

Retouren

Wanneer u aanvraagt dat een pool wordt verwijderd, vinden de volgende acties plaats: de poolstatus is ingesteld op verwijderen; eventuele lopende groottebewerkingen in de pool worden gestopt; de Batch-service begint de grootte van de pool te wijzigen in nul rekenknooppunten; alle taken die op bestaande rekenknooppunten worden uitgevoerd, worden beëindigd en opnieuw in de wachtrij gezet (alsof een bewerking voor het wijzigen van de grootte van de pool is aangevraagd met de standaardoptie voor opnieuw weergeven); ten slotte wordt de pool uit het systeem verwijderd. Omdat taken opnieuw worden uitgevoerd, kan de gebruiker deze taken opnieuw uitvoeren door de taak bij te werken om een andere pool te bereiken. De taken kunnen vervolgens worden uitgevoerd op de nieuwe pool. Als u het requeuegedrag wilt overschrijven, moet u het formaat van de pool expliciet aanroepen om de pool te verkleinen tot nul voordat u de pool verwijdert. Als u een Update-, Patch- of Delete-API aanroept in een pool met de status Verwijderen, mislukt deze met HTTP-statuscode 409 met foutcode PoolBeingDeleted.

function deletePool(poolId: string, options?: DeletePoolOptionalParams): PollerLike<OperationState<void>, void>

Parameters

Retouren

Wanneer een taak wordt verwijderd, worden alle bestanden in de map op het rekenknooppunt waarop deze is uitgevoerd ook verwijderd (ongeacht de bewaartijd). Voor taken met meerdere exemplaren wordt de verwijdertaak synchroon toegepast op de primaire taak; subtaken en hun bestanden worden vervolgens asynchroon op de achtergrond verwijderd.

function deleteTask(jobId: string, taskId: string, options?: DeleteTaskOptionalParams): Promise<void>

Parameters

Retouren

Hiermee verwijdert u het opgegeven taakbestand uit het rekenknooppunt waar de taak is uitgevoerd.

function deleteTaskFile(jobId: string, taskId: string, filePath: string, options?: DeleteTaskFileOptionalParams): Promise<void>

Parameters

Retouren

De Batch Service verplaatst de Job onmiddellijk naar de uitschakelende staat. Batch gebruikt vervolgens de disableTasks-parameter om te bepalen wat er moet gebeuren met de momenteel draaiende taken van de taak. De Job blijft in de deactiveringstoestand totdat de uitschakelingsoperatie is voltooid en alle taken zijn afgehandeld volgens de disableTasks-optie; de baan verplaatst zich vervolgens naar de toestand van een ongeschiktheid. Er worden geen nieuwe taken gestart onder de Job totdat deze weer actief wordt. Als je probeert een taak uit te schakelen die in een andere staat is dan actief, uitgeschakeld of uitgeschakeld, mislukt het verzoek met statuscode 409.

function disableJob(jobId: string, disableOptions: BatchJobDisableOptions, options?: DisableJobOptionalParams): PollerLike<OperationState<void>, void>

Parameters

Retouren

Er worden geen nieuwe taken gemaakt totdat de taakplanning opnieuw is ingeschakeld.

function disableJobSchedule(jobScheduleId: string, options?: DisableJobScheduleOptionalParams): Promise<void>

Parameters

Retouren

Je kunt taakplanning op een rekenknoop alleen uitschakelen als de huidige planningsstatus is ingeschakeld.

function disableNodeScheduling(poolId: string, nodeId: string, options?: DisableNodeSchedulingOptionalParams): Promise<void>

Parameters

Retouren

Hiermee schakelt u automatisch schalen voor een pool uit.

function disablePoolAutoScale(poolId: string, options?: DisablePoolAutoScaleOptionalParams): Promise<void>

Parameters

Retouren

Wanneer je deze API aanroept, zet de Batch-service een uitgeschakelde taak in de ingeschakelde status. Nadat deze operatie is voltooid, gaat de Taak over naar de actieve staat en wordt het plannen van nieuwe taken onder de Taak hervat. De Batch-service staat niet toe dat een Taak langer dan 180 dagen actief blijft. Dus als je een taak inschakelt met actieve taken die meer dan 180 dagen geleden zijn toegevoegd, zullen die taken niet draaien.

function enableJob(jobId: string, options?: EnableJobOptionalParams): PollerLike<OperationState<void>, void>

Parameters

Retouren

Hiermee schakelt u een taakplanning in.

function enableJobSchedule(jobScheduleId: string, options?: EnableJobScheduleOptionalParams): Promise<void>

Parameters

Retouren

Je kunt taakplanning op een Compute Node alleen inschakelen als de huidige planningsstatus is uitgeschakeld

function enableNodeScheduling(poolId: string, nodeId: string, options?: EnableNodeSchedulingOptionalParams): Promise<void>

Parameters

Retouren

U kunt automatisch schalen voor een pool niet inschakelen als er een bewerking voor het wijzigen van de grootte van de pool wordt uitgevoerd. Als automatisch schalen van de pool momenteel is uitgeschakeld, moet u een geldige formule voor automatische schaalaanpassing opgeven als onderdeel van de aanvraag. Als automatisch schalen van de pool al is ingeschakeld, kunt u een nieuwe formule voor automatische schaalaanpassing en/of een nieuw evaluatie-interval opgeven. U kunt deze API niet meer dan één keer per 30 seconden aanroepen voor dezelfde pool.

function enablePoolAutoScale(poolId: string, enableAutoScaleOptions: BatchPoolEnableAutoScaleOptions, options?: EnablePoolAutoScaleOptionalParams): Promise<void>

Parameters

Retouren

Deze API is voornamelijk bedoeld voor het valideren van een formule voor automatisch schalen, omdat het resultaat eenvoudigweg wordt geretourneerd zonder de formule toe te passen op de pool. De pool moet automatisch schalen hebben ingeschakeld om een formule te kunnen evalueren.

function evaluatePoolAutoScale(poolId: string, evaluateAutoScaleOptions: BatchPoolEvaluateAutoScaleOptions, options?: EvaluatePoolAutoScaleOptionalParams): Promise<AutoScaleRun>

Parameters

Retouren

Deze bewerking levert alleen applicaties en versies terug die beschikbaar zijn voor gebruik op rekenknooppunten; dat wil zeggen, die gebruikt kan worden in een Package-referentie. Voor beheerdersinformatie over applicaties en versies die nog niet beschikbaar zijn voor Compute Nodes, gebruik het Azure-portaal of de Azure Resource Manager API.

function getApplication(applicationId: string, options?: GetApplicationOptionalParams): Promise<BatchApplication>

Parameters

Retouren

Krijgt informatie over de opgegeven functie.

function getJob(jobId: string, options?: GetJobOptionalParams): Promise<BatchJob>

Parameters

Retouren

Krijgt informatie over het opgegeven werkrooster.

function getJobSchedule(jobScheduleId: string, options?: GetJobScheduleOptionalParams): Promise<BatchJobSchedule>

Parameters

Retouren

Taakaantallen bieden een telling van de taken per actieve, actieve of voltooide taakstatus en een aantal taken dat is geslaagd of mislukt. Taken in de voorbereidingsstatus worden meegeteld als actief. Houd er rekening mee dat de geretourneerde getallen mogelijk niet altijd up-to-date zijn. Als u exact aantal taken nodig hebt, gebruikt u een lijstquery.

function getJobTaskCounts(jobId: string, options?: GetJobTaskCountsOptionalParams): Promise<BatchTaskCountsResult>

Parameters

Retouren

Hiermee wordt informatie opgehaald over het opgegeven rekenknooppunt.

function getNode(poolId: string, nodeId: string, options?: GetNodeOptionalParams): Promise<BatchNode>

Parameters

Retouren

Krijgt informatie over de gespecificeerde Compute Node Extension.

function getNodeExtension(poolId: string, nodeId: string, extensionName: string, options?: GetNodeExtensionOptionalParams): Promise<BatchNodeVMExtension>

Parameters

Retouren

Geeft de inhoud van het opgegeven Compute Node-bestand terug.

function getNodeFile(poolId: string, nodeId: string, filePath: string, options?: GetNodeFileOptionalParams): Promise<Uint8Array>

Parameters

Retouren

Hiermee haalt u de eigenschappen van het opgegeven rekenknooppuntbestand op.

function getNodeFileProperties(poolId: string, nodeId: string, filePath: string, options?: GetNodeFilePropertiesOptionalParams): Promise<BatchNodeFile>

Parameters

Retouren

Voordat je op afstand kunt inloggen op een Compute Node met de remote login-instellingen, moet je een gebruikersaccount aanmaken op de Compute Node en toegangspoorten configureren voor SSH en RDP. Zie https://dotnet.territoriali.olinfo.it/azure/batch/pool-endpoint-configuration voor meer informatie

function getNodeRemoteLoginSettings(poolId: string, nodeId: string, options?: GetNodeRemoteLoginSettingsOptionalParams): Promise<BatchNodeRemoteLoginSettings>

Parameters

Retouren

Hiermee wordt informatie opgehaald over de opgegeven pool.

function getPool(poolId: string, options?: GetPoolOptionalParams): Promise<BatchPool>

Parameters

Retouren

Voor multi-instance taken verwijzen informatie zoals affinityId, executionInfo en nodeInfo naar de primaire taak. Gebruik de list subtasks API om informatie over subtaken op te halen.

function getTask(jobId: string, taskId: string, options?: GetTaskOptionalParams): Promise<BatchTask>

Parameters

Retouren

Geeft de inhoud van het opgegeven Taakbestand terug.

function getTaskFile(jobId: string, taskId: string, filePath: string, options?: GetTaskFileOptionalParams): Promise<Uint8Array>

Parameters

Retouren

Hiermee haalt u de eigenschappen van het opgegeven taakbestand op.

function getTaskFileProperties(jobId: string, taskId: string, filePath: string, options?: GetTaskFilePropertiesOptionalParams): Promise<BatchNodeFile>

Parameters

Retouren

Controleert of het opgegeven werkrooster bestaat.

function jobScheduleExists(jobScheduleId: string, options?: JobScheduleExistsOptionalParams): Promise<boolean>

Parameters

Retouren

Deze bewerking levert alleen applicaties en versies terug die beschikbaar zijn voor gebruik op rekenknooppunten; dat wil zeggen, die gebruikt kan worden in een Package-referentie. Voor beheerdersinformatie over applicaties en versies die nog niet beschikbaar zijn voor Compute Nodes, gebruik het Azure-portaal of de Azure Resource Manager API.

function listApplications(options?: ListApplicationsOptionalParams): PagedAsyncIterableIterator<BatchApplication, BatchApplication[], PageSettings>

Parameters

Retouren

Deze API retourneert de taakstatus jobvoorbereiding en jobreleasetaak op alle rekenknooppunten waarop de taakvoorbereiding of jobreleasetaak is uitgevoerd. Dit omvat rekenknooppunten die sindsdien uit de pool zijn verwijderd. Als deze API wordt aangeroepen op een taak die geen jobvoorbereidingstaak of jobreleasetaak heeft, retourneert de Batch-service HTTP-statuscode 409 (Conflict) met een foutcode van JobPreparationTaskNotSpecified.

function listJobPreparationAndReleaseTaskStatus(jobId: string, options?: ListJobPreparationAndReleaseTaskStatusOptionalParams): PagedAsyncIterableIterator<BatchJobPreparationAndReleaseTaskStatus, BatchJobPreparationAndReleaseTaskStatus[], PageSettings>

Parameters

Retouren

Geeft alle banen in het opgegeven account weer op.

function listJobs(options?: ListJobsOptionalParams): PagedAsyncIterableIterator<BatchJob, BatchJob[], PageSettings>

Parameters

Retouren

Geeft alle taakschema's in het opgegeven account weer op.

function listJobSchedules(options?: ListJobSchedulesOptionalParams): PagedAsyncIterableIterator<BatchJobSchedule, BatchJobSchedule[], PageSettings>

Parameters

Retouren

Geeft een lijst van de Jobs die zijn aangemaakt onder het gespecificeerde Job Schedule.

function listJobsFromSchedule(jobScheduleId: string, options?: ListJobsFromScheduleOptionalParams): PagedAsyncIterableIterator<BatchJob, BatchJob[], PageSettings>

Parameters

Retouren

Geeft een lijst van de extensies van de Compute Nodes in de opgegeven pool.

function listNodeExtensions(poolId: string, nodeId: string, options?: ListNodeExtensionsOptionalParams): PagedAsyncIterableIterator<BatchNodeVMExtension, BatchNodeVMExtension[], PageSettings>

Parameters

Retouren

Bevat alle bestanden in taakmappen op het opgegeven rekenknooppunt.

function listNodeFiles(poolId: string, nodeId: string, options?: ListNodeFilesOptionalParams): PagedAsyncIterableIterator<BatchNodeFile, BatchNodeFile[], PageSettings>

Parameters

Retouren

Geeft een lijst weer van de rekenknooppunten in de opgegeven pool.

function listNodes(poolId: string, options?: ListNodesOptionalParams): PagedAsyncIterableIterator<BatchNode, BatchNode[], PageSettings>

Parameters

Retouren

Hiermee haalt u het aantal rekenknooppunten in elke status op, gegroepeerd op pool. Houd er rekening mee dat de geretourneerde getallen mogelijk niet altijd up-to-date zijn. Als u exact aantal knooppunten nodig hebt, gebruikt u een lijstquery.

function listPoolNodeCounts(options?: ListPoolNodeCountsOptionalParams): PagedAsyncIterableIterator<BatchPoolNodeCounts, BatchPoolNodeCounts[], PageSettings>

Parameters

Retouren

Een lijst met alle pools in het opgegeven account.

function listPools(options?: ListPoolsOptionalParams): PagedAsyncIterableIterator<BatchPool, BatchPool[], PageSettings>

Parameters

Retouren

Als u geen $filter component met inbegrip van een poolId opgeeft, bevat het antwoord alle pools die in het account aanwezig zijn in het tijdsbereik van de geretourneerde aggregatie-intervallen. Als u geen $filter component opgeeft, inclusief een startTime of endTime, worden deze filters standaard ingesteld op de begin- en eindtijden van het laatste aggregatie-interval dat momenteel beschikbaar is; Dat wil gezegd, alleen het laatste aggregatie-interval wordt geretourneerd.

function listPoolUsageMetrics(options?: ListPoolUsageMetricsOptionalParams): PagedAsyncIterableIterator<BatchPoolUsageMetrics, BatchPoolUsageMetrics[], PageSettings>

Parameters

Retouren

Als de taak geen taak met meerdere exemplaren is, retourneert dit een lege verzameling.

function listSubTasks(jobId: string, taskId: string, options?: ListSubTasksOptionalParams): PagedAsyncIterableIterator<BatchSubtask, BatchSubtask[], PageSettings>

Parameters

Retouren

Een lijst met alle installatiekopieën van virtuele machines die worden ondersteund door de Azure Batch-service.

function listSupportedImages(options?: ListSupportedImagesOptionalParams): PagedAsyncIterableIterator<BatchSupportedImage, BatchSupportedImage[], PageSettings>

Parameters

Retouren

Geeft een lijst weer van de bestanden in de map van een taak op het rekenknooppunt.

function listTaskFiles(jobId: string, taskId: string, options?: ListTaskFilesOptionalParams): PagedAsyncIterableIterator<BatchNodeFile, BatchNodeFile[], PageSettings>

Parameters

Retouren

Voor multi-instance taken verwijzen informatie zoals affinityId, executionInfo en nodeInfo naar de primaire taak. Gebruik de list subtasks API om informatie over subtaken op te halen.

function listTasks(jobId: string, options?: ListTasksOptionalParams): PagedAsyncIterableIterator<BatchTask, BatchTask[], PageSettings>

Parameters

Retouren

Krijgt de basiseigenschappen van een Pool.

function poolExists(poolId: string, options?: PoolExistsOptionalParams): Promise<boolean>

Parameters

Retouren

Door opnieuw te activeren kan een taak opnieuw worden geprobeerd tot het maximumaantal nieuwe pogingen. De status van de taak wordt gewijzigd in actief. Omdat de taak niet langer de status Voltooid heeft, zijn eventuele eerdere afsluitcode of foutinformatie niet meer beschikbaar na opnieuw activeren. Telkens wanneer een taak opnieuw wordt geactiveerd, wordt het aantal nieuwe pogingen opnieuw ingesteld op 0. Opnieuw activeren mislukt voor taken die niet zijn voltooid of die eerder zijn voltooid (met een afsluitcode van 0). Bovendien mislukt het als de taak is voltooid (of wordt beëindigd of verwijderd).

function reactivateTask(jobId: string, taskId: string, options?: ReactivateTaskOptionalParams): Promise<void>

Parameters

Retouren

U kunt een rekenknooppunt alleen opnieuw opstarten als het een niet-actieve of actieve status heeft.

function rebootNode(poolId: string, nodeId: string, options?: RebootNodeOptionalParams): PollerLike<OperationState<void>, void>

Parameters

Retouren

U kunt het besturingssysteem alleen opnieuw installeren op een rekenknooppunt als het een niet-actieve of actieve status heeft. Deze API kan alleen worden aangeroepen op pools die zijn aangemaakt met de cloud service configuratie-eigenschap.

function reimageNode(poolId: string, nodeId: string, options?: ReimageNodeOptionalParams): PollerLike<OperationState<void>, void>

Parameters

Retouren

Deze bewerking kan alleen worden uitgevoerd wanneer de toewijzingsstatus van de pool stabiel is. Wanneer deze bewerking wordt uitgevoerd, verandert de toewijzingsstatus van constant in het wijzigen van de grootte. Elke aanvraag kan maximaal 100 knooppunten verwijderen.

function removeNodes(poolId: string, removeOptions: BatchNodeRemoveOptions, options?: RemoveNodesOptionalParams): PollerLike<OperationState<void>, void>

Parameters

Retouren

Dit vervangt volledig alle up-dateerbare eigenschappen van de Job. Als bijvoorbeeld de Job beperkingen heeft en als constraints niet met dit verzoek zijn gespecificeerd, zal de batchservice de bestaande constraints verwijderen.

function replaceJob(jobId: string, job: BatchJob, options?: ReplaceJobOptionalParams): Promise<void>

Parameters

Retouren

Dit vervangt volledig alle up-dateerbare eigenschappen van het Job Schedule. Als bijvoorbeeld de schedule-eigenschap niet bij dit verzoek is gespecificeerd, verwijdert de Batch-service de bestaande schedule. Wijzigingen in een taakschema hebben alleen invloed op taken die door het schema zijn aangemaakt nadat de update heeft plaatsgevonden; momenteel lopende banen zijn onaangetast.

function replaceJobSchedule(jobScheduleId: string, jobSchedule: BatchJobSchedule, options?: ReplaceJobScheduleOptionalParams): Promise<void>

Parameters

Retouren

Deze bewerking vervangt alle updateerbare eigenschappen van het Account. Als bijvoorbeeld het expiryTime-element niet wordt gespecificeerd, wordt de huidige waarde vervangen door de standaardwaarde en niet ongewijzigd gelaten. Je kunt een gebruikersaccount op een Compute Node alleen bijwerken als deze in de idle of running state is.

function replaceNodeUser(poolId: string, nodeId: string, userName: string, updateOptions: BatchNodeUserUpdateOptions, options?: ReplaceNodeUserOptionalParams): Promise<void>

Parameters

Retouren

Dit vervangt volledig alle up-dateerbare eigenschappen van de Pool. Als bijvoorbeeld de Pool een StartTask heeft gekoppeld en StartTask niet is gespecificeerd met dit verzoek, dan verwijdert de Batch-service de bestaande StartTask.

function replacePoolProperties(poolId: string, pool: BatchPoolReplaceOptions, options?: ReplacePoolPropertiesOptionalParams): Promise<void>

Parameters

Retouren

Werkt de eigenschappen van de opgegeven taak bij.

function replaceTask(jobId: string, taskId: string, task: BatchTask, options?: ReplaceTaskOptionalParams): Promise<void>

Parameters

Retouren

U kunt het formaat van een pool alleen wijzigen wanneer de toewijzingsstatus stabiel is. Als de grootte van de pool al is gewijzigd, mislukt de aanvraag met statuscode 409. Wanneer u het formaat van een pool wijzigt, verandert de toewijzingsstatus van de pool van gestage tot het wijzigen van de grootte. U kunt de grootte van pools die zijn geconfigureerd voor automatisch schalen niet wijzigen. Als u dit probeert te doen, retourneert de Batch-service een fout 409. Als u het formaat van een pool omlaag wijzigt, kiest de Batch-service welke rekenknooppunten u wilt verwijderen. Als u specifieke rekenknooppunten wilt verwijderen, verwijdert u in plaats daarvan de API voor rekenknooppunten met de pool.

function resizePool(poolId: string, resizeOptions: BatchPoolResizeOptions, options?: ResizePoolOptionalParams): PollerLike<OperationState<void>, void>

Parameters

Retouren

Je kunt een Compute Node alleen starten als deze is gedeald.

function startNode(poolId: string, nodeId: string, options?: StartNodeOptionalParams): PollerLike<OperationState<void>, void>

Parameters

Retouren

Dit herstelt de Pool niet naar de vorige staat vóór de wijziging: het stopt alleen verdere wijzigingen en de Pool behoudt zijn huidige toestand. Na het stoppen stabiliseert de Pool het aantal rekenknooppunten waarop het zich bevond toen de stopoperatie werd uitgevoerd. Tijdens de stopwerking verandert de poolallocatietoestand eerst in stoppen en daarna in stabiel. Een hergroottebewerking hoeft niet per se een expliciet verzoek om de grootte van de Pool te zijn; deze API kan ook worden gebruikt om de initiële grootte van de Pool te stoppen wanneer deze wordt aangemaakt.

function stopPoolResize(poolId: string, options?: StopPoolResizeOptionalParams): PollerLike<OperationState<void>, void>

Parameters

Retouren

Wanneer een verzoek om Beëindigen van een baan wordt ontvangen, zet de batchservice de taak in de beëindigende toestand. De Batch-service beëindigt vervolgens alle lopende taken die aan de taak zijn gekoppeld en voert alle benodigde taakvrijgavetaken uit. Daarna gaat de Job naar de voltooide staat. Als er taken in de actieve staat in de baan zijn, blijven die in de actieve staat. Zodra een taak is beëindigd, kunnen er geen nieuwe taken worden toegevoegd en worden eventuele resterende actieve taken niet meer ingepland.

function terminateJob(jobId: string, options?: TerminateJobOptionalParams): PollerLike<OperationState<void>, void>

Parameters

Retouren

Hiermee wordt een taakplanning beëindigd.

function terminateJobSchedule(jobScheduleId: string, options?: TerminateJobScheduleOptionalParams): PollerLike<OperationState<void>, void>

Parameters

Retouren

Wanneer de taak is beëindigd, wordt deze verplaatst naar de voltooide status. Voor taken met meerdere exemplaren wordt de beëindigingstaak synchroon toegepast op de primaire taak; subtaken worden vervolgens asynchroon op de achtergrond beëindigd.

function terminateTask(jobId: string, taskId: string, options?: TerminateTaskOptionalParams): Promise<void>

Parameters

Retouren

Dit vervangt alleen de Job-eigenschappen die in het verzoek zijn gespecificeerd. Als de Job bijvoorbeeld beperkingen heeft en een verzoek het constraints-element niet specificeert, dan behoudt de Job de bestaande beperkingen.

function updateJob(jobId: string, job: BatchJobUpdateOptions, options?: UpdateJobOptionalParams): Promise<void>

Parameters

Retouren

Dit vervangt alleen de taken van het takenschema die in het verzoek zijn gespecificeerd. Als bijvoorbeeld de schedule-eigenschap niet is gespecificeerd bij dit verzoek, dan behoudt de Batch-service de bestaande schedule. Wijzigingen in een taakschema hebben alleen invloed op taken die door het schema zijn aangemaakt nadat de update heeft plaatsgevonden; momenteel lopende banen zijn onaangetast.

function updateJobSchedule(jobScheduleId: string, jobSchedule: BatchJobScheduleUpdateOptions, options?: UpdateJobScheduleOptionalParams): Promise<void>

Parameters

Retouren

Dit vervangt alleen de Pool-eigenschappen die in het verzoek zijn gespecificeerd. Als bijvoorbeeld de Pool een StartTask heeft en een verzoek geen StartTask-element specificeert, dan behoudt de Pool de bestaande StartTask.

function updatePool(poolId: string, pool: BatchPoolUpdateOptions, options?: UpdatePoolOptionalParams): Promise<void>

Parameters

Retouren

Dit is bedoeld om Azure Batch-servicelogbestanden op geautomatiseerde wijze te verzamelen vanuit Compute Nodes als je een fout ervaart en wilt escaleren naar Azure-ondersteuning. De logboekbestanden van de Azure Batch-service moeten worden gedeeld met ondersteuning voor Azure om problemen met de Batch-service op te sporen.

function uploadNodeLogs(poolId: string, nodeId: string, uploadOptions: UploadBatchServiceLogsOptions, options?: UploadNodeLogsOptionalParams): Promise<UploadBatchServiceLogsResult>

Parameters

Retouren