PoolOperations Classe
Operazioni PoolOperations.
Non è consigliabile creare un'istanza diretta di questa classe, ma creare un'istanza client che lo creerà per l'utente e collegarlo come attributo.
- Ereditarietà
-
builtins.objectPoolOperations
Costruttore
PoolOperations(client, config, serializer, deserializer)Parametri
- client
Client per le richieste di servizio.
- config
Configurazione del client del servizio.
- serializer
Serializzatore di modelli a oggetti.
- deserializer
Deserializzatore del modello a oggetti.
Variabili
- api_version
Versione dell'API da usare per la richiesta. Valore costante: "2023-05-01.17.0".
Metodi
| add |
Aggiunge un pool all'account specificato. Quando si denominano pool, evitare di includere informazioni riservate, ad esempio nomi utente o nomi di progetto segreti. Queste informazioni potrebbero essere visualizzate nei log di telemetria accessibili ai tecnici del supporto tecnico Microsoft. |
| delete |
Elimina un pool dall'account specificato. Quando si richiede l'eliminazione di un pool, si verificano le azioni seguenti: lo stato del pool è impostato sull'eliminazione; tutte le operazioni di ridimensionamento in corso nel pool vengono arrestate; il servizio Batch avvia il ridimensionamento del pool in zero nodi di calcolo; tutte le attività in esecuzione nei nodi di calcolo esistenti vengono terminate e riqueuate (come se fosse stata richiesta un'operazione di ridimensionamento del pool con l'opzione di ripetizione predefinita); infine, il pool viene rimosso dal sistema. Poiché l'esecuzione di Attività viene riqueuata, l'utente può rieseguire queste attività aggiornando il processo in modo che venga usata come destinazione di un pool diverso. Le attività possono quindi essere eseguite nel nuovo pool. Se si vuole eseguire l'override del comportamento di ripetizione, è consigliabile chiamare il pool in modo esplicito per compattare il pool in dimensioni zero prima di eliminare il pool. Se si chiama un'API Update, Patch o Delete in un pool nello stato di eliminazione, il problema avrà esito negativo con il codice di stato HTTP 409 con il codice di errore PoolBeingDeleted. |
| disable_auto_scale |
Disabilita il ridimensionamento automatico per un pool. |
| enable_auto_scale |
Consente il ridimensionamento automatico per un pool. Non è possibile abilitare la scalabilità automatica in un pool se un'operazione di ridimensionamento è in corso nel pool. Se il ridimensionamento automatico del pool è attualmente disabilitato, è necessario specificare una formula di scalabilità automatica valida come parte della richiesta. Se il ridimensionamento automatico del pool è già abilitato, è possibile specificare una nuova formula di scalabilità automatica e/o un nuovo intervallo di valutazione. Non è possibile chiamare questa API per lo stesso pool più di una volta ogni 30 secondi. |
| evaluate_auto_scale |
Ottiene il risultato della valutazione di una formula di ridimensionamento automatica nel pool. Questa API è principalmente per convalidare una formula di scalabilità automatica, perché restituisce semplicemente il risultato senza applicare la formula al pool. Il pool deve avere il ridimensionamento automatico abilitato per valutare una formula. |
| exists |
Ottiene le proprietà di base di un pool. |
| get |
Ottiene informazioni sul pool specificato. |
| list |
Elenca tutti i pool nell'account specificato. |
| list_usage_metrics |
Elenca le metriche di utilizzo, aggregate in pool tra singoli intervalli di tempo, per l'account specificato. Se non si specifica una clausola $filter inclusa un poolId, la risposta include tutti i pool esistenti nell'intervallo di tempo degli intervalli di aggregazione restituiti. Se non si specifica una clausola $filter, inclusa una clausola startTime o endTime, questi filtri vengono predefiniti per l'ora di inizio e fine dell'ultimo intervallo di aggregazione attualmente disponibile; ovvero, viene restituito solo l'ultimo intervallo di aggregazione. |
| patch |
Aggiornamenti le proprietà del pool specificato. In questo modo vengono sostituite solo le proprietà pool specificate nella richiesta. Ad esempio, se il pool ha un StartTask associato a esso e una richiesta non specifica un elemento StartTask, il pool mantiene l'esistente StartTask. |
| remove_nodes |
Rimuove i nodi di calcolo dal pool specificato. Questa operazione può essere eseguita solo quando lo stato di allocazione del pool è costante. Quando viene eseguita questa operazione, lo stato di allocazione cambia da costante a ridimensionamento. Ogni richiesta può rimuovere fino a 100 nodi. |
| resize |
Modifica il numero di nodi di calcolo assegnati a un pool. È possibile ridimensionare un pool solo quando lo stato di allocazione è costante. Se il ridimensionamento del pool è già ridimensionato, la richiesta ha esito negativo con il codice di stato 409. Quando si ridimensiona un pool, lo stato di allocazione del pool cambia da costante a ridimensionamento. Non è possibile ridimensionare i pool configurati per il ridimensionamento automatico. Se si tenta di eseguire questa operazione, il servizio Batch restituisce un errore 409. Se si ridimensiona un pool verso il basso, il servizio Batch sceglie quali nodi di calcolo rimuovere. Per rimuovere nodi di calcolo specifici, usare invece l'API Nodi di calcolo rimossa dal pool. |
| stop_resize |
Arresta un'operazione di ridimensionamento in corso nel pool. Questo non ripristina lo stato precedente del pool prima dell'operazione di ridimensionamento: interrompe solo eventuali ulteriori modifiche apportate e il pool mantiene lo stato corrente. Dopo l'arresto, il pool si stabilizza al numero di nodi di calcolo in corrispondenza del momento in cui è stata eseguita l'operazione di arresto. Durante l'operazione di arresto, lo stato di allocazione pool cambia prima di tutto per arrestare e quindi per essere costante. Un'operazione di ridimensionamento non deve essere una richiesta di ridimensionamento esplicita del pool; questa API può essere usata anche per arrestare il ridimensionamento iniziale del pool quando viene creato. |
| update_properties |
Aggiornamenti le proprietà del pool specificato. Questo sostituisce completamente tutte le proprietà aggiornabili del pool. Ad esempio, se il pool ha un StartTask associato a esso e se StartTask non è specificato con questa richiesta, il servizio Batch rimuoverà l'esistente StartTask. |
add
Aggiunge un pool all'account specificato.
Quando si denominano pool, evitare di includere informazioni riservate, ad esempio nomi utente o nomi di progetto segreti. Queste informazioni potrebbero essere visualizzate nei log di telemetria accessibili ai tecnici del supporto tecnico Microsoft.
add(pool, pool_add_options=None, custom_headers=None, raw=False, **operation_config)Parametri
- raw
- bool
restituisce la risposta diretta insieme alla risposta deserializzata
- operation_config
La configurazione dell'operazione esegue l'override.
Restituisce
Nessuno o ClientRawResponse se raw=true
Tipo restituito
Eccezioni
delete
Elimina un pool dall'account specificato.
Quando si richiede l'eliminazione di un pool, si verificano le azioni seguenti: lo stato del pool è impostato sull'eliminazione; tutte le operazioni di ridimensionamento in corso nel pool vengono arrestate; il servizio Batch avvia il ridimensionamento del pool in zero nodi di calcolo; tutte le attività in esecuzione nei nodi di calcolo esistenti vengono terminate e riqueuate (come se fosse stata richiesta un'operazione di ridimensionamento del pool con l'opzione di ripetizione predefinita); infine, il pool viene rimosso dal sistema. Poiché l'esecuzione di Attività viene riqueuata, l'utente può rieseguire queste attività aggiornando il processo in modo che venga usata come destinazione di un pool diverso. Le attività possono quindi essere eseguite nel nuovo pool. Se si vuole eseguire l'override del comportamento di ripetizione, è consigliabile chiamare il pool in modo esplicito per compattare il pool in dimensioni zero prima di eliminare il pool. Se si chiama un'API Update, Patch o Delete in un pool nello stato di eliminazione, il problema avrà esito negativo con il codice di stato HTTP 409 con il codice di errore PoolBeingDeleted.
delete(pool_id, pool_delete_options=None, custom_headers=None, raw=False, **operation_config)Parametri
- pool_delete_options
- PoolDeleteOptions
Parametri aggiuntivi per l'operazione
- raw
- bool
restituisce la risposta diretta insieme alla risposta deserializzata
- operation_config
La configurazione dell'operazione esegue l'override.
Restituisce
Nessuno o ClientRawResponse se raw=true
Tipo restituito
Eccezioni
disable_auto_scale
Disabilita il ridimensionamento automatico per un pool.
disable_auto_scale(pool_id, pool_disable_auto_scale_options=None, custom_headers=None, raw=False, **operation_config)Parametri
- pool_disable_auto_scale_options
- PoolDisableAutoScaleOptions
Parametri aggiuntivi per l'operazione
- raw
- bool
restituisce la risposta diretta insieme alla risposta deserializzata
- operation_config
La configurazione dell'operazione esegue l'override.
Restituisce
Nessuno o ClientRawResponse se raw=true
Tipo restituito
Eccezioni
enable_auto_scale
Consente il ridimensionamento automatico per un pool.
Non è possibile abilitare la scalabilità automatica in un pool se un'operazione di ridimensionamento è in corso nel pool. Se il ridimensionamento automatico del pool è attualmente disabilitato, è necessario specificare una formula di scalabilità automatica valida come parte della richiesta. Se il ridimensionamento automatico del pool è già abilitato, è possibile specificare una nuova formula di scalabilità automatica e/o un nuovo intervallo di valutazione. Non è possibile chiamare questa API per lo stesso pool più di una volta ogni 30 secondi.
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)Parametri
- auto_scale_formula
- str
La formula viene controllata per la validità prima che venga applicata al pool. Se la formula non è valida, il servizio Batch rifiuta la richiesta con informazioni dettagliate sull'errore. Per altre informazioni sulla specifica di questa formula, vedere Ridimensionare automaticamente i nodi di calcolo in un pool di Azure Batch (https://azure.microsoft.com/en-us/documentation/articles/batch-automatic-scaling).
- auto_scale_evaluation_interval
- <xref:timedelta>
Il valore predefinito è 15 minuti. Il valore minimo e massimo sono rispettivamente 5 minuti e 168 ore. Se si specifica un valore minore di 5 minuti o maggiore di 168 ore, il servizio Batch rifiuta la richiesta con un errore del valore della proprietà non valido; se si chiama direttamente l'API REST, il codice di stato HTTP è 400 (richiesta non valida). Se si specifica un nuovo intervallo, la pianificazione di valutazione della scalabilità automatica esistente verrà arrestata e verrà avviata una nuova pianificazione di valutazione della scalabilità automatica, con l'ora di inizio dell'emissione di questa richiesta.
- pool_enable_auto_scale_options
- PoolEnableAutoScaleOptions
Parametri aggiuntivi per l'operazione
- raw
- bool
restituisce la risposta diretta insieme alla risposta deserializzata
- operation_config
La configurazione dell'operazione esegue l'override.
Restituisce
Nessuno o ClientRawResponse se raw=true
Tipo restituito
Eccezioni
evaluate_auto_scale
Ottiene il risultato della valutazione di una formula di ridimensionamento automatica nel pool.
Questa API è principalmente per convalidare una formula di scalabilità automatica, perché restituisce semplicemente il risultato senza applicare la formula al pool. Il pool deve avere il ridimensionamento automatico abilitato per valutare una formula.
evaluate_auto_scale(pool_id, auto_scale_formula, pool_evaluate_auto_scale_options=None, custom_headers=None, raw=False, **operation_config)Parametri
- auto_scale_formula
- str
La formula viene convalidata e i relativi risultati calcolati, ma non vengono applicati al pool. Per applicare la formula al pool, "Abilitare il ridimensionamento automatico in un pool". Per altre informazioni sulla specifica di questa formula, vedere Ridimensionare automaticamente i nodi di calcolo in un pool di Azure Batch (https://azure.microsoft.com/en-us/documentation/articles/batch-automatic-scaling).
- pool_evaluate_auto_scale_options
- PoolEvaluateAutoScaleOptions
Parametri aggiuntivi per l'operazione
- raw
- bool
restituisce la risposta diretta insieme alla risposta deserializzata
- operation_config
La configurazione dell'operazione esegue l'override.
Restituisce
AutoScaleRun o ClientRawResponse se raw=true
Tipo restituito
Eccezioni
exists
Ottiene le proprietà di base di un pool.
exists(pool_id, pool_exists_options=None, custom_headers=None, raw=False, **operation_config)Parametri
- pool_exists_options
- PoolExistsOptions
Parametri aggiuntivi per l'operazione
- raw
- bool
restituisce la risposta diretta insieme alla risposta deserializzata
- operation_config
La configurazione dell'operazione esegue l'override.
Restituisce
bool o ClientRawResponse se raw=true
Tipo restituito
Eccezioni
get
Ottiene informazioni sul pool specificato.
get(pool_id, pool_get_options=None, custom_headers=None, raw=False, **operation_config)Parametri
- raw
- bool
restituisce la risposta diretta insieme alla risposta deserializzata
- operation_config
La configurazione dell'operazione esegue l'override.
Restituisce
CloudPool o ClientRawResponse se raw=true
Tipo restituito
Eccezioni
list
Elenca tutti i pool nell'account specificato.
list(pool_list_options=None, custom_headers=None, raw=False, **operation_config)Parametri
- raw
- bool
restituisce la risposta diretta insieme alla risposta deserializzata
- operation_config
La configurazione dell'operazione esegue l'override.
Restituisce
Iteratore come istanza di CloudPool
Tipo restituito
Eccezioni
list_usage_metrics
Elenca le metriche di utilizzo, aggregate in pool tra singoli intervalli di tempo, per l'account specificato.
Se non si specifica una clausola $filter inclusa un poolId, la risposta include tutti i pool esistenti nell'intervallo di tempo degli intervalli di aggregazione restituiti. Se non si specifica una clausola $filter, inclusa una clausola startTime o endTime, questi filtri vengono predefiniti per l'ora di inizio e fine dell'ultimo intervallo di aggregazione attualmente disponibile; ovvero, viene restituito solo l'ultimo intervallo di aggregazione.
list_usage_metrics(pool_list_usage_metrics_options=None, custom_headers=None, raw=False, **operation_config)Parametri
- pool_list_usage_metrics_options
- PoolListUsageMetricsOptions
Parametri aggiuntivi per l'operazione
- raw
- bool
restituisce la risposta diretta insieme alla risposta deserializzata
- operation_config
La configurazione dell'operazione esegue l'override.
Restituisce
Iteratore come istanza di PoolUsageMetrics
Tipo restituito
Eccezioni
patch
Aggiornamenti le proprietà del pool specificato.
In questo modo vengono sostituite solo le proprietà pool specificate nella richiesta. Ad esempio, se il pool ha un StartTask associato a esso e una richiesta non specifica un elemento StartTask, il pool mantiene l'esistente StartTask.
patch(pool_id, pool_patch_parameter, pool_patch_options=None, custom_headers=None, raw=False, **operation_config)Parametri
- raw
- bool
restituisce la risposta diretta insieme alla risposta deserializzata
- operation_config
La configurazione dell'operazione esegue l'override.
Restituisce
Nessuno o ClientRawResponse se raw=true
Tipo restituito
Eccezioni
remove_nodes
Rimuove i nodi di calcolo dal pool specificato.
Questa operazione può essere eseguita solo quando lo stato di allocazione del pool è costante. Quando viene eseguita questa operazione, lo stato di allocazione cambia da costante a ridimensionamento. Ogni richiesta può rimuovere fino a 100 nodi.
remove_nodes(pool_id, node_remove_parameter, pool_remove_nodes_options=None, custom_headers=None, raw=False, **operation_config)Parametri
- pool_remove_nodes_options
- PoolRemoveNodesOptions
Parametri aggiuntivi per l'operazione
- raw
- bool
restituisce la risposta diretta insieme alla risposta deserializzata
- operation_config
La configurazione dell'operazione esegue l'override.
Restituisce
Nessuno o ClientRawResponse se raw=true
Tipo restituito
Eccezioni
resize
Modifica il numero di nodi di calcolo assegnati a un pool.
È possibile ridimensionare un pool solo quando lo stato di allocazione è costante. Se il ridimensionamento del pool è già ridimensionato, la richiesta ha esito negativo con il codice di stato 409. Quando si ridimensiona un pool, lo stato di allocazione del pool cambia da costante a ridimensionamento. Non è possibile ridimensionare i pool configurati per il ridimensionamento automatico. Se si tenta di eseguire questa operazione, il servizio Batch restituisce un errore 409. Se si ridimensiona un pool verso il basso, il servizio Batch sceglie quali nodi di calcolo rimuovere. Per rimuovere nodi di calcolo specifici, usare invece l'API Nodi di calcolo rimossa dal pool.
resize(pool_id, pool_resize_parameter, pool_resize_options=None, custom_headers=None, raw=False, **operation_config)Parametri
- pool_resize_options
- PoolResizeOptions
Parametri aggiuntivi per l'operazione
- raw
- bool
restituisce la risposta diretta insieme alla risposta deserializzata
- operation_config
La configurazione dell'operazione esegue l'override.
Restituisce
Nessuno o ClientRawResponse se raw=true
Tipo restituito
Eccezioni
stop_resize
Arresta un'operazione di ridimensionamento in corso nel pool.
Questo non ripristina lo stato precedente del pool prima dell'operazione di ridimensionamento: interrompe solo eventuali ulteriori modifiche apportate e il pool mantiene lo stato corrente. Dopo l'arresto, il pool si stabilizza al numero di nodi di calcolo in corrispondenza del momento in cui è stata eseguita l'operazione di arresto. Durante l'operazione di arresto, lo stato di allocazione pool cambia prima di tutto per arrestare e quindi per essere costante. Un'operazione di ridimensionamento non deve essere una richiesta di ridimensionamento esplicita del pool; questa API può essere usata anche per arrestare il ridimensionamento iniziale del pool quando viene creato.
stop_resize(pool_id, pool_stop_resize_options=None, custom_headers=None, raw=False, **operation_config)Parametri
- pool_stop_resize_options
- PoolStopResizeOptions
Parametri aggiuntivi per l'operazione
- raw
- bool
restituisce la risposta diretta insieme alla risposta deserializzata
- operation_config
La configurazione dell'operazione esegue l'override.
Restituisce
Nessuno o ClientRawResponse se raw=true
Tipo restituito
Eccezioni
update_properties
Aggiornamenti le proprietà del pool specificato.
Questo sostituisce completamente tutte le proprietà aggiornabili del pool. Ad esempio, se il pool ha un StartTask associato a esso e se StartTask non è specificato con questa richiesta, il servizio Batch rimuoverà l'esistente StartTask.
update_properties(pool_id, pool_update_properties_parameter, pool_update_properties_options=None, custom_headers=None, raw=False, **operation_config)Parametri
- pool_update_properties_parameter
- PoolUpdatePropertiesParameter
Parametri per la richiesta.
- pool_update_properties_options
- PoolUpdatePropertiesOptions
Parametri aggiuntivi per l'operazione
- raw
- bool
restituisce la risposta diretta insieme alla risposta deserializzata
- operation_config
La configurazione dell'operazione esegue l'override.
Restituisce
Nessuno o ClientRawResponse se raw=true
Tipo restituito
Eccezioni
Attributi
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