BatchClient class

Klientklass för åtkomst till Azure Batch-tjänsten.

Metoder

createJob(BatchJobCreateOptions, CreateJobOptionalParams)

Batch-tjänsten stödjer två sätt att kontrollera arbetet som utförs som en del av ett jobb. I det första tillvägagångssättet specificerar användaren en Jobbhanteraruppgift. Batchtjänsten startar denna uppgift när den är redo att starta jobbet. Jobbhanterar-uppgiften styr alla andra uppgifter som körs under detta jobb genom att använda Task API:erna. I det andra tillvägagångssättet kontrollerar användaren direkt exekveringen av uppgifter under ett aktivt jobb, genom att använda Task API:erna. Observera också: när du namnger jobb, undvik att inkludera känslig information som användarnamn eller hemliga projektnamn. Denna information kan finnas i telemetriloggar som är tillgängliga för Microsoft Support-ingenjörer.

createJobSchedule(BatchJobScheduleCreateOptions, CreateJobScheduleOptionalParams)

Skapar ett jobbschema till det angivna kontot.

createNodeUser(string, string, BatchNodeUserCreateOptions, CreateNodeUserOptionalParams)

Du kan bara lägga till ett användarkonto i en beräkningsnod när den är i viloläge eller körningsläge. Innan du kan fjärrlogga in på en Compute-nod måste du konfigurera åtkomstportar för SSH och RDP. För mer information, se https://dotnet.territoriali.olinfo.it/azure/batch/pool-endpoint-configuration

createPool(BatchPoolCreateOptions, CreatePoolOptionalParams)

När du namnger pooler bör du undvika att inkludera känslig information, till exempel användarnamn eller hemliga projektnamn. Denna information kan finnas i telemetriloggar som är tillgängliga för Microsoft Support-ingenjörer.

createTask(string, BatchTaskCreateOptions, CreateTaskOptionalParams)

Den maximala livslängden för en uppgift från addition till slutförande är 180 dagar. Om en uppgift inte har slutförts inom 180 dagar efter att ha lagts till kommer den att avslutas av batchtjänsten och lämnas kvar i det tillstånd den var i vid den tidpunkten.

createTaskCollection(string, BatchTaskGroup, CreateTaskCollectionOptionalParams)

Observera att varje uppgift måste ha ett unikt ID. Batchtjänsten kanske inte returnerar resultaten för varje uppgift i samma ordning som uppgifterna skickades in i denna förfrågan. Om servern går ut på tidsgränsen eller anslutningen stängs under förfrågan kan begäran ha behandlats delvis eller helt, eller inte alls. I sådana fall bör användaren skicka ut förfrågan på nytt. Observera att det är upp till användaren att korrekt hantera fel vid omutfärdande av en förfrågan. Till exempel bör du använda samma Task ID:n under ett försök så att om föregående operation lyckades, skapar inte omförsöket extra Tasks oväntat. Om svaret innehåller några Tasks som inte lade till kan en klient försöka på nytt med begäran. Vid ett nytt försök är det mest effektivt att endast skicka in uppgifter som misslyckades med att lägga till och att utelämna uppgifter som lyckades läggas till vid första försöket. Den maximala livslängden för en uppgift från addition till slutförande är 180 dagar. Om en uppgift inte har slutförts inom 180 dagar efter att ha lagts till kommer den att avslutas av batchtjänsten och lämnas kvar i det tillstånd den var i vid den tidpunkten.

deallocateNode(string, string, DeallocateNodeOptionalParams)

Du kan bara frigöra en beräkningsnod om den är i ett inaktivt eller körningstillstånd.

deleteJob(string, DeleteJobOptionalParams)

Att ta bort ett jobb tar också bort alla uppgifter som ingår i det jobbet, samt all jobbstatistik. Detta åsidosätter också lagringstiden för uppgiftsdata; det vill säga, om jobbet innehåller uppgifter som fortfarande finns kvar på beräkningsnoder, raderar batchtjänsterna dessa uppgifters arbetskataloger och allt deras innehåll. När en begäran om borttagning av jobb tas emot sätter batchtjänsten jobbet till raderingstillståndet. Alla uppdateringsoperationer på ett jobb som är i raderingsläge kommer att misslyckas med statuskod 409 (Konflikt), med ytterligare information som indikerar att jobbet tas bort.

deleteJobSchedule(string, DeleteJobScheduleOptionalParams)

När du tar bort ett jobbschema tas även alla jobb och aktiviteter bort under det schemat. När Uppgifter tas bort tas även alla filer i deras arbetskataloger på beräkningsnoderna bort (kvarhållningsperioden ignoreras). Statistiken för jobbschemat är inte längre tillgänglig när jobbschemat har tagits bort, även om de fortfarande räknas mot kontolivslängdsstatistik.

deleteNodeFile(string, string, string, DeleteNodeFileOptionalParams)

Tar bort den angivna filen från beräkningsnoden.

deleteNodeUser(string, string, string, DeleteNodeUserOptionalParams)

Du kan bara ta bort ett användarkonto till en beräkningsnod när det är inaktivt eller körs. Innan du kan fjärrlogga in på en Compute-nod måste du konfigurera åtkomstportar för SSH och RDP. För mer information, se https://dotnet.territoriali.olinfo.it/azure/batch/pool-endpoint-configuration

deletePool(string, DeletePoolOptionalParams)

När du begär att en pool ska tas bort utförs följande åtgärder: Pooltillståndet är inställt på att ta bort; alla pågående storleksändringsåtgärder i poolen stoppas. Batch-tjänsten börjar ändra storlek på poolen till noll beräkningsnoder. Alla aktiviteter som körs på befintliga beräkningsnoder avslutas och sparas på nytt (som om en storleksändringsåtgärd för pool hade begärts med standardalternativet för att spara). Slutligen tas poolen bort från systemet. Eftersom aktiviteter som körs hämtas på nytt kan användaren köra aktiviteterna igen genom att uppdatera sitt jobb för att rikta in sig på en annan pool. Aktiviteterna kan sedan köras på den nya poolen. Om du vill åsidosätta återköbeteendet bör du anropa ändra storlek på poolen explicit för att minska poolen till nollstorlek innan du tar bort poolen. Om du anropar ett API för uppdatering, korrigering eller borttagning i en pool i borttagningstillståndet misslyckas det med HTTP-statuskod 409 med felkoden PoolBeingDeleted.

deleteTask(string, string, DeleteTaskOptionalParams)

När en aktivitet tas bort tas alla filer i dess katalog på beräkningsnoden där den kördes också bort (oavsett kvarhållningstid). För aktiviteter med flera instanser tillämpas borttagningsåtgärden synkront på den primära aktiviteten. underaktiviteter och deras filer tas sedan bort asynkront i bakgrunden.

deleteTaskFile(string, string, string, DeleteTaskFileOptionalParams)

Tar bort den angivna aktivitetsfilen från beräkningsnoden där aktiviteten kördes.

disableJob(string, BatchJobDisableOptions, DisableJobOptionalParams)

Batchtjänsten flyttar omedelbart jobbet till det inaktiverande tillståndet. Batch använder sedan disableTasks-parametern för att avgöra vad som ska göras med de aktuella Tasks i jobbet. Jobbet förblir i avstängningsläget tills avstängningsoperationen är slutförd och alla uppgifter har hanterats enligt disableTasks-alternativet; Jobbet går sedan över till funktionshindrat tillstånd. Inga nya uppgifter startas under jobbet förrän det återgår till aktivt tillstånd. Om du försöker inaktivera ett jobb som är i något annat tillstånd än aktivt, inaktiverat eller inaktiverat, misslyckas förfrågan med statuskod 409.

disableJobSchedule(string, DisableJobScheduleOptionalParams)

Inga nya jobb skapas förrän jobbschemat har aktiverats igen.

disableNodeScheduling(string, string, DisableNodeSchedulingOptionalParams)

Du kan inaktivera uppgiftsschemaläggning på en beräkningsnod endast om dess nuvarande schemaläggningstillstånd är aktiverat.

disablePoolAutoScale(string, DisablePoolAutoScaleOptionalParams)

Inaktiverar automatisk skalning för en pool.

enableJob(string, EnableJobOptionalParams)

När du anropar detta API sätter batchtjänsten ett inaktiverat jobb till aktiveringstillståndet. Efter att denna operation är slutförd går jobbet över till aktivt tillstånd och schemaläggning av nya uppgifter under jobbet återupptas. Batchtjänsten tillåter inte att en Uppgift förblir aktiv i mer än 180 dagar. Därför, om du aktiverar ett jobb som innehåller aktiva uppgifter som lades till för mer än 180 dagar sedan, kommer dessa uppgifter inte att köras.

enableJobSchedule(string, EnableJobScheduleOptionalParams)

Aktiverar ett jobbschema.

enableNodeScheduling(string, string, EnableNodeSchedulingOptionalParams)

Du kan aktivera Task scheduling på en Compute-nod endast om dess nuvarande schemaläggningstillstånd är inaktiverat

enablePoolAutoScale(string, BatchPoolEnableAutoScaleOptions, EnablePoolAutoScaleOptionalParams)

Du kan inte aktivera automatisk skalning på en pool om en storleksändring pågår i poolen. Om automatisk skalning av poolen för närvarande är inaktiverad måste du ange en giltig autoskalningsformel som en del av begäran. Om automatisk skalning av poolen redan är aktiverad kan du ange en ny autoskalningsformel och/eller ett nytt utvärderingsintervall. Du kan inte anropa det här API:et för samma pool mer än en gång var 30:e sekund.

evaluatePoolAutoScale(string, BatchPoolEvaluateAutoScaleOptions, EvaluatePoolAutoScaleOptionalParams)

Det här API:et är främst till för att verifiera en autoskalningsformel, eftersom det helt enkelt returnerar resultatet utan att tillämpa formeln på poolen. Poolen måste ha automatisk skalning aktiverad för att kunna utvärdera en formel.

getApplication(string, GetApplicationOptionalParams)

Denna operation returnerar endast applikationer och versioner som är tillgängliga för användning på beräkningsnoder; det vill säga, som kan användas i en paketreferens. För administratörsinformation om applikationer och versioner som ännu inte är tillgängliga för beräkningsnoder, använd Azure-portalen eller Azure Resource Manager API.

getJob(string, GetJobOptionalParams)

Får information om det angivna jobbet.

getJobSchedule(string, GetJobScheduleOptionalParams)

Får information om det angivna arbetsschemat.

getJobTaskCounts(string, GetJobTaskCountsOptionalParams)

Antal aktiviteter anger antalet aktiviteter efter aktivt, körnings- eller slutfört aktivitetstillstånd och antalet aktiviteter som lyckades eller misslyckades. Uppgifter i förberedelsetillståndet räknas som körning. Observera att de returnerade talen kanske inte alltid är uppdaterade. Om du behöver exakta uppgiftsantal använder du en listfråga.

getNode(string, string, GetNodeOptionalParams)

Hämtar information om den angivna beräkningsnoden.

getNodeExtension(string, string, string, GetNodeExtensionOptionalParams)

Hämtar information om den specificerade Compute Node Extension.

getNodeFile(string, string, string, GetNodeFileOptionalParams)

Returnerar innehållet i den angivna Compute Node-filen.

getNodeFileProperties(string, string, string, GetNodeFilePropertiesOptionalParams)

Hämtar egenskaperna för den angivna Compute Node-filen.

getNodeRemoteLoginSettings(string, string, GetNodeRemoteLoginSettingsOptionalParams)

Innan du kan fjärrlogga in på en Compute-nod med fjärrinloggningsinställningarna måste du skapa ett användarkonto på Compute-noden och konfigurera åtkomstportar för SSH och RDP. För mer information, se https://dotnet.territoriali.olinfo.it/azure/batch/pool-endpoint-configuration

getPool(string, GetPoolOptionalParams)

Hämtar information om den angivna poolen.

getTask(string, string, GetTaskOptionalParams)

För uppgifter med flera instanser refererar information som affinityId, executionInfo och nodeInfo till den primära uppgiften. Använd list-deluppgifter-API:et för att hämta information om deluppgifter.

getTaskFile(string, string, string, GetTaskFileOptionalParams)

Returnerar innehållet i den angivna Task-filen.

getTaskFileProperties(string, string, string, GetTaskFilePropertiesOptionalParams)

Hämtar egenskaperna för den angivna aktivitetsfilen.

jobScheduleExists(string, JobScheduleExistsOptionalParams)

Kontrollerar att det angivna arbetsschemat finns.

listApplications(ListApplicationsOptionalParams)

Denna operation returnerar endast applikationer och versioner som är tillgängliga för användning på beräkningsnoder; det vill säga, som kan användas i en paketreferens. För administratörsinformation om applikationer och versioner som ännu inte är tillgängliga för Compute Nodes, använd Azure-portalen eller Azure Resource Manager API.

listJobPreparationAndReleaseTaskStatus(string, ListJobPreparationAndReleaseTaskStatusOptionalParams)

Det här API:et returnerar statusen Jobbförberedelse och Jobbfrigöringsaktivitet på alla beräkningsnoder som har kört jobbförberedelse- eller jobbfrisläppningsaktiviteten. Detta inkluderar beräkningsnoder som sedan dess har tagits bort från poolen. Om det här API:et anropas på ett jobb som inte har någon jobbförberedelse- eller jobbversionsaktivitet returnerar Batch-tjänsten HTTP-statuskoden 409 (konflikt) med felkoden JobPreparationTaskNotSpecified.

listJobs(ListJobsOptionalParams)

Listar alla jobb i det angivna kontot.

listJobSchedules(ListJobSchedulesOptionalParams)

Listar alla jobbscheman i det angivna kontot.

listJobsFromSchedule(string, ListJobsFromScheduleOptionalParams)

Listar de jobb som har skapats under det angivna jobbschemat.

listNodeExtensions(string, string, ListNodeExtensionsOptionalParams)

Listar beräkningsnodernas tillägg i den angivna poolen.

listNodeFiles(string, string, ListNodeFilesOptionalParams)

Visar en lista över alla filer i aktivitetskataloger på den angivna beräkningsnoden.

listNodes(string, ListNodesOptionalParams)

Visar en lista över beräkningsnoder i den angivna poolen.

listPoolNodeCounts(ListPoolNodeCountsOptionalParams)

Hämtar antalet beräkningsnoder i varje tillstånd, grupperat efter pool. Observera att de returnerade talen kanske inte alltid är uppdaterade. Om du behöver exakta nodantal använder du en listfråga.

listPools(ListPoolsOptionalParams)

Visar en lista över alla pooler i det angivna kontot.

listPoolUsageMetrics(ListPoolUsageMetricsOptionalParams)

Om du inte anger en $filter-sats, inklusive ett pool-ID, innehåller svaret alla pooler som fanns i kontot i tidsintervallet för de returnerade aggregeringsintervallen. Om du inte anger en $filter-sats, inklusive en startTime- eller endTime-sats, standardvärdet för dessa filter till start- och sluttiderna för det senaste aggregeringsintervallet som för närvarande är tillgängligt. Dvs. returneras endast det sista aggregeringsintervallet.

listSubTasks(string, string, ListSubTasksOptionalParams)

Om aktiviteten inte är en aktivitet med flera instanser returnerar den en tom samling.

listSupportedImages(ListSupportedImagesOptionalParams)

Visar en lista över alla avbildningar av virtuella datorer som stöds av Azure Batch-tjänsten.

listTaskFiles(string, string, ListTaskFilesOptionalParams)

Visar filerna i en aktivitets katalog på dess beräkningsnod.

listTasks(string, ListTasksOptionalParams)

För uppgifter med flera instanser refererar information som affinityId, executionInfo och nodeInfo till den primära uppgiften. Använd list-deluppgifter-API:et för att hämta information om deluppgifter.

poolExists(string, PoolExistsOptionalParams)

Får grundläggande egenskaper hos en pool.

reactivateTask(string, string, ReactivateTaskOptionalParams)

Återaktivering gör en aktivitet berättigad att försöka igen upp till det maximala antalet återförsök. Aktivitetens tillstånd ändras till aktiv. Eftersom aktiviteten inte längre är i slutfört tillstånd är all tidigare slutkod eller felinformation inte längre tillgänglig efter återaktivering. Varje gång en aktivitet återaktiveras återställs antalet återförsök till 0. Återaktiveringen misslyckas för aktiviteter som inte har slutförts eller som har slutförts tidigare (med slutkoden 0). Dessutom misslyckas det om jobbet har slutförts (eller avslutar eller tar bort).

rebootNode(string, string, RebootNodeOptionalParams)

Du kan bara starta om en beräkningsnod om den är inaktiv eller körs.

reimageNode(string, string, ReimageNodeOptionalParams)

Du kan bara installera om operativsystemet på en beräkningsnod om det är i ett inaktivt eller körs-tillstånd. Detta API kan endast anropas på pooler skapade med molntjänstkonfigurationsegenskapen.

removeNodes(string, BatchNodeRemoveOptions, RemoveNodesOptionalParams)

Den här åtgärden kan bara köras när allokeringstillståndet för poolen är stabilt. När den här åtgärden körs ändras allokeringstillståndet från stabilt till storleksändring. Varje begäran kan ta bort upp till 100 noder.

replaceJob(string, BatchJob, ReplaceJobOptionalParams)

Detta ersätter helt alla uppdaterbara egenskaper hos jobbet. Till exempel, om jobbet har begränsningar kopplade till sig och om begränsningar inte specificeras med denna begäran, kommer batchtjänsten att ta bort de befintliga begränsningarna.

replaceJobSchedule(string, BatchJobSchedule, ReplaceJobScheduleOptionalParams)

Detta ersätter helt alla uppdaterbara egenskaper i jobbschemat. Till exempel, om schema-egenskapen inte är specificerad med denna förfrågan, kommer Batch-tjänsten att ta bort det befintliga schemat. Ändringar i ett jobbschema påverkar endast jobb som skapas av schemat efter att uppdateringen har ägt rum; Jobs som för närvarande är i drift är opåverkade.

replaceNodeUser(string, string, string, BatchNodeUserUpdateOptions, ReplaceNodeUserOptionalParams)

Denna operation ersätter alla kontots uppdaterbara egenskaper. Till exempel, om expiryTime-elementet inte specificeras, ersätts det aktuella värdet med standardvärdet och lämnas inte oförändrat. Du kan uppdatera ett användarkonto på en Compute-nod bara när den är i viloläge eller körningsläge.

replacePoolProperties(string, BatchPoolReplaceOptions, ReplacePoolPropertiesOptionalParams)

Detta ersätter helt alla uppdaterbara egenskaper hos Poolen. Till exempel, om Poolen har en StartTask kopplad till sig och om StartTask inte är specificerad med denna förfrågan, kommer Batch-tjänsten att ta bort den befintliga StartTask.

replaceTask(string, string, BatchTask, ReplaceTaskOptionalParams)

Uppdaterar egenskaperna för den angivna uppgiften.

resizePool(string, BatchPoolResizeOptions, ResizePoolOptionalParams)

Du kan bara ändra storlek på en pool när dess allokeringstillstånd är stabilt. Om poolen redan ändrar storlek misslyckas begäran med statuskoden 409. När du ändrar storlek på en pool ändras poolens allokeringsstatus från stadig till storleksändring. Du kan inte ändra storlek på pooler som är konfigurerade för automatisk skalning. Om du försöker göra detta returnerar Batch-tjänsten ett fel 409. Om du ändrar storlek på en pool nedåt väljer Batch-tjänsten vilka beräkningsnoder du vill ta bort. Om du vill ta bort specifika beräkningsnoder använder du API:et För att ta bort beräkningsnoder i stället.

startNode(string, string, StartNodeOptionalParams)

Du kan starta en Compute Node bara om den har blivit dealloced.

stopPoolResize(string, StopPoolResizeOptionalParams)

Detta återställer inte poolen till dess tidigare tillstånd före storleksbytesoperationen: det stoppar bara ytterligare ändringar och poolen behåller sitt nuvarande tillstånd. Efter att ha stoppat stabiliseras poolen på det antal beräkningsnoder den hade när stoppoperationen utfördes. Under stoppoperationen ändras poolallokeringstillståndet först till stopp och sedan till stabilt. En storleksändring behöver inte vara en explicit storleksändring av Pool; detta API kan också användas för att stoppa den initiala storleken av poolen när den skapas.

terminateJob(string, TerminateJobOptionalParams)

När en begäran om att avsluta jobbet tas emot sätter batchtjänsten jobbet till det avslutande tillståndet. Batchtjänsten avslutar sedan alla körande uppgifter kopplade till jobbet och kör alla nödvändiga jobbfrigöringsuppgifter. Sedan går Jobbet in i det färdiga tillståndet. Om det finns några uppgifter i jobbet i aktivt tillstånd, kommer de att förbli i aktivt tillstånd. När ett jobb avslutas kan nya uppgifter inte läggas till och eventuella kvarvarande aktiva uppgifter kommer inte att schemaläggas igen.

terminateJobSchedule(string, TerminateJobScheduleOptionalParams)

Avslutar ett jobbschema.

terminateTask(string, string, TerminateTaskOptionalParams)

När aktiviteten har avslutats flyttas den till slutfört tillstånd. För aktiviteter med flera instanser gäller åtgärden Avsluta aktivitet synkront för den primära aktiviteten. underaktiviteter avslutas sedan asynkront i bakgrunden.

updateJob(string, BatchJobUpdateOptions, UpdateJobOptionalParams)

Detta ersätter endast de jobbegenskaper som anges i förfrågan. Till exempel, om jobbet har begränsningar och en begäran inte specificerar begränsningselementet, behåller jobbet de befintliga begränsningarna.

updateJobSchedule(string, BatchJobScheduleUpdateOptions, UpdateJobScheduleOptionalParams)

Detta ersätter endast de egenskaper som anges i jobbschemat i förfrågan. Till exempel, om schema-egenskapen inte specificeras med denna förfrågan, kommer Batch-tjänsten att behålla det befintliga schemat. Ändringar i ett jobbschema påverkar endast jobb som skapas av schemat efter att uppdateringen har ägt rum; Jobs som för närvarande är i drift är opåverkade.

updatePool(string, BatchPoolUpdateOptions, UpdatePoolOptionalParams)

Detta ersätter endast poolegenskaperna som anges i förfrågan. Till exempel, om poolen har en StartTask kopplad till sig, och en begäran inte specificerar ett StartTask-element, behåller poolen den befintliga StartTask.

uploadNodeLogs(string, string, UploadBatchServiceLogsOptions, UploadNodeLogsOptionalParams)

Detta är för att samla Azure Batch-tjänstloggfiler på ett automatiserat sätt från Compute Nodes om du upplever ett fel och vill eskalera till Azure-support. De Azure Batch tjänstloggfilerna ska delas med Azure support för att underlätta felsökning av problem med Batch-tjänsten.

Konstruktorinformation

BatchClient(string, TokenCredential | AzureNamedKeyCredential, BatchClientOptionalParams)

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

Parametrar

endpointParam

string

Metodinformation

createJob(BatchJobCreateOptions, CreateJobOptionalParams)

Batch-tjänsten stödjer två sätt att kontrollera arbetet som utförs som en del av ett jobb. I det första tillvägagångssättet specificerar användaren en Jobbhanteraruppgift. Batchtjänsten startar denna uppgift när den är redo att starta jobbet. Jobbhanterar-uppgiften styr alla andra uppgifter som körs under detta jobb genom att använda Task API:erna. I det andra tillvägagångssättet kontrollerar användaren direkt exekveringen av uppgifter under ett aktivt jobb, genom att använda Task API:erna. Observera också: när du namnger jobb, undvik att inkludera känslig information som användarnamn eller hemliga projektnamn. Denna information kan finnas i telemetriloggar som är tillgängliga för Microsoft Support-ingenjörer.

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

Parametrar

Returer

Promise<void>

createJobSchedule(BatchJobScheduleCreateOptions, CreateJobScheduleOptionalParams)

Skapar ett jobbschema till det angivna kontot.

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

Parametrar

Returer

Promise<void>

createNodeUser(string, string, BatchNodeUserCreateOptions, CreateNodeUserOptionalParams)

Du kan bara lägga till ett användarkonto i en beräkningsnod när den är i viloläge eller körningsläge. Innan du kan fjärrlogga in på en Compute-nod måste du konfigurera åtkomstportar för SSH och RDP. För mer information, se https://dotnet.territoriali.olinfo.it/azure/batch/pool-endpoint-configuration

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

Parametrar

poolId

string

nodeId

string

Returer

Promise<void>

createPool(BatchPoolCreateOptions, CreatePoolOptionalParams)

När du namnger pooler bör du undvika att inkludera känslig information, till exempel användarnamn eller hemliga projektnamn. Denna information kan finnas i telemetriloggar som är tillgängliga för Microsoft Support-ingenjörer.

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

Parametrar

Returer

Promise<void>

createTask(string, BatchTaskCreateOptions, CreateTaskOptionalParams)

Den maximala livslängden för en uppgift från addition till slutförande är 180 dagar. Om en uppgift inte har slutförts inom 180 dagar efter att ha lagts till kommer den att avslutas av batchtjänsten och lämnas kvar i det tillstånd den var i vid den tidpunkten.

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

Parametrar

jobId

string

Returer

Promise<void>

createTaskCollection(string, BatchTaskGroup, CreateTaskCollectionOptionalParams)

Observera att varje uppgift måste ha ett unikt ID. Batchtjänsten kanske inte returnerar resultaten för varje uppgift i samma ordning som uppgifterna skickades in i denna förfrågan. Om servern går ut på tidsgränsen eller anslutningen stängs under förfrågan kan begäran ha behandlats delvis eller helt, eller inte alls. I sådana fall bör användaren skicka ut förfrågan på nytt. Observera att det är upp till användaren att korrekt hantera fel vid omutfärdande av en förfrågan. Till exempel bör du använda samma Task ID:n under ett försök så att om föregående operation lyckades, skapar inte omförsöket extra Tasks oväntat. Om svaret innehåller några Tasks som inte lade till kan en klient försöka på nytt med begäran. Vid ett nytt försök är det mest effektivt att endast skicka in uppgifter som misslyckades med att lägga till och att utelämna uppgifter som lyckades läggas till vid första försöket. Den maximala livslängden för en uppgift från addition till slutförande är 180 dagar. Om en uppgift inte har slutförts inom 180 dagar efter att ha lagts till kommer den att avslutas av batchtjänsten och lämnas kvar i det tillstånd den var i vid den tidpunkten.

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

Parametrar

jobId

string

taskCollection
BatchTaskGroup

Returer

deallocateNode(string, string, DeallocateNodeOptionalParams)

Du kan bara frigöra en beräkningsnod om den är i ett inaktivt eller körningstillstånd.

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

Parametrar

poolId

string

nodeId

string

Returer

PollerLike<OperationState<void>, void>

deleteJob(string, DeleteJobOptionalParams)

Att ta bort ett jobb tar också bort alla uppgifter som ingår i det jobbet, samt all jobbstatistik. Detta åsidosätter också lagringstiden för uppgiftsdata; det vill säga, om jobbet innehåller uppgifter som fortfarande finns kvar på beräkningsnoder, raderar batchtjänsterna dessa uppgifters arbetskataloger och allt deras innehåll. När en begäran om borttagning av jobb tas emot sätter batchtjänsten jobbet till raderingstillståndet. Alla uppdateringsoperationer på ett jobb som är i raderingsläge kommer att misslyckas med statuskod 409 (Konflikt), med ytterligare information som indikerar att jobbet tas bort.

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

Parametrar

jobId

string

Returer

PollerLike<OperationState<void>, void>

deleteJobSchedule(string, DeleteJobScheduleOptionalParams)

När du tar bort ett jobbschema tas även alla jobb och aktiviteter bort under det schemat. När Uppgifter tas bort tas även alla filer i deras arbetskataloger på beräkningsnoderna bort (kvarhållningsperioden ignoreras). Statistiken för jobbschemat är inte längre tillgänglig när jobbschemat har tagits bort, även om de fortfarande räknas mot kontolivslängdsstatistik.

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

Parametrar

jobScheduleId

string

Returer

PollerLike<OperationState<void>, void>

deleteNodeFile(string, string, string, DeleteNodeFileOptionalParams)

Tar bort den angivna filen från beräkningsnoden.

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

Parametrar

poolId

string

nodeId

string

filePath

string

Returer

Promise<void>

deleteNodeUser(string, string, string, DeleteNodeUserOptionalParams)

Du kan bara ta bort ett användarkonto till en beräkningsnod när det är inaktivt eller körs. Innan du kan fjärrlogga in på en Compute-nod måste du konfigurera åtkomstportar för SSH och RDP. För mer information, se https://dotnet.territoriali.olinfo.it/azure/batch/pool-endpoint-configuration

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

Parametrar

poolId

string

nodeId

string

userName

string

Returer

Promise<void>

deletePool(string, DeletePoolOptionalParams)

När du begär att en pool ska tas bort utförs följande åtgärder: Pooltillståndet är inställt på att ta bort; alla pågående storleksändringsåtgärder i poolen stoppas. Batch-tjänsten börjar ändra storlek på poolen till noll beräkningsnoder. Alla aktiviteter som körs på befintliga beräkningsnoder avslutas och sparas på nytt (som om en storleksändringsåtgärd för pool hade begärts med standardalternativet för att spara). Slutligen tas poolen bort från systemet. Eftersom aktiviteter som körs hämtas på nytt kan användaren köra aktiviteterna igen genom att uppdatera sitt jobb för att rikta in sig på en annan pool. Aktiviteterna kan sedan köras på den nya poolen. Om du vill åsidosätta återköbeteendet bör du anropa ändra storlek på poolen explicit för att minska poolen till nollstorlek innan du tar bort poolen. Om du anropar ett API för uppdatering, korrigering eller borttagning i en pool i borttagningstillståndet misslyckas det med HTTP-statuskod 409 med felkoden PoolBeingDeleted.

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

Parametrar

poolId

string

Returer

PollerLike<OperationState<void>, void>

deleteTask(string, string, DeleteTaskOptionalParams)

När en aktivitet tas bort tas alla filer i dess katalog på beräkningsnoden där den kördes också bort (oavsett kvarhållningstid). För aktiviteter med flera instanser tillämpas borttagningsåtgärden synkront på den primära aktiviteten. underaktiviteter och deras filer tas sedan bort asynkront i bakgrunden.

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

Parametrar

jobId

string

taskId

string

Returer

Promise<void>

deleteTaskFile(string, string, string, DeleteTaskFileOptionalParams)

Tar bort den angivna aktivitetsfilen från beräkningsnoden där aktiviteten kördes.

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

Parametrar

jobId

string

taskId

string

filePath

string

Returer

Promise<void>

disableJob(string, BatchJobDisableOptions, DisableJobOptionalParams)

Batchtjänsten flyttar omedelbart jobbet till det inaktiverande tillståndet. Batch använder sedan disableTasks-parametern för att avgöra vad som ska göras med de aktuella Tasks i jobbet. Jobbet förblir i avstängningsläget tills avstängningsoperationen är slutförd och alla uppgifter har hanterats enligt disableTasks-alternativet; Jobbet går sedan över till funktionshindrat tillstånd. Inga nya uppgifter startas under jobbet förrän det återgår till aktivt tillstånd. Om du försöker inaktivera ett jobb som är i något annat tillstånd än aktivt, inaktiverat eller inaktiverat, misslyckas förfrågan med statuskod 409.

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

Parametrar

jobId

string

disableOptions
BatchJobDisableOptions

Returer

PollerLike<OperationState<void>, void>

disableJobSchedule(string, DisableJobScheduleOptionalParams)

Inga nya jobb skapas förrän jobbschemat har aktiverats igen.

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

Parametrar

jobScheduleId

string

Returer

Promise<void>

disableNodeScheduling(string, string, DisableNodeSchedulingOptionalParams)

Du kan inaktivera uppgiftsschemaläggning på en beräkningsnod endast om dess nuvarande schemaläggningstillstånd är aktiverat.

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

Parametrar

poolId

string

nodeId

string

Returer

Promise<void>

disablePoolAutoScale(string, DisablePoolAutoScaleOptionalParams)

Inaktiverar automatisk skalning för en pool.

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

Parametrar

poolId

string

Returer

Promise<void>

enableJob(string, EnableJobOptionalParams)

När du anropar detta API sätter batchtjänsten ett inaktiverat jobb till aktiveringstillståndet. Efter att denna operation är slutförd går jobbet över till aktivt tillstånd och schemaläggning av nya uppgifter under jobbet återupptas. Batchtjänsten tillåter inte att en Uppgift förblir aktiv i mer än 180 dagar. Därför, om du aktiverar ett jobb som innehåller aktiva uppgifter som lades till för mer än 180 dagar sedan, kommer dessa uppgifter inte att köras.

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

Parametrar

jobId

string

Returer

PollerLike<OperationState<void>, void>

enableJobSchedule(string, EnableJobScheduleOptionalParams)

Aktiverar ett jobbschema.

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

Parametrar

jobScheduleId

string

Returer

Promise<void>

enableNodeScheduling(string, string, EnableNodeSchedulingOptionalParams)

Du kan aktivera Task scheduling på en Compute-nod endast om dess nuvarande schemaläggningstillstånd är inaktiverat

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

Parametrar

poolId

string

nodeId

string

Returer

Promise<void>

enablePoolAutoScale(string, BatchPoolEnableAutoScaleOptions, EnablePoolAutoScaleOptionalParams)

Du kan inte aktivera automatisk skalning på en pool om en storleksändring pågår i poolen. Om automatisk skalning av poolen för närvarande är inaktiverad måste du ange en giltig autoskalningsformel som en del av begäran. Om automatisk skalning av poolen redan är aktiverad kan du ange en ny autoskalningsformel och/eller ett nytt utvärderingsintervall. Du kan inte anropa det här API:et för samma pool mer än en gång var 30:e sekund.

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

Parametrar

poolId

string

enableAutoScaleOptions
BatchPoolEnableAutoScaleOptions

Returer

Promise<void>

evaluatePoolAutoScale(string, BatchPoolEvaluateAutoScaleOptions, EvaluatePoolAutoScaleOptionalParams)

Det här API:et är främst till för att verifiera en autoskalningsformel, eftersom det helt enkelt returnerar resultatet utan att tillämpa formeln på poolen. Poolen måste ha automatisk skalning aktiverad för att kunna utvärdera en formel.

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

Parametrar

poolId

string

evaluateAutoScaleOptions
BatchPoolEvaluateAutoScaleOptions

Returer

Promise<AutoScaleRun>

getApplication(string, GetApplicationOptionalParams)

Denna operation returnerar endast applikationer och versioner som är tillgängliga för användning på beräkningsnoder; det vill säga, som kan användas i en paketreferens. För administratörsinformation om applikationer och versioner som ännu inte är tillgängliga för beräkningsnoder, använd Azure-portalen eller Azure Resource Manager API.

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

Parametrar

applicationId

string

Returer

Promise<BatchApplication>

getJob(string, GetJobOptionalParams)

Får information om det angivna jobbet.

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

Parametrar

jobId

string

Returer

Promise<BatchJob>

getJobSchedule(string, GetJobScheduleOptionalParams)

Får information om det angivna arbetsschemat.

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

Parametrar

jobScheduleId

string

Returer

Promise<BatchJobSchedule>

getJobTaskCounts(string, GetJobTaskCountsOptionalParams)

Antal aktiviteter anger antalet aktiviteter efter aktivt, körnings- eller slutfört aktivitetstillstånd och antalet aktiviteter som lyckades eller misslyckades. Uppgifter i förberedelsetillståndet räknas som körning. Observera att de returnerade talen kanske inte alltid är uppdaterade. Om du behöver exakta uppgiftsantal använder du en listfråga.

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

Parametrar

jobId

string

Returer

getNode(string, string, GetNodeOptionalParams)

Hämtar information om den angivna beräkningsnoden.

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

Parametrar

poolId

string

nodeId

string

Returer

Promise<BatchNode>

getNodeExtension(string, string, string, GetNodeExtensionOptionalParams)

Hämtar information om den specificerade Compute Node Extension.

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

Parametrar

poolId

string

nodeId

string

extensionName

string

Returer

getNodeFile(string, string, string, GetNodeFileOptionalParams)

Returnerar innehållet i den angivna Compute Node-filen.

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

Parametrar

poolId

string

nodeId

string

filePath

string

Returer

Promise<Uint8Array>

getNodeFileProperties(string, string, string, GetNodeFilePropertiesOptionalParams)

Hämtar egenskaperna för den angivna Compute Node-filen.

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

Parametrar

poolId

string

nodeId

string

filePath

string

Returer

Promise<BatchNodeFile>

getNodeRemoteLoginSettings(string, string, GetNodeRemoteLoginSettingsOptionalParams)

Innan du kan fjärrlogga in på en Compute-nod med fjärrinloggningsinställningarna måste du skapa ett användarkonto på Compute-noden och konfigurera åtkomstportar för SSH och RDP. För mer information, se https://dotnet.territoriali.olinfo.it/azure/batch/pool-endpoint-configuration

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

Parametrar

poolId

string

nodeId

string

Returer

getPool(string, GetPoolOptionalParams)

Hämtar information om den angivna poolen.

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

Parametrar

poolId

string

Returer

Promise<BatchPool>

getTask(string, string, GetTaskOptionalParams)

För uppgifter med flera instanser refererar information som affinityId, executionInfo och nodeInfo till den primära uppgiften. Använd list-deluppgifter-API:et för att hämta information om deluppgifter.

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

Parametrar

jobId

string

taskId

string

Returer

Promise<BatchTask>

getTaskFile(string, string, string, GetTaskFileOptionalParams)

Returnerar innehållet i den angivna Task-filen.

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

Parametrar

jobId

string

taskId

string

filePath

string

Returer

Promise<Uint8Array>

getTaskFileProperties(string, string, string, GetTaskFilePropertiesOptionalParams)

Hämtar egenskaperna för den angivna aktivitetsfilen.

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

Parametrar

jobId

string

taskId

string

filePath

string

Returer

Promise<BatchNodeFile>

jobScheduleExists(string, JobScheduleExistsOptionalParams)

Kontrollerar att det angivna arbetsschemat finns.

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

Parametrar

jobScheduleId

string

Returer

Promise<boolean>

listApplications(ListApplicationsOptionalParams)

Denna operation returnerar endast applikationer och versioner som är tillgängliga för användning på beräkningsnoder; det vill säga, som kan användas i en paketreferens. För administratörsinformation om applikationer och versioner som ännu inte är tillgängliga för Compute Nodes, använd Azure-portalen eller Azure Resource Manager API.

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

Parametrar

Returer

listJobPreparationAndReleaseTaskStatus(string, ListJobPreparationAndReleaseTaskStatusOptionalParams)

Det här API:et returnerar statusen Jobbförberedelse och Jobbfrigöringsaktivitet på alla beräkningsnoder som har kört jobbförberedelse- eller jobbfrisläppningsaktiviteten. Detta inkluderar beräkningsnoder som sedan dess har tagits bort från poolen. Om det här API:et anropas på ett jobb som inte har någon jobbförberedelse- eller jobbversionsaktivitet returnerar Batch-tjänsten HTTP-statuskoden 409 (konflikt) med felkoden JobPreparationTaskNotSpecified.

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

Parametrar

jobId

string

Returer

listJobs(ListJobsOptionalParams)

Listar alla jobb i det angivna kontot.

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

Parametrar

Returer

listJobSchedules(ListJobSchedulesOptionalParams)

Listar alla jobbscheman i det angivna kontot.

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

Parametrar

Returer

listJobsFromSchedule(string, ListJobsFromScheduleOptionalParams)

Listar de jobb som har skapats under det angivna jobbschemat.

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

Parametrar

jobScheduleId

string

Returer

listNodeExtensions(string, string, ListNodeExtensionsOptionalParams)

Listar beräkningsnodernas tillägg i den angivna poolen.

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

Parametrar

poolId

string

nodeId

string

Returer

listNodeFiles(string, string, ListNodeFilesOptionalParams)

Visar en lista över alla filer i aktivitetskataloger på den angivna beräkningsnoden.

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

Parametrar

poolId

string

nodeId

string

Returer

listNodes(string, ListNodesOptionalParams)

Visar en lista över beräkningsnoder i den angivna poolen.

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

Parametrar

poolId

string

Returer

listPoolNodeCounts(ListPoolNodeCountsOptionalParams)

Hämtar antalet beräkningsnoder i varje tillstånd, grupperat efter pool. Observera att de returnerade talen kanske inte alltid är uppdaterade. Om du behöver exakta nodantal använder du en listfråga.

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

Parametrar

Returer

listPools(ListPoolsOptionalParams)

Visar en lista över alla pooler i det angivna kontot.

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

Parametrar

Returer

listPoolUsageMetrics(ListPoolUsageMetricsOptionalParams)

Om du inte anger en $filter-sats, inklusive ett pool-ID, innehåller svaret alla pooler som fanns i kontot i tidsintervallet för de returnerade aggregeringsintervallen. Om du inte anger en $filter-sats, inklusive en startTime- eller endTime-sats, standardvärdet för dessa filter till start- och sluttiderna för det senaste aggregeringsintervallet som för närvarande är tillgängligt. Dvs. returneras endast det sista aggregeringsintervallet.

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

Parametrar

Returer

listSubTasks(string, string, ListSubTasksOptionalParams)

Om aktiviteten inte är en aktivitet med flera instanser returnerar den en tom samling.

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

Parametrar

jobId

string

taskId

string

Returer

listSupportedImages(ListSupportedImagesOptionalParams)

Visar en lista över alla avbildningar av virtuella datorer som stöds av Azure Batch-tjänsten.

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

Parametrar

Returer

listTaskFiles(string, string, ListTaskFilesOptionalParams)

Visar filerna i en aktivitets katalog på dess beräkningsnod.

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

Parametrar

jobId

string

taskId

string

Returer

listTasks(string, ListTasksOptionalParams)

För uppgifter med flera instanser refererar information som affinityId, executionInfo och nodeInfo till den primära uppgiften. Använd list-deluppgifter-API:et för att hämta information om deluppgifter.

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

Parametrar

jobId

string

Returer

poolExists(string, PoolExistsOptionalParams)

Får grundläggande egenskaper hos en pool.

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

Parametrar

poolId

string

Returer

Promise<boolean>

reactivateTask(string, string, ReactivateTaskOptionalParams)

Återaktivering gör en aktivitet berättigad att försöka igen upp till det maximala antalet återförsök. Aktivitetens tillstånd ändras till aktiv. Eftersom aktiviteten inte längre är i slutfört tillstånd är all tidigare slutkod eller felinformation inte längre tillgänglig efter återaktivering. Varje gång en aktivitet återaktiveras återställs antalet återförsök till 0. Återaktiveringen misslyckas för aktiviteter som inte har slutförts eller som har slutförts tidigare (med slutkoden 0). Dessutom misslyckas det om jobbet har slutförts (eller avslutar eller tar bort).

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

Parametrar

jobId

string

taskId

string

Returer

Promise<void>

rebootNode(string, string, RebootNodeOptionalParams)

Du kan bara starta om en beräkningsnod om den är inaktiv eller körs.

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

Parametrar

poolId

string

nodeId

string

Returer

PollerLike<OperationState<void>, void>

reimageNode(string, string, ReimageNodeOptionalParams)

Du kan bara installera om operativsystemet på en beräkningsnod om det är i ett inaktivt eller körs-tillstånd. Detta API kan endast anropas på pooler skapade med molntjänstkonfigurationsegenskapen.

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

Parametrar

poolId

string

nodeId

string

Returer

PollerLike<OperationState<void>, void>

removeNodes(string, BatchNodeRemoveOptions, RemoveNodesOptionalParams)

Den här åtgärden kan bara köras när allokeringstillståndet för poolen är stabilt. När den här åtgärden körs ändras allokeringstillståndet från stabilt till storleksändring. Varje begäran kan ta bort upp till 100 noder.

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

Parametrar

poolId

string

removeOptions
BatchNodeRemoveOptions

Returer

PollerLike<OperationState<void>, void>

replaceJob(string, BatchJob, ReplaceJobOptionalParams)

Detta ersätter helt alla uppdaterbara egenskaper hos jobbet. Till exempel, om jobbet har begränsningar kopplade till sig och om begränsningar inte specificeras med denna begäran, kommer batchtjänsten att ta bort de befintliga begränsningarna.

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

Parametrar

jobId

string

job
BatchJob

Returer

Promise<void>

replaceJobSchedule(string, BatchJobSchedule, ReplaceJobScheduleOptionalParams)

Detta ersätter helt alla uppdaterbara egenskaper i jobbschemat. Till exempel, om schema-egenskapen inte är specificerad med denna förfrågan, kommer Batch-tjänsten att ta bort det befintliga schemat. Ändringar i ett jobbschema påverkar endast jobb som skapas av schemat efter att uppdateringen har ägt rum; Jobs som för närvarande är i drift är opåverkade.

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

Parametrar

jobScheduleId

string

jobSchedule
BatchJobSchedule

Returer

Promise<void>

replaceNodeUser(string, string, string, BatchNodeUserUpdateOptions, ReplaceNodeUserOptionalParams)

Denna operation ersätter alla kontots uppdaterbara egenskaper. Till exempel, om expiryTime-elementet inte specificeras, ersätts det aktuella värdet med standardvärdet och lämnas inte oförändrat. Du kan uppdatera ett användarkonto på en Compute-nod bara när den är i viloläge eller körningsläge.

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

Parametrar

poolId

string

nodeId

string

userName

string

Returer

Promise<void>

replacePoolProperties(string, BatchPoolReplaceOptions, ReplacePoolPropertiesOptionalParams)

Detta ersätter helt alla uppdaterbara egenskaper hos Poolen. Till exempel, om Poolen har en StartTask kopplad till sig och om StartTask inte är specificerad med denna förfrågan, kommer Batch-tjänsten att ta bort den befintliga StartTask.

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

Parametrar

poolId

string

Returer

Promise<void>

replaceTask(string, string, BatchTask, ReplaceTaskOptionalParams)

Uppdaterar egenskaperna för den angivna uppgiften.

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

Parametrar

jobId

string

taskId

string

task
BatchTask

Returer

Promise<void>

resizePool(string, BatchPoolResizeOptions, ResizePoolOptionalParams)

Du kan bara ändra storlek på en pool när dess allokeringstillstånd är stabilt. Om poolen redan ändrar storlek misslyckas begäran med statuskoden 409. När du ändrar storlek på en pool ändras poolens allokeringsstatus från stadig till storleksändring. Du kan inte ändra storlek på pooler som är konfigurerade för automatisk skalning. Om du försöker göra detta returnerar Batch-tjänsten ett fel 409. Om du ändrar storlek på en pool nedåt väljer Batch-tjänsten vilka beräkningsnoder du vill ta bort. Om du vill ta bort specifika beräkningsnoder använder du API:et För att ta bort beräkningsnoder i stället.

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

Parametrar

poolId

string

resizeOptions
BatchPoolResizeOptions

Returer

PollerLike<OperationState<void>, void>

startNode(string, string, StartNodeOptionalParams)

Du kan starta en Compute Node bara om den har blivit dealloced.

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

Parametrar

poolId

string

nodeId

string

Returer

PollerLike<OperationState<void>, void>

stopPoolResize(string, StopPoolResizeOptionalParams)

Detta återställer inte poolen till dess tidigare tillstånd före storleksbytesoperationen: det stoppar bara ytterligare ändringar och poolen behåller sitt nuvarande tillstånd. Efter att ha stoppat stabiliseras poolen på det antal beräkningsnoder den hade när stoppoperationen utfördes. Under stoppoperationen ändras poolallokeringstillståndet först till stopp och sedan till stabilt. En storleksändring behöver inte vara en explicit storleksändring av Pool; detta API kan också användas för att stoppa den initiala storleken av poolen när den skapas.

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

Parametrar

poolId

string

Returer

PollerLike<OperationState<void>, void>

terminateJob(string, TerminateJobOptionalParams)

När en begäran om att avsluta jobbet tas emot sätter batchtjänsten jobbet till det avslutande tillståndet. Batchtjänsten avslutar sedan alla körande uppgifter kopplade till jobbet och kör alla nödvändiga jobbfrigöringsuppgifter. Sedan går Jobbet in i det färdiga tillståndet. Om det finns några uppgifter i jobbet i aktivt tillstånd, kommer de att förbli i aktivt tillstånd. När ett jobb avslutas kan nya uppgifter inte läggas till och eventuella kvarvarande aktiva uppgifter kommer inte att schemaläggas igen.

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

Parametrar

jobId

string

Returer

PollerLike<OperationState<void>, void>

terminateJobSchedule(string, TerminateJobScheduleOptionalParams)

Avslutar ett jobbschema.

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

Parametrar

jobScheduleId

string

Returer

PollerLike<OperationState<void>, void>

terminateTask(string, string, TerminateTaskOptionalParams)

När aktiviteten har avslutats flyttas den till slutfört tillstånd. För aktiviteter med flera instanser gäller åtgärden Avsluta aktivitet synkront för den primära aktiviteten. underaktiviteter avslutas sedan asynkront i bakgrunden.

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

Parametrar

jobId

string

taskId

string

Returer

Promise<void>

updateJob(string, BatchJobUpdateOptions, UpdateJobOptionalParams)

Detta ersätter endast de jobbegenskaper som anges i förfrågan. Till exempel, om jobbet har begränsningar och en begäran inte specificerar begränsningselementet, behåller jobbet de befintliga begränsningarna.

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

Parametrar

jobId

string

Returer

Promise<void>

updateJobSchedule(string, BatchJobScheduleUpdateOptions, UpdateJobScheduleOptionalParams)

Detta ersätter endast de egenskaper som anges i jobbschemat i förfrågan. Till exempel, om schema-egenskapen inte specificeras med denna förfrågan, kommer Batch-tjänsten att behålla det befintliga schemat. Ändringar i ett jobbschema påverkar endast jobb som skapas av schemat efter att uppdateringen har ägt rum; Jobs som för närvarande är i drift är opåverkade.

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

Parametrar

jobScheduleId

string

Returer

Promise<void>

updatePool(string, BatchPoolUpdateOptions, UpdatePoolOptionalParams)

Detta ersätter endast poolegenskaperna som anges i förfrågan. Till exempel, om poolen har en StartTask kopplad till sig, och en begäran inte specificerar ett StartTask-element, behåller poolen den befintliga StartTask.

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

Parametrar

poolId

string

Returer

Promise<void>

uploadNodeLogs(string, string, UploadBatchServiceLogsOptions, UploadNodeLogsOptionalParams)

Detta är för att samla Azure Batch-tjänstloggfiler på ett automatiserat sätt från Compute Nodes om du upplever ett fel och vill eskalera till Azure-support. De Azure Batch tjänstloggfilerna ska delas med Azure support för att underlätta felsökning av problem med Batch-tjänsten.

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

Parametrar

poolId

string

nodeId

string

Returer