PoolOperations Classe
Opérations PoolOperations.
Vous ne devez pas instancier directement cette classe, mais créer un client instance qui la créera pour vous et l’attachera en tant qu’attribut.
- Héritage
-
builtins.objectPoolOperations
Constructeur
PoolOperations(client, config, serializer, deserializer)Paramètres
- client
Client pour les demandes de service.
- config
Configuration du client de service.
- serializer
Sérialiseur de modèle objet.
- deserializer
Désérialiseur de modèle objet.
Variables
- api_version
Version de l’API à utiliser pour la requête. Valeur constante : « 2023-05-01.17.0 ».
Méthodes
| add |
Ajoute un pool au compte spécifié. Lorsque vous nommez des pools, évitez d’inclure des informations sensibles telles que des noms d’utilisateur ou des noms de projet secrets. Ces informations peuvent apparaître dans les journaux de télémétrie accessibles aux ingénieurs du Support Microsoft. |
| delete |
Supprime un pool du compte spécifié. Lorsque vous demandez la suppression d’un pool, les actions suivantes se produisent : l’état du pool est défini sur la suppression ; toute opération de redimensionnement en cours sur le pool est arrêtée ; le service Batch commence à redimensionner le pool à zéro nœuds de calcul ; toutes les tâches s’exécutant sur des nœuds de calcul existants sont arrêtées et mises en file d’attente (comme si une opération de redimensionnement de pool avait été demandée avec l’option de mise en file d’attente par défaut) ; enfin, le pool est supprimé du système. Étant donné que les tâches en cours d’exécution sont remises en file d’attente, l’utilisateur peut réexécuter ces tâches en mettant à jour son travail pour cibler un autre pool. Les tâches peuvent ensuite s’exécuter sur le nouveau pool. Si vous souhaitez remplacer le comportement de la file d’attente, vous devez appeler redimensionner le pool explicitement pour réduire le pool à une taille nulle avant de supprimer le pool. Si vous appelez une API Update, Patch ou Delete sur un pool à l’état de suppression, elle échoue avec le code HTTP status 409 avec le code d’erreur PoolBeingDeleted. |
| disable_auto_scale |
Désactive la mise à l’échelle automatique pour un pool. |
| enable_auto_scale |
Active la mise à l’échelle automatique pour un pool. Vous ne pouvez pas activer la mise à l’échelle automatique sur un pool si une opération de redimensionnement est en cours sur le pool. Si la mise à l’échelle automatique du pool est actuellement désactivée, vous devez spécifier une formule de mise à l’échelle automatique valide dans le cadre de la demande. Si la mise à l’échelle automatique du pool est déjà activée, vous pouvez spécifier une nouvelle formule de mise à l’échelle automatique et/ou un nouvel intervalle d’évaluation. Vous ne pouvez pas appeler cette API pour le même pool plusieurs fois toutes les 30 secondes. |
| evaluate_auto_scale |
Obtient le résultat de l’évaluation d’une formule de mise à l’échelle automatique sur le pool. Cette API est principalement destinée à valider une formule de mise à l’échelle automatique, car elle retourne simplement le résultat sans appliquer la formule au pool. La mise à l’échelle automatique du pool doit être activée pour évaluer une formule. |
| exists |
Obtient les propriétés de base d’un pool. |
| get |
Obtient des informations sur le pool spécifié. |
| list |
Répertorie tous les pools dans le compte spécifié. |
| list_usage_metrics |
Répertorie les métriques d’utilisation, agrégées par pool sur des intervalles de temps individuels, pour le compte spécifié. Si vous ne spécifiez pas de clause $filter incluant un poolId, la réponse inclut tous les pools qui existaient dans le compte dans l’intervalle de temps des intervalles d’agrégation retournés. Si vous ne spécifiez pas de clause $filter incluant un startTime ou endTime, ces filtres correspondent par défaut aux heures de début et de fin du dernier intervalle d’agrégation actuellement disponible ; autrement dit, seul le dernier intervalle d’agrégation est retourné. |
| patch |
Mises à jour les propriétés du pool spécifié. Cela remplace uniquement les propriétés de pool spécifiées dans la demande. Par exemple, si un objet StartTask est associé au pool et qu’une demande ne spécifie pas d’élément StartTask, le pool conserve l’élément StartTask existant. |
| remove_nodes |
Supprime les nœuds de calcul du pool spécifié. Cette opération ne peut s’exécuter que lorsque l’état d’allocation du pool est stable. Lorsque cette opération s’exécute, l’état d’allocation passe de stable à redimensionnement. Chaque requête peut supprimer jusqu’à 100 nœuds. |
| resize |
Modifie le nombre de nœuds de calcul attribués à un pool. Vous ne pouvez redimensionner un pool que lorsque son état d’allocation est stable. Si le pool est déjà en cours de redimensionnement, la demande échoue avec status code 409. Lorsque vous redimensionnez un pool, l’état d’allocation du pool passe de stable à redimensionnement. Vous ne pouvez pas redimensionner les pools qui sont configurés pour la mise à l’échelle automatique. Si vous essayez de procéder ainsi, le service Batch retourne une erreur 409. Si vous redimensionnez un pool vers le bas, le service Batch choisit les nœuds de calcul à supprimer. Pour supprimer des nœuds de calcul spécifiques, utilisez plutôt l’API Supprimer les nœuds de calcul du pool. |
| stop_resize |
Arrête une opération de redimensionnement en cours sur le pool. Cela ne restaure pas le pool à son état précédent avant l’opération de redimensionnement : il arrête uniquement toute autre modification apportée et le pool conserve son état actuel. Après l’arrêt, le pool se stabilise au nombre de nœuds de calcul qu’il était lorsque l’opération d’arrêt a été effectuée. Pendant l’opération d’arrêt, l’état d’allocation du pool passe d’abord à l’arrêt, puis à stable. Une opération de redimensionnement n’a pas besoin d’être une demande de redimensionnement de pool explicite ; cette API peut également être utilisée pour arrêter le dimensionnement initial du pool lors de sa création. |
| update_properties |
Mises à jour les propriétés du pool spécifié. Cela remplace entièrement toutes les propriétés pouvant être mises à jour du pool. Par exemple, si un objet StartTask est associé au pool et si StartTask n’est pas spécifié avec cette demande, le service Batch supprime le StartTask existant. |
add
Ajoute un pool au compte spécifié.
Lorsque vous nommez des pools, évitez d’inclure des informations sensibles telles que des noms d’utilisateur ou des noms de projet secrets. Ces informations peuvent apparaître dans les journaux de télémétrie accessibles aux ingénieurs du Support Microsoft.
add(pool, pool_add_options=None, custom_headers=None, raw=False, **operation_config)Paramètres
- operation_config
La configuration de l’opération remplace.
Retours
None ou ClientRawResponse si raw=true
Type de retour
Exceptions
delete
Supprime un pool du compte spécifié.
Lorsque vous demandez la suppression d’un pool, les actions suivantes se produisent : l’état du pool est défini sur la suppression ; toute opération de redimensionnement en cours sur le pool est arrêtée ; le service Batch commence à redimensionner le pool à zéro nœuds de calcul ; toutes les tâches s’exécutant sur des nœuds de calcul existants sont arrêtées et mises en file d’attente (comme si une opération de redimensionnement de pool avait été demandée avec l’option de mise en file d’attente par défaut) ; enfin, le pool est supprimé du système. Étant donné que les tâches en cours d’exécution sont remises en file d’attente, l’utilisateur peut réexécuter ces tâches en mettant à jour son travail pour cibler un autre pool. Les tâches peuvent ensuite s’exécuter sur le nouveau pool. Si vous souhaitez remplacer le comportement de la file d’attente, vous devez appeler redimensionner le pool explicitement pour réduire le pool à une taille nulle avant de supprimer le pool. Si vous appelez une API Update, Patch ou Delete sur un pool à l’état de suppression, elle échoue avec le code HTTP status 409 avec le code d’erreur PoolBeingDeleted.
delete(pool_id, pool_delete_options=None, custom_headers=None, raw=False, **operation_config)Paramètres
- pool_delete_options
- PoolDeleteOptions
Paramètres supplémentaires pour l’opération
- operation_config
La configuration de l’opération remplace.
Retours
None ou ClientRawResponse si raw=true
Type de retour
Exceptions
disable_auto_scale
Désactive la mise à l’échelle automatique pour un pool.
disable_auto_scale(pool_id, pool_disable_auto_scale_options=None, custom_headers=None, raw=False, **operation_config)Paramètres
- pool_disable_auto_scale_options
- PoolDisableAutoScaleOptions
Paramètres supplémentaires pour l’opération
- operation_config
La configuration de l’opération remplace.
Retours
None ou ClientRawResponse si raw=true
Type de retour
Exceptions
enable_auto_scale
Active la mise à l’échelle automatique pour un pool.
Vous ne pouvez pas activer la mise à l’échelle automatique sur un pool si une opération de redimensionnement est en cours sur le pool. Si la mise à l’échelle automatique du pool est actuellement désactivée, vous devez spécifier une formule de mise à l’échelle automatique valide dans le cadre de la demande. Si la mise à l’échelle automatique du pool est déjà activée, vous pouvez spécifier une nouvelle formule de mise à l’échelle automatique et/ou un nouvel intervalle d’évaluation. Vous ne pouvez pas appeler cette API pour le même pool plusieurs fois toutes les 30 secondes.
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ètres
- auto_scale_formula
- str
La formule est vérifiée pour la validité avant d’être appliquée au pool. Si la formule n’est pas valide, le service Batch rejette la demande avec des informations détaillées sur l’erreur. Pour plus d’informations sur la spécification de cette formule, consultez Mise à l’échelle automatique des nœuds de calcul dans un pool Azure Batch (https://azure.microsoft.com/en-us/documentation/articles/batch-automatic-scaling).
- auto_scale_evaluation_interval
- <xref:timedelta>
La valeur par défaut est 15 minutes. Les valeurs minimale et maximale sont respectivement de 5 minutes et 168 heures. Si vous spécifiez une valeur inférieure à 5 minutes ou supérieure à 168 heures, le service Batch rejette la requête avec une erreur de valeur de propriété non valide ; si vous appelez l’API REST directement, le code http status est 400 (requête incorrecte). Si vous spécifiez un nouvel intervalle, la planification d’évaluation de mise à l’échelle automatique existante est arrêtée et une nouvelle planification d’évaluation de mise à l’échelle automatique est démarrée, l’heure de début étant l’heure à laquelle cette demande a été émise.
- pool_enable_auto_scale_options
- PoolEnableAutoScaleOptions
Paramètres supplémentaires pour l’opération
- operation_config
La configuration de l’opération remplace.
Retours
None ou ClientRawResponse si raw=true
Type de retour
Exceptions
evaluate_auto_scale
Obtient le résultat de l’évaluation d’une formule de mise à l’échelle automatique sur le pool.
Cette API est principalement destinée à valider une formule de mise à l’échelle automatique, car elle retourne simplement le résultat sans appliquer la formule au pool. La mise à l’échelle automatique du pool doit être activée pour évaluer une formule.
evaluate_auto_scale(pool_id, auto_scale_formula, pool_evaluate_auto_scale_options=None, custom_headers=None, raw=False, **operation_config)Paramètres
- auto_scale_formula
- str
La formule est validée et ses résultats calculés, mais elle n’est pas appliquée au pool. Pour appliquer la formule au pool, « Activer la mise à l’échelle automatique sur un pool ». Pour plus d’informations sur la spécification de cette formule, consultez Mise à l’échelle automatique des nœuds de calcul dans un pool Azure Batch (https://azure.microsoft.com/en-us/documentation/articles/batch-automatic-scaling).
- pool_evaluate_auto_scale_options
- PoolEvaluateAutoScaleOptions
Paramètres supplémentaires pour l’opération
- operation_config
La configuration de l’opération remplace.
Retours
AutoScaleRun ou ClientRawResponse si raw=true
Type de retour
Exceptions
exists
Obtient les propriétés de base d’un pool.
exists(pool_id, pool_exists_options=None, custom_headers=None, raw=False, **operation_config)Paramètres
- pool_exists_options
- PoolExistsOptions
Paramètres supplémentaires pour l’opération
- operation_config
La configuration de l’opération remplace.
Retours
bool ou ClientRawResponse si raw=true
Type de retour
Exceptions
get
Obtient des informations sur le pool spécifié.
get(pool_id, pool_get_options=None, custom_headers=None, raw=False, **operation_config)Paramètres
- operation_config
La configuration de l’opération remplace.
Retours
CloudPool ou ClientRawResponse si raw=true
Type de retour
Exceptions
list
Répertorie tous les pools dans le compte spécifié.
list(pool_list_options=None, custom_headers=None, raw=False, **operation_config)Paramètres
- pool_list_options
- PoolListOptions
Paramètres supplémentaires pour l’opération
- operation_config
La configuration de l’opération remplace.
Retours
Un itérateur comme instance de CloudPool
Type de retour
Exceptions
list_usage_metrics
Répertorie les métriques d’utilisation, agrégées par pool sur des intervalles de temps individuels, pour le compte spécifié.
Si vous ne spécifiez pas de clause $filter incluant un poolId, la réponse inclut tous les pools qui existaient dans le compte dans l’intervalle de temps des intervalles d’agrégation retournés. Si vous ne spécifiez pas de clause $filter incluant un startTime ou endTime, ces filtres correspondent par défaut aux heures de début et de fin du dernier intervalle d’agrégation actuellement disponible ; autrement dit, seul le dernier intervalle d’agrégation est retourné.
list_usage_metrics(pool_list_usage_metrics_options=None, custom_headers=None, raw=False, **operation_config)Paramètres
- pool_list_usage_metrics_options
- PoolListUsageMetricsOptions
Paramètres supplémentaires pour l’opération
- operation_config
La configuration de l’opération remplace.
Retours
Un itérateur comme instance de PoolUsageMetrics
Type de retour
Exceptions
patch
Mises à jour les propriétés du pool spécifié.
Cela remplace uniquement les propriétés de pool spécifiées dans la demande. Par exemple, si un objet StartTask est associé au pool et qu’une demande ne spécifie pas d’élément StartTask, le pool conserve l’élément StartTask existant.
patch(pool_id, pool_patch_parameter, pool_patch_options=None, custom_headers=None, raw=False, **operation_config)Paramètres
- pool_patch_options
- PoolPatchOptions
Paramètres supplémentaires pour l’opération
- operation_config
La configuration de l’opération remplace.
Retours
None ou ClientRawResponse si raw=true
Type de retour
Exceptions
remove_nodes
Supprime les nœuds de calcul du pool spécifié.
Cette opération ne peut s’exécuter que lorsque l’état d’allocation du pool est stable. Lorsque cette opération s’exécute, l’état d’allocation passe de stable à redimensionnement. Chaque requête peut supprimer jusqu’à 100 nœuds.
remove_nodes(pool_id, node_remove_parameter, pool_remove_nodes_options=None, custom_headers=None, raw=False, **operation_config)Paramètres
- pool_remove_nodes_options
- PoolRemoveNodesOptions
Paramètres supplémentaires pour l’opération
- operation_config
La configuration de l’opération remplace.
Retours
None ou ClientRawResponse si raw=true
Type de retour
Exceptions
resize
Modifie le nombre de nœuds de calcul attribués à un pool.
Vous ne pouvez redimensionner un pool que lorsque son état d’allocation est stable. Si le pool est déjà en cours de redimensionnement, la demande échoue avec status code 409. Lorsque vous redimensionnez un pool, l’état d’allocation du pool passe de stable à redimensionnement. Vous ne pouvez pas redimensionner les pools qui sont configurés pour la mise à l’échelle automatique. Si vous essayez de procéder ainsi, le service Batch retourne une erreur 409. Si vous redimensionnez un pool vers le bas, le service Batch choisit les nœuds de calcul à supprimer. Pour supprimer des nœuds de calcul spécifiques, utilisez plutôt l’API Supprimer les nœuds de calcul du pool.
resize(pool_id, pool_resize_parameter, pool_resize_options=None, custom_headers=None, raw=False, **operation_config)Paramètres
- pool_resize_options
- PoolResizeOptions
Paramètres supplémentaires pour l’opération
- operation_config
La configuration de l’opération remplace.
Retours
None ou ClientRawResponse si raw=true
Type de retour
Exceptions
stop_resize
Arrête une opération de redimensionnement en cours sur le pool.
Cela ne restaure pas le pool à son état précédent avant l’opération de redimensionnement : il arrête uniquement toute autre modification apportée et le pool conserve son état actuel. Après l’arrêt, le pool se stabilise au nombre de nœuds de calcul qu’il était lorsque l’opération d’arrêt a été effectuée. Pendant l’opération d’arrêt, l’état d’allocation du pool passe d’abord à l’arrêt, puis à stable. Une opération de redimensionnement n’a pas besoin d’être une demande de redimensionnement de pool explicite ; cette API peut également être utilisée pour arrêter le dimensionnement initial du pool lors de sa création.
stop_resize(pool_id, pool_stop_resize_options=None, custom_headers=None, raw=False, **operation_config)Paramètres
- pool_stop_resize_options
- PoolStopResizeOptions
Paramètres supplémentaires pour l’opération
- operation_config
La configuration de l’opération remplace.
Retours
None ou ClientRawResponse si raw=true
Type de retour
Exceptions
update_properties
Mises à jour les propriétés du pool spécifié.
Cela remplace entièrement toutes les propriétés pouvant être mises à jour du pool. Par exemple, si un objet StartTask est associé au pool et si StartTask n’est pas spécifié avec cette demande, le service Batch supprime le StartTask existant.
update_properties(pool_id, pool_update_properties_parameter, pool_update_properties_options=None, custom_headers=None, raw=False, **operation_config)Paramètres
- pool_update_properties_parameter
- PoolUpdatePropertiesParameter
Paramètres de la demande.
- pool_update_properties_options
- PoolUpdatePropertiesOptions
Paramètres supplémentaires pour l’opération
- operation_config
La configuration de l’opération remplace.
Retours
None ou ClientRawResponse si raw=true
Type de retour
Exceptions
Attributs
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