PoolSpecification interface

Paket:

@azure/batch

Eine Schnittstelle, die PoolSpecification darstellt.

Eigenschaften

applicationLicenses	Die Liste der Anwendungslizenzen, die der Batchdienst für jeden Computeknoten im Pool zur Verfügung stellt. Die Liste der Anwendungslizenzen muss eine Teilmenge der verfügbaren Batchdienstanwendungslizenzen sein. Wenn eine Lizenz angefordert wird, die nicht unterstützt wird, schlägt die Poolerstellung fehl. Die im Pool verfügbaren zulässigen Lizenzen sind "maya", "vray", "3dsmax", "arnold". Für jede dem Pool hinzugefügte Anwendungslizenz gilt eine zusätzliche Gebühr.
applicationPackageReferences	Die Liste der Pakete, die auf jedem Computeknoten im Pool installiert werden sollen. Änderungen an Paketverweise wirken sich auf alle neuen Knoten aus, die dem Pool beitreten, wirken sich jedoch nicht auf Computeknoten aus, die sich bereits im Pool befinden, bis sie neu gestartet oder umimages neu erstellt wurden. Es gibt maximal 10 Paketverweise für einen bestimmten Pool.
autoScaleEvaluationInterval	Das Zeitintervall, in dem die Poolgröße automatisch entsprechend der Autoskalenformel angepasst werden soll. Der Standardwert beträgt 15 Minuten. Der Mindest- und Maximalwert beträgt 5 Minuten bzw. 168 Stunden. Wenn Sie einen Wert angeben, der kleiner als 5 Minuten oder größer als 168 Stunden ist, lehnt der Batchdienst die Anforderung mit einem ungültigen Eigenschaftswertfehler ab; wenn Sie die REST-API direkt aufrufen, lautet der HTTP-Statuscode 400 (Ungültige Anforderung).
autoScaleFormula	Die Formel für die gewünschte Anzahl von Computeknoten im Pool. Diese Eigenschaft darf nicht angegeben werden, wenn enableAutoScale auf "false" festgelegt ist. Es ist erforderlich, wenn enableAutoScale auf "true" festgelegt ist. Die Formel wird vor der Erstellung des Pools auf Gültigkeit überprüft. Wenn die Formel ungültig ist, lehnt der Batchdienst die Anforderung mit detaillierten Fehlerinformationen ab.
certificateReferences	Eine Liste der Zertifikate, die auf jedem Computeknoten im Pool installiert werden sollen. Für Windows-Knoten installiert der Batchdienst die Zertifikate im angegebenen Zertifikatspeicher und -speicherort. Bei Linux-Computeknoten werden die Zertifikate in einem Verzeichnis im Arbeitsverzeichnis "Aufgabe" gespeichert, und eine Umgebungsvariable AZ_BATCH_CERTIFICATES_DIR wird der Aufgabe bereitgestellt, um diesen Speicherort abzufragen. Für Zertifikate mit Sichtbarkeit von 'remoteUser' wird ein Verzeichnis "certs" im Startverzeichnis des Benutzers erstellt (z. B. /home/{user-name}/certs) und Zertifikate in diesem Verzeichnis platziert.
cloudServiceConfiguration	Die Clouddienstkonfiguration für den Pool. Diese Eigenschaft muss angegeben werden, wenn der Pool mit Azure PaaS-VMs erstellt werden muss. Diese Eigenschaft und virtualMachineConfiguration schließen sich gegenseitig aus, und eine der Eigenschaften muss angegeben werden. Wenn keines angegeben ist, gibt der Batchdienst einen Fehler zurück. wenn Sie die REST-API direkt aufrufen, lautet der HTTP-Statuscode 400 (Ungültige Anforderung). Diese Eigenschaft kann nicht angegeben werden, wenn das Batchkonto mit der poolAllocationMode-Eigenschaft erstellt wurde, die auf "UserSubscription" festgelegt ist.
displayName	Der Anzeigename für den Pool. Der Anzeigename muss nicht eindeutig sein und kann alle Unicode-Zeichen bis zu einer maximalen Länge von 1024 enthalten.
enableAutoScale	Gibt an, ob die Poolgröße im Laufe der Zeit automatisch angepasst werden soll. Wenn "false", müssen mindestens eine der targetDedicateNodes und targetLowPriorityNodes angegeben werden. Bei "true" ist das autoScaleFormula-Element erforderlich. Der Pool ändert die Größe automatisch entsprechend der Formel. Der Standardwert ist "false".
enableInterNodeCommunication	Gibt an, ob der Pool die direkte Kommunikation zwischen Computeknoten zulässt. Das Aktivieren der Kommunikation zwischen Knoten begrenzt die maximale Größe des Pools aufgrund von Bereitstellungseinschränkungen auf den Computeknoten des Pools. Dies kann dazu führen, dass der Pool seine gewünschte Größe nicht erreicht. Der Standardwert ist "false".
metadata	Eine Liste von Name-Wert-Paaren, die dem Pool als Metadaten zugeordnet sind. Der Batchdienst weist Metadaten keine Bedeutung zu; sie ist ausschließlich für die Verwendung von Benutzercode vorgesehen.
mountConfiguration	Eine Liste der Dateisysteme, die auf jedem Knoten im Pool bereitgestellt werden sollen. Dies unterstützt Azure Files, NFS, CIFS/SMB und Blobfuse.
networkConfiguration	Die Netzwerkkonfiguration für den Pool.
resizeTimeout	Das Timeout für die Zuordnung von Computeknoten zum Pool. Dieses Timeout gilt nur für die manuelle Skalierung; es hat keine Auswirkung, wenn enableAutoScale auf "true" festgelegt ist. Der Standardwert beträgt 15 Minuten. Der Mindestwert beträgt 5 Minuten. Wenn Sie einen Wert kleiner als 5 Minuten angeben, lehnt der Batchdienst die Anforderung mit einem Fehler ab; wenn Sie die REST-API direkt aufrufen, lautet der HTTP-Statuscode 400 (Ungültige Anforderung).
startTask	Eine Aufgabe, die auf jedem Computeknoten ausgeführt werden soll, während er dem Pool beitritt. Die Aufgabe wird ausgeführt, wenn der Computeknoten dem Pool hinzugefügt wird oder wenn der Computeknoten neu gestartet wird.
targetDedicatedNodes	Die gewünschte Anzahl dedizierter Computeknoten im Pool. Diese Eigenschaft darf nicht angegeben werden, wenn enableAutoScale auf "true" festgelegt ist. Wenn "enableAutoScale" auf "false" festgelegt ist, müssen Sie entweder targetDedicatedNodes, targetLowPriorityNodes oder beides festlegen.
targetLowPriorityNodes	Die gewünschte Anzahl von Computeknoten mit niedriger Priorität im Pool. Diese Eigenschaft darf nicht angegeben werden, wenn enableAutoScale auf "true" festgelegt ist. Wenn "enableAutoScale" auf "false" festgelegt ist, müssen Sie entweder targetDedicatedNodes, targetLowPriorityNodes oder beides festlegen.
taskSchedulingPolicy	Wie Aufgaben über Computeknoten in einem Pool verteilt werden. Wenn nicht angegeben, wird die Standardeinstellung verteilt.
taskSlotsPerNode	Die Anzahl der Aufgabenplätze, die zum Ausführen gleichzeitiger Aufgaben auf einem einzelnen Computeknoten im Pool verwendet werden können. Der Standardwert ist 1. Der Maximalwert ist kleiner als 4 Mal die Anzahl der Kerne der vmSize des Pools oder 256.
userAccounts	Die Liste der Benutzerkonten, die auf jedem Computeknoten im Pool erstellt werden sollen.
virtualMachineConfiguration	Die Konfiguration des virtuellen Computers für den Pool. Diese Eigenschaft muss angegeben werden, wenn der Pool mit Azure IaaS-VMs erstellt werden muss. Diese Eigenschaft und cloudServiceConfiguration schließen sich gegenseitig aus, und eine der Eigenschaften muss angegeben werden. Wenn keines angegeben ist, gibt der Batchdienst einen Fehler zurück. wenn Sie die REST-API direkt aufrufen, lautet der HTTP-Statuscode 400 (Ungültige Anforderung).
vmSize	Die Größe der virtuellen Computer im Pool. Alle virtuellen Computer in einem Pool haben die gleiche Größe. Informationen zu verfügbaren Größen virtueller Computer in Pools finden Sie unter Auswählen einer VM-Größe für Computeknoten in einem Azure-Batchpool (https://docs.microsoft.com/azure/batch/batch-pool-vm-sizes).

Details zur Eigenschaft

applicationLicenses

Die Liste der Anwendungslizenzen, die der Batchdienst für jeden Computeknoten im Pool zur Verfügung stellt. Die Liste der Anwendungslizenzen muss eine Teilmenge der verfügbaren Batchdienstanwendungslizenzen sein. Wenn eine Lizenz angefordert wird, die nicht unterstützt wird, schlägt die Poolerstellung fehl. Die im Pool verfügbaren zulässigen Lizenzen sind "maya", "vray", "3dsmax", "arnold". Für jede dem Pool hinzugefügte Anwendungslizenz gilt eine zusätzliche Gebühr.

applicationLicenses?: string[]

Eigenschaftswert

string[]

applicationPackageReferences

Die Liste der Pakete, die auf jedem Computeknoten im Pool installiert werden sollen. Änderungen an Paketverweise wirken sich auf alle neuen Knoten aus, die dem Pool beitreten, wirken sich jedoch nicht auf Computeknoten aus, die sich bereits im Pool befinden, bis sie neu gestartet oder umimages neu erstellt wurden. Es gibt maximal 10 Paketverweise für einen bestimmten Pool.

applicationPackageReferences?: ApplicationPackageReference[]

Eigenschaftswert

ApplicationPackageReference[]

autoScaleEvaluationInterval

Das Zeitintervall, in dem die Poolgröße automatisch entsprechend der Autoskalenformel angepasst werden soll. Der Standardwert beträgt 15 Minuten. Der Mindest- und Maximalwert beträgt 5 Minuten bzw. 168 Stunden. Wenn Sie einen Wert angeben, der kleiner als 5 Minuten oder größer als 168 Stunden ist, lehnt der Batchdienst die Anforderung mit einem ungültigen Eigenschaftswertfehler ab; wenn Sie die REST-API direkt aufrufen, lautet der HTTP-Statuscode 400 (Ungültige Anforderung).

autoScaleEvaluationInterval?: string

Eigenschaftswert

string

autoScaleFormula

Die Formel für die gewünschte Anzahl von Computeknoten im Pool. Diese Eigenschaft darf nicht angegeben werden, wenn enableAutoScale auf "false" festgelegt ist. Es ist erforderlich, wenn enableAutoScale auf "true" festgelegt ist. Die Formel wird vor der Erstellung des Pools auf Gültigkeit überprüft. Wenn die Formel ungültig ist, lehnt der Batchdienst die Anforderung mit detaillierten Fehlerinformationen ab.

autoScaleFormula?: string

Eigenschaftswert

string

certificateReferences

Eine Liste der Zertifikate, die auf jedem Computeknoten im Pool installiert werden sollen. Für Windows-Knoten installiert der Batchdienst die Zertifikate im angegebenen Zertifikatspeicher und -speicherort. Bei Linux-Computeknoten werden die Zertifikate in einem Verzeichnis im Arbeitsverzeichnis "Aufgabe" gespeichert, und eine Umgebungsvariable AZ_BATCH_CERTIFICATES_DIR wird der Aufgabe bereitgestellt, um diesen Speicherort abzufragen. Für Zertifikate mit Sichtbarkeit von 'remoteUser' wird ein Verzeichnis "certs" im Startverzeichnis des Benutzers erstellt (z. B. /home/{user-name}/certs) und Zertifikate in diesem Verzeichnis platziert.

certificateReferences?: CertificateReference[]

Eigenschaftswert

CertificateReference[]

cloudServiceConfiguration

Die Clouddienstkonfiguration für den Pool. Diese Eigenschaft muss angegeben werden, wenn der Pool mit Azure PaaS-VMs erstellt werden muss. Diese Eigenschaft und virtualMachineConfiguration schließen sich gegenseitig aus, und eine der Eigenschaften muss angegeben werden. Wenn keines angegeben ist, gibt der Batchdienst einen Fehler zurück. wenn Sie die REST-API direkt aufrufen, lautet der HTTP-Statuscode 400 (Ungültige Anforderung). Diese Eigenschaft kann nicht angegeben werden, wenn das Batchkonto mit der poolAllocationMode-Eigenschaft erstellt wurde, die auf "UserSubscription" festgelegt ist.

cloudServiceConfiguration?: CloudServiceConfiguration

Eigenschaftswert

CloudServiceConfiguration

displayName

Der Anzeigename für den Pool. Der Anzeigename muss nicht eindeutig sein und kann alle Unicode-Zeichen bis zu einer maximalen Länge von 1024 enthalten.

displayName?: string

Eigenschaftswert

string

enableAutoScale

Gibt an, ob die Poolgröße im Laufe der Zeit automatisch angepasst werden soll. Wenn "false", müssen mindestens eine der targetDedicateNodes und targetLowPriorityNodes angegeben werden. Bei "true" ist das autoScaleFormula-Element erforderlich. Der Pool ändert die Größe automatisch entsprechend der Formel. Der Standardwert ist "false".

enableAutoScale?: boolean

Eigenschaftswert

boolean

enableInterNodeCommunication

Gibt an, ob der Pool die direkte Kommunikation zwischen Computeknoten zulässt. Das Aktivieren der Kommunikation zwischen Knoten begrenzt die maximale Größe des Pools aufgrund von Bereitstellungseinschränkungen auf den Computeknoten des Pools. Dies kann dazu führen, dass der Pool seine gewünschte Größe nicht erreicht. Der Standardwert ist "false".

enableInterNodeCommunication?: boolean

Eigenschaftswert

boolean

metadata

Eine Liste von Name-Wert-Paaren, die dem Pool als Metadaten zugeordnet sind. Der Batchdienst weist Metadaten keine Bedeutung zu; sie ist ausschließlich für die Verwendung von Benutzercode vorgesehen.

metadata?: MetadataItem[]

Eigenschaftswert

MetadataItem[]

mountConfiguration

Eine Liste der Dateisysteme, die auf jedem Knoten im Pool bereitgestellt werden sollen. Dies unterstützt Azure Files, NFS, CIFS/SMB und Blobfuse.

mountConfiguration?: MountConfiguration[]

Eigenschaftswert

MountConfiguration[]

networkConfiguration

Die Netzwerkkonfiguration für den Pool.

networkConfiguration?: NetworkConfiguration

Eigenschaftswert

NetworkConfiguration

resizeTimeout

Das Timeout für die Zuordnung von Computeknoten zum Pool. Dieses Timeout gilt nur für die manuelle Skalierung; es hat keine Auswirkung, wenn enableAutoScale auf "true" festgelegt ist. Der Standardwert beträgt 15 Minuten. Der Mindestwert beträgt 5 Minuten. Wenn Sie einen Wert kleiner als 5 Minuten angeben, lehnt der Batchdienst die Anforderung mit einem Fehler ab; wenn Sie die REST-API direkt aufrufen, lautet der HTTP-Statuscode 400 (Ungültige Anforderung).

resizeTimeout?: string

Eigenschaftswert

string

startTask

Eine Aufgabe, die auf jedem Computeknoten ausgeführt werden soll, während er dem Pool beitritt. Die Aufgabe wird ausgeführt, wenn der Computeknoten dem Pool hinzugefügt wird oder wenn der Computeknoten neu gestartet wird.

startTask?: StartTask

Eigenschaftswert

StartTask

targetDedicatedNodes

Die gewünschte Anzahl dedizierter Computeknoten im Pool. Diese Eigenschaft darf nicht angegeben werden, wenn enableAutoScale auf "true" festgelegt ist. Wenn "enableAutoScale" auf "false" festgelegt ist, müssen Sie entweder targetDedicatedNodes, targetLowPriorityNodes oder beides festlegen.

targetDedicatedNodes?: number

Eigenschaftswert

number

targetLowPriorityNodes

Die gewünschte Anzahl von Computeknoten mit niedriger Priorität im Pool. Diese Eigenschaft darf nicht angegeben werden, wenn enableAutoScale auf "true" festgelegt ist. Wenn "enableAutoScale" auf "false" festgelegt ist, müssen Sie entweder targetDedicatedNodes, targetLowPriorityNodes oder beides festlegen.

targetLowPriorityNodes?: number

Eigenschaftswert

number

taskSchedulingPolicy

Wie Aufgaben über Computeknoten in einem Pool verteilt werden. Wenn nicht angegeben, wird die Standardeinstellung verteilt.

taskSchedulingPolicy?: TaskSchedulingPolicy

Eigenschaftswert

TaskSchedulingPolicy

taskSlotsPerNode

Die Anzahl der Aufgabenplätze, die zum Ausführen gleichzeitiger Aufgaben auf einem einzelnen Computeknoten im Pool verwendet werden können. Der Standardwert ist 1. Der Maximalwert ist kleiner als 4 Mal die Anzahl der Kerne der vmSize des Pools oder 256.

taskSlotsPerNode?: number

Eigenschaftswert

number

userAccounts

Die Liste der Benutzerkonten, die auf jedem Computeknoten im Pool erstellt werden sollen.

userAccounts?: UserAccount[]

Eigenschaftswert

UserAccount[]

virtualMachineConfiguration

Die Konfiguration des virtuellen Computers für den Pool. Diese Eigenschaft muss angegeben werden, wenn der Pool mit Azure IaaS-VMs erstellt werden muss. Diese Eigenschaft und cloudServiceConfiguration schließen sich gegenseitig aus, und eine der Eigenschaften muss angegeben werden. Wenn keines angegeben ist, gibt der Batchdienst einen Fehler zurück. wenn Sie die REST-API direkt aufrufen, lautet der HTTP-Statuscode 400 (Ungültige Anforderung).

virtualMachineConfiguration?: VirtualMachineConfiguration

Eigenschaftswert

VirtualMachineConfiguration

vmSize

Die Größe der virtuellen Computer im Pool. Alle virtuellen Computer in einem Pool haben die gleiche Größe. Informationen zu verfügbaren Größen virtueller Computer in Pools finden Sie unter Auswählen einer VM-Größe für Computeknoten in einem Azure-Batchpool (https://docs.microsoft.com/azure/batch/batch-pool-vm-sizes).

vmSize: string

Eigenschaftswert

string