BatchPoolCreateOptions interface

Paket:

@azure-rest/batch

Parametrar för att skapa en Azure Batch-pool.

Egenskaper

applicationPackageReferences	Listan över paket som ska installeras på varje beräkningsnod i poolen. När du skapar en pool måste paketets program-ID vara fullständigt kvalificerat (/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Batch/batchAccounts/{accountName}/applications/{applicationName}). Ändringar i paketreferenser påverkar alla nya noder som ansluter till poolen, men påverkar inte beräkningsnoder som redan finns i poolen förrän de startas om eller omskapas. Det finns högst 10 paketreferenser för en viss pool.
autoScaleEvaluationInterval	Tidsintervallet då poolstorleken ska justeras automatiskt enligt autoskalningsformeln. Standardvärdet är 15 minuter. Det lägsta och högsta värdet är 5 minuter respektive 168 timmar. Om du anger ett värde som är mindre än 5 minuter eller större än 168 timmar returnerar Batch-tjänsten ett fel. Om du anropar REST-API:et direkt är HTTP-statuskoden 400 (felaktig begäran).
autoScaleFormula	En formel för önskat antal beräkningsnoder i poolen. Den här egenskapen får inte anges om enableAutoScale är inställt på false. Det krävs om enableAutoScale är inställt på true. Formeln kontrolleras för giltighet innan poolen skapas. Om formeln inte är giltig avvisar Batch-tjänsten begäran med detaljerad felinformation. Mer information om hur du anger den här formeln finns i "Skala beräkningsnoder automatiskt i en Azure Batch-pool" (https://learn.microsoft.com/azure/batch/batch-automatic-scaling).
displayName	Visningsnamnet för poolen. Visningsnamnet behöver inte vara unikt och kan innehålla unicode-tecken upp till en maximal längd på 1024.
enableAutoScale	Om poolstorleken ska justeras automatiskt över tid. Om det är falskt måste minst en av targetDedicatedNodes och targetLowPriorityNodes anges. Om det är sant krävs egenskapen autoScaleFormula och poolen ändras automatiskt enligt formeln. Standardvärdet är falskt.
enableInterNodeCommunication	Om poolen tillåter direkt kommunikation mellan beräkningsnoder. Om kommunikation mellan noder aktiveras begränsas poolens maximala storlek på grund av distributionsbegränsningar för poolens beräkningsnoder. Detta kan leda till att poolen inte når önskad storlek. Standardvärdet är falskt.
id	En sträng som unikt identifierar poolen i kontot. ID:t kan innehålla valfri kombination av alfanumeriska tecken, inklusive bindestreck och understreck, och får inte innehålla fler än 64 tecken. ID:t är skiftlägesbevarande och skiftlägesokänsligt (dvs. du kanske inte har två pool-ID:n inom ett konto som endast skiljer sig åt från fall till fall).
metadata	En lista över namn/värde-par som är associerade med poolen som metadata. Batch-tjänsten tilldelar ingen betydelse för metadata. det är endast för användning av användarkod.
mountConfiguration	Montera lagring med angivet filsystem under hela poolens livslängd. Montera lagringen med azure-fildelning, NFS, CIFS- eller Blobfuse-baserat filsystem.
networkConfiguration	Nätverkskonfigurationen för poolen.
resizeTimeout	Tidsgränsen för allokering av beräkningsnoder till poolen. Den här tidsgränsen gäller endast för manuell skalning. det har ingen effekt när enableAutoScale är inställt på sant. Standardvärdet är 15 minuter. Minimivärdet är 5 minuter. Om du anger ett värde som är mindre än 5 minuter returnerar Batch-tjänsten ett fel. Om du anropar REST-API:et direkt är HTTP-statuskoden 400 (felaktig begäran).
startTask	En uppgift som har angetts för att köras på varje beräkningsnod när den ansluter till poolen. Aktiviteten körs när beräkningsnoden läggs till i poolen eller när beräkningsnoden startas om.
targetDedicatedNodes	Önskat antal dedikerade beräkningsnoder i poolen. Den här egenskapen får inte anges om enableAutoScale är inställt på true. Om enableAutoScale är inställt på false måste du ange antingen targetDedicatedNodes, targetLowPriorityNodes eller båda.
targetLowPriorityNodes	Önskat antal beräkningsnoder med oanvänd kapacitet/låg prioritet i poolen. Den här egenskapen får inte anges om enableAutoScale är inställt på true. Om enableAutoScale är inställt på false måste du ange antingen targetDedicatedNodes, targetLowPriorityNodes eller båda.
taskSchedulingPolicy	Så här distribueras uppgifter mellan beräkningsnoder i en pool. Om det inte anges är standardvärdet utspritt.
taskSlotsPerNode	Antalet aktivitetsfack som kan användas för att köra samtidiga uppgifter på en enda beräkningsnod i poolen. Standardvärdet är 1. Det maximala värdet är mindre än 4 gånger antalet kärnor i vmSize för poolen eller 256.
upgradePolicy	Uppgraderingsprincipen för poolen. Beskriver en uppgraderingsprincip – automatisk, manuell eller rullande.
userAccounts	Listan över användarkonton som ska skapas på varje beräkningsnod i poolen.
virtualMachineConfiguration	Konfigurationen av den virtuella datorn för poolen. Den här egenskapen måste anges.
vmSize	Storleken på virtuella datorer i poolen. Alla virtuella datorer i en pool har samma storlek. Information om tillgängliga VM-storlekar för pooler med avbildningar från Virtual Machines Marketplace (pooler som skapats med virtualMachineConfiguration) finns i Storlekar för virtuella datorer i Azure (https://learn.microsoft.com/azure/virtual-machines/sizes/overview). Batch har stöd för alla storlekar på virtuella Azure-datorer förutom STANDARD_A0 och de med premiumlagring (STANDARD_GS, STANDARD_DS och STANDARD_DSV2-serien).

Egenskapsinformation

applicationPackageReferences

Listan över paket som ska installeras på varje beräkningsnod i poolen. När du skapar en pool måste paketets program-ID vara fullständigt kvalificerat (/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Batch/batchAccounts/{accountName}/applications/{applicationName}). Ändringar i paketreferenser påverkar alla nya noder som ansluter till poolen, men påverkar inte beräkningsnoder som redan finns i poolen förrän de startas om eller omskapas. Det finns högst 10 paketreferenser för en viss pool.

applicationPackageReferences?: BatchApplicationPackageReference[]

Egenskapsvärde

BatchApplicationPackageReference[]

autoScaleEvaluationInterval

Tidsintervallet då poolstorleken ska justeras automatiskt enligt autoskalningsformeln. Standardvärdet är 15 minuter. Det lägsta och högsta värdet är 5 minuter respektive 168 timmar. Om du anger ett värde som är mindre än 5 minuter eller större än 168 timmar returnerar Batch-tjänsten ett fel. Om du anropar REST-API:et direkt är HTTP-statuskoden 400 (felaktig begäran).

autoScaleEvaluationInterval?: string

Egenskapsvärde

string

autoScaleFormula

En formel för önskat antal beräkningsnoder i poolen. Den här egenskapen får inte anges om enableAutoScale är inställt på false. Det krävs om enableAutoScale är inställt på true. Formeln kontrolleras för giltighet innan poolen skapas. Om formeln inte är giltig avvisar Batch-tjänsten begäran med detaljerad felinformation. Mer information om hur du anger den här formeln finns i "Skala beräkningsnoder automatiskt i en Azure Batch-pool" (https://learn.microsoft.com/azure/batch/batch-automatic-scaling).

autoScaleFormula?: string

Egenskapsvärde

string

displayName

Visningsnamnet för poolen. Visningsnamnet behöver inte vara unikt och kan innehålla unicode-tecken upp till en maximal längd på 1024.

displayName?: string

Egenskapsvärde

string

enableAutoScale

Om poolstorleken ska justeras automatiskt över tid. Om det är falskt måste minst en av targetDedicatedNodes och targetLowPriorityNodes anges. Om det är sant krävs egenskapen autoScaleFormula och poolen ändras automatiskt enligt formeln. Standardvärdet är falskt.

enableAutoScale?: boolean

Egenskapsvärde

boolean

enableInterNodeCommunication

Om poolen tillåter direkt kommunikation mellan beräkningsnoder. Om kommunikation mellan noder aktiveras begränsas poolens maximala storlek på grund av distributionsbegränsningar för poolens beräkningsnoder. Detta kan leda till att poolen inte når önskad storlek. Standardvärdet är falskt.

enableInterNodeCommunication?: boolean

Egenskapsvärde

boolean

id

En sträng som unikt identifierar poolen i kontot. ID:t kan innehålla valfri kombination av alfanumeriska tecken, inklusive bindestreck och understreck, och får inte innehålla fler än 64 tecken. ID:t är skiftlägesbevarande och skiftlägesokänsligt (dvs. du kanske inte har två pool-ID:n inom ett konto som endast skiljer sig åt från fall till fall).

id: string

Egenskapsvärde

string

metadata

En lista över namn/värde-par som är associerade med poolen som metadata. Batch-tjänsten tilldelar ingen betydelse för metadata. det är endast för användning av användarkod.

metadata?: BatchMetadataItem[]

Egenskapsvärde

BatchMetadataItem[]

mountConfiguration

Montera lagring med angivet filsystem under hela poolens livslängd. Montera lagringen med azure-fildelning, NFS, CIFS- eller Blobfuse-baserat filsystem.

mountConfiguration?: MountConfiguration[]

Egenskapsvärde

MountConfiguration[]

networkConfiguration

Nätverkskonfigurationen för poolen.

networkConfiguration?: NetworkConfiguration

Egenskapsvärde

NetworkConfiguration

resizeTimeout

Tidsgränsen för allokering av beräkningsnoder till poolen. Den här tidsgränsen gäller endast för manuell skalning. det har ingen effekt när enableAutoScale är inställt på sant. Standardvärdet är 15 minuter. Minimivärdet är 5 minuter. Om du anger ett värde som är mindre än 5 minuter returnerar Batch-tjänsten ett fel. Om du anropar REST-API:et direkt är HTTP-statuskoden 400 (felaktig begäran).

resizeTimeout?: string

Egenskapsvärde

string

startTask

En uppgift som har angetts för att köras på varje beräkningsnod när den ansluter till poolen. Aktiviteten körs när beräkningsnoden läggs till i poolen eller när beräkningsnoden startas om.

startTask?: BatchStartTask

Egenskapsvärde

BatchStartTask

targetDedicatedNodes

Önskat antal dedikerade beräkningsnoder i poolen. Den här egenskapen får inte anges om enableAutoScale är inställt på true. Om enableAutoScale är inställt på false måste du ange antingen targetDedicatedNodes, targetLowPriorityNodes eller båda.

targetDedicatedNodes?: number

Egenskapsvärde

number

targetLowPriorityNodes

Önskat antal beräkningsnoder med oanvänd kapacitet/låg prioritet i poolen. Den här egenskapen får inte anges om enableAutoScale är inställt på true. Om enableAutoScale är inställt på false måste du ange antingen targetDedicatedNodes, targetLowPriorityNodes eller båda.

targetLowPriorityNodes?: number

Egenskapsvärde

number

taskSchedulingPolicy

Så här distribueras uppgifter mellan beräkningsnoder i en pool. Om det inte anges är standardvärdet utspritt.

taskSchedulingPolicy?: BatchTaskSchedulingPolicy

Egenskapsvärde

BatchTaskSchedulingPolicy

taskSlotsPerNode

Antalet aktivitetsfack som kan användas för att köra samtidiga uppgifter på en enda beräkningsnod i poolen. Standardvärdet är 1. Det maximala värdet är mindre än 4 gånger antalet kärnor i vmSize för poolen eller 256.

taskSlotsPerNode?: number

Egenskapsvärde

number

upgradePolicy

Uppgraderingsprincipen för poolen. Beskriver en uppgraderingsprincip – automatisk, manuell eller rullande.

upgradePolicy?: UpgradePolicy

Egenskapsvärde

UpgradePolicy

userAccounts

Listan över användarkonton som ska skapas på varje beräkningsnod i poolen.

userAccounts?: UserAccount[]

Egenskapsvärde

UserAccount[]

virtualMachineConfiguration

Konfigurationen av den virtuella datorn för poolen. Den här egenskapen måste anges.

virtualMachineConfiguration?: VirtualMachineConfiguration

Egenskapsvärde

VirtualMachineConfiguration

vmSize

Storleken på virtuella datorer i poolen. Alla virtuella datorer i en pool har samma storlek. Information om tillgängliga VM-storlekar för pooler med avbildningar från Virtual Machines Marketplace (pooler som skapats med virtualMachineConfiguration) finns i Storlekar för virtuella datorer i Azure (https://learn.microsoft.com/azure/virtual-machines/sizes/overview). Batch har stöd för alla storlekar på virtuella Azure-datorer förutom STANDARD_A0 och de med premiumlagring (STANDARD_GS, STANDARD_DS och STANDARD_DSV2-serien).

vmSize: string

Egenskapsvärde

string