Pool interface

Paket:

@azure/arm-batch

Enthält Informationen zu einem Pool.

Extends

ProxyResource

Eigenschaften

allocationState	Gibt an, ob die Größe des Pools geändert wird. HINWEIS: Diese Eigenschaft wird nicht serialisiert. Sie kann nur vom Server aufgefüllt werden.
allocationStateTransitionTime	Der Zeitpunkt, zu dem der Pool seinen aktuellen Zuordnungsstatus erlangt hat. HINWEIS: Diese Eigenschaft wird nicht serialisiert. Sie kann nur vom Server aufgefüllt werden.
applicationLicenses	Die Liste der Anwendungslizenzen muss eine Teilmenge der verfügbaren Batch-Dienstanwendungslizenzen sein. Wenn eine Lizenz angefordert wird, die nicht unterstützt wird, schlägt die Poolerstellung fehl.
applicationPackages	Änderungen an Anwendungspaketverweise wirken sich auf alle neuen Computeknoten aus, die dem Pool beitreten, aber nicht auf Computeknoten, die sich bereits im Pool befinden, bis sie neu gestartet oder neu erstellt werden. Es gibt maximal 10 Anwendungspaketverweise in einem bestimmten Pool.
autoScaleRun	Diese Eigenschaft wird nur festgelegt, wenn der Pool automatisch skaliert, d. h. autoScaleSettings verwendet wird. HINWEIS: Diese Eigenschaft wird nicht serialisiert. Sie kann nur vom Server aufgefüllt werden.
certificates	Bei Windows-Computeknoten installiert der Batch-Dienst die Zertifikate im angegebenen Zertifikatspeicher und -speicherort. Bei Linux-Computeknoten werden die Zertifikate in einem Verzeichnis innerhalb des Aufgabenarbeitsverzeichnisses gespeichert, und eine Umgebungsvariable, AZ_BATCH_CERTIFICATES_DIR für die Aufgabe bereitgestellt wird, um diesen Speicherort abzufragen. Bei Zertifikaten mit sichtbarkeit von "remoteUser" wird im Basisverzeichnis des Benutzers (z. B. /home/{benutzername}/certs) ein Verzeichnis "certs" erstellt, und zertifikate werden in diesem Verzeichnis abgelegt. Warnung: Diese Eigenschaft ist veraltet und wird nach Februar 2024 entfernt. Verwenden Sie stattdessen die Azure KeyVault-Erweiterung .
creationTime	Die Erstellungszeit des Pools. HINWEIS: Diese Eigenschaft wird nicht serialisiert. Sie kann nur vom Server aufgefüllt werden.
currentDedicatedNodes	Die Anzahl der dedizierten Computeknoten, die sich derzeit im Pool befinden. HINWEIS: Diese Eigenschaft wird nicht serialisiert. Sie kann nur vom Server aufgefüllt werden.
currentLowPriorityNodes	Die Anzahl der Computeknoten spot/low-priority, die sich derzeit im Pool befinden. HINWEIS: Diese Eigenschaft wird nicht serialisiert. Sie kann nur vom Server aufgefüllt werden.
currentNodeCommunicationMode	Bestimmt, wie ein Pool mit dem Batch-Dienst kommuniziert. HINWEIS: Diese Eigenschaft wird nicht serialisiert. Sie kann nur vom Server aufgefüllt werden.
deploymentConfiguration	Die Verwendung von CloudServiceConfiguration gibt an, dass die Knoten mithilfe von Azure Cloud Services (PaaS) erstellt werden sollen, während VirtualMachineConfiguration Azure Virtual Machines (IaaS) verwendet.
displayName	Der Anzeigename muss nicht eindeutig sein und kann Unicode-Zeichen bis zu einer maximalen Länge von 1024 enthalten.
identity	Der Identitätstyp, der für den Batchpool verwendet wird.
interNodeCommunication	Dies erzwingt Einschränkungen, welche Knoten dem Pool zugewiesen werden können. Wenn Sie diesen Wert aktivieren, kann die Wahrscheinlichkeit verringert werden, dass die angeforderte Anzahl von Knoten im Pool zugeordnet wird. Wenn nicht angegeben, wird dieser Wert standardmäßig auf "Disabled" festgelegt.
lastModified	Dies ist das letzte Mal, zu dem die Daten auf Poolebene geändert wurden, z. B. targetDedicatedNodes oder autoScaleSettings. Änderungen auf Knotenebene, z. B. die Änderung des Zustands eines Computeknotens, werden nicht mit eingerechnet. HINWEIS: Diese Eigenschaft wird nicht serialisiert. Sie kann nur vom Server aufgefüllt werden.
metadata	Der Batch-Dienst weist Metadaten keine Bedeutung zu. es dient ausschließlich der Verwendung von Benutzercode.
mountConfiguration	Dies unterstützt Azure Files, NFS, CIFS/SMB und Blobfuse.
networkConfiguration	Die Netzwerkkonfiguration für einen Pool.
provisioningState	Der aktuelle Zustand des Pools. HINWEIS: Diese Eigenschaft wird nicht serialisiert. Sie kann nur vom Server aufgefüllt werden.
provisioningStateTransitionTime	Der Zeitpunkt, zu dem der Pool seinen aktuellen Status erlangt hat. HINWEIS: Diese Eigenschaft wird nicht serialisiert. Sie kann nur vom Server aufgefüllt werden.
resizeOperationStatus	Beschreibt entweder den aktuellen Vorgang (wenn der AllocationState-Pool die Größe ändern) oder den zuvor abgeschlossenen Vorgang (wenn AllocationState gleich ist). HINWEIS: Diese Eigenschaft wird nicht serialisiert. Sie kann nur vom Server aufgefüllt werden.
resourceTags	Die benutzerdefinierten Tags, die dem Azure Batch Pool zugeordnet werden sollen. Wenn sie angegeben sind, werden diese Tags an die dem Pool zugeordneten, untergeordneten Azure-Ressourcen weitergegeben. Diese Eigenschaft kann nur angegeben werden, wenn das Batch-Konto erstellt wurde, wobei die poolAllocationMode-Eigenschaft auf "UserSubscription" festgelegt ist.
scaleSettings	Definiert die gewünschte Größe des Pools. Dies kann entweder "fixedScale" sein, wobei die angeforderte targetDedicatedNodes angegeben wird, oder "autoScale", die eine Formel definiert, die regelmäßig neu ausgewertet wird. Wenn diese Eigenschaft nicht angegeben ist, verfügt der Pool über eine feste Skalierung mit 0 targetDedicatedNodes.
startTask	In einem PATCH-Vorgang (Update) kann diese Eigenschaft auf ein leeres Objekt festgelegt werden, um die Startaufgabe aus dem Pool zu entfernen.
targetNodeCommunicationMode	Wenn der Wert nicht angegeben wird, lautet der Standardwert Default.
taskSchedulingPolicy	Wenn nicht angegeben, ist der Standardwert spread.
taskSlotsPerNode	Der Standardwert ist 1. Der Maximalwert ist der 4-fache der Anzahl der Kerne des vmSize-Pools oder 256.
upgradePolicy	Beschreibt eine Upgraderichtlinie – automatisch, manuell oder rolliert.
userAccounts	Die Liste der Benutzerkonten, die auf jedem Knoten im Pool erstellt werden sollen.
vmSize	Informationen zu verfügbaren Größen von virtuellen Computern für Cloud Services Pools (mit cloudServiceConfiguration erstellte Pools) finden Sie unter Größen für Cloud Services (https://azure.microsoft.com/documentation/articles/cloud-services-sizes-specs/). Batch unterstützt alle Cloud Services VM-Größen mit Ausnahme von ExtraSmall. Informationen zu verfügbaren VM-Größen für Pools mit Images aus dem Virtual Machines Marketplace (mit virtualMachineConfiguration erstellte Pools) finden Sie unter Größen für Virtual Machines (Linux)https://azure.microsoft.com/documentation/articles/virtual-machines-linux-sizes/ oder Größen für Virtual Machines (Windows) (https://azure.microsoft.com/documentation/articles/virtual-machines-windows-sizes/). Batch unterstützt alle Azure-VM-Größen mit Ausnahme von STANDARD_A0 und Premium-Speicher (STANDARD_GS, STANDARD_DS und STANDARD_DSV2 Serie).

Geerbte Eigenschaften

etag	Das ETag der Ressource, die für Parallelitätsanweisungen verwendet wird. HINWEIS: Diese Eigenschaft wird nicht serialisiert. Sie kann nur vom Server aufgefüllt werden.
id	Die ID der Ressource. HINWEIS: Diese Eigenschaft wird nicht serialisiert. Sie kann nur vom Server aufgefüllt werden.
name	Der Name der Ressource. HINWEIS: Diese Eigenschaft wird nicht serialisiert. Sie kann nur vom Server aufgefüllt werden.
type	Der Typ der Ressource. HINWEIS: Diese Eigenschaft wird nicht serialisiert. Sie kann nur vom Server aufgefüllt werden.

Details zur Eigenschaft

allocationState

Gibt an, ob die Größe des Pools geändert wird. HINWEIS: Diese Eigenschaft wird nicht serialisiert. Sie kann nur vom Server aufgefüllt werden.

allocationState?: AllocationState

Eigenschaftswert

AllocationState

allocationStateTransitionTime

Der Zeitpunkt, zu dem der Pool seinen aktuellen Zuordnungsstatus erlangt hat. HINWEIS: Diese Eigenschaft wird nicht serialisiert. Sie kann nur vom Server aufgefüllt werden.

allocationStateTransitionTime?: Date

Eigenschaftswert

Date

applicationLicenses

Die Liste der Anwendungslizenzen muss eine Teilmenge der verfügbaren Batch-Dienstanwendungslizenzen sein. Wenn eine Lizenz angefordert wird, die nicht unterstützt wird, schlägt die Poolerstellung fehl.

applicationLicenses?: string[]

Eigenschaftswert

string[]

applicationPackages

Änderungen an Anwendungspaketverweise wirken sich auf alle neuen Computeknoten aus, die dem Pool beitreten, aber nicht auf Computeknoten, die sich bereits im Pool befinden, bis sie neu gestartet oder neu erstellt werden. Es gibt maximal 10 Anwendungspaketverweise in einem bestimmten Pool.

applicationPackages?: ApplicationPackageReference[]

Eigenschaftswert

ApplicationPackageReference[]

autoScaleRun

Diese Eigenschaft wird nur festgelegt, wenn der Pool automatisch skaliert, d. h. autoScaleSettings verwendet wird. HINWEIS: Diese Eigenschaft wird nicht serialisiert. Sie kann nur vom Server aufgefüllt werden.

autoScaleRun?: AutoScaleRun

Eigenschaftswert

AutoScaleRun

certificates

Bei Windows-Computeknoten installiert der Batch-Dienst die Zertifikate im angegebenen Zertifikatspeicher und -speicherort. Bei Linux-Computeknoten werden die Zertifikate in einem Verzeichnis innerhalb des Aufgabenarbeitsverzeichnisses gespeichert, und eine Umgebungsvariable, AZ_BATCH_CERTIFICATES_DIR für die Aufgabe bereitgestellt wird, um diesen Speicherort abzufragen. Bei Zertifikaten mit sichtbarkeit von "remoteUser" wird im Basisverzeichnis des Benutzers (z. B. /home/{benutzername}/certs) ein Verzeichnis "certs" erstellt, und zertifikate werden in diesem Verzeichnis abgelegt.

Warnung: Diese Eigenschaft ist veraltet und wird nach Februar 2024 entfernt. Verwenden Sie stattdessen die Azure KeyVault-Erweiterung .

certificates?: CertificateReference[]

Eigenschaftswert

CertificateReference[]

creationTime

Die Erstellungszeit des Pools. HINWEIS: Diese Eigenschaft wird nicht serialisiert. Sie kann nur vom Server aufgefüllt werden.

creationTime?: Date

Eigenschaftswert

Date

currentDedicatedNodes

Die Anzahl der dedizierten Computeknoten, die sich derzeit im Pool befinden. HINWEIS: Diese Eigenschaft wird nicht serialisiert. Sie kann nur vom Server aufgefüllt werden.

currentDedicatedNodes?: number

Eigenschaftswert

number

currentLowPriorityNodes

Die Anzahl der Computeknoten spot/low-priority, die sich derzeit im Pool befinden. HINWEIS: Diese Eigenschaft wird nicht serialisiert. Sie kann nur vom Server aufgefüllt werden.

currentLowPriorityNodes?: number

Eigenschaftswert

number

currentNodeCommunicationMode

Bestimmt, wie ein Pool mit dem Batch-Dienst kommuniziert. HINWEIS: Diese Eigenschaft wird nicht serialisiert. Sie kann nur vom Server aufgefüllt werden.

currentNodeCommunicationMode?: NodeCommunicationMode

Eigenschaftswert

NodeCommunicationMode

deploymentConfiguration

Die Verwendung von CloudServiceConfiguration gibt an, dass die Knoten mithilfe von Azure Cloud Services (PaaS) erstellt werden sollen, während VirtualMachineConfiguration Azure Virtual Machines (IaaS) verwendet.

deploymentConfiguration?: DeploymentConfiguration

Eigenschaftswert

DeploymentConfiguration

displayName

Der Anzeigename muss nicht eindeutig sein und kann Unicode-Zeichen bis zu einer maximalen Länge von 1024 enthalten.

displayName?: string

Eigenschaftswert

string

identity

Der Identitätstyp, der für den Batchpool verwendet wird.

identity?: BatchPoolIdentity

Eigenschaftswert

BatchPoolIdentity

interNodeCommunication

Dies erzwingt Einschränkungen, welche Knoten dem Pool zugewiesen werden können. Wenn Sie diesen Wert aktivieren, kann die Wahrscheinlichkeit verringert werden, dass die angeforderte Anzahl von Knoten im Pool zugeordnet wird. Wenn nicht angegeben, wird dieser Wert standardmäßig auf "Disabled" festgelegt.

interNodeCommunication?: InterNodeCommunicationState

Eigenschaftswert

InterNodeCommunicationState

lastModified

Dies ist das letzte Mal, zu dem die Daten auf Poolebene geändert wurden, z. B. targetDedicatedNodes oder autoScaleSettings. Änderungen auf Knotenebene, z. B. die Änderung des Zustands eines Computeknotens, werden nicht mit eingerechnet. HINWEIS: Diese Eigenschaft wird nicht serialisiert. Sie kann nur vom Server aufgefüllt werden.

lastModified?: Date

Eigenschaftswert

Date

metadata

Der Batch-Dienst weist Metadaten keine Bedeutung zu. es dient ausschließlich der Verwendung von Benutzercode.

metadata?: MetadataItem[]

Eigenschaftswert

MetadataItem[]

mountConfiguration

Dies unterstützt Azure Files, NFS, CIFS/SMB und Blobfuse.

mountConfiguration?: MountConfiguration[]

Eigenschaftswert

MountConfiguration[]

networkConfiguration

Die Netzwerkkonfiguration für einen Pool.

networkConfiguration?: NetworkConfiguration

Eigenschaftswert

NetworkConfiguration

provisioningState

Der aktuelle Zustand des Pools. HINWEIS: Diese Eigenschaft wird nicht serialisiert. Sie kann nur vom Server aufgefüllt werden.

provisioningState?: PoolProvisioningState

Eigenschaftswert

PoolProvisioningState

provisioningStateTransitionTime

Der Zeitpunkt, zu dem der Pool seinen aktuellen Status erlangt hat. HINWEIS: Diese Eigenschaft wird nicht serialisiert. Sie kann nur vom Server aufgefüllt werden.

provisioningStateTransitionTime?: Date

Eigenschaftswert

Date

resizeOperationStatus

Beschreibt entweder den aktuellen Vorgang (wenn der AllocationState-Pool die Größe ändern) oder den zuvor abgeschlossenen Vorgang (wenn AllocationState gleich ist). HINWEIS: Diese Eigenschaft wird nicht serialisiert. Sie kann nur vom Server aufgefüllt werden.

resizeOperationStatus?: ResizeOperationStatus

Eigenschaftswert

ResizeOperationStatus

resourceTags

Die benutzerdefinierten Tags, die dem Azure Batch Pool zugeordnet werden sollen. Wenn sie angegeben sind, werden diese Tags an die dem Pool zugeordneten, untergeordneten Azure-Ressourcen weitergegeben. Diese Eigenschaft kann nur angegeben werden, wenn das Batch-Konto erstellt wurde, wobei die poolAllocationMode-Eigenschaft auf "UserSubscription" festgelegt ist.

resourceTags?: {[propertyName: string]: string}

Eigenschaftswert

{[propertyName: string]: string}

scaleSettings

Definiert die gewünschte Größe des Pools. Dies kann entweder "fixedScale" sein, wobei die angeforderte targetDedicatedNodes angegeben wird, oder "autoScale", die eine Formel definiert, die regelmäßig neu ausgewertet wird. Wenn diese Eigenschaft nicht angegeben ist, verfügt der Pool über eine feste Skalierung mit 0 targetDedicatedNodes.

scaleSettings?: ScaleSettings

Eigenschaftswert

ScaleSettings

startTask

In einem PATCH-Vorgang (Update) kann diese Eigenschaft auf ein leeres Objekt festgelegt werden, um die Startaufgabe aus dem Pool zu entfernen.

startTask?: StartTask

Eigenschaftswert

StartTask

targetNodeCommunicationMode

Wenn der Wert nicht angegeben wird, lautet der Standardwert Default.

targetNodeCommunicationMode?: NodeCommunicationMode

Eigenschaftswert

NodeCommunicationMode

taskSchedulingPolicy

Wenn nicht angegeben, ist der Standardwert spread.

taskSchedulingPolicy?: TaskSchedulingPolicy

Eigenschaftswert

TaskSchedulingPolicy

taskSlotsPerNode

Der Standardwert ist 1. Der Maximalwert ist der 4-fache der Anzahl der Kerne des vmSize-Pools oder 256.

taskSlotsPerNode?: number

Eigenschaftswert

number

upgradePolicy

Beschreibt eine Upgraderichtlinie – automatisch, manuell oder rolliert.

upgradePolicy?: UpgradePolicy

Eigenschaftswert

UpgradePolicy

userAccounts

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

userAccounts?: UserAccount[]

Eigenschaftswert

UserAccount[]

vmSize

Informationen zu verfügbaren Größen von virtuellen Computern für Cloud Services Pools (mit cloudServiceConfiguration erstellte Pools) finden Sie unter Größen für Cloud Services (https://azure.microsoft.com/documentation/articles/cloud-services-sizes-specs/). Batch unterstützt alle Cloud Services VM-Größen mit Ausnahme von ExtraSmall. Informationen zu verfügbaren VM-Größen für Pools mit Images aus dem Virtual Machines Marketplace (mit virtualMachineConfiguration erstellte Pools) finden Sie unter Größen für Virtual Machines (Linux)https://azure.microsoft.com/documentation/articles/virtual-machines-linux-sizes/ oder Größen für Virtual Machines (Windows) (https://azure.microsoft.com/documentation/articles/virtual-machines-windows-sizes/). Batch unterstützt alle Azure-VM-Größen mit Ausnahme von STANDARD_A0 und Premium-Speicher (STANDARD_GS, STANDARD_DS und STANDARD_DSV2 Serie).

vmSize?: string

Eigenschaftswert

string

Geerbte Eigenschaftsdetails

etag

Das ETag der Ressource, die für Parallelitätsanweisungen verwendet wird. HINWEIS: Diese Eigenschaft wird nicht serialisiert. Sie kann nur vom Server aufgefüllt werden.

etag?: string

Eigenschaftswert

string

Geerbt vonProxyResource.etag

id

Die ID der Ressource. HINWEIS: Diese Eigenschaft wird nicht serialisiert. Sie kann nur vom Server aufgefüllt werden.

id?: string

Eigenschaftswert

string

Geerbt vonProxyResource.id

name

Der Name der Ressource. HINWEIS: Diese Eigenschaft wird nicht serialisiert. Sie kann nur vom Server aufgefüllt werden.

name?: string

Eigenschaftswert

string

Geerbt vonProxyResource.name

type

Der Typ der Ressource. HINWEIS: Diese Eigenschaft wird nicht serialisiert. Sie kann nur vom Server aufgefüllt werden.

type?: string

Eigenschaftswert

string

Geerbt vonProxyResource.type