BatchPool interface

Paket:

@azure/batch

Ein Pool im Azure Batch-Service.

Eigenschaften

allocationState	Gibt an, ob die Größe des Pools geändert wird.
allocationStateTransitionTime	Der Zeitpunkt, zu dem der Pool seinen aktuellen Zuordnungsstatus eingegeben hat.
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. Diese Eigenschaft wird nur festgelegt, wenn der Pool automatisch skaliert wird, d. h. enableAutoScale ist true. Die Zeitspanne ist im ISO-8601-Format angegeben.
autoScaleFormula	Eine Formel für die gewünschte Anzahl von Computeknoten im Pool. Diese Eigenschaft wird nur festgelegt, wenn der Pool automatisch skaliert wird, d. h. enableAutoScale ist true.
autoScaleRun	Die Ergebnisse und Fehler aus der letzten Ausführung der Autoskalenformel. Diese Eigenschaft wird nur festgelegt, wenn der Pool automatisch skaliert wird, d. h. enableAutoScale ist true.
creationTime	Die Erstellungszeit des Pools.
currentDedicatedNodes	Die Anzahl der dedizierten Computeknoten, die sich derzeit im Pool befinden.
currentLowPriorityNodes	Die Anzahl der Computeknoten mit Spot-/Niedriger Priorität, die sich derzeit im Pool befinden. Spot/Low-Priority Compute Nodes, die vorab ausgewertet wurden, sind in dieser Anzahl enthalten.
displayName	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".
eTag	Das ETag des Pools. Dies ist eine undurchsichtige Zeichenfolge. Sie können es verwenden, um zu erkennen, ob sich der Pool zwischen Anforderungen geändert hat. Insbesondere können Sie das ETag übergeben, wenn Sie einen Pool aktualisieren, um anzugeben, dass Ihre Änderungen nur wirksam werden sollen, wenn niemand sonst den Pool in der Zwischenzeit geändert hat.
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 IDs innerhalb eines Kontos, die nur nach Groß-/Kleinschreibung abweichen).
identity	Die Identität des Batchpools, falls konfiguriert. Die Liste der Benutzeridentitäten, die dem Batchpool zugeordnet sind. Die Benutzeridentitätswörterbuchschlüsselverweise sind ARM-Ressourcen-IDs im Formular: "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}".
lastModified	Der Zeitpunkt der letzten Änderung des Pools. Dies ist das letzte Mal, zu dem daten auf Poolebene geändert wurden, z. B. die targetDedicatedNodes oder enableAutoscale-Einstellungen. Es spielt keine Rolle bei Änderungen auf Knotenebene, z. B. beim Ändern des Zustands eines Computeknotens.
metadata	Eine Liste von Name-Wert-Paaren, die dem Pool als Metadaten zugeordnet sind.
mountConfiguration	Bereitstellen des Speichers mithilfe des angegebenen Dateisystems für die gesamte Lebensdauer des Pools. Mounten Sie den Speicher mit Azure Fileshare, NFS, CIFS oder Blobfuse-basiertem Dateisystem.
networkConfiguration	Die Netzwerkkonfiguration für den Pool.
poolStatistics	Nutzungs- und Ressourcennutzungsstatistiken für die gesamte Lebensdauer des Pools. Diese Eigenschaft wird nur aufgefüllt, wenn der BatchPool mit einer Erweiterungsklausel abgerufen wurde, einschließlich des Attributs "stats"; andernfalls ist sie NULL. Die Statistiken sind möglicherweise nicht sofort verfügbar. Der Batchdienst führt regelmäßige Rollups von Statistiken durch. Die typische Verzögerung beträgt ca. 30 Minuten.
resizeErrors	Eine Liste der Fehler, die beim Ausführen der letzten Größenänderung im Pool aufgetreten sind. Diese Eigenschaft wird nur festgelegt, wenn während der letzten Poolgröße mindestens ein Fehler aufgetreten ist, und nur, wenn der Pool allocationState stabil ist.
resizeTimeout	Das Timeout für die Zuordnung von Computeknoten zum Pool. Dies ist das Timeout für den letzten Größenänderungsvorgang. (Die anfängliche Größenanpassung, wenn der Pool erstellt wird, zählt als Größenänderung.) Der Standardwert beträgt 15 Minuten. Die Zeitspanne ist im ISO-8601-Format angegeben.
startTask	Eine Aufgabe, die für jeden Computeknoten ausgeführt werden soll, während er dem Pool beitritt.
state	Der aktuelle Status des Pools.
stateTransitionTime	Die Uhrzeit, zu der der Pool seinen aktuellen Zustand eingegeben hat.
targetDedicatedNodes	Die gewünschte Anzahl dedizierter Computeknoten im Pool.
targetLowPriorityNodes	Die gewünschte Anzahl von Computeknoten mit Spot-/Niedriger Priorität im Pool.
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.
url	Die URL des Pools.
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 verfügbaren Größen virtueller Maschinen in Pools finden Sie unter Choose a VM size for Compute Nodes in an Azure Batch Pool (https://learn.microsoft.com/azure/batch/batch-pool-vm-sizes).

Details zur Eigenschaft

allocationState

Gibt an, ob die Größe des Pools geändert wird.

allocationState?: AllocationState

Eigenschaftswert

AllocationState

allocationStateTransitionTime

Der Zeitpunkt, zu dem der Pool seinen aktuellen Zuordnungsstatus eingegeben hat.

allocationStateTransitionTime?: Date

Eigenschaftswert

Date

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

Eigenschaftswert

BatchApplicationPackageReference[]

autoScaleEvaluationInterval

Das Zeitintervall, in dem die Poolgröße automatisch entsprechend der Autoskalenformel angepasst werden soll. Diese Eigenschaft wird nur festgelegt, wenn der Pool automatisch skaliert wird, d. h. enableAutoScale ist true. Die Zeitspanne ist im ISO-8601-Format angegeben.

autoScaleEvaluationInterval?: string

Eigenschaftswert

string

autoScaleFormula

Eine Formel für die gewünschte Anzahl von Computeknoten im Pool. Diese Eigenschaft wird nur festgelegt, wenn der Pool automatisch skaliert wird, d. h. enableAutoScale ist true.

autoScaleFormula?: string

Eigenschaftswert

string

autoScaleRun

Die Ergebnisse und Fehler aus der letzten Ausführung der Autoskalenformel. Diese Eigenschaft wird nur festgelegt, wenn der Pool automatisch skaliert wird, d. h. enableAutoScale ist true.

autoScaleRun?: AutoScaleRun

Eigenschaftswert

AutoScaleRun

creationTime

Die Erstellungszeit des Pools.

creationTime: Date

Eigenschaftswert

Date

currentDedicatedNodes

Die Anzahl der dedizierten Computeknoten, die sich derzeit im Pool befinden.

currentDedicatedNodes: number

Eigenschaftswert

number

currentLowPriorityNodes

Die Anzahl der Computeknoten mit Spot-/Niedriger Priorität, die sich derzeit im Pool befinden. Spot/Low-Priority Compute Nodes, die vorab ausgewertet wurden, sind in dieser Anzahl enthalten.

currentLowPriorityNodes: number

Eigenschaftswert

number

displayName

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

eTag

Das ETag des Pools. Dies ist eine undurchsichtige Zeichenfolge. Sie können es verwenden, um zu erkennen, ob sich der Pool zwischen Anforderungen geändert hat. Insbesondere können Sie das ETag übergeben, wenn Sie einen Pool aktualisieren, um anzugeben, dass Ihre Änderungen nur wirksam werden sollen, wenn niemand sonst den Pool in der Zwischenzeit geändert hat.

eTag: string

Eigenschaftswert

string

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 IDs innerhalb eines Kontos, die nur nach Groß-/Kleinschreibung abweichen).

id: string

Eigenschaftswert

string

identity

Die Identität des Batchpools, falls konfiguriert. Die Liste der Benutzeridentitäten, die dem Batchpool zugeordnet sind. Die Benutzeridentitätswörterbuchschlüsselverweise sind ARM-Ressourcen-IDs im Formular: "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}".

identity?: BatchPoolIdentity

Eigenschaftswert

BatchPoolIdentity

lastModified

Der Zeitpunkt der letzten Änderung des Pools. Dies ist das letzte Mal, zu dem daten auf Poolebene geändert wurden, z. B. die targetDedicatedNodes oder enableAutoscale-Einstellungen. Es spielt keine Rolle bei Änderungen auf Knotenebene, z. B. beim Ändern des Zustands eines Computeknotens.

lastModified: Date

Eigenschaftswert

Date

metadata

Eine Liste von Name-Wert-Paaren, die dem Pool als Metadaten zugeordnet sind.

metadata?: BatchMetadataItem[]

Eigenschaftswert

BatchMetadataItem[]

mountConfiguration

Bereitstellen des Speichers mithilfe des angegebenen Dateisystems für die gesamte Lebensdauer des Pools. Mounten Sie den Speicher mit Azure Fileshare, NFS, CIFS oder Blobfuse-basiertem Dateisystem.

mountConfiguration?: MountConfiguration[]

Eigenschaftswert

MountConfiguration[]

networkConfiguration

Die Netzwerkkonfiguration für den Pool.

networkConfiguration?: NetworkConfiguration

Eigenschaftswert

NetworkConfiguration

poolStatistics

Nutzungs- und Ressourcennutzungsstatistiken für die gesamte Lebensdauer des Pools. Diese Eigenschaft wird nur aufgefüllt, wenn der BatchPool mit einer Erweiterungsklausel abgerufen wurde, einschließlich des Attributs "stats"; andernfalls ist sie NULL. Die Statistiken sind möglicherweise nicht sofort verfügbar. Der Batchdienst führt regelmäßige Rollups von Statistiken durch. Die typische Verzögerung beträgt ca. 30 Minuten.

poolStatistics?: BatchPoolStatistics

Eigenschaftswert

BatchPoolStatistics

resizeErrors

Eine Liste der Fehler, die beim Ausführen der letzten Größenänderung im Pool aufgetreten sind. Diese Eigenschaft wird nur festgelegt, wenn während der letzten Poolgröße mindestens ein Fehler aufgetreten ist, und nur, wenn der Pool allocationState stabil ist.

resizeErrors?: ResizeError[]

Eigenschaftswert

ResizeError[]

resizeTimeout

Das Timeout für die Zuordnung von Computeknoten zum Pool. Dies ist das Timeout für den letzten Größenänderungsvorgang. (Die anfängliche Größenanpassung, wenn der Pool erstellt wird, zählt als Größenänderung.) Der Standardwert beträgt 15 Minuten. Die Zeitspanne ist im ISO-8601-Format angegeben.

resizeTimeout?: string

Eigenschaftswert

string

startTask

Eine Aufgabe, die für jeden Computeknoten ausgeführt werden soll, während er dem Pool beitritt.

startTask?: BatchStartTask

Eigenschaftswert

BatchStartTask

state

Der aktuelle Status des Pools.

state: BatchPoolState

Eigenschaftswert

BatchPoolState

stateTransitionTime

Die Uhrzeit, zu der der Pool seinen aktuellen Zustand eingegeben hat.

stateTransitionTime: Date

Eigenschaftswert

Date

targetDedicatedNodes

Die gewünschte Anzahl dedizierter Computeknoten im Pool.

targetDedicatedNodes?: number

Eigenschaftswert

number

targetLowPriorityNodes

Die gewünschte Anzahl von Computeknoten mit Spot-/Niedriger Priorität im Pool.

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

url

Die URL des Pools.

url: string

Eigenschaftswert

string

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 verfügbaren Größen virtueller Maschinen in Pools finden Sie unter Choose a VM size for Compute Nodes in an Azure Batch Pool (https://learn.microsoft.com/azure/batch/batch-pool-vm-sizes).

vmSize: string

Eigenschaftswert

string