Pool - Add

Lägger till en pool till det angivna kontot.
När du namnger pooler bör du undvika att inkludera känslig information, till exempel användarnamn eller hemliga projektnamn. Den här informationen kan visas i telemetriloggar som är tillgängliga för Microsoft Support-tekniker.

POST {batchUrl}/pools?api-version=2024-07-01.20.0
POST {batchUrl}/pools?timeout={timeout}&api-version=2024-07-01.20.0

URI-parametrar

Name I Obligatorisk Typ Description
batchUrl
path True

string

Bas-URL:en för alla Azure Batch-tjänstbegäranden.

api-version
query True

string

Klient-API-version.

timeout
query

integer

int32

Den maximala tid som servern kan ägna åt att bearbeta begäran i sekunder. Standardvärdet är 30 sekunder. Om värdet är större än 30 används standardvärdet i stället.

Begärandehuvud

Media Types: "application/json; odata=minimalmetadata"

Name Obligatorisk Typ Description
client-request-id

string

uuid

Den anropargenererade begärandeidentiteten i form av ett GUID utan dekoration, till exempel klammerparenteser, t.ex. 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0.

return-client-request-id

boolean

Om servern ska returnera klient-request-id i svaret.

ocp-date

string

date-time-rfc1123

Den tid då begäran utfärdades. Klientbibliotek anger vanligtvis detta till den aktuella systemklockatiden. ange det explicit om du anropar REST-API:et direkt.

Begärandetext

Media Types: "application/json; odata=minimalmetadata"

Name Obligatorisk Typ Description
id True

string

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).

vmSize True

string

Storleken på virtuella datorer i poolen. Alla virtuella datorer i en pool har samma storlek.
Information om tillgängliga VM-storlekar finns i Storlekar för virtuella datorer (Linux) (https://azure.microsoft.com/documentation/articles/virtual-machines-linux-sizes/) eller Storlekar för virtuella datorer (Windows) (https://azure.microsoft.com/documentation/articles/virtual-machines-windows-sizes/). 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).

applicationPackageReferences

ApplicationPackageReference[]

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

string

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

string

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://azure.microsoft.com/documentation/articles/batch-automatic-scaling/).

certificateReferences

CertificateReference[]

Listan över certifikat som ska installeras på varje beräkningsnod i poolen.
För Windows-noder installerar Batch-tjänsten certifikaten till det angivna certifikatarkivet och platsen. För Linux-beräkningsnoder lagras certifikaten i en katalog i arbetskatalogen Aktivitet och en miljövariabel AZ_BATCH_CERTIFICATES_DIR skickas till uppgiften för att fråga efter den här platsen. För certifikat med synlighet för "remoteUser" skapas en "certifikatkatalog" i användarens hemkatalog (t.ex. /home/{user-name}/certs) och Certifikat placeras i den katalogen.

Varning! Den här egenskapen är inaktuell och tas bort efter februari 2024. Använd Azure KeyVault-tillägget i stället.

displayName

string

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

boolean

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

boolean

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.

metadata

MetadataItem[]

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

MountConfiguration[]

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

networkConfiguration

NetworkConfiguration

Nätverkskonfigurationen för poolen.
Nätverkskonfigurationen för en pool.

resizeTimeout

string

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).

resourceTags

object

De användardefinierade taggarna som är associerade med poolen.
De användardefinierade taggar som ska associeras med Azure Batch-poolen. När de här taggarna anges sprids de till de Azure-resurser som är associerade med poolen. Den här egenskapen kan bara anges när Batch-kontot skapades med egenskapen poolAllocationMode inställd på "UserSubscription".

startTask

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

integer

Ö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

integer

Ö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.

targetNodeCommunicationMode

NodeCommunicationMode

Önskat nodkommunikationsläge för poolen.
Om det utelämnas är standardvärdet Standard.

taskSchedulingPolicy

TaskSchedulingPolicy

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

taskSlotsPerNode

integer

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

UpgradePolicy

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

userAccounts

UserAccount[]

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

virtualMachineConfiguration

VirtualMachineConfiguration

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

Svar

Name Typ Description
201 Created

Begäran till Batch-tjänsten lyckades.

Sidhuvuden

  • client-request-id: string
  • request-id: string
  • ETag: string
  • Last-Modified: string
  • DataServiceId: string
Other Status Codes

BatchError

Felet från Batch-tjänsten.

Säkerhet

azure_auth

Autentiseringskodflöde för Microsoft Entra OAuth 2.0

Typ: oauth2
Flow: implicit
Auktoriseringswebbadress: https://login.microsoftonline.com/common/oauth2/authorize

Omfattningar

Name Description
user_impersonation Personifiera ditt användarkonto

Authorization

Typ: apiKey
I: header

Exempel

Add a pool with accelerated networking
Add a pool with mount drive specified
Add a pool with SecurityProfile
Add a pool with UpgradePolicy
Add a simple pool with resourceTags
Add a VirtualMachineConfiguration pool
Add a VirtualMachineConfiguration pool with containers
Add a VirtualMachineConfiguration pool with extensions
Add a VirtualMachineConfiguration pool with OS disk
Add a VirtualMachineConfiguration pool with ServiceArtifactReference

Add a pool with accelerated networking

Exempelbegäran

POST account.region.batch.azure.com/pools?api-version=2024-07-01.20.0



{
  "id": "mypool01",
  "vmSize": "Standard_D1_v2",
  "virtualMachineConfiguration": {
    "imageReference": {
      "publisher": "MicrosoftWindowsServer",
      "offer": "WindowsServer",
      "sku": "2016-datacenter-smalldisk",
      "version": "latest"
    },
    "nodeAgentSKUId": "batch.node.windows amd64"
  },
  "targetDedicatedNodes": 2,
  "networkConfiguration": {
    "enableAcceleratedNetworking": true
  }
}

Exempelsvar

Add a pool with mount drive specified

Exempelbegäran

POST account.region.batch.azure.com/pools?api-version=2024-07-01.20.0


{
  "id": "pool2",
  "vmSize": "standard_a1",
  "virtualMachineConfiguration": {
    "imageReference": {
      "publisher": "Canonical",
      "offer": "UbuntuServer",
      "sku": "20_04-lts"
    },
    "nodeAgentSKUId": "batch.node.ubuntu 20.04"
  },
  "mountConfiguration": [
    {
      "azureBlobFileSystemConfiguration": {
        "accountName": "accountName",
        "containerName": "blobContainerName",
        "accountKey": "accountKey",
        "relativeMountPath": "bfusepath"
      }
    },
    {
      "azureFileShareConfiguration": {
        "accountName": "accountName",
        "azureFileUrl": "https://myaccount.file.core.windows.net/fileshare",
        "accountKey": "accountKey",
        "relativeMountPath": "filesharepath",
        "mountOptions": "mount options ver=1.0"
      }
    },
    {
      "nfsMountConfiguration": {
        "source": "somesource nfs url",
        "relativeMountPath": "mountpath",
        "mountOptions": "mount options ver=1.0"
      }
    },
    {
      "cifsMountConfiguration": {
        "username": "accountName",
        "password": "password",
        "source": "//myaccount.file.core.windows.net/file",
        "relativeMountPath": "mountpath",
        "mountOptions": "mount options ver=1.0"
      }
    }
  ],
  "resizeTimeout": "PT15M",
  "targetDedicatedNodes": 5,
  "targetLowPriorityNodes": 0,
  "taskSlotsPerNode": 3,
  "taskSchedulingPolicy": {
    "nodeFillType": "spread"
  },
  "enableAutoScale": false
}

Exempelsvar

Add a pool with SecurityProfile

Exempelbegäran

POST account.region.batch.azure.com/pools?api-version=2024-07-01.20.0



{
  "id": "mypool001",
  "vmSize": "STANDARD_DC2s_V2",
  "virtualMachineConfiguration": {
    "imageReference": {
      "publisher": "Canonical",
      "offer": "UbuntuServer",
      "sku": "18_04-lts-gen2",
      "version": "latest"
    },
    "nodeAgentSKUId": "batch.node.ubuntu 18.04",
    "securityProfile": {
      "securityType": "trustedLaunch",
      "encryptionAtHost": true,
      "uefiSettings": {
        "secureBootEnabled": false,
        "vTpmEnabled": null
      }
    }
  },
  "targetDedicatedNodes": 1
}

Exempelsvar

Add a pool with UpgradePolicy

Exempelbegäran

POST account.region.batch.azure.com/pools?api-version=2024-07-01.20.0



{
  "id": "mypool001",
  "vmSize": "Standard_A1_v2",
  "virtualMachineConfiguration": {
    "imageReference": {
      "publisher": "MicrosoftWindowsServer",
      "offer": "WindowsServer",
      "sku": "2016-datacenter-smalldisk",
      "version": "latest"
    },
    "windowsConfiguration": {
      "enableAutomaticUpdates": false
    },
    "nodePlacementConfiguration": {
      "policy": "zonal"
    },
    "nodeAgentSKUId": "batch.node.windows amd64"
  },
  "targetDedicatedNodes": 2,
  "upgradePolicy": {
    "mode": "automatic",
    "automaticOSUpgradePolicy": {
      "disableAutomaticRollback": true,
      "enableAutomaticOSUpgrade": true,
      "useRollingUpgradePolicy": true,
      "osRollingUpgradeDeferral": true
    },
    "rollingUpgradePolicy": {
      "enableCrossZoneUpgrade": true,
      "maxBatchInstancePercent": 20,
      "maxUnhealthyInstancePercent": 20,
      "maxUnhealthyUpgradedInstancePercent": 20,
      "pauseTimeBetweenBatches": "PT0S",
      "prioritizeUnhealthyInstances": false,
      "rollbackFailedInstancesOnPolicyBreach": false
    }
  }
}

Exempelsvar

Add a simple pool with resourceTags

Exempelbegäran

POST account.region.batch.azure.com/pools?api-version=2024-07-01.20.0



{
  "id": "mypool001",
  "vmSize": "STANDARD_DC2s_V2",
  "virtualMachineConfiguration": {
    "imageReference": {
      "publisher": "Canonical",
      "offer": "UbuntuServer",
      "sku": "18_04-lts-gen2",
      "version": "latest"
    },
    "nodeAgentSKUId": "batch.node.ubuntu 18.04"
  },
  "targetDedicatedNodes": 1,
  "resourceTags": {
    "TagName1": "TagValue1",
    "TagName2": "TagValue2"
  }
}

Exempelsvar

Add a VirtualMachineConfiguration pool

Exempelbegäran

POST account.region.batch.azure.com/pools?api-version=2024-07-01.20.0



{
  "id": "pool2",
  "vmSize": "standard_a1",
  "virtualMachineConfiguration": {
    "imageReference": {
      "publisher": "Canonical",
      "offer": "0001-com-ubuntu-server-focal",
      "sku": "20_04-lts"
    },
    "nodeAgentSKUId": "batch.node.ubuntu 20.04"
  },
  "resizeTimeout": "PT15M",
  "targetDedicatedNodes": 5,
  "targetLowPriorityNodes": 0,
  "taskSlotsPerNode": 3,
  "taskSchedulingPolicy": {
    "nodeFillType": "spread"
  },
  "enableAutoScale": false,
  "enableInterNodeCommunication": true,
  "metadata": [
    {
      "name": "myproperty",
      "value": "myvalue"
    }
  ]
}

Exempelsvar

Add a VirtualMachineConfiguration pool with containers

Exempelbegäran

POST account.region.batch.azure.com/pools?api-version=2024-07-01.20.0



{
  "id": "pool2",
  "vmSize": "standard_a1",
  "virtualMachineConfiguration": {
    "imageReference": {
      "publisher": "Canonical",
      "offer": "0001-com-ubuntu-server-focal",
      "sku": "120_04-lts"
    },
    "nodeAgentSKUId": "batch.node.ubuntu 20.04",
    "containerConfiguration": {
      "type": "dockerCompatible",
      "containerImageNames": [
        "busybox"
      ]
    }
  },
  "resizeTimeout": "PT15M",
  "targetDedicatedNodes": 5,
  "targetLowPriorityNodes": 0,
  "taskSlotsPerNode": 3,
  "taskSchedulingPolicy": {
    "nodeFillType": "spread"
  },
  "enableAutoScale": false
}

Exempelsvar

Add a VirtualMachineConfiguration pool with extensions

Exempelbegäran

POST account.region.batch.azure.com/pools?api-version=2024-07-01.20.0



{
  "id": "pool2",
  "vmSize": "standard_a1",
  "virtualMachineConfiguration": {
    "imageReference": {
      "publisher": "Canonical",
      "offer": "0001-com-ubuntu-server-focal",
      "sku": "20_04-lts"
    },
    "nodeAgentSKUId": "batch.node.ubuntu 20.04",
    "extensions": [
      {
        "name": "batchextension1",
        "type": "KeyVaultForLinux",
        "publisher": "Microsoft.Azure.KeyVault",
        "typeHandlerVersion": "2.0",
        "autoUpgradeMinorVersion": true,
        "enableAutomaticUpgrade": true,
        "settings": "{\"secretsManagementSettingsKey\":\"secretsManagementSettingsValue\",\"authenticationSettingsKey\":\"authenticationSettingsValue\"}"
      }
    ]
  },
  "resizeTimeout": "PT15M",
  "targetDedicatedNodes": 5,
  "targetLowPriorityNodes": 0,
  "taskSlotsPerNode": 3,
  "taskSchedulingPolicy": {
    "nodeFillType": "spread"
  },
  "enableAutoScale": false,
  "enableInterNodeCommunication": true,
  "metadata": [
    {
      "name": "myproperty",
      "value": "myvalue"
    }
  ],
  "targetNodeCommunicationMode": "simplified"
}

Exempelsvar

Add a VirtualMachineConfiguration pool with OS disk

Exempelbegäran

POST account.region.batch.azure.com/pools?api-version=2024-07-01.20.0



{
  "id": "mypool001",
  "vmSize": "standard_d2s_v3",
  "virtualMachineConfiguration": {
    "imageReference": {
      "publisher": "Canonical",
      "offer": "0001-com-ubuntu-server-focal",
      "sku": "20_04-lts"
    },
    "osDisk": {
      "diskSizeGB": 100,
      "managedDisk": {
        "storageAccountType": "standardssd_lrs"
      },
      "caching": "readwrite",
      "ephemeralOSDiskSettings": {
        "placement": "CacheDisk"
      }
    },
    "nodeAgentSKUId": "batch.node.ubuntu 20.04"
  },
  "resizeTimeout": "PT15M",
  "targetDedicatedNodes": 1,
  "targetLowPriorityNodes": 0,
  "taskSlotsPerNode": 1,
  "enableAutoScale": false
}

Exempelsvar

Add a VirtualMachineConfiguration pool with ServiceArtifactReference

Exempelbegäran

POST account.region.batch.azure.com/pools?api-version=2024-07-01.20.0



{
  "id": "mypool002",
  "vmSize": "Standard_A1_v2",
  "virtualMachineConfiguration": {
    "imageReference": {
      "publisher": "MicrosoftWindowsServer",
      "offer": "WindowsServer",
      "sku": "2016-datacenter-smalldisk",
      "version": "latest"
    },
    "windowsConfiguration": {
      "enableAutomaticUpdates": false
    },
    "serviceArtifactReference": {
      "id": "/subscriptions/subid/resourceGroups/default-azurebatch-japaneast/providers/Microsoft.Compute/galleries/myGallery/serviceArtifacts/myServiceArtifact/vmArtifactsProfiles/vmArtifactsProfile"
    },
    "nodeAgentSKUId": "batch.node.windows amd64"
  },
  "targetDedicatedNodes": 2,
  "upgradePolicy": {
    "mode": "automatic",
    "automaticOSUpgradePolicy": {
      "enableAutomaticOSUpgrade": true
    }
  }
}

Exempelsvar

Definitioner

Name Description
ApplicationPackageReference

En referens till ett paket som ska distribueras till beräkningsnoder.

AutomaticOSUpgradePolicy

De konfigurationsparametrar som används för att utföra automatisk operativsystemuppgradering.

AutoUserScope

Omfånget för den automatiska användaren

AutoUserSpecification

Anger parametrarna för den automatiska användare som kör en uppgift i Batch-tjänsten.

AzureBlobFileSystemConfiguration

Information som används för att ansluta till en Azure Storage-container med blobfuse.

AzureFileShareConfiguration

Information som används för att ansluta till en Azure Fileshare.

BatchError

Ett felsvar som tagits emot från Azure Batch-tjänsten.

BatchErrorDetail

Ett objekt med ytterligare information som ingår i ett Azure Batch-felsvar.

CachingType

Typ av cachelagring som ska aktiveras för disken.

CertificateReference

En referens till ett certifikat som ska installeras på beräkningsnoder i en pool.

CertificateStoreLocation

Platsen för certifikatarkivet på beräkningsnoden där certifikatet ska installeras.

CertificateVisibility

Vilka användarkonton på beräkningsnoden ska ha åtkomst till certifikatets privata data.

CIFSMountConfiguration

Information som används för att ansluta till ett CIFS-filsystem.

ComputeNodeFillType

Så här distribueras uppgifter mellan beräkningsnoder i en pool.

ComputeNodeIdentityReference

Referensen till en användartilldelad identitet som är associerad med Batch-poolen som en beräkningsnod ska använda.

ContainerConfiguration

Konfigurationen för containeraktiverade pooler.

ContainerHostBatchBindMountEntry

Posten för sökvägen och monteringsläget som du vill montera i aktivitetscontainern.

ContainerHostDataPath

Sökvägarna som ska monteras på containeraktivitetens container.

ContainerRegistry

Ett privat containerregister.

ContainerType

Den containerteknik som ska användas.

ContainerWorkingDirectory

Platsen för containerns arbetskatalog för uppgift.

DataDisk

Inställningar som ska användas av de datadiskar som är associerade med beräkningsnoder i poolen. När du använder anslutna datadiskar måste du montera och formatera diskarna från en virtuell dator för att kunna använda dem.

DiffDiskPlacement

Anger den tillfälliga diskplaceringen för operativsystemdisken för alla beräkningsnoder (VM) i poolen.

DiffDiskSettings

Anger tillfälliga diskinställningar för operativsystemdisken som används av beräkningsnoden (VM).

DiskEncryptionConfiguration

Diskkrypteringskonfigurationen som tillämpas på beräkningsnoder i poolen. Diskkrypteringskonfiguration stöds inte i Linux-pool som skapats med Azure Compute Gallery Image.

DiskEncryptionTarget

Listan över diskmål Batch Service krypterar på beräkningsnoden.

DynamicVNetAssignmentScope

Omfånget för dynamisk vnet-tilldelning.

ElevationLevel

Användarens höjdnivå.

EnvironmentSetting

En miljövariabel som ska anges för en aktivitetsprocess.

ErrorMessage

Ett felmeddelande som togs emot i ett Azure Batch-felsvar.

ImageReference

En referens till en Azure Virtual Machines Marketplace-avbildning eller en Azure Compute Gallery-avbildning. Om du vill hämta listan över alla Azure Marketplace-avbildningsreferenser som verifierats av Azure Batch läser du åtgärden "Lista avbildningar som stöds".

InboundEndpointProtocol

Slutpunktens protokoll.

InboundNATPool

En inkommande NAT-pool som kan användas för att hantera specifika portar på beräkningsnoder i en Batch-pool externt.

IPAddressProvisioningType

Etableringstypen för offentliga IP-adresser för poolen.

LinuxUserConfiguration

Egenskaper som används för att skapa ett användarkonto på en Linux-beräkningsnod.

LoginMode

Inloggningsläget för användaren

ManagedDisk
MetadataItem

Ett namn/värde-par som är associerat med en Batch-tjänstresurs.

MountConfiguration

Filsystemet som ska monteras på varje nod.

NetworkConfiguration

Nätverkskonfigurationen för en pool.

NetworkSecurityGroupRule

En regel för nätverkssäkerhetsgrupp som ska tillämpas på en inkommande slutpunkt.

NetworkSecurityGroupRuleAccess

Den åtgärd som ska vidtas för en angiven IP-adress, undernätsintervall eller tagg.

NFSMountConfiguration

Information som används för att ansluta till ett NFS-filsystem.

NodeCommunicationMode

Avgör hur en pool kommunicerar med Batch-tjänsten.

NodePlacementConfiguration

Konfiguration av nodplacering för en pool.

NodePlacementPolicyType

Placeringsprincipen för allokering av noder i poolen.

OSDisk

Inställningar för operativsystemets disk för beräkningsnoden (VM).

PoolAddParameter

En pool i Azure Batch-tjänsten att lägga till.

PoolEndpointConfiguration

Slutpunktskonfigurationen för en pool.

PublicIPAddressConfiguration

Den offentliga IP-adresskonfigurationen för nätverkskonfigurationen för en pool.

ResourceFile

En enda fil eller flera filer som ska laddas ned till en beräkningsnod.

RollingUpgradePolicy

De konfigurationsparametrar som används vid löpande uppgradering.

SecurityEncryptionTypes

Anger EncryptionType för den hanterade disken. Den är inställd på VMGuestStateOnly för kryptering av bara VMGuestState-bloben och NonPersistedTPM för att inte bevara tillståndet för inbyggd programvara i VMGuestState-bloben. Obs: Det kan endast anges för konfidentiella virtuella datorer och krävs när du använder konfidentiella virtuella datorer.

SecurityProfile

Anger säkerhetsprofilinställningarna för den virtuella datorn eller vm-skalningsuppsättningen.

SecurityTypes

Anger SecurityType för den virtuella datorn. Det måste anges till ett angivet värde för att aktivera UefiSettings.

ServiceArtifactReference

Anger tjänstartefaktreferens-ID:t som används för att ange samma avbildningsversion för alla virtuella datorer i skalningsuppsättningen när du använder den senaste avbildningsversionen.

StartTask

En uppgift som körs när en nod ansluter till en pool i Azure Batch-tjänsten, eller när beräkningsnoden startas om eller omskapas.

StorageAccountType

Lagringskontotypen som ska användas för att skapa datadiskar eller OS-diskar.

TaskContainerSettings

Containerinställningarna för en aktivitet.

TaskSchedulingPolicy

Anger hur Aktiviteter ska distribueras mellan beräkningsnoder.

UefiSettings

Anger de säkerhetsinställningar som säker start och vTPM som används när den virtuella datorn skapas.

UpgradeMode

Anger läget för en uppgradering till virtuella datorer i skalningsuppsättningen.

Möjliga värden är:

Manuell – Du styr programmet för uppdateringar av virtuella datorer i skalningsuppsättningen. Du gör detta med hjälp av åtgärden manualUpgrade.

Automatisk – Alla virtuella datorer i skalningsuppsättningen uppdateras automatiskt samtidigt.

Rullande – Skalningsuppsättningen utför uppdateringar i batchar med en valfri paustid däremellan.

UpgradePolicy

Beskriver en uppgraderingsprincip – automatisk, manuell eller rullande.

UserAccount

Egenskaper som används för att skapa en användare som används för att köra uppgifter på en Azure Batch Compute-nod.

UserIdentity

Definitionen av användaridentiteten som aktiviteten körs under.

VirtualMachineConfiguration

Konfigurationen för beräkningsnoder i en pool baserat på Azure Virtual Machines-infrastrukturen.

VMDiskSecurityProfile

Anger säkerhetsprofilinställningarna för den hanterade disken. Obs: Det kan bara anges för konfidentiella virtuella datorer och krävs när du använder konfidentiella virtuella datorer.

VMExtension

Konfigurationen för tillägg för virtuella datorer.

WindowsConfiguration

Inställningar för Windows-operativsystem som ska tillämpas på den virtuella datorn.

WindowsUserConfiguration

Egenskaper som används för att skapa ett användarkonto på en Windows-beräkningsnod.

ApplicationPackageReference

En referens till ett paket som ska distribueras till beräkningsnoder.

Name Typ Description
applicationId

string

ID:t för programmet som ska distribueras.
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}).

version

string

Den version av programmet som ska distribueras. Om den utelämnas distribueras standardversionen.
Om detta utelämnas i en pool och ingen standardversion har angetts för det här programmet misslyckas begäran med felkoden InvalidApplicationPackageReferences och HTTP-statuskod 409. Om detta utelämnas för en aktivitet och ingen standardversion har angetts för det här programmet misslyckas uppgiften med ett förbearbetningsfel.

AutomaticOSUpgradePolicy

De konfigurationsparametrar som används för att utföra automatisk operativsystemuppgradering.

Name Typ Description
disableAutomaticRollback

boolean

Om funktionen för återställning av os-avbildning ska inaktiveras.

enableAutomaticOSUpgrade

boolean

Anger om OS-uppgraderingar automatiskt ska tillämpas på skalningsuppsättningsinstanser på ett löpande sätt när en nyare version av OS-avbildningen blir tillgänglig.

Om detta är inställt på sant för Windows-baserade pooler kan WindowsConfiguration.enableAutomaticUpdates inte anges till true.

osRollingUpgradeDeferral

boolean

Skjut upp OS-uppgraderingar på TV-datorerna om de kör uppgifter.

useRollingUpgradePolicy

boolean

Anger om principen för löpande uppgradering ska användas under automatisk operativsystemuppgradering. Automatisk os-uppgradering återgår till standardprincipen om ingen princip har definierats på VMSS.

AutoUserScope

Omfånget för den automatiska användaren

Name Typ Description
pool

string

Anger att aktiviteten körs som det vanliga automatiska användarkontot som skapas på varje beräkningsnod i en pool.

task

string

Anger att tjänsten ska skapa en ny användare för uppgiften.

AutoUserSpecification

Anger parametrarna för den automatiska användare som kör en uppgift i Batch-tjänsten.

Name Typ Description
elevationLevel

ElevationLevel

Den automatiska användarens höjdnivå.
Standardvärdet är nonAdmin.

scope

AutoUserScope

Omfånget för den automatiska användaren
Standardvärdet är pool. Om poolen kör Windows ska värdet Aktivitet anges om striktare isolering mellan aktiviteter krävs. Om uppgiften till exempel muterar registret på ett sätt som kan påverka andra uppgifter, eller om certifikat har angetts i poolen som inte ska vara tillgängliga för normala uppgifter men bör vara tillgängliga av StartTasks.

AzureBlobFileSystemConfiguration

Information som används för att ansluta till en Azure Storage-container med blobfuse.

Name Typ Description
accountKey

string

Azure Storage-kontonyckeln.
Den här egenskapen är ömsesidigt uteslutande med både sasKey och identitet; exakt ett måste anges.

accountName

string

Namnet på Azure Storage-kontot.

blobfuseOptions

string

Ytterligare kommandoradsalternativ för att skicka till monteringskommandot.
Det här är alternativ för "net use" i Windows och "monteringsalternativ" i Linux.

containerName

string

Namnet på Azure Blob Storage-containern.

identityReference

ComputeNodeIdentityReference

Referensen till den användartilldelade identitet som ska användas för att komma åt containerName
Den här egenskapen är ömsesidigt uteslutande med både accountKey och sasKey; exakt ett måste anges.

relativeMountPath

string

Den relativa sökvägen på beräkningsnoden där filsystemet ska monteras
Alla filsystem monteras i förhållande till katalogen Batch-monteringar, som är tillgängliga via AZ_BATCH_NODE_MOUNTS_DIR miljövariabeln.

sasKey

string

Sas-token för Azure Storage.
Den här egenskapen är ömsesidigt uteslutande med både accountKey och identitet; exakt ett måste anges.

AzureFileShareConfiguration

Information som används för att ansluta till en Azure Fileshare.

Name Typ Description
accountKey

string

Azure Storage-kontonyckeln.

accountName

string

Namnet på Azure Storage-kontot.

azureFileUrl

string

Url:en för Azure Files.
Det här är formuläret "https://{account}.file.core.windows.net/".

mountOptions

string

Ytterligare kommandoradsalternativ för att skicka till monteringskommandot.
Det här är alternativ för "net use" i Windows och "monteringsalternativ" i Linux.

relativeMountPath

string

Den relativa sökvägen på beräkningsnoden där filsystemet ska monteras
Alla filsystem monteras i förhållande till katalogen Batch-monteringar, som är tillgängliga via AZ_BATCH_NODE_MOUNTS_DIR miljövariabeln.

BatchError

Ett felsvar som tagits emot från Azure Batch-tjänsten.

Name Typ Description
code

string

En identifierare för felet. Koder är invarianta och är avsedda att användas programmatiskt.

message

ErrorMessage

Ett meddelande som beskriver felet, avsett att vara lämpligt för visning i ett användargränssnitt.

values

BatchErrorDetail[]

En samling nyckel/värde-par som innehåller ytterligare information om felet.

BatchErrorDetail

Ett objekt med ytterligare information som ingår i ett Azure Batch-felsvar.

Name Typ Description
key

string

En identifierare som anger innebörden av egenskapen Value.

value

string

Den ytterligare information som ingår i felsvaret.

CachingType

Typ av cachelagring som ska aktiveras för disken.

Name Typ Description
none

string

Cachelagringsläget för disken är inte aktiverat.

readonly

string

Cachelagringsläget för disken är skrivskyddat.

readwrite

string

Cachelagringsläget för disken är läs- och skrivläge.

CertificateReference

En referens till ett certifikat som ska installeras på beräkningsnoder i en pool.

Name Typ Description
storeLocation

CertificateStoreLocation

Platsen för certifikatarkivet på beräkningsnoden där certifikatet ska installeras.
Standardvärdet är currentuser. Den här egenskapen gäller endast för pooler som konfigurerats med Windows-beräkningsnoder. För Linux-beräkningsnoder lagras certifikaten i en katalog i arbetskatalogen Aktivitet och en miljövariabel AZ_BATCH_CERTIFICATES_DIR skickas till uppgiften för att fråga efter den här platsen. För certifikat med synlighet för "remoteUser" skapas en "certifikatkatalog" i användarens hemkatalog (t.ex. /home/{user-name}/certs) och Certifikat placeras i den katalogen.

storeName

string

Namnet på certifikatarkivet på beräkningsnoden som certifikatet ska installeras i.
Den här egenskapen gäller endast för pooler som konfigurerats med Windows-beräkningsnoder. Vanliga butiksnamn är: My, Root, CA, Trust, Disallowed, TrustedPeople, TrustedPublisher, AuthRoot, AddressBook, men alla anpassade butiksnamn kan också användas. Standardvärdet är Min.

thumbprint

string

Certifikatets tumavtryck.

thumbprintAlgorithm

string

Algoritmen som tumavtrycket är associerat med. Det här måste vara sha1.

visibility

CertificateVisibility[]

Vilka användarkonton på beräkningsnoden ska ha åtkomst till certifikatets privata data.
Du kan ange mer än en synlighet i den här samlingen. Standardvärdet är alla konton.

CertificateStoreLocation

Platsen för certifikatarkivet på beräkningsnoden där certifikatet ska installeras.

Name Typ Description
currentuser

string

Certifikat ska installeras i CurrentUser-certifikatarkivet.

localmachine

string

Certifikat ska installeras i LocalMachine-certifikatarkivet.

CertificateVisibility

Vilka användarkonton på beräkningsnoden ska ha åtkomst till certifikatets privata data.

Name Typ Description
remoteuser

string

Certifikatet ska vara synligt för användarkontona under vilka användare fjärransluter till beräkningsnoden.

starttask

string

Certifikatet ska vara synligt för användarkontot där StartTask körs. Observera att om AutoUser-omfånget är Pool för både StartTask och en aktivitet visas även det här certifikatet för aktiviteten.

task

string

Certifikatet ska vara synligt för användarkontona under vilka Jobbaktiviteter körs.

CIFSMountConfiguration

Information som används för att ansluta till ett CIFS-filsystem.

Name Typ Description
mountOptions

string

Ytterligare kommandoradsalternativ för att skicka till monteringskommandot.
Det här är alternativ för "net use" i Windows och "monteringsalternativ" i Linux.

password

string

Lösenordet som ska användas för autentisering mot CIFS-filsystemet.

relativeMountPath

string

Den relativa sökvägen på beräkningsnoden där filsystemet ska monteras
Alla filsystem monteras i förhållande till katalogen Batch-monteringar, som är tillgängliga via AZ_BATCH_NODE_MOUNTS_DIR miljövariabeln.

source

string

URI:n för filsystemet som ska monteras.

username

string

Användaren som ska användas för autentisering mot CIFS-filsystemet.

ComputeNodeFillType

Så här distribueras uppgifter mellan beräkningsnoder i en pool.

Name Typ Description
pack

string

Så många aktiviteter som möjligt (taskSlotsPerNode) ska tilldelas till varje beräkningsnod i poolen innan aktiviteter tilldelas till nästa beräkningsnod i poolen.

spread

string

Aktiviteter bör tilldelas jämnt över alla beräkningsnoder i poolen.

ComputeNodeIdentityReference

Referensen till en användartilldelad identitet som är associerad med Batch-poolen som en beräkningsnod ska använda.

Name Typ Description
resourceId

string

ARM-resurs-ID för den användartilldelade identiteten.

ContainerConfiguration

Konfigurationen för containeraktiverade pooler.

Name Typ Description
containerImageNames

string[]

Samlingen med containeravbildningsnamn.
Det här är den fullständiga avbildningsreferensen, som skulle anges till "docker pull". En avbildning kommer att hämtas från docker-standardregistret såvida inte avbildningen är fullständigt kvalificerad med ett alternativt register.

containerRegistries

ContainerRegistry[]

Ytterligare privata register från vilka containrar kan hämtas.
Om några avbildningar måste laddas ned från ett privat register som kräver autentiseringsuppgifter måste dessa autentiseringsuppgifter anges här.

type

ContainerType

Den containerteknik som ska användas.

ContainerHostBatchBindMountEntry

Posten för sökvägen och monteringsläget som du vill montera i aktivitetscontainern.

Name Typ Description
isReadOnly

boolean

Montera den här källsökvägen som skrivskyddat läge eller inte. Standardvärdet är falskt (läs-/skrivläge).
För Linux, om du monterar den här sökvägen som ett läs-/skrivläge betyder det inte att alla användare i containern har läs-/skrivåtkomst för sökvägen, det beror på åtkomsten i den virtuella värddatorn. Om den här sökvägen är skrivskyddad kan inte alla användare i containern ändra sökvägen.

source

ContainerHostDataPath

Sökvägen som monteras på containerkund kan välja.

ContainerHostDataPath

Sökvägarna som ska monteras på containeraktivitetens container.

Name Typ Description
Applications

string

Programsökvägen.

JobPrep

string

Jobbförberedelseaktivitetssökvägen.

Shared

string

Sökvägen för uppgift för flera instanser att dela sina filer.

Startup

string

Sökvägen för startaktiviteten.

Task

string

Aktivitetssökvägen.

VfsMounts

string

Sökvägen innehåller alla virtuella filsystem som är monterade på den här noden.

ContainerRegistry

Ett privat containerregister.

Name Typ Description
identityReference

ComputeNodeIdentityReference

Referensen till den användartilldelade identitet som ska användas för att komma åt ett Azure Container Registry i stället för användarnamn och lösenord.
Referensen till en användartilldelad identitet som är associerad med Batch-poolen som en beräkningsnod ska använda.

password

string

Lösenordet för att logga in på registerservern.

registryServer

string

Registrets URL.
Om det utelämnas är standardvärdet "docker.io".

username

string

Användarnamnet för att logga in på registerservern.

ContainerType

Den containerteknik som ska användas.

Name Typ Description
criCompatible

string

En CRI-baserad teknik kommer att användas för att starta containrarna.

dockerCompatible

string

En Docker-kompatibel containerteknik används för att starta containrarna.

ContainerWorkingDirectory

Platsen för containerns arbetskatalog för uppgift.

Name Typ Description
containerImageDefault

string

Använd arbetskatalogen som definierats i containern Image. Se upp för att den här katalogen inte innehåller de resursfiler som laddats ned av Batch.

taskWorkingDirectory

string

Använd standardarbetskatalogen för Batch-tjänsten, som innehåller aktivitetsresursfilerna som fylls i av Batch.

DataDisk

Inställningar som ska användas av de datadiskar som är associerade med beräkningsnoder i poolen. När du använder anslutna datadiskar måste du montera och formatera diskarna från en virtuell dator för att kunna använda dem.

Name Typ Description
caching

CachingType

Den typ av cachelagring som ska aktiveras för datadiskarna.
Standardvärdet för cachelagring är skrivskyddat. Information om cachelagringsalternativen finns i: https://blogs.msdn.microsoft.com/windowsazurestorage/2012/06/27/exploring-windows-azure-drives-disks-and-images/.

diskSizeGB

integer

Den ursprungliga diskstorleken i gigabyte.

lun

integer

Det logiska enhetsnumret.
Lun används för att unikt identifiera varje datadisk. Om du ansluter flera diskar bör var och en ha ett distinkt lun. Värdet måste vara mellan 0 och 63, inklusive.

storageAccountType

StorageAccountType

Den lagringskontotyp som ska användas för datadisken.
Om det utelämnas är standardvärdet "standard_lrs".

DiffDiskPlacement

Anger den tillfälliga diskplaceringen för operativsystemdisken för alla beräkningsnoder (VM) i poolen.

Name Typ Description
CacheDisk

string

Den tillfälliga OS-disken lagras i den virtuella datorns cacheminne.

DiffDiskSettings

Anger tillfälliga diskinställningar för operativsystemdisken som används av beräkningsnoden (VM).

Name Typ Description
placement

DiffDiskPlacement

Anger den tillfälliga diskplaceringen för operativsystemdisken för alla virtuella datorer i poolen.
Den här egenskapen kan användas av användaren i begäran om att välja plats, t.ex. cachelagring av diskutrymme för tillfällig OS-disketablering. Mer information om krav för tillfällig os-diskstorlek finns i Krav på tillfällig os-diskstorlek för virtuella Windows-datorer på https://docs.microsoft.com/azure/virtual-machines/windows/ephemeral-os-disks#size-requirements och virtuella Linux-datorer på https://docs.microsoft.com/azure/virtual-machines/linux/ephemeral-os-disks#size-requirements.

DiskEncryptionConfiguration

Diskkrypteringskonfigurationen som tillämpas på beräkningsnoder i poolen. Diskkrypteringskonfiguration stöds inte i Linux-pool som skapats med Azure Compute Gallery Image.

Name Typ Description
targets

DiskEncryptionTarget[]

Listan över diskmål Batch Service krypterar på beräkningsnoden.
Listan över diskmål Batch Service krypterar på beräkningsnoden.

DiskEncryptionTarget

Listan över diskmål Batch Service krypterar på beräkningsnoden.

Name Typ Description
osdisk

string

OS-disken på beräkningsnoden är krypterad.

temporarydisk

string

Den tillfälliga disken på beräkningsnoden krypteras. I Linux gäller den här krypteringen för andra partitioner (till exempel de på monterade datadiskar) när kryptering sker vid start.

DynamicVNetAssignmentScope

Omfånget för dynamisk vnet-tilldelning.

Name Typ Description
job

string

Dynamisk VNet-tilldelning görs per jobb.

none

string

Ingen dynamisk VNet-tilldelning är aktiverad.

ElevationLevel

Användarens höjdnivå.

Name Typ Description
admin

string

Användaren är en användare med förhöjd åtkomst och fungerar med fullständig administratörsbehörighet.

nonadmin

string

Användaren är en standardanvändare utan förhöjd åtkomst.

EnvironmentSetting

En miljövariabel som ska anges för en aktivitetsprocess.

Name Typ Description
name

string

Namnet på miljövariabeln.

value

string

Värdet för miljövariabeln.

ErrorMessage

Ett felmeddelande som togs emot i ett Azure Batch-felsvar.

Name Typ Description
lang

string

Språkkoden för felmeddelandet

value

string

Texten i meddelandet.

ImageReference

En referens till en Azure Virtual Machines Marketplace-avbildning eller en Azure Compute Gallery-avbildning. Om du vill hämta listan över alla Azure Marketplace-avbildningsreferenser som verifierats av Azure Batch läser du åtgärden "Lista avbildningar som stöds".

Name Typ Description
communityGalleryImageId

string

Unik identifierare för communitygalleribilden
Den här egenskapen är ömsesidigt uteslutande med andra egenskaper och kan hämtas från community gallery image GET-anrop.

exactVersion

string

Den specifika versionen av plattformsbilden eller marketplace-avbildningen som används för att skapa noden. Det här skrivskyddade fältet skiljer sig endast från "version" om värdet som angavs för "version" när poolen skapades var "senaste".

offer

string

Erbjudandetypen för Azure Virtual Machines Marketplace Image.
Till exempel UbuntuServer eller WindowsServer.

publisher

string

Utgivaren av Azure Virtual Machines Marketplace Image.
Till exempel Canonical eller MicrosoftWindowsServer.

sharedGalleryImageId

string

Unik identifierare för den delade galleribilden
Den här egenskapen är ömsesidigt uteslutande med andra egenskaper och kan hämtas från get-anropet för den delade galleribilden.

sku

string

SKU:n för Azure Virtual Machines Marketplace-avbildningen.
Till exempel 18.04-LTS eller 2019-Datacenter.

version

string

Versionen av Azure Virtual Machines Marketplace-avbildningen.
Du kan ange värdet "senaste" för att välja den senaste versionen av en bild. Om det utelämnas är standardvärdet "senaste".

virtualMachineImageId

string

ARM-resursidentifieraren för Azure Compute Gallery Image. Beräkningsnoder i poolen skapas med det här avbildnings-ID:t. Det här är formuläret /subscriptions/{subscriptionId}/resourceGroups/{resourceGroup}/providers/Microsoft.Compute/galleries/{galleryName}/images/{imageDefinitionName}/versions/{VersionId} eller /subscriptions/{subscriptionId}/resourceGroups/{resourceGroup}/providers/Microsoft.Compute/galleries/{galleryName}/images/{imageDefinitionName} för att alltid vara standard för den senaste avbildningsversionen.
Den här egenskapen är ömsesidigt uteslutande med andra ImageReference-egenskaper. Azure Compute Gallery Image måste ha repliker i samma region och måste finnas i samma prenumeration som Azure Batch-kontot. Om avbildningsversionen inte anges i imageId används den senaste versionen. Information om brandväggsinställningarna för Batch Compute Node-agenten för kommunikation med Batch-tjänsten finns i https://docs.microsoft.com/azure/batch/batch-api-basics#virtual-network-vnet-and-firewall-configuration.

InboundEndpointProtocol

Slutpunktens protokoll.

Name Typ Description
tcp

string

Använd TCP för slutpunkten.

udp

string

Använd UDP för slutpunkten.

InboundNATPool

En inkommande NAT-pool som kan användas för att hantera specifika portar på beräkningsnoder i en Batch-pool externt.

Name Typ Description
backendPort

integer

Portnumret på beräkningsnoden.
Detta måste vara unikt i en Batch-pool. Godtagbara värden är mellan 1 och 65535 förutom för 22, 3389, 29876 och 29877 eftersom dessa är reserverade. Om några reserverade värden anges misslyckas begäran med HTTP-statuskod 400.

frontendPortRangeEnd

integer

Det sista portnumret i intervallet för externa portar som ska användas för att ge inkommande åtkomst till backendPort på enskilda beräkningsnoder.
Acceptabla värden varierar mellan 1 och 65534 förutom portar från 50000 till 55000 som reserveras av Batch-tjänsten. Alla intervall i en pool måste vara distinkta och får inte överlappa varandra. Varje intervall måste innehålla minst 40 portar. Om några reserverade eller överlappande värden anges misslyckas begäran med HTTP-statuskod 400.

frontendPortRangeStart

integer

Det första portnumret i intervallet för externa portar som ska användas för att ge inkommande åtkomst till backendPort på enskilda beräkningsnoder.
Godtagbara värden varierar mellan 1 och 65534 förutom portar från 50000 till 55000 som är reserverade. Alla intervall i en pool måste vara distinkta och får inte överlappa varandra. Varje intervall måste innehålla minst 40 portar. Om några reserverade eller överlappande värden anges misslyckas begäran med HTTP-statuskod 400.

name

string

Namnet på slutpunkten.
Namnet måste vara unikt i en Batch-pool, kan innehålla bokstäver, siffror, understreck, punkter och bindestreck. Namn måste börja med en bokstav eller siffra, måste sluta med en bokstav, ett tal eller understreck och får inte överstiga 77 tecken. Om ogiltiga värden anges misslyckas begäran med HTTP-statuskod 400.

networkSecurityGroupRules

NetworkSecurityGroupRule[]

En lista över regler för nätverkssäkerhetsgrupper som ska tillämpas på slutpunkten.
Det maximala antalet regler som kan anges för alla slutpunkter i en Batch-pool är 25. Om inga regler för nätverkssäkerhetsgrupper har angetts skapas en standardregel för att tillåta inkommande åtkomst till den angivna backendPort. Om det maximala antalet regler för nätverkssäkerhetsgrupper överskrids misslyckas begäran med HTTP-statuskod 400.

protocol

InboundEndpointProtocol

Slutpunktens protokoll.

IPAddressProvisioningType

Etableringstypen för offentliga IP-adresser för poolen.

Name Typ Description
batchmanaged

string

En offentlig IP-adress skapas och hanteras av Batch. Det kan finnas flera offentliga IP-adresser beroende på poolens storlek.

nopublicipaddresses

string

Ingen offentlig IP-adress skapas.

usermanaged

string

Offentliga IP-adresser tillhandahålls av användaren och används för att etablera beräkningsnoderna.

LinuxUserConfiguration

Egenskaper som används för att skapa ett användarkonto på en Linux-beräkningsnod.

Name Typ Description
gid

integer

Grupp-ID för användarkontot.
Egenskaperna uid och gid måste anges tillsammans eller inte alls. Om det inte anges väljer det underliggande operativsystemet gid.

sshPrivateKey

string

Den privata SSH-nyckeln för användarkontot.
Den privata nyckeln får inte vara lösenordsskyddad. Den privata nyckeln används för att automatiskt konfigurera asymmetrisk nyckelbaserad autentisering för SSH mellan beräkningsnoder i en Linux-pool när poolens enableInterNodeCommunication-egenskap är sann (den ignoreras om enableInterNodeCommunication är falskt). Det gör du genom att placera nyckelparet i användarens .ssh-katalog. Om det inte anges konfigureras inte lösenordsfri SSH mellan beräkningsnoder (ingen ändring av användarens .ssh-katalog görs).

uid

integer

Användar-ID för användarkontot.
Egenskaperna uid och gid måste anges tillsammans eller inte alls. Om det inte anges väljer det underliggande operativsystemet uid.

LoginMode

Inloggningsläget för användaren

Name Typ Description
batch

string

Inloggningsläget LOGON32_LOGON_BATCH Win32. Batchinloggningsläget rekommenderas för långvariga parallella processer.

interactive

string

Inloggningsläget LOGON32_LOGON_INTERACTIVE Win32. UAC är aktiverat i Windows-pooler. Om det här alternativet används med en upphöjd användaridentitet i en Windows-pool utökas inte användarsessionen såvida inte programmet som körs av kommandoraden Aktivitet har konfigurerats för att alltid kräva administratörsbehörighet eller att alltid kräva maximal behörighet.

ManagedDisk

Name Typ Description
securityProfile

VMDiskSecurityProfile

Anger säkerhetsprofilinställningarna för den hanterade disken.
Anger säkerhetsprofilinställningarna för den hanterade disken. Obs: Det kan bara anges för konfidentiella virtuella datorer och krävs när du använder konfidentiella virtuella datorer.

storageAccountType

StorageAccountType

Lagringskontotypen för hanterad disk.

MetadataItem

Ett namn/värde-par som är associerat med en Batch-tjänstresurs.

Name Typ Description
name

string

Namnet på metadataobjektet.

value

string

Värdet för metadataobjektet.

MountConfiguration

Filsystemet som ska monteras på varje nod.

Name Typ Description
azureBlobFileSystemConfiguration

AzureBlobFileSystemConfiguration

Azure Storage-containern som ska monteras med blob-FUSE på varje nod.
Den här egenskapen är ömsesidigt uteslutande med alla andra egenskaper.

azureFileShareConfiguration

AzureFileShareConfiguration

Den Azure-filresurs som ska monteras på varje nod.
Den här egenskapen är ömsesidigt uteslutande med alla andra egenskaper.

cifsMountConfiguration

CIFSMountConfiguration

CIFS/SMB-filsystemet som ska monteras på varje nod.
Den här egenskapen är ömsesidigt uteslutande med alla andra egenskaper.

nfsMountConfiguration

NFSMountConfiguration

NFS-filsystemet som ska monteras på varje nod.
Den här egenskapen är ömsesidigt uteslutande med alla andra egenskaper.

NetworkConfiguration

Nätverkskonfigurationen för en pool.

Name Typ Description
dynamicVNetAssignmentScope

DynamicVNetAssignmentScope

Omfånget för dynamisk vnet-tilldelning.

enableAcceleratedNetworking

boolean

Om den här poolen ska aktivera accelererat nätverk.
Accelererat nätverk möjliggör enkel rot-I/O-virtualisering (SR-IOV) till en virtuell dator, vilket kan leda till bättre nätverksprestanda. Mer information finns i: https://video2.skills-academy.com/azure/virtual-network/accelerated-networking-overview.

endpointConfiguration

PoolEndpointConfiguration

Konfigurationen för slutpunkter på beräkningsnoder i Batch-poolen.

publicIPAddressConfiguration

PublicIPAddressConfiguration

Den offentliga IPAddress-konfigurationen för beräkningsnoder i Batch-poolen.
Den offentliga IP-adresskonfigurationen för nätverkskonfigurationen för en pool.

subnetId

string

ARM-resursidentifieraren för det virtuella nätverksundernätet som poolens beräkningsnoder ansluter till. Det här är formuläret /subscriptions/{subscription}/resourceGroups/{group}/providers/{provider}/virtualNetworks/{network}/subnets/{subnet}.
Det virtuella nätverket måste finnas i samma region och prenumeration som Azure Batch-kontot. Det angivna undernätet bör ha tillräckligt med kostnadsfria IP-adresser för att hantera antalet beräkningsnoder i poolen. Om undernätet inte har tillräckligt med kostnadsfria IP-adresser allokerar poolen delvis noder och ett storleksändringsfel uppstår. Tjänstens huvudnamn för MicrosoftAzureBatch måste ha rollen "Klassisk virtuell datordeltagare" Role-Based åtkomstkontroll (RBAC) för det angivna virtuella nätverket. Det angivna undernätet måste tillåta kommunikation från Azure Batch-tjänsten för att kunna schemalägga aktiviteter på noderna. Detta kan verifieras genom att kontrollera om det angivna virtuella nätverket har några associerade nätverkssäkerhetsgrupper (NSG). Om kommunikationen till noderna i det angivna undernätet nekas av en NSG anger Batch-tjänsten tillståndet för beräkningsnoderna till oanvändbart. Endast virtuella ARM-nätverk ("Microsoft.Network/virtualNetworks") stöds. Om det angivna virtuella nätverket har några associerade nätverkssäkerhetsgrupper (NSG) måste några reserverade systemportar aktiveras för inkommande kommunikation. Aktivera portarna 29876 och 29877 samt port 22 för Linux och port 3389 för Windows. Aktivera även utgående anslutningar till Azure Storage på port 443. Mer information finns i: https://docs.microsoft.com/azure/batch/batch-api-basics#virtual-network-vnet-and-firewall-configuration

NetworkSecurityGroupRule

En regel för nätverkssäkerhetsgrupp som ska tillämpas på en inkommande slutpunkt.

Name Typ Description
access

NetworkSecurityGroupRuleAccess

Den åtgärd som ska vidtas för en angiven IP-adress, undernätsintervall eller tagg.

priority

integer

Prioriteten för den här regeln.
Prioriteringarna i en pool måste vara unika och utvärderas i prioritetsordning. Desto lägre är talet, desto högre prioritet. Regler kan till exempel anges med ordernummer 150, 250 och 350. Regeln med ordernumret 150 har företräde framför regeln som har en ordning på 250. Tillåtna prioriteringar är mellan 150 och 4 096. Om några reserverade eller duplicerade värden anges misslyckas begäran med HTTP-statuskod 400.

sourceAddressPrefix

string

Källadressprefixet eller taggen som ska matchas för regeln.
Giltiga värden är en enskild IP-adress (dvs. 10.10.10.10), IP-undernät (dvs. 192.168.1.0/24), standardtagg eller * (för alla adresser). Om andra värden anges misslyckas begäran med HTTP-statuskod 400.

sourcePortRanges

string[]

Källportintervallen som ska matchas för regeln.
Giltiga värden är(för alla portar 0–65535), en specifik port (dvs. 22) eller ett portintervall (dvs. 100–200). Portarna måste vara mellan 0 och 65535. Varje post i den här samlingen får inte överlappa någon annan post (antingen ett intervall eller en enskild port). Om andra värden anges misslyckas begäran med HTTP-statuskod 400. Standardvärdet är.

NetworkSecurityGroupRuleAccess

Den åtgärd som ska vidtas för en angiven IP-adress, undernätsintervall eller tagg.

Name Typ Description
allow

string

Tillåt åtkomst.

deny

string

Neka åtkomst.

NFSMountConfiguration

Information som används för att ansluta till ett NFS-filsystem.

Name Typ Description
mountOptions

string

Ytterligare kommandoradsalternativ för att skicka till monteringskommandot.
Det här är alternativ för "net use" i Windows och "monteringsalternativ" i Linux.

relativeMountPath

string

Den relativa sökvägen på beräkningsnoden där filsystemet ska monteras
Alla filsystem monteras i förhållande till katalogen Batch-monteringar, som är tillgängliga via AZ_BATCH_NODE_MOUNTS_DIR miljövariabeln.

source

string

URI:n för filsystemet som ska monteras.

NodeCommunicationMode

Avgör hur en pool kommunicerar med Batch-tjänsten.

Name Typ Description
classic

string

Noder som använder det klassiska kommunikationsläget kräver inkommande TCP-kommunikation på portarna 29876 och 29877 från "BatchNodeManagement. {region}"-tjänsttagg och utgående TCP-kommunikation på port 443 till "Storage.region" och "BatchNodeManagement. {region}" tjänsttaggar.

default

string

Nodkommunikationsläget anges automatiskt av Batch-tjänsten.

simplified

string

Noder som använder det förenklade kommunikationsläget kräver utgående TCP-kommunikation på port 443 till "BatchNodeManagement. {region}" tjänsttagg. Inga öppna inkommande portar krävs.

NodePlacementConfiguration

Konfiguration av nodplacering för en pool.

Name Typ Description
policy

NodePlacementPolicyType

Principtyp för nodplacering i Batch-pooler.
Allokeringsprincip som används av Batch Service för att etablera noderna. Om det inte anges använder Batch regionalprincipen.

NodePlacementPolicyType

Placeringsprincipen för allokering av noder i poolen.

Name Typ Description
regional

string

Alla noder i poolen allokeras i samma region.

zonal

string

Noder i poolen kommer att spridas över olika tillgänglighetszoner med bästa möjliga balansering.

OSDisk

Inställningar för operativsystemets disk för beräkningsnoden (VM).

Name Typ Description
caching

CachingType

Anger cachelagringskraven. Möjliga värden är: None, ReadOnly, ReadWrite. Standardvärdena är: Ingen för standardlagring. ReadOnly för Premium Storage.
Standardvärdet för cachelagring är inget. Information om cachelagringsalternativen finns i: https://blogs.msdn.microsoft.com/windowsazurestorage/2012/06/27/exploring-windows-azure-drives-disks-and-images/.

diskSizeGB

integer

Den ursprungliga diskstorleken i GB när du skapar en ny OS-disk.

ephemeralOSDiskSettings

DiffDiskSettings

Anger tillfälliga diskinställningar för operativsystemdisken som används av beräkningsnoden (VM).

managedDisk

ManagedDisk

Parametrarna för hanterade diskar.

writeAcceleratorEnabled

boolean

Anger om writeAccelerator ska aktiveras eller inaktiveras på disken.

PoolAddParameter

En pool i Azure Batch-tjänsten att lägga till.

Name Typ Description
applicationPackageReferences

ApplicationPackageReference[]

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

string

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

string

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://azure.microsoft.com/documentation/articles/batch-automatic-scaling/).

certificateReferences

CertificateReference[]

Listan över certifikat som ska installeras på varje beräkningsnod i poolen.
För Windows-noder installerar Batch-tjänsten certifikaten till det angivna certifikatarkivet och platsen. För Linux-beräkningsnoder lagras certifikaten i en katalog i arbetskatalogen Aktivitet och en miljövariabel AZ_BATCH_CERTIFICATES_DIR skickas till uppgiften för att fråga efter den här platsen. För certifikat med synlighet för "remoteUser" skapas en "certifikatkatalog" i användarens hemkatalog (t.ex. /home/{user-name}/certs) och Certifikat placeras i den katalogen.

Varning! Den här egenskapen är inaktuell och tas bort efter februari 2024. Använd Azure KeyVault-tillägget i stället.

displayName

string

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

boolean

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

boolean

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

string

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

MetadataItem[]

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

MountConfiguration[]

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

networkConfiguration

NetworkConfiguration

Nätverkskonfigurationen för poolen.
Nätverkskonfigurationen för en pool.

resizeTimeout

string

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).

resourceTags

object

De användardefinierade taggarna som är associerade med poolen.
De användardefinierade taggar som ska associeras med Azure Batch-poolen. När de här taggarna anges sprids de till de Azure-resurser som är associerade med poolen. Den här egenskapen kan bara anges när Batch-kontot skapades med egenskapen poolAllocationMode inställd på "UserSubscription".

startTask

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

integer

Ö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

integer

Ö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.

targetNodeCommunicationMode

NodeCommunicationMode

Önskat nodkommunikationsläge för poolen.
Om det utelämnas är standardvärdet Standard.

taskSchedulingPolicy

TaskSchedulingPolicy

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

taskSlotsPerNode

integer

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

UpgradePolicy

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

userAccounts

UserAccount[]

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

virtualMachineConfiguration

VirtualMachineConfiguration

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

vmSize

string

Storleken på virtuella datorer i poolen. Alla virtuella datorer i en pool har samma storlek.
Information om tillgängliga VM-storlekar finns i Storlekar för virtuella datorer (Linux) (https://azure.microsoft.com/documentation/articles/virtual-machines-linux-sizes/) eller Storlekar för virtuella datorer (Windows) (https://azure.microsoft.com/documentation/articles/virtual-machines-windows-sizes/). 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).

PoolEndpointConfiguration

Slutpunktskonfigurationen för en pool.

Name Typ Description
inboundNATPools

InboundNATPool[]

En lista över inkommande NAT-pooler som kan användas för att hantera specifika portar på en enskild beräkningsnod externt.
Det maximala antalet inkommande NAT-pooler per Batch-pool är 5. Om det maximala antalet inkommande NAT-pooler överskrids misslyckas begäran med HTTP-statuskod 400. Detta kan inte anges om IPAddressProvisioningType är NoPublicIPAddresses.

PublicIPAddressConfiguration

Den offentliga IP-adresskonfigurationen för nätverkskonfigurationen för en pool.

Name Typ Description
ipAddressIds

string[]

Listan över offentliga IP-adresser som Batch-tjänsten ska använda vid etablering av beräkningsnoder.
Antalet IP-adresser som anges här begränsar den maximala storleken på poolen – 100 dedikerade noder eller 100 noder med oanvänd kapacitet/låg prioritet kan allokeras för varje offentlig IP-adress. En pool som behöver 250 dedikerade virtuella datorer skulle till exempel behöva minst 3 offentliga IP-adresser angivna. Varje element i den här samlingen är av formuläret : /subscriptions/{subscription}/resourceGroups/{group}/providers/Microsoft.Network/publicIPAddresses/{ip}.

provision

IPAddressProvisioningType

Etableringstypen för offentliga IP-adresser för poolen.
Standardvärdet är BatchManaged.

ResourceFile

En enda fil eller flera filer som ska laddas ned till en beräkningsnod.

Name Typ Description
autoStorageContainerName

string

Namnet på lagringscontainern i det automatiska lagringskontot.
Egenskaperna autoStorageContainerName, storageContainerUrl och httpUrl är ömsesidigt uteslutande och en av dem måste anges.

blobPrefix

string

Blobprefixet som ska användas vid nedladdning av blobar från en Azure Storage-container. Endast de blobar vars namn börjar med det angivna prefixet laddas ned.
Egenskapen är endast giltig när autoStorageContainerName eller storageContainerUrl används. Det här prefixet kan vara ett partiellt filnamn eller en underkatalog. Om inget prefix har angetts laddas alla filer i containern ned.

fileMode

string

Attributet för filbehörighetsläge i oktalt format.
Den här egenskapen gäller endast filer som laddas ned till Linux-beräkningsnoder. Den ignoreras om den har angetts för en resourceFile som laddas ned till en Windows-beräkningsnod. Om den här egenskapen inte har angetts för en Linux-beräkningsnod tillämpas standardvärdet 0770 på filen.

filePath

string

Platsen på beräkningsnoden som filen eller filerna ska laddas ned till i förhållande till aktivitetens arbetskatalog.
Om egenskapen httpUrl har angetts krävs filePath och beskriver sökvägen som filen ska laddas ned till, inklusive filnamnet. Om egenskapen autoStorageContainerName eller storageContainerUrl har angetts är filePath valfritt och är den katalog som filerna ska laddas ned till. Om filePath används som en katalog behålls alla katalogstrukturer som redan är associerade med indata i sin helhet och läggs till i den angivna filePath-katalogen. Den angivna relativa sökvägen kan inte bryta sig ut från aktivitetens arbetskatalog (till exempel med hjälp av ..).

httpUrl

string

URL:en för filen som ska laddas ned.
Egenskaperna autoStorageContainerName, storageContainerUrl och httpUrl är ömsesidigt uteslutande och en av dem måste anges. Om URL:en pekar på Azure Blob Storage måste den vara läsbar från beräkningsnoder. Det finns tre sätt att hämta en sådan URL för en blob i Azure Storage: inkludera en signatur för delad åtkomst (SAS) som beviljar läsbehörigheter för blobben, använda en hanterad identitet med läsbehörighet eller ange ACL för blobben eller dess container för att tillåta offentlig åtkomst.

identityReference

ComputeNodeIdentityReference

Referensen till den användartilldelade identitet som ska användas för åtkomst till Azure Blob Storage som anges av storageContainerUrl eller httpUrl
Referensen till en användartilldelad identitet som är associerad med Batch-poolen som en beräkningsnod ska använda.

storageContainerUrl

string

URL:en för blobcontainern i Azure Blob Storage.
Egenskaperna autoStorageContainerName, storageContainerUrl och httpUrl är ömsesidigt uteslutande och en av dem måste anges. Den här URL:en måste vara läsbar och listbar från beräkningsnoder. Det finns tre sätt att hämta en sådan URL för en container i Azure Storage: inkludera en signatur för delad åtkomst (SAS) som beviljar läs- och listbehörigheter för containern, använder en hanterad identitet med läs- och listbehörigheter eller anger ACL för containern för att tillåta offentlig åtkomst.

RollingUpgradePolicy

De konfigurationsparametrar som används vid löpande uppgradering.

Name Typ Description
enableCrossZoneUpgrade

boolean

Tillåt ATT VMSS ignorerar AZ-gränser när du skapar uppgraderingsbatch. Ta hänsyn till uppdateringsdomänen och maxBatchInstancePercent för att fastställa batchstorleken. Det här fältet kan endast anges till sant eller falskt när nodePlacementConfiguration används som zonindelning.

maxBatchInstancePercent

integer

Den maximala procentandelen av de totala virtuella datorinstanserna som uppgraderas samtidigt av den löpande uppgraderingen i en batch. Eftersom detta är ett maximalt antal felaktiga instanser i tidigare eller framtida batchar kan procentandelen instanser i en batch minska för att säkerställa högre tillförlitlighet. Värdet för det här fältet ska vara mellan 5 och 100, inklusive. Om både maxBatchInstancePercent och maxUnhealthyInstancePercent tilldelas med värde bör värdet för maxBatchInstancePercent inte vara mer än maxUnhealthyInstancePercent.

maxUnhealthyInstancePercent

integer

Den maximala procentandelen av de totala virtuella datorinstanserna i skalningsuppsättningen som kan vara felfritt samtidigt, antingen till följd av uppgraderingen eller genom att hittas i ett feltillstånd av hälsokontrollerna för den virtuella datorn innan den löpande uppgraderingen avbryts. Den här begränsningen kontrolleras innan någon batch startas. Värdet för det här fältet ska vara mellan 5 och 100, inklusive. Om både maxBatchInstancePercent och maxUnhealthyInstancePercent tilldelas med värde bör värdet för maxBatchInstancePercent inte vara mer än maxUnhealthyInstancePercent.

maxUnhealthyUpgradedInstancePercent

integer

Den maximala procentandelen uppgraderade virtuella datorinstanser som kan konstateras vara i ett feltillstånd. Den här kontrollen sker när varje batch har uppgraderats. Om den här procentandelen någonsin överskrids avbryts den löpande uppdateringen. Värdet för det här fältet ska vara mellan 0 och 100, inklusive.

pauseTimeBetweenBatches

string

Väntetiden mellan att slutföra uppdateringen för alla virtuella datorer i en batch och starta nästa batch. Varaktigheten ska anges i ISO 8601-format.

prioritizeUnhealthyInstances

boolean

Uppgradera alla instanser med feltillstånd i en skalningsuppsättning före eventuella felfria instanser.

rollbackFailedInstancesOnPolicyBreach

boolean

Återställningen misslyckades för instanser till en tidigare modell om principen för löpande uppgradering överträds.

SecurityEncryptionTypes

Anger EncryptionType för den hanterade disken. Den är inställd på VMGuestStateOnly för kryptering av bara VMGuestState-bloben och NonPersistedTPM för att inte bevara tillståndet för inbyggd programvara i VMGuestState-bloben. Obs: Det kan endast anges för konfidentiella virtuella datorer och krävs när du använder konfidentiella virtuella datorer.

Name Typ Description
NonPersistedTPM

string

VMGuestStateOnly

string

SecurityProfile

Anger säkerhetsprofilinställningarna för den virtuella datorn eller vm-skalningsuppsättningen.

Name Typ Description
encryptionAtHost

boolean

Den här egenskapen kan användas av användaren i begäran för att aktivera eller inaktivera värdkryptering för den virtuella datorn eller vm-skalningsuppsättningen. Detta aktiverar krypteringen för alla diskar, inklusive resurs/temp-disk på själva värden. Mer information om kryptering vid värdkrav finns i https://video2.skills-academy.com/azure/virtual-machines/disk-encryption#supported-vm-sizes.

securityType

SecurityTypes

Anger SecurityType för den virtuella datorn. Det måste anges till ett angivet värde för att aktivera UefiSettings.

uefiSettings

UefiSettings

Anger de säkerhetsinställningar som säker start och vTPM som används när den virtuella datorn skapas.
Anger de säkerhetsinställningar som säker start och vTPM som används när den virtuella datorn skapas.

SecurityTypes

Anger SecurityType för den virtuella datorn. Det måste anges till ett angivet värde för att aktivera UefiSettings.

Name Typ Description
confidentialVM

string

Konfidentiell databehandling i Azure erbjuder konfidentiella virtuella datorer för klienter med höga krav på säkerhet och konfidentialitet. Dessa virtuella datorer tillhandahåller en stark, maskinvarubaserad gräns som hjälper dig att uppfylla dina säkerhetsbehov. Du kan använda konfidentiella virtuella datorer för migreringar utan att göra ändringar i koden, där plattformen skyddar den virtuella datorns tillstånd från att läsas eller ändras.

trustedLaunch

string

Betrodd start skyddar mot avancerade och beständiga attacktekniker.

ServiceArtifactReference

Anger tjänstartefaktreferens-ID:t som används för att ange samma avbildningsversion för alla virtuella datorer i skalningsuppsättningen när du använder den senaste avbildningsversionen.

Name Typ Description
id

string

Tjänstartefaktens referens-ID för ServiceArtifactReference
Referens-ID för tjänstartefakt i form av /subscriptions/{subscriptionId}/resourceGroups/{resourceGroup}/providers/Microsoft.Compute/galleries/{galleryName}/serviceArtifacts/{serviceArtifactName}/vmArtifactsProfiles/{vmArtifactsProfilesName}

StartTask

En uppgift som körs när en nod ansluter till en pool i Azure Batch-tjänsten, eller när beräkningsnoden startas om eller omskapas.

Name Typ Description
commandLine

string

Kommandoraden i StartTask.
Kommandoraden körs inte under ett gränssnitt och kan därför inte dra nytta av gränssnittsfunktioner som miljövariabelexpansion. Om du vill dra nytta av sådana funktioner bör du anropa gränssnittet på kommandoraden, till exempel med hjälp av "cmd /c MyCommand" i Windows eller "/bin/sh -c MyCommand" i Linux. Om kommandoraden refererar till filsökvägar bör den använda en relativ sökväg (i förhållande till arbetskatalogen Uppgift) eller använda miljövariabeln i Batch (https://docs.microsoft.com/azure/batch/batch-compute-node-environment-variables).

containerSettings

TaskContainerSettings

Inställningarna för containern under vilken StartTask körs.
När detta anges mappas alla kataloger rekursivt under AZ_BATCH_NODE_ROOT_DIR (roten för Azure Batch-kataloger på noden) till containern, alla miljövariabler för aktivitet mappas till containern och kommandoraden Aktivitet körs i containern. Filer som skapas i containern utanför AZ_BATCH_NODE_ROOT_DIR kanske inte återspeglas på värddisken, vilket innebär att Batch-fil-API:er inte kommer att kunna komma åt dessa filer.

environmentSettings

EnvironmentSetting[]

En lista över miljövariabelinställningar för StartTask.

maxTaskRetryCount

integer

Det maximala antalet gånger som aktiviteten kan försökas igen.
Batch-tjänsten försöker utföra en aktivitet igen om slutkoden inte är noll. Observera att det här värdet specifikt styr antalet återförsök. Batch-tjänsten provar uppgiften en gång och kan sedan försöka upp till den här gränsen igen. Om det maximala antalet återförsök till exempel är 3, försöker Batch aktiviteten upp till 4 gånger (ett första försök och 3 återförsök). Om det maximala antalet återförsök är 0 försöker inte Batch-tjänsten uppgiften igen. Om det maximala antalet återförsök är -1 försöker Batch-tjänsten aktiviteten utan begränsning igen, men detta rekommenderas inte för en startaktivitet eller någon aktivitet. Standardvärdet är 0 (inga återförsök).

resourceFiles

ResourceFile[]

En lista över filer som Batch-tjänsten laddar ned till beräkningsnoden innan du kör kommandoraden. Det finns en maximal storlek för listan över resursfiler. När maxstorleken överskrids misslyckas begäran och svarsfelkoden requestEntityTooLarge. Om detta inträffar måste samlingen av ResourceFiles minskas i storlek. Detta kan uppnås med hjälp av .zip filer, programpaket eller Docker-containrar.
Filer som visas under det här elementet finns i arbetskatalogen för aktiviteten.

userIdentity

UserIdentity

Användaridentiteten som StartTask körs under.
Om den utelämnas körs aktiviteten som en icke-administrativ användare som är unik för aktiviteten.

waitForSuccess

boolean

Om Batch-tjänsten ska vänta tills StartTask har slutförts (d.v.s. avsluta med slutkod 0) innan du schemalägger aktiviteter på beräkningsnoden.
Om true och StartTask misslyckas på en nod, försöker Batch-tjänsten starta om StartTask upp till det maximala antalet återförsök (maxTaskRetryCount). Om aktiviteten fortfarande inte har slutförts efter alla återförsök markerar Batch-tjänsten noden oanvändbar och schemalägger inte Aktiviteter till den. Det här villkoret kan identifieras via beräkningsnodens tillstånd och information om felinformation. Om det är falskt väntar inte Batch-tjänsten på att StartTask ska slutföras. I det här fallet kan andra uppgifter börja köras på beräkningsnoden medan StartTask fortfarande körs. och även om StartTask misslyckas fortsätter nya aktiviteter att schemaläggas på beräkningsnoden. Standardvärdet är sant.

StorageAccountType

Lagringskontotypen som ska användas för att skapa datadiskar eller OS-diskar.

Name Typ Description
premium_lrs

string

Datadisken/OS-disken bör använda premium lokalt redundant lagring.

standard_lrs

string

Datadisken/OS-disken bör använda lokalt redundant standardlagring.

standardssd_lrs

string

Datadisken/OS-disken ska använda standardlagring med lokalt redundant SSD.

TaskContainerSettings

Containerinställningarna för en aktivitet.

Name Typ Description
containerHostBatchBindMounts

ContainerHostBatchBindMountEntry[]

Sökvägarna som du vill montera på containeraktiviteten.
Om den här matrisen är null eller inte finns monterar containeraktiviteten hela den tillfälliga diskenheten i Windows (eller AZ_BATCH_NODE_ROOT_DIR i Linux). Den monterar inga datasökvägar i containern om den här matrisen har angetts som tom.

containerRunOptions

string

Ytterligare alternativ för kommandot container create.
Dessa ytterligare alternativ anges som argument till kommandot "docker create", utöver de som styrs av Batch-tjänsten.

imageName

string

Avbildningen som ska användas för att skapa containern där aktiviteten ska köras.
Det här är den fullständiga avbildningsreferensen, som skulle anges till "docker pull". Om ingen tagg anges som en del av avbildningsnamnet används taggen ":latest" som standard.

registry

ContainerRegistry

Det privata registret som innehåller containeravbildningen.
Den här inställningen kan utelämnas om den redan angavs när poolen skapades.

workingDirectory

ContainerWorkingDirectory

Platsen för containerns arbetskatalog för uppgift.
Standardvärdet är "taskWorkingDirectory".

TaskSchedulingPolicy

Anger hur Aktiviteter ska distribueras mellan beräkningsnoder.

Name Typ Description
nodeFillType

ComputeNodeFillType

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

UefiSettings

Anger de säkerhetsinställningar som säker start och vTPM som används när den virtuella datorn skapas.

Name Typ Description
secureBootEnabled

boolean

Anger om säker start ska aktiveras på den virtuella datorn.

vTpmEnabled

boolean

Anger om vTPM ska aktiveras på den virtuella datorn.

UpgradeMode

Anger läget för en uppgradering till virtuella datorer i skalningsuppsättningen.

Möjliga värden är:

Manuell – Du styr programmet för uppdateringar av virtuella datorer i skalningsuppsättningen. Du gör detta med hjälp av åtgärden manualUpgrade.

Automatisk – Alla virtuella datorer i skalningsuppsättningen uppdateras automatiskt samtidigt.

Rullande – Skalningsuppsättningen utför uppdateringar i batchar med en valfri paustid däremellan.

Name Typ Description
automatic

string

Alla virtuella datorer i skalningsuppsättningen uppdateras automatiskt samtidigt.

manual

string

Du styr programmet för uppdateringar av virtuella datorer i skalningsuppsättningen. Du gör detta med hjälp av åtgärden manualUpgrade.

rolling

string

De befintliga instanserna i en skalningsuppsättning tas ned i batchar som ska uppgraderas. När den uppgraderade batchen är klar börjar instanserna ta trafik igen och nästa batch börjar. Detta fortsätter tills alla instanser har up-to-date.

UpgradePolicy

Beskriver en uppgraderingsprincip – automatisk, manuell eller rullande.

Name Typ Description
automaticOSUpgradePolicy

AutomaticOSUpgradePolicy

Konfigurationsparametrar som används för att utföra automatisk operativsystemuppgradering.
De konfigurationsparametrar som används för att utföra automatisk operativsystemuppgradering.

mode

UpgradeMode

Anger läget för en uppgradering till virtuella datorer i skalningsuppsättningen.

Möjliga värden är:

Manuell – Du styr programmet för uppdateringar av virtuella datorer i skalningsuppsättningen. Du gör detta med hjälp av åtgärden manualUpgrade.

Automatisk – Alla virtuella datorer i skalningsuppsättningen uppdateras automatiskt samtidigt.

Rullande – Skalningsuppsättningen utför uppdateringar i batchar med en valfri paustid däremellan.

rollingUpgradePolicy

RollingUpgradePolicy

De konfigurationsparametrar som används vid löpande uppgradering.
De konfigurationsparametrar som används vid löpande uppgradering.

UserAccount

Egenskaper som används för att skapa en användare som används för att köra uppgifter på en Azure Batch Compute-nod.

Name Typ Description
elevationLevel

ElevationLevel

Behörighetsnivån för användarkontot.
Standardvärdet är nonAdmin.

linuxUserConfiguration

LinuxUserConfiguration

Den Linux-specifika användarkonfigurationen för användarkontot.
Den här egenskapen ignoreras om den anges i en Windows-pool. Om det inte anges skapas användaren med standardalternativen.

name

string

Namnet på användarkontot. Namn kan innehålla alla Unicode-tecken upp till en maximal längd på 20.

password

string

Lösenordet för användarkontot.

windowsUserConfiguration

WindowsUserConfiguration

Den Windows-specifika användarkonfigurationen för användarkontot.
Den här egenskapen kan bara anges om användaren finns i en Windows-pool. Om det inte anges och på en Windows-pool skapas användaren med standardalternativen.

UserIdentity

Definitionen av användaridentiteten som aktiviteten körs under.

Name Typ Description
autoUser

AutoUserSpecification

Den automatiska användare under vilken aktiviteten körs.
Egenskaperna userName och autoUser är ömsesidigt uteslutande. du måste ange en men inte båda.

username

string

Namnet på den användaridentitet som aktiviteten körs under.
Egenskaperna userName och autoUser är ömsesidigt uteslutande. du måste ange en men inte båda.

VirtualMachineConfiguration

Konfigurationen för beräkningsnoder i en pool baserat på Azure Virtual Machines-infrastrukturen.

Name Typ Description
containerConfiguration

ContainerConfiguration

Containerkonfigurationen för poolen.
Om det anges utförs konfigurationen på varje beräkningsnod i poolen så att uppgifter kan köras i containrar. Alla vanliga uppgifter och jobbhanteraraktiviteter som körs i den här poolen måste ange egenskapen containerSettings och alla andra aktiviteter kan ange den.

dataDisks

DataDisk[]

Konfigurationen för datadiskar som är anslutna till beräkningsnoderna i poolen.
Den här egenskapen måste anges om beräkningsnoderna i poolen måste ha tomma datadiskar kopplade till sig. Det går inte att uppdatera detta. Varje beräkningsnod hämtar en egen disk (disken är inte en filresurs). Det går inte att ansluta befintliga diskar. Varje ansluten disk är tom. När beräkningsnoden tas bort från poolen tas även disken och alla data som är associerade med den bort. Disken är inte formaterad efter att den har anslutits, den måste formateras före användning – mer information finns i https://docs.microsoft.com/azure/virtual-machines/linux/classic/attach-disk#initialize-a-new-data-disk-in-linux och https://docs.microsoft.com/azure/virtual-machines/windows/attach-disk-ps#add-an-empty-data-disk-to-a-virtual-machine.

diskEncryptionConfiguration

DiskEncryptionConfiguration

Diskkrypteringskonfigurationen för poolen.
Om det anges utförs kryptering på varje nod i poolen under nodetablering.

extensions

VMExtension[]

Tillägget för den virtuella datorn för poolen.
Om det anges installeras tilläggen som nämns i den här konfigurationen på varje nod.

imageReference

ImageReference

En referens till Azure Virtual Machines Marketplace-avbildningen eller den anpassade virtual machine-avbildningen som ska användas.

licenseType

string

Den typ av lokal licens som ska användas vid distribution av operativsystemet.
Detta gäller endast för avbildningar som innehåller Windows-operativsystemet och bör endast användas när du har giltiga lokala licenser för beräkningsnoderna som ska distribueras. Om det utelämnas tillämpas ingen lokal licensrabatt. Värden är:

Windows_Server – Den lokala licensen gäller för Windows Server. Windows_Client – Den lokala licensen gäller för Windows-klienten.

nodeAgentSKUId

string

SKU:n för Batch Compute Node-agenten som ska etableras på beräkningsnoder i poolen.
Batch Compute Node-agenten är ett program som körs på varje beräkningsnod i poolen och tillhandahåller kommando- och kontrollgränssnittet mellan beräkningsnoden och Batch-tjänsten. Det finns olika implementeringar av Compute Node-agenten, som kallas SKU:er, för olika operativsystem. Du måste ange en SKU för Beräkningsnodagent som matchar den valda avbildningsreferensen. Information om hur du hämtar listan över beräkningsnodagent-SKU:er som stöds tillsammans med deras lista över verifierade bildreferenser finns i åtgärden "List supported Compute Node agent SKU:er".

nodePlacementConfiguration

NodePlacementConfiguration

Nodplaceringskonfigurationen för poolen.
Den här konfigurationen anger regler för hur noder i poolen ska allokeras fysiskt.

osDisk

OSDisk

Inställningar för den virtuella datorns operativsystemdisk.

securityProfile

SecurityProfile

Anger säkerhetsprofilinställningarna för den virtuella datorn eller vm-skalningsuppsättningen.
Anger säkerhetsprofilinställningarna för den virtuella datorn eller vm-skalningsuppsättningen.

serviceArtifactReference

ServiceArtifactReference

Anger tjänstartefaktreferens-ID:t som används för att ange samma avbildningsversion för alla virtuella datorer i skalningsuppsättningen när du använder den senaste avbildningsversionen.
Referens-ID för tjänstartefakt i form av /subscriptions/{subscriptionId}/resourceGroups/{resourceGroup}/providers/Microsoft.Compute/galleries/{galleryName}/serviceArtifacts/{serviceArtifactName}/vmArtifactsProfiles/{vmArtifactsProfilesName}

windowsConfiguration

WindowsConfiguration

Inställningar för Windows-operativsystem på den virtuella datorn.
Den här egenskapen får inte anges om egenskapen imageReference anger en Linux OS-avbildning.

VMDiskSecurityProfile

Anger säkerhetsprofilinställningarna för den hanterade disken. Obs: Det kan bara anges för konfidentiella virtuella datorer och krävs när du använder konfidentiella virtuella datorer.

Name Typ Description
securityEncryptionType

SecurityEncryptionTypes

Anger EncryptionType för den hanterade disken. Den är inställd på VMGuestStateOnly för kryptering av bara VMGuestState-bloben och NonPersistedTPM för att inte bevara tillståndet för inbyggd programvara i VMGuestState-bloben. Obs: Det kan endast anges för konfidentiella virtuella datorer och krävs när du använder konfidentiella virtuella datorer.

VMExtension

Konfigurationen för tillägg för virtuella datorer.

Name Typ Description
autoUpgradeMinorVersion

boolean

Anger om tillägget ska använda en nyare delversion om en är tillgänglig vid distributionstillfället. När tillägget har distribuerats uppgraderas dock inte mindre versioner om de inte distribueras om, även med den här egenskapen inställd på true.

enableAutomaticUpgrade

boolean

Anger om tillägget ska uppgraderas automatiskt av plattformen om det finns en nyare version av tillägget tillgängligt.

name

string

Namnet på tillägget för den virtuella datorn.

protectedSettings

object

Tillägget kan innehålla antingen protectedSettings eller protectedSettingsFromKeyVault eller inga skyddade inställningar alls.

provisionAfterExtensions

string[]

Samlingen med tilläggsnamn.
Samling tilläggsnamn varefter tillägget måste etableras.

publisher

string

Namnet på tilläggshanterarens utgivare.

settings

object

JSON-formaterade offentliga inställningar för tillägget.

type

string

Typ av tillägg.

typeHandlerVersion

string

Versionen av skripthanteraren.

WindowsConfiguration

Inställningar för Windows-operativsystem som ska tillämpas på den virtuella datorn.

Name Typ Description
enableAutomaticUpdates

boolean

Om automatiska uppdateringar är aktiverade på den virtuella datorn.
Om det utelämnas är standardvärdet sant.

WindowsUserConfiguration

Egenskaper som används för att skapa ett användarkonto på en Windows-beräkningsnod.

Name Typ Description
loginMode

LoginMode

Inloggningsläget för användaren
Standardvärdet är "batch".