PoolOperations Klass
PoolOperations-åtgärder.
Du bör inte instansiera direkt den här klassen, utan skapa en klientinstans som skapar den åt dig och bifogar den som attribut.
- Arv
-
builtins.objectPoolOperations
Konstruktor
PoolOperations(client, config, serializer, deserializer)Parametrar
- client
Klient för tjänstbegäranden.
- config
Konfiguration av tjänstklient.
- serializer
En objektmodellserialiserare.
- deserializer
En deserialiserare för objektmodell.
Variabler
- api_version
DEN API-version som ska användas för begäran. Konstant värde: "2023-05-01.17.0".
Metoder
| add |
Lägger till en pool i det angivna kontot. När du namnger pooler bör du undvika att inkludera känslig information, till exempel användarnamn eller hemliga projektnamn. Den här informationen kan visas i telemetriloggar som är tillgängliga för Microsoft Support tekniker. |
| delete |
Tar bort en pool från det angivna kontot. 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 placeras i kö igen (som om en storleksändringsåtgärd för pool hade begärts med standardalternativet för köning); Slutligen tas poolen bort från systemet. Eftersom aktiviteter som körs placeras i kö igen 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 krympa poolen till nollstorlek innan du tar bort poolen. Om du anropar ett API för uppdatering, korrigering eller borttagning på en pool i borttagningstillståndet misslyckas det med HTTP-statuskod 409 med felkoden PoolBeingDeleted. |
| disable_auto_scale |
Inaktiverar automatisk skalning för en pool. |
| enable_auto_scale |
Aktiverar automatisk skalning för en pool. 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. |
| evaluate_auto_scale |
Hämtar resultatet av utvärderingen av en automatisk skalningsformel i poolen. 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. Den automatiska skalningen måste vara aktiverad för att en formel ska kunna utvärderas. |
| exists |
Hämtar grundläggande egenskaper för en pool. |
| get |
Hämtar information om den angivna poolen. |
| list |
Visar en lista över alla pooler i det angivna kontot. |
| list_usage_metrics |
Visar användningsstatistik, aggregerade efter pool över enskilda tidsintervall, för det angivna kontot. Om du inte anger en $filter-sats, inklusive ett poolId, 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, använder dessa filter som standard start- och sluttider för det senaste tillgängliga aggregeringsintervallet. Dvs. returneras endast det sista aggregeringsintervallet. |
| patch |
Uppdateringar egenskaperna för den angivna poolen. Detta ersätter endast poolegenskaperna som anges i begäran. Om poolen till exempel har en StartTask associerad med den och en begäran inte anger ett StartTask-element, behåller poolen den befintliga StartTask. |
| remove_nodes |
Tar bort beräkningsnoder från den angivna poolen. 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. |
| resize |
Ändrar antalet beräkningsnoder som har tilldelats till en pool. 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 allokeringstillstånd från stabilt till storleksändring. Du kan inte ändra storlek på pooler som har konfigurerats 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 Pool remove Compute Nodes i stället. |
| stop_resize |
Stoppar en pågående storleksändring i poolen. Detta återställer inte poolen till dess tidigare tillstånd innan storleksändringsåtgärden: den stoppar bara ytterligare ändringar som görs och poolen behåller sitt aktuella tillstånd. När den har stoppats stabiliseras poolen vid det antal beräkningsnoder som den var vid när stoppåtgärden utfördes. Under stoppåtgärden ändras poolallokeringstillståndet först till att stoppas och sedan stabiliseras. En storleksändringsåtgärd behöver inte vara en uttrycklig begäran om att ändra storlek på poolen. det här API:et kan också användas för att stoppa den inledande storleken på poolen när den skapas. |
| update_properties |
Uppdateringar egenskaperna för den angivna poolen. Detta ersätter alla uppdateringsbara egenskaper för poolen. Om poolen till exempel har en Associerad StartTask och StartTask inte har angetts med den här begäran, tar Batch-tjänsten bort den befintliga StartTask. |
add
Lägger till en pool i det angivna kontot.
När du namnger pooler bör du undvika att inkludera känslig information, till exempel användarnamn eller hemliga projektnamn. Den här informationen kan visas i telemetriloggar som är tillgängliga för Microsoft Support tekniker.
add(pool, pool_add_options=None, custom_headers=None, raw=False, **operation_config)Parametrar
- raw
- bool
returnerar det direkta svaret tillsammans med det avserialiserade svaret
- operation_config
Åsidosättningar av åtgärdskonfiguration.
Returer
Ingen eller ClientRawResponse om raw=true
Returtyp
Undantag
delete
Tar bort en pool från det angivna kontot.
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 placeras i kö igen (som om en storleksändringsåtgärd för pool hade begärts med standardalternativet för köning); Slutligen tas poolen bort från systemet. Eftersom aktiviteter som körs placeras i kö igen 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 krympa poolen till nollstorlek innan du tar bort poolen. Om du anropar ett API för uppdatering, korrigering eller borttagning på en pool i borttagningstillståndet misslyckas det med HTTP-statuskod 409 med felkoden PoolBeingDeleted.
delete(pool_id, pool_delete_options=None, custom_headers=None, raw=False, **operation_config)Parametrar
- raw
- bool
returnerar det direkta svaret tillsammans med det avserialiserade svaret
- operation_config
Åsidosättningar av åtgärdskonfiguration.
Returer
Ingen eller ClientRawResponse om raw=true
Returtyp
Undantag
disable_auto_scale
Inaktiverar automatisk skalning för en pool.
disable_auto_scale(pool_id, pool_disable_auto_scale_options=None, custom_headers=None, raw=False, **operation_config)Parametrar
- pool_disable_auto_scale_options
- PoolDisableAutoScaleOptions
Ytterligare parametrar för åtgärden
- raw
- bool
returnerar det direkta svaret tillsammans med det avserialiserade svaret
- operation_config
Åsidosättningar av åtgärdskonfiguration.
Returer
Ingen eller ClientRawResponse om raw=true
Returtyp
Undantag
enable_auto_scale
Aktiverar automatisk skalning för en pool.
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.
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)Parametrar
- auto_scale_formula
- str
Formeln kontrolleras för giltighet innan den tillämpas på poolen. Om formeln inte är giltig avvisar Batch-tjänsten begäran med detaljerad felinformation. Mer information om hur du anger den här formeln finns i Skala beräkningsnoder automatiskt i en Azure Batch pool (https://azure.microsoft.com/en-us/documentation/articles/batch-automatic-scaling).
- auto_scale_evaluation_interval
- <xref:timedelta>
Standardvärdet är 15 minuter. Det minsta och högsta värdet är 5 minuter respektive 168 timmar. Om du anger ett värde som är mindre än 5 minuter eller större än 168 timmar avvisar Batch-tjänsten begäran med ett ogiltigt egenskapsvärdefel. Om du anropar REST-API:et direkt är HTTP-statuskoden 400 (felaktig begäran). Om du anger ett nytt intervall stoppas det befintliga utvärderingsschemat för autoskalning och ett nytt utvärderingsschema för autoskalning startas, och starttiden är den tidpunkt då begäran utfärdades.
- pool_enable_auto_scale_options
- PoolEnableAutoScaleOptions
Ytterligare parametrar för åtgärden
- raw
- bool
returnerar det direkta svaret tillsammans med det avserialiserade svaret
- operation_config
Åsidosättningar av åtgärdskonfiguration.
Returer
Ingen eller ClientRawResponse om raw=true
Returtyp
Undantag
evaluate_auto_scale
Hämtar resultatet av utvärderingen av en automatisk skalningsformel i poolen.
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. Den automatiska skalningen måste vara aktiverad för att en formel ska kunna utvärderas.
evaluate_auto_scale(pool_id, auto_scale_formula, pool_evaluate_auto_scale_options=None, custom_headers=None, raw=False, **operation_config)Parametrar
- auto_scale_formula
- str
Formeln verifieras och dess resultat beräknas, men den tillämpas inte på poolen. Om du vill tillämpa formeln på poolen aktiverar du automatisk skalning på en pool. Mer information om hur du anger den här formeln finns i Skala beräkningsnoder automatiskt i en Azure Batch pool (https://azure.microsoft.com/en-us/documentation/articles/batch-automatic-scaling).
- pool_evaluate_auto_scale_options
- PoolEvaluateAutoScaleOptions
Ytterligare parametrar för åtgärden
- raw
- bool
returnerar det direkta svaret tillsammans med det avserialiserade svaret
- operation_config
Åsidosättningar av åtgärdskonfiguration.
Returer
AutoScaleRun eller ClientRawResponse om raw=true
Returtyp
Undantag
exists
Hämtar grundläggande egenskaper för en pool.
exists(pool_id, pool_exists_options=None, custom_headers=None, raw=False, **operation_config)Parametrar
- raw
- bool
returnerar det direkta svaret tillsammans med det avserialiserade svaret
- operation_config
Åsidosättningar av åtgärdskonfiguration.
Returer
bool eller ClientRawResponse om raw=true
Returtyp
Undantag
get
Hämtar information om den angivna poolen.
get(pool_id, pool_get_options=None, custom_headers=None, raw=False, **operation_config)Parametrar
- raw
- bool
returnerar det direkta svaret tillsammans med det avserialiserade svaret
- operation_config
Åsidosättningar av åtgärdskonfiguration.
Returer
CloudPool eller ClientRawResponse om raw=true
Returtyp
Undantag
list
Visar en lista över alla pooler i det angivna kontot.
list(pool_list_options=None, custom_headers=None, raw=False, **operation_config)Parametrar
- raw
- bool
returnerar det direkta svaret tillsammans med det avserialiserade svaret
- operation_config
Åsidosättningar av åtgärdskonfiguration.
Returer
En iterator som en instans av CloudPool
Returtyp
Undantag
list_usage_metrics
Visar användningsstatistik, aggregerade efter pool över enskilda tidsintervall, för det angivna kontot.
Om du inte anger en $filter-sats, inklusive ett poolId, 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, använder dessa filter som standard start- och sluttider för det senaste tillgängliga aggregeringsintervallet. Dvs. returneras endast det sista aggregeringsintervallet.
list_usage_metrics(pool_list_usage_metrics_options=None, custom_headers=None, raw=False, **operation_config)Parametrar
- pool_list_usage_metrics_options
- PoolListUsageMetricsOptions
Ytterligare parametrar för åtgärden
- raw
- bool
returnerar det direkta svaret tillsammans med det avserialiserade svaret
- operation_config
Åsidosättningar av åtgärdskonfiguration.
Returer
En iterator som en instans av PoolUsageMetrics
Returtyp
Undantag
patch
Uppdateringar egenskaperna för den angivna poolen.
Detta ersätter endast poolegenskaperna som anges i begäran. Om poolen till exempel har en StartTask associerad med den och en begäran inte anger ett StartTask-element, behåller poolen den befintliga StartTask.
patch(pool_id, pool_patch_parameter, pool_patch_options=None, custom_headers=None, raw=False, **operation_config)Parametrar
- raw
- bool
returnerar det direkta svaret tillsammans med det avserialiserade svaret
- operation_config
Åsidosättningar av åtgärdskonfiguration.
Returer
None eller ClientRawResponse om raw=true
Returtyp
Undantag
remove_nodes
Tar bort beräkningsnoder från den angivna poolen.
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.
remove_nodes(pool_id, node_remove_parameter, pool_remove_nodes_options=None, custom_headers=None, raw=False, **operation_config)Parametrar
- pool_remove_nodes_options
- PoolRemoveNodesOptions
Ytterligare parametrar för åtgärden
- operation_config
Åsidosättningar av åtgärdskonfiguration.
Returer
None eller ClientRawResponse om raw=true
Returtyp
Undantag
resize
Ändrar antalet beräkningsnoder som har tilldelats till en pool.
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 allokeringstillstånd från stabilt till storleksändring. Du kan inte ändra storlek på pooler som har konfigurerats 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 Pool remove Compute Nodes i stället.
resize(pool_id, pool_resize_parameter, pool_resize_options=None, custom_headers=None, raw=False, **operation_config)Parametrar
- operation_config
Åsidosättningar av åtgärdskonfiguration.
Returer
None eller ClientRawResponse om raw=true
Returtyp
Undantag
stop_resize
Stoppar en pågående storleksändring i poolen.
Detta återställer inte poolen till dess tidigare tillstånd innan storleksändringsåtgärden: den stoppar bara ytterligare ändringar som görs och poolen behåller sitt aktuella tillstånd. När den har stoppats stabiliseras poolen vid det antal beräkningsnoder som den var vid när stoppåtgärden utfördes. Under stoppåtgärden ändras poolallokeringstillståndet först till att stoppas och sedan stabiliseras. En storleksändringsåtgärd behöver inte vara en uttrycklig begäran om att ändra storlek på poolen. det här API:et kan också användas för att stoppa den inledande storleken på poolen när den skapas.
stop_resize(pool_id, pool_stop_resize_options=None, custom_headers=None, raw=False, **operation_config)Parametrar
- pool_stop_resize_options
- PoolStopResizeOptions
Ytterligare parametrar för åtgärden
- operation_config
Åsidosättningar av åtgärdskonfiguration.
Returer
None eller ClientRawResponse om raw=true
Returtyp
Undantag
update_properties
Uppdateringar egenskaperna för den angivna poolen.
Detta ersätter alla uppdateringsbara egenskaper för poolen. Om poolen till exempel har en Associerad StartTask och StartTask inte har angetts med den här begäran, tar Batch-tjänsten bort den befintliga StartTask.
update_properties(pool_id, pool_update_properties_parameter, pool_update_properties_options=None, custom_headers=None, raw=False, **operation_config)Parametrar
- pool_update_properties_parameter
- PoolUpdatePropertiesParameter
Parametrarna för begäran.
- pool_update_properties_options
- PoolUpdatePropertiesOptions
Ytterligare parametrar för åtgärden
- operation_config
Åsidosättningar av åtgärdskonfiguration.
Returer
None eller ClientRawResponse om raw=true
Returtyp
Undantag
Attribut
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
Feedback
Kommer snart: Under hela 2024 kommer vi att fasa ut GitHub-problem som feedbackmekanism för innehåll och ersätta det med ett nytt feedbacksystem. Mer information finns i: https://aka.ms/ContentUserFeedback.
Skicka och visa feedback för