CloudPool interface

Paquet:

@azure/batch

Interface représentant CloudPool.

Propriétés

allocationState	Indique si le redimensionnement du pool est en cours. Les valeurs possibles sont les suivantes : « stable », « redimensionnement », « arrêt »
allocationStateTransitionTime	Heure à laquelle le pool a entré son état d’allocation actuel.
applicationLicenses	La liste des licences d’application que le service Batch mettra à disposition sur chaque nœud de calcul du pool. La liste des licences d’application doit être un sous-ensemble de licences d’application de service Batch disponibles. Si une licence n’est pas prise en charge, la création du pool échoue.
applicationPackageReferences	Liste des packages à installer sur chaque nœud de calcul du pool. Les modifications apportées aux références de package affectent tous les nouveaux nœuds qui rejoignent le pool, mais n’affectent pas les nœuds de calcul qui se trouvent déjà dans le pool tant qu’ils ne sont pas redémarrés ou réinitialisé. Il existe un maximum de 10 références de package sur un pool donné.
autoScaleEvaluationInterval	Intervalle de temps auquel ajuster automatiquement la taille du pool en fonction de la formule de mise à l’échelle automatique. Cette propriété est définie uniquement si le pool est automatiquement mis à l’échelle, c’est-à-dire que enableAutoScale a la valeur true.
autoScaleFormula	Formule pour le nombre souhaité de nœuds de calcul dans le pool. Cette propriété est définie uniquement si le pool est automatiquement mis à l’échelle, c’est-à-dire que enableAutoScale a la valeur true.
autoScaleRun	Résultats et erreurs de la dernière exécution de la formule de mise à l’échelle automatique. Cette propriété est définie uniquement si le pool est automatiquement mis à l’échelle, c’est-à-dire que enableAutoScale a la valeur true.
certificateReferences	Liste des certificats à installer sur chaque nœud de calcul du pool. Pour les nœuds Windows, le service Batch installe les certificats dans le magasin de certificats et l’emplacement spécifiés. Pour les nœuds de calcul Linux, les certificats sont stockés dans un répertoire à l’intérieur du répertoire de travail de tâche et une variable d’environnement AZ_BATCH_CERTIFICATES_DIR est fournie à la tâche pour interroger cet emplacement. Pour les certificats avec une visibilité de « remoteUser », un répertoire « certificats » est créé dans le répertoire d’accueil de l’utilisateur (par exemple, /home/{user-name}/certs) et les certificats sont placés dans ce répertoire.
cloudServiceConfiguration	Configuration du service cloud pour le pool. Cette propriété et virtualMachineConfiguration s’excluent mutuellement et l’une des propriétés doit être spécifiée. Cette propriété ne peut pas être spécifiée si le compte Batch a été créé avec sa propriété poolAllocationMode définie sur « UserSubscription ».
creationTime	Heure de création du pool.
currentDedicatedNodes	Nombre de nœuds de calcul dédiés actuellement dans le pool.
currentLowPriorityNodes	Nombre de nœuds de calcul de faible priorité actuellement dans le pool. Les nœuds de calcul de faible priorité qui ont été préemptés sont inclus dans ce nombre.
displayName	Nom complet du pool. Le nom complet n’a pas besoin d’être unique et peut contenir des caractères Unicode pouvant atteindre une longueur maximale de 1024.
enableAutoScale	Indique si la taille du pool doit être ajustée automatiquement au fil du temps. Si la valeur est false, au moins l’un des targetDedicateNodes et targetLowPriorityNodes doit être spécifié. Si la valeur est true, la propriété autoScaleFormula est requise et le pool se redimensionne automatiquement en fonction de la formule. La valeur par défaut est false.
enableInterNodeCommunication	Indique si le pool autorise la communication directe entre les nœuds de calcul. Cela impose des restrictions sur les nœuds de calcul qui peuvent être affectés au pool. La spécification de cette valeur peut réduire le nombre demandé de nœuds de calcul à allouer dans le pool.
eTag	ETag du pool. Il s’agit d’une chaîne opaque. Vous pouvez l’utiliser pour détecter si le pool a changé entre les requêtes. En particulier, vous pouvez passer l’ETag lors de la mise à jour d’un pool pour spécifier que vos modifications doivent prendre effet uniquement si personne d’autre n’a modifié le pool en attendant.
id	Chaîne qui identifie de façon unique le pool dans le compte. L’ID peut contenir n’importe quelle combinaison de caractères alphanumériques, y compris des traits d’union et des traits de soulignement, et ne peut pas contenir plus de 64 caractères. L’ID est respectant la casse et ne respecte pas la casse (autrement dit, vous n’avez peut-être pas deux ID au sein d’un compte qui diffèrent uniquement par cas).
lastModified	Heure de la dernière modification du pool. Il s’agit de la dernière fois où les données au niveau du pool, telles que targetDedicatedNodes ou activer les paramètresAutoscale, ont changé. Elle ne prend pas en compte les modifications au niveau du nœud, telles qu’un nœud de calcul qui change d’état.
metadata	Liste des paires nom-valeur associées au pool en tant que métadonnées.
mountConfiguration	Liste des systèmes de fichiers à monter sur chaque nœud du pool. Cela prend en charge Azure Files, NFS, CIFS/SMB et Blobfuse.
networkConfiguration	Configuration réseau du pool.
resizeErrors	Liste des erreurs rencontrées lors de l’exécution du dernier redimensionnement sur le pool. Cette propriété n’est définie que si une ou plusieurs erreurs se sont produites pendant le dernier redimensionnement du pool, et uniquement lorsque l’allocationState du pool est stable.
resizeTimeout	Délai d’expiration pour l’allocation de nœuds de calcul au pool. Il s’agit du délai d’expiration de l’opération de redimensionnement la plus récente. (Le dimensionnement initial lorsque le pool est créé compte en tant que redimensionnement.) La valeur par défaut est de 15 minutes.
startTask	Tâche spécifiée pour s’exécuter sur chaque nœud de calcul au fur et à mesure qu’elle joint le pool.
state	État actuel du pool. Les valeurs possibles sont les suivantes : « actif », « suppression »
stateTransitionTime	Heure à laquelle le pool a entré son état actuel.
stats	Statistiques d’utilisation et d’utilisation des ressources pour toute la durée de vie du pool. Cette propriété est remplie uniquement si CloudPool a été récupéré avec une clause expand, y compris l’attribut « stats » ; sinon, il s’agit de null. 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.
targetDedicatedNodes	Nombre souhaité de nœuds de calcul dédiés dans le pool.
targetLowPriorityNodes	Nombre souhaité de nœuds de calcul de faible priorité dans le pool.
taskSchedulingPolicy	Comment les tâches sont distribuées entre les nœuds de calcul d’un pool. S’il n’est pas spécifié, la valeur par défaut est répartie.
taskSlotsPerNode	Nombre d’emplacements de tâche qui peuvent être utilisés pour exécuter des tâches simultanées sur un nœud de calcul unique dans le pool. La valeur par défaut est 1. La valeur maximale est la plus petite de 4 fois le nombre de cœurs de la vmSize du pool ou 256.
url	URL du pool.
userAccounts	Liste des comptes d’utilisateur à créer sur chaque nœud de calcul du pool.
virtualMachineConfiguration	Configuration de la machine virtuelle pour le pool. Cette propriété et cloudServiceConfiguration s’excluent mutuellement et l’une des propriétés doit être spécifiée.
vmSize	Taille des machines virtuelles dans le pool. Toutes les machines virtuelles d’un pool sont de la même taille. Pour plus d’informations sur les tailles disponibles de machines virtuelles dans les pools, consultez Choisir une taille de machine virtuelle pour les nœuds de calcul dans un pool Azure Batch (https://docs.microsoft.com/azure/batch/batch-pool-vm-sizes).

Détails de la propriété

allocationState

Indique si le redimensionnement du pool est en cours. Les valeurs possibles sont les suivantes : « stable », « redimensionnement », « arrêt »

allocationState?: AllocationState

Valeur de propriété

AllocationState

allocationStateTransitionTime

Heure à laquelle le pool a entré son état d’allocation actuel.

allocationStateTransitionTime?: Date

Valeur de propriété

Date

applicationLicenses

La liste des licences d’application que le service Batch mettra à disposition sur chaque nœud de calcul du pool. La liste des licences d’application doit être un sous-ensemble de licences d’application de service Batch disponibles. Si une licence n’est pas prise en charge, la création du pool échoue.

applicationLicenses?: string[]

Valeur de propriété

string[]

applicationPackageReferences

Liste des packages à installer sur chaque nœud de calcul du pool. Les modifications apportées aux références de package affectent tous les nouveaux nœuds qui rejoignent le pool, mais n’affectent pas les nœuds de calcul qui se trouvent déjà dans le pool tant qu’ils ne sont pas redémarrés ou réinitialisé. Il existe un maximum de 10 références de package sur un pool donné.

applicationPackageReferences?: ApplicationPackageReference[]

Valeur de propriété

ApplicationPackageReference[]

autoScaleEvaluationInterval

Intervalle de temps auquel ajuster automatiquement la taille du pool en fonction de la formule de mise à l’échelle automatique. Cette propriété est définie uniquement si le pool est automatiquement mis à l’échelle, c’est-à-dire que enableAutoScale a la valeur true.

autoScaleEvaluationInterval?: string

Valeur de propriété

string

autoScaleFormula

Formule pour le nombre souhaité de nœuds de calcul dans le pool. Cette propriété est définie uniquement si le pool est automatiquement mis à l’échelle, c’est-à-dire que enableAutoScale a la valeur true.

autoScaleFormula?: string

Valeur de propriété

string

autoScaleRun

Résultats et erreurs de la dernière exécution de la formule de mise à l’échelle automatique. Cette propriété est définie uniquement si le pool est automatiquement mis à l’échelle, c’est-à-dire que enableAutoScale a la valeur true.

autoScaleRun?: AutoScaleRun

Valeur de propriété

AutoScaleRun

certificateReferences

Liste des certificats à installer sur chaque nœud de calcul du pool. Pour les nœuds Windows, le service Batch installe les certificats dans le magasin de certificats et l’emplacement spécifiés. Pour les nœuds de calcul Linux, les certificats sont stockés dans un répertoire à l’intérieur du répertoire de travail de tâche et une variable d’environnement AZ_BATCH_CERTIFICATES_DIR est fournie à la tâche pour interroger cet emplacement. Pour les certificats avec une visibilité de « remoteUser », un répertoire « certificats » est créé dans le répertoire d’accueil de l’utilisateur (par exemple, /home/{user-name}/certs) et les certificats sont placés dans ce répertoire.

certificateReferences?: CertificateReference[]

Valeur de propriété

CertificateReference[]

cloudServiceConfiguration

Configuration du service cloud pour le pool. Cette propriété et virtualMachineConfiguration s’excluent mutuellement et l’une des propriétés doit être spécifiée. Cette propriété ne peut pas être spécifiée si le compte Batch a été créé avec sa propriété poolAllocationMode définie sur « UserSubscription ».

cloudServiceConfiguration?: CloudServiceConfiguration

Valeur de propriété

CloudServiceConfiguration

creationTime

Heure de création du pool.

creationTime?: Date

Valeur de propriété

Date

currentDedicatedNodes

Nombre de nœuds de calcul dédiés actuellement dans le pool.

currentDedicatedNodes?: number

Valeur de propriété

number

currentLowPriorityNodes

Nombre de nœuds de calcul de faible priorité actuellement dans le pool. Les nœuds de calcul de faible priorité qui ont été préemptés sont inclus dans ce nombre.

currentLowPriorityNodes?: number

Valeur de propriété

number

displayName

Nom complet du pool. Le nom complet n’a pas besoin d’être unique et peut contenir des caractères Unicode pouvant atteindre une longueur maximale de 1024.

displayName?: string

Valeur de propriété

string

enableAutoScale

Indique si la taille du pool doit être ajustée automatiquement au fil du temps. Si la valeur est false, au moins l’un des targetDedicateNodes et targetLowPriorityNodes doit être spécifié. Si la valeur est true, la propriété autoScaleFormula est requise et le pool se redimensionne automatiquement en fonction de la formule. La valeur par défaut est false.

enableAutoScale?: boolean

Valeur de propriété

boolean

enableInterNodeCommunication

Indique si le pool autorise la communication directe entre les nœuds de calcul. Cela impose des restrictions sur les nœuds de calcul qui peuvent être affectés au pool. La spécification de cette valeur peut réduire le nombre demandé de nœuds de calcul à allouer dans le pool.

enableInterNodeCommunication?: boolean

Valeur de propriété

boolean

eTag

ETag du pool. Il s’agit d’une chaîne opaque. Vous pouvez l’utiliser pour détecter si le pool a changé entre les requêtes. En particulier, vous pouvez passer l’ETag lors de la mise à jour d’un pool pour spécifier que vos modifications doivent prendre effet uniquement si personne d’autre n’a modifié le pool en attendant.

eTag?: string

Valeur de propriété

string

id

Chaîne qui identifie de façon unique le pool dans le compte. L’ID peut contenir n’importe quelle combinaison de caractères alphanumériques, y compris des traits d’union et des traits de soulignement, et ne peut pas contenir plus de 64 caractères. L’ID est respectant la casse et ne respecte pas la casse (autrement dit, vous n’avez peut-être pas deux ID au sein d’un compte qui diffèrent uniquement par cas).

id?: string

Valeur de propriété

string

lastModified

Heure de la dernière modification du pool. Il s’agit de la dernière fois où les données au niveau du pool, telles que targetDedicatedNodes ou activer les paramètresAutoscale, ont changé. Elle ne prend pas en compte les modifications au niveau du nœud, telles qu’un nœud de calcul qui change d’état.

lastModified?: Date

Valeur de propriété

Date

metadata

Liste des paires nom-valeur associées au pool en tant que métadonnées.

metadata?: MetadataItem[]

Valeur de propriété

MetadataItem[]

mountConfiguration

Liste des systèmes de fichiers à monter sur chaque nœud du pool. Cela prend en charge Azure Files, NFS, CIFS/SMB et Blobfuse.

mountConfiguration?: MountConfiguration[]

Valeur de propriété

MountConfiguration[]

networkConfiguration

Configuration réseau du pool.

networkConfiguration?: NetworkConfiguration

Valeur de propriété

NetworkConfiguration

resizeErrors

Liste des erreurs rencontrées lors de l’exécution du dernier redimensionnement sur le pool. Cette propriété n’est définie que si une ou plusieurs erreurs se sont produites pendant le dernier redimensionnement du pool, et uniquement lorsque l’allocationState du pool est stable.

resizeErrors?: ResizeError[]

Valeur de propriété

ResizeError[]

resizeTimeout

Délai d’expiration pour l’allocation de nœuds de calcul au pool. Il s’agit du délai d’expiration de l’opération de redimensionnement la plus récente. (Le dimensionnement initial lorsque le pool est créé compte en tant que redimensionnement.) La valeur par défaut est de 15 minutes.

resizeTimeout?: string

Valeur de propriété

string

startTask

Tâche spécifiée pour s’exécuter sur chaque nœud de calcul au fur et à mesure qu’elle joint le pool.

startTask?: StartTask

Valeur de propriété

StartTask

state

État actuel du pool. Les valeurs possibles sont les suivantes : « actif », « suppression »

state?: PoolState

Valeur de propriété

PoolState

stateTransitionTime

Heure à laquelle le pool a entré son état actuel.

stateTransitionTime?: Date

Valeur de propriété

Date

stats

Statistiques d’utilisation et d’utilisation des ressources pour toute la durée de vie du pool. Cette propriété est remplie uniquement si CloudPool a été récupéré avec une clause expand, y compris l’attribut « stats » ; sinon, il s’agit de null. 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.

stats?: PoolStatistics

Valeur de propriété

PoolStatistics

targetDedicatedNodes

Nombre souhaité de nœuds de calcul dédiés dans le pool.

targetDedicatedNodes?: number

Valeur de propriété

number

targetLowPriorityNodes

Nombre souhaité de nœuds de calcul de faible priorité dans le pool.

targetLowPriorityNodes?: number

Valeur de propriété

number

taskSchedulingPolicy

Comment les tâches sont distribuées entre les nœuds de calcul d’un pool. S’il n’est pas spécifié, la valeur par défaut est répartie.

taskSchedulingPolicy?: TaskSchedulingPolicy

Valeur de propriété

TaskSchedulingPolicy

taskSlotsPerNode

Nombre d’emplacements de tâche qui peuvent être utilisés pour exécuter des tâches simultanées sur un nœud de calcul unique dans le pool. La valeur par défaut est 1. La valeur maximale est la plus petite de 4 fois le nombre de cœurs de la vmSize du pool ou 256.

taskSlotsPerNode?: number

Valeur de propriété

number

url

URL du pool.

url?: string

Valeur de propriété

string

userAccounts

Liste des comptes d’utilisateur à créer sur chaque nœud de calcul du pool.

userAccounts?: UserAccount[]

Valeur de propriété

UserAccount[]

virtualMachineConfiguration

Configuration de la machine virtuelle pour le pool. Cette propriété et cloudServiceConfiguration s’excluent mutuellement et l’une des propriétés doit être spécifiée.

virtualMachineConfiguration?: VirtualMachineConfiguration

Valeur de propriété

VirtualMachineConfiguration

vmSize

Taille des machines virtuelles dans le pool. Toutes les machines virtuelles d’un pool sont de la même taille. Pour plus d’informations sur les tailles disponibles de machines virtuelles dans les pools, consultez Choisir une taille de machine virtuelle pour les nœuds de calcul dans un pool Azure Batch (https://docs.microsoft.com/azure/batch/batch-pool-vm-sizes).

vmSize?: string

Valeur de propriété

string