BatchClient class

Client class for access Azure Batch service.

Metódusok

createJob(BatchJobCreateOptions, CreateJobOptionalParams)

A Batch szolgáltatás kétféle módon irányítja a munkát, amelyet a Munka részeként végeznek. Az első megközelítésben a felhasználó egy Job Manager feladatot határoz meg. A Batch szolgáltatás akkor indítja el ezt a Feladatot, amikor készen áll a Feladat elindítására. A Feladatkezelő Feladat irányítja az összes többi feladatot, amely ezen a Feladaton fut, a Feladat API-k segítségével. A második megközelítésben a felhasználó közvetlenül irányítja a feladatok végrehajtását egy aktív Feladat alatt, a Feladat API-k segítségével. Fontos megjegyezni: Jobs-nevekor kerüld az érzékeny információk, például felhasználónevek vagy titkos projektnevek bevonását. Ezek az információk megjelenhetnek a Microsoft ügyfélszolgálata mérnökei számára elérhető telemetriai naplókban.

createJobSchedule(BatchJobScheduleCreateOptions, CreateJobScheduleOptionalParams)

Létrehoz egy Munkamenetrendet a megadott fiókhoz.

createNodeUser(string, string, BatchNodeUserCreateOptions, CreateNodeUserOptionalParams)

Felhasználói fiókot csak akkor adhatsz hozzá egy Compute Node-hoz, ha az tétlen vagy futó állapotban van. Mielőtt távolról bejelentkezhetnél egy Compute Node-ba, be kell állítanod az SSH és RDP hozzáférési portokat. További információért, lásd: https://learn.microsoft.com/azure/batch/pool-endpoint-configuration

createPool(BatchPoolCreateOptions, CreatePoolOptionalParams)

A készletek elnevezésekor kerülje a bizalmas adatok, például a felhasználónevek vagy a titkos projektnevek használatát. Ezek az információk megjelenhetnek a Microsoft ügyfélszolgálata mérnökei számára elérhető telemetriai naplókban.

createTask(string, BatchTaskCreateOptions, CreateTaskOptionalParams)

Egy feladat maximális élettartama a kiegészítéstől a befejezésig 180 nap. Ha egy feladat 180 napon belül nem fejez be a hozzáadásától, a Batch szolgáltatás megszünteti, és abban az állapotban hagyja, amiben az adott állapotban volt.

createTaskCollection(string, BatchTaskGroup, CreateTaskCollectionOptionalParams)

Fontos megjegyezni, hogy minden feladatnak egyedi azonosítóval kell rendelkeznie. A Batch szolgáltatás nem térhet vissza minden feladat eredményeit ugyanabban a sorrendben, ahogy a feladatokat ebben a kérésben benyújtották. Ha a szerver időkorlátot kap vagy a kapcsolat lezáródik a kérés során, a kérés részben vagy teljes egészében feldolgozódhat, vagy egyáltalán nem történt. Ilyen esetekben a felhasználónak újra kell kiküldenie a kérést. Fontos megjegyezni, hogy a felhasználó feladata, hogy helyesen kezelje a hibákat a kérés újraküldésekor. Például ugyanazokat a Feladatazonosítókat kell használni egy újrapróbálkozás során, hogy ha az előző művelet sikeres volt, az újrapróbálkozás ne hozzon létre váratlanul plusz feladatokat. Ha a válasz tartalmaz olyan feladatokat, amelyeket nem sikerült hozzáadni, egy kliens újra megpróbálhatja a kérést. Újrapróbálkozás esetén a leghatékonyabb, ha csak azokat a feladatokat küldjük újra, amelyek nem adtak össze, és kihagyják azokat a feladatokat, amelyeket az első próbálkozáskor sikeresen hozzáadtak. Egy feladat maximális élettartama a kiegészítéstől a befejezésig 180 nap. Ha egy feladat 180 napon belül nem fejez be a hozzáadásától, a Batch szolgáltatás megszünteti, és abban az állapotban hagyja, amiben az adott állapotban volt.

deallocateNode(string, string, DeallocateNodeOptionalParams)

A számítási csomópontot csak akkor szabadíthatja fel, ha inaktív vagy futó állapotban van.

deleteJob(string, DeleteJobOptionalParams)

Egy Job törlése minden feladatot törlik, amelyek ehhez a feladathoz tartoznak, valamint az összes Job statisztikát is. Ez felülírja a feladatadatok megőrzési idejét is; vagyis ha a Feladat tartalmaz olyan feladatokat, amelyek még megmaradnak a Compute Node-okon, a Batch szolgáltatások törli ezeknek a feladatoknak a munkakönyvtárait és minden tartalmát. Amikor Törlési Feladatkérés érkezik, a Batch szolgáltatás a Feladatot a törlési állapotra állítja. Minden frissítési művelet egy törlési állapotban lévő Feladaton meghibásodik 409 (Konfliktus) állapotkóddal, további információk pedig jelezik, hogy a Feladatot törölik.

deleteJobSchedule(string, DeleteJobScheduleOptionalParams)

Feladatütemezés törlésekor ez az ütemezés alatt lévő összes feladatot és feladatot is törli. A feladatok törlésekor a számítási csomópontok munkakönyvtáraiban lévő összes fájl is törlődik (a megőrzési időtartam figyelmen kívül lesz hagyva). A feladatütemezés statisztikái már nem érhetők el a feladatütemezés törlése után, bár továbbra is beleszámítanak a fiók élettartam-statisztikáiba.

deleteNodeFile(string, string, string, DeleteNodeFileOptionalParams)

Törli a megadott fájlt a számítási csomópontról.

deleteNodeUser(string, string, string, DeleteNodeUserOptionalParams)

Felhasználói fiókot csak akkor törölhet a számítási csomópontra, ha inaktív vagy futó állapotban van. Mielőtt távolról bejelentkezhetnél egy Compute Node-ba, be kell állítanod az SSH és RDP hozzáférési portokat. További információért, lásd: https://learn.microsoft.com/azure/batch/pool-endpoint-configuration

deletePool(string, DeletePoolOptionalParams)

Amikor egy készlet törlését kéri, a következő műveletek történnek: a készlet állapota törlésre van beállítva; a készleten folyamatban lévő átméretezési műveletek leállnak; a Batch szolgáltatás elkezdi átméretezni a készletet nulla számítási csomópontra; a meglévő számítási csomópontokon futó tevékenységek leállnak és újra lekérdezhetők (mintha egy átméretezési készlet műveletet kértek volna az alapértelmezett ismételt lekérési beállítással); végül a rendszer eltávolítja a készletet a rendszerből. Mivel a futó feladatok újra le vannak kérdezve, a felhasználó újrafuttathatja ezeket a feladatokat úgy, hogy a feladatukat egy másik készletre frissíti. A feladatok ezután futtathatók az új készleten. Ha felül szeretné bírálni az újralekérdezési viselkedést, akkor a készlet törlése előtt kifejezetten az átméretezési készletet kell meghívnia, hogy a készletet nullára zsugorítsa. Ha törlési állapotban meghív egy Frissítés, Javítás vagy Törlés API-t egy készleten, az a 409-es HTTP-állapotkóddal és a PoolBeingDeleted hibakóddal meghiúsul.

deleteTask(string, string, DeleteTaskOptionalParams)

Egy tevékenység törlésekor a számítási csomópont könyvtárában lévő összes fájl is törlődik (a megőrzési időtől függetlenül). Többpéldányos feladatok esetén a tevékenység törlése művelet szinkron módon vonatkozik az elsődleges tevékenységre; az altevékenységek és fájljaik ezután aszinkron módon törlődnek a háttérben.

deleteTaskFile(string, string, string, DeleteTaskFileOptionalParams)

Törli a megadott tevékenységfájlt abból a számítási csomópontból, ahol a tevékenység futott.

disableJob(string, BatchJobDisableOptions, DisableJobOptionalParams)

A Batch Service azonnal áthelyezi a Munkát letiltó állapotba. Ezután a Batch a disableTasks paramétert használja annak meghatározására, mit tegyen a jelenleg futó Feladatokkal a feladattal. A Feladat letiltó állapotban marad, amíg a kikapcsolás művelet be nem fejeződik, és az összes feladatot a disableTasks opció szerint el nem intézték; ezután a Munka a fogyatékos állapotba kerül. A Feladat alatt nem indulnak új feladatok, amíg vissza nem tér aktív állapotba. Ha megpróbálsz letiltani egy olyan feladatot, ami más állapotban van, nem aktív, letiltott vagy kikapcsolva, a kérés meghibásodik a 409-es állapotkóddal.

disableJobSchedule(string, DisableJobScheduleOptionalParams)

A feladatütemezés ismételt engedélyezéséig nem jön létre új feladat.

disableNodeScheduling(string, string, DisableNodeSchedulingOptionalParams)

A Compute Node-on csak akkor lehet kikapcsolni a feladat ütemezését, ha a jelenlegi ütemezési állapota engedélyezve.

disablePoolAutoScale(string, DisablePoolAutoScaleOptionalParams)

Letiltja a készlet automatikus skálázását.

enableJob(string, EnableJobOptionalParams)

Amikor ezt az API-t hívod, a Batch szolgáltatás egy letiltott Feladatot állít be az engedélyező állapotba. Miután ez a művelet befejeződött, a Feladat aktív állapotba kerül, és folytatódik az új Feladatok ütemezése a Feladat alatt. A Batch szolgáltatás nem engedi, hogy egy Feladat 180 napnál tovább aktív állapotban maradjon. Ezért, ha engedélyezed egy olyan Feladatot, amely több mint 180 napja hozzáadott aktív feladatokat tartalmaz, azok a feladatok nem futnak el.

enableJobSchedule(string, EnableJobScheduleOptionalParams)

Feladatütemezés engedélyezése.

enableNodeScheduling(string, string, EnableNodeSchedulingOptionalParams)

A feladatok ütemezését csak akkor lehet engedélyezni egy Compute Node-on, ha a jelenlegi ütemezési állapota ki van tiltva

enablePoolAutoScale(string, BatchPoolEnableAutoScaleOptions, EnablePoolAutoScaleOptionalParams)

Ha a készleten átméretezési művelet van folyamatban, nem engedélyezheti az automatikus skálázást a készleten. Ha a készlet automatikus méretezése jelenleg le van tiltva, a kérés részeként meg kell adnia egy érvényes automatikus méretezési képletet. Ha a készlet automatikus méretezése már engedélyezve van, megadhat egy új automatikus skálázási képletet és/vagy egy új kiértékelési időközt. Ezt az API-t nem hívhatja meg 30 másodpercenként többször ugyanarra a készletre.

evaluatePoolAutoScale(string, BatchPoolEvaluateAutoScaleOptions, EvaluatePoolAutoScaleOptionalParams)

Ez az API elsősorban egy automatikus skálázási képlet ellenőrzésére szolgál, mivel egyszerűen visszaadja az eredményt anélkül, hogy a képletet a készletre alkalmazták volna. A készletnek engedélyeznie kell az automatikus skálázást egy képlet kiértékeléséhez.

getApplication(string, GetApplicationOptionalParams)

Ez a művelet csak azokat az alkalmazásokat és verziókat adják vissza, amelyek Compute Node-on elérhetők; vagyis használható csomaghivatkozásban. Az alkalmazásokról és verziókról adminisztrátori információkért az Azure portált vagy az Azure Resource Manager API-t használd.

getJob(string, GetJobOptionalParams)

Információt kap a megadott feladatról.

getJobSchedule(string, GetJobScheduleOptionalParams)

Információkat kap a megadott munkabeosztásról.

getJobTaskCounts(string, GetJobTaskCountsOptionalParams)

A tevékenységszám aktív, futó vagy befejezett tevékenységállapot, valamint a sikeres vagy sikertelen tevékenységek száma alapján adja meg a Tevékenységek számát. Az előkészítési állapotban lévő tevékenységek futásnak számítanak. Vegye figyelembe, hogy a visszaadott számok nem mindig naprakészek. Ha pontos feladatszámra van szüksége, használjon lista lekérdezést.

getNode(string, string, GetNodeOptionalParams)

Információt kap a megadott számítási csomópontról.

getNodeExtension(string, string, string, GetNodeExtensionOptionalParams)

Információt kap a megadott Compute Node Extensionről.

getNodeFile(string, string, string, GetNodeFileOptionalParams)

A megadott Compute Node fájl tartalmát adja vissza.

getNodeFileProperties(string, string, string, GetNodeFilePropertiesOptionalParams)

Lekéri a megadott számítási csomópont fájl tulajdonságait.

getNodeRemoteLoginSettings(string, string, GetNodeRemoteLoginSettingsOptionalParams)

Mielőtt távolról bejelentkezhetnél egy Compute Node-ba a távoli bejelentkezési beállításokkal, létre kell hoznod egy felhasználói fiókot a Compute Node-on, és be kell állítanod az SSH és RDP hozzáférési portjait. További információért, lásd: https://learn.microsoft.com/azure/batch/pool-endpoint-configuration

getPool(string, GetPoolOptionalParams)

Információt kap a megadott készletről.

getTask(string, string, GetTaskOptionalParams)

Többpéldányos feladatok esetén az olyan információk, mint az affinityId, executionInfo és nodeInfo, az elsődleges feladatra utalnak. Használd a lista alfeladatok API-ját, hogy információkat szerezz az alfeladatokról.

getTaskFile(string, string, string, GetTaskFileOptionalParams)

A megadott feladatfájl tartalmát adja vissza.

getTaskFileProperties(string, string, string, GetTaskFilePropertiesOptionalParams)

Lekéri a megadott feladatfájl tulajdonságait.

jobScheduleExists(string, JobScheduleExistsOptionalParams)

Ellenőrzi, hogy létezik-e a megadott munkaidőbeosztás.

listApplications(ListApplicationsOptionalParams)

Ez a művelet csak azokat az alkalmazásokat és verziókat adják vissza, amelyek Compute Node-on elérhetők; vagyis használható csomaghivatkozásban. Az alkalmazásokról és verziókról adminisztrátori információkért az Azure portált vagy az Azure Resource Manager API-t használjuk.

listJobPreparationAndReleaseTaskStatus(string, ListJobPreparationAndReleaseTaskStatusOptionalParams)

Ez az API a feladat-előkészítési és feladatkiadási feladat állapotát adja vissza az összes olyan számítási csomóponton, amely a feladat-előkészítési vagy a feladat-kiadási feladatot futtatja. Ide tartoznak azok a számítási csomópontok, amelyeket azóta eltávolítottak a készletből. Ha ezt az API-t olyan feladatra hívja meg, amely nem rendelkezik feladat-előkészítési vagy feladat-kiadási feladattal, a Batch szolgáltatás a 409-es HTTP-állapotkódot (ütközést) adja vissza a JobPreparationTaskNotSpecified hibakóddal.

listJobs(ListJobsOptionalParams)

Felsorolja az összes Állást a megadott fiókban.

listJobSchedules(ListJobSchedulesOptionalParams)

Felsorolja az összes Munkamenet-beosztást a megadott fiókban.

listJobsFromSchedule(string, ListJobsFromScheduleOptionalParams)

Felsorolja azokat a Munkákat, amelyeket a megadott Munkaidő-beosztás alatt hoztak létre.

listNodeExtensions(string, string, ListNodeExtensionsOptionalParams)

Felsorolja a Compute Nodes kiterjesztéseket a megadott Poolban.

listNodeFiles(string, string, ListNodeFilesOptionalParams)

A megadott számítási csomópont tevékenységkönyvtáraiban lévő összes fájlt listázza.

listNodes(string, ListNodesOptionalParams)

A megadott készlet számítási csomópontjait sorolja fel.

listPoolNodeCounts(ListPoolNodeCountsOptionalParams)

Lekéri az egyes állapotokban lévő számítási csomópontok számát készlet szerint csoportosítva. Vegye figyelembe, hogy a visszaadott számok nem mindig naprakészek. Ha pontos csomópontszámra van szüksége, használjon lista lekérdezést.

listPools(ListPoolsOptionalParams)

A megadott fiók összes készletét listázza.

listPoolUsageMetrics(ListPoolUsageMetricsOptionalParams)

Ha nem ad meg $filter záradékot, beleértve a készletazonosítót is, a válasz tartalmazza a fiókban meglévő összes készletet a visszaadott összesítési intervallumok időtartományában. Ha nem ad meg $filter záradékot, beleértve a startTime-ot vagy az endTime-ot, ezek a szűrők alapértelmezés szerint az aktuálisan elérhető utolsó összesítési időköz kezdő és befejező időpontjaira vannak beszűkülve; vagyis csak az utolsó összesítési időköz lesz visszaadva.

listSubTasks(string, string, ListSubTasksOptionalParams)

Ha a tevékenység nem többpéldányos tevékenység, akkor ez egy üres gyűjteményt ad vissza.

listSupportedImages(ListSupportedImagesOptionalParams)

A Azure Batch szolgáltatás által támogatott összes virtuálisgép-rendszerképet felsorolja.

listTaskFiles(string, string, ListTaskFilesOptionalParams)

Egy tevékenység könyvtárában lévő fájlokat sorolja fel a számítási csomóponton.

listTasks(string, ListTasksOptionalParams)

Többpéldányos feladatok esetén az olyan információk, mint az affinityId, executionInfo és nodeInfo, az elsődleges feladatra utalnak. Használd a lista alfeladatok API-ját, hogy információkat szerezz az alfeladatokról.

poolExists(string, PoolExistsOptionalParams)

Megkapja a Pool alapvető tulajdonságait.

reactivateTask(string, string, ReactivateTaskOptionalParams)

Az újraaktiválás lehetővé teszi egy tevékenység újrapróbálkozását a maximális újrapróbálkozási számig. A tevékenység állapota aktívra módosul. Mivel a tevékenység már nincs befejezve, a korábbi kilépési kód- vagy hibainformációk már nem érhetők el az újraaktiválás után. Minden alkalommal, amikor egy tevékenységet újraaktiválnak, az újrapróbálkozásainak száma 0-ra lesz visszaállítva. Az újraaktiválás sikertelen lesz a nem befejezett vagy korábban sikeresen befejezett feladatok esetében (0-s kilépési kóddal). Emellett sikertelen lesz, ha a feladat befejeződött (vagy leáll vagy töröl).

rebootNode(string, string, RebootNodeOptionalParams)

A számítási csomópontot csak akkor lehet újraindítani, ha inaktív vagy futó állapotban van.

reimageNode(string, string, ReimageNodeOptionalParams)

Az operációs rendszert csak akkor telepítheti újra egy számítási csomóponton, ha inaktív vagy futó állapotban van. Ez az API csak a felhőszolgáltatás konfigurációs tulajdonsággal létrehozott poolokon hívható meg.

removeNodes(string, BatchNodeRemoveOptions, RemoveNodesOptionalParams)

Ez a művelet csak akkor futtatható, ha a készlet foglalási állapota állandó. A művelet futtatásakor a foglalási állapot állandóról átméretezésre változik. Minden kérés legfeljebb 100 csomópontot távolíthat el.

replaceJob(string, BatchJob, ReplaceJobOptionalParams)

Ez teljesen felváltja a Job összes frissíthető tulajdonságát. Például, ha a feladathoz vannak kötvények, és ha ezek a kérés nem határozzák meg, akkor a Batch szolgáltatás eltávolítja a meglévő korlátozásokat.

replaceJobSchedule(string, BatchJobSchedule, ReplaceJobScheduleOptionalParams)

Ez teljesen lecseréli a Munkaidőrend összes frissíthető tulajdonságát. Például, ha az ütemezés tulajdonsága nincs megadva ezzel a kéréssel, akkor a Batch szolgáltatás eltávolítja a meglévő ütemezést. A Munkaidő-ütemterv változásai csak az átosztás által létrehozott munkákat érintik a frissítés után; a jelenleg működő munkahelyek érintetlenek.

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

Ez a művelet kiváltja a számla összes frissíthető tulajdonságát. Például, ha az expiryTime elem nincs megadva, a jelenlegi értéket az alapértelmezett értékre cserélik, nem hagyják megváltoztatva. Egy Compute Node-on csak akkor frissítheted a felhasználói fiókot, ha az tétlen vagy futó állapotban van.

replacePoolProperties(string, BatchPoolReplaceOptions, ReplacePoolPropertiesOptionalParams)

Ez teljesen felváltja a Pool összes frissíthető tulajdonságát. Például, ha a Poolhoz tartozik egy StartTask, és ha a StartTask nincs megadva ezzel a kéréssel, akkor a Batch szolgáltatás eltávolítja a meglévő StartTask-et.

replaceTask(string, string, BatchTask, ReplaceTaskOptionalParams)

Frissíti a megadott feladat tulajdonságait.

resizePool(string, BatchPoolResizeOptions, ResizePoolOptionalParams)

A készletet csak akkor méretezheti át, ha a foglalási állapota állandó. Ha a készlet már átméretezve van, a kérés a 409-ben megadott állapotkóddal meghiúsul. Amikor átméretez egy készletet, a készlet foglalási állapota állandóról átméretezésre változik. Az automatikus skálázáshoz konfigurált készletek nem méretezhetők át. Ha megpróbálja ezt megtenni, a Batch szolgáltatás 409-et ad vissza. Ha lefelé méretez át egy készletet, a Batch szolgáltatás kiválasztja az eltávolítani kívánt számítási csomópontokat. Adott számítási csomópontok eltávolításához használja a készletben a Compute Nodes API eltávolítását.

startNode(string, string, StartNodeOptionalParams)

Compute Node-ot csak akkor indíthatsz el, ha már leosztották.

stopPoolResize(string, StopPoolResizeOptionalParams)

Ez nem állítja vissza a Pool korábbi állapotát a méretátalakítás előtt: csak a további változtatásokat állítja meg, és a Pool megtartja jelenlegi állapotát. Megállás után a Pool stabilizálódik a Számítási Csomópontok számán, ahol a megállítás során volt. A megállítás során a Pool allokációs állapota először megállásra, majd stabilra változik. Egy méretváltoztatási műveletnek nem kell explicit Pool újraméretezési kérésnek lennie; ez az API arra is használható, hogy megállítsa a Pool eredeti méretezését a létrehozáskor.

terminateJob(string, TerminateJobOptionalParams)

Amikor megérkezik a Feladat megszüntetése kérése, a Batch szolgáltatás a Feladatot a lezáró állapotra állítja be. A Batch szolgáltatás ezután megszünteti a feladathoz kapcsolódó összes futó feladatot, és lefuttatja a szükséges Feladatkiadó feladatokat. Ezután a Feladat a befejezett állapotba kerül. Ha aktív állapotban vannak a Feladatok, akkor aktív állapotban maradnak. Ha egy Job megszűnt, új Feladatokat nem lehet hozzáadni, és a maradék aktív Feladatok nem lesznek ütemezve.

terminateJobSchedule(string, TerminateJobScheduleOptionalParams)

Leállítja a feladatütemezést.

terminateTask(string, string, TerminateTaskOptionalParams)

Amikor a tevékenység leállt, az a befejezett állapotba kerül. Többpéldányos tevékenységek esetén a feladat leállítási művelete szinkron módon vonatkozik az elsődleges tevékenységre; az altevékenységek ezután aszinkron módon leállnak a háttérben.

updateJob(string, BatchJobUpdateOptions, UpdateJobOptionalParams)

Ez csak a kérésben megadott Job tulajdonságokat váltja fel. Például, ha a Feladatnak vannak korlátai, és egy kérés nem határozza meg a korlátokat, akkor a Feladat megtartja a meglévő korlátokat.

updateJobSchedule(string, BatchJobScheduleUpdateOptions, UpdateJobScheduleOptionalParams)

Ez csak a kérésben megadott Job Schedule tulajdonságokat helyettesíti. Például, ha az ütemezés tulajdonsága nincs megadva ezzel a kéréssel, akkor a Batch szolgáltatás megtartja a meglévő ütemezést. A Munkaidő-ütemterv változásai csak az átosztás által létrehozott munkákat érintik a frissítés után; a jelenleg működő munkahelyek érintetlenek.

updatePool(string, BatchPoolUpdateOptions, UpdatePoolOptionalParams)

Ez csak a kérésben megadott Pool tulajdonságokat helyettesíti. Például, ha a Poolhoz tartozik egy StartTask, és egy kérés nem határoz meg StartTask elemet, akkor a Pool megtartja a meglévő StartTask-et.

uploadNodeLogs(string, string, UploadBatchServiceLogsOptions, UploadNodeLogsOptionalParams)

Ez arra szolgál, hogy automatizált módon gyűjtsd össze Azure Batch szolgáltatási naplófájlokat a Compute Nodes-ból, ha hibát tapasztalsz, és szeretnél az Azure támogatáshoz fordulni. A Azure Batch szolgáltatás naplófájljait meg kell osztani Azure-támogatás a Batch szolgáltatással kapcsolatos hibakeresési problémák megoldásához.

Konstruktor adatai

BatchClient(string, TokenCredential | AzureNamedKeyCredential, BatchClientOptionalParams)

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

Paraméterek

endpointParam

string

Metódus adatai

createJob(BatchJobCreateOptions, CreateJobOptionalParams)

A Batch szolgáltatás kétféle módon irányítja a munkát, amelyet a Munka részeként végeznek. Az első megközelítésben a felhasználó egy Job Manager feladatot határoz meg. A Batch szolgáltatás akkor indítja el ezt a Feladatot, amikor készen áll a Feladat elindítására. A Feladatkezelő Feladat irányítja az összes többi feladatot, amely ezen a Feladaton fut, a Feladat API-k segítségével. A második megközelítésben a felhasználó közvetlenül irányítja a feladatok végrehajtását egy aktív Feladat alatt, a Feladat API-k segítségével. Fontos megjegyezni: Jobs-nevekor kerüld az érzékeny információk, például felhasználónevek vagy titkos projektnevek bevonását. Ezek az információk megjelenhetnek a Microsoft ügyfélszolgálata mérnökei számára elérhető telemetriai naplókban.

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

Paraméterek

Válaszok

Promise<void>

createJobSchedule(BatchJobScheduleCreateOptions, CreateJobScheduleOptionalParams)

Létrehoz egy Munkamenetrendet a megadott fiókhoz.

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

Paraméterek

Válaszok

Promise<void>

createNodeUser(string, string, BatchNodeUserCreateOptions, CreateNodeUserOptionalParams)

Felhasználói fiókot csak akkor adhatsz hozzá egy Compute Node-hoz, ha az tétlen vagy futó állapotban van. Mielőtt távolról bejelentkezhetnél egy Compute Node-ba, be kell állítanod az SSH és RDP hozzáférési portokat. További információért, lásd: https://learn.microsoft.com/azure/batch/pool-endpoint-configuration

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

Paraméterek

poolId

string

nodeId

string

Válaszok

Promise<void>

createPool(BatchPoolCreateOptions, CreatePoolOptionalParams)

A készletek elnevezésekor kerülje a bizalmas adatok, például a felhasználónevek vagy a titkos projektnevek használatát. Ezek az információk megjelenhetnek a Microsoft ügyfélszolgálata mérnökei számára elérhető telemetriai naplókban.

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

Paraméterek

Válaszok

Promise<void>

createTask(string, BatchTaskCreateOptions, CreateTaskOptionalParams)

Egy feladat maximális élettartama a kiegészítéstől a befejezésig 180 nap. Ha egy feladat 180 napon belül nem fejez be a hozzáadásától, a Batch szolgáltatás megszünteti, és abban az állapotban hagyja, amiben az adott állapotban volt.

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

Paraméterek

jobId

string

Válaszok

Promise<void>

createTaskCollection(string, BatchTaskGroup, CreateTaskCollectionOptionalParams)

Fontos megjegyezni, hogy minden feladatnak egyedi azonosítóval kell rendelkeznie. A Batch szolgáltatás nem térhet vissza minden feladat eredményeit ugyanabban a sorrendben, ahogy a feladatokat ebben a kérésben benyújtották. Ha a szerver időkorlátot kap vagy a kapcsolat lezáródik a kérés során, a kérés részben vagy teljes egészében feldolgozódhat, vagy egyáltalán nem történt. Ilyen esetekben a felhasználónak újra kell kiküldenie a kérést. Fontos megjegyezni, hogy a felhasználó feladata, hogy helyesen kezelje a hibákat a kérés újraküldésekor. Például ugyanazokat a Feladatazonosítókat kell használni egy újrapróbálkozás során, hogy ha az előző művelet sikeres volt, az újrapróbálkozás ne hozzon létre váratlanul plusz feladatokat. Ha a válasz tartalmaz olyan feladatokat, amelyeket nem sikerült hozzáadni, egy kliens újra megpróbálhatja a kérést. Újrapróbálkozás esetén a leghatékonyabb, ha csak azokat a feladatokat küldjük újra, amelyek nem adtak össze, és kihagyják azokat a feladatokat, amelyeket az első próbálkozáskor sikeresen hozzáadtak. Egy feladat maximális élettartama a kiegészítéstől a befejezésig 180 nap. Ha egy feladat 180 napon belül nem fejez be a hozzáadásától, a Batch szolgáltatás megszünteti, és abban az állapotban hagyja, amiben az adott állapotban volt.

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

Paraméterek

jobId

string

taskCollection
BatchTaskGroup

Válaszok

deallocateNode(string, string, DeallocateNodeOptionalParams)

A számítási csomópontot csak akkor szabadíthatja fel, ha inaktív vagy futó állapotban van.

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

Paraméterek

poolId

string

nodeId

string

Válaszok

PollerLike<OperationState<void>, void>

deleteJob(string, DeleteJobOptionalParams)

Egy Job törlése minden feladatot törlik, amelyek ehhez a feladathoz tartoznak, valamint az összes Job statisztikát is. Ez felülírja a feladatadatok megőrzési idejét is; vagyis ha a Feladat tartalmaz olyan feladatokat, amelyek még megmaradnak a Compute Node-okon, a Batch szolgáltatások törli ezeknek a feladatoknak a munkakönyvtárait és minden tartalmát. Amikor Törlési Feladatkérés érkezik, a Batch szolgáltatás a Feladatot a törlési állapotra állítja. Minden frissítési művelet egy törlési állapotban lévő Feladaton meghibásodik 409 (Konfliktus) állapotkóddal, további információk pedig jelezik, hogy a Feladatot törölik.

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

Paraméterek

jobId

string

Válaszok

PollerLike<OperationState<void>, void>

deleteJobSchedule(string, DeleteJobScheduleOptionalParams)

Feladatütemezés törlésekor ez az ütemezés alatt lévő összes feladatot és feladatot is törli. A feladatok törlésekor a számítási csomópontok munkakönyvtáraiban lévő összes fájl is törlődik (a megőrzési időtartam figyelmen kívül lesz hagyva). A feladatütemezés statisztikái már nem érhetők el a feladatütemezés törlése után, bár továbbra is beleszámítanak a fiók élettartam-statisztikáiba.

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

Paraméterek

jobScheduleId

string

Válaszok

PollerLike<OperationState<void>, void>

deleteNodeFile(string, string, string, DeleteNodeFileOptionalParams)

Törli a megadott fájlt a számítási csomópontról.

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

Paraméterek

poolId

string

nodeId

string

filePath

string

Válaszok

Promise<void>

deleteNodeUser(string, string, string, DeleteNodeUserOptionalParams)

Felhasználói fiókot csak akkor törölhet a számítási csomópontra, ha inaktív vagy futó állapotban van. Mielőtt távolról bejelentkezhetnél egy Compute Node-ba, be kell állítanod az SSH és RDP hozzáférési portokat. További információért, lásd: https://learn.microsoft.com/azure/batch/pool-endpoint-configuration

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

Paraméterek

poolId

string

nodeId

string

userName

string

Válaszok

Promise<void>

deletePool(string, DeletePoolOptionalParams)

Amikor egy készlet törlését kéri, a következő műveletek történnek: a készlet állapota törlésre van beállítva; a készleten folyamatban lévő átméretezési műveletek leállnak; a Batch szolgáltatás elkezdi átméretezni a készletet nulla számítási csomópontra; a meglévő számítási csomópontokon futó tevékenységek leállnak és újra lekérdezhetők (mintha egy átméretezési készlet műveletet kértek volna az alapértelmezett ismételt lekérési beállítással); végül a rendszer eltávolítja a készletet a rendszerből. Mivel a futó feladatok újra le vannak kérdezve, a felhasználó újrafuttathatja ezeket a feladatokat úgy, hogy a feladatukat egy másik készletre frissíti. A feladatok ezután futtathatók az új készleten. Ha felül szeretné bírálni az újralekérdezési viselkedést, akkor a készlet törlése előtt kifejezetten az átméretezési készletet kell meghívnia, hogy a készletet nullára zsugorítsa. Ha törlési állapotban meghív egy Frissítés, Javítás vagy Törlés API-t egy készleten, az a 409-es HTTP-állapotkóddal és a PoolBeingDeleted hibakóddal meghiúsul.

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

Paraméterek

poolId

string

Válaszok

PollerLike<OperationState<void>, void>

deleteTask(string, string, DeleteTaskOptionalParams)

Egy tevékenység törlésekor a számítási csomópont könyvtárában lévő összes fájl is törlődik (a megőrzési időtől függetlenül). Többpéldányos feladatok esetén a tevékenység törlése művelet szinkron módon vonatkozik az elsődleges tevékenységre; az altevékenységek és fájljaik ezután aszinkron módon törlődnek a háttérben.

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

Paraméterek

jobId

string

taskId

string

Válaszok

Promise<void>

deleteTaskFile(string, string, string, DeleteTaskFileOptionalParams)

Törli a megadott tevékenységfájlt abból a számítási csomópontból, ahol a tevékenység futott.

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

Paraméterek

jobId

string

taskId

string

filePath

string

Válaszok

Promise<void>

disableJob(string, BatchJobDisableOptions, DisableJobOptionalParams)

A Batch Service azonnal áthelyezi a Munkát letiltó állapotba. Ezután a Batch a disableTasks paramétert használja annak meghatározására, mit tegyen a jelenleg futó Feladatokkal a feladattal. A Feladat letiltó állapotban marad, amíg a kikapcsolás művelet be nem fejeződik, és az összes feladatot a disableTasks opció szerint el nem intézték; ezután a Munka a fogyatékos állapotba kerül. A Feladat alatt nem indulnak új feladatok, amíg vissza nem tér aktív állapotba. Ha megpróbálsz letiltani egy olyan feladatot, ami más állapotban van, nem aktív, letiltott vagy kikapcsolva, a kérés meghibásodik a 409-es állapotkóddal.

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

Paraméterek

jobId

string

disableOptions
BatchJobDisableOptions

Válaszok

PollerLike<OperationState<void>, void>

disableJobSchedule(string, DisableJobScheduleOptionalParams)

A feladatütemezés ismételt engedélyezéséig nem jön létre új feladat.

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

Paraméterek

jobScheduleId

string

Válaszok

Promise<void>

disableNodeScheduling(string, string, DisableNodeSchedulingOptionalParams)

A Compute Node-on csak akkor lehet kikapcsolni a feladat ütemezését, ha a jelenlegi ütemezési állapota engedélyezve.

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

Paraméterek

poolId

string

nodeId

string

Válaszok

Promise<void>

disablePoolAutoScale(string, DisablePoolAutoScaleOptionalParams)

Letiltja a készlet automatikus skálázását.

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

Paraméterek

poolId

string

Válaszok

Promise<void>

enableJob(string, EnableJobOptionalParams)

Amikor ezt az API-t hívod, a Batch szolgáltatás egy letiltott Feladatot állít be az engedélyező állapotba. Miután ez a művelet befejeződött, a Feladat aktív állapotba kerül, és folytatódik az új Feladatok ütemezése a Feladat alatt. A Batch szolgáltatás nem engedi, hogy egy Feladat 180 napnál tovább aktív állapotban maradjon. Ezért, ha engedélyezed egy olyan Feladatot, amely több mint 180 napja hozzáadott aktív feladatokat tartalmaz, azok a feladatok nem futnak el.

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

Paraméterek

jobId

string

Válaszok

PollerLike<OperationState<void>, void>

enableJobSchedule(string, EnableJobScheduleOptionalParams)

Feladatütemezés engedélyezése.

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

Paraméterek

jobScheduleId

string

Válaszok

Promise<void>

enableNodeScheduling(string, string, EnableNodeSchedulingOptionalParams)

A feladatok ütemezését csak akkor lehet engedélyezni egy Compute Node-on, ha a jelenlegi ütemezési állapota ki van tiltva

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

Paraméterek

poolId

string

nodeId

string

Válaszok

Promise<void>

enablePoolAutoScale(string, BatchPoolEnableAutoScaleOptions, EnablePoolAutoScaleOptionalParams)

Ha a készleten átméretezési művelet van folyamatban, nem engedélyezheti az automatikus skálázást a készleten. Ha a készlet automatikus méretezése jelenleg le van tiltva, a kérés részeként meg kell adnia egy érvényes automatikus méretezési képletet. Ha a készlet automatikus méretezése már engedélyezve van, megadhat egy új automatikus skálázási képletet és/vagy egy új kiértékelési időközt. Ezt az API-t nem hívhatja meg 30 másodpercenként többször ugyanarra a készletre.

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

Paraméterek

poolId

string

enableAutoScaleOptions
BatchPoolEnableAutoScaleOptions

Válaszok

Promise<void>

evaluatePoolAutoScale(string, BatchPoolEvaluateAutoScaleOptions, EvaluatePoolAutoScaleOptionalParams)

Ez az API elsősorban egy automatikus skálázási képlet ellenőrzésére szolgál, mivel egyszerűen visszaadja az eredményt anélkül, hogy a képletet a készletre alkalmazták volna. A készletnek engedélyeznie kell az automatikus skálázást egy képlet kiértékeléséhez.

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

Paraméterek

poolId

string

evaluateAutoScaleOptions
BatchPoolEvaluateAutoScaleOptions

Válaszok

Promise<AutoScaleRun>

getApplication(string, GetApplicationOptionalParams)

Ez a művelet csak azokat az alkalmazásokat és verziókat adják vissza, amelyek Compute Node-on elérhetők; vagyis használható csomaghivatkozásban. Az alkalmazásokról és verziókról adminisztrátori információkért az Azure portált vagy az Azure Resource Manager API-t használd.

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

Paraméterek

applicationId

string

Válaszok

Promise<BatchApplication>

getJob(string, GetJobOptionalParams)

Információt kap a megadott feladatról.

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

Paraméterek

jobId

string

Válaszok

Promise<BatchJob>

getJobSchedule(string, GetJobScheduleOptionalParams)

Információkat kap a megadott munkabeosztásról.

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

Paraméterek

jobScheduleId

string

Válaszok

Promise<BatchJobSchedule>

getJobTaskCounts(string, GetJobTaskCountsOptionalParams)

A tevékenységszám aktív, futó vagy befejezett tevékenységállapot, valamint a sikeres vagy sikertelen tevékenységek száma alapján adja meg a Tevékenységek számát. Az előkészítési állapotban lévő tevékenységek futásnak számítanak. Vegye figyelembe, hogy a visszaadott számok nem mindig naprakészek. Ha pontos feladatszámra van szüksége, használjon lista lekérdezést.

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

Paraméterek

jobId

string

Válaszok

getNode(string, string, GetNodeOptionalParams)

Információt kap a megadott számítási csomópontról.

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

Paraméterek

poolId

string

nodeId

string

Válaszok

Promise<BatchNode>

getNodeExtension(string, string, string, GetNodeExtensionOptionalParams)

Információt kap a megadott Compute Node Extensionről.

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

Paraméterek

poolId

string

nodeId

string

extensionName

string

Válaszok

getNodeFile(string, string, string, GetNodeFileOptionalParams)

A megadott Compute Node fájl tartalmát adja vissza.

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

Paraméterek

poolId

string

nodeId

string

filePath

string

Válaszok

Promise<Uint8Array>

getNodeFileProperties(string, string, string, GetNodeFilePropertiesOptionalParams)

Lekéri a megadott számítási csomópont fájl tulajdonságait.

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

Paraméterek

poolId

string

nodeId

string

filePath

string

Válaszok

Promise<BatchNodeFile>

getNodeRemoteLoginSettings(string, string, GetNodeRemoteLoginSettingsOptionalParams)

Mielőtt távolról bejelentkezhetnél egy Compute Node-ba a távoli bejelentkezési beállításokkal, létre kell hoznod egy felhasználói fiókot a Compute Node-on, és be kell állítanod az SSH és RDP hozzáférési portjait. További információért, lásd: https://learn.microsoft.com/azure/batch/pool-endpoint-configuration

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

Paraméterek

poolId

string

nodeId

string

Válaszok

getPool(string, GetPoolOptionalParams)

Információt kap a megadott készletről.

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

Paraméterek

poolId

string

Válaszok

Promise<BatchPool>

getTask(string, string, GetTaskOptionalParams)

Többpéldányos feladatok esetén az olyan információk, mint az affinityId, executionInfo és nodeInfo, az elsődleges feladatra utalnak. Használd a lista alfeladatok API-ját, hogy információkat szerezz az alfeladatokról.

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

Paraméterek

jobId

string

taskId

string

Válaszok

Promise<BatchTask>

getTaskFile(string, string, string, GetTaskFileOptionalParams)

A megadott feladatfájl tartalmát adja vissza.

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

Paraméterek

jobId

string

taskId

string

filePath

string

Válaszok

Promise<Uint8Array>

getTaskFileProperties(string, string, string, GetTaskFilePropertiesOptionalParams)

Lekéri a megadott feladatfájl tulajdonságait.

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

Paraméterek

jobId

string

taskId

string

filePath

string

Válaszok

Promise<BatchNodeFile>

jobScheduleExists(string, JobScheduleExistsOptionalParams)

Ellenőrzi, hogy létezik-e a megadott munkaidőbeosztás.

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

Paraméterek

jobScheduleId

string

Válaszok

Promise<boolean>

listApplications(ListApplicationsOptionalParams)

Ez a művelet csak azokat az alkalmazásokat és verziókat adják vissza, amelyek Compute Node-on elérhetők; vagyis használható csomaghivatkozásban. Az alkalmazásokról és verziókról adminisztrátori információkért az Azure portált vagy az Azure Resource Manager API-t használjuk.

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

Paraméterek

Válaszok

listJobPreparationAndReleaseTaskStatus(string, ListJobPreparationAndReleaseTaskStatusOptionalParams)

Ez az API a feladat-előkészítési és feladatkiadási feladat állapotát adja vissza az összes olyan számítási csomóponton, amely a feladat-előkészítési vagy a feladat-kiadási feladatot futtatja. Ide tartoznak azok a számítási csomópontok, amelyeket azóta eltávolítottak a készletből. Ha ezt az API-t olyan feladatra hívja meg, amely nem rendelkezik feladat-előkészítési vagy feladat-kiadási feladattal, a Batch szolgáltatás a 409-es HTTP-állapotkódot (ütközést) adja vissza a JobPreparationTaskNotSpecified hibakóddal.

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

Paraméterek

jobId

string

Válaszok

listJobs(ListJobsOptionalParams)

Felsorolja az összes Állást a megadott fiókban.

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

Paraméterek

Válaszok

listJobSchedules(ListJobSchedulesOptionalParams)

Felsorolja az összes Munkamenet-beosztást a megadott fiókban.

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

Paraméterek

Válaszok

listJobsFromSchedule(string, ListJobsFromScheduleOptionalParams)

Felsorolja azokat a Munkákat, amelyeket a megadott Munkaidő-beosztás alatt hoztak létre.

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

Paraméterek

jobScheduleId

string

Válaszok

listNodeExtensions(string, string, ListNodeExtensionsOptionalParams)

Felsorolja a Compute Nodes kiterjesztéseket a megadott Poolban.

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

Paraméterek

poolId

string

nodeId

string

Válaszok

listNodeFiles(string, string, ListNodeFilesOptionalParams)

A megadott számítási csomópont tevékenységkönyvtáraiban lévő összes fájlt listázza.

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

Paraméterek

poolId

string

nodeId

string

Válaszok

listNodes(string, ListNodesOptionalParams)

A megadott készlet számítási csomópontjait sorolja fel.

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

Paraméterek

poolId

string

Válaszok

listPoolNodeCounts(ListPoolNodeCountsOptionalParams)

Lekéri az egyes állapotokban lévő számítási csomópontok számát készlet szerint csoportosítva. Vegye figyelembe, hogy a visszaadott számok nem mindig naprakészek. Ha pontos csomópontszámra van szüksége, használjon lista lekérdezést.

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

Paraméterek

Válaszok

listPools(ListPoolsOptionalParams)

A megadott fiók összes készletét listázza.

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

Paraméterek

Válaszok

listPoolUsageMetrics(ListPoolUsageMetricsOptionalParams)

Ha nem ad meg $filter záradékot, beleértve a készletazonosítót is, a válasz tartalmazza a fiókban meglévő összes készletet a visszaadott összesítési intervallumok időtartományában. Ha nem ad meg $filter záradékot, beleértve a startTime-ot vagy az endTime-ot, ezek a szűrők alapértelmezés szerint az aktuálisan elérhető utolsó összesítési időköz kezdő és befejező időpontjaira vannak beszűkülve; vagyis csak az utolsó összesítési időköz lesz visszaadva.

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

Paraméterek

Válaszok

listSubTasks(string, string, ListSubTasksOptionalParams)

Ha a tevékenység nem többpéldányos tevékenység, akkor ez egy üres gyűjteményt ad vissza.

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

Paraméterek

jobId

string

taskId

string

Válaszok

listSupportedImages(ListSupportedImagesOptionalParams)

A Azure Batch szolgáltatás által támogatott összes virtuálisgép-rendszerképet felsorolja.

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

Paraméterek

Válaszok

listTaskFiles(string, string, ListTaskFilesOptionalParams)

Egy tevékenység könyvtárában lévő fájlokat sorolja fel a számítási csomóponton.

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

Paraméterek

jobId

string

taskId

string

Válaszok

listTasks(string, ListTasksOptionalParams)

Többpéldányos feladatok esetén az olyan információk, mint az affinityId, executionInfo és nodeInfo, az elsődleges feladatra utalnak. Használd a lista alfeladatok API-ját, hogy információkat szerezz az alfeladatokról.

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

Paraméterek

jobId

string

Válaszok

poolExists(string, PoolExistsOptionalParams)

Megkapja a Pool alapvető tulajdonságait.

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

Paraméterek

poolId

string

Válaszok

Promise<boolean>

reactivateTask(string, string, ReactivateTaskOptionalParams)

Az újraaktiválás lehetővé teszi egy tevékenység újrapróbálkozását a maximális újrapróbálkozási számig. A tevékenység állapota aktívra módosul. Mivel a tevékenység már nincs befejezve, a korábbi kilépési kód- vagy hibainformációk már nem érhetők el az újraaktiválás után. Minden alkalommal, amikor egy tevékenységet újraaktiválnak, az újrapróbálkozásainak száma 0-ra lesz visszaállítva. Az újraaktiválás sikertelen lesz a nem befejezett vagy korábban sikeresen befejezett feladatok esetében (0-s kilépési kóddal). Emellett sikertelen lesz, ha a feladat befejeződött (vagy leáll vagy töröl).

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

Paraméterek

jobId

string

taskId

string

Válaszok

Promise<void>

rebootNode(string, string, RebootNodeOptionalParams)

A számítási csomópontot csak akkor lehet újraindítani, ha inaktív vagy futó állapotban van.

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

Paraméterek

poolId

string

nodeId

string

Válaszok

PollerLike<OperationState<void>, void>

reimageNode(string, string, ReimageNodeOptionalParams)

Az operációs rendszert csak akkor telepítheti újra egy számítási csomóponton, ha inaktív vagy futó állapotban van. Ez az API csak a felhőszolgáltatás konfigurációs tulajdonsággal létrehozott poolokon hívható meg.

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

Paraméterek

poolId

string

nodeId

string

Válaszok

PollerLike<OperationState<void>, void>

removeNodes(string, BatchNodeRemoveOptions, RemoveNodesOptionalParams)

Ez a művelet csak akkor futtatható, ha a készlet foglalási állapota állandó. A művelet futtatásakor a foglalási állapot állandóról átméretezésre változik. Minden kérés legfeljebb 100 csomópontot távolíthat el.

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

Paraméterek

poolId

string

removeOptions
BatchNodeRemoveOptions

Válaszok

PollerLike<OperationState<void>, void>

replaceJob(string, BatchJob, ReplaceJobOptionalParams)

Ez teljesen felváltja a Job összes frissíthető tulajdonságát. Például, ha a feladathoz vannak kötvények, és ha ezek a kérés nem határozzák meg, akkor a Batch szolgáltatás eltávolítja a meglévő korlátozásokat.

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

Paraméterek

jobId

string

job
BatchJob

Válaszok

Promise<void>

replaceJobSchedule(string, BatchJobSchedule, ReplaceJobScheduleOptionalParams)

Ez teljesen lecseréli a Munkaidőrend összes frissíthető tulajdonságát. Például, ha az ütemezés tulajdonsága nincs megadva ezzel a kéréssel, akkor a Batch szolgáltatás eltávolítja a meglévő ütemezést. A Munkaidő-ütemterv változásai csak az átosztás által létrehozott munkákat érintik a frissítés után; a jelenleg működő munkahelyek érintetlenek.

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

Paraméterek

jobScheduleId

string

jobSchedule
BatchJobSchedule

Válaszok

Promise<void>

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

Ez a művelet kiváltja a számla összes frissíthető tulajdonságát. Például, ha az expiryTime elem nincs megadva, a jelenlegi értéket az alapértelmezett értékre cserélik, nem hagyják megváltoztatva. Egy Compute Node-on csak akkor frissítheted a felhasználói fiókot, ha az tétlen vagy futó állapotban van.

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

Paraméterek

poolId

string

nodeId

string

userName

string

Válaszok

Promise<void>

replacePoolProperties(string, BatchPoolReplaceOptions, ReplacePoolPropertiesOptionalParams)

Ez teljesen felváltja a Pool összes frissíthető tulajdonságát. Például, ha a Poolhoz tartozik egy StartTask, és ha a StartTask nincs megadva ezzel a kéréssel, akkor a Batch szolgáltatás eltávolítja a meglévő StartTask-et.

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

Paraméterek

poolId

string

Válaszok

Promise<void>

replaceTask(string, string, BatchTask, ReplaceTaskOptionalParams)

Frissíti a megadott feladat tulajdonságait.

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

Paraméterek

jobId

string

taskId

string

task
BatchTask

Válaszok

Promise<void>

resizePool(string, BatchPoolResizeOptions, ResizePoolOptionalParams)

A készletet csak akkor méretezheti át, ha a foglalási állapota állandó. Ha a készlet már átméretezve van, a kérés a 409-ben megadott állapotkóddal meghiúsul. Amikor átméretez egy készletet, a készlet foglalási állapota állandóról átméretezésre változik. Az automatikus skálázáshoz konfigurált készletek nem méretezhetők át. Ha megpróbálja ezt megtenni, a Batch szolgáltatás 409-et ad vissza. Ha lefelé méretez át egy készletet, a Batch szolgáltatás kiválasztja az eltávolítani kívánt számítási csomópontokat. Adott számítási csomópontok eltávolításához használja a készletben a Compute Nodes API eltávolítását.

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

Paraméterek

poolId

string

resizeOptions
BatchPoolResizeOptions

Válaszok

PollerLike<OperationState<void>, void>

startNode(string, string, StartNodeOptionalParams)

Compute Node-ot csak akkor indíthatsz el, ha már leosztották.

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

Paraméterek

poolId

string

nodeId

string

Válaszok

PollerLike<OperationState<void>, void>

stopPoolResize(string, StopPoolResizeOptionalParams)

Ez nem állítja vissza a Pool korábbi állapotát a méretátalakítás előtt: csak a további változtatásokat állítja meg, és a Pool megtartja jelenlegi állapotát. Megállás után a Pool stabilizálódik a Számítási Csomópontok számán, ahol a megállítás során volt. A megállítás során a Pool allokációs állapota először megállásra, majd stabilra változik. Egy méretváltoztatási műveletnek nem kell explicit Pool újraméretezési kérésnek lennie; ez az API arra is használható, hogy megállítsa a Pool eredeti méretezését a létrehozáskor.

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

Paraméterek

poolId

string

Válaszok

PollerLike<OperationState<void>, void>

terminateJob(string, TerminateJobOptionalParams)

Amikor megérkezik a Feladat megszüntetése kérése, a Batch szolgáltatás a Feladatot a lezáró állapotra állítja be. A Batch szolgáltatás ezután megszünteti a feladathoz kapcsolódó összes futó feladatot, és lefuttatja a szükséges Feladatkiadó feladatokat. Ezután a Feladat a befejezett állapotba kerül. Ha aktív állapotban vannak a Feladatok, akkor aktív állapotban maradnak. Ha egy Job megszűnt, új Feladatokat nem lehet hozzáadni, és a maradék aktív Feladatok nem lesznek ütemezve.

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

Paraméterek

jobId

string

Válaszok

PollerLike<OperationState<void>, void>

terminateJobSchedule(string, TerminateJobScheduleOptionalParams)

Leállítja a feladatütemezést.

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

Paraméterek

jobScheduleId

string

Válaszok

PollerLike<OperationState<void>, void>

terminateTask(string, string, TerminateTaskOptionalParams)

Amikor a tevékenység leállt, az a befejezett állapotba kerül. Többpéldányos tevékenységek esetén a feladat leállítási művelete szinkron módon vonatkozik az elsődleges tevékenységre; az altevékenységek ezután aszinkron módon leállnak a háttérben.

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

Paraméterek

jobId

string

taskId

string

Válaszok

Promise<void>

updateJob(string, BatchJobUpdateOptions, UpdateJobOptionalParams)

Ez csak a kérésben megadott Job tulajdonságokat váltja fel. Például, ha a Feladatnak vannak korlátai, és egy kérés nem határozza meg a korlátokat, akkor a Feladat megtartja a meglévő korlátokat.

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

Paraméterek

jobId

string

Válaszok

Promise<void>

updateJobSchedule(string, BatchJobScheduleUpdateOptions, UpdateJobScheduleOptionalParams)

Ez csak a kérésben megadott Job Schedule tulajdonságokat helyettesíti. Például, ha az ütemezés tulajdonsága nincs megadva ezzel a kéréssel, akkor a Batch szolgáltatás megtartja a meglévő ütemezést. A Munkaidő-ütemterv változásai csak az átosztás által létrehozott munkákat érintik a frissítés után; a jelenleg működő munkahelyek érintetlenek.

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

Paraméterek

jobScheduleId

string

Válaszok

Promise<void>

updatePool(string, BatchPoolUpdateOptions, UpdatePoolOptionalParams)

Ez csak a kérésben megadott Pool tulajdonságokat helyettesíti. Például, ha a Poolhoz tartozik egy StartTask, és egy kérés nem határoz meg StartTask elemet, akkor a Pool megtartja a meglévő StartTask-et.

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

Paraméterek

poolId

string

Válaszok

Promise<void>

uploadNodeLogs(string, string, UploadBatchServiceLogsOptions, UploadNodeLogsOptionalParams)

Ez arra szolgál, hogy automatizált módon gyűjtsd össze Azure Batch szolgáltatási naplófájlokat a Compute Nodes-ból, ha hibát tapasztalsz, és szeretnél az Azure támogatáshoz fordulni. A Azure Batch szolgáltatás naplófájljait meg kell osztani Azure-támogatás a Batch szolgáltatással kapcsolatos hibakeresési problémák megoldásához.

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

Paraméterek

poolId

string

nodeId

string

Válaszok