PoolOperations Klasse
PoolOperations-Vorgänge.
Sie sollten diese Klasse nicht direkt instanziieren, sondern einen Client instance erstellen, der sie für Sie erstellt und als Attribut anfügen wird.
- Vererbung
-
builtins.objectPoolOperations
Konstruktor
PoolOperations(client, config, serializer, deserializer)Parameter
- client
Client für Dienstanforderungen.
- config
Konfiguration des Dienstclients.
- serializer
Ein Objektmodellserialisierungsprogramm.
- deserializer
Ein Objektmodell-Deserialisierer.
Variablen
- api_version
API-Version, die für die Anforderung verwendet werden soll. Konstanter Wert: "2023-05-01.17.0".
Methoden
| add |
Fügt dem angegebenen Konto einen Pool hinzu. Vermeiden Sie beim Benennen von Pools das Einschließen vertraulicher Informationen wie Benutzernamen oder geheimer Projektnamen. Diese Informationen können in Telemetrieprotokollen enthalten sein, auf die Microsoft-Supporttechniker zugreifen können. |
| delete |
Löscht einen Pool aus dem angegebenen Konto. Wenn Sie die Löschung eines Pools anfordern, werden die folgenden Aktionen ausgeführt: Der Poolstatus ist auf Löschen festgelegt; jeder laufende Größenänderungsvorgang für den Pool wird beendet. der Batch-Dienst beginnt, die Größe des Pools auf 0 Computeknoten zu ändern. Alle Aufgaben, die auf vorhandenen Computeknoten ausgeführt werden, werden beendet und erneut in die Warteschlange gestellt (als ob ein Vorgang zum Ändern der Größe des Pools mit der Standardoption "Requeue" angefordert wurde); schließlich wird der Pool aus dem System entfernt. Da ausgeführte Aufgaben erneut in die Warteschlange gestellt werden, kann der Benutzer diese Aufgaben erneut ausführen, indem er seinen Auftrag aktualisiert, um einen anderen Pool als Ziel zu verwenden. Die Tasks können dann im neuen Pool ausgeführt werden. Wenn Sie das Verhalten bei der erneuten Warteschlange überschreiben möchten, sollten Sie den Pool explizit aufrufen, um die Größe des Pools auf null zu verkleinern, bevor Sie den Pool löschen. Wenn Sie eine Update-, Patch- oder Delete-API für einen Pool im Löschstatus aufrufen, tritt ein Fehler mit HTTP-status Code 409 mit dem Fehlercode PoolBeingDeleted auf. |
| disable_auto_scale |
Deaktiviert die automatische Skalierung für einen Pool. |
| enable_auto_scale |
Aktiviert die automatische Skalierung für einen Pool. Sie können die automatische Skalierung für einen Pool nicht aktivieren, wenn ein Größenänderungsvorgang für den Pool ausgeführt wird. Wenn die automatische Skalierung des Pools derzeit deaktiviert ist, müssen Sie eine gültige Formel für die autoskalierte Skalierung als Teil der Anforderung angeben. Wenn die automatische Skalierung des Pools bereits aktiviert ist, können Sie eine neue Formel für die autoskalierte Skalierung und/oder ein neues Auswertungsintervall angeben. Sie können diese API nicht mehr als einmal alle 30 Sekunden für denselben Pool aufrufen. |
| evaluate_auto_scale |
Ruft das Ergebnis der Auswertung einer Formel für die automatische Skalierung im Pool ab. Diese API dient in erster Linie zur Validierung einer Formel für die autoskalierte Skalierung, da sie einfach das Ergebnis zurückgibt, ohne die Formel auf den Pool anzuwenden. Für den Pool muss die automatische Skalierung aktiviert sein, um eine Formel auszuwerten. |
| exists |
Ruft grundlegende Eigenschaften eines Pools ab. |
| get |
Ruft Informationen zum angegebenen Pool ab. |
| list |
Listet alle Pools im angegebenen Konto auf. |
| list_usage_metrics |
Listet die Nutzungsmetriken auf, die vom Pool über einzelne Zeitintervalle hinweg aggregiert werden, für das angegebene Konto. Wenn Sie keine $filter-Klausel angeben, die eine poolId enthält, enthält die Antwort alle Pools, die im Konto im Zeitbereich der zurückgegebenen Aggregationsintervalle vorhanden waren. Wenn Sie keine $filter-Klausel angeben, die startTime oder endTime enthält, werden für diese Filter standardmäßig die Start- und Endzeiten des letzten derzeit verfügbaren Aggregationsintervalls verwendet. Das heißt, es wird nur das letzte Aggregationsintervall zurückgegeben. |
| patch |
Updates die Eigenschaften des angegebenen Pools. Dadurch werden nur die Pooleigenschaften ersetzt, die in der Anforderung angegeben sind. Wenn dem Pool beispielsweise ein StartTask zugeordnet ist und eine Anforderung kein StartTask-Element angibt, behält der Pool den vorhandenen StartTask bei. |
| remove_nodes |
Entfernt Computeknoten aus dem angegebenen Pool. Dieser Vorgang kann nur ausgeführt werden, wenn der Zuordnungsstatus des Pools konstant ist. Wenn dieser Vorgang ausgeführt wird, ändert sich der Zuordnungsstatus von stabil zu Größe. Jede Anforderung kann bis zu 100 Knoten entfernen. |
| resize |
Ändert die Anzahl der Computeknoten, die einem Pool zugewiesen sind. Sie können die Größe eines Pools nur ändern, wenn der Zuordnungsstatus konstant ist. Wenn die Größe des Pools bereits geändert wird, schlägt die Anforderung mit status Code 409 fehl. Wenn Sie die Größe eines Pools ändern, ändert sich der Zuordnungsstatus des Pools von "stabil" in "Größe". Sie können die Größe von Pools, die für die automatische Skalierung konfiguriert sind, nicht ändern. Wenn Sie dies versuchen, gibt der Batch-Dienst den Fehler 409 zurück. Wenn Sie die Größe eines Pools nach unten ändern, wählt der Batch-Dienst aus, welche Computeknoten entfernt werden sollen. Um bestimmte Computeknoten zu entfernen, verwenden Sie stattdessen die Api zum Entfernen von Computeknoten im Pool. |
| stop_resize |
Beendet einen laufenden Größenänderungsvorgang für den Pool. Dadurch wird der Pool vor dem Größenänderungsvorgang nicht in seinen vorherigen Zustand wiederhergestellt: Es wird nur alle weiteren Änderungen beendet, die vorgenommen werden, und der Pool behält seinen aktuellen Zustand bei. Nach dem Beenden stabilisiert sich der Pool bei der Anzahl der Computeknoten, an der er sich befand, als der Beendenvorgang abgeschlossen wurde. Während des Beendigungsvorgangs ändert sich der Poolzuordnungsstatus zuerst in "Beenden" und dann in "stabil". Ein Größenänderungsvorgang muss keine explizite Pooländerungsanforderung sein. Diese API kann auch verwendet werden, um die anfängliche Größenanpassung des Pools beim Erstellen anzuhalten. |
| update_properties |
Updates die Eigenschaften des angegebenen Pools. Dadurch werden alle aktualisierbaren Eigenschaften des Pools vollständig ersetzt. Wenn dem Pool beispielsweise ein StartTask zugeordnet ist und StartTask mit dieser Anforderung nicht angegeben ist, entfernt der Batch-Dienst den vorhandenen StartTask. |
add
Fügt dem angegebenen Konto einen Pool hinzu.
Vermeiden Sie beim Benennen von Pools das Einschließen vertraulicher Informationen wie Benutzernamen oder geheimer Projektnamen. Diese Informationen können in Telemetrieprotokollen enthalten sein, auf die Microsoft-Supporttechniker zugreifen können.
add(pool, pool_add_options=None, custom_headers=None, raw=False, **operation_config)Parameter
- raw
- bool
gibt die direkte Antwort zusammen mit der deserialisierten Antwort zurück.
- operation_config
Außerkraftsetzungen der Vorgangskonfiguration.
Gibt zurück
None oder ClientRawResponse if raw=true
Rückgabetyp
Ausnahmen
delete
Löscht einen Pool aus dem angegebenen Konto.
Wenn Sie die Löschung eines Pools anfordern, werden die folgenden Aktionen ausgeführt: Der Poolstatus ist auf Löschen festgelegt; jeder laufende Größenänderungsvorgang für den Pool wird beendet. der Batch-Dienst beginnt, die Größe des Pools auf 0 Computeknoten zu ändern. Alle Aufgaben, die auf vorhandenen Computeknoten ausgeführt werden, werden beendet und erneut in die Warteschlange gestellt (als ob ein Vorgang zum Ändern der Größe des Pools mit der Standardoption "Requeue" angefordert wurde); schließlich wird der Pool aus dem System entfernt. Da ausgeführte Aufgaben erneut in die Warteschlange gestellt werden, kann der Benutzer diese Aufgaben erneut ausführen, indem er seinen Auftrag aktualisiert, um einen anderen Pool als Ziel zu verwenden. Die Tasks können dann im neuen Pool ausgeführt werden. Wenn Sie das Verhalten bei der erneuten Warteschlange überschreiben möchten, sollten Sie den Pool explizit aufrufen, um die Größe des Pools auf null zu verkleinern, bevor Sie den Pool löschen. Wenn Sie eine Update-, Patch- oder Delete-API für einen Pool im Löschstatus aufrufen, tritt ein Fehler mit HTTP-status Code 409 mit dem Fehlercode PoolBeingDeleted auf.
delete(pool_id, pool_delete_options=None, custom_headers=None, raw=False, **operation_config)Parameter
- raw
- bool
gibt die direkte Antwort zusammen mit der deserialisierten Antwort zurück.
- operation_config
Außerkraftsetzungen der Vorgangskonfiguration.
Gibt zurück
None oder ClientRawResponse if raw=true
Rückgabetyp
Ausnahmen
disable_auto_scale
Deaktiviert die automatische Skalierung für einen Pool.
disable_auto_scale(pool_id, pool_disable_auto_scale_options=None, custom_headers=None, raw=False, **operation_config)Parameter
- pool_id
- str
Die ID des Pools, für den die automatische Skalierung deaktiviert werden soll.
- pool_disable_auto_scale_options
- PoolDisableAutoScaleOptions
Zusätzliche Parameter für den Vorgang
- raw
- bool
gibt die direkte Antwort zusammen mit der deserialisierten Antwort zurück.
- operation_config
Außerkraftsetzungen der Vorgangskonfiguration.
Gibt zurück
None oder ClientRawResponse if raw=true
Rückgabetyp
Ausnahmen
enable_auto_scale
Aktiviert die automatische Skalierung für einen Pool.
Sie können die automatische Skalierung für einen Pool nicht aktivieren, wenn ein Größenänderungsvorgang für den Pool ausgeführt wird. Wenn die automatische Skalierung des Pools derzeit deaktiviert ist, müssen Sie eine gültige Formel für die autoskalierte Skalierung als Teil der Anforderung angeben. Wenn die automatische Skalierung des Pools bereits aktiviert ist, können Sie eine neue Formel für die autoskalierte Skalierung und/oder ein neues Auswertungsintervall angeben. Sie können diese API nicht mehr als einmal alle 30 Sekunden für denselben Pool aufrufen.
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)Parameter
- pool_id
- str
Die ID des Pools, für den die automatische Skalierung aktiviert werden soll.
- auto_scale_formula
- str
Die Formel wird auf Gültigkeit überprüft, bevor sie auf den Pool angewendet wird. Wenn die Formel ungültig ist, lehnt der Batch-Dienst die Anforderung mit detaillierten Fehlerinformationen ab. Weitere Informationen zum Angeben dieser Formel finden Sie unter Automatisches Skalieren von Computeknoten in einem Azure Batch Pool (https://azure.microsoft.com/en-us/documentation/articles/batch-automatic-scaling).
- auto_scale_evaluation_interval
- <xref:timedelta>
Der Standardwert beträgt 15 Minuten. Der Mindest- und Höchstwert beträgt 5 Minuten bzw. 168 Stunden. Wenn Sie einen Wert angeben, der kleiner als 5 Minuten oder größer als 168 Stunden ist, lehnt der Batch-Dienst die Anforderung mit einem ungültigen Eigenschaftswertfehler ab. Wenn Sie die REST-API direkt aufrufen, ist der HTTP-status Code 400 (ungültige Anforderung). Wenn Sie ein neues Intervall angeben, wird der vorhandene Auswertungszeitplan für die autoskalierte Skalierung beendet, und ein neuer Auswertungszeitplan für die automatische Skalierung wird gestartet, dessen Startzeit der Zeitpunkt ist, zu dem diese Anforderung ausgestellt wurde.
- pool_enable_auto_scale_options
- PoolEnableAutoScaleOptions
Zusätzliche Parameter für den Vorgang
- raw
- bool
gibt die direkte Antwort zusammen mit der deserialisierten Antwort zurück.
- operation_config
Außerkraftsetzungen der Vorgangskonfiguration.
Gibt zurück
None oder ClientRawResponse if raw=true
Rückgabetyp
Ausnahmen
evaluate_auto_scale
Ruft das Ergebnis der Auswertung einer Formel für die automatische Skalierung im Pool ab.
Diese API dient in erster Linie zur Validierung einer Formel für die autoskalierte Skalierung, da sie einfach das Ergebnis zurückgibt, ohne die Formel auf den Pool anzuwenden. Für den Pool muss die automatische Skalierung aktiviert sein, um eine Formel auszuwerten.
evaluate_auto_scale(pool_id, auto_scale_formula, pool_evaluate_auto_scale_options=None, custom_headers=None, raw=False, **operation_config)Parameter
- pool_id
- str
Die ID des Pools, für den die Formel für die automatische Skalierung ausgewertet werden soll.
- auto_scale_formula
- str
Die Formel wird überprüft und ihre Ergebnisse berechnet, aber sie wird nicht auf den Pool angewendet. Um die Formel auf den Pool anzuwenden, aktivieren Sie die automatische Skalierung für einen Pool. Weitere Informationen zum Angeben dieser Formel finden Sie unter Automatisches Skalieren von Computeknoten in einem Azure Batch Pool (https://azure.microsoft.com/en-us/documentation/articles/batch-automatic-scaling).
- pool_evaluate_auto_scale_options
- PoolEvaluateAutoScaleOptions
Zusätzliche Parameter für den Vorgang
- raw
- bool
gibt die direkte Antwort zusammen mit der deserialisierten Antwort zurück.
- operation_config
Außerkraftsetzungen der Vorgangskonfiguration.
Gibt zurück
AutoScaleRun oder ClientRawResponse if raw=true
Rückgabetyp
Ausnahmen
exists
Ruft grundlegende Eigenschaften eines Pools ab.
exists(pool_id, pool_exists_options=None, custom_headers=None, raw=False, **operation_config)Parameter
- raw
- bool
gibt die direkte Antwort zusammen mit der deserialisierten Antwort zurück.
- operation_config
Außerkraftsetzungen der Vorgangskonfiguration.
Gibt zurück
bool oder ClientRawResponse if raw=true
Rückgabetyp
Ausnahmen
get
Ruft Informationen zum angegebenen Pool ab.
get(pool_id, pool_get_options=None, custom_headers=None, raw=False, **operation_config)Parameter
- raw
- bool
gibt die direkte Antwort zusammen mit der deserialisierten Antwort zurück.
- operation_config
Außerkraftsetzungen der Vorgangskonfiguration.
Gibt zurück
CloudPool oder ClientRawResponse if raw=true
Rückgabetyp
Ausnahmen
list
Listet alle Pools im angegebenen Konto auf.
list(pool_list_options=None, custom_headers=None, raw=False, **operation_config)Parameter
- raw
- bool
gibt die direkte Antwort zusammen mit der deserialisierten Antwort zurück.
- operation_config
Außerkraftsetzungen der Vorgangskonfiguration.
Gibt zurück
Ein Iterator wie instance von CloudPool
Rückgabetyp
Ausnahmen
list_usage_metrics
Listet die Nutzungsmetriken auf, die vom Pool über einzelne Zeitintervalle hinweg aggregiert werden, für das angegebene Konto.
Wenn Sie keine $filter-Klausel angeben, die eine poolId enthält, enthält die Antwort alle Pools, die im Konto im Zeitbereich der zurückgegebenen Aggregationsintervalle vorhanden waren. Wenn Sie keine $filter-Klausel angeben, die startTime oder endTime enthält, werden für diese Filter standardmäßig die Start- und Endzeiten des letzten derzeit verfügbaren Aggregationsintervalls verwendet. Das heißt, es wird nur das letzte Aggregationsintervall zurückgegeben.
list_usage_metrics(pool_list_usage_metrics_options=None, custom_headers=None, raw=False, **operation_config)Parameter
- pool_list_usage_metrics_options
- PoolListUsageMetricsOptions
Zusätzliche Parameter für den Vorgang
- raw
- bool
gibt die direkte Antwort zusammen mit der deserialisierten Antwort zurück.
- operation_config
Außerkraftsetzungen der Vorgangskonfiguration.
Gibt zurück
Ein Iterator wie instance von PoolUsageMetrics
Rückgabetyp
Ausnahmen
patch
Updates die Eigenschaften des angegebenen Pools.
Dadurch werden nur die Pooleigenschaften ersetzt, die in der Anforderung angegeben sind. Wenn dem Pool beispielsweise ein StartTask zugeordnet ist und eine Anforderung kein StartTask-Element angibt, behält der Pool den vorhandenen StartTask bei.
patch(pool_id, pool_patch_parameter, pool_patch_options=None, custom_headers=None, raw=False, **operation_config)Parameter
- raw
- bool
gibt die direkte Antwort zusammen mit der deserialisierten Antwort zurück.
- operation_config
Außerkraftsetzungen der Vorgangskonfiguration.
Gibt zurück
None oder ClientRawResponse if raw=true
Rückgabetyp
Ausnahmen
remove_nodes
Entfernt Computeknoten aus dem angegebenen Pool.
Dieser Vorgang kann nur ausgeführt werden, wenn der Zuordnungsstatus des Pools konstant ist. Wenn dieser Vorgang ausgeführt wird, ändert sich der Zuordnungsstatus von stabil zu Größe. Jede Anforderung kann bis zu 100 Knoten entfernen.
remove_nodes(pool_id, node_remove_parameter, pool_remove_nodes_options=None, custom_headers=None, raw=False, **operation_config)Parameter
- pool_remove_nodes_options
- PoolRemoveNodesOptions
Zusätzliche Parameter für den Vorgang
- operation_config
Außerkraftsetzungen der Vorgangskonfiguration.
Gibt zurück
None oder ClientRawResponse if raw=true
Rückgabetyp
Ausnahmen
resize
Ändert die Anzahl der Computeknoten, die einem Pool zugewiesen sind.
Sie können die Größe eines Pools nur ändern, wenn der Zuordnungsstatus konstant ist. Wenn die Größe des Pools bereits geändert wird, schlägt die Anforderung mit status Code 409 fehl. Wenn Sie die Größe eines Pools ändern, ändert sich der Zuordnungsstatus des Pools von "stabil" in "Größe". Sie können die Größe von Pools, die für die automatische Skalierung konfiguriert sind, nicht ändern. Wenn Sie dies versuchen, gibt der Batch-Dienst den Fehler 409 zurück. Wenn Sie die Größe eines Pools nach unten ändern, wählt der Batch-Dienst aus, welche Computeknoten entfernt werden sollen. Um bestimmte Computeknoten zu entfernen, verwenden Sie stattdessen die Api zum Entfernen von Computeknoten im Pool.
resize(pool_id, pool_resize_parameter, pool_resize_options=None, custom_headers=None, raw=False, **operation_config)Parameter
- operation_config
Außerkraftsetzungen der Vorgangskonfiguration.
Gibt zurück
None oder ClientRawResponse if raw=true
Rückgabetyp
Ausnahmen
stop_resize
Beendet einen laufenden Größenänderungsvorgang für den Pool.
Dadurch wird der Pool vor dem Größenänderungsvorgang nicht in seinen vorherigen Zustand wiederhergestellt: Es wird nur alle weiteren Änderungen beendet, die vorgenommen werden, und der Pool behält seinen aktuellen Zustand bei. Nach dem Beenden stabilisiert sich der Pool bei der Anzahl der Computeknoten, an der er sich befand, als der Beendenvorgang abgeschlossen wurde. Während des Beendigungsvorgangs ändert sich der Poolzuordnungsstatus zuerst in "Beenden" und dann in "stabil". Ein Größenänderungsvorgang muss keine explizite Pooländerungsanforderung sein. Diese API kann auch verwendet werden, um die anfängliche Größenanpassung des Pools beim Erstellen anzuhalten.
stop_resize(pool_id, pool_stop_resize_options=None, custom_headers=None, raw=False, **operation_config)Parameter
- pool_stop_resize_options
- PoolStopResizeOptions
Zusätzliche Parameter für den Vorgang
- operation_config
Außerkraftsetzungen der Vorgangskonfiguration.
Gibt zurück
None oder ClientRawResponse if raw=true
Rückgabetyp
Ausnahmen
update_properties
Updates die Eigenschaften des angegebenen Pools.
Dadurch werden alle aktualisierbaren Eigenschaften des Pools vollständig ersetzt. Wenn dem Pool beispielsweise ein StartTask zugeordnet ist und StartTask mit dieser Anforderung nicht angegeben ist, entfernt der Batch-Dienst den vorhandenen StartTask.
update_properties(pool_id, pool_update_properties_parameter, pool_update_properties_options=None, custom_headers=None, raw=False, **operation_config)Parameter
- pool_update_properties_parameter
- PoolUpdatePropertiesParameter
Die Parameter für die Anforderung.
- pool_update_properties_options
- PoolUpdatePropertiesOptions
Zusätzliche Parameter für den Vorgang
- operation_config
Außerkraftsetzungen der Vorgangskonfiguration.
Gibt zurück
None oder ClientRawResponse if raw=true
Rückgabetyp
Ausnahmen
Attribute
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