BatchPoolCreateOptions interface

Paket:

@azure-rest/batch

Parameter zum Erstellen eines Azure-Batchpools.

Eigenschaften

applicationPackageReferences	Die Liste der Pakete, die auf jedem Computeknoten im Pool installiert werden sollen. Beim Erstellen eines Pools muss die Anwendungs-ID des Pakets vollqualifizierte sein (/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Batch/batchAccounts/{accountName}/applications/{applicationName}). Ä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, gibt der Batchdienst einen Fehler zurück. wenn Sie die REST-API direkt aufrufen, lautet der HTTP-Statuscode 400 (Ungültige Anforderung).
autoScaleFormula	Eine 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. Weitere Informationen zum Angeben dieser Formel finden Sie unter "Automatisches Skalieren von Computeknoten in einem Azure-Batchpool" (https://learn.microsoft.com/azure/batch/batch-automatic-scaling).
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, muss mindestens eine der targetDedicatedNodes und targetLowPriorityNodes angegeben werden. Bei "true" ist die AutoScaleFormula-Eigenschaft erforderlich, und 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".
id	Eine Zeichenfolge, die den Pool innerhalb des Kontos eindeutig identifiziert. Die ID kann eine beliebige Kombination aus alphanumerischen Zeichen einschließlich Bindestrichen und Unterstrichen enthalten und darf nicht mehr als 64 Zeichen enthalten. Bei der ID wird die Groß-/Kleinschreibung beibehalten und die Groß-/Kleinschreibung nicht beachtet (d. h., Sie verfügen möglicherweise nicht über zwei Pool-IDs innerhalb eines Kontos, die sich nur nach Groß-/Kleinschreibung unterscheiden).
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	Bereitstellen des Speichers mithilfe des angegebenen Dateisystems für die gesamte Lebensdauer des Pools. Binden Sie den Speicher mithilfe eines Azure-Dateifreigabe-, NFS-, CIFS- oder Blobfuse-basierten Dateisystems ein.
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, gibt der Batchdienst einen Fehler zurück. wenn Sie die REST-API direkt aufrufen, lautet der HTTP-Statuscode 400 (Ungültige Anforderung).
startTask	Eine Aufgabe, die für jeden 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 Spot-/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 von Taskslots, die verwendet werden können, um gleichzeitige Tasks auf einem einzelnen Computeknoten im Pool auszuführen. Der Standardwert ist 1. Der Maximalwert ist kleiner als 4 Mal die Anzahl der Kerne der vmSize des Pools oder 256.
upgradePolicy	Die Upgraderichtlinie für den Pool. Beschreibt eine Upgraderichtlinie – automatisch, manuell oder rolliert.
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.
vmSize	Die Größe virtueller Computer im Pool. Alle virtuellen Computer in einem Pool haben die gleiche Größe. Informationen zu den verfügbaren VM-Größen für Pools, die Images aus dem Virtual Machines Marketplace verwenden (Pools, die mit virtualMachineConfiguration erstellt wurden), finden Sie unter Größen für virtuelle Computer in Azure (https://learn.microsoft.com/azure/virtual-machines/sizes/overview). Batch unterstützt alle Azure VM-Größen außer STANDARD_A0 und denen mit Premiumspeicher (STANDARD_GS, STANDARD_DS und STANDARD_DSV2 Serie).

Details zur Eigenschaft

applicationPackageReferences

Die Liste der Pakete, die auf jedem Computeknoten im Pool installiert werden sollen. Beim Erstellen eines Pools muss die Anwendungs-ID des Pakets vollqualifizierte sein (/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Batch/batchAccounts/{accountName}/applications/{applicationName}). Ä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?: BatchApplicationPackageReference[]

Eigenschaftswert

BatchApplicationPackageReference[]

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, gibt der Batchdienst einen Fehler zurück. wenn Sie die REST-API direkt aufrufen, lautet der HTTP-Statuscode 400 (Ungültige Anforderung).

autoScaleEvaluationInterval?: string

Eigenschaftswert

string

autoScaleFormula

Eine 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. Weitere Informationen zum Angeben dieser Formel finden Sie unter "Automatisches Skalieren von Computeknoten in einem Azure-Batchpool" (https://learn.microsoft.com/azure/batch/batch-automatic-scaling).

autoScaleFormula?: string

Eigenschaftswert

string

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, muss mindestens eine der targetDedicatedNodes und targetLowPriorityNodes angegeben werden. Bei "true" ist die AutoScaleFormula-Eigenschaft erforderlich, und 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

id

Eine Zeichenfolge, die den Pool innerhalb des Kontos eindeutig identifiziert. Die ID kann eine beliebige Kombination aus alphanumerischen Zeichen einschließlich Bindestrichen und Unterstrichen enthalten und darf nicht mehr als 64 Zeichen enthalten. Bei der ID wird die Groß-/Kleinschreibung beibehalten und die Groß-/Kleinschreibung nicht beachtet (d. h., Sie verfügen möglicherweise nicht über zwei Pool-IDs innerhalb eines Kontos, die sich nur nach Groß-/Kleinschreibung unterscheiden).

id: string

Eigenschaftswert

string

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?: BatchMetadataItem[]

Eigenschaftswert

BatchMetadataItem[]

mountConfiguration

Bereitstellen des Speichers mithilfe des angegebenen Dateisystems für die gesamte Lebensdauer des Pools. Binden Sie den Speicher mithilfe eines Azure-Dateifreigabe-, NFS-, CIFS- oder Blobfuse-basierten Dateisystems ein.

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, gibt der Batchdienst einen Fehler zurück. wenn Sie die REST-API direkt aufrufen, lautet der HTTP-Statuscode 400 (Ungültige Anforderung).

resizeTimeout?: string

Eigenschaftswert

string

startTask

Eine Aufgabe, die für jeden 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?: BatchStartTask

Eigenschaftswert

BatchStartTask

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 Spot-/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?: BatchTaskSchedulingPolicy

Eigenschaftswert

BatchTaskSchedulingPolicy

taskSlotsPerNode

Die Anzahl von Taskslots, die verwendet werden können, um gleichzeitige Tasks auf einem einzelnen Computeknoten im Pool auszuführen. 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

upgradePolicy

Die Upgraderichtlinie für den Pool. Beschreibt eine Upgraderichtlinie – automatisch, manuell oder rolliert.

upgradePolicy?: UpgradePolicy

Eigenschaftswert

UpgradePolicy

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.

virtualMachineConfiguration?: VirtualMachineConfiguration

Eigenschaftswert

VirtualMachineConfiguration

vmSize

Die Größe virtueller Computer im Pool. Alle virtuellen Computer in einem Pool haben die gleiche Größe. Informationen zu den verfügbaren VM-Größen für Pools, die Images aus dem Virtual Machines Marketplace verwenden (Pools, die mit virtualMachineConfiguration erstellt wurden), finden Sie unter Größen für virtuelle Computer in Azure (https://learn.microsoft.com/azure/virtual-machines/sizes/overview). Batch unterstützt alle Azure VM-Größen außer STANDARD_A0 und denen mit Premiumspeicher (STANDARD_GS, STANDARD_DS und STANDARD_DSV2 Serie).

vmSize: string

Eigenschaftswert

string