PoolOperations Klas
PoolOperations-bewerkingen.
U moet deze klasse niet rechtstreeks instantiëren, maar een clientexemplaar maken dat deze voor u maakt en deze als kenmerk koppelt.
- Overname
-
builtins.objectPoolOperations
Constructor
PoolOperations(client, config, serializer, deserializer)Parameters
- client
Client voor serviceaanvragen.
- config
Configuratie van de serviceclient.
- serializer
Een serialisatiefunctie voor objectmodellen.
- deserializer
Een deserializer voor objectmodellen.
Variabelen
- api_version
De API-versie die moet worden gebruikt voor de aanvraag. Constante waarde: "2023-05-01.17.0".
Methoden
| add |
Hiermee voegt u een pool toe aan het opgegeven account. Vermijd bij het benoemen van pools gevoelige informatie, zoals gebruikersnamen of geheime projectnamen. Deze informatie kan worden weergegeven in telemetrielogboeken die toegankelijk zijn voor Microsoft Ondersteuning technici. |
| delete |
Hiermee verwijdert u een pool uit het opgegeven account. Wanneer u aanvraagt om een pool te verwijderen, worden de volgende acties uitgevoerd: de poolstatus is ingesteld op verwijderen; elke lopende bewerking voor het wijzigen van het formaat van de pool wordt gestopt; de Batch-service begint met het wijzigen van de grootte van de pool naar nul rekenknooppunten; alle taken die worden uitgevoerd op bestaande rekenknooppunten worden beëindigd en opnieuw in de wachtrij worden gezet (alsof een bewerking voor het wijzigen van de grootte van de pool is aangevraagd met de standaardoptie voor opnieuw in de wachtrij); ten slotte wordt de pool uit het systeem verwijderd. Omdat actieve taken opnieuw in de wachtrij worden weergegeven, kan de gebruiker deze taken opnieuw uitvoeren door de taak bij te werken naar een andere pool. De taken kunnen vervolgens worden uitgevoerd op de nieuwe pool. Als u het gedrag voor opnieuw in de wachtrij plaatsen wilt overschrijven, moet u het formaat van pool wijzigen expliciet aanroepen om de pool tot nul te verkleinen voordat u de pool verwijdert. Als u een Update-, Patch- of Delete-API aanroept op een pool met de status Verwijderen, mislukt deze met HTTP-statuscode 409 met foutcode PoolBeingDeleted. |
| disable_auto_scale |
Hiermee schakelt u automatisch schalen voor een pool uit. |
| enable_auto_scale |
Hiermee schakelt u automatisch schalen voor een pool in. U kunt automatisch schalen niet inschakelen voor een pool als er een bewerking voor het wijzigen van het formaat van de pool wordt uitgevoerd. Als automatisch schalen van de pool momenteel is uitgeschakeld, moet u een geldige formule voor automatisch schalen opgeven als onderdeel van de aanvraag. Als automatisch schalen van de pool al is ingeschakeld, kunt u een nieuwe formule voor automatisch schalen en/of een nieuw evaluatie-interval opgeven. U kunt deze API niet meerdere keren per 30 seconden aanroepen voor dezelfde pool. |
| evaluate_auto_scale |
Hiermee haalt u het resultaat op van het evalueren van een formule voor automatisch schalen in de pool. Deze API is voornamelijk bedoeld voor het valideren van een formule voor automatische schaalaanpassing, omdat deze alleen het resultaat retourneert zonder de formule toe te passen op de pool. Voor de pool moet automatisch schalen zijn ingeschakeld om een formule te kunnen evalueren. |
| exists |
Hiermee haalt u de basiseigenschappen van een pool op. |
| get |
Hiermee haalt u informatie op over de opgegeven pool. |
| list |
Een lijst met alle groepen in het opgegeven account. |
| list_usage_metrics |
Een lijst met de metrische gegevens over gebruik, geaggregeerd per pool voor afzonderlijke tijdsintervallen, voor het opgegeven account. Als u geen $filter component met inbegrip van een poolId opgeeft, bevat het antwoord alle pools die in het account bestonden in het tijdsbereik van de geretourneerde aggregatie-intervallen. Als u geen $filter-component opgeeft, inclusief een startTime of endTime, worden deze filters standaard toegepast op de begin- en eindtijd van het laatste aggregatie-interval dat momenteel beschikbaar is; dat wil gezegd dat alleen het laatste aggregatie-interval wordt geretourneerd. |
| patch |
Updates de eigenschappen van de opgegeven pool. Hiermee vervangt u alleen de pooleigenschappen die in de aanvraag zijn opgegeven. Als er bijvoorbeeld aan de pool een StartTask is gekoppeld en een aanvraag geen StartTask-element opgeeft, behoudt de pool de bestaande StartTask. |
| remove_nodes |
Hiermee verwijdert u rekenknooppunten uit de opgegeven pool. Deze bewerking kan alleen worden uitgevoerd wanneer de toewijzingsstatus van de pool stabiel is. Wanneer deze bewerking wordt uitgevoerd, verandert de toewijzingsstatus van constant in wijzigen van formaat. Elke aanvraag kan maximaal 100 knooppunten verwijderen. |
| resize |
Hiermee wijzigt u het aantal rekenknooppunten dat is toegewezen aan een pool. U kunt het formaat van een pool alleen wijzigen wanneer de toewijzingsstatus stabiel is. Als het formaat van de groep al wordt gewijzigd, mislukt de aanvraag met statuscode 409. Wanneer u het formaat van een pool wijzigt, verandert de toewijzingsstatus van de pool van constant in het wijzigen van het formaat. U kunt de grootte van pools die zijn geconfigureerd voor automatisch schalen niet wijzigen. Als u dit probeert te doen, retourneert de Batch-service fout 409. Als u de grootte van een pool omlaag wijzigt, kiest de Batch-service welke rekenknooppunten u wilt verwijderen. Als u specifieke rekenknooppunten wilt verwijderen, gebruikt u in plaats daarvan de API Rekenknooppunten groep verwijderen. |
| stop_resize |
Hiermee stopt u een doorlopende bewerking voor het wijzigen van het formaat van de pool. Hiermee wordt de pool niet teruggezet naar de vorige status vóór de bewerking voor het wijzigen van het formaat: er worden alleen verdere wijzigingen gestopt en de pool behoudt de huidige status. Na het stoppen stabiliseert de pool zich op het aantal rekenknooppunten waarop het was toen de stopbewerking werd uitgevoerd. Tijdens de stopbewerking verandert de pooltoewijzingsstatus eerst in stoppen en vervolgens in stabiel. Een bewerking voor het wijzigen van het formaat hoeft geen expliciete aanvraag voor het wijzigen van het formaat van de groep te zijn; deze API kan ook worden gebruikt om de eerste grootte van de pool te stoppen wanneer deze wordt gemaakt. |
| update_properties |
Updates de eigenschappen van de opgegeven pool. Hiermee worden alle bijwerkbare eigenschappen van de pool volledig vervangen. Als er bijvoorbeeld aan de pool een StartTask is gekoppeld en als StartTask niet is opgegeven bij deze aanvraag, verwijdert de Batch-service de bestaande StartTask. |
add
Hiermee voegt u een pool toe aan het opgegeven account.
Vermijd bij het benoemen van pools gevoelige informatie, zoals gebruikersnamen of geheime projectnamen. Deze informatie kan worden weergegeven in telemetrielogboeken die toegankelijk zijn voor Microsoft Ondersteuning technici.
add(pool, pool_add_options=None, custom_headers=None, raw=False, **operation_config)Parameters
- raw
- bool
retourneert het directe antwoord naast het gedeserialiseerde antwoord
- operation_config
Bewerkingsconfiguratie overschrijft.
Retouren
None of ClientRawResponse indien raw=true
Retourtype
Uitzonderingen
delete
Hiermee verwijdert u een pool uit het opgegeven account.
Wanneer u aanvraagt om een pool te verwijderen, worden de volgende acties uitgevoerd: de poolstatus is ingesteld op verwijderen; elke lopende bewerking voor het wijzigen van het formaat van de pool wordt gestopt; de Batch-service begint met het wijzigen van de grootte van de pool naar nul rekenknooppunten; alle taken die worden uitgevoerd op bestaande rekenknooppunten worden beëindigd en opnieuw in de wachtrij worden gezet (alsof een bewerking voor het wijzigen van de grootte van de pool is aangevraagd met de standaardoptie voor opnieuw in de wachtrij); ten slotte wordt de pool uit het systeem verwijderd. Omdat actieve taken opnieuw in de wachtrij worden weergegeven, kan de gebruiker deze taken opnieuw uitvoeren door de taak bij te werken naar een andere pool. De taken kunnen vervolgens worden uitgevoerd op de nieuwe pool. Als u het gedrag voor opnieuw in de wachtrij plaatsen wilt overschrijven, moet u het formaat van pool wijzigen expliciet aanroepen om de pool tot nul te verkleinen voordat u de pool verwijdert. Als u een Update-, Patch- of Delete-API aanroept op een pool met de status Verwijderen, mislukt deze met HTTP-statuscode 409 met foutcode PoolBeingDeleted.
delete(pool_id, pool_delete_options=None, custom_headers=None, raw=False, **operation_config)Parameters
- pool_delete_options
- PoolDeleteOptions
Aanvullende parameters voor de bewerking
- raw
- bool
retourneert het directe antwoord naast het gedeserialiseerde antwoord
- operation_config
Bewerkingsconfiguratie overschrijft.
Retouren
None of ClientRawResponse indien raw=true
Retourtype
Uitzonderingen
disable_auto_scale
Hiermee schakelt u automatisch schalen voor een pool uit.
disable_auto_scale(pool_id, pool_disable_auto_scale_options=None, custom_headers=None, raw=False, **operation_config)Parameters
- pool_disable_auto_scale_options
- PoolDisableAutoScaleOptions
Aanvullende parameters voor de bewerking
- raw
- bool
retourneert het directe antwoord naast het gedeserialiseerde antwoord
- operation_config
Bewerkingsconfiguratie overschrijft.
Retouren
None of ClientRawResponse indien raw=true
Retourtype
Uitzonderingen
enable_auto_scale
Hiermee schakelt u automatisch schalen voor een pool in.
U kunt automatisch schalen niet inschakelen voor een pool als er een bewerking voor het wijzigen van het formaat van de pool wordt uitgevoerd. Als automatisch schalen van de pool momenteel is uitgeschakeld, moet u een geldige formule voor automatisch schalen opgeven als onderdeel van de aanvraag. Als automatisch schalen van de pool al is ingeschakeld, kunt u een nieuwe formule voor automatisch schalen en/of een nieuw evaluatie-interval opgeven. U kunt deze API niet meerdere keren per 30 seconden aanroepen voor dezelfde pool.
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)Parameters
- auto_scale_formula
- str
De formule wordt gecontroleerd op geldigheid voordat deze wordt toegepast op de pool. Als de formule ongeldig is, weigert de Batch-service de aanvraag met gedetailleerde foutinformatie. Zie Compute Nodes in an Azure Batch Pool (https://azure.microsoft.com/en-us/documentation/articles/batch-automatic-scaling) automatisch schalen voor meer informatie over het opgeven van deze formule.
- auto_scale_evaluation_interval
- <xref:timedelta>
De standaardwaarde is 15 minuten. De minimum- en maximumwaarde zijn respectievelijk 5 minuten en 168 uur. Als u een waarde opgeeft die minder dan 5 minuten of langer is dan 168 uur, weigert de Batch-service de aanvraag met een fout met een ongeldige eigenschapswaarde. Als u de REST API rechtstreeks aanroept, is de HTTP-statuscode 400 (Ongeldige aanvraag). Als u een nieuw interval opgeeft, wordt het bestaande evaluatieschema voor automatische schaalaanpassing gestopt en wordt er een nieuw evaluatieschema voor automatisch schalen gestart, met als begintijd het tijdstip waarop deze aanvraag is uitgegeven.
- pool_enable_auto_scale_options
- PoolEnableAutoScaleOptions
Aanvullende parameters voor de bewerking
- raw
- bool
retourneert het directe antwoord naast het gedeserialiseerde antwoord
- operation_config
Bewerkingsconfiguratie overschrijft.
Retouren
None of ClientRawResponse indien raw=true
Retourtype
Uitzonderingen
evaluate_auto_scale
Hiermee haalt u het resultaat op van het evalueren van een formule voor automatisch schalen in de pool.
Deze API is voornamelijk bedoeld voor het valideren van een formule voor automatische schaalaanpassing, omdat deze alleen het resultaat retourneert zonder de formule toe te passen op de pool. Voor de pool moet automatisch schalen zijn ingeschakeld om een formule te kunnen evalueren.
evaluate_auto_scale(pool_id, auto_scale_formula, pool_evaluate_auto_scale_options=None, custom_headers=None, raw=False, **operation_config)Parameters
- pool_id
- str
De id van de pool waarop de formule voor automatisch schalen moet worden geëvalueerd.
- auto_scale_formula
- str
De formule wordt gevalideerd en de resultaten worden berekend, maar wordt niet toegepast op de pool. Als u de formule wilt toepassen op de pool, schakelt u automatisch schalen in op een pool. Zie Compute Nodes in an Azure Batch Pool (https://azure.microsoft.com/en-us/documentation/articles/batch-automatic-scaling) automatisch schalen voor meer informatie over het opgeven van deze formule.
- pool_evaluate_auto_scale_options
- PoolEvaluateAutoScaleOptions
Aanvullende parameters voor de bewerking
- raw
- bool
retourneert het directe antwoord naast het gedeserialiseerde antwoord
- operation_config
Bewerkingsconfiguratie overschrijft.
Retouren
AutoScaleRun of ClientRawResponse indien raw=true
Retourtype
Uitzonderingen
exists
Hiermee haalt u de basiseigenschappen van een pool op.
exists(pool_id, pool_exists_options=None, custom_headers=None, raw=False, **operation_config)Parameters
- pool_exists_options
- PoolExistsOptions
Aanvullende parameters voor de bewerking
- raw
- bool
retourneert het directe antwoord naast het gedeserialiseerde antwoord
- operation_config
Bewerkingsconfiguratie overschrijft.
Retouren
bool of ClientRawResponse indien raw=true
Retourtype
Uitzonderingen
get
Hiermee haalt u informatie op over de opgegeven pool.
get(pool_id, pool_get_options=None, custom_headers=None, raw=False, **operation_config)Parameters
- raw
- bool
retourneert het directe antwoord naast het gedeserialiseerde antwoord
- operation_config
Bewerkingsconfiguratie overschrijft.
Retouren
CloudPool of ClientRawResponse indien raw=true
Retourtype
Uitzonderingen
list
Een lijst met alle groepen in het opgegeven account.
list(pool_list_options=None, custom_headers=None, raw=False, **operation_config)Parameters
- raw
- bool
retourneert het directe antwoord naast het gedeserialiseerde antwoord
- operation_config
Bewerkingsconfiguratie overschrijft.
Retouren
Een iterator zoals een exemplaar van CloudPool
Retourtype
Uitzonderingen
list_usage_metrics
Een lijst met de metrische gegevens over gebruik, geaggregeerd per pool voor afzonderlijke tijdsintervallen, voor het opgegeven account.
Als u geen $filter component met inbegrip van een poolId opgeeft, bevat het antwoord alle pools die in het account bestonden in het tijdsbereik van de geretourneerde aggregatie-intervallen. Als u geen $filter-component opgeeft, inclusief een startTime of endTime, worden deze filters standaard toegepast op de begin- en eindtijd van het laatste aggregatie-interval dat momenteel beschikbaar is; dat wil gezegd dat alleen het laatste aggregatie-interval wordt geretourneerd.
list_usage_metrics(pool_list_usage_metrics_options=None, custom_headers=None, raw=False, **operation_config)Parameters
- pool_list_usage_metrics_options
- PoolListUsageMetricsOptions
Aanvullende parameters voor de bewerking
- raw
- bool
retourneert het directe antwoord naast het gedeserialiseerde antwoord
- operation_config
Bewerkingsconfiguratie overschrijft.
Retouren
Een iterator zoals een exemplaar van PoolUsageMetrics
Retourtype
Uitzonderingen
patch
Updates de eigenschappen van de opgegeven pool.
Hiermee vervangt u alleen de pooleigenschappen die in de aanvraag zijn opgegeven. Als er bijvoorbeeld aan de pool een StartTask is gekoppeld en een aanvraag geen StartTask-element opgeeft, behoudt de pool de bestaande StartTask.
patch(pool_id, pool_patch_parameter, pool_patch_options=None, custom_headers=None, raw=False, **operation_config)Parameters
- raw
- bool
retourneert het directe antwoord naast het gedeserialiseerde antwoord
- operation_config
Bewerkingsconfiguratie overschrijft.
Retouren
None of ClientRawResponse indien raw=true
Retourtype
Uitzonderingen
remove_nodes
Hiermee verwijdert u rekenknooppunten uit de opgegeven pool.
Deze bewerking kan alleen worden uitgevoerd wanneer de toewijzingsstatus van de pool stabiel is. Wanneer deze bewerking wordt uitgevoerd, verandert de toewijzingsstatus van constant in wijzigen van formaat. Elke aanvraag kan maximaal 100 knooppunten verwijderen.
remove_nodes(pool_id, node_remove_parameter, pool_remove_nodes_options=None, custom_headers=None, raw=False, **operation_config)Parameters
- pool_remove_nodes_options
- PoolRemoveNodesOptions
Aanvullende parameters voor de bewerking
- raw
- bool
retourneert het directe antwoord naast het gedeserialiseerde antwoord
- operation_config
Bewerkingsconfiguratie overschrijft.
Retouren
None of ClientRawResponse indien raw=true
Retourtype
Uitzonderingen
resize
Hiermee wijzigt u het aantal rekenknooppunten dat is toegewezen aan een pool.
U kunt het formaat van een pool alleen wijzigen wanneer de toewijzingsstatus stabiel is. Als het formaat van de groep al wordt gewijzigd, mislukt de aanvraag met statuscode 409. Wanneer u het formaat van een pool wijzigt, verandert de toewijzingsstatus van de pool van constant in het wijzigen van het formaat. U kunt de grootte van pools die zijn geconfigureerd voor automatisch schalen niet wijzigen. Als u dit probeert te doen, retourneert de Batch-service fout 409. Als u de grootte van een pool omlaag wijzigt, kiest de Batch-service welke rekenknooppunten u wilt verwijderen. Als u specifieke rekenknooppunten wilt verwijderen, gebruikt u in plaats daarvan de API Rekenknooppunten groep verwijderen.
resize(pool_id, pool_resize_parameter, pool_resize_options=None, custom_headers=None, raw=False, **operation_config)Parameters
- pool_resize_options
- PoolResizeOptions
Aanvullende parameters voor de bewerking
- raw
- bool
retourneert het directe antwoord naast het gedeserialiseerde antwoord
- operation_config
Bewerkingsconfiguratie overschrijft.
Retouren
None of ClientRawResponse indien raw=true
Retourtype
Uitzonderingen
stop_resize
Hiermee stopt u een doorlopende bewerking voor het wijzigen van het formaat van de pool.
Hiermee wordt de pool niet teruggezet naar de vorige status vóór de bewerking voor het wijzigen van het formaat: er worden alleen verdere wijzigingen gestopt en de pool behoudt de huidige status. Na het stoppen stabiliseert de pool zich op het aantal rekenknooppunten waarop het was toen de stopbewerking werd uitgevoerd. Tijdens de stopbewerking verandert de pooltoewijzingsstatus eerst in stoppen en vervolgens in stabiel. Een bewerking voor het wijzigen van het formaat hoeft geen expliciete aanvraag voor het wijzigen van het formaat van de groep te zijn; deze API kan ook worden gebruikt om de eerste grootte van de pool te stoppen wanneer deze wordt gemaakt.
stop_resize(pool_id, pool_stop_resize_options=None, custom_headers=None, raw=False, **operation_config)Parameters
- pool_stop_resize_options
- PoolStopResizeOptions
Aanvullende parameters voor de bewerking
- raw
- bool
retourneert het directe antwoord naast het gedeserialiseerde antwoord
- operation_config
Bewerkingsconfiguratie overschrijft.
Retouren
None of ClientRawResponse indien raw=true
Retourtype
Uitzonderingen
update_properties
Updates de eigenschappen van de opgegeven pool.
Hiermee worden alle bijwerkbare eigenschappen van de pool volledig vervangen. Als er bijvoorbeeld aan de pool een StartTask is gekoppeld en als StartTask niet is opgegeven bij deze aanvraag, verwijdert de Batch-service de bestaande StartTask.
update_properties(pool_id, pool_update_properties_parameter, pool_update_properties_options=None, custom_headers=None, raw=False, **operation_config)Parameters
- pool_update_properties_parameter
- PoolUpdatePropertiesParameter
De parameters voor de aanvraag.
- pool_update_properties_options
- PoolUpdatePropertiesOptions
Aanvullende parameters voor de bewerking
- raw
- bool
retourneert het directe antwoord naast het gedeserialiseerde antwoord
- operation_config
Bewerkingsconfiguratie overschrijft.
Retouren
None of ClientRawResponse indien raw=true
Retourtype
Uitzonderingen
Kenmerken
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
Binnenkort beschikbaar: In de loop van 2024 zullen we GitHub-problemen geleidelijk uitfaseren als het feedbackmechanisme voor inhoud en deze vervangen door een nieuw feedbacksysteem. Zie voor meer informatie: https://aka.ms/ContentUserFeedback.
Feedback verzenden en weergeven voor