Pool - Add

Service:

Batch Service

API Version:

2023-11-01.18.0

Hiermee voegt u een pool toe aan het opgegeven account.
Vermijd bij het benoemen van pools gevoelige informatie, zoals gebruikersnamen of geheime projectnamen. Deze informatie kan worden weergegeven in telemetrielogboeken die toegankelijk zijn voor Microsoft Ondersteuning technici.

POST {batchUrl}/pools?api-version=2023-11-01.18.0

With optional parameters:

POST {batchUrl}/pools?timeout={timeout}&api-version=2023-11-01.18.0

URI-parameters

Name	In	Vereist	Type	Description
batchUrl	path	True	string	De basis-URL voor alle Azure Batch serviceaanvragen.
api-version	query	True	string	Client-API-versie.
timeout	query		integer int32	De maximale tijd die de server kan besteden aan het verwerken van de aanvraag, in seconden. De standaardwaarde is 30 seconden.

Aanvraagkoptekst

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

Name	Vereist	Type	Description
client-request-id		string uuid	De aanroeper gegenereerde aanvraagidentiteit, in de vorm van een GUID zonder decoratie, zoals accolades, bijvoorbeeld 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0.
return-client-request-id		boolean	Of de server de client-request-id in het antwoord moet retourneren.
ocp-date		string date-time-rfc1123	Het tijdstip waarop de aanvraag is uitgegeven. Clientbibliotheken stellen dit doorgaans in op de huidige systeemkloktijd; stel dit expliciet in als u de REST API rechtstreeks aanroept.

Aanvraagbody

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

Name	Vereist	Type	Description
id	True	string	Een tekenreeks die de pool binnen het account uniek identificeert. De id kan elke combinatie van alfanumerieke tekens bevatten, inclusief afbreekstreepjes en onderstrepingstekens, en mag niet meer dan 64 tekens bevatten. De id is hoofdletterbewaarbaar en niet hoofdlettergevoelig (dat wil dat u mogelijk geen twee pool-id's binnen een account hebt die alleen per geval verschillen).
vmSize	True	string	De grootte van virtuele machines in de pool. Alle virtuele machines in een pool hebben dezelfde grootte. Zie Grootten voor Cloud Services () voor informatie over de beschikbare grootten van virtuele machines voor Cloud Services pools (https://azure.microsoft.com/documentation/articles/cloud-services-sizes-specs/pools die zijn gemaakt met cloudServiceConfiguration). Batch ondersteunt alle Cloud Services VM-grootten, met uitzondering van ExtraSmall, A1V2 en A2V2. Zie Grootten voor Virtual Machines (Linux) () of Grootten voor Virtual Machines (Windows)https://azure.microsoft.com/documentation/articles/virtual-machines-linux-sizes/ voor informatie over beschikbare VM-grootten voor pools met behulp van installatiekopieën uit de Virtual Machines Marketplace (pools die zijn gemaakt met virtualMachineConfiguration).https://azure.microsoft.com/documentation/articles/virtual-machines-windows-sizes/ Batch ondersteunt alle azure-VM-grootten, behalve STANDARD_A0 en grootten met Premium Storage (STANDARD_GS, STANDARD_DS en STANDARD_DSV2-serie).
applicationLicenses		string[]	De lijst met toepassingslicenties die de Batch-service beschikbaar maakt op elk rekenknooppunt in de pool. De lijst met toepassingslicenties moet een subset zijn van beschikbare licenties voor Batch-servicetoepassingen. Als er een licentie wordt aangevraagd die niet wordt ondersteund, mislukt het maken van de pool.
applicationPackageReferences		ApplicationPackageReference[]	De lijst met pakketten die moeten worden geïnstalleerd op elk rekenknooppunt in de pool. Wanneer u een groep maakt, moet de toepassings-id van het pakket volledig zijn gekwalificeerd (/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Batch/batchAccounts/{accountName}/applications/{applicationName}). Wijzigingen in pakketverwijzingen zijn van invloed op alle nieuwe knooppunten die lid worden van de pool, maar hebben geen invloed op rekenknooppunten die zich al in de pool bevinden totdat ze opnieuw worden opgestart of opnieuw zijn geïnstalleerd. Er zijn maximaal 10 pakketverwijzingen voor een bepaalde pool.
autoScaleEvaluationInterval		string	Het tijdsinterval waarmee de poolgrootte automatisch moet worden aangepast aan de formule voor automatische schaalaanpassing. De standaardwaarde is 15 minuten. De minimum- en maximumwaarde zijn respectievelijk 5 minuten en 168 uur. Als u een waarde opgeeft die kleiner is dan 5 minuten of langer dan 168 uur, retourneert de Batch-service een fout; Als u de REST API rechtstreeks aanroept, is de HTTP-statuscode 400 (Ongeldige aanvraag).
autoScaleFormula		string	Een formule voor het gewenste aantal rekenknooppunten in de pool. Deze eigenschap mag niet worden opgegeven als enableAutoScale is ingesteld op false. Dit is vereist als enableAutoScale is ingesteld op true. De formule wordt gecontroleerd op geldigheid voordat de pool wordt gemaakt. Als de formule ongeldig is, weigert de Batch-service de aanvraag met gedetailleerde foutinformatie. Zie 'Compute Nodes in an Azure Batch Pool automatisch schalen' (https://azure.microsoft.com/documentation/articles/batch-automatic-scaling/) voor meer informatie over het opgeven van deze formule.
certificateReferences		CertificateReference[]	De lijst met certificaten die moeten worden geïnstalleerd op elk rekenknooppunt in de pool. Voor Windows-knooppunten installeert de Batch-service de certificaten in het opgegeven certificaatarchief en de opgegeven locatie. Voor Linux-rekenknooppunten worden de certificaten opgeslagen in een map in de werkmap Taak en een omgevingsvariabele AZ_BATCH_CERTIFICATES_DIR wordt geleverd aan de taak om een query uit te voeren op deze locatie. Voor certificaten met zichtbaarheid van 'remoteUser' wordt een map met certificaten gemaakt in de basismap van de gebruiker (bijvoorbeeld /home/{user-name}/certs) en worden certificaten in die map geplaatst. Waarschuwing: deze eigenschap is afgeschaft en wordt na februari 2024 verwijderd. Gebruik in plaats daarvan de Azure KeyVault-extensie .
cloudServiceConfiguration		CloudServiceConfiguration	De cloudserviceconfiguratie voor de pool. Deze eigenschap en virtualMachineConfiguration sluiten elkaar wederzijds uit en een van de eigenschappen moet worden opgegeven. Deze eigenschap kan niet worden opgegeven als het Batch-account is gemaakt met de eigenschap poolAllocationMode ingesteld op UserSubscription.
displayName		string	De weergavenaam voor de pool. De weergavenaam hoeft niet uniek te zijn en mag Unicode-tekens bevatten tot een maximale lengte van 1024.
enableAutoScale		boolean	Of de poolgrootte automatisch moet worden aangepast in de loop van de tijd. Indien onwaar, moet ten minste één van de targetDedicatedNodes en targetLowPriorityNodes worden opgegeven. Als dit waar is, is de eigenschap autoScaleFormula vereist en wordt de grootte van de pool automatisch aangepast aan de formule. De standaardwaarde is false.
enableInterNodeCommunication		boolean	Of de pool directe communicatie tussen rekenknooppunten toestaat. Als u communicatie tussen knooppunten inschakelt, wordt de maximale grootte van de pool beperkt vanwege implementatiebeperkingen op de rekenknooppunten van de pool. Dit kan ertoe leiden dat de pool niet de gewenste grootte bereikt. De standaardwaarde is false.
metadata		MetadataItem[]	Een lijst met naam-waardeparen die als metagegevens zijn gekoppeld aan de pool. De Batch-service wijst geen betekenis toe aan metagegevens; het is uitsluitend voor het gebruik van gebruikerscode.
mountConfiguration		MountConfiguration[]	Koppel opslag met behulp van het opgegeven bestandssysteem voor de hele levensduur van de groep. Koppel de opslag met behulp van azure-bestandsshare, NFS, CIFS of op Blobfuse gebaseerd bestandssysteem.
networkConfiguration		NetworkConfiguration	De netwerkconfiguratie voor de pool. De netwerkconfiguratie voor een pool.
resizeTimeout		string	De time-out voor de toewijzing van rekenknooppunten aan de pool. Deze time-out geldt alleen voor handmatig schalen; het heeft geen effect wanneer enableAutoScale is ingesteld op true. De standaardwaarde is 15 minuten. De minimumwaarde is 5 minuten. Als u een waarde van minder dan vijf minuten opgeeft, retourneert de Batch-service een fout; Als u de REST API rechtstreeks aanroept, is de HTTP-statuscode 400 (ongeldige aanvraag).
resourceTags		object	De door de gebruiker opgegeven tags die zijn gekoppeld aan de pool. De door de gebruiker gedefinieerde tags die moeten worden gekoppeld aan de Azure Batch pool. Indien opgegeven, worden deze tags doorgegeven aan de back-up van Azure-resources die zijn gekoppeld aan de pool. Deze eigenschap kan alleen worden opgegeven wanneer het Batch-account is gemaakt met de eigenschap poolAllocationMode ingesteld op UserSubscription.
startTask		StartTask	Een taak die is opgegeven om te worden uitgevoerd op elk rekenknooppunt wanneer het lid wordt van de pool. De taak wordt uitgevoerd wanneer het rekenknooppunt wordt toegevoegd aan de pool of wanneer het rekenknooppunt opnieuw wordt gestart.
targetDedicatedNodes		integer	Het gewenste aantal toegewezen rekenknooppunten in de pool. Deze eigenschap mag niet worden opgegeven als enableAutoScale is ingesteld op true. Als enableAutoScale is ingesteld op false, moet u targetDedicatedNodes, targetLowPriorityNodes of beide instellen.
targetLowPriorityNodes		integer	Het gewenste aantal spot-rekenknooppunten/rekenknooppunten met lage prioriteit in de pool. Deze eigenschap mag niet worden opgegeven als enableAutoScale is ingesteld op true. Als enableAutoScale is ingesteld op false, moet u targetDedicatedNodes, targetLowPriorityNodes of beide instellen.
targetNodeCommunicationMode		NodeCommunicationMode	De gewenste knooppuntcommunicatiemodus voor de pool. Als u dit weglaat, is de standaardwaarde Standaard.
taskSchedulingPolicy		TaskSchedulingPolicy	Hoe taken worden verdeeld over rekenknooppunten in een pool. Als dit niet is opgegeven, is de standaardwaarde spread.
taskSlotsPerNode		integer	Het aantal taaksites dat kan worden gebruikt om gelijktijdige taken uit te voeren op één rekenknooppunt in de pool. De standaardwaarde is 1. De maximumwaarde is de kleinste van 4 keer het aantal kernen van de vmSize van de pool of 256.
userAccounts		UserAccount[]	De lijst met gebruikersaccounts die moeten worden gemaakt op elk rekenknooppunt in de pool.
virtualMachineConfiguration		VirtualMachineConfiguration	De configuratie van de virtuele machine voor de pool. Deze eigenschap en cloudServiceConfiguration sluiten elkaar uit en een van de eigenschappen moet worden opgegeven.

Antwoorden

Name	Type	Description
201 Created		De aanvraag voor de Batch-service is geslaagd. Headers client-request-id: string request-id: string ETag: string Last-Modified: string DataServiceId: string
Other Status Codes	BatchError	De fout van de Batch-service.

Beveiliging

azure_auth

Microsoft Entra OAuth 2.0-verificatiecodestroom

Type: oauth2
Flow: implicit
Authorization URL: https://login.microsoftonline.com/common/oauth2/authorize

Scopes

Name	Description
user_impersonation	Uw gebruikersaccount imiteren

Authorization

Type: apiKey
In: header

Voorbeelden

Add a CloudServiceConfiguration pool

Add a pool with accelerated networking

Add a pool with mount drive specified

Add a pool with SecurityProfile

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 CloudServiceConfiguration pool

Sample Request

HTTP

POST account.region.batch.azure.com/pools?api-version=2023-11-01.18.0



{
  "id": "poolId",
  "vmSize": "small",
  "cloudServiceConfiguration": {
    "osFamily": "4"
  },
  "resizeTimeout": "PT15M",
  "targetDedicatedNodes": 5,
  "targetLowPriorityNodes": 0,
  "taskSlotsPerNode": 3,
  "taskSchedulingPolicy": {
    "nodeFillType": "spread"
  },
  "enableAutoScale": false,
  "enableInterNodeCommunication": true,
  "metadata": [
    {
      "name": "myproperty",
      "value": "myvalue"
    }
  ]
}

Sample Response

Status code:

201

Add a pool with accelerated networking

Sample Request

HTTP

POST account.region.batch.azure.com/pools?api-version=2023-11-01.18.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
  }
}

Sample Response

Status code:

201

Add a pool with mount drive specified

Sample Request

HTTP

POST account.region.batch.azure.com/pools?api-version=2023-11-01.18.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
}

Sample Response

Status code:

201

Add a pool with SecurityProfile

Sample Request

HTTP

POST account.region.batch.azure.com/pools?api-version=2023-11-01.18.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
      }
    }
  },
  "targetDedicatedNodes": 1
}

Sample Response

Status code:

201

Add a simple pool with resourceTags

Sample Request

HTTP

POST account.region.batch.azure.com/pools?api-version=2023-11-01.18.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"
  }
}

Sample Response

Status code:

201

Add a VirtualMachineConfiguration pool

Sample Request

HTTP

POST account.region.batch.azure.com/pools?api-version=2023-11-01.18.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"
    }
  ]
}

Sample Response

Status code:

201

Add a VirtualMachineConfiguration pool with containers

Sample Request

HTTP

POST account.region.batch.azure.com/pools?api-version=2023-11-01.18.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
}

Sample Response

Status code:

201

Add a VirtualMachineConfiguration pool with extensions

Sample Request

HTTP

POST account.region.batch.azure.com/pools?api-version=2023-11-01.18.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"
}

Sample Response

Status code:

201

Add a VirtualMachineConfiguration pool with OS disk

Sample Request

HTTP

POST account.region.batch.azure.com/pools?api-version=2023-11-01.18.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
}

Sample Response

Status code:

201

Add a VirtualMachineConfiguration pool with ServiceArtifactReference

Sample Request

HTTP

POST account.region.batch.azure.com/pools?api-version=2023-11-01.18.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
}

Sample Response

Status code:

201

Definities

Name	Description
ApplicationPackageReference	Een verwijzing naar een pakket dat moet worden geïmplementeerd op rekenknooppunten.
AutoUserScope	Het bereik voor de automatische gebruiker
AutoUserSpecification	Hiermee geeft u de parameters op voor de automatische gebruiker die een taak uitvoert in de Batch-service.
AzureBlobFileSystemConfiguration	Informatie die wordt gebruikt om verbinding te maken met een Azure Storage-container met behulp van Blobfuse.
AzureFileShareConfiguration	Informatie die wordt gebruikt om verbinding te maken met een Azure FileShare.
BatchError	Een foutbericht ontvangen van de Azure Batch-service.
BatchErrorDetail	Een item met aanvullende informatie die is opgenomen in een Azure Batch-foutreactie.
CachingType	Het type caching dat moet worden ingeschakeld voor de schijf.
CertificateReference	Een verwijzing naar een certificaat dat moet worden geïnstalleerd op rekenknooppunten in een pool.
CertificateStoreLocation	De locatie van het certificaatarchief op het rekenknooppunt waarin het certificaat moet worden geïnstalleerd.
CertificateVisibility	Welke gebruikersaccounts op het rekenknooppunt moeten toegang hebben tot de persoonlijke gegevens van het certificaat.
CIFSMountConfiguration	Informatie die wordt gebruikt om verbinding te maken met een CIFS-bestandssysteem.
CloudServiceConfiguration	De configuratie voor rekenknooppunten in een pool op basis van het Azure Cloud Services-platform.
ComputeNodeFillType	Hoe taken worden verdeeld over rekenknooppunten in een pool.
ComputeNodeIdentityReference	De verwijzing naar een door de gebruiker toegewezen identiteit die is gekoppeld aan de Batch-pool die door een rekenknooppunt wordt gebruikt.
ContainerConfiguration	De configuratie voor pools met container.
ContainerRegistry	Een privécontainerregister.
ContainerType	De containertechnologie die moet worden gebruikt.
ContainerWorkingDirectory	De locatie van de werkmap van de containertaak.
DataDisk	Instellingen die worden gebruikt door de gegevensschijven die zijn gekoppeld aan rekenknooppunten in de pool. Wanneer u gekoppelde gegevensschijven gebruikt, moet u de schijven koppelen en formatteren vanuit een virtuele machine om ze te kunnen gebruiken.
DiffDiskPlacement	Hiermee geeft u de tijdelijke schijfplaatsing voor de besturingssysteemschijf voor alle rekenknooppunten (VM's) in de groep op.
DiffDiskSettings	Hiermee geeft u de tijdelijke schijfinstellingen op voor de besturingssysteemschijf die wordt gebruikt door het rekenknooppunt (VM).
DiskEncryptionConfiguration	De schijfversleutelingsconfiguratie die is toegepast op rekenknooppunten in de groep. De configuratie van schijfversleuteling wordt niet ondersteund in een Linux-pool die is gemaakt met azure Compute Gallery-installatiekopie.
DiskEncryptionTarget	De lijst met schijfdoelen batchservice wordt versleuteld op het rekenknooppunt.
DynamicVNetAssignmentScope	Het bereik van dynamische vnet-toewijzing.
ElevationLevel	Het hoogteniveau van de gebruiker.
EnvironmentSetting	Een omgevingsvariabele die moet worden ingesteld voor een taakproces.
ErrorMessage	Een foutbericht ontvangen in een Azure Batch antwoord.
ImageReference	Een verwijzing naar een Azure Virtual Machines Marketplace-installatiekopieën of een Azure Compute Gallery-installatiekopieën. Zie de bewerking Ondersteunde installatiekopieën weergeven voor een lijst met alle Azure Marketplace Afbeeldingsverwijzingen die door Azure Batch zijn geverifieerd.
InboundEndpointProtocol	Het protocol van het eindpunt.
InboundNATPool	Een inkomende NAT-pool die kan worden gebruikt om specifieke poorten op rekenknooppunten in een Batch-pool extern te adresseren.
IPAddressProvisioningType	Het inrichtingstype voor openbare IP-adressen voor de groep.
LinuxUserConfiguration	Eigenschappen die worden gebruikt voor het maken van een gebruikersaccount op een Linux-rekenknooppunt.
LoginMode	De aanmeldingsmodus voor de gebruiker
ManagedDisk
MetadataItem	Een naam-waardepaar dat is gekoppeld aan een Batch-serviceresource.
MountConfiguration	Het bestandssysteem dat aan elk knooppunt moet worden gekoppeld.
NetworkConfiguration	De netwerkconfiguratie voor een pool.
NetworkSecurityGroupRule	Een netwerkbeveiligingsgroepregel die moet worden toegepast op een binnenkomend eindpunt.
NetworkSecurityGroupRuleAccess	De actie die moet worden uitgevoerd voor een opgegeven IP-adres, subnetbereik of tag.
NFSMountConfiguration	Informatie die wordt gebruikt om verbinding te maken met een NFS-bestandssysteem.
NodeCommunicationMode	Bepaalt hoe een pool communiceert met de Batch-service.
NodePlacementConfiguration	Configuratie van knooppuntplaatsing voor een pool.
NodePlacementPolicyType	Het plaatsingsbeleid voor het toewijzen van knooppunten in de pool.
OSDisk	Instellingen voor de besturingssysteemschijf van het rekenknooppunt (VM).
PoolAddParameter	Een pool in de Azure Batch-service om toe te voegen.
PoolEndpointConfiguration	De eindpuntconfiguratie voor een pool.
PublicIPAddressConfiguration	De configuratie van het openbare IP-adres van de netwerkconfiguratie van een pool.
ResourceFile	Eén bestand of meerdere bestanden die moeten worden gedownload naar een rekenknooppunt.
SecurityProfile	Hiermee geeft u de beveiligingsprofielinstellingen voor de virtuele machine of virtuele-machineschaalset op.
SecurityTypes	Hiermee geeft u het SecurityType van de virtuele machine. Deze moet worden ingesteld op een opgegeven waarde om UefiSettings in te schakelen.
ServiceArtifactReference	Hiermee geeft u de referentie-id voor serviceartefacten op die wordt gebruikt om dezelfde versie van de installatiekopieën in te stellen voor alle virtuele machines in de schaalset bij het gebruik van de meest recente versie van de installatiekopieën.
StartTask	Een taak die wordt uitgevoerd wanneer een knooppunt lid wordt van een pool in de Azure Batch-service of wanneer het rekenknooppunt opnieuw wordt opgestart of opnieuw wordt geïnstalleerd.
StorageAccountType	Het opslagaccounttype voor gebruik bij het maken van gegevensschijven of besturingssysteemschijven.
TaskContainerSettings	De containerinstellingen voor een taak.
TaskSchedulingPolicy	Hiermee geeft u op hoe taken moeten worden verdeeld over rekenknooppunten.
UefiSettings	Hiermee geeft u de beveiligingsinstellingen op, zoals beveiligd opstarten en vTPM die worden gebruikt tijdens het maken van de virtuele machine.
UserAccount	Eigenschappen die worden gebruikt om een gebruiker te maken die wordt gebruikt om taken uit te voeren op een Azure Batch-rekenknooppunt.
UserIdentity	De definitie van de gebruikersidentiteit waaronder de taak wordt uitgevoerd.
VirtualMachineConfiguration	De configuratie voor rekenknooppunten in een pool op basis van de Azure Virtual Machines-infrastructuur.
VMExtension	De configuratie voor extensies van virtuele machines.
WindowsConfiguration	Instellingen van het Windows-besturingssysteem die moeten worden toegepast op de virtuele machine.
WindowsUserConfiguration	Eigenschappen die worden gebruikt voor het maken van een gebruikersaccount op een Windows-rekenknooppunt.

ApplicationPackageReference

Een verwijzing naar een pakket dat moet worden geïmplementeerd op rekenknooppunten.

Name	Type	Description
applicationId	string	De id van de toepassing die moet worden geïmplementeerd. Bij het maken van een pool moet de toepassings-id van het pakket volledig zijn gekwalificeerd (/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Batch/batchAccounts/{accountName}/applications/{applicationName}).
version	string	De versie van de toepassing die moet worden geïmplementeerd. Als u dit weglaat, wordt de standaardversie geïmplementeerd. Als dit wordt weggelaten in een pool en er geen standaardversie is opgegeven voor deze toepassing, mislukt de aanvraag met de foutcode InvalidApplicationPackageReferences en HTTP-statuscode 409. Als dit wordt weggelaten in een taak en er geen standaardversie is opgegeven voor deze toepassing, mislukt de taak met een voorverwerkingsfout.

AutoUserScope

Het bereik voor de automatische gebruiker

Name	Type	Description
pool	string	Hiermee geeft u op dat de taak wordt uitgevoerd als het algemene automatische gebruikersaccount dat wordt gemaakt op elk rekenknooppunt in een pool.
task	string	Hiermee geeft u op dat de service een nieuwe gebruiker voor de taak moet maken.

AutoUserSpecification

Hiermee geeft u de parameters op voor de automatische gebruiker die een taak uitvoert in de Batch-service.

Name	Type	Description
elevationLevel	ElevationLevel	Het uitbreidingsniveau van de automatische gebruiker. De standaardwaarde is nonAdmin.
scope	AutoUserScope	Het bereik voor de automatische gebruiker De standaardwaarde is pool. Als in de groep Windows wordt uitgevoerd, moet de waarde Taak worden opgegeven als een striktere isolatie tussen taken vereist is. Bijvoorbeeld als de taak het register muteert op een manier die van invloed kan zijn op andere taken, of als er certificaten zijn opgegeven in de groep die niet toegankelijk moeten zijn voor normale taken, maar toegankelijk moeten zijn door StartTasks.

AzureBlobFileSystemConfiguration

Informatie die wordt gebruikt om verbinding te maken met een Azure Storage-container met behulp van Blobfuse.

Name	Type	Description
accountKey	string	De sleutel van het Azure Storage-account. Deze eigenschap is wederzijds exclusief met zowel sasKey als identiteit; Er moet precies één worden opgegeven.
accountName	string	De naam van het Azure Storage-account.
blobfuseOptions	string	Extra opdrachtregelopties om door te geven aan de koppelingsopdracht. Dit zijn opties voor 'net use' in Windows en 'koppelopties' in Linux.
containerName	string	De Azure Blob Storage containernaam.
identityReference	ComputeNodeIdentityReference	De verwijzing naar de door de gebruiker toegewezen identiteit die moet worden gebruikt voor toegang tot containerName Deze eigenschap is wederzijds exclusief met zowel accountKey als sasKey; Er moet precies één worden opgegeven.
relativeMountPath	string	Het relatieve pad op het rekenknooppunt waar het bestandssysteem wordt gekoppeld Alle bestandssystemen worden gekoppeld ten opzichte van de batch-koppelmap, toegankelijk via de AZ_BATCH_NODE_MOUNTS_DIR omgevingsvariabele.
sasKey	string	Het AZURE Storage SAS-token. Deze eigenschap is wederzijds exclusief met zowel accountKey als identiteit; Er moet precies één worden opgegeven.

AzureFileShareConfiguration

Informatie die wordt gebruikt om verbinding te maken met een Azure FileShare.

Name	Type	Description
accountKey	string	De sleutel van het Azure Storage-account.
accountName	string	De naam van het Azure Storage-account.
azureFileUrl	string	De URL van Azure Files. Dit heeft de vorm 'https://{account}.file.core.windows.net/'.
mountOptions	string	Extra opdrachtregelopties om door te geven aan de koppelingsopdracht. Dit zijn opties voor 'net use' in Windows en 'koppelopties' in Linux.
relativeMountPath	string	Het relatieve pad op het rekenknooppunt waar het bestandssysteem wordt gekoppeld Alle bestandssystemen worden gekoppeld ten opzichte van de batch-koppelmap, toegankelijk via de AZ_BATCH_NODE_MOUNTS_DIR omgevingsvariabele.

BatchError

Een foutbericht ontvangen van de Azure Batch-service.

Name	Type	Description
code	string	Een id voor de fout. Codes zijn invariant en zijn bedoeld om programmatisch te worden gebruikt.
message	ErrorMessage	Een bericht met een beschrijving van de fout, bedoeld om te worden weergegeven in een gebruikersinterface.
values	BatchErrorDetail[]	Een verzameling sleutel-waardeparen met aanvullende informatie over de fout.

BatchErrorDetail

Een item met aanvullende informatie die is opgenomen in een Azure Batch-foutreactie.

Name	Type	Description
key	string	Een id die de betekenis van de eigenschap Value aangeeft.
value	string	De aanvullende informatie die is opgenomen in de foutreactie.

CachingType

Het type caching dat moet worden ingeschakeld voor de schijf.

Name	Type	Description
none	string	De cachemodus voor de schijf is niet ingeschakeld.
readonly	string	De cachemodus voor de schijf is alleen-lezen.
readwrite	string	De cachemodus voor de schijf is lezen en schrijven.

CertificateReference

Een verwijzing naar een certificaat dat moet worden geïnstalleerd op rekenknooppunten in een pool.

Name	Type	Description
storeLocation	CertificateStoreLocation	De locatie van het certificaatarchief op het rekenknooppunt waarin het certificaat moet worden geïnstalleerd. De standaardwaarde is currentuser. Deze eigenschap is alleen van toepassing op pools die zijn geconfigureerd met Windows-rekenknooppunten (dat wil gezegd, gemaakt met cloudServiceConfiguration of met virtualMachineConfiguration met behulp van een Verwijzing naar windows-installatiekopieën). Voor Linux-rekenknooppunten worden de certificaten opgeslagen in een map in de werkmap Taak en wordt een omgevingsvariabele AZ_BATCH_CERTIFICATES_DIR opgegeven bij de taak om een query uit te voeren op deze locatie. Voor certificaten met zichtbaarheid van 'remoteUser' wordt een map met certificaten gemaakt in de basismap van de gebruiker (bijvoorbeeld /home/{user-name}/certs) en worden certificaten in die map geplaatst.
storeName	string	De naam van het certificaatarchief op het rekenknooppunt waarin het certificaat moet worden geïnstalleerd. Deze eigenschap is alleen van toepassing op pools die zijn geconfigureerd met Windows-rekenknooppunten (dat wil gezegd, gemaakt met cloudServiceConfiguration of met virtualMachineConfiguration met behulp van een Verwijzing naar windows-installatiekopieën). Algemene winkelnamen zijn: My, Root, CA, Trust, Disallowed, TrustedPeople, TrustedPublisher, AuthRoot, AddressBook, maar elke aangepaste winkelnaam kan ook worden gebruikt. De standaardwaarde is Mijn.
thumbprint	string	De vingerafdruk van het certificaat.
thumbprintAlgorithm	string	Het algoritme waaraan de vingerafdruk is gekoppeld. Dit moet sha1 zijn.
visibility	CertificateVisibility[]	Welke gebruikersaccounts op het rekenknooppunt moeten toegang hebben tot de persoonlijke gegevens van het certificaat. U kunt meer dan één zichtbaarheid in deze verzameling opgeven. De standaardwaarde is alle accounts.

CertificateStoreLocation

De locatie van het certificaatarchief op het rekenknooppunt waarin het certificaat moet worden geïnstalleerd.

Name	Type	Description
currentuser	string	Certificaten moeten worden geïnstalleerd in het currentuser-certificaatarchief.
localmachine	string	Certificaten moeten worden geïnstalleerd in het LocalMachine-certificaatarchief.

CertificateVisibility

Welke gebruikersaccounts op het rekenknooppunt moeten toegang hebben tot de persoonlijke gegevens van het certificaat.

Name	Type	Description
remoteuser	string	Het certificaat moet zichtbaar zijn voor de gebruikersaccounts waaronder gebruikers op afstand toegang hebben tot het rekenknooppunt.
starttask	string	Het certificaat moet zichtbaar zijn voor het gebruikersaccount waaronder de StartTask wordt uitgevoerd. Houd er rekening mee dat als AutoUser-bereik pool is voor zowel de StartTask als een taak, dit certificaat ook zichtbaar is voor de taak.
task	string	Het certificaat moet zichtbaar zijn voor de gebruikersaccounts waaronder taaktaken worden uitgevoerd.

CIFSMountConfiguration

Informatie die wordt gebruikt om verbinding te maken met een CIFS-bestandssysteem.

Name	Type	Description
mountOptions	string	Extra opdrachtregelopties om door te geven aan de koppelingsopdracht. Dit zijn opties voor 'net use' in Windows en 'koppelopties' in Linux.
password	string	Het wachtwoord dat moet worden gebruikt voor verificatie met het CIFS-bestandssysteem.
relativeMountPath	string	Het relatieve pad op het rekenknooppunt waar het bestandssysteem wordt gekoppeld Alle bestandssystemen worden gekoppeld ten opzichte van de batch-koppelmap, toegankelijk via de AZ_BATCH_NODE_MOUNTS_DIR omgevingsvariabele.
source	string	De URI van het bestandssysteem dat moet worden gekoppeld.
username	string	De gebruiker die moet worden gebruikt voor verificatie met het CIFS-bestandssysteem.

CloudServiceConfiguration

De configuratie voor rekenknooppunten in een pool op basis van het Azure Cloud Services-platform.

Name	Type	Description
osFamily	string	De Azure-gastbesturingssysteemfamilie die moet worden geïnstalleerd op de virtuele machines in de pool. Mogelijke waarden zijn: 2 - OS-familie 2, gelijk aan Windows Server 2008 R2 SP1. 3 - OS-familie 3, gelijk aan Windows Server 2012. 4 - OS-familie 4, gelijk aan Windows Server 2012 R2. 5 - OS-familie 5, gelijk aan Windows Server 2016. 6 - OS-familie 6, equivalent aan Windows Server 2019. Zie Azure-gastbesturingssystemen (https://azure.microsoft.com/documentation/articles/cloud-services-guestos-update-matrix/#releases) voor meer informatie.
osVersion	string	De versie van het Azure-gastbesturingssystemen die moet worden geïnstalleerd op de virtuele machines in de pool. De standaardwaarde is * waarmee de meest recente versie van het besturingssysteem voor de opgegeven besturingssysteemfamilie wordt opgegeven.

ComputeNodeFillType

Hoe taken worden verdeeld over rekenknooppunten in een pool.

Name	Type	Description
pack	string	Er moeten zoveel mogelijk taken (taskSlotsPerNode) worden toegewezen aan elk rekenknooppunt in de pool voordat taken worden toegewezen aan het volgende rekenknooppunt in de pool.
spread	string	Taken moeten gelijkmatig worden toegewezen aan alle rekenknooppunten in de pool.

ComputeNodeIdentityReference

De verwijzing naar een door de gebruiker toegewezen identiteit die is gekoppeld aan de Batch-pool die door een rekenknooppunt wordt gebruikt.

Name	Type	Description
resourceId	string	De ARM-resource-id van de door de gebruiker toegewezen identiteit.

ContainerConfiguration

De configuratie voor pools met container.

Name	Type	Description
containerImageNames	string[]	De verzameling containerinstallatiekopieën. Dit is de volledige installatiekopiereferentie, zoals wordt opgegeven bij 'docker pull'. Een installatiekopieën worden opgehaald uit het standaard Docker-register, tenzij de installatiekopieën volledig zijn gekwalificeerd met een alternatief register.
containerRegistries	ContainerRegistry[]	Aanvullende privéregisters waaruit containers kunnen worden opgehaald. Als installatiekopieën moeten worden gedownload uit een privéregister waarvoor referenties zijn vereist, moeten deze referenties hier worden opgegeven.
type	ContainerType	De te gebruiken containertechnologie.

ContainerRegistry

Een privécontainerregister.

Name	Type	Description
identityReference	ComputeNodeIdentityReference	De verwijzing naar de door de gebruiker toegewezen identiteit die moet worden gebruikt voor toegang tot een Azure Container Registry in plaats van gebruikersnaam en wachtwoord. De verwijzing naar een door de gebruiker toegewezen identiteit die is gekoppeld aan de Batch-pool die door een rekenknooppunt wordt gebruikt.
password	string	Het wachtwoord om u aan te melden bij de registerserver.
registryServer	string	De register-URL. Als u dit weglaat, is de standaardwaarde 'docker.io'.
username	string	De gebruikersnaam om u aan te melden bij de registerserver.

ContainerType

De containertechnologie die moet worden gebruikt.

Name	Type	Description
criCompatible	string	Er wordt een op CRI gebaseerde technologie gebruikt om de containers te starten.
dockerCompatible	string	Er wordt een docker-compatibele containertechnologie gebruikt om de containers te starten.

ContainerWorkingDirectory

De locatie van de werkmap van de containertaak.

Name	Type	Description
containerImageDefault	string	Gebruik de werkmap die is gedefinieerd in de containerinstallatiekopieën. Pas op dat deze map niet de resourcebestanden bevat die door Batch zijn gedownload.
taskWorkingDirectory	string	Gebruik de standaardwerkmap taak van de Batch-service, die de taakbronbestanden bevat die door Batch worden ingevuld.

DataDisk

Instellingen die worden gebruikt door de gegevensschijven die zijn gekoppeld aan rekenknooppunten in de pool. Wanneer u gekoppelde gegevensschijven gebruikt, moet u de schijven koppelen en formatteren vanuit een virtuele machine om ze te kunnen gebruiken.

Name	Type	Description
caching	CachingType	Het type caching dat moet worden ingeschakeld voor de gegevensschijven. De standaardwaarde voor opslaan in cache is readwrite. Zie voor meer informatie over de cacheopties: https://blogs.msdn.microsoft.com/windowsazurestorage/2012/06/27/exploring-windows-azure-drives-disks-and-images/.
diskSizeGB	integer	De initiële schijfgrootte in gigabytes.
lun	integer	Het logische eenheidsnummer. De lun wordt gebruikt om elke gegevensschijf uniek te identificeren. Als u meerdere schijven koppelt, moet elk een afzonderlijke lun hebben. De waarde moet tussen 0 en 63 liggen, inclusief.
storageAccountType	StorageAccountType	Het type opslagaccount dat moet worden gebruikt voor de gegevensschijf. Als u dit weglaat, is de standaardwaarde 'standard_lrs'.

DiffDiskPlacement

Hiermee geeft u de tijdelijke schijfplaatsing voor de besturingssysteemschijf voor alle rekenknooppunten (VM's) in de groep op.

Name	Type	Description
CacheDisk	string	De tijdelijke besturingssysteemschijf wordt opgeslagen in de VM-cache.

DiffDiskSettings

Hiermee geeft u de tijdelijke schijfinstellingen op voor de besturingssysteemschijf die wordt gebruikt door het rekenknooppunt (VM).

Name	Type	Description
placement	DiffDiskPlacement	Hiermee geeft u de tijdelijke schijfplaatsing voor de besturingssysteemschijf voor alle VM's in de groep. Deze eigenschap kan door de gebruiker in de aanvraag worden gebruikt om de locatie te kiezen, bijvoorbeeld cacheschijfruimte voor tijdelijke inrichting van besturingssysteemschijven. Raadpleeg voor meer informatie over de vereisten voor de schijfgrootte van een kortstondige besturingssysteemschijf voor Windows-VM's op https://docs.microsoft.com/en-us/azure/virtual-machines/windows/ephemeral-os-disks#size-requirements en Linux-VM's op https://docs.microsoft.com/en-us/azure/virtual-machines/linux/ephemeral-os-disks#size-requirements.

DiskEncryptionConfiguration

De schijfversleutelingsconfiguratie die is toegepast op rekenknooppunten in de groep. De configuratie van schijfversleuteling wordt niet ondersteund in een Linux-pool die is gemaakt met azure Compute Gallery-installatiekopie.

Name	Type	Description
targets	DiskEncryptionTarget[]	De lijst met schijfdoelen Batch Service wordt versleuteld op het rekenknooppunt. Als u dit weglaat, worden er geen schijven op de rekenknooppunten in de pool versleuteld. In Een Linux-pool wordt alleen 'TemporaryDisk' ondersteund; op Windows-pool moeten 'OsDisk' en 'TemporaryDisk' worden opgegeven.

DiskEncryptionTarget

De lijst met schijfdoelen batchservice wordt versleuteld op het rekenknooppunt.

Name	Type	Description
osdisk	string	De besturingssysteemschijf op het rekenknooppunt is versleuteld.
temporarydisk	string	De tijdelijke schijf op het rekenknooppunt is versleuteld. Op Linux is deze versleuteling van toepassing op andere partities (zoals partities op gekoppelde gegevensschijven) wanneer versleuteling plaatsvindt tijdens het opstarten.

DynamicVNetAssignmentScope

Het bereik van dynamische vnet-toewijzing.

Name	Type	Description
job	string	Dynamische VNet-toewijzing wordt per taak uitgevoerd.
none	string	Er is geen dynamische VNet-toewijzing ingeschakeld.

ElevationLevel

Het hoogteniveau van de gebruiker.

Name	Type	Description
admin	string	De gebruiker is een gebruiker met verhoogde toegang en werkt met volledige beheerdersmachtigingen.
nonadmin	string	De gebruiker is een standaardgebruiker zonder verhoogde toegang.

EnvironmentSetting

Een omgevingsvariabele die moet worden ingesteld voor een taakproces.

Name	Type	Description
name	string	De naam van de omgevingsvariabele.
value	string	De waarde van de omgevingsvariabele.

ErrorMessage

Een foutbericht ontvangen in een Azure Batch antwoord.

Name	Type	Description
lang	string	De taalcode van het foutbericht
value	string	De tekst van het bericht.

ImageReference

Een verwijzing naar een Azure Virtual Machines Marketplace-installatiekopieën of een Azure Compute Gallery-installatiekopieën. Zie de bewerking Ondersteunde installatiekopieën weergeven voor een lijst met alle Azure Marketplace Afbeeldingsverwijzingen die door Azure Batch zijn geverifieerd.

Name	Type	Description
exactVersion	string	De specifieke versie van de platforminstallatiekopieën of marketplace-installatiekopieën die worden gebruikt om het knooppunt te maken. Dit alleen-lezenveld verschilt alleen van 'versie' als de waarde die is opgegeven voor 'versie' toen de pool werd gemaakt, 'meest recente' was.
offer	string	Het aanbiedingstype van de Azure Virtual Machines Marketplace-installatiekopieën. Bijvoorbeeld UbuntuServer of WindowsServer.
publisher	string	De uitgever van de Azure Virtual Machines Marketplace-installatiekopieën. Bijvoorbeeld Canonical of MicrosoftWindowsServer.
sku	string	De SKU van de Azure Virtual Machines Marketplace-installatiekopieën. Bijvoorbeeld 18.04-LTS of 2019-Datacenter.
version	string	De versie van de Azure Virtual Machines Marketplace-installatiekopieën. De waarde 'nieuwste' kan worden opgegeven om de nieuwste versie van een installatiekopieën te selecteren. Als u dit weglaat, is de standaardwaarde 'nieuwste'.
virtualMachineImageId	string	De ARM-resource-id van de installatiekopieën van de Azure Compute Gallery. Rekenknooppunten in de pool worden gemaakt met behulp van deze installatiekopieën-id. Dit heeft de vorm /subscriptions/{subscriptionId}/resourceGroups/{resourceGroup}/providers/Microsoft.Compute/galleries/{galleryName}/images/{imageDefinitionName}/versions/{VersionId} of /subscriptions/{subscriptionId}/resourceGroups/{resourceGroup}/providers/Microsoft.Compute/galleries/{galleryName}/images/{imageDefinitionName} om altijd de meest recente versie van de installatiekopie te gebruiken. Deze eigenschap is wederzijds exclusief met andere ImageReference-eigenschappen. De installatiekopieën van de Azure Compute Gallery moeten replica's in dezelfde regio hebben en moeten zich in hetzelfde abonnement bevinden als het Azure Batch-account. Als de versie van de installatiekopieën niet is opgegeven in de imageId, wordt de meest recente versie gebruikt. Zie voor informatie over de firewallinstellingen voor de Batch Compute Node-agent om te communiceren met de Batch-service https://docs.microsoft.com/en-us/azure/batch/batch-api-basics#virtual-network-vnet-and-firewall-configuration.

InboundEndpointProtocol

Het protocol van het eindpunt.

Name	Type	Description
tcp	string	Gebruik TCP voor het eindpunt.
udp	string	Gebruik UDP voor het eindpunt.

InboundNATPool

Een inkomende NAT-pool die kan worden gebruikt om specifieke poorten op rekenknooppunten in een Batch-pool extern te adresseren.

Name	Type	Description
backendPort	integer	Het poortnummer op het rekenknooppunt. Dit moet uniek zijn binnen een Batch-pool. Acceptabele waarden liggen tussen 1 en 65535, met uitzondering van 22, 3389, 29876 en 29877, omdat deze zijn gereserveerd. Als er gereserveerde waarden worden opgegeven, mislukt de aanvraag met HTTP-statuscode 400.
frontendPortRangeEnd	integer	Het laatste poortnummer in het bereik van externe poorten dat wordt gebruikt om binnenkomende toegang te bieden tot de backendPort op afzonderlijke rekenknooppunten. Acceptabele waarden liggen tussen 1 en 65534, met uitzondering van poorten van 50000 tot 55000 die zijn gereserveerd door de Batch-service. Alle bereiken binnen een pool moeten verschillend zijn en mogen elkaar niet overlappen. Elk bereik moet ten minste 40 poorten bevatten. Als er gereserveerde of overlappende waarden worden opgegeven, mislukt de aanvraag met HTTP-statuscode 400.
frontendPortRangeStart	integer	Het eerste poortnummer in het bereik van externe poorten dat wordt gebruikt om binnenkomende toegang te bieden tot de backendPort op afzonderlijke rekenknooppunten. Acceptabele waarden liggen tussen 1 en 65534, met uitzondering van poorten van 50000 tot 55000 die zijn gereserveerd. Alle bereiken binnen een pool moeten verschillend zijn en mogen elkaar niet overlappen. Elk bereik moet ten minste 40 poorten bevatten. Als er gereserveerde of overlappende waarden worden opgegeven, mislukt de aanvraag met HTTP-statuscode 400.
name	string	De naam van het eindpunt. De naam moet uniek zijn binnen een Batch-pool en mag letters, cijfers, onderstrepingstekens, punten en afbreekstreepjes bevatten. Namen moeten beginnen met een letter of cijfer, moeten eindigen op een letter, cijfer of onderstrepingsteken en mogen niet langer zijn dan 77 tekens. Als er ongeldige waarden worden opgegeven, mislukt de aanvraag met HTTP-statuscode 400.
networkSecurityGroupRules	NetworkSecurityGroupRule[]	Een lijst met netwerkbeveiligingsgroepsregels die worden toegepast op het eindpunt. Het maximum aantal regels dat kan worden opgegeven voor alle eindpunten in een Batch-pool is 25. Als er geen regels voor netwerkbeveiligingsgroepen zijn opgegeven, wordt er een standaardregel gemaakt om binnenkomende toegang tot de opgegeven backendPort toe te staan. Als het maximum aantal regels voor netwerkbeveiligingsgroepen wordt overschreden, mislukt de aanvraag met HTTP-statuscode 400.
protocol	InboundEndpointProtocol	Het protocol van het eindpunt.

IPAddressProvisioningType

Het inrichtingstype voor openbare IP-adressen voor de groep.

Name	Type	Description
batchmanaged	string	Er wordt een openbaar IP-adres gemaakt en beheerd door Batch. Er kunnen meerdere openbare IP-adressen zijn, afhankelijk van de grootte van de pool.
nopublicipaddresses	string	Er wordt geen openbaar IP-adres gemaakt.
usermanaged	string	Openbare IP-adressen worden geleverd door de gebruiker en worden gebruikt om de rekenknooppunten in te richten.

LinuxUserConfiguration

Eigenschappen die worden gebruikt voor het maken van een gebruikersaccount op een Linux-rekenknooppunt.

Name	Type	Description
gid	integer	De groeps-id voor het gebruikersaccount. De eigenschappen uid en gid moeten samen worden opgegeven of helemaal niet. Als dit niet is opgegeven, kiest het onderliggende besturingssysteem de gid.
sshPrivateKey	string	De persoonlijke SSH-sleutel voor het gebruikersaccount. De persoonlijke sleutel mag niet met een wachtwoord zijn beveiligd. De persoonlijke sleutel wordt gebruikt voor het automatisch configureren van verificatie op basis van asymmetrische sleutels voor SSH tussen rekenknooppunten in een Linux-pool wanneer de eigenschap enableInterNodeCommunication van de pool waar is (deze wordt genegeerd als enableInterNodeCommunication onwaar is). Dit doet u door het sleutelpaar in de .ssh-map van de gebruiker te plaatsen. Als dit niet is opgegeven, wordt SSH zonder wachtwoord niet geconfigureerd tussen rekenknooppunten (er wordt geen wijziging van de .ssh-map van de gebruiker uitgevoerd).
uid	integer	De gebruikers-id van het gebruikersaccount. De eigenschappen uid en gid moeten samen worden opgegeven of helemaal niet. Als dit niet is opgegeven, kiest het onderliggende besturingssysteem de uid.

LoginMode

De aanmeldingsmodus voor de gebruiker

Name	Type	Description
batch	string	De LOGON32_LOGON_BATCH Win32-aanmeldingsmodus. De modus batchaanmelding wordt aanbevolen voor langdurige parallelle processen.
interactive	string	De LOGON32_LOGON_INTERACTIVE Win32-aanmeldingsmodus. UAC is ingeschakeld voor Windows VirtualMachineConfiguration Pools. Als deze optie wordt gebruikt met een gebruikersidentiteit met verhoogde bevoegdheid in een Windows VirtualMachineConfiguration-pool, wordt de gebruikerssessie niet verhoogd, tenzij de toepassing die wordt uitgevoerd door de taakopdrachtregel is geconfigureerd om altijd beheerdersbevoegdheden te vereisen of om altijd maximale bevoegdheden te vereisen.

ManagedDisk

Name	Type	Description
storageAccountType	StorageAccountType	Het opslagaccounttype voor de beheerde schijf.

MetadataItem

Een naam-waardepaar dat is gekoppeld aan een Batch-serviceresource.

Name	Type	Description
name	string	De naam van het metagegevensitem.
value	string	De waarde van het metagegevensitem.

MountConfiguration

Het bestandssysteem dat aan elk knooppunt moet worden gekoppeld.

Name	Type	Description
azureBlobFileSystemConfiguration	AzureBlobFileSystemConfiguration	De Azure Storage-container die moet worden gekoppeld met behulp van blob FUSE op elk knooppunt. Deze eigenschap is wederzijds exclusief met alle andere eigenschappen.
azureFileShareConfiguration	AzureFileShareConfiguration	De Azure-bestandsshare die aan elk knooppunt moet worden gekoppeld. Deze eigenschap is wederzijds exclusief met alle andere eigenschappen.
cifsMountConfiguration	CIFSMountConfiguration	Het CIFS/SMB-bestandssysteem dat aan elk knooppunt moet worden gekoppeld. Deze eigenschap is wederzijds exclusief met alle andere eigenschappen.
nfsMountConfiguration	NFSMountConfiguration	Het NFS-bestandssysteem dat aan elk knooppunt moet worden gekoppeld. Deze eigenschap is wederzijds exclusief met alle andere eigenschappen.

NetworkConfiguration

De netwerkconfiguratie voor een pool.

Name	Type	Description
dynamicVNetAssignmentScope	DynamicVNetAssignmentScope	Het bereik van dynamische vnet-toewijzing.
enableAcceleratedNetworking	boolean	Of deze pool versneld netwerken moet inschakelen. Versneld netwerken maakt I/O-virtualisatie met één hoofdmap (SR-IOV) mogelijk voor een VM, wat kan leiden tot betere netwerkprestaties. Zie https://learn.microsoft.com/azure/virtual-network/accelerated-networking-overview voor meer informatie.
endpointConfiguration	PoolEndpointConfiguration	De configuratie voor eindpunten op rekenknooppunten in de Batch-pool. Configuratie van pooleindpunten wordt alleen ondersteund in pools met de eigenschap virtualMachineConfiguration.
publicIPAddressConfiguration	PublicIPAddressConfiguration	De configuratie van het openbare IP-adres voor rekenknooppunten in de Batch-pool. De eigenschap Openbare IP-configuratie wordt alleen ondersteund in pools met de eigenschap virtualMachineConfiguration.
subnetId	string	De ARM-resource-id van het subnet van het virtuele netwerk waaraan de rekenknooppunten van de pool worden toegevoegd. Dit heeft de vorm /subscriptions/{subscription}/resourceGroups/{group}/providers/{provider}/virtualNetworks/{network}/subnets/{subnet}. Het virtuele netwerk moet zich in dezelfde regio en hetzelfde abonnement bevinden als het Azure Batch-account. Het opgegeven subnet moet voldoende vrije IP-adressen hebben voor het aantal rekenknooppunten in de groep. Als het subnet onvoldoende vrije IP-adressen heeft, wijst de groep gedeeltelijk knooppunten toe en treedt er een fout bij het wijzigen van het formaat op. De service-principal 'MicrosoftAzureBatch' moet de rol 'Inzender voor klassieke virtuele machines' Role-Based Access Control (RBAC) hebben voor het opgegeven VNet. Het opgegeven subnet moet communicatie van de Azure Batch service toestaan om taken op de knooppunten te kunnen plannen. Dit kan worden gecontroleerd door te controleren of het opgegeven VNet gekoppelde netwerkbeveiligingsgroepen (NSG's) heeft. Als communicatie met de knooppunten in het opgegeven subnet wordt geweigerd door een NSG, stelt de Batch-service de status van de rekenknooppunten in op onbruikbaar. Voor pools die zijn gemaakt met virtualMachineConfiguration worden alleen virtuele ARM-netwerken ('Microsoft.Network/virtualNetworks') ondersteund, maar voor pools die zijn gemaakt met cloudServiceConfiguration worden zowel ARM- als klassieke virtuele netwerken ondersteund. Als aan het opgegeven VNet NSG’s (netwerkbeveiligingsgroepen) zijn gekoppeld, moeten een paar gereserveerde poorten worden ingeschakeld voor binnenkomende communicatie. Schakel voor pools die zijn gemaakt met een virtuele-machineconfiguratie de poorten 29876 en 29877 in, evenals poort 22 voor Linux en poort 3389 voor Windows. Schakel voor pools die zijn gemaakt met een cloudserviceconfiguratie de poorten 10100, 20100 en 30100 in. Schakel ook uitgaande verbindingen met Azure Storage in op poort 443. Zie voor meer informatie: https://docs.microsoft.com/en-us/azure/batch/batch-api-basics#virtual-network-vnet-and-firewall-configuration

NetworkSecurityGroupRule

Een netwerkbeveiligingsgroepregel die moet worden toegepast op een binnenkomend eindpunt.

Name	Type	Description
access	NetworkSecurityGroupRuleAccess	De actie die moet worden uitgevoerd voor een opgegeven IP-adres, subnetbereik of tag.
priority	integer	De prioriteit voor deze regel. Prioriteiten binnen een pool moeten uniek zijn en worden geëvalueerd in volgorde van prioriteit. Hoe lager het getal, hoe hoger de prioriteit. Regels kunnen bijvoorbeeld worden opgegeven met volgnummers van 150, 250 en 350. De regel met het volgordenummer 150 heeft voorrang op de regel met een volgorde van 250. Toegestane prioriteiten zijn 150 tot 4096. Als er gereserveerde of dubbele waarden worden opgegeven, mislukt de aanvraag met HTTP-statuscode 400.
sourceAddressPrefix	string	Het bronadresvoorvoegsel of de tag die overeenkomt met de regel. Geldige waarden zijn één IP-adres (bijvoorbeeld 10.10.10.10), IP-subnet (bijvoorbeeld 192.168.1.0/24), standaardtag of * (voor alle adressen). Als er andere waarden worden opgegeven, mislukt de aanvraag met HTTP-statuscode 400.
sourcePortRanges	string[]	De bronpoortbereiken die overeenkomen met de regel. Geldige waarden zijn '' (voor alle poorten 0 - 65535), een specifieke poort (bijvoorbeeld 22) of een poortbereik (100-200). De poorten moeten tussen 0 en 65535 liggen. Elke vermelding in deze verzameling mag geen andere vermelding overlappen (een bereik of een afzonderlijke poort). Als er andere waarden worden opgegeven, mislukt de aanvraag met HTTP-statuscode 400. De standaardwaarde is ''.

NetworkSecurityGroupRuleAccess

De actie die moet worden uitgevoerd voor een opgegeven IP-adres, subnetbereik of tag.

Name	Type	Description
allow	string	Toegang toestaan.
deny	string	Toegang weigeren.

NFSMountConfiguration

Informatie die wordt gebruikt om verbinding te maken met een NFS-bestandssysteem.

Name	Type	Description
mountOptions	string	Extra opdrachtregelopties om door te geven aan de koppelingsopdracht. Dit zijn opties voor 'net use' in Windows en 'koppelopties' in Linux.
relativeMountPath	string	Het relatieve pad op het rekenknooppunt waar het bestandssysteem wordt gekoppeld Alle bestandssystemen worden gekoppeld ten opzichte van de batch-koppelmap, toegankelijk via de AZ_BATCH_NODE_MOUNTS_DIR omgevingsvariabele.
source	string	De URI van het bestandssysteem dat moet worden gekoppeld.

NodeCommunicationMode

Bepaalt hoe een pool communiceert met de Batch-service.

Name	Type	Description
classic	string	Voor knooppunten die de klassieke communicatiemodus gebruiken, is binnenkomende TCP-communicatie vereist op poorten 29876 en 29877 van batchnodemanagement. Servicetag {region} en uitgaande TCP-communicatie op poort 443 naar storage.region en BatchNodeManagement. {region}'-servicetags.
default	string	De communicatiemodus voor het knooppunt wordt automatisch ingesteld door de Batch-service.
simplified	string	Knooppunten die de vereenvoudigde communicatiemodus gebruiken, vereisen uitgaande TCP-communicatie op poort 443 naar batchnodemanagement. Servicetag {region}. Er zijn geen open binnenkomende poorten vereist.

NodePlacementConfiguration

Configuratie van knooppuntplaatsing voor een pool.

Name	Type	Description
policy	NodePlacementPolicyType	Type beleid voor knooppuntplaatsing in Batch-pools. Toewijzingsbeleid dat door Batch Service wordt gebruikt om de knooppunten in te richten. Als dit niet is opgegeven, gebruikt Batch het regionale beleid.

NodePlacementPolicyType

Het plaatsingsbeleid voor het toewijzen van knooppunten in de pool.

Name	Type	Description
regional	string	Alle knooppunten in de pool worden toegewezen in dezelfde regio.
zonal	string	Knooppunten in de pool worden verdeeld over verschillende beschikbaarheidszones met best effort balancing.

OSDisk

Instellingen voor de besturingssysteemschijf van het rekenknooppunt (VM).

Name	Type	Description
caching	CachingType	Hiermee geeft u de cachevereisten op. Mogelijke waarden zijn: None, ReadOnly, ReadWrite. De standaardwaarden zijn: Geen voor Standard-opslag. ReadOnly voor Premium-opslag. De standaardwaarde voor opslaan in de cache is geen. Zie voor meer informatie over de cacheopties: https://blogs.msdn.microsoft.com/windowsazurestorage/2012/06/27/exploring-windows-azure-drives-disks-and-images/.
diskSizeGB	integer	De initiële schijfgrootte in GB bij het maken van een nieuwe besturingssysteemschijf.
ephemeralOSDiskSettings	DiffDiskSettings	Hiermee geeft u de tijdelijke schijfinstellingen voor de besturingssysteemschijf die wordt gebruikt door het rekenknooppunt (VM).
managedDisk	ManagedDisk	De parameters van de beheerde schijf.
writeAcceleratorEnabled	boolean	Hiermee geeft u op of writeAccelerator moet worden in- of uitgeschakeld op de schijf.

PoolAddParameter

Een pool in de Azure Batch-service om toe te voegen.

Name	Type	Description
applicationLicenses	string[]	De lijst met toepassingslicenties die de Batch-service beschikbaar maakt op elk rekenknooppunt in de pool. De lijst met toepassingslicenties moet een subset zijn van beschikbare batchservicetoepassingslicenties. Als een licentie wordt aangevraagd die niet wordt ondersteund, mislukt het maken van de pool.
applicationPackageReferences	ApplicationPackageReference[]	De lijst met pakketten die moeten worden geïnstalleerd op elk rekenknooppunt in de pool. Bij het maken van een pool moet de toepassings-id van het pakket volledig zijn gekwalificeerd (/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Batch/batchAccounts/{accountName}/applications/{applicationName}). Wijzigingen in pakketverwijzingen zijn van invloed op alle nieuwe knooppunten die lid worden van de pool, maar hebben geen invloed op rekenknooppunten die zich al in de pool bevinden totdat ze opnieuw worden opgestart of opnieuw worden geïnstalleerd. Er zijn maximaal 10 pakketverwijzingen voor een bepaalde pool.
autoScaleEvaluationInterval	string	Het tijdsinterval waarmee de poolgrootte automatisch moet worden aangepast op basis van de formule voor automatische schaalaanpassing. De standaardwaarde is 15 minuten. De minimum- en maximumwaarde zijn respectievelijk 5 minuten en 168 uur. Als u een waarde opgeeft van minder dan 5 minuten of meer dan 168 uur, retourneert de Batch-service een fout; Als u de REST API rechtstreeks aanroept, is de HTTP-statuscode 400 (ongeldige aanvraag).
autoScaleFormula	string	Een formule voor het gewenste aantal rekenknooppunten in de pool. Deze eigenschap mag niet worden opgegeven als enableAutoScale is ingesteld op false. Dit is vereist als enableAutoScale is ingesteld op true. De formule wordt gecontroleerd op geldigheid voordat de pool wordt gemaakt. Als de formule ongeldig is, weigert de Batch-service de aanvraag met gedetailleerde foutinformatie. Zie Rekenknooppunten automatisch schalen in een Azure Batch pool (https://azure.microsoft.com/documentation/articles/batch-automatic-scaling/) voor meer informatie over het opgeven van deze formule.
certificateReferences	CertificateReference[]	De lijst met certificaten die moeten worden geïnstalleerd op elk rekenknooppunt in de pool. Voor Windows-knooppunten installeert de Batch-service de certificaten in het opgegeven certificaatarchief en de opgegeven locatie. Voor Linux-rekenknooppunten worden de certificaten opgeslagen in een map in de werkmap Taak en wordt een omgevingsvariabele AZ_BATCH_CERTIFICATES_DIR opgegeven bij de taak om een query uit te voeren op deze locatie. Voor certificaten met zichtbaarheid van 'remoteUser' wordt een map met certificaten gemaakt in de basismap van de gebruiker (bijvoorbeeld /home/{user-name}/certs) en worden certificaten in die map geplaatst. Waarschuwing: deze eigenschap is afgeschaft en wordt na februari 2024 verwijderd. Gebruik in plaats daarvan de Azure KeyVault-extensie .
cloudServiceConfiguration	CloudServiceConfiguration	De cloudserviceconfiguratie voor de pool. Deze eigenschap en virtualMachineConfiguration sluiten elkaar wederzijds uit en een van de eigenschappen moet worden opgegeven. Deze eigenschap kan niet worden opgegeven als het Batch-account is gemaakt met de eigenschap poolAllocationMode ingesteld op UserSubscription.
displayName	string	De weergavenaam voor de pool. De weergavenaam hoeft niet uniek te zijn en mag Unicode-tekens bevatten tot een maximale lengte van 1024.
enableAutoScale	boolean	Of de poolgrootte automatisch moet worden aangepast in de loop van de tijd. Indien onwaar, moet ten minste één van de targetDedicatedNodes en targetLowPriorityNodes worden opgegeven. Als dit waar is, is de eigenschap autoScaleFormula vereist en wordt de grootte van de pool automatisch aangepast aan de formule. De standaardwaarde is false.
enableInterNodeCommunication	boolean	Of de pool directe communicatie tussen rekenknooppunten toestaat. Als u communicatie tussen knooppunten inschakelt, wordt de maximale grootte van de pool beperkt vanwege implementatiebeperkingen op de rekenknooppunten van de pool. Dit kan ertoe leiden dat de pool de gewenste grootte niet bereikt. De standaardwaarde is false.
id	string	Een tekenreeks die de pool binnen het account uniek identificeert. De id kan elke combinatie van alfanumerieke tekens bevatten, inclusief afbreekstreepjes en onderstrepingstekens, en mag niet meer dan 64 tekens bevatten. De id is hoofdletterbewaarbaar en niet hoofdlettergevoelig (dat wil dat u mogelijk geen twee pool-id's binnen een account hebt die alleen per geval verschillen).
metadata	MetadataItem[]	Een lijst met naam-waardeparen die zijn gekoppeld aan de pool als metagegevens. De Batch-service wijst geen betekenis toe aan metagegevens; het is uitsluitend voor het gebruik van gebruikerscode.
mountConfiguration	MountConfiguration[]	Koppel opslag met behulp van het opgegeven bestandssysteem voor de gehele levensduur van de groep. Koppel de opslag met behulp van azure-bestandsshare, NFS, CIFS of een bestandssysteem op basis van Blobfuse.
networkConfiguration	NetworkConfiguration	De netwerkconfiguratie voor de pool. De netwerkconfiguratie voor een pool.
resizeTimeout	string	De time-out voor de toewijzing van rekenknooppunten aan de pool. Deze time-out geldt alleen voor handmatig schalen; het heeft geen effect wanneer enableAutoScale is ingesteld op true. De standaardwaarde is 15 minuten. De minimumwaarde is 5 minuten. Als u een waarde van minder dan vijf minuten opgeeft, retourneert de Batch-service een fout; Als u de REST API rechtstreeks aanroept, is de HTTP-statuscode 400 (ongeldige aanvraag).
resourceTags	object	De door de gebruiker opgegeven tags die zijn gekoppeld aan de pool. De door de gebruiker gedefinieerde tags die moeten worden gekoppeld aan de Azure Batch pool. Indien opgegeven, worden deze tags doorgegeven aan de Backing Azure-resources die zijn gekoppeld aan de pool. Deze eigenschap kan alleen worden opgegeven wanneer het Batch-account is gemaakt met de eigenschap poolAllocationMode ingesteld op UserSubscription.
startTask	StartTask	Een taak die is opgegeven om te worden uitgevoerd op elk rekenknooppunt wanneer het lid wordt van de pool. De taak wordt uitgevoerd wanneer het rekenknooppunt wordt toegevoegd aan de pool of wanneer het rekenknooppunt opnieuw wordt opgestart.
targetDedicatedNodes	integer	Het gewenste aantal toegewezen rekenknooppunten in de pool. Deze eigenschap mag niet worden opgegeven als enableAutoScale is ingesteld op true. Als enableAutoScale is ingesteld op false, moet u targetDedicatedNodes, targetLowPriorityNodes of beide instellen.
targetLowPriorityNodes	integer	Het gewenste aantal spot-rekenknooppunten/rekenknooppunten met lage prioriteit in de pool. Deze eigenschap mag niet worden opgegeven als enableAutoScale is ingesteld op true. Als enableAutoScale is ingesteld op false, moet u targetDedicatedNodes, targetLowPriorityNodes of beide instellen.
targetNodeCommunicationMode	NodeCommunicationMode	De gewenste knooppuntcommunicatiemodus voor de pool. Als u dit weglaat, is de standaardwaarde Standaard.
taskSchedulingPolicy	TaskSchedulingPolicy	Hoe taken worden verdeeld over rekenknooppunten in een pool. Als dit niet is opgegeven, is de standaardwaarde spread.
taskSlotsPerNode	integer	Het aantal taaksites dat kan worden gebruikt om gelijktijdige taken uit te voeren op één rekenknooppunt in de pool. De standaardwaarde is 1. De maximumwaarde is de kleinste van 4 keer het aantal kernen van de vmSize van de pool of 256.
userAccounts	UserAccount[]	De lijst met gebruikersaccounts die moeten worden gemaakt op elk rekenknooppunt in de pool.
virtualMachineConfiguration	VirtualMachineConfiguration	De configuratie van de virtuele machine voor de pool. Deze eigenschap en cloudServiceConfiguration sluiten elkaar uit en een van de eigenschappen moet worden opgegeven.
vmSize	string	De grootte van virtuele machines in de pool. Alle virtuele machines in een pool hebben dezelfde grootte. Zie Grootten voor Cloud Services () voor informatie over de beschikbare grootten van virtuele machines voor Cloud Services pools (https://azure.microsoft.com/documentation/articles/cloud-services-sizes-specs/pools die zijn gemaakt met cloudServiceConfiguration). Batch ondersteunt alle Cloud Services VM-grootten, met uitzondering van ExtraSmall, A1V2 en A2V2. Zie Grootten voor Virtual Machines (Linux) () of Grootten voor Virtual Machines (Windows)https://azure.microsoft.com/documentation/articles/virtual-machines-linux-sizes/ voor informatie over beschikbare VM-grootten voor pools met behulp van installatiekopieën uit de Virtual Machines Marketplace (pools die zijn gemaakt met virtualMachineConfiguration).https://azure.microsoft.com/documentation/articles/virtual-machines-windows-sizes/ Batch ondersteunt alle azure-VM-grootten, behalve STANDARD_A0 en grootten met Premium Storage (STANDARD_GS, STANDARD_DS en STANDARD_DSV2-serie).

PoolEndpointConfiguration

De eindpuntconfiguratie voor een pool.

Name	Type	Description
inboundNATPools	InboundNATPool[]	Een lijst met binnenkomende NAT-pools die kunnen worden gebruikt om specifieke poorten op een afzonderlijk rekenknooppunt extern aan te pakken. Het maximum aantal binnenkomende NAT-pools per Batch-pool is 5. Als het maximum aantal binnenkomende NAT-pools wordt overschreden, mislukt de aanvraag met HTTP-statuscode 400. Dit kan niet worden opgegeven als het IPAddressProvisioningType NoPublicIPAddresses is.

PublicIPAddressConfiguration

De configuratie van het openbare IP-adres van de netwerkconfiguratie van een pool.

Name	Type	Description
ipAddressIds	string[]	De lijst met openbare IP-adressen die door de Batch-service worden gebruikt bij het inrichten van rekenknooppunten. Het aantal IP-adressen dat hier is opgegeven, beperkt de maximale grootte van de pool: 100 toegewezen knooppunten of 100 spot-/lage prioriteitsknooppunten kunnen worden toegewezen voor elk openbaar IP-adres. Een pool die bijvoorbeeld 250 toegewezen VM's nodig heeft, moet ten minste drie openbare IP-adressen opgegeven hebben. Elk element van deze verzameling heeft de volgende vorm: /subscriptions/{subscription}/resourceGroups/{group}/providers/Microsoft.Network/publicIPAddresses/{ip}.
provision	IPAddressProvisioningType	Het inrichtingstype voor openbare IP-adressen voor de groep. De standaardwaarde is BatchManaged.

ResourceFile

Eén bestand of meerdere bestanden die moeten worden gedownload naar een rekenknooppunt.

Name	Type	Description
autoStorageContainerName	string	De naam van de opslagcontainer in het automatische opslagaccount. De eigenschappen autoStorageContainerName, storageContainerUrl en httpUrl sluiten elkaar uit en een van deze eigenschappen moet worden opgegeven.
blobPrefix	string	Het blobvoorvoegsel dat moet worden gebruikt bij het downloaden van blobs uit een Azure Storage-container. Alleen de blobs waarvan de naam begint met het opgegeven voorvoegsel, worden gedownload. De eigenschap is alleen geldig wanneer autoStorageContainerName of storageContainerUrl wordt gebruikt. Dit voorvoegsel kan een gedeeltelijke bestandsnaam of een submap zijn. Als er geen voorvoegsel is opgegeven, worden alle bestanden in de container gedownload.
fileMode	string	Het kenmerk bestandsmachtigingsmodus in octale indeling. Deze eigenschap is alleen van toepassing op bestanden die worden gedownload naar Linux-rekenknooppunten. Deze wordt genegeerd als het is opgegeven voor een resourceBestand dat wordt gedownload naar een Windows-rekenknooppunt. Als deze eigenschap niet is opgegeven voor een Linux-rekenknooppunt, wordt de standaardwaarde 0770 toegepast op het bestand.
filePath	string	De locatie op het rekenknooppunt waarnaar het bestand(en) moet worden gedownload, ten opzichte van de werkmap van de taak. Als de eigenschap httpUrl is opgegeven, is het filePath vereist en wordt het pad beschreven waarnaar het bestand wordt gedownload, inclusief de bestandsnaam. Als de eigenschap autoStorageContainerName of storageContainerUrl is opgegeven, is filePath optioneel en is het de map waar de bestanden naar moeten worden gedownload. In het geval dat filePath wordt gebruikt als een map, wordt elke mapstructuur die al aan de invoergegevens is gekoppeld, volledig bewaard en toegevoegd aan de opgegeven filePath-map. Het opgegeven relatieve pad kan niet worden verwijderd uit de werkmap van de taak (bijvoorbeeld met behulp van '..').
httpUrl	string	De URL van het bestand dat u wilt downloaden. De eigenschappen autoStorageContainerName, storageContainerUrl en httpUrl sluiten elkaar uit en een van deze eigenschappen moet worden opgegeven. Als de URL naar Azure Blob Storage verwijst, moet deze leesbaar zijn voor rekenknooppunten. Er zijn drie manieren om een dergelijke URL voor een blob in Azure Storage op te halen: voeg een Shared Access Signature (SAS) toe die leesmachtigingen verleent voor de blob, gebruik een beheerde identiteit met leesmachtiging of stel de ACL voor de blob of de container in om openbare toegang toe te staan.
identityReference	ComputeNodeIdentityReference	De verwijzing naar de door de gebruiker toegewezen identiteit die moet worden gebruikt voor toegang tot Azure Blob Storage opgegeven door storageContainerUrl of httpUrl De verwijzing naar een door de gebruiker toegewezen identiteit die is gekoppeld aan de Batch-pool die door een rekenknooppunt wordt gebruikt.
storageContainerUrl	string	De URL van de blobcontainer in Azure Blob Storage. De eigenschappen autoStorageContainerName, storageContainerUrl en httpUrl sluiten elkaar uit en een van deze eigenschappen moet worden opgegeven. Deze URL moet leesbaar en listbaar zijn vanuit rekenknooppunten. Er zijn drie manieren om een dergelijke URL voor een container in Azure Storage op te halen: voeg een Sas (Shared Access Signature) toe die lees- en lijstmachtigingen verleent voor de container, gebruik een beheerde identiteit met lees- en lijstmachtigingen of stel de ACL voor de container in om openbare toegang toe te staan.

SecurityProfile

Hiermee geeft u de beveiligingsprofielinstellingen voor de virtuele machine of virtuele-machineschaalset op.

Name	Type	Description
encryptionAtHost	boolean	Deze eigenschap kan door de gebruiker in de aanvraag worden gebruikt om hostversleuteling voor de virtuele machine of virtuele-machineschaalset in of uit te schakelen. Hiermee schakelt u de versleuteling in voor alle schijven, inclusief de resource-/tijdelijke schijf op de host zelf.
securityType	SecurityTypes	Hiermee geeft u het Beveiligingstype van de virtuele machine. Deze moet worden ingesteld op een opgegeven waarde om UefiSettings in te schakelen.
uefiSettings	UefiSettings	Hiermee geeft u de beveiligingsinstellingen op, zoals beveiligd opstarten en vTPM die worden gebruikt bij het maken van de virtuele machine. Hiermee geeft u de beveiligingsinstellingen op, zoals beveiligd opstarten en vTPM die worden gebruikt bij het maken van de virtuele machine.

SecurityTypes

Hiermee geeft u het SecurityType van de virtuele machine. Deze moet worden ingesteld op een opgegeven waarde om UefiSettings in te schakelen.

Name	Type	Description
trustedLaunch	string	Vertrouwde lancering beschermt tegen geavanceerde en permanente aanvalstechnieken.

ServiceArtifactReference

Hiermee geeft u de referentie-id voor serviceartefacten op die wordt gebruikt om dezelfde versie van de installatiekopieën in te stellen voor alle virtuele machines in de schaalset bij het gebruik van de meest recente versie van de installatiekopieën.

Name	Type	Description
id	string	De serviceartefactreferentie-id van ServiceArtifactReference De serviceartefactreferentie-id in de vorm van /subscriptions/{subscriptionId}/resourceGroups/{resourceGroup}/providers/Microsoft.Compute/galleries/{galleryName}/serviceArtifacts/{serviceArtifactName}/vmArtifactsProfiles/{vmArtifactsProfilesName}

StartTask

Een taak die wordt uitgevoerd wanneer een knooppunt lid wordt van een pool in de Azure Batch-service of wanneer het rekenknooppunt opnieuw wordt opgestart of opnieuw wordt geïnstalleerd.

Name	Type	Description
commandLine	string	De opdrachtregel van de StartTask. De opdrachtregel wordt niet uitgevoerd onder een shell en kan daarom niet profiteren van shell-functies zoals uitbreiding van omgevingsvariabelen. Als u van dergelijke functies wilt profiteren, moet u de shell in de opdrachtregel aanroepen, bijvoorbeeld met 'cmd /c MyCommand' in Windows of '/bin/sh -c MyCommand' in Linux. Als de opdrachtregel naar bestandspaden verwijst, moet deze een relatief pad gebruiken (ten opzichte van de taakwerkmap) of de door Batch opgegeven omgevingsvariabele () gebruiken.https://docs.microsoft.com/en-us/azure/batch/batch-compute-node-environment-variables
containerSettings	TaskContainerSettings	De instellingen voor de container waaronder StartTask wordt uitgevoerd. Wanneer dit is opgegeven, worden alle mappen recursief onder de AZ_BATCH_NODE_ROOT_DIR (de hoofdmap van Azure Batch mappen op het knooppunt) toegewezen aan de container, worden alle taakomgevingsvariabelen toegewezen aan de container en wordt de taakopdrachtregel uitgevoerd in de container. Bestanden die zijn geproduceerd in de container buiten AZ_BATCH_NODE_ROOT_DIR worden mogelijk niet weergegeven op de hostschijf, wat betekent dat Api's van Batch-bestanden geen toegang hebben tot deze bestanden.
environmentSettings	EnvironmentSetting[]	Een lijst met omgevingsvariabeleinstellingen voor de StartTask.
maxTaskRetryCount	integer	Het maximum aantal keren dat de taak opnieuw kan worden geprobeerd. De Batch-service probeert een taak opnieuw als de afsluitcode een andere is dan nul. Houd er rekening mee dat deze waarde specifiek het aantal nieuwe pogingen bepaalt. De Batch-service probeert de taak eenmaal uit te voeren en kan het vervolgens opnieuw proberen tot deze limiet. Als het maximumaantal nieuwe pogingen bijvoorbeeld 3 is, probeert Batch de taak maximaal vier keer (één eerste poging en 3 nieuwe pogingen). Als het maximumaantal nieuwe pogingen 0 is, voert de Batch-service de taak niet opnieuw uit. Als het maximumaantal nieuwe pogingen -1 is, probeert de Batch-service de taak opnieuw zonder limiet, maar dit wordt niet aanbevolen voor een begintaak of een willekeurige taak. De standaardwaarde is 0 (geen nieuwe pogingen).
resourceFiles	ResourceFile[]	Een lijst met bestanden die door de Batch-service worden gedownload naar het rekenknooppunt voordat de opdrachtregel wordt uitgevoerd. Er is een maximale grootte voor de lijst met resourcebestanden. Wanneer de maximale grootte wordt overschreden, mislukt de aanvraag en is de antwoordfoutcode RequestEntityTooLarge. Als dit gebeurt, moet de verzameling ResourceFiles worden verkleind. Dit kan worden bereikt met behulp van .zip-bestanden, toepassingspakketten of Docker-containers. Bestanden die onder dit element worden vermeld, bevinden zich in de werkmap van de taak.
userIdentity	UserIdentity	De gebruikersidentiteit waaronder de StartTask wordt uitgevoerd. Als u dit weglaat, wordt de taak uitgevoerd als een gebruiker zonder beheerdersrechten die uniek is voor de taak.
waitForSuccess	boolean	Of de Batch-service moet wachten tot de StartTask is voltooid (dat wil gezegd, afsluiten met afsluitcode 0) voordat taken op het rekenknooppunt worden gepland. Als true en de StartTask mislukt op een knooppunt, probeert de Batch-service de StartTask opnieuw tot het maximale aantal nieuwe pogingen (maxTaskRetryCount). Als de taak na alle nieuwe pogingen nog steeds niet is voltooid, markeert de Batch-service het knooppunt als onbruikbaar en worden er geen taken op gepland. Deze voorwaarde kan worden gedetecteerd via de details van de status van het rekenknooppunt en foutgegevens. Indien onwaar, wacht de Batch-service niet tot de StartTask is voltooid. In dit geval kunnen andere taken worden uitgevoerd op het rekenknooppunt terwijl de StartTask nog steeds wordt uitgevoerd; en zelfs als de StartTask mislukt, worden nieuwe taken gepland op het rekenknooppunt. De standaardwaarde is true.

StorageAccountType

Het opslagaccounttype voor gebruik bij het maken van gegevensschijven of besturingssysteemschijven.

Name	Type	Description
premium_lrs	string	De gegevensschijf/besturingssysteemschijf moet gebruikmaken van premium lokaal redundante opslag.
standard_lrs	string	De gegevensschijf/besturingssysteemschijf moet standaard lokaal redundante opslag gebruiken.
standardssd_lrs	string	De gegevensschijf/besturingssysteemschijf moet gebruikmaken van lokaal redundante standaard-SSD-opslag.

TaskContainerSettings

De containerinstellingen voor een taak.

Name	Type	Description
containerRunOptions	string	Aanvullende opties voor de opdracht container maken. Deze extra opties worden geleverd als argumenten voor de opdracht 'docker maken', naast de opties die worden beheerd door de Batch-service.
imageName	string	De installatiekopieën die moeten worden gebruikt om de container te maken waarin de taak wordt uitgevoerd. Dit is de volledige installatiekopiereferentie, zoals wordt opgegeven bij 'docker pull'. Als er geen tag wordt opgegeven als onderdeel van de naam van de installatiekopieën, wordt de tag ':latest' standaard gebruikt.
registry	ContainerRegistry	Het persoonlijke register dat de containerinstallatiekopieën bevat. Deze instelling kan worden weggelaten als deze al is opgegeven bij het maken van de pool.
workingDirectory	ContainerWorkingDirectory	De locatie van de werkmap van de containertaak. De standaardwaarde is taskWorkingDirectory.

TaskSchedulingPolicy

Hiermee geeft u op hoe taken moeten worden verdeeld over rekenknooppunten.

Name	Type	Description
nodeFillType	ComputeNodeFillType	Hoe taken worden verdeeld over rekenknooppunten in een pool. Als dit niet is opgegeven, is de standaardwaarde spread.

UefiSettings

Hiermee geeft u de beveiligingsinstellingen op, zoals beveiligd opstarten en vTPM die worden gebruikt tijdens het maken van de virtuele machine.

Name	Type	Description
secureBootEnabled	boolean	Hiermee geeft u op of beveiligd opstarten moet worden ingeschakeld op de virtuele machine.
vTpmEnabled	boolean	Hiermee geeft u op of vTPM moet worden ingeschakeld op de virtuele machine.

UserAccount

Eigenschappen die worden gebruikt om een gebruiker te maken die wordt gebruikt om taken uit te voeren op een Azure Batch-rekenknooppunt.

Name	Type	Description
elevationLevel	ElevationLevel	Het uitbreidingsniveau van het gebruikersaccount. De standaardwaarde is nonAdmin.
linuxUserConfiguration	LinuxUserConfiguration	De Linux-specifieke gebruikersconfiguratie voor het gebruikersaccount. Deze eigenschap wordt genegeerd als deze is opgegeven in een Windows-pool. Als deze niet is opgegeven, wordt de gebruiker gemaakt met de standaardopties.
name	string	De naam van het gebruikersaccount. Namen kunnen Unicode-tekens bevatten met een maximale lengte van 20.
password	string	Het wachtwoord voor het gebruikersaccount.
windowsUserConfiguration	WindowsUserConfiguration	De Windows-specifieke gebruikersconfiguratie voor het gebruikersaccount. Deze eigenschap kan alleen worden opgegeven als de gebruiker zich in een Windows-pool bevindt. Als dit niet is opgegeven en in een Windows-groep, wordt de gebruiker gemaakt met de standaardopties.

UserIdentity

De definitie van de gebruikersidentiteit waaronder de taak wordt uitgevoerd.

Name	Type	Description
autoUser	AutoUserSpecification	De automatische gebruiker waaronder de taak wordt uitgevoerd. De eigenschappen userName en autoUser sluiten elkaar uit. u moet een, maar niet beide opgeven.
username	string	De naam van de gebruikersidentiteit waaronder de taak wordt uitgevoerd. De eigenschappen userName en autoUser sluiten elkaar uit. u moet een, maar niet beide opgeven.

VirtualMachineConfiguration

De configuratie voor rekenknooppunten in een pool op basis van de Azure Virtual Machines-infrastructuur.

Name	Type	Description
containerConfiguration	ContainerConfiguration	De containerconfiguratie voor de pool. Indien opgegeven, wordt de installatie uitgevoerd op elk rekenknooppunt in de pool, zodat taken kunnen worden uitgevoerd in containers. Alle reguliere taken en taakbeheertaken die in deze pool worden uitgevoerd, moeten de eigenschap containerSettings opgeven, en alle andere taken kunnen deze opgeven.
dataDisks	DataDisk[]	De configuratie voor gegevensschijven die zijn gekoppeld aan de rekenknooppunten in de pool. Deze eigenschap moet worden opgegeven als aan de rekenknooppunten in de pool lege gegevensschijven moeten zijn gekoppeld. Dit kan niet worden bijgewerkt. Elk rekenknooppunt krijgt een eigen schijf (de schijf is geen bestandsshare). Bestaande schijven kunnen niet worden gekoppeld. Elke gekoppelde schijf is leeg. Wanneer het rekenknooppunt uit de pool wordt verwijderd, worden de schijf en alle bijbehorende gegevens ook verwijderd. De schijf is niet geformatteerd nadat deze is gekoppeld. Deze moet vóór gebruik worden geformatteerd. Zie https://docs.microsoft.com/en-us/azure/virtual-machines/linux/classic/attach-disk#initialize-a-new-data-disk-in-linux en https://docs.microsoft.com/en-us/azure/virtual-machines/windows/attach-disk-ps#add-an-empty-data-disk-to-a-virtual-machinevoor meer informatie .
diskEncryptionConfiguration	DiskEncryptionConfiguration	De schijfversleutelingsconfiguratie voor de pool. Indien opgegeven, wordt versleuteling uitgevoerd op elk knooppunt in de pool tijdens het inrichten van knooppunten.
extensions	VMExtension[]	De extensie van de virtuele machine voor de pool. Indien opgegeven, worden de extensies die in deze configuratie worden vermeld op elk knooppunt geïnstalleerd.
imageReference	ImageReference	Een verwijzing naar de Azure Virtual Machines Marketplace-installatiekopieën of de aangepaste vm-installatiekopieën die moeten worden gebruikt.
licenseType	string	Het type on-premises licentie dat moet worden gebruikt bij het implementeren van het besturingssysteem. Dit geldt alleen voor installatiekopieën die het Windows-besturingssysteem bevatten en mag alleen worden gebruikt wanneer u geldige on-premises licenties hebt voor de rekenknooppunten die worden geïmplementeerd. Als u dit weglaat, wordt er geen on-premises licentiekorting toegepast. Waarden zijn: Windows_Server: de on-premises licentie is voor Windows Server. Windows_Client: de on-premises licentie is voor Windows Client.
nodeAgentSKUId	string	De SKU van de Batch Compute Node-agent die moet worden ingericht op rekenknooppunten in de pool. De Batch Compute Node-agent is een programma dat wordt uitgevoerd op elk rekenknooppunt in de pool en biedt de command-and-control-interface tussen het rekenknooppunt en de Batch-service. Er zijn verschillende implementaties van de Compute Node-agent, ook wel SKU's genoemd, voor verschillende besturingssystemen. U moet een SKU voor de compute node-agent opgeven die overeenkomt met de geselecteerde afbeeldingsreferentie. Als u de lijst met ondersteunde SKU's van de Compute Node-agent wilt ophalen, samen met de lijst met geverifieerde afbeeldingsverwijzingen, raadpleegt u de bewerking 'Ondersteunde agent-SKU's voor rekenknooppunten weergeven'.
nodePlacementConfiguration	NodePlacementConfiguration	De configuratie van de knooppuntplaatsing voor de pool. Met deze configuratie worden regels opgegeven voor de wijze waarop knooppunten in de pool fysiek worden toegewezen.
osDisk	OSDisk	Instellingen voor de besturingssysteemschijf van de virtuele machine.
securityProfile	SecurityProfile	Hiermee geeft u de beveiligingsprofielinstellingen voor de virtuele machine of virtuele-machineschaalset op. Hiermee geeft u de beveiligingsprofielinstellingen voor de virtuele machine of virtuele-machineschaalset op.
serviceArtifactReference	ServiceArtifactReference	Hiermee geeft u de referentie-id voor serviceartefacten op die wordt gebruikt om dezelfde versie van de installatiekopieën in te stellen voor alle virtuele machines in de schaalset bij het gebruik van de meest recente versie van de installatiekopieën. De serviceartefactreferentie-id in de vorm van /subscriptions/{subscriptionId}/resourceGroups/{resourceGroup}/providers/Microsoft.Compute/galleries/{galleryName}/serviceArtifacts/{serviceArtifactName}/vmArtifactsProfiles/{vmArtifactsProfilesName}
windowsConfiguration	WindowsConfiguration	Windows-besturingssysteeminstellingen op de virtuele machine. Deze eigenschap mag niet worden opgegeven als de eigenschap imageReference een Linux-besturingssysteeminstallatiekopie opgeeft.

VMExtension

De configuratie voor extensies van virtuele machines.

Name	Type	Description
autoUpgradeMinorVersion	boolean	Geeft aan of de extensie een nieuwere secundaire versie moet gebruiken als deze beschikbaar is tijdens de implementatie. Zodra de extensie is geïmplementeerd, worden secundaire versies echter niet bijgewerkt, tenzij opnieuw geïmplementeerd, zelfs als deze eigenschap is ingesteld op true.
enableAutomaticUpgrade	boolean	Geeft aan of de extensie automatisch moet worden bijgewerkt door het platform als er een nieuwere versie van de extensie beschikbaar is.
name	string	De naam van de extensie van de virtuele machine.
protectedSettings	object	De extensie kan protectedSettings of protectedSettingsFromKeyVault bevatten of helemaal geen beveiligde instellingen bevatten.
provisionAfterExtensions	string[]	De verzameling extensienamen. Verzameling extensienamen waarna deze extensie moet worden ingericht.
publisher	string	De naam van de uitgever van de extensie-handler.
settings	object	Met JSON opgemaakte openbare instellingen voor de extensie.
type	string	Het type van de extensie.
typeHandlerVersion	string	De versie van scripthandler.

WindowsConfiguration

Instellingen van het Windows-besturingssysteem die moeten worden toegepast op de virtuele machine.

Name	Type	Description
enableAutomaticUpdates	boolean	Of automatische updates zijn ingeschakeld op de virtuele machine. Als u dit weglaat, is de standaardwaarde true.

WindowsUserConfiguration

Eigenschappen die worden gebruikt voor het maken van een gebruikersaccount op een Windows-rekenknooppunt.

Name	Type	Description
loginMode	LoginMode	De aanmeldingsmodus voor de gebruiker De standaardwaarde voor VirtualMachineConfiguration-pools is 'batch' en voor CloudServiceConfiguration-pools is 'interactief'.