Pool class

Paquet:: @azure/batch

Classe représentant un pool.

Constructeurs

Créez un pool.

Méthodes

add(PoolAddParameter, PoolAddOptionalParams)	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 technique Microsoft.
add(PoolAddParameter, PoolAddOptionalParams, ServiceCallback<void>)
add(PoolAddParameter, ServiceCallback<void>)
deleteMethod(string, PoolDeleteMethodOptionalParams)	Lorsque vous demandez qu’un pool soit supprimé, 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 démarre le redimensionnement du pool sur zéro nœuds de calcul ; toutes les tâches exécutées sur des nœuds de calcul existants sont arrêtées et requeuées (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 requeuées, l’utilisateur peut réexécuter ces tâches en mettant à jour leur 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 mise en file d’attente, vous devez appeler le pool de redimensionnement explicitement pour réduire la taille zéro du pool avant de supprimer le pool. Si vous appelez une API Update, Patch ou Delete sur un pool dans l’état de suppression, elle échoue avec le code d’état HTTP 409 avec le code d’erreur PoolBeingDeleted.
deleteMethod(string, PoolDeleteMethodOptionalParams, ServiceCallback<void>)
deleteMethod(string, ServiceCallback<void>)
disableAutoScale(string, PoolDisableAutoScaleOptionalParams)
disableAutoScale(string, PoolDisableAutoScaleOptionalParams, ServiceCallback<void>)
disableAutoScale(string, ServiceCallback<void>)
enableAutoScale(string, PoolEnableAutoScaleParameter, PoolEnableAutoScaleOptionalParams)	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 requête. 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.
enableAutoScale(string, PoolEnableAutoScaleParameter, PoolEnableAutoScaleOptionalParams, ServiceCallback<void>)
enableAutoScale(string, PoolEnableAutoScaleParameter, ServiceCallback<void>)
evaluateAutoScale(string, string, PoolEvaluateAutoScaleOptionalParams)	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. Le pool doit avoir la mise à l’échelle automatique activée pour évaluer une formule.
evaluateAutoScale(string, string, PoolEvaluateAutoScaleOptionalParams, ServiceCallback<AutoScaleRun>)
evaluateAutoScale(string, string, ServiceCallback<AutoScaleRun>)
exists(string, PoolExistsOptionalParams)	Obtient les propriétés de base d’un pool.
exists(string, PoolExistsOptionalParams, ServiceCallback<boolean>)
exists(string, ServiceCallback<boolean>)
get(string, PoolGetOptionalParams)	Obtient des informations sur le pool spécifié.
get(string, PoolGetOptionalParams, ServiceCallback<CloudPool>)
get(string, ServiceCallback<CloudPool>)
getAllLifetimeStatistics(PoolGetAllLifetimeStatisticsOptionalParams)	Les statistiques sont agrégées sur tous les pools qui ont déjà existé dans le compte, de la création du compte à l’heure de la dernière mise à jour des statistiques. Les statistiques peuvent ne pas être immédiatement disponibles. Le service Batch effectue un cumul périodique des statistiques. Le délai classique est d’environ 30 minutes.
getAllLifetimeStatistics(PoolGetAllLifetimeStatisticsOptionalParams, ServiceCallback<PoolStatistics>)
getAllLifetimeStatistics(ServiceCallback<PoolStatistics>)
list(PoolListOptionalParams)
list(PoolListOptionalParams, ServiceCallback<CloudPoolListResult>)
list(ServiceCallback<CloudPoolListResult>)
listNext(string, PoolListNextOptionalParams)
listNext(string, PoolListNextOptionalParams, ServiceCallback<CloudPoolListResult>)
listNext(string, ServiceCallback<CloudPoolListResult>)
listUsageMetrics(PoolListUsageMetricsOptionalParams)	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 sont par défaut les heures de début et de fin de la dernière intervalle d’agrégation actuellement disponible ; autrement dit, seul le dernier intervalle d’agrégation est retourné.
listUsageMetrics(PoolListUsageMetricsOptionalParams, ServiceCallback<PoolListUsageMetricsResult>)
listUsageMetrics(ServiceCallback<PoolListUsageMetricsResult>)
listUsageMetricsNext(string, PoolListUsageMetricsNextOptionalParams)	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 sont par défaut les heures de début et de fin de la dernière intervalle d’agrégation actuellement disponible ; autrement dit, seul le dernier intervalle d’agrégation est retourné.
listUsageMetricsNext(string, PoolListUsageMetricsNextOptionalParams, ServiceCallback<PoolListUsageMetricsResult>)
listUsageMetricsNext(string, ServiceCallback<PoolListUsageMetricsResult>)
patch(string, PoolPatchParameter, PoolPatchOptionalParams)	Cela remplace uniquement les propriétés de pool spécifiées dans la requête. Par exemple, si le pool a un StartTask associé à celui-ci et qu’une requête ne spécifie pas d’élément StartTask, le pool conserve l’objet StartTask existant.
patch(string, PoolPatchParameter, PoolPatchOptionalParams, ServiceCallback<void>)
patch(string, PoolPatchParameter, ServiceCallback<void>)
removeNodes(string, NodeRemoveParameter, PoolRemoveNodesOptionalParams)	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 du redimensionnement stable au redimensionnement.
removeNodes(string, NodeRemoveParameter, PoolRemoveNodesOptionalParams, ServiceCallback<void>)
removeNodes(string, NodeRemoveParameter, ServiceCallback<void>)
resize(string, PoolResizeParameter, PoolResizeOptionalParams)	Vous ne pouvez redimensionner un pool que lorsque son état d’allocation est stable. Si le redimensionnement du pool est déjà effectué, la demande échoue avec le code d’état 409. Lorsque vous redimensionnez un pool, l’état d’allocation du pool passe du redimensionnement stable au redimensionnement. Vous ne pouvez pas redimensionner les pools configurés pour la mise à l’échelle automatique. Si vous essayez de le faire, 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 Nœuds de calcul.
resize(string, PoolResizeParameter, PoolResizeOptionalParams, ServiceCallback<void>)
resize(string, PoolResizeParameter, ServiceCallback<void>)
stopResize(string, PoolStopResizeOptionalParams)	Cela ne restaure pas le pool à son état précédent avant l’opération de redimensionnement : il arrête uniquement les modifications supplémentaires apportées, et le pool conserve son état actuel. Après l’arrêt, le pool se stabilise au nombre de nœuds de calcul où 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 requête de redimensionnement explicite du pool ; cette API peut également être utilisée pour arrêter le dimensionnement initial du pool lors de sa création.
stopResize(string, PoolStopResizeOptionalParams, ServiceCallback<void>)
stopResize(string, ServiceCallback<void>)
updateProperties(string, PoolUpdatePropertiesParameter, PoolUpdatePropertiesOptionalParams)	Cela remplace entièrement toutes les propriétés pouvant être mises à jour du pool. Par exemple, si le pool a un StartTask associé à celui-ci et si StartTask n’est pas spécifié avec cette requête, le service Batch supprime l’objet StartTask existant.
updateProperties(string, PoolUpdatePropertiesParameter, PoolUpdatePropertiesOptionalParams, ServiceCallback<void>)
updateProperties(string, PoolUpdatePropertiesParameter, ServiceCallback<void>)

Détails du constructeur

Pool(BatchServiceClientContext)

Créez un pool.

new Pool(client: BatchServiceClientContext)

Paramètres

client: BatchServiceClientContext

Référence au client de service.

Détails de la méthode

add(PoolAddParameter, PoolAddOptionalParams)

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 technique Microsoft.

function add(pool: PoolAddParameter, options?: PoolAddOptionalParams): Promise<PoolAddResponse>

Paramètres

pool: PoolAddParameter

Pool à ajouter.

options: PoolAddOptionalParams

Paramètres facultatifs

Retours

Promise<PoolAddResponse>

Promise<Models.PoolAddResponse>

add(PoolAddParameter, PoolAddOptionalParams, ServiceCallback<void>)

function add(pool: PoolAddParameter, options: PoolAddOptionalParams, callback: ServiceCallback<void>)

Paramètres

pool: PoolAddParameter

Pool à ajouter.

options: PoolAddOptionalParams

Paramètres facultatifs

callback: ServiceCallback<void>

Rappel

add(PoolAddParameter, ServiceCallback<void>)

function add(pool: PoolAddParameter, callback: ServiceCallback<void>)

Paramètres

pool: PoolAddParameter

Pool à ajouter.

callback: ServiceCallback<void>

Rappel

deleteMethod(string, PoolDeleteMethodOptionalParams)

Lorsque vous demandez qu’un pool soit supprimé, 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 démarre le redimensionnement du pool sur zéro nœuds de calcul ; toutes les tâches exécutées sur des nœuds de calcul existants sont arrêtées et requeuées (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 requeuées, l’utilisateur peut réexécuter ces tâches en mettant à jour leur 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 mise en file d’attente, vous devez appeler le pool de redimensionnement explicitement pour réduire la taille zéro du pool avant de supprimer le pool. Si vous appelez une API Update, Patch ou Delete sur un pool dans l’état de suppression, elle échoue avec le code d’état HTTP 409 avec le code d’erreur PoolBeingDeleted.

function deleteMethod(poolId: string, options?: PoolDeleteMethodOptionalParams): Promise<PoolDeleteResponse>

Paramètres

poolId: string

ID du pool à supprimer.

options: PoolDeleteMethodOptionalParams

Paramètres facultatifs

Retours

Promise<PoolDeleteResponse>

Promise<Models.PoolDeleteResponse>

deleteMethod(string, PoolDeleteMethodOptionalParams, ServiceCallback<void>)

function deleteMethod(poolId: string, options: PoolDeleteMethodOptionalParams, callback: ServiceCallback<void>)

Paramètres

poolId: string

ID du pool à supprimer.

options: PoolDeleteMethodOptionalParams

Paramètres facultatifs

callback: ServiceCallback<void>

Rappel

deleteMethod(string, ServiceCallback<void>)

function deleteMethod(poolId: string, callback: ServiceCallback<void>)

Paramètres

poolId: string

ID du pool à supprimer.

callback: ServiceCallback<void>

Rappel

disableAutoScale(string, PoolDisableAutoScaleOptionalParams)

function disableAutoScale(poolId: string, options?: PoolDisableAutoScaleOptionalParams): Promise<PoolDisableAutoScaleResponse>

Paramètres

poolId: string

ID du pool sur lequel désactiver la mise à l’échelle automatique.

options: PoolDisableAutoScaleOptionalParams

Paramètres facultatifs

Retours

Promise<PoolDisableAutoScaleResponse>

Promise<Models.PoolDisableAutoScaleResponse>

disableAutoScale(string, PoolDisableAutoScaleOptionalParams, ServiceCallback<void>)

function disableAutoScale(poolId: string, options: PoolDisableAutoScaleOptionalParams, callback: ServiceCallback<void>)

Paramètres

poolId: string

ID du pool sur lequel désactiver la mise à l’échelle automatique.

options: PoolDisableAutoScaleOptionalParams

Paramètres facultatifs

callback: ServiceCallback<void>

Rappel

disableAutoScale(string, ServiceCallback<void>)

function disableAutoScale(poolId: string, callback: ServiceCallback<void>)

Paramètres

poolId: string

ID du pool sur lequel désactiver la mise à l’échelle automatique.

callback: ServiceCallback<void>

Rappel

enableAutoScale(string, PoolEnableAutoScaleParameter, PoolEnableAutoScaleOptionalParams)

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 requête. 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.

function enableAutoScale(poolId: string, poolEnableAutoScaleParameter: PoolEnableAutoScaleParameter, options?: PoolEnableAutoScaleOptionalParams): Promise<PoolEnableAutoScaleResponse>

Paramètres

poolId: string

ID du pool sur lequel activer la mise à l’échelle automatique.

poolEnableAutoScaleParameter: PoolEnableAutoScaleParameter

Paramètres de la requête.

options: PoolEnableAutoScaleOptionalParams

Paramètres facultatifs

Retours

Promise<PoolEnableAutoScaleResponse>

Promise<Models.PoolEnableAutoScaleResponse>

enableAutoScale(string, PoolEnableAutoScaleParameter, PoolEnableAutoScaleOptionalParams, ServiceCallback<void>)

function enableAutoScale(poolId: string, poolEnableAutoScaleParameter: PoolEnableAutoScaleParameter, options: PoolEnableAutoScaleOptionalParams, callback: ServiceCallback<void>)

Paramètres

poolId: string

ID du pool sur lequel activer la mise à l’échelle automatique.

poolEnableAutoScaleParameter: PoolEnableAutoScaleParameter

Paramètres de la requête.

options: PoolEnableAutoScaleOptionalParams

Paramètres facultatifs

callback: ServiceCallback<void>

Rappel

enableAutoScale(string, PoolEnableAutoScaleParameter, ServiceCallback<void>)

function enableAutoScale(poolId: string, poolEnableAutoScaleParameter: PoolEnableAutoScaleParameter, callback: ServiceCallback<void>)

Paramètres

poolId: string

ID du pool sur lequel activer la mise à l’échelle automatique.

poolEnableAutoScaleParameter: PoolEnableAutoScaleParameter

Paramètres de la requête.

callback: ServiceCallback<void>

Rappel

evaluateAutoScale(string, string, PoolEvaluateAutoScaleOptionalParams)

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. Le pool doit avoir la mise à l’échelle automatique activée pour évaluer une formule.

function evaluateAutoScale(poolId: string, autoScaleFormula: string, options?: PoolEvaluateAutoScaleOptionalParams): Promise<PoolEvaluateAutoScaleResponse>

Paramètres

poolId: string

ID du pool sur lequel évaluer la formule de mise à l’échelle automatique.

autoScaleFormula: string

Formule pour le nombre souhaité de nœuds de calcul dans le pool. 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).

options: PoolEvaluateAutoScaleOptionalParams

Paramètres facultatifs

Retours

Promise<PoolEvaluateAutoScaleResponse>

Promise<Models.PoolEvaluateAutoScaleResponse>

evaluateAutoScale(string, string, PoolEvaluateAutoScaleOptionalParams, ServiceCallback<AutoScaleRun>)

function evaluateAutoScale(poolId: string, autoScaleFormula: string, options: PoolEvaluateAutoScaleOptionalParams, callback: ServiceCallback<AutoScaleRun>)

Paramètres

poolId: string

ID du pool sur lequel évaluer la formule de mise à l’échelle automatique.

autoScaleFormula: string

options: PoolEvaluateAutoScaleOptionalParams

Paramètres facultatifs

callback: ServiceCallback<AutoScaleRun>

Rappel

evaluateAutoScale(string, string, ServiceCallback<AutoScaleRun>)

function evaluateAutoScale(poolId: string, autoScaleFormula: string, callback: ServiceCallback<AutoScaleRun>)

Paramètres

poolId: string

ID du pool sur lequel évaluer la formule de mise à l’échelle automatique.

autoScaleFormula: string

callback: ServiceCallback<AutoScaleRun>

Rappel

exists(string, PoolExistsOptionalParams)

Obtient les propriétés de base d’un pool.

function exists(poolId: string, options?: PoolExistsOptionalParams): Promise<PoolExistsResponse>

Paramètres

poolId: string

ID du pool à obtenir.

options: PoolExistsOptionalParams

Paramètres facultatifs

Retours

Promise<PoolExistsResponse>

Promise<Models.PoolExistsResponse>

exists(string, PoolExistsOptionalParams, ServiceCallback<boolean>)

function exists(poolId: string, options: PoolExistsOptionalParams, callback: ServiceCallback<boolean>)

Paramètres

poolId: string

ID du pool à obtenir.

options: PoolExistsOptionalParams

Paramètres facultatifs

callback: ServiceCallback<boolean>

Rappel

exists(string, ServiceCallback<boolean>)

function exists(poolId: string, callback: ServiceCallback<boolean>)

Paramètres

poolId: string

ID du pool à obtenir.

callback: ServiceCallback<boolean>

Rappel

get(string, PoolGetOptionalParams)

Obtient des informations sur le pool spécifié.

function get(poolId: string, options?: PoolGetOptionalParams): Promise<PoolGetResponse>

Paramètres

poolId: string

ID du pool à obtenir.

options: PoolGetOptionalParams

Paramètres facultatifs

Retours

Promise<PoolGetResponse>

Promise<Models.PoolGetResponse>

get(string, PoolGetOptionalParams, ServiceCallback<CloudPool>)

function get(poolId: string, options: PoolGetOptionalParams, callback: ServiceCallback<CloudPool>)

Paramètres

poolId: string

ID du pool à obtenir.

options: PoolGetOptionalParams

Paramètres facultatifs

callback: ServiceCallback<CloudPool>

Rappel

get(string, ServiceCallback<CloudPool>)

function get(poolId: string, callback: ServiceCallback<CloudPool>)

Paramètres

poolId: string

ID du pool à obtenir.

callback: ServiceCallback<CloudPool>

Rappel

getAllLifetimeStatistics(PoolGetAllLifetimeStatisticsOptionalParams)

Les statistiques sont agrégées sur tous les pools qui ont déjà existé dans le compte, de la création du compte à l’heure de la dernière mise à jour des statistiques. Les statistiques peuvent ne pas être immédiatement disponibles. Le service Batch effectue un cumul périodique des statistiques. Le délai classique est d’environ 30 minutes.

function getAllLifetimeStatistics(options?: PoolGetAllLifetimeStatisticsOptionalParams): Promise<PoolGetAllLifetimeStatisticsResponse>

Paramètres

options: PoolGetAllLifetimeStatisticsOptionalParams

Paramètres facultatifs

Retours

Promise<PoolGetAllLifetimeStatisticsResponse>

Promise<Models.PoolGetAllLifetimeStatisticsRéponse>

getAllLifetimeStatistics(PoolGetAllLifetimeStatisticsOptionalParams, ServiceCallback<PoolStatistics>)

function getAllLifetimeStatistics(options: PoolGetAllLifetimeStatisticsOptionalParams, callback: ServiceCallback<PoolStatistics>)

Paramètres

options: PoolGetAllLifetimeStatisticsOptionalParams

Paramètres facultatifs

callback: ServiceCallback<PoolStatistics>

Rappel

getAllLifetimeStatistics(ServiceCallback<PoolStatistics>)

function getAllLifetimeStatistics(callback: ServiceCallback<PoolStatistics>)

Paramètres

callback: ServiceCallback<PoolStatistics>

Rappel

list(PoolListOptionalParams)

function list(options?: PoolListOptionalParams): Promise<PoolListResponse>

Paramètres

options: PoolListOptionalParams

Paramètres facultatifs

Retours

Promise<PoolListResponse>

Promise<Models.PoolListResponse>

list(PoolListOptionalParams, ServiceCallback<CloudPoolListResult>)

function list(options: PoolListOptionalParams, callback: ServiceCallback<CloudPoolListResult>)

Paramètres

options: PoolListOptionalParams

Paramètres facultatifs

callback: ServiceCallback<CloudPoolListResult>

Rappel

list(ServiceCallback<CloudPoolListResult>)

function list(callback: ServiceCallback<CloudPoolListResult>)

Paramètres

callback: ServiceCallback<CloudPoolListResult>

Rappel

listNext(string, PoolListNextOptionalParams)

function listNext(nextPageLink: string, options?: PoolListNextOptionalParams): Promise<PoolListResponse>

Paramètres

nextPageLink: string

NextLink de l’appel réussi précédent à l’opération De liste.

options: PoolListNextOptionalParams

Paramètres facultatifs

Retours

Promise<PoolListResponse>

Promise<Models.PoolListResponse>

listNext(string, PoolListNextOptionalParams, ServiceCallback<CloudPoolListResult>)

function listNext(nextPageLink: string, options: PoolListNextOptionalParams, callback: ServiceCallback<CloudPoolListResult>)

Paramètres

nextPageLink: string

NextLink de l’appel réussi précédent à l’opération De liste.

options: PoolListNextOptionalParams

Paramètres facultatifs

callback: ServiceCallback<CloudPoolListResult>

Rappel

listNext(string, ServiceCallback<CloudPoolListResult>)

function listNext(nextPageLink: string, callback: ServiceCallback<CloudPoolListResult>)

Paramètres

nextPageLink: string

NextLink de l’appel réussi précédent à l’opération De liste.

callback: ServiceCallback<CloudPoolListResult>

Rappel

listUsageMetrics(PoolListUsageMetricsOptionalParams)

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 sont par défaut les heures de début et de fin de la dernière intervalle d’agrégation actuellement disponible ; autrement dit, seul le dernier intervalle d’agrégation est retourné.

function listUsageMetrics(options?: PoolListUsageMetricsOptionalParams): Promise<PoolListUsageMetricsResponse>

Paramètres

options: PoolListUsageMetricsOptionalParams

Paramètres facultatifs

Retours

Promise<PoolListUsageMetricsResponse>

Promise<Models.PoolListUsageMetricsResponse>

listUsageMetrics(PoolListUsageMetricsOptionalParams, ServiceCallback<PoolListUsageMetricsResult>)

function listUsageMetrics(options: PoolListUsageMetricsOptionalParams, callback: ServiceCallback<PoolListUsageMetricsResult>)

Paramètres

options: PoolListUsageMetricsOptionalParams

Paramètres facultatifs

callback: ServiceCallback<PoolListUsageMetricsResult>

Rappel

listUsageMetrics(ServiceCallback<PoolListUsageMetricsResult>)

function listUsageMetrics(callback: ServiceCallback<PoolListUsageMetricsResult>)

Paramètres

callback: ServiceCallback<PoolListUsageMetricsResult>

Rappel

listUsageMetricsNext(string, PoolListUsageMetricsNextOptionalParams)

function listUsageMetricsNext(nextPageLink: string, options?: PoolListUsageMetricsNextOptionalParams): Promise<PoolListUsageMetricsResponse>

Paramètres

nextPageLink: string

NextLink de l’appel réussi précédent à l’opération De liste.

options: PoolListUsageMetricsNextOptionalParams

Paramètres facultatifs

Retours

Promise<PoolListUsageMetricsResponse>

Promise<Models.PoolListUsageMetricsResponse>

listUsageMetricsNext(string, PoolListUsageMetricsNextOptionalParams, ServiceCallback<PoolListUsageMetricsResult>)

function listUsageMetricsNext(nextPageLink: string, options: PoolListUsageMetricsNextOptionalParams, callback: ServiceCallback<PoolListUsageMetricsResult>)

Paramètres

nextPageLink: string

NextLink de l’appel réussi précédent à l’opération De liste.

options: PoolListUsageMetricsNextOptionalParams

Paramètres facultatifs

callback: ServiceCallback<PoolListUsageMetricsResult>

Rappel

listUsageMetricsNext(string, ServiceCallback<PoolListUsageMetricsResult>)

function listUsageMetricsNext(nextPageLink: string, callback: ServiceCallback<PoolListUsageMetricsResult>)

Paramètres

nextPageLink: string

NextLink de l’appel réussi précédent à l’opération De liste.

callback: ServiceCallback<PoolListUsageMetricsResult>

Rappel

patch(string, PoolPatchParameter, PoolPatchOptionalParams)

Cela remplace uniquement les propriétés de pool spécifiées dans la requête. Par exemple, si le pool a un StartTask associé à celui-ci et qu’une requête ne spécifie pas d’élément StartTask, le pool conserve l’objet StartTask existant.

function patch(poolId: string, poolPatchParameter: PoolPatchParameter, options?: PoolPatchOptionalParams): Promise<PoolPatchResponse>

Paramètres

poolId: string

ID du pool à mettre à jour.

poolPatchParameter: PoolPatchParameter

Paramètres de la requête.

options: PoolPatchOptionalParams

Paramètres facultatifs

Retours

Promise<PoolPatchResponse>

Promise<Models.PoolPatchResponse>

patch(string, PoolPatchParameter, PoolPatchOptionalParams, ServiceCallback<void>)

function patch(poolId: string, poolPatchParameter: PoolPatchParameter, options: PoolPatchOptionalParams, callback: ServiceCallback<void>)

Paramètres

poolId: string

ID du pool à mettre à jour.

poolPatchParameter: PoolPatchParameter

Paramètres de la requête.

options: PoolPatchOptionalParams

Paramètres facultatifs

callback: ServiceCallback<void>

Rappel

patch(string, PoolPatchParameter, ServiceCallback<void>)

function patch(poolId: string, poolPatchParameter: PoolPatchParameter, callback: ServiceCallback<void>)

Paramètres

poolId: string

ID du pool à mettre à jour.

poolPatchParameter: PoolPatchParameter

Paramètres de la requête.

callback: ServiceCallback<void>

Rappel

removeNodes(string, NodeRemoveParameter, PoolRemoveNodesOptionalParams)

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 du redimensionnement stable au redimensionnement.

function removeNodes(poolId: string, nodeRemoveParameter: NodeRemoveParameter, options?: PoolRemoveNodesOptionalParams): Promise<PoolRemoveNodesResponse>

Paramètres

poolId: string

ID du pool à partir duquel vous souhaitez supprimer des nœuds de calcul.

nodeRemoveParameter: NodeRemoveParameter

Paramètres de la requête.

options: PoolRemoveNodesOptionalParams

Paramètres facultatifs

Retours

Promise<PoolRemoveNodesResponse>

Promise<Models.PoolRemoveNodesResponse>

removeNodes(string, NodeRemoveParameter, PoolRemoveNodesOptionalParams, ServiceCallback<void>)

function removeNodes(poolId: string, nodeRemoveParameter: NodeRemoveParameter, options: PoolRemoveNodesOptionalParams, callback: ServiceCallback<void>)

Paramètres

poolId: string

ID du pool à partir duquel vous souhaitez supprimer des nœuds de calcul.

nodeRemoveParameter: NodeRemoveParameter

Paramètres de la requête.

options: PoolRemoveNodesOptionalParams

Paramètres facultatifs

callback: ServiceCallback<void>

Rappel

removeNodes(string, NodeRemoveParameter, ServiceCallback<void>)

function removeNodes(poolId: string, nodeRemoveParameter: NodeRemoveParameter, callback: ServiceCallback<void>)

Paramètres

poolId: string

ID du pool à partir duquel vous souhaitez supprimer des nœuds de calcul.

nodeRemoveParameter: NodeRemoveParameter

Paramètres de la requête.

callback: ServiceCallback<void>

Rappel

resize(string, PoolResizeParameter, PoolResizeOptionalParams)

Vous ne pouvez redimensionner un pool que lorsque son état d’allocation est stable. Si le redimensionnement du pool est déjà effectué, la demande échoue avec le code d’état 409. Lorsque vous redimensionnez un pool, l’état d’allocation du pool passe du redimensionnement stable au redimensionnement. Vous ne pouvez pas redimensionner les pools configurés pour la mise à l’échelle automatique. Si vous essayez de le faire, 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 Nœuds de calcul.

function resize(poolId: string, poolResizeParameter: PoolResizeParameter, options?: PoolResizeOptionalParams): Promise<PoolResizeResponse>

Paramètres

poolId: string

ID du pool à redimensionner.

poolResizeParameter: PoolResizeParameter

Paramètres de la requête.

options: PoolResizeOptionalParams

Paramètres facultatifs

Retours

Promise<PoolResizeResponse>

Promise<Models.PoolResizeResponse>

resize(string, PoolResizeParameter, PoolResizeOptionalParams, ServiceCallback<void>)

function resize(poolId: string, poolResizeParameter: PoolResizeParameter, options: PoolResizeOptionalParams, callback: ServiceCallback<void>)

Paramètres

poolId: string

ID du pool à redimensionner.

poolResizeParameter: PoolResizeParameter

Paramètres de la requête.

options: PoolResizeOptionalParams

Paramètres facultatifs

callback: ServiceCallback<void>

Rappel

resize(string, PoolResizeParameter, ServiceCallback<void>)

function resize(poolId: string, poolResizeParameter: PoolResizeParameter, callback: ServiceCallback<void>)

Paramètres

poolId: string

ID du pool à redimensionner.

poolResizeParameter: PoolResizeParameter

Paramètres de la requête.

callback: ServiceCallback<void>

Rappel

stopResize(string, PoolStopResizeOptionalParams)

Cela ne restaure pas le pool à son état précédent avant l’opération de redimensionnement : il arrête uniquement les modifications supplémentaires apportées, et le pool conserve son état actuel. Après l’arrêt, le pool se stabilise au nombre de nœuds de calcul où 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 requête de redimensionnement explicite du pool ; cette API peut également être utilisée pour arrêter le dimensionnement initial du pool lors de sa création.

function stopResize(poolId: string, options?: PoolStopResizeOptionalParams): Promise<PoolStopResizeResponse>

Paramètres

poolId: string

ID du pool dont vous souhaitez arrêter le redimensionnement.

options: PoolStopResizeOptionalParams

Paramètres facultatifs

Retours

Promise<PoolStopResizeResponse>

Promise<Models.PoolStopResizeResponse>

stopResize(string, PoolStopResizeOptionalParams, ServiceCallback<void>)

function stopResize(poolId: string, options: PoolStopResizeOptionalParams, callback: ServiceCallback<void>)

Paramètres

poolId: string

ID du pool dont vous souhaitez arrêter le redimensionnement.

options: PoolStopResizeOptionalParams

Paramètres facultatifs

callback: ServiceCallback<void>

Rappel

stopResize(string, ServiceCallback<void>)

function stopResize(poolId: string, callback: ServiceCallback<void>)

Paramètres

poolId: string

ID du pool dont vous souhaitez arrêter le redimensionnement.

callback: ServiceCallback<void>

Rappel

updateProperties(string, PoolUpdatePropertiesParameter, PoolUpdatePropertiesOptionalParams)

Cela remplace entièrement toutes les propriétés pouvant être mises à jour du pool. Par exemple, si le pool a un StartTask associé à celui-ci et si StartTask n’est pas spécifié avec cette requête, le service Batch supprime l’objet StartTask existant.

function updateProperties(poolId: string, poolUpdatePropertiesParameter: PoolUpdatePropertiesParameter, options?: PoolUpdatePropertiesOptionalParams): Promise<PoolUpdatePropertiesResponse>

Paramètres

poolId: string

ID du pool à mettre à jour.

poolUpdatePropertiesParameter: PoolUpdatePropertiesParameter

Paramètres de la requête.

options: PoolUpdatePropertiesOptionalParams

Paramètres facultatifs

Retours

Promise<PoolUpdatePropertiesResponse>

Promise<Models.PoolUpdatePropertiesResponse>

updateProperties(string, PoolUpdatePropertiesParameter, PoolUpdatePropertiesOptionalParams, ServiceCallback<void>)

function updateProperties(poolId: string, poolUpdatePropertiesParameter: PoolUpdatePropertiesParameter, options: PoolUpdatePropertiesOptionalParams, callback: ServiceCallback<void>)

Paramètres

poolId: string

ID du pool à mettre à jour.

poolUpdatePropertiesParameter: PoolUpdatePropertiesParameter

Paramètres de la requête.

options: PoolUpdatePropertiesOptionalParams

Paramètres facultatifs

callback: ServiceCallback<void>

Rappel

updateProperties(string, PoolUpdatePropertiesParameter, ServiceCallback<void>)

function updateProperties(poolId: string, poolUpdatePropertiesParameter: PoolUpdatePropertiesParameter, callback: ServiceCallback<void>)

Paramètres

poolId: string

ID du pool à mettre à jour.

poolUpdatePropertiesParameter: PoolUpdatePropertiesParameter

Paramètres de la requête.

callback: ServiceCallback<void>

Rappel

Partager via

Pool class

Constructeurs

Méthodes

Détails du constructeur

Pool(BatchServiceClientContext)

Paramètres

Détails de la méthode

add(PoolAddParameter, PoolAddOptionalParams)

Paramètres

Retours

add(PoolAddParameter, PoolAddOptionalParams, ServiceCallback<void>)

Paramètres

add(PoolAddParameter, ServiceCallback<void>)

Paramètres

deleteMethod(string, PoolDeleteMethodOptionalParams)

Paramètres

Retours

deleteMethod(string, PoolDeleteMethodOptionalParams, ServiceCallback<void>)

Paramètres

deleteMethod(string, ServiceCallback<void>)

Paramètres

disableAutoScale(string, PoolDisableAutoScaleOptionalParams)

Paramètres

Retours

disableAutoScale(string, PoolDisableAutoScaleOptionalParams, ServiceCallback<void>)

Paramètres

disableAutoScale(string, ServiceCallback<void>)

Paramètres

enableAutoScale(string, PoolEnableAutoScaleParameter, PoolEnableAutoScaleOptionalParams)

Paramètres

Retours

enableAutoScale(string, PoolEnableAutoScaleParameter, PoolEnableAutoScaleOptionalParams, ServiceCallback<void>)

Paramètres

enableAutoScale(string, PoolEnableAutoScaleParameter, ServiceCallback<void>)

Paramètres

evaluateAutoScale(string, string, PoolEvaluateAutoScaleOptionalParams)

Paramètres

Retours

evaluateAutoScale(string, string, PoolEvaluateAutoScaleOptionalParams, ServiceCallback<AutoScaleRun>)

Paramètres

evaluateAutoScale(string, string, ServiceCallback<AutoScaleRun>)

Paramètres

exists(string, PoolExistsOptionalParams)

Paramètres

Retours

exists(string, PoolExistsOptionalParams, ServiceCallback<boolean>)

Paramètres

exists(string, ServiceCallback<boolean>)

Paramètres

get(string, PoolGetOptionalParams)

Paramètres

Retours

get(string, PoolGetOptionalParams, ServiceCallback<CloudPool>)

Paramètres

get(string, ServiceCallback<CloudPool>)

Paramètres

getAllLifetimeStatistics(PoolGetAllLifetimeStatisticsOptionalParams)

Paramètres

Retours

getAllLifetimeStatistics(PoolGetAllLifetimeStatisticsOptionalParams, ServiceCallback<PoolStatistics>)

Paramètres

getAllLifetimeStatistics(ServiceCallback<PoolStatistics>)

Paramètres

list(PoolListOptionalParams)

Paramètres

Retours

list(PoolListOptionalParams, ServiceCallback<CloudPoolListResult>)

Paramètres

list(ServiceCallback<CloudPoolListResult>)

Paramètres

listNext(string, PoolListNextOptionalParams)

Paramètres

Retours

listNext(string, PoolListNextOptionalParams, ServiceCallback<CloudPoolListResult>)

Paramètres

listNext(string, ServiceCallback<CloudPoolListResult>)

Paramètres

listUsageMetrics(PoolListUsageMetricsOptionalParams)

Paramètres