Pool interface

Pakket:

@azure/arm-batch

Bevat informatie over een pool.

Uitbreiding

AzureProxyResource

Eigenschappen

allocationState	Of de grootte van de pool wordt gewijzigd. OPMERKING: Deze eigenschap wordt niet geserialiseerd. Deze kan alleen worden ingevuld door de server.
allocationStateTransitionTime	Het tijdstip waarop de pool de huidige toewijzingsstatus heeft ingevoerd. OPMERKING: Deze eigenschap wordt niet geserialiseerd. Deze kan alleen worden ingevuld door de server.
applicationLicenses	De lijst met toepassingslicenties moet een subset van beschikbare Licenties voor Batch-servicetoepassingen zijn. Als er een licentie wordt aangevraagd die niet wordt ondersteund, mislukt het maken van een pool.
applicationPackages	Wijzigingen in toepassingspakketverwijzingen zijn van invloed op alle nieuwe rekenknooppunten die lid zijn van de pool, maar hebben geen invloed op rekenknooppunten die al in de pool staan totdat ze opnieuw worden opgestart of opnieuw worden gemaakt. Er zijn maximaal 10 toepassingspakketverwijzingen voor een bepaalde groep.
autoScaleRun	Deze eigenschap wordt alleen ingesteld als de pool automatisch wordt geschaald, bijvoorbeeld autoScaleSettings. OPMERKING: Deze eigenschap wordt niet geserialiseerd. Deze kan alleen worden ingevuld door de server.
certificates	Voor Windows-rekenknooppunten installeert de Batch-service de certificaten naar het opgegeven certificaatarchief en de opgegeven locatie. Voor Linux-rekenknooppunten worden de certificaten opgeslagen in een map in de werkmap van de taak en wordt een omgevingsvariabele AZ_BATCH_CERTIFICATES_DIR aan de taak geleverd om een query uit te voeren op deze locatie. Voor certificaten met zichtbaarheid van remoteUser wordt een map met certificaten gemaakt in de basismap van de gebruiker (bijvoorbeeld /home/{user-name}/certs) en worden certificaten in die map geplaatst. Waarschuwing: deze eigenschap is afgeschaft en wordt na februari 2024 verwijderd. Gebruik in plaats daarvan de Azure KeyVault-extensie.
creationTime	De aanmaaktijd van het zwembad. OPMERKING: Deze eigenschap wordt niet geserialiseerd. Deze kan alleen worden ingevuld door de server.
currentDedicatedNodes	Het aantal toegewezen rekenknooppunten dat zich momenteel in de pool bevindt. OPMERKING: Deze eigenschap wordt niet geserialiseerd. Deze kan alleen worden ingevuld door de server.
currentLowPriorityNodes	Het aantal rekenknooppunten met spot-/lage prioriteit die zich momenteel in de pool bevinden. OPMERKING: Deze eigenschap wordt niet geserialiseerd. Deze kan alleen worden ingevuld door de server.
currentNodeCommunicationMode	Bepaalt hoe een pool communiceert met de Batch-service. OPMERKING: Deze eigenschap wordt niet geserialiseerd. Deze kan alleen worden ingevuld door de server.
deploymentConfiguration	Configuratie-eigenschappen voor implementatie.
displayName	De weergavenaam hoeft niet uniek te zijn en mag unicode-tekens bevatten tot een maximale lengte van 1024.
identity	Het type identiteit dat wordt gebruikt voor de Batch-pool.
interNodeCommunication	Hiermee worden beperkingen opgelegd aan welke knooppunten aan de pool kunnen worden toegewezen. Als u deze waarde inschakelt, kan de kans op het aangevraagde aantal knooppunten dat in de pool moet worden toegewezen, verminderen. Als deze waarde niet is opgegeven, wordt deze waarde standaard ingesteld op Uitgeschakeld.
lastModified	Dit is de laatste keer dat de gegevens op groepsniveau, zoals targetDedicatedNodes of autoScaleSettings, zijn gewijzigd. Dit houdt geen rekening met wijzigingen op knooppuntniveau, zoals een wijzigingsstatus van een rekenknooppunt. OPMERKING: Deze eigenschap wordt niet geserialiseerd. Deze kan alleen worden ingevuld door de server.
metadata	De Batch-service wijst geen betekenis toe aan metagegevens; deze is uitsluitend bedoeld voor het gebruik van gebruikerscode.
mountConfiguration	Dit ondersteunt Azure Files, NFS, CIFS/SMB en Blobfuse.
networkConfiguration	De netwerkconfiguratie voor een pool.
provisioningState	De huidige status van de pool. OPMERKING: Deze eigenschap wordt niet geserialiseerd. Deze kan alleen worden ingevuld door de server.
provisioningStateTransitionTime	Het tijdstip waarop de pool de huidige status heeft ingevoerd. OPMERKING: Deze eigenschap wordt niet geserialiseerd. Deze kan alleen worden ingevuld door de server.
resizeOperationStatus	Beschrijft de huidige bewerking (als de pool AllocationState het formaat wijzigt) of de eerder voltooide bewerking (als de AllocationState stabiel is). OPMERKING: Deze eigenschap wordt niet geserialiseerd. Deze kan alleen worden ingevuld door de server.
resourceTags	De door de gebruiker gedefinieerde tags die moeten worden gekoppeld aan de Azure Batch-pool. Wanneer deze tags zijn opgegeven, worden deze tags doorgegeven aan de back-up van Azure-resources die zijn gekoppeld aan de pool. Deze eigenschap kan alleen worden opgegeven wanneer het Batch-account is gemaakt met de eigenschap poolAllocationMode ingesteld op UserSubscription.
scaleSettings	Definieert de gewenste grootte van de pool. Dit kan 'fixedScale' zijn waarbij de aangevraagde targetDedicatedNodes is opgegeven, of 'autoScale' waarmee een formule wordt gedefinieerd die periodiek opnieuw wordt geëvalueerd. Als deze eigenschap niet is opgegeven, heeft de pool een vaste schaal met 0 targetDedicatedNodes.
startTask	In een PATCH-bewerking (update) kan deze eigenschap worden ingesteld op een leeg object om de begintaak uit de pool te verwijderen.
targetNodeCommunicationMode	Als u dit weglaat, is de standaardwaarde Standaard.
taskSchedulingPolicy	Als dit niet is opgegeven, wordt de standaardwaarde verspreid.
taskSlotsPerNode	De standaardwaarde is 1. De maximumwaarde is de kleinste van 4 keer het aantal kernen van de vmSize van de pool of 256.
upgradePolicy	Beschrijft een upgradebeleid: automatisch, handmatig of rolling.
userAccounts	De lijst met gebruikersaccounts die op elk knooppunt in de pool moeten worden gemaakt.
vmSize	Zie Grootten voor virtuele machines (Linux) (https://azure.microsoft.com/documentation/articles/virtual-machines-linux-sizes/) of grootten voor virtuele machines (Windows) (https://azure.microsoft.com/documentation/articles/virtual-machines-windows-sizes/) voor meer informatie over beschikbare VM-grootten. Batch ondersteunt alle azure-VM-grootten, behalve STANDARD_A0 en vm's met Premium Storage (STANDARD_GS, STANDARD_DS en STANDARD_DSV2 reeks).

Overgenomen eigenschappen

etag	De ETag van de resource die wordt gebruikt voor gelijktijdigheidsinstructies. OPMERKING: Deze eigenschap wordt niet geserialiseerd. Deze kan alleen worden ingevuld door de server.
id	De id van de resource. OPMERKING: Deze eigenschap wordt niet geserialiseerd. Deze kan alleen worden ingevuld door de server.
name	De naam van de resource. OPMERKING: Deze eigenschap wordt niet geserialiseerd. Deze kan alleen worden ingevuld door de server.
tags	De tags van de resource.
type	Het type resource. OPMERKING: Deze eigenschap wordt niet geserialiseerd. Deze kan alleen worden ingevuld door de server.

Eigenschapdetails

allocationState

Of de grootte van de pool wordt gewijzigd. OPMERKING: Deze eigenschap wordt niet geserialiseerd. Deze kan alleen worden ingevuld door de server.

allocationState?: AllocationState

Waarde van eigenschap

AllocationState

allocationStateTransitionTime

Het tijdstip waarop de pool de huidige toewijzingsstatus heeft ingevoerd. OPMERKING: Deze eigenschap wordt niet geserialiseerd. Deze kan alleen worden ingevuld door de server.

allocationStateTransitionTime?: Date

Waarde van eigenschap

Date

applicationLicenses

De lijst met toepassingslicenties moet een subset van beschikbare Licenties voor Batch-servicetoepassingen zijn. Als er een licentie wordt aangevraagd die niet wordt ondersteund, mislukt het maken van een pool.

applicationLicenses?: string[]

Waarde van eigenschap

string[]

applicationPackages

Wijzigingen in toepassingspakketverwijzingen zijn van invloed op alle nieuwe rekenknooppunten die lid zijn van de pool, maar hebben geen invloed op rekenknooppunten die al in de pool staan totdat ze opnieuw worden opgestart of opnieuw worden gemaakt. Er zijn maximaal 10 toepassingspakketverwijzingen voor een bepaalde groep.

applicationPackages?: ApplicationPackageReference[]

Waarde van eigenschap

ApplicationPackageReference[]

autoScaleRun

Deze eigenschap wordt alleen ingesteld als de pool automatisch wordt geschaald, bijvoorbeeld autoScaleSettings. OPMERKING: Deze eigenschap wordt niet geserialiseerd. Deze kan alleen worden ingevuld door de server.

autoScaleRun?: AutoScaleRun

Waarde van eigenschap

AutoScaleRun

certificates

Voor Windows-rekenknooppunten installeert de Batch-service de certificaten naar het opgegeven certificaatarchief en de opgegeven locatie. Voor Linux-rekenknooppunten worden de certificaten opgeslagen in een map in de werkmap van de taak en wordt een omgevingsvariabele AZ_BATCH_CERTIFICATES_DIR aan de taak geleverd om een query uit te voeren op deze locatie. Voor certificaten met zichtbaarheid van remoteUser wordt een map met certificaten gemaakt in de basismap van de gebruiker (bijvoorbeeld /home/{user-name}/certs) en worden certificaten in die map geplaatst.

Waarschuwing: deze eigenschap is afgeschaft en wordt na februari 2024 verwijderd. Gebruik in plaats daarvan de Azure KeyVault-extensie.

certificates?: CertificateReference[]

Waarde van eigenschap

CertificateReference[]

creationTime

De aanmaaktijd van het zwembad. OPMERKING: Deze eigenschap wordt niet geserialiseerd. Deze kan alleen worden ingevuld door de server.

creationTime?: Date

Waarde van eigenschap

Date

currentDedicatedNodes

Het aantal toegewezen rekenknooppunten dat zich momenteel in de pool bevindt. OPMERKING: Deze eigenschap wordt niet geserialiseerd. Deze kan alleen worden ingevuld door de server.

currentDedicatedNodes?: number

Waarde van eigenschap

number

currentLowPriorityNodes

Het aantal rekenknooppunten met spot-/lage prioriteit die zich momenteel in de pool bevinden. OPMERKING: Deze eigenschap wordt niet geserialiseerd. Deze kan alleen worden ingevuld door de server.

currentLowPriorityNodes?: number

Waarde van eigenschap

number

currentNodeCommunicationMode

Bepaalt hoe een pool communiceert met de Batch-service. OPMERKING: Deze eigenschap wordt niet geserialiseerd. Deze kan alleen worden ingevuld door de server.

currentNodeCommunicationMode?: NodeCommunicationMode

Waarde van eigenschap

NodeCommunicationMode

deploymentConfiguration

Configuratie-eigenschappen voor implementatie.

deploymentConfiguration?: DeploymentConfiguration

Waarde van eigenschap

DeploymentConfiguration

displayName

De weergavenaam hoeft niet uniek te zijn en mag unicode-tekens bevatten tot een maximale lengte van 1024.

displayName?: string

Waarde van eigenschap

string

identity

Het type identiteit dat wordt gebruikt voor de Batch-pool.

identity?: BatchPoolIdentity

Waarde van eigenschap

BatchPoolIdentity

interNodeCommunication

Hiermee worden beperkingen opgelegd aan welke knooppunten aan de pool kunnen worden toegewezen. Als u deze waarde inschakelt, kan de kans op het aangevraagde aantal knooppunten dat in de pool moet worden toegewezen, verminderen. Als deze waarde niet is opgegeven, wordt deze waarde standaard ingesteld op Uitgeschakeld.

interNodeCommunication?: InterNodeCommunicationState

Waarde van eigenschap

InterNodeCommunicationState

lastModified

Dit is de laatste keer dat de gegevens op groepsniveau, zoals targetDedicatedNodes of autoScaleSettings, zijn gewijzigd. Dit houdt geen rekening met wijzigingen op knooppuntniveau, zoals een wijzigingsstatus van een rekenknooppunt. OPMERKING: Deze eigenschap wordt niet geserialiseerd. Deze kan alleen worden ingevuld door de server.

lastModified?: Date

Waarde van eigenschap

Date

metadata

De Batch-service wijst geen betekenis toe aan metagegevens; deze is uitsluitend bedoeld voor het gebruik van gebruikerscode.

metadata?: MetadataItem[]

Waarde van eigenschap

MetadataItem[]

mountConfiguration

Dit ondersteunt Azure Files, NFS, CIFS/SMB en Blobfuse.

mountConfiguration?: MountConfiguration[]

Waarde van eigenschap

MountConfiguration[]

networkConfiguration

De netwerkconfiguratie voor een pool.

networkConfiguration?: NetworkConfiguration

Waarde van eigenschap

NetworkConfiguration

provisioningState

De huidige status van de pool. OPMERKING: Deze eigenschap wordt niet geserialiseerd. Deze kan alleen worden ingevuld door de server.

provisioningState?: PoolProvisioningState

Waarde van eigenschap

PoolProvisioningState

provisioningStateTransitionTime

Het tijdstip waarop de pool de huidige status heeft ingevoerd. OPMERKING: Deze eigenschap wordt niet geserialiseerd. Deze kan alleen worden ingevuld door de server.

provisioningStateTransitionTime?: Date

Waarde van eigenschap

Date

resizeOperationStatus

Beschrijft de huidige bewerking (als de pool AllocationState het formaat wijzigt) of de eerder voltooide bewerking (als de AllocationState stabiel is). OPMERKING: Deze eigenschap wordt niet geserialiseerd. Deze kan alleen worden ingevuld door de server.

resizeOperationStatus?: ResizeOperationStatus

Waarde van eigenschap

ResizeOperationStatus

resourceTags

De door de gebruiker gedefinieerde tags die moeten worden gekoppeld aan de Azure Batch-pool. Wanneer deze tags zijn opgegeven, worden deze tags doorgegeven aan de back-up van Azure-resources die zijn gekoppeld aan de pool. Deze eigenschap kan alleen worden opgegeven wanneer het Batch-account is gemaakt met de eigenschap poolAllocationMode ingesteld op UserSubscription.

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

Waarde van eigenschap

{[propertyName: string]: string}

scaleSettings

Definieert de gewenste grootte van de pool. Dit kan 'fixedScale' zijn waarbij de aangevraagde targetDedicatedNodes is opgegeven, of 'autoScale' waarmee een formule wordt gedefinieerd die periodiek opnieuw wordt geëvalueerd. Als deze eigenschap niet is opgegeven, heeft de pool een vaste schaal met 0 targetDedicatedNodes.

scaleSettings?: ScaleSettings

Waarde van eigenschap

ScaleSettings

startTask

In een PATCH-bewerking (update) kan deze eigenschap worden ingesteld op een leeg object om de begintaak uit de pool te verwijderen.

startTask?: StartTask

Waarde van eigenschap

StartTask

targetNodeCommunicationMode

Als u dit weglaat, is de standaardwaarde Standaard.

targetNodeCommunicationMode?: NodeCommunicationMode

Waarde van eigenschap

NodeCommunicationMode

taskSchedulingPolicy

Als dit niet is opgegeven, wordt de standaardwaarde verspreid.

taskSchedulingPolicy?: TaskSchedulingPolicy

Waarde van eigenschap

TaskSchedulingPolicy

taskSlotsPerNode

De standaardwaarde is 1. De maximumwaarde is de kleinste van 4 keer het aantal kernen van de vmSize van de pool of 256.

taskSlotsPerNode?: number

Waarde van eigenschap

number

upgradePolicy

Beschrijft een upgradebeleid: automatisch, handmatig of rolling.

upgradePolicy?: UpgradePolicy

Waarde van eigenschap

UpgradePolicy

userAccounts

De lijst met gebruikersaccounts die op elk knooppunt in de pool moeten worden gemaakt.

userAccounts?: UserAccount[]

Waarde van eigenschap

UserAccount[]

vmSize

Zie Grootten voor virtuele machines (Linux) (https://azure.microsoft.com/documentation/articles/virtual-machines-linux-sizes/) of grootten voor virtuele machines (Windows) (https://azure.microsoft.com/documentation/articles/virtual-machines-windows-sizes/) voor meer informatie over beschikbare VM-grootten. Batch ondersteunt alle azure-VM-grootten, behalve STANDARD_A0 en vm's met Premium Storage (STANDARD_GS, STANDARD_DS en STANDARD_DSV2 reeks).

vmSize?: string

Waarde van eigenschap

string

Details van overgenomen eigenschap

etag

De ETag van de resource die wordt gebruikt voor gelijktijdigheidsinstructies. OPMERKING: Deze eigenschap wordt niet geserialiseerd. Deze kan alleen worden ingevuld door de server.

etag?: string

Waarde van eigenschap

string

overgenomen vanAzureProxyResource.etag-

id

De id van de resource. OPMERKING: Deze eigenschap wordt niet geserialiseerd. Deze kan alleen worden ingevuld door de server.

id?: string

Waarde van eigenschap

string

overgenomen vanAzureProxyResource.id

name

De naam van de resource. OPMERKING: Deze eigenschap wordt niet geserialiseerd. Deze kan alleen worden ingevuld door de server.

name?: string

Waarde van eigenschap

string

overgenomen vanAzureProxyResource.name

tags

De tags van de resource.

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

Waarde van eigenschap

{[propertyName: string]: string}

overgenomen vanAzureProxyResource.tags

type

Het type resource. OPMERKING: Deze eigenschap wordt niet geserialiseerd. Deze kan alleen worden ingevuld door de server.

type?: string

Waarde van eigenschap

string

overgenomen vanAzureProxyResource.type