Partager via

PoolAddParameter interface

Paquet:
@azure/batch

Interface représentant PoolAddParameter.

Propriétés

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. La valeur par défaut est de 15 minutes. La valeur minimale et maximale est de 5 minutes et 168 heures respectivement. Si vous spécifiez une valeur inférieure à 5 minutes ou supérieure à 168 heures, le service Batch retourne une erreur ; si vous appelez directement l’API REST, le code d’état HTTP est 400 (requête incorrecte).
autoScaleFormula

Formule pour le nombre souhaité de nœuds de calcul dans le pool. Cette propriété ne doit pas être spécifiée si enableAutoScale a la valeur false. Elle est requise si enableAutoScale a la valeur true. La formule est vérifiée pour la validité avant la création du pool. Si la formule n’est pas valide, le service Batch rejette la demande avec des informations d’erreur détaillées. Pour plus d’informations sur la spécification de cette formule, consultez « Mettre automatiquement à l’échelle des nœuds de calcul dans un pool Azure Batch » (https://azure.microsoft.com/documentation/articles/batch-automatic-scaling/).
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 ».
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. L’activation de la communication entre nœuds limite la taille maximale du pool en raison de restrictions de déploiement sur les nœuds de calcul du pool. Cela peut entraîner le fait que le pool n’atteigne pas sa taille souhaitée. La valeur par défaut est false.
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 de pool au sein d’un compte qui diffèrent uniquement par cas).
metadata

Liste des paires nom-valeur associées au pool en tant que métadonnées. Le service Batch n’affecte aucune signification aux métadonnées ; il s’agit uniquement de l’utilisation du code utilisateur.
mountConfiguration

Montez le stockage à l’aide du système de fichiers spécifié pendant toute la durée de vie du pool. Montez le stockage à l’aide du système de fichiers Azure fileshare, NFS, CIFS ou Blobfuse.
networkConfiguration

Configuration réseau du pool.
resizeTimeout

Délai d’expiration pour l’allocation de nœuds de calcul au pool. Ce délai d’expiration s’applique uniquement à la mise à l’échelle manuelle ; elle n’a aucun effet quand enableAutoScale a la valeur true. La valeur par défaut est de 15 minutes. La valeur minimale est de 5 minutes. Si vous spécifiez une valeur inférieure à 5 minutes, le service Batch retourne une erreur ; si vous appelez directement l’API REST, le code d’état HTTP est 400 (requête incorrecte).
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. La tâche s’exécute lorsque le nœud de calcul est ajouté au pool ou lorsque le nœud de calcul est redémarré.
targetDedicatedNodes

Nombre souhaité de nœuds de calcul dédiés dans le pool. Cette propriété ne doit pas être spécifiée si enableAutoScale a la valeur true. Si enableAutoScale a la valeur false, vous devez définir targetDedicatedNodes, targetLowPriorityNodes ou les deux.
targetLowPriorityNodes

Nombre souhaité de nœuds de calcul de faible priorité dans le pool. Cette propriété ne doit pas être spécifiée si enableAutoScale a la valeur true. Si enableAutoScale a la valeur false, vous devez définir targetDedicatedNodes, targetLowPriorityNodes ou les deux.
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.
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 pour les pools de services cloud (pools créés avec cloudServiceConfiguration), consultez Tailles pour les services cloud (https://azure.microsoft.com/documentation/articles/cloud-services-sizes-specs/). Batch prend en charge toutes les tailles de machine virtuelle Cloud Services, à l’exception d’ExtraSmall, A1V2 et A2V2. Pour plus d’informations sur les tailles de machines virtuelles disponibles pour les pools utilisant des images à partir de la Place de marché des machines virtuelles (pools créés avec virtualMachineConfiguration), consultez Tailles pour les machines virtuelles (Linux) (https://azure.microsoft.com/documentation/articles/virtual-machines-linux-sizes/) ou tailles pour les machines virtuelles (Windows) (https://azure.microsoft.com/documentation/articles/virtual-machines-windows-sizes/). Batch prend en charge toutes les tailles de machine virtuelle Azure, à l’exception des STANDARD_A0 et celles avec stockage Premium (STANDARD_GS, STANDARD_DS et série STANDARD_DSV2).

Détails de la propriété

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. La valeur par défaut est de 15 minutes. La valeur minimale et maximale est de 5 minutes et 168 heures respectivement. Si vous spécifiez une valeur inférieure à 5 minutes ou supérieure à 168 heures, le service Batch retourne une erreur ; si vous appelez directement l’API REST, le code d’état HTTP est 400 (requête incorrecte).

autoScaleEvaluationInterval?: string

Valeur de propriété

string

autoScaleFormula

Formule pour le nombre souhaité de nœuds de calcul dans le pool. Cette propriété ne doit pas être spécifiée si enableAutoScale a la valeur false. Elle est requise si enableAutoScale a la valeur true. La formule est vérifiée pour la validité avant la création du pool. Si la formule n’est pas valide, le service Batch rejette la demande avec des informations d’erreur détaillées. Pour plus d’informations sur la spécification de cette formule, consultez « Mettre automatiquement à l’échelle des nœuds de calcul dans un pool Azure Batch » (https://azure.microsoft.com/documentation/articles/batch-automatic-scaling/).

autoScaleFormula?: string

Valeur de propriété

string

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

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. L’activation de la communication entre nœuds limite la taille maximale du pool en raison de restrictions de déploiement sur les nœuds de calcul du pool. Cela peut entraîner le fait que le pool n’atteigne pas sa taille souhaitée. La valeur par défaut est false.

enableInterNodeCommunication?: boolean

Valeur de propriété

boolean

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 de pool au sein d’un compte qui diffèrent uniquement par cas).

id: string

Valeur de propriété

string

metadata

Liste des paires nom-valeur associées au pool en tant que métadonnées. Le service Batch n’affecte aucune signification aux métadonnées ; il s’agit uniquement de l’utilisation du code utilisateur.

metadata?: MetadataItem[]

Valeur de propriété

MetadataItem[]

mountConfiguration

Montez le stockage à l’aide du système de fichiers spécifié pendant toute la durée de vie du pool. Montez le stockage à l’aide du système de fichiers Azure fileshare, NFS, CIFS ou Blobfuse.

mountConfiguration?: MountConfiguration[]

Valeur de propriété

MountConfiguration[]

networkConfiguration

Configuration réseau du pool.

networkConfiguration?: NetworkConfiguration

Valeur de propriété

NetworkConfiguration

resizeTimeout

Délai d’expiration pour l’allocation de nœuds de calcul au pool. Ce délai d’expiration s’applique uniquement à la mise à l’échelle manuelle ; elle n’a aucun effet quand enableAutoScale a la valeur true. La valeur par défaut est de 15 minutes. La valeur minimale est de 5 minutes. Si vous spécifiez une valeur inférieure à 5 minutes, le service Batch retourne une erreur ; si vous appelez directement l’API REST, le code d’état HTTP est 400 (requête incorrecte).

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. La tâche s’exécute lorsque le nœud de calcul est ajouté au pool ou lorsque le nœud de calcul est redémarré.

startTask?: StartTask

Valeur de propriété

StartTask

targetDedicatedNodes

Nombre souhaité de nœuds de calcul dédiés dans le pool. Cette propriété ne doit pas être spécifiée si enableAutoScale a la valeur true. Si enableAutoScale a la valeur false, vous devez définir targetDedicatedNodes, targetLowPriorityNodes ou les deux.

targetDedicatedNodes?: number

Valeur de propriété

number

targetLowPriorityNodes

Nombre souhaité de nœuds de calcul de faible priorité dans le pool. Cette propriété ne doit pas être spécifiée si enableAutoScale a la valeur true. Si enableAutoScale a la valeur false, vous devez définir targetDedicatedNodes, targetLowPriorityNodes ou les deux.

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

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 pour les pools de services cloud (pools créés avec cloudServiceConfiguration), consultez Tailles pour les services cloud (https://azure.microsoft.com/documentation/articles/cloud-services-sizes-specs/). Batch prend en charge toutes les tailles de machine virtuelle Cloud Services, à l’exception d’ExtraSmall, A1V2 et A2V2. Pour plus d’informations sur les tailles de machines virtuelles disponibles pour les pools utilisant des images à partir de la Place de marché des machines virtuelles (pools créés avec virtualMachineConfiguration), consultez Tailles pour les machines virtuelles (Linux) (https://azure.microsoft.com/documentation/articles/virtual-machines-linux-sizes/) ou tailles pour les machines virtuelles (Windows) (https://azure.microsoft.com/documentation/articles/virtual-machines-windows-sizes/). Batch prend en charge toutes les tailles de machine virtuelle Azure, à l’exception des STANDARD_A0 et celles avec stockage Premium (STANDARD_GS, STANDARD_DS et série STANDARD_DSV2).

vmSize: string

Valeur de propriété

string