Delen via


Pools - Create Pool

Maakt een pool aan voor het opgegeven account.
Vermijd bij het benoemen van groepen gevoelige informatie, zoals gebruikersnamen of geheime projectnamen. Deze informatie kan worden weergegeven in telemetrielogboeken die toegankelijk zijn voor Microsoft Ondersteuningstechnici.

POST {endpoint}/pools?api-version=2025-06-01
POST {endpoint}/pools?api-version=2025-06-01&timeOut={timeOut}

URI-parameters

Name In Vereist Type Description
endpoint
path True

string (uri)

Batch-accounteindpunt (bijvoorbeeld: https://batchaccount.eastus2.batch.azure.com).

api-version
query True

string

minLength: 1

De API-versie die voor deze bewerking moet worden gebruikt.

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. Als de waarde groter is dan 30, wordt de standaard in plaats daarvan gebruikt."

Aanvraagkoptekst

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

Name Vereist Type Description
client-request-id

string

De door 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 clientaanvraag-id in het antwoord moet retourneren.

ocp-date

string (date-time-rfc7231)

Het tijdstip waarop de aanvraag is uitgegeven. Clientbibliotheken stellen dit doorgaans in op de huidige kloktijd van het systeem; stel deze 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 uniek identificeert binnen het account. De id kan elke combinatie van alfanumerieke tekens bevatten, inclusief afbreekstreepjes en onderstrepingstekens, en mag niet meer dan 64 tekens bevatten. De id is hoofdlettergevoelig en niet hoofdlettergevoelig (dat wil gezegd, u hebt mogelijk geen twee pool-id's binnen een account die alleen per geval verschillen).

vmSize True

string

De grootte van virtuele machines in de pool. Alle virtuele machines in een pool hebben dezelfde grootte. Zie Formaten voor virtuele machines in Azure (https://learn.microsoft.com/azure/virtual-machines/sizes/overview) voor informatie over beschikbare VM-grootten voor pools met behulp van installatiekopieën van de Virtual Machines Marketplace (pools gemaakt met virtualMachineConfiguration). Batch ondersteunt alle azure-VM-grootten, behalve STANDARD_A0 en vm's met Premium Storage (STANDARD_GS, STANDARD_DS en STANDARD_DSV2 reeks).

applicationPackageReferences

BatchApplicationPackageReference[]

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

autoScaleEvaluationInterval

string (duration)

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

autoScaleFormula

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 niet geldig is, weigert de Batch-service de aanvraag met gedetailleerde foutinformatie. Zie 'Rekenknooppunten automatisch schalen in een Azure Batch-pool' (https://learn.microsoft.com/azure/batch/batch-automatic-scaling) voor meer informatie over het opgeven van deze formule.

displayName

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

enableInterNodeCommunication

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

metadata

BatchMetadataItem[]

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

mountConfiguration

MountConfiguration[]

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

networkConfiguration

NetworkConfiguration

De netwerkconfiguratie voor de pool.

resizeTimeout

string (duration)

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

startTask

BatchStartTask

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

targetDedicatedNodes

integer (int32)

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 (int32)

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

taskSchedulingPolicy

BatchTaskSchedulingPolicy

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

taskSlotsPerNode

integer (int32)

Het aantal taaksites dat kan worden gebruikt om gelijktijdige taken uit te voeren op één rekenknooppunt in de pool. De standaardwaarde is 1. De maximumwaarde is de kleinste van 4 keer het aantal kernen van de vmSize van de pool of 256.

upgradePolicy

UpgradePolicy

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

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 moet worden opgegeven.

Antwoorden

Name Type Description
201 Created

De aanvraag is geslaagd en er is een nieuwe resource gemaakt.

Kopteksten

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

BatchError

Een onverwachte foutreactie.

Beveiliging

OAuth2Auth

Type: oauth2
Stroom: implicit
Autorisatie-URL: https://login.microsoftonline.com/common/oauth2/v2.0/authorize

Bereiken

Name Description
https://batch.core.windows.net//.default

Voorbeelden

Creates a pool with accelerated networking
Creates a pool with confidential disk encryption set for user subscription accounts
Creates a pool with disk encryption set for user subscription accounts
Creates a pool with dual stack networking
Creates a pool with mount drive specified
Creates a pool with SecurityProfile
Creates a VirtualMachineConfiguration pool
Creates a VirtualMachineConfiguration pool with containers
Creates a VirtualMachineConfiguration pool with extensions
Creates a VirtualMachineConfiguration pool with OS disk
Creates a VirtualMachineConfiguration pool with ServiceArtifactReference

Creates a pool with accelerated networking

Voorbeeldaanvraag

POST {endpoint}/pools?api-version=2025-06-01



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

Voorbeeldrespons

Creates a pool with confidential disk encryption set for user subscription accounts

Voorbeeldaanvraag

POST {endpoint}/pools?api-version=2025-06-01



{
  "id": "pool",
  "vmSize": "Standard_DC2as_v5",
  "virtualMachineConfiguration": {
    "imageReference": {
      "publisher": "MicrosoftWindowsServer",
      "offer": "WindowsServer",
      "sku": "2019-datacenter-core-g2",
      "version": "latest"
    },
    "osDisk": {
      "managedDisk": {
        "storageAccountType": "standard_lrs",
        "diskEncryptionSet": {
          "id": "/subscriptions/subid/resourceGroups/default-azurebatch-japaneast/providers/Microsoft.Compute/diskEncryptionSets/DiskEncryptionSetId"
        },
        "securityProfile": {
          "securityEncryptionType": "DiskWithVMGuestState"
        }
      }
    },
    "dataDisks": [
      {
        "lun": 0,
        "diskSizeGB": 1024,
        "managedDisk": {
          "storageAccountType": "standard_lrs",
          "diskEncryptionSet": {
            "id": "/subscriptions/subid/resourceGroups/default-azurebatch-japaneast/providers/Microsoft.Compute/diskEncryptionSets/DiskEncryptionSetId"
          }
        }
      }
    ],
    "securityProfile": {
      "securityType": "confidentialvm",
      "uefiSettings": {
        "vTpmEnabled": true,
        "secureBootEnabled": true
      }
    },
    "nodeAgentSKUId": "batch.node.windows amd64"
  },
  "targetDedicatedNodes": 1
}

Voorbeeldrespons

Creates a pool with disk encryption set for user subscription accounts

Voorbeeldaanvraag

POST {endpoint}/pools?api-version=2025-06-01



{
  "id": "pool",
  "vmSize": "Standard_D2ds_v5",
  "virtualMachineConfiguration": {
    "imageReference": {
      "publisher": "MicrosoftWindowsServer",
      "offer": "WindowsServer",
      "sku": "2019-datacenter-core-g2",
      "version": "latest"
    },
    "osDisk": {
      "managedDisk": {
        "storageAccountType": "standard_lrs",
        "diskEncryptionSet": {
          "id": "/subscriptions/subid/resourceGroups/default-azurebatch-japaneast/providers/Microsoft.Compute/diskEncryptionSets/DiskEncryptionSetId"
        }
      }
    },
    "dataDisks": [
      {
        "lun": 0,
        "diskSizeGB": 1024,
        "managedDisk": {
          "storageAccountType": "standard_lrs",
          "diskEncryptionSet": {
            "id": "/subscriptions/subid/resourceGroups/default-azurebatch-japaneast/providers/Microsoft.Compute/diskEncryptionSets/DiskEncryptionSetId"
          }
        }
      }
    ],
    "nodeAgentSKUId": "batch.node.windows amd64"
  },
  "targetDedicatedNodes": 1
}

Voorbeeldrespons

Creates a pool with dual stack networking

Voorbeeldaanvraag

POST {endpoint}/pools?api-version=2025-06-01



{
  "id": "dualstackpool",
  "vmSize": "Standard_D2ds_v5",
  "virtualMachineConfiguration": {
    "imageReference": {
      "publisher": "Canonical",
      "offer": "ubuntu-24_04-lts",
      "sku": "server"
    },
    "nodeAgentSKUId": "batch.node.ubuntu 20.04"
  },
  "networkConfiguration": {
    "publicIPAddressConfiguration": {
      "ipFamilies": [
        "IPv4",
        "IPv6"
      ]
    },
    "endpointConfiguration": {
      "inboundNATPools": [
        {
          "backendPort": 22,
          "frontendPortRangeStart": 40000,
          "frontendPortRangeEnd": 40500,
          "name": "sshpool",
          "protocol": "tcp",
          "networkSecurityGroupRules": [
            {
              "access": "allow",
              "priority": 1000,
              "sourceAddressPrefix": "*",
              "sourcePortRanges": [
                "*"
              ]
            }
          ]
        }
      ]
    }
  },
  "resizeTimeout": "PT15M",
  "targetDedicatedNodes": 1,
  "targetLowPriorityNodes": 0
}

Voorbeeldrespons

Creates a pool with mount drive specified

Voorbeeldaanvraag

POST {endpoint}/pools?api-version=2025-06-01


{
  "id": "pool2",
  "vmSize": "Standard_D4d_v5",
  "virtualMachineConfiguration": {
    "imageReference": {
      "publisher": "Canonical",
      "offer": "ubuntu-24_04-lts",
      "sku": "server"
    },
    "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
}

Voorbeeldrespons

Creates a pool with SecurityProfile

Voorbeeldaanvraag

POST {endpoint}/pools?api-version=2025-06-01



{
  "id": "mypool001",
  "vmSize": "STANDARD_DC2s_V2",
  "virtualMachineConfiguration": {
    "imageReference": {
      "publisher": "Canonical",
      "offer": "ubuntu-24_04-lts",
      "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
}

Voorbeeldrespons

Creates a VirtualMachineConfiguration pool

Voorbeeldaanvraag

POST {endpoint}/pools?api-version=2025-06-01



{
  "id": "pool2",
  "vmSize": "Standard_D4d_v5",
  "virtualMachineConfiguration": {
    "imageReference": {
      "publisher": "Canonical",
      "offer": "ubuntu-24_04-lts",
      "sku": "server"
    },
    "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"
    }
  ]
}

Voorbeeldrespons

Creates a VirtualMachineConfiguration pool with containers

Voorbeeldaanvraag

POST {endpoint}/pools?api-version=2025-06-01



{
  "id": "pool2",
  "vmSize": "Standard_D4d_v5",
  "virtualMachineConfiguration": {
    "imageReference": {
      "publisher": "Canonical",
      "offer": "ubuntu-24_04-lts",
      "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
}

Voorbeeldrespons

Creates a VirtualMachineConfiguration pool with extensions

Voorbeeldaanvraag

POST {endpoint}/pools?api-version=2025-06-01



{
  "id": "pool2",
  "vmSize": "Standard_D4d_v5",
  "virtualMachineConfiguration": {
    "imageReference": {
      "publisher": "Canonical",
      "offer": "ubuntu-24_04-lts",
      "sku": "server"
    },
    "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"
    }
  ]
}

Voorbeeldrespons

Creates a VirtualMachineConfiguration pool with OS disk

Voorbeeldaanvraag

POST {endpoint}/pools?api-version=2025-06-01



{
  "id": "mypool001",
  "vmSize": "Standard_D2ds_v5",
  "virtualMachineConfiguration": {
    "imageReference": {
      "publisher": "Canonical",
      "offer": "ubuntu-24_04-lts",
      "sku": "server"
    },
    "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
}

Voorbeeldrespons

Creates a VirtualMachineConfiguration pool with ServiceArtifactReference

Voorbeeldaanvraag

POST {endpoint}/pools?api-version=2025-06-01



{
  "id": "mypool002",
  "vmSize": "Standard_D4d_v5",
  "virtualMachineConfiguration": {
    "imageReference": {
      "publisher": "MicrosoftWindowsServer",
      "offer": "WindowsServer",
      "sku": "2025-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
}

Voorbeeldrespons

Definities

Name Description
AutomaticOsUpgradePolicy

De configuratieparameters die worden gebruikt voor het uitvoeren van automatische upgrade van het besturingssysteem.

AutoUserScope

AutoUserScope enums

AutoUserSpecification

Hiermee geeft u de opties voor de automatische gebruiker die een Azure Batch-taak uitvoert.

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.

BatchApplicationPackageReference

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

BatchContainerConfiguration

De configuratie voor pools waarvoor containers zijn ingeschakeld.

BatchDiffDiskSettings

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

BatchError

Er is een foutbericht ontvangen van de Azure Batch-service.

BatchErrorDetail

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

BatchErrorMessage

Een foutbericht dat is ontvangen in een Azure Batch-foutreactie.

BatchInboundNatPool

Een binnenkomende NAT-pool die kan worden gebruikt om specifieke poorten op rekenknooppunten in een batchgroep extern aan te pakken.

BatchJobDefaultOrder

BatchJobDefaultOrder-enums

BatchMetadataItem

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

BatchNodeFillType

BatchNodeFillType enums

BatchNodeIdentityReference

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

BatchNodePlacementConfiguration

Voor regionale plaatsing worden knooppunten in de pool toegewezen in dezelfde regio. Voor zonegebonden plaatsing worden knooppunten in de pool verdeeld over verschillende zones met optimale taakverdeling.

BatchNodePlacementPolicyType

BatchNodePlacementPolicyType enums

BatchOsDisk

Instellingen voor de besturingssysteemschijf van het rekenknooppunt (VM).

BatchPoolCreateOptions

Parameters voor het maken van een Azure Batch-pool.

BatchPoolEndpointConfiguration

De eindpuntconfiguratie voor een pool.

BatchPoolIdentityReference

De verwijzing van een van de poolidentiteiten om Disk te versleutelen. Deze identiteit wordt gebruikt om toegang te krijgen tot de sleutelkluis.

BatchPublicIpAddressConfiguration

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

BatchStartTask

Batch voert taken opnieuw uit wanneer een herstelbewerking wordt geactiveerd op een knooppunt. Voorbeelden van herstelbewerkingen zijn (maar zijn niet beperkt tot) wanneer een beschadigd knooppunt opnieuw wordt opgestart of een rekenknooppunt is verdwenen vanwege een hostfout. Nieuwe pogingen vanwege herstelbewerkingen zijn onafhankelijk van en worden niet meegeteld voor maxTaskRetryCount. Zelfs als maxTaskRetryCount 0 is, kan er een interne nieuwe poging worden uitgevoerd vanwege een herstelbewerking. Daarom moeten alle taken idempotent zijn. Dit betekent dat taken moeten worden onderbroken en opnieuw moeten worden gestart zonder beschadiging of dubbele gegevens te veroorzaken. De aanbevolen procedure voor langlopende taken is om een vorm van controlepunten te gebruiken. In sommige gevallen kan de StartTask opnieuw worden uitgevoerd, ook al is het rekenknooppunt niet opnieuw opgestart. Er moet speciale aandacht worden besteed aan het voorkomen van StartTasks die een breakaway-proces maken of services installeren/starten vanuit de werkmap StartTask, omdat hierdoor Batch niet meer in staat is om de StartTask opnieuw uit te voeren.

BatchTaskContainerSettings

De containerinstellingen voor een taak.

BatchTaskSchedulingPolicy

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

BatchUefiSettings

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

BatchVmDiskSecurityProfile

Hiermee geeft u de beveiligingsprofielinstellingen voor de beheerde schijf. Opmerking: Het kan alleen worden ingesteld voor vertrouwelijke VM's en is vereist bij het gebruik van vertrouwelijke VM's.

BatchVmImageReference

Een verwijzing naar een Azure Virtual Machines Marketplace-installatiekopieën of een Azure Compute Gallery-installatiekopieën. Zie de bewerking 'Lijst met ondersteunde installatiekopieën' voor alle Azure Marketplace-installatiekopieën die zijn geverifieerd door Azure Batch.

CachingType

CachingType enums

CifsMountConfiguration

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

ContainerHostBatchBindMountEntry

De vermelding van het pad en de koppelingsmodus die u wilt koppelen aan de taakcontainer.

ContainerHostDataPath

De paden die worden gekoppeld aan de container van de containertaak.

ContainerRegistryReference

Een privécontainerregister.

ContainerType

ContainerType enums

ContainerWorkingDirectory

ContainerWorkingDirectory-enums

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 vanuit een virtuele machine koppelen en formatteren om ze te kunnen gebruiken.

DiffDiskPlacement

Specificeert de plaatsing van de tijdelijke schijf voor de besturingssysteemschijf voor alle rekenknooppunten (VM's) in de pool. Deze eigenschap kan worden gebruikt door de gebruiker in de aanvraag om te kiezen op welke locatie het besturingssysteem zich moet bevinden. Bijvoorbeeld: cacheschijfruimte voor kortstondige besturingssysteemschijfinrichting. Voor meer informatie over de vereisten voor schijfgrootte van Ephemeral OS, zie Ephemeral OS schijfgroottevereisten voor Windows-VM's en https://learn.microsoft.com/azure/virtual-machines/windows/ephemeral-os-disks#size-requirements Linux-VM's bij https://learn.microsoft.com/azure/virtual-machines/linux/ephemeral-os-disks#size-requirements

DiskCustomerManagedKey

De door de klant beheerde sleutelreferentie om de schijf te versleutelen.

DiskEncryptionConfiguration

De schijfversleutelingsconfiguratie die is toegepast op rekenknooppunten in de pool. Schijfversleutelingsconfiguratie wordt niet ondersteund in een Linux-pool die is gemaakt met de installatiekopie van de Azure Compute Gallery.

DiskEncryptionSetParameters

De ARM-bron-id van de set schijfversleuteling.

DiskEncryptionTarget

DiskEncryptionTarget-enums

DynamicVNetAssignmentScope

DynamicVNetAssignmentScope enums

ElevationLevel

ElevationLevel-enums

EnvironmentSetting

Een omgevingsvariabele die moet worden ingesteld voor een taakproces.

HostEndpointSettings

Hiermee geeft u bepaalde instellingen voor hosteindpunten op.

HostEndpointSettingsModeTypes

HostEndpointSettingsModeTypes enums

InboundEndpointProtocol

InboundEndpointProtocol enums

IpAddressProvisioningType

IPAddressProvisioningType enums

IPFamily

De IP-families die worden gebruikt om IP-versies op te geven die beschikbaar zijn voor de pool.

IPTag

Bevat de IP-tag die is gekoppeld aan het openbare IP-adres.

LinuxUserConfiguration

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

LoginMode

LoginMode-enums

ManagedDisk

De parameters van de beheerde schijf.

MountConfiguration

Het bestandssysteem dat op elk knooppunt moet worden gekoppeld.

NetworkConfiguration

De netwerkconfiguratie voor een pool.

NetworkSecurityGroupRule

Een regel voor een netwerkbeveiligingsgroep die moet worden toegepast op een binnenkomend eindpunt.

NetworkSecurityGroupRuleAccess

NetworkSecurityGroupRuleAccess-enums

NfsMountConfiguration

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

ProxyAgentSettings

Hiermee geeft u ProxyAgent-instellingen op tijdens het maken van de virtuele machine.

ResourceFile

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

RollingUpgradePolicy

De configuratieparameters die worden gebruikt tijdens het uitvoeren van een rolling upgrade.

SecurityEncryptionTypes

SecurityEncryptionTypes enums

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 voor het instellen van dezelfde installatiekopieënversie voor alle virtuele machines in de schaalset wanneer u de meest recente installatiekopieënversie gebruikt.

StorageAccountType

StorageAccountType enums

UpgradeMode

UpgradeMode-enums

UpgradePolicy

Beschrijft een upgradebeleid: automatisch, handmatig of rolling.

UserAccount

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

UserIdentity

De definitie van de gebruikersidentiteit waaronder de taak wordt uitgevoerd. Geef de eigenschap userName of autoUser op, maar niet beide.

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

Windows-besturingssysteeminstellingen die van toepassing zijn op de virtuele machine.

WindowsUserConfiguration

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

AutomaticOsUpgradePolicy

De configuratieparameters die worden gebruikt voor het uitvoeren van automatische upgrade van het besturingssysteem.

Name Type Description
disableAutomaticRollback

boolean

Of de functie voor terugdraaien van installatiekopieën van het besturingssysteem moet worden uitgeschakeld.

enableAutomaticOSUpgrade

boolean

Hiermee wordt aangegeven of upgrades van het besturingssysteem automatisch moeten worden toegepast op exemplaren van schaalsets wanneer een nieuwere versie van de installatiekopie van het besturingssysteem beschikbaar wordt.

Als dit is ingesteld op waar voor Windows-pools, kan WindowsConfiguration.enableAutomaticUpdates niet worden ingesteld op true.

osRollingUpgradeDeferral

boolean

Stel upgrades van het besturingssysteem uit op de TVM's als ze taken uitvoeren.

useRollingUpgradePolicy

boolean

Hiermee wordt aangegeven of beleid voor rolling upgrades moet worden gebruikt tijdens de automatische upgrade van het besturingssysteem. Automatische upgrade van het besturingssysteem valt terug op het standaardbeleid als er geen beleid is gedefinieerd op de VMSS.

AutoUserScope

AutoUserScope enums

Waarde Description
task

Geeft aan dat de dienst een nieuwe gebruiker voor de Taak moet aanmaken.

pool

Specificeert dat de Taak draait als het gemeenschappelijke automatische gebruikersaccount dat op elke rekenknoop in een pool wordt aangemaakt.

AutoUserSpecification

Hiermee geeft u de opties voor de automatische gebruiker die een Azure Batch-taak uitvoert.

Name Type Description
elevationLevel

ElevationLevel

Het hoogteniveau van de automatische gebruiker. De standaardwaarde is nietAdmin.

scope

AutoUserScope

Het bereik voor de automatische gebruiker. De standaardwaarde is pool. Als de pool Windows uitvoert, moet een waarde van Taak worden opgegeven als strengere isolatie tussen taken vereist is. Bijvoorbeeld als de taak het register muteert op een manier die van invloed kan zijn op andere taken.

AzureBlobFileSystemConfiguration

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

Name Type Description
accountKey

string (password)

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

Aanvullende opdrachtregelopties om door te geven aan de koppelingsopdracht. Dit zijn opties voor 'net use' in Windows en opties voor koppelen in Linux.

containerName

string

De naam van de Azure Blob Storage-container.

identityReference

BatchNodeIdentityReference

De verwijzing naar de door de gebruiker toegewezen identiteit om toegang te krijgen tot containerName. Deze eigenschap is wederzijds exclusief met zowel accountKey als sasKey; er moet precies één worden opgegeven.

relativeMountPath

string

Het relatieve pad op de rekenknoop waar het bestandssysteem wordt gemount. Alle bestandssystemen worden gekoppeld ten opzichte van de map batchkoppelingen, die toegankelijk zijn via de omgevingsvariabele AZ_BATCH_NODE_MOUNTS_DIR.

sasKey

string (password)

Het SAS-token van Azure Storage. 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 (password)

De sleutel van het Azure Storage-account.

accountName

string

De naam van het Azure Storage-account.

azureFileUrl

string (uri)

De URL van Azure Files. Dit is de vorm 'https://{account}.file.core.windows.net/'.

mountOptions

string

Aanvullende opdrachtregelopties om door te geven aan de koppelingsopdracht. Dit zijn opties voor 'net use' in Windows en opties voor koppelen in Linux.

relativeMountPath

string

Het relatieve pad op de rekenknoop waar het bestandssysteem wordt gemount. Alle bestandssystemen worden gekoppeld ten opzichte van de map batchkoppelingen, die toegankelijk zijn via de omgevingsvariabele AZ_BATCH_NODE_MOUNTS_DIR.

BatchApplicationPackageReference

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

Name Type Description
applicationId

string

De ID van de applicatie om uit te rollen. 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 is geen standaardversie gespecificeerd voor deze applicatie, faalt het verzoek met de foutcode InvalidApplicationPackageReferences en HTTP-statuscode 409. Als dit wordt weggelaten op een Task en er geen standaardversie voor deze applicatie is opgegeven, faalt de Task met een pre-processing error.

BatchContainerConfiguration

De configuratie voor pools waarvoor containers zijn ingeschakeld.

Name Type Description
containerImageNames

string[]

De verzameling van containerafbeeldingen namen. Dit is de volledige afbeeldingsreferentie, zoals gespecificeerd bij "docker pull". Een Image wordt afkomstig uit het standaard Docker-register, tenzij de Image volledig gekwalificeerd is met een alternatief register.

containerRegistries

ContainerRegistryReference[]

Aanvullende privéregisters waaruit containers kunnen worden opgehaald. Als afbeeldingen gedownload moeten worden uit een privéregister dat inloggegevens vereist, dan moeten die gegevens hier worden verstrekt.

type

ContainerType

De containertechnologie die moet worden gebruikt.

BatchDiffDiskSettings

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

Name Type Description
placement

DiffDiskPlacement

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

BatchError

Er is 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

BatchErrorMessage

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 Waarde aangeeft.

value

string

De aanvullende informatie die is opgenomen in het foutbericht.

BatchErrorMessage

Een foutbericht dat is ontvangen in een Azure Batch-foutreactie.

Name Type Description
lang

string

De taalcode van het foutbericht.

value

string

De tekst van het bericht.

BatchInboundNatPool

Een binnenkomende NAT-pool die kan worden gebruikt om specifieke poorten op rekenknooppunten in een batchgroep extern aan te pakken.

Name Type Description
backendPort

integer (int32)

Het poortnummer op de Compute Node. Dit moet uniek zijn binnen een Batch Pool. Acceptabele waarden liggen tussen 1 en 65535, met uitzondering van 29876 en 29877, aangezien deze zijn gereserveerd. Als er gereserveerde waarden worden opgegeven, mislukt de aanvraag met HTTP-statuscode 400.

frontendPortRangeEnd

integer (int32)

Het laatste poortnummer in het bereik van externe poorten dat wordt gebruikt om inkomende toegang tot de backendPort te bieden op individuele rekenknooppunten. Acceptabele waarden variëren tussen 1 en 65534, behalve poorten van 50000 tot 55000, die zijn gereserveerd door de Batch-service. Alle bereiken binnen een Pool moeten verschillend zijn en mogen niet overlappen. Elke range moet minstens 40 poorten bevatten. Als er gereserveerde of overlappende waarden worden opgegeven, mislukt de aanvraag met HTTP-statuscode 400.

frontendPortRangeStart

integer (int32)

Het eerste poortnummer in het bereik van externe poorten dat wordt gebruikt om inkomende toegang te bieden tot de backendPort op individuele rekenknooppunten. Acceptabele waarden variëren 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 niet overlappen. Elke range moet minstens 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, kan letters, cijfers, onderstreepjes, punten en koppeltekens 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 regels voor netwerkbeveiligingsgroepen die worden toegepast op het eindpunt. Het maximale aantal regels dat over alle eindpunten in een Batch Pool kan worden gespecificeerd, 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.

BatchJobDefaultOrder

BatchJobDefaultOrder-enums

Waarde Description
none

Taken moeten uniform worden ingepland vanuit alle taken met gelijke prioriteit voor de pool.

creationtime

Als taken gelijke prioriteit hebben, moeten taken van eerder aangemaakte taken eerst worden ingepland.

BatchMetadataItem

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

Name Type Description
name

string

De naam van het metagegevensitem.

value

string

De waarde van het metagegevensitem.

BatchNodeFillType

BatchNodeFillType enums

Waarde Description
spread

Taken moeten gelijkmatig worden toegewezen aan alle Compute Nodes in de Pool.

pack

Zoveel mogelijk taken (taskSlotsPerNode) moeten aan elke rekenknoop in de pool worden toegewezen voordat taken worden toegewezen aan de volgende rekenknoop in de pool.

BatchNodeIdentityReference

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 (arm-id)

De ARM-resource-id van de door de gebruiker toegewezen identiteit.

BatchNodePlacementConfiguration

Voor regionale plaatsing worden knooppunten in de pool toegewezen in dezelfde regio. Voor zonegebonden plaatsing worden knooppunten in de pool verdeeld over verschillende zones met optimale taakverdeling.

Name Type Description
policy

BatchNodePlacementPolicyType

Type plaatsingsbeleid voor knooppunten 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.

BatchNodePlacementPolicyType

BatchNodePlacementPolicyType enums

Waarde Description
regional

Alle knooppunten in de pool worden in dezelfde regio toegewezen.

zonal

Nodes in de pool worden verspreid over verschillende beschikbaarheidszones met best effort balancering.

BatchOsDisk

Instellingen voor de besturingssysteemschijf van het rekenknooppunt (VM).

Name Type Description
caching

CachingType

Hiermee geeft u de cachevereisten op. Mogelijke waarden zijn: Geen, ReadOnly, ReadWrite. De standaardwaarden zijn: Geen voor Standard-opslag. ReadOnly voor Premium-opslag.

diskSizeGB

integer (int32)

De oorspronkelijke schijfgrootte in GB bij het maken van een nieuwe besturingssysteemschijf.

ephemeralOSDiskSettings

BatchDiffDiskSettings

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 ingeschakeld of uitgeschakeld op de schijf.

BatchPoolCreateOptions

Parameters voor het maken van een Azure Batch-pool.

Name Type Description
applicationPackageReferences

BatchApplicationPackageReference[]

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

autoScaleEvaluationInterval

string (duration)

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

autoScaleFormula

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 niet geldig is, weigert de Batch-service de aanvraag met gedetailleerde foutinformatie. Zie 'Rekenknooppunten automatisch schalen in een Azure Batch-pool' (https://learn.microsoft.com/azure/batch/batch-automatic-scaling) voor meer informatie over het opgeven van deze formule.

displayName

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

enableInterNodeCommunication

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

id

string

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

metadata

BatchMetadataItem[]

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

mountConfiguration

MountConfiguration[]

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

networkConfiguration

NetworkConfiguration

De netwerkconfiguratie voor de pool.

resizeTimeout

string (duration)

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

startTask

BatchStartTask

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

targetDedicatedNodes

integer (int32)

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 (int32)

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

taskSchedulingPolicy

BatchTaskSchedulingPolicy

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

taskSlotsPerNode

integer (int32)

Het aantal taaksites dat kan worden gebruikt om gelijktijdige taken uit te voeren op één rekenknooppunt in de pool. De standaardwaarde is 1. De maximumwaarde is de kleinste van 4 keer het aantal kernen van de vmSize van de pool of 256.

upgradePolicy

UpgradePolicy

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

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 moet worden opgegeven.

vmSize

string

De grootte van virtuele machines in de pool. Alle virtuele machines in een pool hebben dezelfde grootte. Zie Formaten voor virtuele machines in Azure (https://learn.microsoft.com/azure/virtual-machines/sizes/overview) voor informatie over beschikbare VM-grootten voor pools met behulp van installatiekopieën van de Virtual Machines Marketplace (pools gemaakt met virtualMachineConfiguration). Batch ondersteunt alle azure-VM-grootten, behalve STANDARD_A0 en vm's met Premium Storage (STANDARD_GS, STANDARD_DS en STANDARD_DSV2 reeks).

BatchPoolEndpointConfiguration

De eindpuntconfiguratie voor een pool.

Name Type Description
inboundNATPools

BatchInboundNatPool[]

Een lijst van inkomende NAT Pools die gebruikt kunnen worden om specifieke poorten op een individuele Compute Node extern aan te spreken. Het maximale aantal inkomende NAT-pools per batchpool is 5. Als het maximale aantal inkomende NAT Pools wordt overschreden, faalt het verzoek met HTTP-statuscode 400. Dit kan niet worden opgegeven als het IPAddressProvisioningType NoPublicIPAddresses is.

BatchPoolIdentityReference

De verwijzing van een van de poolidentiteiten om Disk te versleutelen. Deze identiteit wordt gebruikt om toegang te krijgen tot de sleutelkluis.

Name Type Description
resourceId

string (arm-id)

De ARM-resource-id van de door de gebruiker toegewezen identiteit. Deze verwijzing moet worden opgenomen in de poolidentiteiten.

BatchPublicIpAddressConfiguration

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

Name Type Description
ipAddressIds

string[] (arm-id)

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, heeft ten minste 3 openbare IP-adressen nodig. Elk element van deze verzameling heeft de volgende vorm: /subscriptions/{subscription}/resourceGroups/{group}/providers/Microsoft.Network/publicIPAddresses/{ip}.

ipFamilies

IPFamily[]

De IP-families die worden gebruikt om IP-versies op te geven die beschikbaar zijn voor de pool. IP-families worden gebruikt om single-stack of dual-stack pools te bepalen. Voor één stack is de verwachte waarde IPv4. Voor dual-stack zijn de verwachte waarden IPv4 en IPv6.

ipTags

IPTag[]

Een lijst met IP-tags die zijn gekoppeld aan de openbare IP-adressen van de pool. IP-tags worden gebruikt om openbare IP-adressen te categoriseren en te filteren voor facturerings- en beheerdoeleinden.

provision

IpAddressProvisioningType

Het inrichtingstype voor openbare IP-adressen voor de groep. De standaardwaarde is BatchManaged.

BatchStartTask

Batch voert taken opnieuw uit wanneer een herstelbewerking wordt geactiveerd op een knooppunt. Voorbeelden van herstelbewerkingen zijn (maar zijn niet beperkt tot) wanneer een beschadigd knooppunt opnieuw wordt opgestart of een rekenknooppunt is verdwenen vanwege een hostfout. Nieuwe pogingen vanwege herstelbewerkingen zijn onafhankelijk van en worden niet meegeteld voor maxTaskRetryCount. Zelfs als maxTaskRetryCount 0 is, kan er een interne nieuwe poging worden uitgevoerd vanwege een herstelbewerking. Daarom moeten alle taken idempotent zijn. Dit betekent dat taken moeten worden onderbroken en opnieuw moeten worden gestart zonder beschadiging of dubbele gegevens te veroorzaken. De aanbevolen procedure voor langlopende taken is om een vorm van controlepunten te gebruiken. In sommige gevallen kan de StartTask opnieuw worden uitgevoerd, ook al is het rekenknooppunt niet opnieuw opgestart. Er moet speciale aandacht worden besteed aan het voorkomen van StartTasks die een breakaway-proces maken of services installeren/starten vanuit de werkmap StartTask, omdat hierdoor Batch niet meer in staat is om de StartTask opnieuw uit te voeren.

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 aanroepen op de opdrachtregel, bijvoorbeeld met 'cmd /c MyCommand' in Windows of '/bin/sh -c MyCommand' in Linux. Als de opdrachtregel verwijst naar bestandspaden, moet deze een relatief pad gebruiken (ten opzichte van de werkmap Taak) of de door Batch geleverde omgevingsvariabele (https://learn.microsoft.com/azure/batch/batch-compute-node-environment-variables).

containerSettings

BatchTaskContainerSettings

De instellingen voor de container waaronder de StartTask draait. Wanneer dit wordt gespecificeerd, worden alle directories recursief onder de AZ_BATCH_NODE_ROOT_DIR (de wortel van Azure Batch-directories op de node) in de container toegewezen, worden alle Task-omgevingsvariabelen in de container gemapt en wordt de Task-opdrachtregel uitgevoerd in de container. Bestanden die buiten AZ_BATCH_NODE_ROOT_DIR in de container worden geproduceerd, worden mogelijk niet teruggespiegeld naar de hostdisk, wat betekent dat Batch-bestands-API's geen toegang tot die bestanden hebben.

environmentSettings

EnvironmentSetting[]

Een lijst met omgevingsvariabele-instellingen voor de StartTask.

maxTaskRetryCount

integer (int32)

Het maximum aantal keren dat de taak opnieuw kan worden geprobeerd. De Batch-service probeert een taak opnieuw uit te voeren als de afsluitcode niet-nul is. Houd er rekening mee dat deze waarde specifiek het aantal nieuwe pogingen bepaalt. De Batch-service probeert de taak eenmaal uit en probeert vervolgens opnieuw tot deze limiet. Als het maximumaantal nieuwe pogingen bijvoorbeeld 3 is, probeert Batch de taak maximaal 4 keer (één eerste poging en drie 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 andere taak. De standaardwaarde is 0 (geen nieuwe pogingen).

resourceFiles

ResourceFile[]

Een lijst met bestanden die de Batch-service naar het rekenknooppunt downloadt voordat u de opdrachtregel uitvoert. 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 het geval is, 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 draait. Als deze wordt weggelaten, draait de taak als een niet-administratieve gebruiker 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. Indien waar en starttask mislukt op een knooppunt, probeert de Batch-service de StartTask opnieuw uit te voeren tot het maximumaantal nieuwe pogingen (maxTaskRetryCount). Als de taak na alle nieuwe pogingen nog steeds niet is voltooid, markeert de Batch-service het knooppunt onbruikbaar en plant deze niet. Deze voorwaarde kan worden gedetecteerd via de details van de status en foutgegevens van het rekenknooppunt. Als dit onwaar is, 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 nog steeds gepland op het rekenknooppunt. De standaardwaarde is waar.

BatchTaskContainerSettings

De containerinstellingen voor een taak.

Name Type Description
containerHostBatchBindMounts

ContainerHostBatchBindMountEntry[]

De paden die u aan de containertaak wilt koppelen. Als deze matrix null is of niet aanwezig is, koppelt de containertaak een volledig tijdelijk schijfstation in Windows (of AZ_BATCH_NODE_ROOT_DIR in Linux). Er worden geen gegevenspaden in de container geplaatst als deze matrix is ingesteld als leeg.

containerRunOptions

string

Aanvullende opties voor de opdracht container maken. Deze extra opties worden geleverd als argumenten voor de opdracht Docker create, naast de opties die worden beheerd door de Batch-service.

imageName

string

De image die gebruikt moet worden om de container te maken waarin de taak zal draaien. Dit is de volledige afbeeldingsreferentie, zoals gespecificeerd bij "docker pull". Als er geen tag in de afbeeldingsnaam wordt vermeld, wordt de tag ":latest" standaard gebruikt.

registry

ContainerRegistryReference

Het privéregister dat de containerafbeelding bevat. Deze instelling kan worden weggelaten als deze al bij het aanmaken van het zwembad was aangegeven.

workingDirectory

ContainerWorkingDirectory

De locatie van de container Task werkdirectory. De standaardwaarde is taskWorkingDirectory.

BatchTaskSchedulingPolicy

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

Name Type Default value Description
jobDefaultOrder

BatchJobDefaultOrder

none

De volgorde voor het plannen van taken van verschillende taken met dezelfde prioriteit. Als dit niet is opgegeven, is de standaardinstelling geen.

nodeFillType

BatchNodeFillType

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

BatchUefiSettings

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.

BatchVmDiskSecurityProfile

Hiermee geeft u de beveiligingsprofielinstellingen voor de beheerde schijf. Opmerking: Het kan alleen worden ingesteld voor vertrouwelijke VM's en is vereist bij het gebruik van vertrouwelijke VM's.

Name Type Description
securityEncryptionType

SecurityEncryptionTypes

Hiermee geeft u het EncryptionType van de beheerde schijf. Deze is ingesteld op VMGuestStateOnly voor versleuteling van alleen de VMGuestState-blob en NonPersistedTPM voor het niet behouden van de firmwarestatus in de VMGuestState-blob. Opmerking: Het kan alleen worden ingesteld voor vertrouwelijke VM's en is vereist bij het gebruik van vertrouwelijke VM's.

BatchVmImageReference

Een verwijzing naar een Azure Virtual Machines Marketplace-installatiekopieën of een Azure Compute Gallery-installatiekopieën. Zie de bewerking 'Lijst met ondersteunde installatiekopieën' voor alle Azure Marketplace-installatiekopieën die zijn geverifieerd door Azure Batch.

Name Type Description
communityGalleryImageId

string

De unieke identificatie van de afbeelding in de communitygalerij. Deze eigenschap is wederzijds exclusief met andere eigenschappen en kan worden opgehaald uit de get-aanroep van de communitygalerieafbeelding.

exactVersion

string

De specifieke versie van het platformimage of marktplaats image die is gebruikt om de node te maken. Dit alleen-lezen veld verschilt van 'versie' alleen als de waarde die voor 'versie' werd gespecificeerd toen de pool werd aangemaakt 'laatste' was.

offer

string

Het aanbiedingstype van de Azure Virtual Machines Marketplace Image. Bijvoorbeeld UbuntuServer of WindowsServer.

publisher

string

De uitgever van de Azure Virtual Machines Marketplace Image. Bijvoorbeeld Canonical of MicrosoftWindowsServer.

sharedGalleryImageId

string

De unieke identificatie van de gedeelde galerijafbeelding. Deze eigenschap is wederzijds exclusief met andere eigenschappen en kan worden opgehaald uit de get-aanroep van de installatiekopieën in de gedeelde galerie.

sku

string

De SKU van de Azure Virtual Machines Marketplace Image. Bijvoorbeeld 18.04-LTS of 2019-Datacenter.

version

string

De versie van de Azure Virtual Machines Marketplace Image. Een waarde van 'laatste' kan worden opgegeven om de nieuwste versie van een Image te selecteren. Als u dit weglaat, is de standaardwaarde 'nieuwste'.

virtualMachineImageId

string (arm-id)

De ARM-resource-id van de installatiekopieën van de Azure Compute Gallery. Compute Nodes in de pool worden aangemaakt met deze Image Id. Dit is 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 standaard te kiezen voor de nieuwste afbeeldingsversie. Deze eigenschap sluit elkaar uit met andere ImageReference-eigenschappen. De Azure Compute Gallery Image moet replica's in dezelfde regio hebben en moet in hetzelfde abonnement zitten als het Azure Batch-account. Als de afbeeldingsversie niet is gespecificeerd in de imageId, wordt de nieuwste versie gebruikt. Voor informatie over de firewallinstellingen voor de Batch Compute Node-agent om met de Batch-service te communiceren, zie https://learn.microsoft.com/azure/batch/nodes-and-pools#virtual-network-vnet-and-firewall-configuration.

CachingType

CachingType enums

Waarde Description
none

De cachemodus voor de schijf is niet ingeschakeld.

readonly

De cachemodus voor de schijf is alleen-lezen.

readwrite

De cachemodus voor de schijf is lezen en schrijven.

CifsMountConfiguration

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

Name Type Description
mountOptions

string

Aanvullende opdrachtregelopties om door te geven aan de koppelingsopdracht. Dit zijn opties voor 'net use' in Windows en opties voor koppelen in Linux.

password

string (password)

Het wachtwoord dat moet worden gebruikt voor verificatie op basis van het CIFS-bestandssysteem.

relativeMountPath

string

Het relatieve pad op de rekenknoop waar het bestandssysteem wordt gemount. Alle bestandssystemen worden gekoppeld ten opzichte van de map batchkoppelingen, die toegankelijk zijn via de omgevingsvariabele AZ_BATCH_NODE_MOUNTS_DIR.

source

string

De URI van het bestandssysteem die moet worden gekoppeld.

username

string

De gebruiker die moet worden gebruikt voor verificatie op basis van het CIFS-bestandssysteem.

ContainerHostBatchBindMountEntry

De vermelding van het pad en de koppelingsmodus die u wilt koppelen aan de taakcontainer.

Name Type Description
isReadOnly

boolean

Koppel dit bronpad als alleen-lezenmodus of niet. De standaardwaarde is onwaar (lees-/schrijfmodus). Als u voor Linux dit pad koppelt als een lees-/schrijfmodus, betekent dit niet dat alle gebruikers in de container de lees-/schrijftoegang voor het pad hebben, afhankelijk van de toegang in de host-VM. Als dit pad is gekoppeld met het kenmerk Alleen-lezen, kunnen alle gebruikers in de container het pad niet wijzigen.

source

ContainerHostDataPath

Het pad dat aan de containerklant wordt gekoppeld, kan worden geselecteerd.

ContainerHostDataPath

De paden die worden gekoppeld aan de container van de containertaak.

Waarde Description
Shared

Het pad voor de taak met meerdere exemplaren om hun bestanden te delen.

Startup

Het pad voor de begintaak.

VfsMounts

Het pad bevat alle virtuele bestandssystemen die op dit knooppunt zijn gekoppeld.

Task

Het taakpad.

JobPrep

Het taakpad voor de taakvoorbereiding.

Applications

Het pad naar toepassingen.

ContainerRegistryReference

Een privécontainerregister.

Name Type Description
identityReference

BatchNodeIdentityReference

De verwijzing naar de door de gebruiker toegewezen identiteit die moet worden gebruikt voor toegang tot een Azure Container Registry in plaats van een gebruikersnaam en wachtwoord.

password

string (password)

Het wachtwoord om u aan te melden bij de registerserver.

registryServer

string (uri)

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

ContainerType enums

Waarde Description
dockerCompatible

Er wordt een docker-compatibele containertechnologie gebruikt om de containers te starten.

criCompatible

Een op CRI gebaseerde technologie wordt gebruikt om de containers te starten.

ContainerWorkingDirectory

ContainerWorkingDirectory-enums

Waarde Description
taskWorkingDirectory

Gebruik de standaard Batch-service Taakwerkmap, die de Taakresourcebestanden bevat die door Batch worden ingevuld met Batch.

containerImageDefault

Gebruik de werkmap die is gedefinieerd in de container Image. Let op: deze map bevat niet de door batch gedownloade Resource Files.

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 vanuit een virtuele machine koppelen en formatteren 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 (int32)

De initiële schijfgrootte in gigabytes.

lun

integer (int32)

Het nummer van de logische eenheid. Het logicalUnitNumber wordt gebruikt om elke gegevensschijf uniek te identificeren. Als u meerdere schijven koppelt, moet elk een uniek logicalUnitNumber hebben. De waarde moet tussen 0 en 63 liggen, inclusief.

managedDisk

ManagedDisk

De parameters van de beheerde schijf.

storageAccountType

StorageAccountType

Het type opslagaccount dat moet worden gebruikt voor de gegevensschijf. Als u dit weglaat, is de standaardwaarde 'standard_lrs'.

DiffDiskPlacement

Specificeert de plaatsing van de tijdelijke schijf voor de besturingssysteemschijf voor alle rekenknooppunten (VM's) in de pool. Deze eigenschap kan worden gebruikt door de gebruiker in de aanvraag om te kiezen op welke locatie het besturingssysteem zich moet bevinden. Bijvoorbeeld: cacheschijfruimte voor kortstondige besturingssysteemschijfinrichting. Voor meer informatie over de vereisten voor schijfgrootte van Ephemeral OS, zie Ephemeral OS schijfgroottevereisten voor Windows-VM's en https://learn.microsoft.com/azure/virtual-machines/windows/ephemeral-os-disks#size-requirements Linux-VM's bij https://learn.microsoft.com/azure/virtual-machines/linux/ephemeral-os-disks#size-requirements

Waarde Description
cachedisk

De tijdelijke besturingssysteemschijf wordt opgeslagen in de VM-cache.

DiskCustomerManagedKey

De door de klant beheerde sleutelreferentie om de schijf te versleutelen.

Name Type Description
identityReference

BatchPoolIdentityReference

De verwijzing van een van de poolidentiteiten om Disk te versleutelen. Deze identiteit wordt gebruikt om toegang te krijgen tot de KeyVault.

keyUrl

string

Volledige versie van de sleutel-URL die verwijst naar een sleutel in KeyVault. Versiesegment van de URL is vereist, ongeacht de waarde rotationToLatestKeyVersionEnabled.

rotationToLatestKeyVersionEnabled

boolean

Stel deze vlag in op true om het automatisch bijwerken van de schijfversleuteling naar de nieuwste sleutelversie mogelijk te maken. De standaardwaarde is vals.

DiskEncryptionConfiguration

De schijfversleutelingsconfiguratie die is toegepast op rekenknooppunten in de pool. Schijfversleutelingsconfiguratie wordt niet ondersteund in een Linux-pool die is gemaakt met de installatiekopie van de Azure Compute Gallery.

Name Type Description
customerManagedKey

DiskCustomerManagedKey

De door de klant beheerde sleutelreferentie om de schijf van het besturingssysteem te versleutelen. De door de klant beheerde sleutel versleutelt de OS-schijf door middel van EncryptionAtRest en standaard versleutelen we ook de gegevensschijf. Het kan alleen worden gebruikt wanneer de pool is geconfigureerd met een identiteit en OsDisk is ingesteld als een van de doelen van DiskEncryption.

targets

DiskEncryptionTarget[]

De lijst met schijfdoelen voor Batch Service wordt versleuteld op het rekenknooppunt. De lijst met schijfdoelen voor Batch Service wordt versleuteld op het rekenknooppunt.

DiskEncryptionSetParameters

De ARM-bron-id van de set schijfversleuteling.

Name Type Description
id

string (arm-id)

De ARM-bron-id van de set schijfversleuteling. De resource moet deel uitmaken van hetzelfde abonnement als het Batch-account.

DiskEncryptionTarget

DiskEncryptionTarget-enums

Waarde Description
osdisk

De besturingssysteemschijf op het rekenknooppunt is versleuteld.

temporarydisk

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

DynamicVNetAssignmentScope enums

Waarde Description
none

Er is geen dynamische VNet-toewijzing ingeschakeld.

job

Dynamische VNet-toewijzing wordt per taak uitgevoerd.

ElevationLevel

ElevationLevel-enums

Waarde Description
nonadmin

De gebruiker is een standaardgebruiker zonder verhoogde toegang.

admin

De gebruiker is een gebruiker met verhoogde toegang en werkt met volledige beheerdersmachtigingen.

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.

HostEndpointSettings

Hiermee geeft u bepaalde instellingen voor hosteindpunten op.

Name Type Description
inVMAccessControlProfileReferenceId

string

Hiermee geeft u de verwijzing naar de resource-id InVMAccessControlProfileVersion op in de vorm van /subscriptions/{SubscriptionId}/resourceGroups/{ResourceGroupName}/providers/Microsoft.Compute/galleries/{galleryName}/inVMAccessControlProfiles/{profile}/versions/{version}.

mode

HostEndpointSettingsModeTypes

Hiermee geeft u de uitvoeringsmodus van het toegangsbeheerbeleid op.

HostEndpointSettingsModeTypes

HostEndpointSettingsModeTypes enums

Waarde Description
Audit

In de controlemodus fungeert het systeem alsof het het toegangsbeheerbeleid afdwingt, inclusief het verzenden van toegangsontkenningsvermeldingen in de logboeken, maar het weigert geen aanvragen voor hosteindpunten.

Enforce

Enforce-modus is de aanbevolen werkwijze en het systeem zal het toegangscontrolebeleid handhaven. Deze eigenschap kan niet worden gebruikt samen met 'inVMAccessControlProfileReferenceId'.

InboundEndpointProtocol

InboundEndpointProtocol enums

Waarde Description
tcp

Gebruik TCP voor het eindpunt.

udp

Gebruik UDP voor het eindpunt.

IpAddressProvisioningType

IPAddressProvisioningType enums

Waarde Description
batchmanaged

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.

usermanaged

Openbare IP-adressen worden geleverd door de gebruiker en worden gebruikt om de rekenknooppunten in te richten.

nopublicipaddresses

Er wordt geen openbaar IP-adres aangemaakt.

IPFamily

De IP-families die worden gebruikt om IP-versies op te geven die beschikbaar zijn voor de pool.

Waarde Description
IPv4

IPv4 is beschikbaar voor de pool.

IPv6

IPv6 is beschikbaar voor de pool.

IPTag

Bevat de IP-tag die is gekoppeld aan het openbare IP-adres.

Name Type Description
ipTagType

string

Het type IP-tag. Voorbeeld: FirstPartyUsage.

tag

string

De waarde van de IP-tag die is gekoppeld aan het openbare IP-adres. Voorbeeld: SQL.

LinuxUserConfiguration

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

Name Type Description
gid

integer (int32)

De groeps-ID voor het gebruikersaccount. De uid- en gid-eigenschappen moeten samen worden opgegeven of helemaal niet. Als het onderliggende besturingssysteem niet is opgegeven, kiest u de gid.

sshPrivateKey

string (password)

De SSH privésleutel voor het gebruikersaccount. De persoonlijke sleutel mag niet met een wachtwoord zijn beveiligd. De privésleutel wordt gebruikt om automatisch asymmetrische-sleutelgebaseerde authenticatie voor SSH tussen Compute Nodes in een Linux Pool te configureren wanneer de enableInterNodeCommunication-eigenschap van de pool waar is (deze wordt genegeerd als enableInterNodeCommunication onwaar is). Dit doet u door het sleutelpaar in de map .ssh van de gebruiker te plaatsen. Indien niet gespecificeerd, wordt wachtwoordloze SSH niet geconfigureerd tussen Compute Nodes (er wordt geen wijziging gedaan aan de .ssh-directory van de gebruiker).

uid

integer (int32)

De gebruikers-ID van het gebruikersaccount. De uid- en gid-eigenschappen moeten samen worden opgegeven of helemaal niet. Als het onderliggende besturingssysteem niet is opgegeven, wordt de uid gekozen.

LoginMode

LoginMode-enums

Waarde Description
batch

De LOGON32_LOGON_BATCH Win32-aanmeldingsmodus. De batchaanmeldingsmodus wordt aanbevolen voor langdurige parallelle processen.

interactive

De LOGON32_LOGON_INTERACTIVE Win32-aanmeldingsmodus. UAC is ingeschakeld op Windows VirtualMachineConfiguration Pools. Als deze optie wordt gebruikt met een verhoogde gebruikersidentiteit in een Windows VirtualMachineConfiguration Pool, wordt de gebruikerssessie niet verhoogd tenzij de applicatie die via de Task-opdrachtregel wordt uitgevoerd is geconfigureerd om altijd beheerdersrechten of altijd maximale rechten te vereisen.

ManagedDisk

De parameters van de beheerde schijf.

Name Type Description
diskEncryptionSet

DiskEncryptionSetParameters

Hiermee geeft u de resource-id van de door de klant beheerde schijfversleutelingsset voor de beheerde schijf op. Het kan alleen worden ingesteld in de UserSubscription-modus.

securityProfile

BatchVmDiskSecurityProfile

Hiermee geeft u de beveiligingsprofielinstellingen voor de beheerde schijf.

storageAccountType

StorageAccountType

Het type opslagaccount voor beheerde schijf.

MountConfiguration

Het bestandssysteem dat op elk knooppunt moet worden gekoppeld.

Name Type Description
azureBlobFileSystemConfiguration

AzureBlobFileSystemConfiguration

De Azure Storage-container die moet worden gekoppeld met blob FUSE op elk knooppunt. Deze eigenschap is wederzijds exclusief met alle andere eigenschappen.

azureFileShareConfiguration

AzureFileShareConfiguration

De Azure-bestandsshare die op elk knooppunt moet worden gekoppeld. Deze eigenschap is wederzijds exclusief met alle andere eigenschappen.

cifsMountConfiguration

CifsMountConfiguration

Het CIFS-/SMB-bestandssysteem dat op elk knooppunt moet worden gekoppeld. Deze eigenschap is wederzijds exclusief met alle andere eigenschappen.

nfsMountConfiguration

NfsMountConfiguration

Het NFS-bestandssysteem dat op 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 maken I/O-virtualisatie met één hoofdmap (SR-IOV) mogelijk voor een VIRTUELE machine, wat kan leiden tot verbeterde netwerkprestaties. Zie voor meer informatie: https://learn.microsoft.com/azure/virtual-network/accelerated-networking-overview.

endpointConfiguration

BatchPoolEndpointConfiguration

De configuratie voor eindpunten op rekenknooppunten in de batchpool.

publicIPAddressConfiguration

BatchPublicIpAddressConfiguration

De openbare IPAddress-configuratie voor rekenknooppunten in de Batch-pool.

subnetId

string

De ARM-resource-identificatie van het virtuele netwerksubnet waar de rekenknooppunten van de pool zich bij zullen voegen. Dit is van het formulier /subscriptions/{subscription}/resourceGroups/{group}/providers/{provider}/virtualNetworks/{network}/subnetten/{subnet}. Het virtuele netwerk moet zich in dezelfde regio en hetzelfde abonnement bevinden als het Azure Batch-account. Het opgegeven subnet moet genoeg vrije IP-adressen hebben om het aantal Compute Nodes in de pool te accommoderen. Als het subnet niet genoeg vrije IP-adressen heeft, zal de Pool de Nodes gedeeltelijk toewijzen en zal er een resize-fout optreden. De service-principal 'MicrosoftAzureBatch' moet de rol 'Inzender voor klassieke virtuele machines' hebben Role-Based RBAC-rol (Access Control) voor het opgegeven VNet. Het gespecificeerde subnet moet communicatie vanuit de Azure Batch-service mogelijk maken om taken op de knooppunten te kunnen inplannen. Dit kan worden gecontroleerd door te controleren of het opgegeven VNet gekoppelde netwerkbeveiligingsgroepen (NSG' 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. Alleen ARM-virtuele netwerken ('Microsoft.Network/virtualNetworks') worden ondersteund. Als de gespecificeerde VNet geassocieerde Network Security Groups (NSG) heeft, moeten enkele gereserveerde systeempoorten worden ingeschakeld voor inkomende communicatie, waaronder poorten 29876 en 29877. Schakel ook uitgaande verbindingen met Azure Storage in op poort 443. Zie voor meer informatie: https://learn.microsoft.com/azure/batch/nodes-and-pools#virtual-network-vnet-and-firewall-configuration

NetworkSecurityGroupRule

Een regel voor een netwerkbeveiligingsgroep 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 (int32)

De prioriteit voor deze regel. Prioriteiten binnen een Pool moeten uniek zijn en worden beoordeeld op volgorde van prioriteit. Hoe lager het getal hoe hoger de prioriteit. Regels kunnen bijvoorbeeld worden opgegeven met ordernummers 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 het label dat 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 (d.w.z. 22), of een poortbereik (d.w.z. 100-200). De poorten moeten in het bereik van 0 tot 65535 liggen. Elke vermelding in deze collectie mag geen andere vermelding overlappen (noch een bereik noch een individuele poort). Als er andere waarden worden gegeven, faalt het verzoek met HTTP-statuscode 400. De standaardwaarde is ''.

NetworkSecurityGroupRuleAccess

NetworkSecurityGroupRuleAccess-enums

Waarde Description
allow

Toegang toestaan.

deny

Toegang weigeren.

NfsMountConfiguration

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

Name Type Description
mountOptions

string

Aanvullende opdrachtregelopties om door te geven aan de koppelingsopdracht. Dit zijn opties voor 'net use' in Windows en opties voor koppelen in Linux.

relativeMountPath

string

Het relatieve pad op de rekenknoop waar het bestandssysteem wordt gemount. Alle bestandssystemen worden gekoppeld ten opzichte van de map batchkoppelingen, die toegankelijk zijn via de omgevingsvariabele AZ_BATCH_NODE_MOUNTS_DIR.

source

string

De URI van het bestandssysteem die moet worden gekoppeld.

ProxyAgentSettings

Hiermee geeft u ProxyAgent-instellingen op tijdens het maken van de virtuele machine.

Name Type Description
enabled

boolean

Hiermee geeft u op of de functie Metagegevensbeveiligingsprotocol moet worden ingeschakeld op de virtuele-machine of de virtuele-machineschaalset. Standaard is onwaar.

imds

HostEndpointSettings

Instellingen voor het IMDS-eindpunt.

wireServer

HostEndpointSettings

Instellingen voor het WireServer-eindpunt.

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 wederzijds uit en een van deze 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 namen beginnen 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 geldt alleen voor bestanden die worden gedownload naar Linux Compute Nodes. Het wordt genegeerd als het wordt gespecificeerd voor een resourceFile dat wordt gedownload naar een Windows Compute Node. Als deze eigenschap niet is gespecificeerd voor een Linux Compute Node, wordt een standaardwaarde van 0770 op het bestand toegepast.

filePath

string

De locatie op de Compute Node waar het bestand(en) naartoe gedownload moet worden, 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 anders de eigenschap autoStorageContainerName of storageContainerUrl is opgegeven, is filePath optioneel en is het de map waarin de bestanden moeten worden gedownload. In het geval dat filePath wordt gebruikt als 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 uit de werkmap van de Taak ontsnappen (bijvoorbeeld door '..' te gebruiken).

httpUrl

string (uri)

De URL van het bestand dat u wilt downloaden. De eigenschappen autoStorageContainerName, storageContainerUrl en httpUrl sluiten elkaar wederzijds uit en een van deze moet worden opgegeven. Als de URL verwijst naar Azure Blob Storage, moet deze leesbaar zijn vanuit rekenknooppunten. Er zijn drie manieren om een dergelijke URL op te halen voor een blob in Azure Storage: neem een SAS (Shared Access Signature) die leesmachtigingen voor de blob verleent, gebruik een beheerde identiteit met leesmachtigingen of stel de ACL voor de blob of de container in om openbare toegang toe te staan.

identityReference

BatchNodeIdentityReference

De verwijzing naar de door de gebruiker toegewezen identiteit om toegang te krijgen tot Azure Blob Storage, gespecificeerd door storageContainerUrl of httpUrl.

storageContainerUrl

string (uri)

De URL van de blobcontainer in Azure Blob Storage. De eigenschappen autoStorageContainerName, storageContainerUrl en httpUrl sluiten elkaar wederzijds uit en een van deze moet worden opgegeven. Deze URL moet kunnen worden gelezen en vermeld vanuit rekenknooppunten. Er zijn drie manieren om een dergelijke URL op te halen voor een container in Azure Storage: neem een SAS (Shared Access Signature) op die lees- en lijstmachtigingen voor de container verleent, gebruik een beheerde identiteit met lees- en lijstmachtigingen of stel de ACL voor de container in om openbare toegang toe te staan.

RollingUpgradePolicy

De configuratieparameters die worden gebruikt tijdens het uitvoeren van een rolling upgrade.

Name Type Description
enableCrossZoneUpgrade

boolean

Toestaan dat VMSS AZ-grenzen negeert bij het maken van upgradebatches. Neem rekening met het updatedomein en maxBatchInstancePercent om de batchgrootte te bepalen. Dit veld kan alleen worden ingesteld op waar of onwaar wanneer u NodePlacementConfiguration als zonegebonden gebruikt.

maxBatchInstancePercent

integer (int32)

Het maximumpercentage van het totale aantal exemplaren van virtuele machines dat tegelijkertijd wordt geüpgraded door de rolling upgrade in één batch. Omdat dit een maximum is, kunnen beschadigde exemplaren in eerdere of toekomstige batches ervoor zorgen dat het percentage exemplaren in een batch afneemt om een hogere betrouwbaarheid te garanderen. De waarde van dit veld moet tussen 5 en 100 liggen, inclusief. Als zowel maxBatchInstancePercent als maxUnhealthyInstancePercent aan waarde zijn toegewezen, mag de waarde van maxBatchInstancePercent niet meer zijn dan maxUnhealthyInstancePercent.

maxUnhealthyInstancePercent

integer (int32)

Het maximumpercentage van het totale aantal exemplaren van virtuele machines in de schaalset dat tegelijkertijd beschadigd kan zijn, hetzij als gevolg van een upgrade of door de statuscontroles van de virtuele machine te worden aangetroffen voordat de rolling upgrade wordt afgebroken. Deze beperking wordt gecontroleerd voordat u een batch start. De waarde van dit veld moet tussen 5 en 100 liggen, inclusief. Als zowel maxBatchInstancePercent als maxUnhealthyInstancePercent aan waarde zijn toegewezen, mag de waarde van maxBatchInstancePercent niet meer zijn dan maxUnhealthyInstancePercent.

maxUnhealthyUpgradedInstancePercent

integer (int32)

Het maximumpercentage van bijgewerkte exemplaren van virtuele machines die kunnen worden gevonden, hebben een slechte status. Deze controle vindt plaats nadat elke batch is bijgewerkt. Als dit percentage ooit wordt overschreden, wordt de rolling update afgebroken. De waarde van dit veld moet tussen 0 en 100, inclusief zijn.

pauseTimeBetweenBatches

string (duration)

De wachttijd tussen het voltooien van de update voor alle virtuele machines in één batch en het starten van de volgende batch. De tijdsduur moet worden opgegeven in ISO 8601-indeling..

prioritizeUnhealthyInstances

boolean

Werk alle beschadigde exemplaren in een schaalset bij voordat alle exemplaren in orde zijn.

rollbackFailedInstancesOnPolicyBreach

boolean

Het terugdraaien van mislukte exemplaren naar het vorige model als het beleid voor rolling upgrades wordt geschonden.

SecurityEncryptionTypes

SecurityEncryptionTypes enums

Waarde Description
DiskWithVMGuestState

EncryptionType van de beheerde schijf is ingesteld op DiskWithVMGuestState voor versleuteling van de beheerde schijf samen met VMGuestState-blob. Het wordt niet ondersteund in datadisks.

NonPersistedTPM

EncryptionType van de beheerde schijf is ingesteld op NonPersistedTPM voor het niet persistent zijn van de firmwarestatus in de VMGuestState-blob.

VMGuestStateOnly

Het versleutelingstype van de beheerde schijf is ingesteld op VMGuestStateOnly voor versleuteling van alleen de VMGuestState-blob.

SecurityProfile

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

Name Type Description
encryptionAtHost

boolean

Deze eigenschap kan worden gebruikt door de gebruiker in de aanvraag om hostversleuteling voor de virtuele machine of virtuele-machineschaalset in of uit te schakelen. Hierdoor wordt de versleuteling ingeschakeld voor alle schijven, inclusief resource-/tijdelijke schijf op de host zelf. Raadpleeg https://learn.microsoft.com/azure/virtual-machines/disk-encryption#supported-vm-sizesvoor meer informatie over versleuteling bij hostvereisten.

proxyAgentSettings

ProxyAgentSettings

Hiermee geeft u ProxyAgent-instellingen op tijdens het maken van de virtuele machine.

securityType

SecurityTypes

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

uefiSettings

BatchUefiSettings

Hiermee geeft u de beveiligingsinstellingen op, zoals beveiligd opstarten en vTPM die worden gebruikt tijdens het maken van de virtuele machine. Hiermee geeft u de beveiligingsinstellingen op, zoals beveiligd opstarten en vTPM die worden gebruikt tijdens 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.

Waarde Description
trustedLaunch

Vertrouwde lancering beschermt tegen geavanceerde en permanente aanvalstechnieken.

confidentialvm

Azure Confidential Computing biedt vertrouwelijke VM's voor tenants met hoge vereisten voor beveiliging en vertrouwelijkheid. Deze VM's bieden een sterke, hardware-afgedwongen grens om te voldoen aan uw beveiligingsbehoeften. U kunt vertrouwelijke VM's gebruiken voor migraties zonder wijzigingen aan te brengen in uw code, waarbij het platform dat de status van uw VIRTUELE machine beveiligt, niet kan worden gelezen of gewijzigd.

ServiceArtifactReference

Hiermee geeft u de referentie-id voor serviceartefacten op die wordt gebruikt voor het instellen van dezelfde installatiekopieënversie voor alle virtuele machines in de schaalset wanneer u de meest recente installatiekopieënversie gebruikt.

Name Type Description
id

string

De referentie-ID van ServiceArtifactReference van het serviceartefact. De referentie-id van het serviceartefact in de vorm van /subscriptions/{subscriptionId}/resourceGroups/{resourceGroup}/providers/Microsoft.Compute/galleries/{galleryName}/serviceArtifacts/{serviceArtifactName}/vmArtifactsProfiles/{vmArtifactsProfilesName}

StorageAccountType

StorageAccountType enums

Waarde Description
standard_lrs

De gegevensschijf moet gebruikmaken van standaard lokaal redundante opslag.

premium_lrs

De gegevensschijf moet gebruikmaken van premium lokaal redundante opslag.

standardssd_lrs

De gegevensschijf/besturingssysteemschijf moet lokaal redundante standaard-SSD-opslag gebruiken.

UpgradeMode

UpgradeMode-enums

Waarde Description
automatic

Alle virtuele machines in de schaalset worden automatisch tegelijkertijd bijgewerkt.

manual

U bepaalt de toepassing van updates voor virtuele machines in de schaalset. U doet dit met behulp van de manualUpgrade-actie.

rolling

De bestaande exemplaren in een schaalset worden neergezet in batches die moeten worden bijgewerkt. Zodra de bijgewerkte batch is voltooid, beginnen de exemplaren opnieuw met verkeer en wordt de volgende batch gestart. Dit gaat door totdat alle exemplaren up-to-date zijn gebracht.

UpgradePolicy

Beschrijft een upgradebeleid: automatisch, handmatig of rolling.

Name Type Description
automaticOSUpgradePolicy

AutomaticOsUpgradePolicy

Configuratieparameters die worden gebruikt voor het uitvoeren van automatische upgrade van het besturingssysteem. De configuratieparameters die worden gebruikt voor het uitvoeren van automatische upgrade van het besturingssysteem.

mode

UpgradeMode

Hiermee geeft u de modus van een upgrade naar virtuele machines in de schaalset.

Mogelijke waarden zijn:

Handmatige: u bepaalt de toepassing van updates voor virtuele machines in de schaalset. U doet dit met behulp van de manualUpgrade-actie.

Automatisch: alle virtuele machines in de schaalset worden automatisch tegelijkertijd bijgewerkt.

Rolling - Schaalset voert updates uit in batches met een optionele onderbrekingstijd ertussen.

rollingUpgradePolicy

RollingUpgradePolicy

De configuratieparameters die worden gebruikt tijdens het uitvoeren van een rolling upgrade.

UserAccount

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

Name Type Description
elevationLevel

ElevationLevel

Het hoogteniveau van het gebruikersaccount. De standaardwaarde is nietAdmin.

linuxUserConfiguration

LinuxUserConfiguration

De Linux-specifieke gebruikersconfiguratie voor het gebruikersaccount. Deze eigenschap wordt genegeerd als deze is gespecificeerd op een Windows Pool. Als dit niet is opgegeven, wordt de gebruiker gemaakt met de standaardopties.

name

string

De naam van het gebruikersaccount. Namen kunnen Unicode-tekens bevatten tot een maximale lengte van 20.

password

string (password)

Het wachtwoord voor het gebruikersaccount.

windowsUserConfiguration

WindowsUserConfiguration

De Windows-specifieke gebruikersconfiguratie voor het gebruikersaccount. Deze eigenschap kan alleen worden gespecificeerd als de gebruiker zich op een Windows Pool bevindt. Als dit niet is gespecificeerd en op een Windows Pool zit, wordt de gebruiker aangemaakt met de standaardopties.

UserIdentity

De definitie van de gebruikersidentiteit waaronder de taak wordt uitgevoerd. Geef de eigenschap userName of autoUser op, maar niet beide.

Name Type Description
autoUser

AutoUserSpecification

De automatische gebruiker waaronder de taak wordt uitgevoerd. De eigenschappen userName en autoUser sluiten elkaar wederzijds uit; u moet één, maar niet beide opgeven.

username

string

De naam van de gebruikersidentiteit waaronder de taak wordt uitgevoerd. De eigenschappen userName en autoUser sluiten elkaar wederzijds uit; u moet één, maar niet beide opgeven.

VirtualMachineConfiguration

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

Name Type Description
containerConfiguration

BatchContainerConfiguration

De containerconfiguratie voor de Pool. Indien gespecificeerd, wordt de setup uitgevoerd op elke rekenknoop in de pool om taken in containers te laten draaien. Alle reguliere taken en taakmanagertaken die op deze pool draaien, moeten de containerSettings-eigenschap specificeren, en alle andere taken kunnen dit specificeren.

dataDisks

DataDisk[]

De configuratie voor datadisks die zijn aangesloten op de Compute Nodes in de pool. Deze eigenschap moet worden gespecificeerd als de rekenknooppunten in de pool lege datadisks aan zich moeten koppelen. Dit kan niet worden bijgewerkt. Elke Compute Node krijgt zijn eigen schijf (de schijf is geen bestandsdeling). Bestaande schijven kunnen niet worden aangesloten, elke aangesloten schijf is leeg. Wanneer de Compute Node uit de pool wordt verwijderd, worden de schijf en alle bijbehorende gegevens ook verwijderd. De schijf wordt niet geformatteerd nadat hij is aangesloten, hij moet voor gebruik worden geformatteerd - voor meer informatie zie https://learn.microsoft.com/azure/virtual-machines/linux/classic/attach-disk#initialize-a-new-data-disk-in-linux en https://learn.microsoft.com/azure/virtual-machines/windows/attach-disk-ps#add-an-empty-data-disk-to-a-virtual-machine.

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 genoemd, op elk knooppunt geïnstalleerd.

imageReference

BatchVmImageReference

Een verwijzing naar de Marketplace-installatiekopieën van Azure Virtual Machines of de aangepaste vm-installatiekopieën die u wilt gebruiken.

licenseType

string

Dit geldt alleen voor images die het Windows-besturingssysteem bevatten, en mogen alleen worden gebruikt als je geldige on-premises licenties hebt voor de Compute Nodes die worden uitgerold. Als u dit weglaat, wordt er geen korting op on-premises licenties 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 opdracht-en-beheerinterface 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 rekenknooppuntagent-SKU opgeven die overeenkomt met de geselecteerde afbeeldingsreferentie. Zie de bewerking Ondersteunde SKU's voor compute-knooppuntagenten samen met de lijst met geverifieerde afbeeldingsverwijzingen voor de lijst met ondersteunde SKU's voor compute-knooppuntagenten.

nodePlacementConfiguration

BatchNodePlacementConfiguration

De configuratie van de plaatsing van knooppunten voor de pool. Met deze configuratie worden regels opgegeven voor de manier waarop knooppunten in de pool fysiek worden toegewezen.

osDisk

BatchOsDisk

Instellingen voor de besturingssysteemschijf van de virtuele machine.

securityProfile

SecurityProfile

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 voor het instellen van dezelfde installatiekopieënversie voor alle virtuele machines in de schaalset wanneer u de meest recente installatiekopieënversie gebruikt. De referentie-id van het serviceartefact 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 gespecificeerd als de imageReference-eigenschap een Linux OS-image specificeert.

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 eenmaal is geïmplementeerd, worden er echter geen secundaire versies bijgewerkt, tenzij deze opnieuw wordt geïmplementeerd, zelfs niet 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 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

Openbare instellingen met JSON-indeling voor de extensie.

type

string

Het type verlenging.

typeHandlerVersion

string

De versie van de scripthandler.

WindowsConfiguration

Windows-besturingssysteeminstellingen die van toepassing zijn 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 waar.

WindowsUserConfiguration

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

Name Type Description
loginMode

LoginMode

De inlogmodus voor de gebruiker. De standaard is 'batch'.