PoolOperations Osztály
PoolOperations-műveletek.
Ne példányosítsa közvetlenül ezt az osztályt, hanem hozzon létre egy ügyfélpéldányt, amely létrehozza és attribútumként csatolja.
- Öröklődés
-
builtins.objectPoolOperations
Konstruktor
PoolOperations(client, config, serializer, deserializer)Paraméterek
- client
Ügyfél szolgáltatáskérésekhez.
- config
A szolgáltatásügyfél konfigurálása.
- serializer
Objektummodell szerializálója.
- deserializer
Objektummodell-deszerializáló.
Változók
- api_version
A kéréshez használni kívánt API-verzió. Állandó érték: "2023-05-01.17.0".
Metódusok
| add |
Készletet ad hozzá a megadott fiókhoz. A Készletek elnevezésekor kerülje a bizalmas információk, 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ökök számára elérhető telemetriai naplókban. |
| delete |
Egy készlet törlése a megadott fiókból. 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 le vannak kérdezve (mintha az alapértelmezett újrakiadási beállítással igényeltek volna egy átméretezési készlet műveletet); végül a rendszer eltávolítja a készletet a rendszerből. Mivel a feladatok futtatása újra le van kérdezve, a felhasználó újrafuttathatja ezeket a feladatokat úgy, hogy frissíti a feladatot egy másik készletre. 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 explicit módon hívja meg az átméretezési készletet a készlet nullára zsugorításához. Ha egy frissítési, javítási vagy törlési API-t hív meg egy készleten törlési állapotban, az a 409-es HTTP-állapotkóddal és a PoolBeingDeleted hibakóddal meghiúsul. |
| disable_auto_scale |
Letiltja a készlet automatikus skálázását. |
| enable_auto_scale |
Lehetővé teszi az automatikus skálázást egy készlethez. Nem engedélyezheti az automatikus skálázást egy készleten, ha átméretezési művelet van folyamatban 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 skálázási képletet. Ha a készlet automatikus skálázása 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. 30 másodpercenként nem hívhatja meg ezt az API-t ugyanarra a készletre. |
| evaluate_auto_scale |
Lekéri a készlet automatikus skálázási képletének kiértékelésének eredményét. Ez az API elsősorban egy automatikus skálázási képlet érvényesítésére szolgál, mivel egyszerűen visszaadja az eredményt anélkül, hogy a képletet a készletre alkalmazta volna. A készletnek engedélyeznie kell az automatikus skálázást a képlet kiértékeléséhez. |
| exists |
Lekéri a készlet alapvető tulajdonságait. |
| get |
Információt kap a megadott készletről. |
| list |
A megadott fiók összes készletét felsorolja. |
| list_usage_metrics |
Felsorolja a megadott fiókhoz tartozó használati metrikákat, amelyeket a készlet egyes időintervallumok szerint összesít. Ha nem ad meg $filter záradékot, beleértve a készletazonosítót is, a válasz tartalmazza az összes készletet, amely a fiókban létezett a visszaadott aggregációs intervallumok időtartományában. Ha nem ad meg $filter záradékot, beleértve a startTime vagy endTime értéket, ezek a szűrők alapértelmezés szerint a jelenleg elérhető utolsó összesítési időköz kezdő és záró időpontjaira vannak beszűkülve; vagyis csak az utolsó összesítési időköz lesz visszaadva. |
| patch |
Frissítések a megadott készlet tulajdonságait. Ez csak a kérelemben megadott készlettulajdonságokat cseréli le. Ha például a készlethez egy StartTask van társítva, és a kérés nem ad meg StartTask elemet, akkor a készlet megtartja a meglévő StartTaskot. |
| remove_nodes |
Eltávolítja a számítási csomópontokat a megadott készletből. Ez a művelet csak akkor futtatható, ha a készlet foglalási állapota állandó. A művelet futtatásakor a foglalás állapota állandóról átméretezésre változik. Minden kérés legfeljebb 100 csomópontot távolíthat el. |
| resize |
Módosítja a készlethez rendelt számítási csomópontok számát. A készletet csak akkor méretezheti át, ha annak foglalási állapota állandó. Ha a készlet már átméreteződött, a kérés a 409-es á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 a 409-edik hibát adja vissza. Ha lefelé átméretez 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 inkább a Készlet eltávolítja a Számítási csomópontok API-t. |
| stop_resize |
Leállítja a folyamatban lévő átméretezési műveletet a készleten. Ez nem állítja vissza a készletet a korábbi állapotba az átméretezési művelet előtt: csak leállítja a további módosításokat, és a készlet fenntartja az aktuális állapotát. A leállítás után a készlet a leállítási művelet végrehajtásakor a számítási csomópontok számánál stabilizálódik. A leállítási művelet során a készletfoglalási állapot először leállításra, majd állandó állapotra változik. Az átméretezési műveletnek nem kell explicit átméretezési készletkérésnek lennie; Ez az API a készlet kezdeti méretezésének leállítására is használható a létrehozáskor. |
| update_properties |
Frissítések a megadott készlet tulajdonságait. Ez teljes mértékben lecseréli a készlet összes frissíthető tulajdonságát. Ha például a készlethez egy StartTask van társítva, és a StartTask nincs megadva ezzel a kéréssel, akkor a Batch szolgáltatás eltávolítja a meglévő StartTaskot. |
add
Készletet ad hozzá a megadott fiókhoz.
A Készletek elnevezésekor kerülje a bizalmas információk, 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ökök számára elérhető telemetriai naplókban.
add(pool, pool_add_options=None, custom_headers=None, raw=False, **operation_config)Paraméterek
- raw
- bool
a deszerializált válasz mellett a közvetlen választ adja vissza
- operation_config
A műveletkonfiguráció felülbírálása.
Válaszok
Nincs vagy ClientRawResponse, ha raw=true
Visszatérési típus
Kivételek
delete
Egy készlet törlése a megadott fiókból.
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 le vannak kérdezve (mintha az alapértelmezett újrakiadási beállítással igényeltek volna egy átméretezési készlet műveletet); végül a rendszer eltávolítja a készletet a rendszerből. Mivel a feladatok futtatása újra le van kérdezve, a felhasználó újrafuttathatja ezeket a feladatokat úgy, hogy frissíti a feladatot egy másik készletre. 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 explicit módon hívja meg az átméretezési készletet a készlet nullára zsugorításához. Ha egy frissítési, javítási vagy törlési API-t hív meg egy készleten törlési állapotban, az a 409-es HTTP-állapotkóddal és a PoolBeingDeleted hibakóddal meghiúsul.
delete(pool_id, pool_delete_options=None, custom_headers=None, raw=False, **operation_config)Paraméterek
- raw
- bool
a deszerializált válasz mellett a közvetlen választ adja vissza
- operation_config
A műveletkonfiguráció felülbírálása.
Válaszok
Nincs vagy ClientRawResponse, ha raw=true
Visszatérési típus
Kivételek
disable_auto_scale
Letiltja a készlet automatikus skálázását.
disable_auto_scale(pool_id, pool_disable_auto_scale_options=None, custom_headers=None, raw=False, **operation_config)Paraméterek
- pool_id
- str
Annak a készletnek az azonosítója, amelyen le szeretné tiltani az automatikus skálázást.
- pool_disable_auto_scale_options
- PoolDisableAutoScaleOptions
A művelet további paraméterei
- raw
- bool
a deszerializált válasz mellett a közvetlen választ adja vissza
- operation_config
A műveletkonfiguráció felülbírálása.
Válaszok
Nincs vagy ClientRawResponse, ha raw=true
Visszatérési típus
Kivételek
enable_auto_scale
Lehetővé teszi az automatikus skálázást egy készlethez.
Nem engedélyezheti az automatikus skálázást egy készleten, ha átméretezési művelet van folyamatban 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 skálázási képletet. Ha a készlet automatikus skálázása 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. 30 másodpercenként nem hívhatja meg ezt az API-t ugyanarra a készletre.
enable_auto_scale(pool_id, auto_scale_formula=None, auto_scale_evaluation_interval=None, pool_enable_auto_scale_options=None, custom_headers=None, raw=False, **operation_config)Paraméterek
- pool_id
- str
Annak a készletnek az azonosítója, amelyen engedélyezni szeretné az automatikus skálázást.
- auto_scale_formula
- str
A rendszer ellenőrzi a képlet érvényességét, mielőtt alkalmazva lenne a készletre. Ha a képlet érvénytelen, a Batch szolgáltatás elutasítja a kérelmet részletes hibainformációkkal. A képlet megadásával kapcsolatos további információkért lásd: Számítási csomópontok automatikus méretezése Azure Batch készletben (https://azure.microsoft.com/en-us/documentation/articles/batch-automatic-scaling).
- auto_scale_evaluation_interval
- <xref:timedelta>
Az alapértelmezett érték 15 perc. A minimális és maximális érték 5 perc, illetve 168 óra. Ha 5 percnél rövidebb vagy 168 óránál hosszabb értéket ad meg, a Batch szolgáltatás érvénytelen tulajdonságérték-hibával utasítja el a kérést; Ha közvetlenül a REST API-t hívja meg, a HTTP-állapotkód 400 (hibás kérés). Ha új időközt ad meg, a rendszer leállítja a meglévő automatikus skálázási kiértékelési ütemezést, és elindít egy új automatikus skálázási kiértékelési ütemezést, amelynek kezdési időpontja a kérés kiadásának időpontja.
- pool_enable_auto_scale_options
- PoolEnableAutoScaleOptions
A művelet további paraméterei
- raw
- bool
a deszerializált válasz mellett a közvetlen választ adja vissza
- operation_config
A műveletkonfiguráció felülbírálása.
Válaszok
Nincs vagy ClientRawResponse, ha raw=true
Visszatérési típus
Kivételek
evaluate_auto_scale
Lekéri a készlet automatikus skálázási képletének kiértékelésének eredményét.
Ez az API elsősorban egy automatikus skálázási képlet érvényesítésére szolgál, mivel egyszerűen visszaadja az eredményt anélkül, hogy a képletet a készletre alkalmazta volna. A készletnek engedélyeznie kell az automatikus skálázást a képlet kiértékeléséhez.
evaluate_auto_scale(pool_id, auto_scale_formula, pool_evaluate_auto_scale_options=None, custom_headers=None, raw=False, **operation_config)Paraméterek
- pool_id
- str
Annak a készletnek az azonosítója, amelyen az automatikus skálázási képletet ki kell értékelni.
- auto_scale_formula
- str
A képlet érvényesítve van, és kiszámítja az eredményeit, de nem alkalmazza a készletre. Ha a képletet a készletre szeretné alkalmazni, az "Automatikus skálázás engedélyezése egy készleten". A képlet megadásával kapcsolatos további információkért lásd: Számítási csomópontok automatikus méretezése Azure Batch készletben (https://azure.microsoft.com/en-us/documentation/articles/batch-automatic-scaling).
- pool_evaluate_auto_scale_options
- PoolEvaluateAutoScaleOptions
A művelet további paraméterei
- raw
- bool
a deszerializált válasz mellett a közvetlen választ adja vissza
- operation_config
A műveletkonfiguráció felülbírálása.
Válaszok
Automatikus skálázásfuttatás vagy ClientRawResponse, ha raw=true
Visszatérési típus
Kivételek
exists
Lekéri a készlet alapvető tulajdonságait.
exists(pool_id, pool_exists_options=None, custom_headers=None, raw=False, **operation_config)Paraméterek
- raw
- bool
a deszerializált válasz mellett a közvetlen választ adja vissza
- operation_config
A műveletkonfiguráció felülbírálása.
Válaszok
bool vagy ClientRawResponse, ha raw=true
Visszatérési típus
Kivételek
get
Információt kap a megadott készletről.
get(pool_id, pool_get_options=None, custom_headers=None, raw=False, **operation_config)Paraméterek
- raw
- bool
a deszerializált válasz mellett a közvetlen választ adja vissza
- operation_config
A műveletkonfiguráció felülbírálása.
Válaszok
CloudPool vagy ClientRawResponse, ha raw=true
Visszatérési típus
Kivételek
list
A megadott fiók összes készletét felsorolja.
list(pool_list_options=None, custom_headers=None, raw=False, **operation_config)Paraméterek
- raw
- bool
a deszerializált válasz mellett a közvetlen választ adja vissza
- operation_config
A műveletkonfiguráció felülbírálása.
Válaszok
Iterátor, például CloudPool-példány
Visszatérési típus
Kivételek
list_usage_metrics
Felsorolja a megadott fiókhoz tartozó használati metrikákat, amelyeket a készlet egyes időintervallumok szerint összesít.
Ha nem ad meg $filter záradékot, beleértve a készletazonosítót is, a válasz tartalmazza az összes készletet, amely a fiókban létezett a visszaadott aggregációs intervallumok időtartományában. Ha nem ad meg $filter záradékot, beleértve a startTime vagy endTime értéket, ezek a szűrők alapértelmezés szerint a jelenleg elérhető utolsó összesítési időköz kezdő és záró időpontjaira vannak beszűkülve; vagyis csak az utolsó összesítési időköz lesz visszaadva.
list_usage_metrics(pool_list_usage_metrics_options=None, custom_headers=None, raw=False, **operation_config)Paraméterek
- pool_list_usage_metrics_options
- PoolListUsageMetricsOptions
A művelet további paraméterei
- raw
- bool
a deszerializált válasz mellett a közvetlen választ adja vissza
- operation_config
A műveletkonfiguráció felülbírálása.
Válaszok
Egy iterátor, például a PoolUsageMetrics példánya
Visszatérési típus
Kivételek
patch
Frissítések a megadott készlet tulajdonságait.
Ez csak a kérelemben megadott készlettulajdonságokat cseréli le. Ha például a készlethez egy StartTask van társítva, és a kérés nem ad meg StartTask elemet, akkor a készlet megtartja a meglévő StartTaskot.
patch(pool_id, pool_patch_parameter, pool_patch_options=None, custom_headers=None, raw=False, **operation_config)Paraméterek
- raw
- bool
a deszerializált válasz mellett a közvetlen választ adja vissza
- operation_config
A műveletkonfiguráció felülbírálása.
Válaszok
Nincs vagy ClientRawResponse, ha raw=true
Visszatérési típus
Kivételek
remove_nodes
Eltávolítja a számítási csomópontokat a megadott készletből.
Ez a művelet csak akkor futtatható, ha a készlet foglalási állapota állandó. A művelet futtatásakor a foglalás állapota állandóról átméretezésre változik. Minden kérés legfeljebb 100 csomópontot távolíthat el.
remove_nodes(pool_id, node_remove_parameter, pool_remove_nodes_options=None, custom_headers=None, raw=False, **operation_config)Paraméterek
- pool_id
- str
Annak a készletnek az azonosítója, amelyből el szeretné távolítani a számítási csomópontokat.
- pool_remove_nodes_options
- PoolRemoveNodesOptions
A művelet további paraméterei
- raw
- bool
a deszerializált válasz mellett a közvetlen választ adja vissza
- operation_config
A műveletkonfiguráció felülbírálása.
Válaszok
Nincs vagy ClientRawResponse, ha raw=true
Visszatérési típus
Kivételek
resize
Módosítja a készlethez rendelt számítási csomópontok számát.
A készletet csak akkor méretezheti át, ha annak foglalási állapota állandó. Ha a készlet már átméreteződött, a kérés a 409-es á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 a 409-edik hibát adja vissza. Ha lefelé átméretez 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 inkább a Készlet eltávolítja a Számítási csomópontok API-t.
resize(pool_id, pool_resize_parameter, pool_resize_options=None, custom_headers=None, raw=False, **operation_config)Paraméterek
- raw
- bool
a deszerializált válasz mellett a közvetlen választ adja vissza
- operation_config
A műveletkonfiguráció felülbírálása.
Válaszok
Nincs vagy ClientRawResponse, ha raw=true
Visszatérési típus
Kivételek
stop_resize
Leállítja a folyamatban lévő átméretezési műveletet a készleten.
Ez nem állítja vissza a készletet a korábbi állapotba az átméretezési művelet előtt: csak leállítja a további módosításokat, és a készlet fenntartja az aktuális állapotát. A leállítás után a készlet a leállítási művelet végrehajtásakor a számítási csomópontok számánál stabilizálódik. A leállítási művelet során a készletfoglalási állapot először leállításra, majd állandó állapotra változik. Az átméretezési műveletnek nem kell explicit átméretezési készletkérésnek lennie; Ez az API a készlet kezdeti méretezésének leállítására is használható a létrehozáskor.
stop_resize(pool_id, pool_stop_resize_options=None, custom_headers=None, raw=False, **operation_config)Paraméterek
- pool_id
- str
Annak a készletnek az azonosítója, amelynek átméretezését le szeretné állítani.
- pool_stop_resize_options
- PoolStopResizeOptions
A művelet további paraméterei
- raw
- bool
a deszerializált válasz mellett a közvetlen választ adja vissza
- operation_config
A műveletkonfiguráció felülbírálása.
Válaszok
Nincs vagy ClientRawResponse, ha raw=true
Visszatérési típus
Kivételek
update_properties
Frissítések a megadott készlet tulajdonságait.
Ez teljes mértékben lecseréli a készlet összes frissíthető tulajdonságát. Ha például a készlethez egy StartTask van társítva, és a StartTask nincs megadva ezzel a kéréssel, akkor a Batch szolgáltatás eltávolítja a meglévő StartTaskot.
update_properties(pool_id, pool_update_properties_parameter, pool_update_properties_options=None, custom_headers=None, raw=False, **operation_config)Paraméterek
- pool_update_properties_options
- PoolUpdatePropertiesOptions
A művelet további paraméterei
- raw
- bool
a deszerializált válasz mellett a közvetlen választ adja vissza
- operation_config
A műveletkonfiguráció felülbírálása.
Válaszok
Nincs vagy ClientRawResponse, ha raw=true
Visszatérési típus
Kivételek
Attribútumok
models
models = <module 'azure.batch.models' from 'C:\\hostedtoolcache\\windows\\Python\\3.11.7\\x64\\Lib\\site-packages\\azure\\batch\\models\\__init__.py'>
Azure SDK for Python
Visszajelzés
Hamarosan elérhető: 2024-ben fokozatosan kivezetjük a GitHub-problémákat a tartalom visszajelzési mechanizmusaként, és lecseréljük egy új visszajelzési rendszerre. További információ: https://aka.ms/ContentUserFeedback.
Visszajelzés küldése és megtekintése a következőhöz: