CloudPool interface

Paket:

@azure/batch

Eine Schnittstelle, die CloudPool darstellt.

Eigenschaften

allocationState	Gibt an, ob die Größe des Pools geändert wird. Mögliche Werte sind: "steady", "resizing", "stop"
allocationStateTransitionTime	Der Zeitpunkt, zu dem der Pool seinen aktuellen Zuordnungsstatus eingegeben hat.
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.
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.
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.
certificateReferences	Die 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 und virtualMachineConfiguration schließen sich gegenseitig aus, und eine der Eigenschaften muss angegeben werden. Diese Eigenschaft kann nicht angegeben werden, wenn das Batchkonto mit der poolAllocationMode-Eigenschaft erstellt wurde, die auf "UserSubscription" festgelegt ist.
creationTime	Die Erstellungszeit des Pools.
currentDedicatedNodes	Die Anzahl der dedizierten Computeknoten, die sich derzeit im Pool befinden.
currentLowPriorityNodes	Die Anzahl der Computeknoten mit niedriger Priorität, die sich derzeit im Pool befinden. Berechnete Knoten mit niedriger Priorität sind in dieser Anzahl enthalten.
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 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. Dadurch werden Einschränkungen auferlegt, denen Computeknoten dem Pool zugewiesen werden können. Die Angabe dieses Werts kann die Wahrscheinlichkeit verringern, dass die angeforderte Anzahl von Computeknoten im Pool zugewiesen werden soll.
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).
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	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.
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.
startTask	Eine Aufgabe, die für jeden Computeknoten ausgeführt werden soll, während er dem Pool beitritt.
state	Der aktuelle Status des Pools. Mögliche Werte sind: "aktiv", "löschen"
stateTransitionTime	Die Uhrzeit, zu der der Pool seinen aktuellen Zustand eingegeben hat.
stats	Nutzungs- und Ressourcennutzungsstatistiken für die gesamte Lebensdauer des Pools. Diese Eigenschaft wird nur aufgefüllt, wenn der CloudPool mit einer Erweiterungsklausel einschließlich des Attributs "stats" abgerufen wurde; 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.
targetDedicatedNodes	Die gewünschte Anzahl dedizierter Computeknoten im Pool.
targetLowPriorityNodes	Die gewünschte Anzahl von Computeknoten mit 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 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.
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 und cloudServiceConfiguration schließen sich gegenseitig aus, und eine der Eigenschaften 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 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

allocationState

Gibt an, ob die Größe des Pools geändert wird. Mögliche Werte sind: "steady", "resizing", "stop"

allocationState?: AllocationState

Eigenschaftswert

AllocationState

allocationStateTransitionTime

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

allocationStateTransitionTime?: Date

Eigenschaftswert

Date

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.

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. Diese Eigenschaft wird nur festgelegt, wenn der Pool automatisch skaliert wird, d. h. enableAutoScale ist true.

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

certificateReferences

Die 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 und virtualMachineConfiguration schließen sich gegenseitig aus, und eine der Eigenschaften muss angegeben werden. Diese Eigenschaft kann nicht angegeben werden, wenn das Batchkonto mit der poolAllocationMode-Eigenschaft erstellt wurde, die auf "UserSubscription" festgelegt ist.

cloudServiceConfiguration?: CloudServiceConfiguration

Eigenschaftswert

CloudServiceConfiguration

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 niedriger Priorität, die sich derzeit im Pool befinden. Berechnete Knoten mit niedriger Priorität sind in dieser Anzahl enthalten.

currentLowPriorityNodes?: number

Eigenschaftswert

number

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 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. Dadurch werden Einschränkungen auferlegt, denen Computeknoten dem Pool zugewiesen werden können. Die Angabe dieses Werts kann die Wahrscheinlichkeit verringern, dass die angeforderte Anzahl von Computeknoten im Pool zugewiesen werden soll.

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

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?: 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

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.

resizeTimeout?: string

Eigenschaftswert

string

startTask

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

startTask?: StartTask

Eigenschaftswert

StartTask

state

Der aktuelle Status des Pools. Mögliche Werte sind: "aktiv", "löschen"

state?: PoolState

Eigenschaftswert

PoolState

stateTransitionTime

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

stateTransitionTime?: Date

Eigenschaftswert

Date

stats

Nutzungs- und Ressourcennutzungsstatistiken für die gesamte Lebensdauer des Pools. Diese Eigenschaft wird nur aufgefüllt, wenn der CloudPool mit einer Erweiterungsklausel einschließlich des Attributs "stats" abgerufen wurde; 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.

stats?: PoolStatistics

Eigenschaftswert

PoolStatistics

targetDedicatedNodes

Die gewünschte Anzahl dedizierter Computeknoten im Pool.

targetDedicatedNodes?: number

Eigenschaftswert

number

targetLowPriorityNodes

Die gewünschte Anzahl von Computeknoten mit 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?: 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

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 und cloudServiceConfiguration schließen sich gegenseitig aus, und eine der Eigenschaften 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 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