BatchPoolCreateOptions interface

Pakket:

@azure-rest/batch

Parameters voor het maken van een Azure Batch-pool.

Eigenschappen

applicationPackageReferences	De lijst met pakketten die moeten worden geïnstalleerd op elk rekenknooppunt in de pool. Bij het maken van een pool moet de toepassings-id van het pakket volledig zijn gekwalificeerd (/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Batch/batchAccounts/{accountName}/applications/{applicationName}). Wijzigingen in pakketverwijzingen zijn van invloed op alle nieuwe knooppunten die lid zijn van de pool, maar hebben geen invloed op rekenknooppunten die zich al in de pool bevinden totdat ze opnieuw worden opgestart of opnieuw worden hersteld. Er zijn maximaal 10 pakketverwijzingen voor een bepaalde groep.
autoScaleEvaluationInterval	Het tijdsinterval waarmee de poolgrootte automatisch moet worden aangepast volgens de formule voor automatische schaalaanpassing. De standaardwaarde is 15 minuten. De minimum- en maximumwaarde zijn respectievelijk 5 minuten en 168 uur. Als u een waarde opgeeft die minder dan 5 minuten of langer is dan 168 uur, retourneert de Batch-service een fout; als u de REST API rechtstreeks aanroept, is de HTTP-statuscode 400 (Ongeldige aanvraag).
autoScaleFormula	Een formule voor het gewenste aantal rekenknooppunten in de pool. Deze eigenschap mag niet worden opgegeven als enableAutoScale is ingesteld op false. Dit is vereist als enableAutoScale is ingesteld op true. De formule wordt gecontroleerd op geldigheid voordat de pool wordt gemaakt. Als de formule niet geldig is, weigert de Batch-service de aanvraag met gedetailleerde foutinformatie. Zie 'Rekenknooppunten automatisch schalen in een Azure Batch-pool' (https://learn.microsoft.com/azure/batch/batch-automatic-scaling) voor meer informatie over het opgeven van deze formule.
displayName	De weergavenaam voor de pool. De weergavenaam hoeft niet uniek te zijn en mag unicode-tekens bevatten tot een maximale lengte van 1024.
enableAutoScale	Of de grootte van de pool na verloop van tijd automatisch moet worden aangepast. Als dit onwaar is, moeten ten minste één van targetDedicatedNodes en targetLowPriorityNodes worden opgegeven. Indien waar, is de eigenschap AutoScaleFormula vereist en wordt de grootte van de pool automatisch aangepast aan de formule. De standaardwaarde is onwaar.
enableInterNodeCommunication	Of de pool directe communicatie tussen rekenknooppunten toestaat. Als u communicatie tussen knooppunten inschakelt, wordt de maximale grootte van de pool beperkt vanwege implementatiebeperkingen op de rekenknooppunten van de pool. Dit kan ertoe leiden dat de pool de gewenste grootte niet bereikt. De standaardwaarde is onwaar.
id	Een tekenreeks die de pool uniek identificeert binnen het account. De id kan elke combinatie van alfanumerieke tekens bevatten, inclusief afbreekstreepjes en onderstrepingstekens, en mag niet meer dan 64 tekens bevatten. De id is hoofdlettergevoelig en niet hoofdlettergevoelig (dat wil gezegd, u hebt mogelijk geen twee pool-id's binnen een account die alleen per geval verschillen).
metadata	Een lijst met naam-waardeparen die zijn gekoppeld aan de pool als metagegevens. De Batch-service wijst geen betekenis toe aan metagegevens; deze is uitsluitend bedoeld voor het gebruik van gebruikerscode.
mountConfiguration	Koppel opslag met behulp van het opgegeven bestandssysteem voor de gehele levensduur van de pool. Koppel de opslag met behulp van azure-bestandsshare, NFS, CIFS of op Blobfuse gebaseerd bestandssysteem.
networkConfiguration	De netwerkconfiguratie voor de pool.
resizeTimeout	De time-out voor de toewijzing van rekenknooppunten aan de pool. Deze time-out is alleen van toepassing op handmatig schalen; dit heeft geen effect wanneer enableAutoScale is ingesteld op true. De standaardwaarde is 15 minuten. De minimumwaarde is 5 minuten. Als u een waarde opgeeft die minder dan 5 minuten is, retourneert de Batch-service een fout; als u de REST API rechtstreeks aanroept, is de HTTP-statuscode 400 (Ongeldige aanvraag).
startTask	Een taak die moet worden uitgevoerd op elk rekenknooppunt terwijl deze lid wordt van de pool. De taak wordt uitgevoerd wanneer het rekenknooppunt wordt toegevoegd aan de pool of wanneer het rekenknooppunt opnieuw wordt opgestart.
targetDedicatedNodes	Het gewenste aantal toegewezen rekenknooppunten in de pool. Deze eigenschap mag niet worden opgegeven als enableAutoScale is ingesteld op true. Als enableAutoScale is ingesteld op false, moet u targetDedicatedNodes, targetLowPriorityNodes of beide instellen.
targetLowPriorityNodes	Het gewenste aantal spot-/lage prioriteit rekenknooppunten in de pool. Deze eigenschap mag niet worden opgegeven als enableAutoScale is ingesteld op true. Als enableAutoScale is ingesteld op false, moet u targetDedicatedNodes, targetLowPriorityNodes of beide instellen.
taskSchedulingPolicy	Hoe taken worden verdeeld over rekenknooppunten in een pool. Als dit niet is opgegeven, wordt de standaardwaarde verspreid.
taskSlotsPerNode	Het aantal taaksites dat kan worden gebruikt om gelijktijdige taken uit te voeren op één rekenknooppunt in de pool. De standaardwaarde is 1. De maximumwaarde is de kleinste van 4 keer het aantal kernen van de vmSize van de pool of 256.
upgradePolicy	Het upgradebeleid voor de pool. Beschrijft een upgradebeleid: automatisch, handmatig of rolling.
userAccounts	De lijst met gebruikersaccounts die moeten worden gemaakt op elk rekenknooppunt in de pool.
virtualMachineConfiguration	De configuratie van de virtuele machine voor de pool. Deze eigenschap moet worden opgegeven.
vmSize	De grootte van virtuele machines in de pool. Alle virtuele machines in een pool hebben dezelfde grootte. Zie Formaten voor virtuele machines in Azure (https://learn.microsoft.com/azure/virtual-machines/sizes/overview) voor informatie over beschikbare VM-grootten voor pools met behulp van installatiekopieën van de Virtual Machines Marketplace (pools gemaakt met virtualMachineConfiguration). Batch ondersteunt alle azure-VM-grootten, behalve STANDARD_A0 en vm's met Premium Storage (STANDARD_GS, STANDARD_DS en STANDARD_DSV2 reeks).

Eigenschapdetails

applicationPackageReferences

De lijst met pakketten die moeten worden geïnstalleerd op elk rekenknooppunt in de pool. Bij het maken van een pool moet de toepassings-id van het pakket volledig zijn gekwalificeerd (/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Batch/batchAccounts/{accountName}/applications/{applicationName}). Wijzigingen in pakketverwijzingen zijn van invloed op alle nieuwe knooppunten die lid zijn van de pool, maar hebben geen invloed op rekenknooppunten die zich al in de pool bevinden totdat ze opnieuw worden opgestart of opnieuw worden hersteld. Er zijn maximaal 10 pakketverwijzingen voor een bepaalde groep.

applicationPackageReferences?: BatchApplicationPackageReference[]

Waarde van eigenschap

BatchApplicationPackageReference[]

autoScaleEvaluationInterval

Het tijdsinterval waarmee de poolgrootte automatisch moet worden aangepast volgens de formule voor automatische schaalaanpassing. De standaardwaarde is 15 minuten. De minimum- en maximumwaarde zijn respectievelijk 5 minuten en 168 uur. Als u een waarde opgeeft die minder dan 5 minuten of langer is dan 168 uur, retourneert de Batch-service een fout; als u de REST API rechtstreeks aanroept, is de HTTP-statuscode 400 (Ongeldige aanvraag).

autoScaleEvaluationInterval?: string

Waarde van eigenschap

string

autoScaleFormula

Een formule voor het gewenste aantal rekenknooppunten in de pool. Deze eigenschap mag niet worden opgegeven als enableAutoScale is ingesteld op false. Dit is vereist als enableAutoScale is ingesteld op true. De formule wordt gecontroleerd op geldigheid voordat de pool wordt gemaakt. Als de formule niet geldig is, weigert de Batch-service de aanvraag met gedetailleerde foutinformatie. Zie 'Rekenknooppunten automatisch schalen in een Azure Batch-pool' (https://learn.microsoft.com/azure/batch/batch-automatic-scaling) voor meer informatie over het opgeven van deze formule.

autoScaleFormula?: string

Waarde van eigenschap

string

displayName

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

displayName?: string

Waarde van eigenschap

string

enableAutoScale

Of de grootte van de pool na verloop van tijd automatisch moet worden aangepast. Als dit onwaar is, moeten ten minste één van targetDedicatedNodes en targetLowPriorityNodes worden opgegeven. Indien waar, is de eigenschap AutoScaleFormula vereist en wordt de grootte van de pool automatisch aangepast aan de formule. De standaardwaarde is onwaar.

enableAutoScale?: boolean

Waarde van eigenschap

boolean

enableInterNodeCommunication

Of de pool directe communicatie tussen rekenknooppunten toestaat. Als u communicatie tussen knooppunten inschakelt, wordt de maximale grootte van de pool beperkt vanwege implementatiebeperkingen op de rekenknooppunten van de pool. Dit kan ertoe leiden dat de pool de gewenste grootte niet bereikt. De standaardwaarde is onwaar.

enableInterNodeCommunication?: boolean

Waarde van eigenschap

boolean

id

Een tekenreeks die de pool uniek identificeert binnen het account. De id kan elke combinatie van alfanumerieke tekens bevatten, inclusief afbreekstreepjes en onderstrepingstekens, en mag niet meer dan 64 tekens bevatten. De id is hoofdlettergevoelig en niet hoofdlettergevoelig (dat wil gezegd, u hebt mogelijk geen twee pool-id's binnen een account die alleen per geval verschillen).

id: string

Waarde van eigenschap

string

metadata

Een lijst met naam-waardeparen die zijn gekoppeld aan de pool als metagegevens. De Batch-service wijst geen betekenis toe aan metagegevens; deze is uitsluitend bedoeld voor het gebruik van gebruikerscode.

metadata?: BatchMetadataItem[]

Waarde van eigenschap

BatchMetadataItem[]

mountConfiguration

Koppel opslag met behulp van het opgegeven bestandssysteem voor de gehele levensduur van de pool. Koppel de opslag met behulp van azure-bestandsshare, NFS, CIFS of op Blobfuse gebaseerd bestandssysteem.

mountConfiguration?: MountConfiguration[]

Waarde van eigenschap

MountConfiguration[]

networkConfiguration

De netwerkconfiguratie voor de pool.

networkConfiguration?: NetworkConfiguration

Waarde van eigenschap

NetworkConfiguration

resizeTimeout

De time-out voor de toewijzing van rekenknooppunten aan de pool. Deze time-out is alleen van toepassing op handmatig schalen; dit heeft geen effect wanneer enableAutoScale is ingesteld op true. De standaardwaarde is 15 minuten. De minimumwaarde is 5 minuten. Als u een waarde opgeeft die minder dan 5 minuten is, retourneert de Batch-service een fout; als u de REST API rechtstreeks aanroept, is de HTTP-statuscode 400 (Ongeldige aanvraag).

resizeTimeout?: string

Waarde van eigenschap

string

startTask

Een taak die moet worden uitgevoerd op elk rekenknooppunt terwijl deze lid wordt van de pool. De taak wordt uitgevoerd wanneer het rekenknooppunt wordt toegevoegd aan de pool of wanneer het rekenknooppunt opnieuw wordt opgestart.

startTask?: BatchStartTask

Waarde van eigenschap

BatchStartTask

targetDedicatedNodes

Het gewenste aantal toegewezen rekenknooppunten in de pool. Deze eigenschap mag niet worden opgegeven als enableAutoScale is ingesteld op true. Als enableAutoScale is ingesteld op false, moet u targetDedicatedNodes, targetLowPriorityNodes of beide instellen.

targetDedicatedNodes?: number

Waarde van eigenschap

number

targetLowPriorityNodes

Het gewenste aantal spot-/lage prioriteit rekenknooppunten in de pool. Deze eigenschap mag niet worden opgegeven als enableAutoScale is ingesteld op true. Als enableAutoScale is ingesteld op false, moet u targetDedicatedNodes, targetLowPriorityNodes of beide instellen.

targetLowPriorityNodes?: number

Waarde van eigenschap

number

taskSchedulingPolicy

Hoe taken worden verdeeld over rekenknooppunten in een pool. Als dit niet is opgegeven, wordt de standaardwaarde verspreid.

taskSchedulingPolicy?: BatchTaskSchedulingPolicy

Waarde van eigenschap

BatchTaskSchedulingPolicy

taskSlotsPerNode

Het aantal taaksites dat kan worden gebruikt om gelijktijdige taken uit te voeren op één rekenknooppunt in de pool. 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

Het upgradebeleid voor de pool. Beschrijft een upgradebeleid: automatisch, handmatig of rolling.

upgradePolicy?: UpgradePolicy

Waarde van eigenschap

UpgradePolicy

userAccounts

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

userAccounts?: UserAccount[]

Waarde van eigenschap

UserAccount[]

virtualMachineConfiguration

De configuratie van de virtuele machine voor de pool. Deze eigenschap moet worden opgegeven.

virtualMachineConfiguration?: VirtualMachineConfiguration

Waarde van eigenschap

VirtualMachineConfiguration

vmSize

De grootte van virtuele machines in de pool. Alle virtuele machines in een pool hebben dezelfde grootte. Zie Formaten voor virtuele machines in Azure (https://learn.microsoft.com/azure/virtual-machines/sizes/overview) voor informatie over beschikbare VM-grootten voor pools met behulp van installatiekopieën van de Virtual Machines Marketplace (pools gemaakt met virtualMachineConfiguration). 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