Share via

Pool - Create

  • Referentie
Service:
Batch Management
API Version:
2024-02-01

Hiermee maakt u een nieuwe pool in het opgegeven account.

PUT https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Batch/batchAccounts/{accountName}/pools/{poolName}?api-version=2024-02-01

URI-parameters

Name In Vereist Type Description
accountName
 path True

string

De naam van het Batch-account.

Regex pattern: ^[a-zA-Z0-9]+$
poolName
 path True

string

De naam van de pool. Dit moet uniek zijn binnen het account.

Regex pattern: ^[a-zA-Z0-9_-]+$
resourceGroupName
 path True

string

De naam van de resourcegroep die het Batch-account bevat.
subscriptionId
 path True

string

De Azure-abonnements-id. Dit is een tekenreeks in GUID-indeling (bijvoorbeeld 000000000-0000-0000-0000-000000000000)
api-version
 query True

string

De API-versie die moet worden gebruikt met de HTTP-aanvraag.

Aanvraagkoptekst

Name Vereist Type Description
If-Match

string

De versie van de entiteitsstatus (ETag) van de pool die moet worden bijgewerkt. De waarde *kan alleen worden gebruikt om de bewerking toe te passen als de groep al bestaat. Als u dit weglaat, wordt deze bewerking altijd toegepast.
If-None-Match

string

Stel in op *om het maken van een nieuwe pool toe te staan, maar om te voorkomen dat een bestaande groep wordt bijgewerkt. Andere waarden worden genegeerd.

Aanvraagbody

Name Type Description
identity

BatchPoolIdentity

Het type identiteit dat wordt gebruikt voor de Batch-pool.
Het type identiteit dat wordt gebruikt voor de Batch-pool.
properties.applicationLicenses

string[]

De lijst met toepassingslicenties die de Batch-service beschikbaar maakt op elk rekenknooppunt in de pool.
De lijst met toepassingslicenties moet een subset zijn van beschikbare licenties voor Batch-servicetoepassingen. Als een licentie wordt aangevraagd die niet wordt ondersteund, mislukt het maken van de pool.
properties.applicationPackages

ApplicationPackageReference[]

De lijst met toepassingspakketten die moeten worden geïnstalleerd op elk rekenknooppunt in de pool.
Wijzigingen in verwijzingen naar toepassingspakketten zijn van invloed op alle nieuwe rekenknooppunten die lid worden van de pool, maar hebben geen invloed op rekenknooppunten die zich al in de pool bevinden totdat ze opnieuw worden opgestart of opnieuw zijn geïnstalleerd. Er zijn maximaal 10 verwijzingen naar toepassingspakketten voor een bepaalde groep.
properties.certificates

CertificateReference[]

De lijst met certificaten die op elk rekenknooppunt in de pool moeten worden geïnstalleerd.
Voor Windows-rekenknooppunten installeert de Batch-service de certificaten in het opgegeven certificaatarchief en de opgegeven locatie. Voor Linux-rekenknooppunten worden de certificaten opgeslagen in een map in de werkmap van de taak en wordt een omgevingsvariabele AZ_BATCH_CERTIFICATES_DIR opgegeven voor de taak om een query uit te voeren voor deze locatie. Voor certificaten met zichtbaarheid van 'remoteUser' wordt een map met certificaten gemaakt in de basismap van de gebruiker (bijvoorbeeld /home/{user-name}/certs) en worden certificaten in die map geplaatst.

Waarschuwing: deze eigenschap is afgeschaft en wordt na februari 2024 verwijderd. Gebruik in plaats daarvan de Azure KeyVault-extensie .
properties.deploymentConfiguration

DeploymentConfiguration

Deze eigenschap beschrijft hoe de poolknooppunten worden geïmplementeerd met behulp van Cloud Services of Virtual Machines.
Met CloudServiceConfiguration geeft u op dat de knooppunten moeten worden gemaakt met behulp van Azure Cloud Services (PaaS), terwijl VirtualMachineConfiguration Gebruikmaakt van Azure Virtual Machines (IaaS).
properties.displayName

string

De weergavenaam voor de pool.
De weergavenaam hoeft niet uniek te zijn en kan Unicode-tekens bevatten met een maximale lengte van 1024.
properties.interNodeCommunication

InterNodeCommunicationState

Of de pool directe communicatie tussen knooppunten toestaat.
Dit legt beperkingen op aan welke knooppunten kunnen worden toegewezen aan de pool. Als u deze waarde inschakelt, wordt de kans verkleind dat het aangevraagde aantal knooppunten in de pool wordt toegewezen. Als dit niet is opgegeven, wordt deze waarde standaard ingesteld op 'Uitgeschakeld'.
properties.metadata

MetadataItem[]

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

MountConfiguration[]

Een lijst met bestandssystemen die aan elk knooppunt in de pool moeten worden gekoppeld.
Dit ondersteunt Azure Files, NFS, CIFS/SMB en Blobfuse.
properties.networkConfiguration

NetworkConfiguration

De netwerkconfiguratie voor de pool.
De netwerkconfiguratie voor een pool.
properties.resourceTags

object

De door de gebruiker opgegeven tags die zijn gekoppeld aan de pool.
De door de gebruiker gedefinieerde tags die moeten worden gekoppeld aan de Azure Batch pool. Indien opgegeven, worden deze tags doorgegeven aan de back-up van Azure-resources die zijn gekoppeld aan de pool. Deze eigenschap kan alleen worden opgegeven wanneer het Batch-account is gemaakt met de eigenschap poolAllocationMode ingesteld op UserSubscription.
properties.scaleSettings

ScaleSettings

Instellingen waarmee het aantal knooppunten in de pool wordt geconfigureerd.
Hiermee definieert u de gewenste grootte van de pool. Dit kan 'fixedScale' zijn waarbij de aangevraagde targetDedicatedNodes is opgegeven, of 'autoScale' waarmee een formule wordt gedefinieerd die periodiek opnieuw wordt geëvalueerd. Als deze eigenschap niet is opgegeven, heeft de pool een vaste schaal met 0 targetDedicatedNodes.
properties.startTask

StartTask

Een taak die is opgegeven om te worden uitgevoerd op elk rekenknooppunt wanneer het lid wordt van de pool.
In een PATCH-bewerking (update) kan deze eigenschap worden ingesteld op een leeg object om de begintaak uit de pool te verwijderen.
properties.targetNodeCommunicationMode

NodeCommunicationMode

De gewenste knooppuntcommunicatiemodus voor de pool.
Als u dit weglaat, is de standaardwaarde Standaard.
properties.taskSchedulingPolicy

TaskSchedulingPolicy

Hoe taken worden verdeeld over rekenknooppunten in een pool.
Als dit niet is opgegeven, is de standaardwaarde spread.
properties.taskSlotsPerNode

integer

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

UpgradePolicy

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

UserAccount[]

De lijst met gebruikersaccounts die moeten worden gemaakt op elk knooppunt in de pool.
properties.vmSize

string

De grootte van virtuele machines in de pool. Alle VM's in een pool hebben dezelfde grootte.
Zie Grootten voor Cloud Services () voor informatie over de beschikbare grootten van virtuele machines voor Cloud Services pools (https://azure.microsoft.com/documentation/articles/cloud-services-sizes-specs/pools die zijn gemaakt met cloudServiceConfiguration). Batch ondersteunt alle vm-grootten van Cloud Services behalve ExtraSmall. Zie Grootten voor Virtual Machines (Linux) () of Grootten voor Virtual Machines (Windows)https://azure.microsoft.com/documentation/articles/virtual-machines-linux-sizes/ voor informatie over beschikbare VM-grootten voor pools met behulp van installatiekopieën uit de Virtual Machines Marketplace (pools die zijn gemaakt met virtualMachineConfiguration).https://azure.microsoft.com/documentation/articles/virtual-machines-windows-sizes/ Batch ondersteunt alle Vm-grootten van Azure, met uitzondering van STANDARD_A0 en grootten met Premium Storage (STANDARD_GS, STANDARD_DS en STANDARD_DSV2 serie).

Antwoorden

Name Type Description
200 OK

Pool

De bewerking is geslaagd. Het antwoord bevat de poolentiteit.

Headers

ETag: string
Other Status Codes

CloudError

Foutreactie waarin wordt beschreven waarom de bewerking is mislukt.

Beveiliging

azure_auth

Microsoft Entra OAuth 2.0-verificatiecodestroom

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

Scopes

Name Description
user_impersonation Uw gebruikersaccount imiteren

Voorbeelden

CreatePool - accelerated networking
CreatePool - Custom Image
CreatePool - Full CloudServiceConfiguration
CreatePool - Full VirtualMachineConfiguration
CreatePool - Minimal CloudServiceConfiguration
CreatePool - Minimal VirtualMachineConfiguration
CreatePool - No public IP
CreatePool - Public IPs
CreatePool - ResourceTags
CreatePool - SecurityProfile
CreatePool - UpgradePolicy
CreatePool - UserAssignedIdentities
CreatePool - VirtualMachineConfiguration Extensions
CreatePool - VirtualMachineConfiguration OSDisk
CreatePool - VirtualMachineConfiguration ServiceArtifactReference

CreatePool - accelerated networking

Sample Request

PUT https://management.azure.com/subscriptions/subid/resourceGroups/default-azurebatch-japaneast/providers/Microsoft.Batch/batchAccounts/sampleacct/pools/testpool?api-version=2024-02-01

{
  "properties": {
    "vmSize": "STANDARD_D1_V2",
    "networkConfiguration": {
      "subnetId": "/subscriptions/subid/resourceGroups/rg1234/providers/Microsoft.Network/virtualNetworks/network1234/subnets/subnet123",
      "enableAcceleratedNetworking": true
    },
    "deploymentConfiguration": {
      "virtualMachineConfiguration": {
        "imageReference": {
          "publisher": "MicrosoftWindowsServer",
          "offer": "WindowsServer",
          "sku": "2016-datacenter-smalldisk",
          "version": "latest"
        },
        "nodeAgentSkuId": "batch.node.windows amd64"
      }
    },
    "scaleSettings": {
      "fixedScale": {
        "targetDedicatedNodes": 1,
        "targetLowPriorityNodes": 0
      }
    }
  }
}

Sample Response

Status code:
200 
ETag: W/"0x8DB46CB72A227E2"
Response Body
{
  "id": "/subscriptions/subid/resourceGroups/default-azurebatch-japaneast/providers/Microsoft.Batch/batchAccounts/sampleacct/pools/testpool",
  "name": "testpool",
  "type": "Microsoft.Batch/batchAccounts/pools",
  "etag": "W/\"0x8DB46CB72A227E2\"",
  "properties": {
    "lastModified": "2023-04-27T02:59:41.8592226Z",
    "creationTime": "2023-04-27T02:59:41.8592226Z",
    "provisioningState": "Succeeded",
    "provisioningStateTransitionTime": "2023-04-27T02:59:41.8592226Z",
    "allocationState": "Steady",
    "allocationStateTransitionTime": "2023-04-27T03:00:34.0646502Z",
    "vmSize": "STANDARD_D1_V2",
    "interNodeCommunication": "Disabled",
    "taskSlotsPerNode": 1,
    "taskSchedulingPolicy": {
      "nodeFillType": "Spread"
    },
    "deploymentConfiguration": {
      "virtualMachineConfiguration": {
        "imageReference": {
          "publisher": "MicrosoftWindowsServer",
          "offer": "WindowsServer",
          "sku": "2016-datacenter-smalldisk",
          "version": "latest"
        },
        "nodeAgentSkuId": "batch.node.windows amd64"
      }
    },
    "networkConfiguration": {
      "subnetId": "/subscriptions/subid/resourceGroups/rg1234/providers/Microsoft.Network/virtualNetworks/network1234/subnets/subnet123",
      "dynamicVnetAssignmentScope": "none",
      "enableAcceleratedNetworking": true
    },
    "scaleSettings": {
      "fixedScale": {
        "targetDedicatedNodes": 1,
        "targetLowPriorityNodes": 0,
        "resizeTimeout": "PT15M"
      }
    },
    "resizeOperationStatus": {
      "targetDedicatedNodes": 1,
      "nodeDeallocationOption": "Requeue",
      "resizeTimeout": "PT15M",
      "startTime": "2023-04-27T02:59:41.8592226Z"
    },
    "currentDedicatedNodes": 1,
    "currentLowPriorityNodes": 0,
    "currentNodeCommunicationMode": "Classic"
  }
}

CreatePool - Custom Image

Sample Request

PUT https://management.azure.com/subscriptions/subid/resourceGroups/default-azurebatch-japaneast/providers/Microsoft.Batch/batchAccounts/sampleacct/pools/testpool?api-version=2024-02-01

{
  "properties": {
    "vmSize": "STANDARD_D4",
    "deploymentConfiguration": {
      "virtualMachineConfiguration": {
        "imageReference": {
          "id": "/subscriptions/subid/resourceGroups/networking-group/providers/Microsoft.Compute/galleries/testgallery/images/testimagedef/versions/0.0.1"
        },
        "nodeAgentSkuId": "batch.node.ubuntu 18.04"
      }
    }
  }
}

Sample Response

Status code:
200 
ETag: W/"0x8D4EDFEBFADF4AB"
Response Body
{
  "id": "/subscriptions/subid/resourceGroups/default-azurebatch-japaneast/providers/Microsoft.Batch/batchAccounts/sampleacct/pools/testpool",
  "name": "testpool",
  "type": "Microsoft.Batch/batchAccounts/pools",
  "etag": "W/\"0x8D4EDFEBFADF4AB\"",
  "properties": {
    "lastModified": "2017-08-28T10:22:55.9407275Z",
    "creationTime": "2017-08-28T10:22:55.9407275Z",
    "provisioningState": "Succeeded",
    "provisioningStateTransitionTime": "2017-08-28T10:22:55.9407275Z",
    "allocationState": "Steady",
    "allocationStateTransitionTime": "2017-08-28T10:22:55.9407275Z",
    "vmSize": "STANDARD_D4",
    "interNodeCommunication": "Disabled",
    "taskSlotsPerNode": 1,
    "taskSchedulingPolicy": {
      "nodeFillType": "Spread"
    },
    "deploymentConfiguration": {
      "virtualMachineConfiguration": {
        "imageReference": {
          "id": "/subscriptions/subid/resourceGroups/networking-group/providers/Microsoft.Compute/galleries/testgallery/images/testimagedef/versions/0.0.1"
        },
        "nodeAgentSkuId": "batch.node.ubuntu 18.04"
      }
    },
    "scaleSettings": {
      "fixedScale": {
        "targetDedicatedNodes": 0,
        "targetLowPriorityNodes": 0
      }
    },
    "currentDedicatedNodes": 0,
    "currentLowPriorityNodes": 0
  }
}

CreatePool - Full CloudServiceConfiguration

Sample Request

PUT https://management.azure.com/subscriptions/subid/resourceGroups/default-azurebatch-japaneast/providers/Microsoft.Batch/batchAccounts/sampleacct/pools/testpool?api-version=2024-02-01

{
  "properties": {
    "displayName": "my-pool-name",
    "vmSize": "STANDARD_D4",
    "interNodeCommunication": "Enabled",
    "taskSlotsPerNode": 13,
    "taskSchedulingPolicy": {
      "nodeFillType": "Pack"
    },
    "deploymentConfiguration": {
      "cloudServiceConfiguration": {
        "osFamily": "4",
        "osVersion": "WA-GUEST-OS-4.45_201708-01"
      }
    },
    "networkConfiguration": {
      "subnetId": "/subscriptions/subid/resourceGroups/rg1234/providers/Microsoft.Network/virtualNetworks/network1234/subnets/subnet123",
      "publicIPAddressConfiguration": {
        "provision": "UserManaged",
        "ipAddressIds": [
          "/subscriptions/subid1/resourceGroups/rg13/providers/Microsoft.Network/publicIPAddresses/ip135",
          "/subscriptions/subid2/resourceGroups/rg24/providers/Microsoft.Network/publicIPAddresses/ip268"
        ]
      }
    },
    "scaleSettings": {
      "fixedScale": {
        "targetDedicatedNodes": 6,
        "targetLowPriorityNodes": 28,
        "resizeTimeout": "PT8M",
        "nodeDeallocationOption": "TaskCompletion"
      }
    },
    "metadata": [
      {
        "name": "metadata-1",
        "value": "value-1"
      },
      {
        "name": "metadata-2",
        "value": "value-2"
      }
    ],
    "startTask": {
      "commandLine": "cmd /c SET",
      "resourceFiles": [
        {
          "httpUrl": "https://testaccount.blob.core.windows.net/example-blob-file",
          "filePath": "c:\\temp\\gohere",
          "fileMode": "777"
        }
      ],
      "environmentSettings": [
        {
          "name": "MYSET",
          "value": "1234"
        }
      ],
      "userIdentity": {
        "autoUser": {
          "scope": "Pool",
          "elevationLevel": "Admin"
        }
      },
      "maxTaskRetryCount": 6,
      "waitForSuccess": true
    },
    "userAccounts": [
      {
        "name": "username1",
        "password": "<ExamplePassword>",
        "elevationLevel": "Admin",
        "linuxUserConfiguration": {
          "sshPrivateKey": "sshprivatekeyvalue",
          "uid": 1234,
          "gid": 4567
        }
      }
    ],
    "applicationPackages": [
      {
        "id": "/subscriptions/subid/resourceGroups/default-azurebatch-japaneast/providers/Microsoft.Batch/batchAccounts/sampleacct/pools/testpool/applications/app_1234",
        "version": "asdf"
      }
    ],
    "certificates": [
      {
        "id": "/subscriptions/subid/resourceGroups/default-azurebatch-japaneast/providers/Microsoft.Batch/batchAccounts/sampleacct/pools/testpool/certificates/sha1-1234567",
        "storeLocation": "LocalMachine",
        "storeName": "MY",
        "visibility": [
          "RemoteUser"
        ]
      }
    ],
    "applicationLicenses": [
      "app-license0",
      "app-license1"
    ]
  }
}

Sample Response

Status code:
200 
ETag: W/"0x8D4EDFEBFADF4AB"
Response Body
{
  "id": "/subscriptions/subid/resourceGroups/default-azurebatch-japaneast/providers/Microsoft.Batch/batchAccounts/sampleacct/pools/testpool",
  "name": "testpool",
  "type": "Microsoft.Batch/batchAccounts/pools",
  "etag": "W/\"0x8D4EDFEBFADF4AB\"",
  "properties": {
    "lastModified": "2017-08-28T10:22:55.9407275Z",
    "creationTime": "2017-08-28T10:22:55.9407275Z",
    "provisioningState": "Succeeded",
    "provisioningStateTransitionTime": "2017-08-28T10:22:55.9407275Z",
    "allocationState": "Resizing",
    "allocationStateTransitionTime": "2017-08-28T10:22:55.9407275Z",
    "vmSize": "STANDARD_D4",
    "interNodeCommunication": "Enabled",
    "taskSlotsPerNode": 13,
    "taskSchedulingPolicy": {
      "nodeFillType": "Pack"
    },
    "deploymentConfiguration": {
      "cloudServiceConfiguration": {
        "osFamily": "4",
        "osVersion": "WA-GUEST-OS-4.45_201708-01"
      }
    },
    "scaleSettings": {
      "fixedScale": {
        "targetDedicatedNodes": 6,
        "targetLowPriorityNodes": 28,
        "resizeTimeout": "PT8M",
        "nodeDeallocationOption": "TaskCompletion"
      }
    },
    "networkConfiguration": {
      "subnetId": "/subscriptions/subid/resourceGroups/rg1234/providers/Microsoft.Network/virtualNetworks/network1234/subnets/subnet123",
      "publicIPAddressConfiguration": {
        "provision": "UserManaged",
        "ipAddressIds": [
          "/subscriptions/subid1/resourceGroups/rg13/providers/Microsoft.Network/publicIPAddresses/ip135",
          "/subscriptions/subid2/resourceGroups/rg24/providers/Microsoft.Network/publicIPAddresses/ip268"
        ]
      }
    },
    "metadata": [
      {
        "name": "metadata-1",
        "value": "value-1"
      },
      {
        "name": "metadata-2",
        "value": "value-2"
      }
    ],
    "startTask": {
      "commandLine": "cmd /c SET",
      "resourceFiles": [
        {
          "httpUrl": "https://testaccount.blob.core.windows.net/example-blob-file",
          "filePath": "c:\\temp\\gohere",
          "fileMode": "777"
        }
      ],
      "environmentSettings": [
        {
          "name": "MYSET",
          "value": "1234"
        }
      ],
      "userIdentity": {
        "autoUser": {
          "scope": "Pool",
          "elevationLevel": "Admin"
        }
      },
      "maxTaskRetryCount": 6,
      "waitForSuccess": true
    },
    "userAccounts": [
      {
        "name": "username1",
        "elevationLevel": "Admin",
        "linuxUserConfiguration": {
          "uid": 1234,
          "gid": 4567
        }
      }
    ],
    "applicationPackages": [
      {
        "id": "/subscriptions/subid/resourceGroups/default-azurebatch-japaneast/providers/Microsoft.Batch/batchAccounts/sampleacct/pools/testpool/applications/app_1234",
        "version": "asdf"
      }
    ],
    "certificates": [
      {
        "id": "/subscriptions/subid/resourceGroups/default-azurebatch-japaneast/providers/Microsoft.Batch/batchAccounts/sampleacct/pools/testpool/certificates/sha1-1234567",
        "storeLocation": "LocalMachine",
        "storeName": "MY",
        "visibility": [
          "RemoteUser"
        ]
      }
    ],
    "applicationLicenses": [
      "app-license0",
      "app-license1"
    ],
    "currentDedicatedNodes": 0,
    "currentLowPriorityNodes": 0
  }
}

CreatePool - Full VirtualMachineConfiguration

Sample Request

PUT https://management.azure.com/subscriptions/subid/resourceGroups/default-azurebatch-japaneast/providers/Microsoft.Batch/batchAccounts/sampleacct/pools/testpool?api-version=2024-02-01

{
  "properties": {
    "vmSize": "STANDARD_D4",
    "deploymentConfiguration": {
      "virtualMachineConfiguration": {
        "imageReference": {
          "publisher": "MicrosoftWindowsServer",
          "offer": "WindowsServer",
          "sku": "2016-Datacenter-SmallDisk",
          "version": "latest"
        },
        "nodeAgentSkuId": "batch.node.windows amd64",
        "windowsConfiguration": {
          "enableAutomaticUpdates": false
        },
        "licenseType": "Windows_Server",
        "dataDisks": [
          {
            "lun": 0,
            "caching": "ReadWrite",
            "diskSizeGB": 30,
            "storageAccountType": "Premium_LRS"
          },
          {
            "lun": 1,
            "caching": "None",
            "diskSizeGB": 200,
            "storageAccountType": "Standard_LRS"
          }
        ],
        "diskEncryptionConfiguration": {
          "targets": [
            "OsDisk",
            "TemporaryDisk"
          ]
        },
        "nodePlacementConfiguration": {
          "policy": "Zonal"
        },
        "osDisk": {
          "ephemeralOSDiskSettings": {
            "placement": "CacheDisk"
          }
        }
      }
    },
    "networkConfiguration": {
      "endpointConfiguration": {
        "inboundNatPools": [
          {
            "name": "testnat",
            "protocol": "TCP",
            "backendPort": 12001,
            "frontendPortRangeStart": 15000,
            "frontendPortRangeEnd": 15100,
            "networkSecurityGroupRules": [
              {
                "access": "Allow",
                "sourceAddressPrefix": "192.100.12.45",
                "priority": 150,
                "sourcePortRanges": [
                  "1",
                  "2"
                ]
              },
              {
                "access": "Deny",
                "sourceAddressPrefix": "*",
                "priority": 3500,
                "sourcePortRanges": [
                  "*"
                ]
              }
            ]
          }
        ]
      }
    },
    "scaleSettings": {
      "autoScale": {
        "formula": "$TargetDedicatedNodes=1",
        "evaluationInterval": "PT5M"
      }
    }
  }
}

Sample Response

Status code:
200 
ETag: W/"0x8D4EDFEBFADF4AB"
Response Body
{
  "id": "/subscriptions/subid/resourceGroups/default-azurebatch-japaneast/providers/Microsoft.Batch/batchAccounts/sampleacct/pools/testpool",
  "name": "testpool",
  "type": "Microsoft.Batch/batchAccounts/pools",
  "etag": "W/\"0x8D4EDFEBFADF4AB\"",
  "properties": {
    "lastModified": "2017-08-28T10:22:55.9407275Z",
    "creationTime": "2017-08-28T10:22:55.9407275Z",
    "provisioningState": "Succeeded",
    "provisioningStateTransitionTime": "2017-08-28T10:22:55.9407275Z",
    "allocationState": "Resizing",
    "allocationStateTransitionTime": "2017-08-28T10:22:55.9407275Z",
    "vmSize": "STANDARD_D4",
    "interNodeCommunication": "Disabled",
    "taskSlotsPerNode": 1,
    "taskSchedulingPolicy": {
      "nodeFillType": "Spread"
    },
    "deploymentConfiguration": {
      "virtualMachineConfiguration": {
        "imageReference": {
          "publisher": "MicrosoftWindowsServer",
          "offer": "WindowsServer",
          "sku": "2016-Datacenter-SmallDisk",
          "version": "latest"
        },
        "nodeAgentSkuId": "batch.node.windows amd64",
        "windowsConfiguration": {
          "enableAutomaticUpdates": false
        },
        "licenseType": "Windows_Server",
        "dataDisks": [
          {
            "lun": 0,
            "caching": "ReadWrite",
            "diskSizeGB": 30,
            "storageAccountType": "Premium_LRS"
          },
          {
            "lun": 1,
            "caching": "None",
            "diskSizeGB": 200,
            "storageAccountType": "Standard_LRS"
          }
        ],
        "diskEncryptionConfiguration": {
          "targets": [
            "OsDisk",
            "TemporaryDisk"
          ]
        },
        "nodePlacementConfiguration": {
          "policy": "Zonal"
        }
      }
    },
    "networkConfiguration": {
      "endpointConfiguration": {
        "inboundNatPools": [
          {
            "name": "testnat",
            "protocol": "TCP",
            "backendPort": 12001,
            "frontendPortRangeStart": 15000,
            "frontendPortRangeEnd": 15100,
            "networkSecurityGroupRules": [
              {
                "access": "Allow",
                "sourceAddressPrefix": "192.100.12.45",
                "priority": 150,
                "sourcePortRanges": [
                  "1",
                  "2"
                ]
              },
              {
                "access": "Deny",
                "sourceAddressPrefix": "*",
                "priority": 3500,
                "sourcePortRanges": [
                  "*"
                ]
              }
            ]
          }
        ]
      }
    },
    "scaleSettings": {
      "autoScale": {
        "formula": "$TargetDedicatedNodes=1",
        "evaluationInterval": "PT5M"
      }
    },
    "currentDedicatedNodes": 0,
    "currentLowPriorityNodes": 0
  }
}

CreatePool - Minimal CloudServiceConfiguration

Sample Request

PUT https://management.azure.com/subscriptions/subid/resourceGroups/default-azurebatch-japaneast/providers/Microsoft.Batch/batchAccounts/sampleacct/pools/testpool?api-version=2024-02-01

{
  "properties": {
    "vmSize": "STANDARD_D4",
    "deploymentConfiguration": {
      "cloudServiceConfiguration": {
        "osFamily": "5"
      }
    },
    "scaleSettings": {
      "fixedScale": {
        "targetDedicatedNodes": 3
      }
    }
  }
}

Sample Response

Status code:
200 
ETag: W/"0x8D4EDFEBFADF4AB"
Response Body
{
  "id": "/subscriptions/subid/resourceGroups/default-azurebatch-japaneast/providers/Microsoft.Batch/batchAccounts/sampleacct/pools/testpool",
  "name": "testpool",
  "type": "Microsoft.Batch/batchAccounts/pools",
  "etag": "W/\"0x8D4EDFEBFADF4AB\"",
  "properties": {
    "lastModified": "2017-08-28T10:22:55.9407275Z",
    "creationTime": "2017-08-28T10:22:55.9407275Z",
    "provisioningState": "Succeeded",
    "provisioningStateTransitionTime": "2017-08-28T10:22:55.9407275Z",
    "allocationState": "Resizing",
    "allocationStateTransitionTime": "2017-08-28T10:22:55.9407275Z",
    "vmSize": "STANDARD_D4",
    "interNodeCommunication": "Disabled",
    "taskSlotsPerNode": 1,
    "taskSchedulingPolicy": {
      "nodeFillType": "Spread"
    },
    "deploymentConfiguration": {
      "cloudServiceConfiguration": {
        "osFamily": "5",
        "osVersion": "*"
      }
    },
    "scaleSettings": {
      "fixedScale": {
        "targetDedicatedNodes": 3,
        "targetLowPriorityNodes": 0,
        "resizeTimeout": "PT15M"
      }
    },
    "currentDedicatedNodes": 0,
    "currentLowPriorityNodes": 0,
    "resizeOperationStatus": {
      "startTime": "2017-08-28T10:22:55.9407275Z",
      "targetDedicatedNodes": 3,
      "nodeDeallocationOption": "Requeue",
      "resizeTimeout": "PT15M"
    }
  }
}

CreatePool - Minimal VirtualMachineConfiguration

Sample Request

PUT https://management.azure.com/subscriptions/subid/resourceGroups/default-azurebatch-japaneast/providers/Microsoft.Batch/batchAccounts/sampleacct/pools/testpool?api-version=2024-02-01

{
  "properties": {
    "vmSize": "STANDARD_D4",
    "deploymentConfiguration": {
      "virtualMachineConfiguration": {
        "imageReference": {
          "publisher": "Canonical",
          "offer": "UbuntuServer",
          "sku": "18.04-LTS",
          "version": "latest"
        },
        "nodeAgentSkuId": "batch.node.ubuntu 18.04"
      }
    },
    "scaleSettings": {
      "autoScale": {
        "formula": "$TargetDedicatedNodes=1",
        "evaluationInterval": "PT5M"
      }
    }
  }
}

Sample Response

Status code:
200 
ETag: W/"0x8D4EDFEBFADF4AB"
Response Body
{
  "id": "/subscriptions/subid/resourceGroups/default-azurebatch-japaneast/providers/Microsoft.Batch/batchAccounts/sampleacct/pools/testpool",
  "name": "testpool",
  "type": "Microsoft.Batch/batchAccounts/pools",
  "etag": "W/\"0x8D4EDFEBFADF4AB\"",
  "properties": {
    "lastModified": "2017-08-28T10:22:55.9407275Z",
    "creationTime": "2017-08-28T10:22:55.9407275Z",
    "provisioningState": "Succeeded",
    "provisioningStateTransitionTime": "2017-08-28T10:22:55.9407275Z",
    "allocationState": "Resizing",
    "allocationStateTransitionTime": "2017-08-28T10:22:55.9407275Z",
    "vmSize": "STANDARD_D4",
    "interNodeCommunication": "Disabled",
    "taskSlotsPerNode": 1,
    "taskSchedulingPolicy": {
      "nodeFillType": "Spread"
    },
    "deploymentConfiguration": {
      "virtualMachineConfiguration": {
        "imageReference": {
          "publisher": "Canonical",
          "offer": "UbuntuServer",
          "sku": "18.04-LTS",
          "version": "latest"
        },
        "nodeAgentSkuId": "batch.node.ubuntu 18.04"
      }
    },
    "scaleSettings": {
      "autoScale": {
        "formula": "$TargetDedicatedNodes=1",
        "evaluationInterval": "PT5M"
      }
    },
    "currentDedicatedNodes": 0,
    "currentLowPriorityNodes": 0
  }
}

CreatePool - No public IP

Sample Request

PUT https://management.azure.com/subscriptions/subid/resourceGroups/default-azurebatch-japaneast/providers/Microsoft.Batch/batchAccounts/sampleacct/pools/testpool?api-version=2024-02-01

{
  "properties": {
    "vmSize": "STANDARD_D4",
    "networkConfiguration": {
      "subnetId": "/subscriptions/subid/resourceGroups/rg1234/providers/Microsoft.Network/virtualNetworks/network1234/subnets/subnet123",
      "publicIPAddressConfiguration": {
        "provision": "NoPublicIPAddresses"
      }
    },
    "deploymentConfiguration": {
      "virtualMachineConfiguration": {
        "imageReference": {
          "id": "/subscriptions/subid/resourceGroups/networking-group/providers/Microsoft.Compute/galleries/testgallery/images/testimagedef/versions/0.0.1"
        },
        "nodeAgentSkuId": "batch.node.ubuntu 18.04"
      }
    }
  }
}

Sample Response

Status code:
200 
ETag: W/"0x8D4EDFEBFADF4AB"
Response Body
{
  "id": "/subscriptions/subid/resourceGroups/default-azurebatch-japaneast/providers/Microsoft.Batch/batchAccounts/sampleacct/pools/testpool",
  "name": "testpool",
  "type": "Microsoft.Batch/batchAccounts/pools",
  "etag": "W/\"0x8D4EDFEBFADF4AB\"",
  "properties": {
    "lastModified": "2017-08-28T10:22:55.9407275Z",
    "creationTime": "2017-08-28T10:22:55.9407275Z",
    "provisioningState": "Succeeded",
    "provisioningStateTransitionTime": "2017-08-28T10:22:55.9407275Z",
    "allocationState": "Steady",
    "allocationStateTransitionTime": "2017-08-28T10:22:55.9407275Z",
    "vmSize": "STANDARD_D4",
    "interNodeCommunication": "Disabled",
    "taskSlotsPerNode": 1,
    "taskSchedulingPolicy": {
      "nodeFillType": "Spread"
    },
    "networkConfiguration": {
      "subnetId": "/subscriptions/subid/resourceGroups/rg1234/providers/Microsoft.Network/virtualNetworks/network1234/subnets/subnet123",
      "publicIPAddressConfiguration": {
        "provision": "NoPublicIPAddresses"
      }
    },
    "deploymentConfiguration": {
      "virtualMachineConfiguration": {
        "imageReference": {
          "id": "/subscriptions/subid/resourceGroups/networking-group/providers/Microsoft.Compute/galleries/testgallery/images/testimagedef/versions/0.0.1"
        },
        "nodeAgentSkuId": "batch.node.ubuntu 18.04"
      }
    },
    "scaleSettings": {
      "fixedScale": {
        "targetDedicatedNodes": 0,
        "targetLowPriorityNodes": 0
      }
    },
    "currentDedicatedNodes": 0,
    "currentLowPriorityNodes": 0
  }
}

CreatePool - Public IPs

Sample Request

PUT https://management.azure.com/subscriptions/subid/resourceGroups/default-azurebatch-japaneast/providers/Microsoft.Batch/batchAccounts/sampleacct/pools/testpool?api-version=2024-02-01

{
  "properties": {
    "vmSize": "STANDARD_D4",
    "networkConfiguration": {
      "subnetId": "/subscriptions/subid/resourceGroups/rg1234/providers/Microsoft.Network/virtualNetworks/network1234/subnets/subnet123",
      "publicIPAddressConfiguration": {
        "provision": "UserManaged",
        "ipAddressIds": [
          "/subscriptions/subid1/resourceGroups/rg13/providers/Microsoft.Network/publicIPAddresses/ip135"
        ]
      }
    },
    "deploymentConfiguration": {
      "virtualMachineConfiguration": {
        "imageReference": {
          "id": "/subscriptions/subid/resourceGroups/networking-group/providers/Microsoft.Compute/galleries/testgallery/images/testimagedef/versions/0.0.1"
        },
        "nodeAgentSkuId": "batch.node.ubuntu 18.04"
      }
    }
  }
}

Sample Response

Status code:
200 
ETag: W/"0x8D4EDFEBFADF4AB"
Response Body
{
  "id": "/subscriptions/subid/resourceGroups/default-azurebatch-japaneast/providers/Microsoft.Batch/batchAccounts/sampleacct/pools/testpool",
  "name": "testpool",
  "type": "Microsoft.Batch/batchAccounts/pools",
  "etag": "W/\"0x8D4EDFEBFADF4AB\"",
  "properties": {
    "lastModified": "2017-08-28T10:22:55.9407275Z",
    "creationTime": "2017-08-28T10:22:55.9407275Z",
    "provisioningState": "Succeeded",
    "provisioningStateTransitionTime": "2017-08-28T10:22:55.9407275Z",
    "allocationState": "Steady",
    "allocationStateTransitionTime": "2017-08-28T10:22:55.9407275Z",
    "vmSize": "STANDARD_D4",
    "interNodeCommunication": "Disabled",
    "taskSlotsPerNode": 1,
    "taskSchedulingPolicy": {
      "nodeFillType": "Spread"
    },
    "networkConfiguration": {
      "subnetId": "/subscriptions/subid/resourceGroups/rg1234/providers/Microsoft.Network/virtualNetworks/network1234/subnets/subnet123",
      "publicIPAddressConfiguration": {
        "provision": "UserManaged",
        "ipAddressIds": [
          "/subscriptions/subid1/resourceGroups/rg13/providers/Microsoft.Network/publicIPAddresses/ip135"
        ]
      }
    },
    "deploymentConfiguration": {
      "virtualMachineConfiguration": {
        "imageReference": {
          "id": "/subscriptions/subid/resourceGroups/networking-group/providers/Microsoft.Compute/galleries/testgallery/images/testimagedef/versions/0.0.1"
        },
        "nodeAgentSkuId": "batch.node.ubuntu 18.04"
      }
    },
    "scaleSettings": {
      "fixedScale": {
        "targetDedicatedNodes": 0,
        "targetLowPriorityNodes": 0
      }
    },
    "currentDedicatedNodes": 0,
    "currentLowPriorityNodes": 0
  }
}

CreatePool - ResourceTags

Sample Request

PUT https://management.azure.com/subscriptions/subid/resourceGroups/default-azurebatch-japaneast/providers/Microsoft.Batch/batchAccounts/sampleacct/pools/testpool?api-version=2024-02-01

{
  "properties": {
    "vmSize": "Standard_d4s_v3",
    "deploymentConfiguration": {
      "virtualMachineConfiguration": {
        "imageReference": {
          "publisher": "Canonical",
          "offer": "UbuntuServer",
          "sku": "18_04-lts-gen2",
          "version": "latest"
        },
        "nodeAgentSkuId": "batch.node.ubuntu 18.04"
      }
    },
    "resourceTags": {
      "TagName1": "TagValue1",
      "TagName2": "TagValue2"
    },
    "scaleSettings": {
      "fixedScale": {
        "targetDedicatedNodes": 1,
        "targetLowPriorityNodes": 0
      }
    }
  }
}

Sample Response

Status code:
200 
ETag: W/"0x8DB554F8E08BCF4"
Response Body
{
  "id": "/subscriptions/subid/resourceGroups/default-azurebatch-japaneast/providers/Microsoft.Batch/batchAccounts/sampleacct/pools/testpool",
  "name": "testpool",
  "type": "Microsoft.Batch/batchAccounts/pools",
  "etag": "W/\"0x8DB554F8E08BCF4\"",
  "properties": {
    "lastModified": "2023-06-14T07:03:58.3231917Z",
    "creationTime": "2023-06-14T07:03:58.3231917Z",
    "provisioningState": "Succeeded",
    "provisioningStateTransitionTime": "2023-06-14T07:03:58.3231917Z",
    "allocationState": "Resizing",
    "allocationStateTransitionTime": "2023-06-14T07:03:58.3231917Z",
    "vmSize": "STANDARD_D4S_V3",
    "interNodeCommunication": "Disabled",
    "taskSlotsPerNode": 1,
    "taskSchedulingPolicy": {
      "nodeFillType": "Spread"
    },
    "deploymentConfiguration": {
      "virtualMachineConfiguration": {
        "imageReference": {
          "publisher": "Canonical",
          "offer": "UbuntuServer",
          "sku": "18_04-lts-gen2",
          "version": "latest"
        },
        "nodeAgentSkuId": "batch.node.ubuntu 18.04"
      }
    },
    "scaleSettings": {
      "fixedScale": {
        "targetDedicatedNodes": 1,
        "targetLowPriorityNodes": 0,
        "resizeTimeout": "PT15M"
      }
    },
    "resizeOperationStatus": {
      "targetDedicatedNodes": 1,
      "nodeDeallocationOption": "Requeue",
      "resizeTimeout": "PT15M",
      "startTime": "2023-09-27T07:33:13.0625789Z"
    },
    "currentDedicatedNodes": 0,
    "currentLowPriorityNodes": 0,
    "resourceTags": {
      "TagName1": "TagValue1",
      "TagName2": "TagValue2"
    }
  }
}

CreatePool - SecurityProfile

Sample Request

PUT https://management.azure.com/subscriptions/subid/resourceGroups/default-azurebatch-japaneast/providers/Microsoft.Batch/batchAccounts/sampleacct/pools/testpool?api-version=2024-02-01

{
  "properties": {
    "vmSize": "Standard_d4s_v3",
    "deploymentConfiguration": {
      "virtualMachineConfiguration": {
        "imageReference": {
          "publisher": "Canonical",
          "offer": "UbuntuServer",
          "sku": "18_04-lts-gen2",
          "version": "latest"
        },
        "nodeAgentSkuId": "batch.node.ubuntu 18.04",
        "securityProfile": {
          "securityType": "trustedLaunch",
          "encryptionAtHost": true,
          "uefiSettings": {
            "secureBootEnabled": null,
            "vTpmEnabled": false
          }
        }
      }
    },
    "scaleSettings": {
      "fixedScale": {
        "targetDedicatedNodes": 1,
        "targetLowPriorityNodes": 0
      }
    }
  }
}

Sample Response

Status code:
200 
ETag: W/"0x8DB554F8E08BCF4"
Response Body
{
  "id": "/subscriptions/subid/resourceGroups/default-azurebatch-japaneast/providers/Microsoft.Batch/batchAccounts/sampleacct/pools/testpool",
  "name": "testpool",
  "type": "Microsoft.Batch/batchAccounts/pools",
  "etag": "W/\"0x8DB554F8E08BCF4\"",
  "properties": {
    "lastModified": "2023-06-14T07:03:58.3231917Z",
    "creationTime": "2023-06-14T07:03:58.3231917Z",
    "provisioningState": "Succeeded",
    "provisioningStateTransitionTime": "2023-06-14T07:03:58.3231917Z",
    "allocationState": "Resizing",
    "allocationStateTransitionTime": "2023-06-14T07:03:58.3231917Z",
    "vmSize": "STANDARD_D4S_V3",
    "interNodeCommunication": "Disabled",
    "taskSlotsPerNode": 1,
    "taskSchedulingPolicy": {
      "nodeFillType": "Spread"
    },
    "deploymentConfiguration": {
      "virtualMachineConfiguration": {
        "imageReference": {
          "publisher": "Canonical",
          "offer": "UbuntuServer",
          "sku": "18_04-lts-gen2",
          "version": "latest"
        },
        "nodeAgentSkuId": "batch.node.ubuntu 18.04",
        "securityProfile": {
          "securityType": "trustedLaunch",
          "encryptionAtHost": true,
          "uefiSettings": {
            "vTpmEnabled": false
          }
        }
      }
    },
    "scaleSettings": {
      "fixedScale": {
        "targetDedicatedNodes": 1,
        "targetLowPriorityNodes": 0,
        "resizeTimeout": "PT15M"
      }
    },
    "resizeOperationStatus": {
      "targetDedicatedNodes": 1,
      "nodeDeallocationOption": "Requeue",
      "resizeTimeout": "PT15M",
      "startTime": "2023-06-14T07:03:58.3231917Z"
    },
    "currentDedicatedNodes": 0,
    "currentLowPriorityNodes": 0
  }
}

CreatePool - UpgradePolicy

Sample Request

PUT https://management.azure.com/subscriptions/subid/resourceGroups/default-azurebatch-japaneast/providers/Microsoft.Batch/batchAccounts/sampleacct/pools/testpool?api-version=2024-02-01

{
  "properties": {
    "vmSize": "Standard_d4s_v3",
    "deploymentConfiguration": {
      "virtualMachineConfiguration": {
        "imageReference": {
          "publisher": "MicrosoftWindowsServer",
          "offer": "WindowsServer",
          "sku": "2019-datacenter-smalldisk",
          "version": "latest"
        },
        "nodePlacementConfiguration": {
          "policy": "Zonal"
        },
        "nodeAgentSkuId": "batch.node.windows amd64",
        "windowsConfiguration": {
          "enableAutomaticUpdates": false
        }
      }
    },
    "scaleSettings": {
      "fixedScale": {
        "targetDedicatedNodes": 2,
        "targetLowPriorityNodes": 0
      }
    },
    "upgradePolicy": {
      "mode": "automatic",
      "automaticOSUpgradePolicy": {
        "disableAutomaticRollback": true,
        "enableAutomaticOSUpgrade": true,
        "useRollingUpgradePolicy": true,
        "osRollingUpgradeDeferral": true
      },
      "rollingUpgradePolicy": {
        "enableCrossZoneUpgrade": true,
        "maxBatchInstancePercent": 20,
        "maxUnhealthyInstancePercent": 20,
        "maxUnhealthyUpgradedInstancePercent": 20,
        "pauseTimeBetweenBatches": "PT0S",
        "prioritizeUnhealthyInstances": false,
        "rollbackFailedInstancesOnPolicyBreach": false
      }
    }
  }
}

Sample Response

Status code:
200 
ETag: W/"0x8DB51E64D3C3B69"
Response Body
{
  "id": "/subscriptions/subid/resourceGroups/default-azurebatch-japaneast/providers/Microsoft.Batch/batchAccounts/sampleacct/pools/testpool",
  "name": "testpool",
  "type": "Microsoft.Batch/batchAccounts/pools",
  "etag": "W/\"0x8DB51E64D3C3B69\"",
  "properties": {
    "lastModified": "2023-05-11T06:16:44.2372184Z",
    "creationTime": "2023-05-11T06:16:44.2372184Z",
    "provisioningState": "Succeeded",
    "provisioningStateTransitionTime": "2023-05-11T06:16:44.2372184Z",
    "allocationState": "Resizing",
    "allocationStateTransitionTime": "2023-05-11T06:16:44.2372184Z",
    "vmSize": "STANDARD_D4S_V3",
    "interNodeCommunication": "Disabled",
    "taskSlotsPerNode": 1,
    "taskSchedulingPolicy": {
      "nodeFillType": "Spread"
    },
    "deploymentConfiguration": {
      "virtualMachineConfiguration": {
        "imageReference": {
          "publisher": "MicrosoftWindowsServer",
          "offer": "WindowsServer",
          "sku": "2019-datacenter-smalldisk",
          "version": "latest"
        },
        "nodeAgentSkuId": "batch.node.windows amd64",
        "windowsConfiguration": {
          "enableAutomaticUpdates": false
        },
        "nodePlacementConfiguration": {
          "policy": "Zonal"
        }
      }
    },
    "scaleSettings": {
      "fixedScale": {
        "targetDedicatedNodes": 2,
        "targetLowPriorityNodes": 0,
        "resizeTimeout": "PT15M"
      }
    },
    "resizeOperationStatus": {
      "targetDedicatedNodes": 2,
      "nodeDeallocationOption": "Requeue",
      "resizeTimeout": "PT15M",
      "startTime": "2023-05-11T06:16:44.2372184Z"
    },
    "currentDedicatedNodes": 0,
    "currentLowPriorityNodes": 0,
    "upgradePolicy": {
      "mode": "automatic",
      "automaticOSUpgradePolicy": {
        "disableAutomaticRollback": true,
        "enableAutomaticOSUpgrade": true,
        "useRollingUpgradePolicy": true,
        "osRollingUpgradeDeferral": true
      },
      "rollingUpgradePolicy": {
        "enableCrossZoneUpgrade": true,
        "maxBatchInstancePercent": 20,
        "maxUnhealthyInstancePercent": 20,
        "maxUnhealthyUpgradedInstancePercent": 20,
        "pauseTimeBetweenBatches": "PT0S",
        "prioritizeUnhealthyInstances": false,
        "rollbackFailedInstancesOnPolicyBreach": false
      }
    }
  }
}

CreatePool - UserAssignedIdentities

Sample Request

PUT https://management.azure.com/subscriptions/subid/resourceGroups/default-azurebatch-japaneast/providers/Microsoft.Batch/batchAccounts/sampleacct/pools/testpool?api-version=2024-02-01

{
  "properties": {
    "vmSize": "STANDARD_D4",
    "deploymentConfiguration": {
      "virtualMachineConfiguration": {
        "imageReference": {
          "publisher": "Canonical",
          "offer": "UbuntuServer",
          "sku": "18.04-LTS",
          "version": "latest"
        },
        "nodeAgentSkuId": "batch.node.ubuntu 18.04"
      }
    },
    "scaleSettings": {
      "autoScale": {
        "formula": "$TargetDedicatedNodes=1",
        "evaluationInterval": "PT5M"
      }
    }
  },
  "identity": {
    "type": "UserAssigned",
    "userAssignedIdentities": {
      "/subscriptions/subid/resourceGroups/default-azurebatch-japaneast/providers/Microsoft.ManagedIdentity/userAssignedIdentities/id1": {},
      "/subscriptions/subid/resourceGroups/default-azurebatch-japaneast/providers/Microsoft.ManagedIdentity/userAssignedIdentities/id2": {}
    }
  }
}

Sample Response

Status code:
200 
ETag: W/"0x8D4EDFEBFADF4AB"
Response Body
{
  "id": "/subscriptions/subid/resourceGroups/default-azurebatch-japaneast/providers/Microsoft.Batch/batchAccounts/sampleacct/pools/testpool",
  "name": "testpool",
  "type": "Microsoft.Batch/batchAccounts/pools",
  "etag": "W/\"0x8D4EDFEBFADF4AB\"",
  "properties": {
    "lastModified": "2020-10-01T10:22:55.9407275Z",
    "creationTime": "2020-10-01T10:22:55.9407275Z",
    "provisioningState": "Succeeded",
    "provisioningStateTransitionTime": "2020-10-01T10:22:55.9407275Z",
    "allocationState": "Resizing",
    "allocationStateTransitionTime": "2020-10-01T10:22:55.9407275Z",
    "vmSize": "STANDARD_D4",
    "interNodeCommunication": "Disabled",
    "taskSlotsPerNode": 1,
    "taskSchedulingPolicy": {
      "nodeFillType": "Spread"
    },
    "deploymentConfiguration": {
      "virtualMachineConfiguration": {
        "imageReference": {
          "publisher": "Canonical",
          "offer": "UbuntuServer",
          "sku": "18.04-LTS",
          "version": "latest"
        },
        "nodeAgentSkuId": "batch.node.ubuntu 18.04"
      }
    },
    "scaleSettings": {
      "autoScale": {
        "formula": "$TargetDedicatedNodes=1",
        "evaluationInterval": "PT5M"
      }
    },
    "currentDedicatedNodes": 0,
    "currentLowPriorityNodes": 0
  },
  "identity": {
    "type": "UserAssigned",
    "userAssignedIdentities": {
      "/subscriptions/subid/resourceGroups/default-azurebatch-japaneast/providers/Microsoft.ManagedIdentity/userAssignedIdentities/id1": {
        "principalId": "principalId1",
        "clientId": "clientId1"
      },
      "/subscriptions/subid/resourceGroups/default-azurebatch-japaneast/providers/Microsoft.ManagedIdentity/userAssignedIdentities/id2": {
        "principalId": "principalId2",
        "clientId": "clientId2"
      }
    }
  }
}

CreatePool - VirtualMachineConfiguration Extensions

Sample Request

PUT https://management.azure.com/subscriptions/subid/resourceGroups/default-azurebatch-japaneast/providers/Microsoft.Batch/batchAccounts/sampleacct/pools/testpool?api-version=2024-02-01

{
  "properties": {
    "vmSize": "STANDARD_D4",
    "scaleSettings": {
      "autoScale": {
        "formula": "$TargetDedicatedNodes=1",
        "evaluationInterval": "PT5M"
      }
    },
    "deploymentConfiguration": {
      "virtualMachineConfiguration": {
        "imageReference": {
          "publisher": "Canonical",
          "offer": "0001-com-ubuntu-server-focal",
          "sku": "20_04-lts"
        },
        "nodeAgentSkuId": "batch.node.ubuntu 20.04",
        "extensions": [
          {
            "name": "batchextension1",
            "type": "KeyVaultForLinux",
            "publisher": "Microsoft.Azure.KeyVault",
            "typeHandlerVersion": "2.0",
            "autoUpgradeMinorVersion": true,
            "enableAutomaticUpgrade": true,
            "settings": {
              "secretsManagementSettingsKey": "secretsManagementSettingsValue",
              "authenticationSettingsKey": "authenticationSettingsValue"
            }
          }
        ]
      }
    },
    "targetNodeCommunicationMode": "Default"
  }
}

Sample Response

Status code:
200 
ETag: W/"0x8D4EDFEBFADF4AB"
Response Body
{
  "id": "/subscriptions/subid/resourceGroups/default-azurebatch-japaneast/providers/Microsoft.Batch/batchAccounts/sampleacct/pools/testpool",
  "name": "testpool",
  "type": "Microsoft.Batch/batchAccounts/pools",
  "etag": "W/\"0x8D4EDFEBFADF4AB\"",
  "properties": {
    "lastModified": "2017-08-28T10:22:55.9407275Z",
    "creationTime": "2017-08-28T10:22:55.9407275Z",
    "provisioningState": "Succeeded",
    "provisioningStateTransitionTime": "2017-08-28T10:22:55.9407275Z",
    "allocationState": "Resizing",
    "allocationStateTransitionTime": "2017-08-28T10:22:55.9407275Z",
    "vmSize": "STANDARD_D4",
    "interNodeCommunication": "Disabled",
    "taskSlotsPerNode": 1,
    "taskSchedulingPolicy": {
      "nodeFillType": "Spread"
    },
    "scaleSettings": {
      "autoScale": {
        "formula": "$TargetDedicatedNodes=1",
        "evaluationInterval": "PT5M"
      }
    },
    "currentDedicatedNodes": 0,
    "currentLowPriorityNodes": 0,
    "deploymentConfiguration": {
      "virtualMachineConfiguration": {
        "imageReference": {
          "publisher": "Canonical",
          "offer": "0001-com-ubuntu-server-focal",
          "sku": "20_04-lts"
        },
        "nodeAgentSkuId": "batch.node.ubuntu 20.04",
        "extensions": [
          {
            "name": "batchextension1",
            "type": "KeyVaultForLinux",
            "publisher": "Microsoft.Azure.KeyVault",
            "typeHandlerVersion": "2.0",
            "autoUpgradeMinorVersion": true,
            "enableAutomaticUpgrade": true,
            "settings": {
              "secretsManagementSettingsKey": "secretsManagementSettingsValue",
              "authenticationSettingsKey": "authenticationSettingsValue"
            }
          }
        ]
      }
    },
    "targetNodeCommunicationMode": "Default"
  }
}

CreatePool - VirtualMachineConfiguration OSDisk

Sample Request

PUT https://management.azure.com/subscriptions/subid/resourceGroups/default-azurebatch-japaneast/providers/Microsoft.Batch/batchAccounts/sampleacct/pools/testpool?api-version=2024-02-01

{
  "properties": {
    "vmSize": "Standard_d2s_v3",
    "deploymentConfiguration": {
      "virtualMachineConfiguration": {
        "imageReference": {
          "publisher": "microsoftwindowsserver",
          "offer": "windowsserver",
          "sku": "2022-datacenter-smalldisk"
        },
        "osDisk": {
          "diskSizeGB": 100,
          "managedDisk": {
            "storageAccountType": "StandardSSD_LRS"
          },
          "caching": "ReadWrite",
          "writeAcceleratorEnabled": false
        },
        "nodeAgentSkuId": "batch.node.windows amd64"
      }
    },
    "scaleSettings": {
      "fixedScale": {
        "targetDedicatedNodes": 1,
        "targetLowPriorityNodes": 0
      }
    }
  }
}

Sample Response

Status code:
200 
ETag: W/"0x8DB51F14DC1A8AD"
Response Body
{
  "id": "/subscriptions/subid/resourceGroups/default-azurebatch-japaneast/providers/Microsoft.Batch/batchAccounts/sampleacct/pools/testpool",
  "name": "testpool",
  "type": "Microsoft.Batch/batchAccounts/pools",
  "etag": "W/\"0x8DB51F396992B8D\"",
  "properties": {
    "lastModified": "2023-08-24T02:12:27.7527697Z",
    "creationTime": "2023-08-24T02:12:27.7527697Z",
    "provisioningState": "Succeeded",
    "provisioningStateTransitionTime": "2023-08-24T02:12:27.7527697Z",
    "allocationState": "Resizing",
    "allocationStateTransitionTime": "2023-08-24T02:12:27.7527697Z",
    "vmSize": "STANDARD_D2_V3",
    "interNodeCommunication": "Disabled",
    "taskSlotsPerNode": 1,
    "taskSchedulingPolicy": {
      "nodeFillType": "Spread"
    },
    "deploymentConfiguration": {
      "virtualMachineConfiguration": {
        "imageReference": {
          "publisher": "microsoftwindowsserver",
          "offer": "windowsserver",
          "sku": "2022-datacenter-smalldisk",
          "version": "latest"
        },
        "nodeAgentSkuId": "batch.node.windows amd64",
        "osDisk": {
          "caching": "ReadWrite",
          "managedDisk": {
            "storageAccountType": "StandardSSD_LRS"
          },
          "diskSizeGB": 100,
          "writeAcceleratorEnabled": false
        }
      }
    },
    "scaleSettings": {
      "fixedScale": {
        "targetDedicatedNodes": 1,
        "targetLowPriorityNodes": 0,
        "resizeTimeout": "PT15M"
      }
    },
    "resizeOperationStatus": {
      "targetDedicatedNodes": 1,
      "nodeDeallocationOption": "Requeue",
      "resizeTimeout": "PT15M",
      "startTime": "2023-08-24T02:12:27.7527697Z"
    },
    "currentDedicatedNodes": 0,
    "currentLowPriorityNodes": 0
  }
}

CreatePool - VirtualMachineConfiguration ServiceArtifactReference

Sample Request

PUT https://management.azure.com/subscriptions/subid/resourceGroups/default-azurebatch-japaneast/providers/Microsoft.Batch/batchAccounts/sampleacct/pools/testpool?api-version=2024-02-01

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

Sample Response

Status code:
200 
ETag: W/"0x8DB51F14DC1A8AD"
Response Body
{
  "id": "/subscriptions/subid/resourceGroups/default-azurebatch-japaneast/providers/Microsoft.Batch/batchAccounts/sampleacct/pools/testpool",
  "name": "mypool41",
  "type": "Microsoft.Batch/batchAccounts/pools",
  "etag": "W/\"0x8DB51F396992B8D\"",
  "properties": {
    "lastModified": "2023-05-11T07:44:44.8580493Z",
    "creationTime": "2023-05-11T07:44:44.8580493Z",
    "provisioningState": "Succeeded",
    "provisioningStateTransitionTime": "2023-05-11T07:44:44.8580493Z",
    "allocationState": "Resizing",
    "allocationStateTransitionTime": "2023-05-11T07:44:44.8580493Z",
    "vmSize": "STANDARD_D4S_V3",
    "interNodeCommunication": "Disabled",
    "taskSlotsPerNode": 1,
    "taskSchedulingPolicy": {
      "nodeFillType": "Spread"
    },
    "deploymentConfiguration": {
      "virtualMachineConfiguration": {
        "imageReference": {
          "publisher": "MicrosoftWindowsServer",
          "offer": "WindowsServer",
          "sku": "2019-datacenter-smalldisk",
          "version": "latest"
        },
        "nodeAgentSkuId": "batch.node.windows amd64",
        "windowsConfiguration": {
          "enableAutomaticUpdates": false
        },
        "serviceArtifactReference": {
          "id": "/subscriptions/subid/resourceGroups/default-azurebatch-japaneast/providers/Microsoft.Compute/galleries/myGallery/serviceArtifacts/myServiceArtifact/vmArtifactsProfiles/vmArtifactsProfile"
        }
      }
    },
    "scaleSettings": {
      "fixedScale": {
        "targetDedicatedNodes": 2,
        "targetLowPriorityNodes": 0,
        "resizeTimeout": "PT15M"
      }
    },
    "resizeOperationStatus": {
      "targetDedicatedNodes": 2,
      "nodeDeallocationOption": "Requeue",
      "resizeTimeout": "PT15M",
      "startTime": "2023-05-11T07:44:44.8580493Z"
    },
    "currentDedicatedNodes": 0,
    "currentLowPriorityNodes": 0,
    "upgradePolicy": {
      "mode": "automatic",
      "automaticOSUpgradePolicy": {
        "enableAutomaticOSUpgrade": true
      }
    }
  }
}

Definities

Name Description
AllocationState

Of de grootte van de pool wordt gewijzigd.
ApplicationPackageReference

Een koppeling maken naar een toepassingspakket in het batch-account
AutomaticOSUpgradePolicy

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

De resultaten en fouten van een uitvoering van een formule voor automatische schaalaanpassing van groepen.
AutoScaleRunError

Een fout die is opgetreden bij het automatisch schalen van een pool.
AutoScaleSettings

Instellingen voor automatische schaalaanpassing voor de pool.
AutoUserScope

Het bereik voor de automatische gebruiker
AutoUserSpecification

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

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

Informatie die wordt gebruikt om verbinding te maken met een Azure-bestandsshare.
BatchPoolIdentity

De identiteit van de Batch-pool, indien geconfigureerd. Als de poolidentiteit wordt bijgewerkt tijdens het bijwerken van een bestaande pool, hebben alleen de nieuwe vm's die worden gemaakt nadat de pool is verkleind naar 0, de bijgewerkte identiteiten
CachingType

Het type cache dat moet worden ingeschakeld voor de schijf.
CertificateReference

Een verwijzing naar een certificaat dat moet worden geïnstalleerd op rekenknooppunten in een pool. Dit moet zich in hetzelfde account bevinden als de pool.
CertificateStoreLocation

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

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

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

Een foutreactie van de Batch-service.
CloudErrorBody

Een foutreactie van de Batch-service.
CloudServiceConfiguration

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

Bepaalt wat er moet worden gedaan met een knooppunt en de bijbehorende actieve taak(en) nadat het is geselecteerd voor deallocatie.
ComputeNodeFillType

Hoe taken moeten worden verdeeld over rekenknooppunten.
ComputeNodeIdentityReference

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

De configuratie voor pools met container.
ContainerRegistry

Een privécontainerregister.
ContainerType

De te gebruiken containertechnologie.
ContainerWorkingDirectory

Een vlag om aan te geven waar de werkmap van de containertaak zich bevindt. De standaardwaarde is taskWorkingDirectory.
DataDisk

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

Eigenschappen van implementatieconfiguratie.
DiffDiskPlacement

Hiermee geeft u de tijdelijke schijfplaatsing voor de besturingssysteemschijf voor alle VM's in de groep.
DiffDiskSettings

Hiermee geeft u de tijdelijke schijfinstellingen voor de besturingssysteemschijf die wordt gebruikt door de virtuele machine.
DiskEncryptionConfiguration

De schijfversleutelingsconfiguratie die is toegepast op rekenknooppunten in de groep. De configuratie van schijfversleuteling wordt niet ondersteund in een Linux-pool die is gemaakt met de installatiekopie van de virtuele machine of de installatiekopie van de Azure Compute-galerie.
DiskEncryptionTarget

De lijst met schijfdoelen batchservice versleutelt op het rekenknooppunt
DynamicVNetAssignmentScope

Het bereik van dynamische vnet-toewijzing.
ElevationLevel

Het hoogteniveau van de gebruiker.
EnvironmentSetting

Een omgevingsvariabele die moet worden ingesteld voor een taakproces.
FixedScaleSettings

Vaste schaalinstellingen voor de pool.
ImageReference

Een verwijzing naar een Azure Virtual Machines Marketplace-installatiekopieën of de Azure-installatiekopieënresource van een aangepaste virtuele machine. Als u de lijst met alle imageReferences wilt ophalen die zijn geverifieerd door Azure Batch, raadpleegt u de bewerking Ondersteunde knooppuntagent-SKU's vermelden.
InboundEndpointProtocol

Het protocol van het eindpunt.
InboundNatPool

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

Of de pool directe communicatie tussen knooppunten toestaat.
IPAddressProvisioningType

Het inrichtingstype voor openbare IP-adressen voor de Batch-pool.
LinuxUserConfiguration

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

Aanmeldingsmodus voor gebruiker
ManagedDisk
MetadataItem

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

Het bestandssysteem dat aan elk knooppunt moet worden gekoppeld.
NetworkConfiguration

De netwerkconfiguratie voor een pool.
NetworkSecurityGroupRule

Een netwerkbeveiligingsgroepregel die moet worden toegepast op een binnenkomend eindpunt.
NetworkSecurityGroupRuleAccess

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

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

Bepaalt hoe een pool communiceert met de Batch-service.
NodePlacementConfiguration

Configuratie van knooppuntplaatsing voor batchgroepen.
NodePlacementPolicyType

Het plaatsingsbeleid voor het toewijzen van knooppunten in de pool.
OSDisk

Instellingen voor de besturingssysteemschijf van de virtuele machine.
Pool

Bevat informatie over een groep.
PoolEndpointConfiguration

De eindpuntconfiguratie voor een pool.
PoolIdentityType

Het type identiteit dat wordt gebruikt voor de Batch-pool.
PoolProvisioningState

De huidige status van de pool.
PublicIPAddressConfiguration

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

Een fout die is opgetreden bij het wijzigen van het formaat van een pool.
ResizeOperationStatus

Details over de huidige of laatste voltooide bewerking voor het wijzigen van de grootte.
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.
ScaleSettings

Schaalinstellingen voor de pool
SecurityProfile

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

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

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

Een taak die wordt uitgevoerd wanneer een rekenknooppunt lid wordt van een pool in de Azure Batch-service, of wanneer het rekenknooppunt opnieuw wordt opgestart of een nieuwe installatiekopie wordt gemaakt.
StorageAccountType

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

De containerinstellingen voor een taak.
TaskSchedulingPolicy

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

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

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

Mogelijke waarden zijn:

Handmatig : u bepaalt de toepassing van updates op virtuele machines in de schaalset. U doet dit met behulp van de actie manualUpgrade.

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

Rolling : schaalset voert updates uit in batches met een optionele pauzetijd ertussen.
UpgradePolicy

Beschrijft een upgradebeleid: automatisch, handmatig of rolling.
UserAccount

Eigenschappen die worden gebruikt om een gebruiker te maken op een Azure Batch-knooppunt.
UserAssignedIdentities

De lijst met gekoppelde gebruikersidentiteiten.
UserIdentity

De definitie van de gebruikersidentiteit waaronder de taak wordt uitgevoerd.
VirtualMachineConfiguration

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

De configuratie voor extensies van virtuele machines.
WindowsConfiguration

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

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

AllocationState

Of de grootte van de pool wordt gewijzigd.

Name Type Description
Resizing

string

De grootte van de pool wordt gewijzigd; dat wil gezegd dat rekenknooppunten worden toegevoegd aan of verwijderd uit de pool.
Steady

string

De grootte van de pool wordt niet gewijzigd. Er zijn geen wijzigingen in het aantal knooppunten in de pool die wordt uitgevoerd. Een pool krijgt deze status wanneer deze wordt gemaakt en wanneer er geen bewerkingen worden uitgevoerd op de pool om het aantal knooppunten te wijzigen.
Stopping

string

Het formaat van de pool is gewijzigd, maar de gebruiker heeft gevraagd om het wijzigen van het formaat te stoppen, maar de stopaanvraag is nog niet voltooid.

ApplicationPackageReference

Een koppeling maken naar een toepassingspakket in het batch-account

Name Type Description
id

string

De id van het toepassingspakket dat moet worden geïnstalleerd. Dit moet zich in hetzelfde batchaccount bevinden als de pool. Dit kan een verwijzing zijn naar een specifieke versie of de standaardversie als deze bestaat.
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 en er geen standaardversie is opgegeven voor deze toepassing, mislukt de aanvraag met de foutcode InvalidApplicationPackageReferences. Als u de REST API rechtstreeks aanroept, is de HTTP-statuscode 409.

AutomaticOSUpgradePolicy

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

Name Type Description
disableAutomaticRollback

boolean

Of de functie voor het 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 schaalsetexemplaren op een doorlopende manier wanneer er een nieuwere versie van de installatiekopieën van het besturingssysteem beschikbaar komt.

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

boolean

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

boolean

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

AutoScaleRun

De resultaten en fouten van een uitvoering van een formule voor automatische schaalaanpassing van groepen.

Name Type Description
error

AutoScaleRunError

Details van de fout die is opgetreden bij het evalueren van de formule voor automatische schaalaanpassing in de pool, als de evaluatie is mislukt.
evaluationTime

string

Het tijdstip waarop de formule voor automatische schaalaanpassing voor het laatst is geëvalueerd.
results

string

De uiteindelijke waarden van alle variabelen die worden gebruikt bij de evaluatie van de formule voor automatisch schalen.
Elke variabelewaarde wordt geretourneerd in de vorm $variable=waarde en variabelen worden gescheiden door puntkomma's.

AutoScaleRunError

Een fout die is opgetreden bij het automatisch schalen van een pool.

Name Type Description
code

string

Een id voor de fout. Codes zijn invariant en zijn bedoeld om programmatisch te worden gebruikt.
details

AutoScaleRunError[]

Aanvullende informatie over de fout.
message

string

Een bericht met een beschrijving van de fout, bedoeld om te worden weergegeven in een gebruikersinterface.

AutoScaleSettings

Instellingen voor automatische schaalaanpassing voor de pool.

Name Type Description
evaluationInterval

string

Het tijdsinterval waarmee de grootte van de pool automatisch moet worden aangepast op basis van de formule voor automatische schaalaanpassing.
Als u dit weglaat, is de standaardwaarde 15 minuten (PT15M).
formula

string

Een formule voor het gewenste aantal rekenknooppunten in de pool.

AutoUserScope

Het bereik voor de automatische gebruiker

Name Type Description
Pool

string

Hiermee geeft u op dat de taak wordt uitgevoerd als het algemene automatische gebruikersaccount dat wordt gemaakt op elk knooppunt in een pool.
Task

string

Hiermee geeft u op dat de service een nieuwe gebruiker voor de taak moet maken.

AutoUserSpecification

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

Name Type Description
elevationLevel

ElevationLevel

Het uitbreidingsniveau van de automatische gebruiker.
De standaardwaarde is nonAdmin.
scope

AutoUserScope

Het bereik voor de automatische gebruiker
De standaardwaarde is Pool. Als in de groep Windows wordt uitgevoerd, moet de waarde Taak worden opgegeven als een striktere isolatie tussen taken vereist is. Bijvoorbeeld als de taak het register muteert op een manier die van invloed kan zijn op andere taken, of als er certificaten zijn opgegeven in de groep die niet toegankelijk moeten zijn voor normale taken, maar toegankelijk moeten zijn voor starttaken.

AzureBlobFileSystemConfiguration

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

Name Type Description
accountKey

string

De sleutel van het Azure Storage-account.
Deze eigenschap is wederzijds exclusief met zowel sasKey als identiteit; Er moet precies één worden opgegeven.
accountName

string

De naam van het Azure Storage-account.
blobfuseOptions

string

Aanvullende opdrachtregelopties die moeten worden doorgegeven aan de koppelingsopdracht.
Dit zijn 'net use'-opties in Windows en 'koppelopties' in Linux.
containerName

string

De Azure Blob Storage containernaam.
identityReference

ComputeNodeIdentityReference

De verwijzing naar de door de gebruiker toegewezen identiteit die moet worden gebruikt voor toegang tot containerName
Deze eigenschap is wederzijds exclusief met zowel accountKey als sasKey; Er moet precies één worden opgegeven.
relativeMountPath

string

Het relatieve pad op het rekenknooppunt waar het bestandssysteem wordt gekoppeld
Alle bestandssystemen worden gekoppeld ten opzichte van de Batch-koppelingsmap, toegankelijk via de omgevingsvariabele AZ_BATCH_NODE_MOUNTS_DIR.
sasKey

string

Het AZURE Storage SAS-token.
Deze eigenschap is wederzijds exclusief met zowel accountKey als identiteit; Er moet precies één worden opgegeven.

AzureFileShareConfiguration

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

Name Type Description
accountKey

string

De Azure Storage-accountsleutel.
accountName

string

De naam van het Azure Storage-account.
azureFileUrl

string

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

string

Aanvullende opdrachtregelopties die moeten worden doorgegeven aan de koppelingsopdracht.
Dit zijn 'net use'-opties in Windows en 'koppelopties' in Linux.
relativeMountPath

string

Het relatieve pad op het rekenknooppunt waar het bestandssysteem wordt gekoppeld
Alle bestandssystemen worden gekoppeld ten opzichte van de Batch-koppelingsmap, toegankelijk via de omgevingsvariabele AZ_BATCH_NODE_MOUNTS_DIR.

BatchPoolIdentity

De identiteit van de Batch-pool, indien geconfigureerd. Als de poolidentiteit wordt bijgewerkt tijdens het bijwerken van een bestaande pool, hebben alleen de nieuwe vm's die worden gemaakt nadat de pool is verkleind naar 0, de bijgewerkte identiteiten

Name Type Description
type

PoolIdentityType

Het type identiteit dat wordt gebruikt voor de Batch-pool.
userAssignedIdentities

object

De lijst met gebruikersidentiteiten die zijn gekoppeld aan de Batch-pool.

CachingType

Het type cache dat moet worden ingeschakeld voor de schijf.

Name Type Description
None

string

De cachemodus voor de schijf is niet ingeschakeld.
ReadOnly

string

De cachemodus voor de schijf is alleen-lezen.
ReadWrite

string

De cachemodus voor de schijf is lezen en schrijven.

CertificateReference

Een verwijzing naar een certificaat dat moet worden geïnstalleerd op rekenknooppunten in een pool. Dit moet zich in hetzelfde account bevinden als de pool.

Name Type Description
id

string

De volledig gekwalificeerde id van het certificaat dat op de groep moet worden geïnstalleerd. Dit moet zich in hetzelfde batchaccount bevinden als de pool.
storeLocation

CertificateStoreLocation

De locatie van het certificaatarchief op het rekenknooppunt waarin het certificaat moet worden geïnstalleerd.
De standaardwaarde is currentUser. Deze eigenschap is alleen van toepassing op pools die zijn geconfigureerd met Windows-knooppunten (dat wil gezegd, gemaakt met cloudServiceConfiguration of met virtualMachineConfiguration met behulp van een Verwijzing naar een Windows-installatiekopieën). Voor Linux-rekenknooppunten worden de certificaten opgeslagen in een map in de werkmap van de taak en wordt een omgevingsvariabele AZ_BATCH_CERTIFICATES_DIR opgegeven voor de taak om een query uit te voeren voor deze locatie. Voor certificaten met zichtbaarheid van 'remoteUser' wordt een map met certificaten gemaakt in de basismap van de gebruiker (bijvoorbeeld /home/{user-name}/certs) en worden certificaten in die map geplaatst.
storeName

string

De naam van het certificaatarchief op het rekenknooppunt waarin het certificaat moet worden geïnstalleerd.
Deze eigenschap is alleen van toepassing op pools die zijn geconfigureerd met Windows-knooppunten (dat wil gezegd, gemaakt met cloudServiceConfiguration of met virtualMachineConfiguration met behulp van een Verwijzing naar een Windows-installatiekopieën). Algemene winkelnamen zijn: My, Root, CA, Trust, Disallowed, TrustedPeople, TrustedPublisher, AuthRoot, AddressBook, maar elke aangepaste winkelnaam kan ook worden gebruikt. De standaardwaarde is Mijn.
visibility

CertificateVisibility[]

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

CertificateStoreLocation

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

Name Type Description
CurrentUser

string

Certificaten moeten worden geïnstalleerd in het certificaatarchief CurrentUser.
LocalMachine

string

Certificaten moeten worden geïnstalleerd in het LocalMachine-certificaatarchief.

CertificateVisibility

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

Name Type Description
RemoteUser

string

Het certificaat moet zichtbaar zijn voor de gebruikersaccounts waaronder gebruikers op afstand toegang hebben tot het knooppunt.
StartTask

string

Het certificaat moet zichtbaar zijn voor het gebruikersaccount waaronder de begintaak wordt uitgevoerd. Houd er rekening mee dat als AutoUser-bereik pool is voor zowel de StartTask als een taak, dit certificaat ook zichtbaar is voor de taak.
Task

string

Het certificaat moet zichtbaar zijn voor de gebruikersaccounts waaronder taaktaken worden uitgevoerd.

CIFSMountConfiguration

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

Name Type Description
mountOptions

string

Aanvullende opdrachtregelopties die moeten worden doorgegeven aan de koppelingsopdracht.
Dit zijn 'net use'-opties in Windows en 'koppelopties' in Linux.
password

string

Het wachtwoord dat moet worden gebruikt voor verificatie met het CIFS-bestandssysteem.
relativeMountPath

string

Het relatieve pad op het rekenknooppunt waar het bestandssysteem wordt gekoppeld
Alle bestandssystemen worden gekoppeld ten opzichte van de Batch-koppelingsmap, toegankelijk via de omgevingsvariabele AZ_BATCH_NODE_MOUNTS_DIR.
source

string

De URI van het bestandssysteem dat moet worden gekoppeld.
userName

string

De gebruiker die moet worden gebruikt voor verificatie met het CIFS-bestandssysteem.

CloudError

Een foutreactie van de Batch-service.

Name Type Description
error

CloudErrorBody

De hoofdtekst van het foutbericht.

CloudErrorBody

Een foutreactie van de Batch-service.

Name Type Description
code

string

Een id voor de fout. Codes zijn invariant en zijn bedoeld om programmatisch te worden gebruikt.
details

CloudErrorBody[]

Een lijst met aanvullende informatie over de fout.
message

string

Een bericht met een beschrijving van de fout, bedoeld om te worden weergegeven in een gebruikersinterface.
target

string

Het doel van de specifieke fout. Bijvoorbeeld de naam van de eigenschap in fout.

CloudServiceConfiguration

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

Name Type Description
osFamily

string

De Azure-gastbesturingssysteemgroep die moet worden geïnstalleerd op de virtuele machines in de pool.
Mogelijke waarden zijn: 2 - OS-familie 2, gelijk aan Windows Server 2008 R2 SP1. 3 - OS-familie 3, gelijk aan Windows Server 2012. 4 - OS-familie 4, gelijk aan Windows Server 2012 R2. 5 - OS-familie 5, gelijk aan Windows Server 2016. 6 - OS-familie 6, equivalent aan Windows Server 2019. Zie Azure-gastbesturingssystemen (https://azure.microsoft.com/documentation/articles/cloud-services-guestos-update-matrix/#releases) voor meer informatie.
osVersion

string

De versie van het Azure-gastbesturingssystemen die moet worden geïnstalleerd op de virtuele machines in de pool.
De standaardwaarde is * waarmee de meest recente versie van het besturingssysteem voor de opgegeven besturingssysteemfamilie wordt opgegeven.

ComputeNodeDeallocationOption

Bepaalt wat er moet worden gedaan met een knooppunt en de bijbehorende actieve taak(en) nadat het is geselecteerd voor deallocatie.

Name Type Description
Requeue

string

Actieve taakprocessen beëindigen en de taken opnieuw in de wachtrij plaatsen. De taken worden opnieuw uitgevoerd wanneer er een knooppunt beschikbaar is. Verwijder knooppunten zodra taken zijn beëindigd.
RetainedData

string

Sta het voltooien van actieve taken toe en wacht totdat alle bewaarperioden voor taakgegevens zijn verlopen. Plan geen nieuwe taken tijdens het wachten. Verwijder knooppunten wanneer alle retentieperioden voor taken zijn verlopen.
TaskCompletion

string

Sta het voltooien van taken die momenteel worden uitgevoerd toe. Plan geen nieuwe taken tijdens het wachten. Verwijder knooppunten wanneer alle taken zijn voltooid.
Terminate

string

Actieve taken beëindigen. De taken worden voltooid met failureInfo die aangeeft dat ze zijn beëindigd en niet opnieuw worden uitgevoerd. Verwijder knooppunten zodra taken zijn beëindigd.

ComputeNodeFillType

Hoe taken moeten worden verdeeld over rekenknooppunten.

Name Type Description
Pack

string

Er moeten zoveel mogelijk taken (taskSlotsPerNode) worden toegewezen aan elk knooppunt in de pool voordat taken worden toegewezen aan het volgende knooppunt in de pool.
Spread

string

Taken moeten gelijkmatig worden toegewezen over alle knooppunten in de pool.

ComputeNodeIdentityReference

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

Name Type Description
resourceId

string

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

ContainerConfiguration

De configuratie voor pools met container.

Name Type Description
containerImageNames

string[]

De verzameling containerinstallatiekopieën.
Dit is de volledige installatiekopiereferentie, zoals wordt opgegeven bij 'docker pull'. Een installatiekopieën worden opgehaald uit het standaard Docker-register, tenzij de installatiekopieën volledig zijn gekwalificeerd met een alternatief register.
containerRegistries

ContainerRegistry[]

Aanvullende privéregisters waaruit containers kunnen worden opgehaald.
Als installatiekopieën moeten worden gedownload uit een privéregister waarvoor referenties zijn vereist, moeten deze referenties hier worden opgegeven.
type

ContainerType

De te gebruiken containertechnologie.

ContainerRegistry

Een privécontainerregister.

Name Type Description
identityReference

ComputeNodeIdentityReference

De verwijzing naar de door de gebruiker toegewezen identiteit die moet worden gebruikt voor toegang tot een Azure Container Registry in plaats van gebruikersnaam en wachtwoord.
De verwijzing naar een door de gebruiker toegewezen identiteit die is gekoppeld aan de Batch-pool die door een rekenknooppunt wordt gebruikt.
password

string

Het wachtwoord om u aan te melden bij de registerserver.
registryServer

string

De register-URL.
Als u dit weglaat, is de standaardwaarde 'docker.io'.
username

string

De gebruikersnaam om u aan te melden bij de registerserver.

ContainerType

De te gebruiken containertechnologie.

Name Type Description
CriCompatible

string

Er wordt een op CRI gebaseerde technologie gebruikt om de containers te starten.
DockerCompatible

string

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

ContainerWorkingDirectory

Een vlag om aan te geven waar de werkmap van de containertaak zich bevindt. De standaardwaarde is taskWorkingDirectory.

Name Type Description
ContainerImageDefault

string

Met behulp van de door containerinstallatiekopieën gedefinieerde werkmap. Pas op dat deze map niet de bronbestanden bevat die door Batch zijn gedownload.
TaskWorkingDirectory

string

Gebruik de standaardwerkmap voor batchservicetaken, die de taakresourcebestanden bevat die door Batch worden gevuld.

DataDisk

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

Name Type Description
caching

CachingType

Het type caching dat moet worden ingeschakeld voor de gegevensschijven.
Waarden zijn:

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.

De standaardwaarde voor opslaan in de cache is geen. Zie voor meer informatie over de cacheopties: https://blogs.msdn.microsoft.com/windowsazurestorage/2012/06/27/exploring-windows-azure-drives-disks-and-images/.
diskSizeGB

integer

De initiële schijfgrootte in GB bij het maken van een nieuwe gegevensschijf.
lun

integer

Het logische eenheidsnummer.
De lun wordt gebruikt om elke gegevensschijf uniek te identificeren. Als u meerdere schijven koppelt, moet elk een afzonderlijke lun hebben. De waarde moet tussen 0 en 63 liggen, inclusief.
storageAccountType

StorageAccountType

Het type opslagaccount dat moet worden gebruikt voor de gegevensschijf.
Als u dit weglaat, is de standaardwaarde 'Standard_LRS'. Waarden zijn:

Standard_LRS: de gegevensschijf moet gebruikmaken van standaard lokaal redundante opslag. Premium_LRS: de gegevensschijf moet gebruikmaken van premium lokaal redundante opslag.

DeploymentConfiguration

Eigenschappen van implementatieconfiguratie.

Name Type Description
cloudServiceConfiguration

CloudServiceConfiguration

De cloudserviceconfiguratie voor de pool.
Deze eigenschap en virtualMachineConfiguration sluiten elkaar uit en een van de eigenschappen moet worden opgegeven. Deze eigenschap kan niet worden opgegeven als het Batch-account is gemaakt met de eigenschap poolAllocationMode ingesteld op UserSubscription.
virtualMachineConfiguration

VirtualMachineConfiguration

De configuratie van de virtuele machine voor de pool.
Deze eigenschap en cloudServiceConfiguration sluiten elkaar uit en een van de eigenschappen moet worden opgegeven.

DiffDiskPlacement

Hiermee geeft u de tijdelijke schijfplaatsing voor de besturingssysteemschijf voor alle VM's in de groep.

Name Type Description
CacheDisk

string

De tijdelijke besturingssysteemschijf wordt opgeslagen in de VM-cache.

DiffDiskSettings

Hiermee geeft u de tijdelijke schijfinstellingen voor de besturingssysteemschijf die wordt gebruikt door de virtuele machine.

Name Type Description
placement

DiffDiskPlacement

Hiermee geeft u de tijdelijke schijfplaatsing voor de besturingssysteemschijf voor alle VM's in de groep.
Deze eigenschap kan door de gebruiker in de aanvraag worden gebruikt om te kiezen op welke locatie het besturingssysteem zich moet bevinden. bijvoorbeeld schijfruimte in de cache voor het inrichten van tijdelijke besturingssysteemschijven. Raadpleeg Voor meer informatie over de vereisten voor tijdelijke besturingssysteemschijfgrootten de vereisten voor de schijfgrootte van kortstondige besturingssystemen voor Windows-VM's op https://docs.microsoft.com/en-us/azure/virtual-machines/windows/ephemeral-os-disks#size-requirements en Linux-VM's op https://docs.microsoft.com/en-us/azure/virtual-machines/linux/ephemeral-os-disks#size-requirements.

DiskEncryptionConfiguration

De schijfversleutelingsconfiguratie die is toegepast op rekenknooppunten in de groep. De configuratie van schijfversleuteling wordt niet ondersteund in een Linux-pool die is gemaakt met de installatiekopie van de virtuele machine of de installatiekopie van de Azure Compute-galerie.

Name Type Description
targets

DiskEncryptionTarget[]

De lijst met schijfdoelen batchservice versleutelt op het rekenknooppunt
In Een Linux-pool wordt alleen 'TemporaryDisk' ondersteund; op Windows-pool moeten 'OsDisk' en 'TemporaryDisk' worden opgegeven.

DiskEncryptionTarget

De lijst met schijfdoelen batchservice versleutelt op het rekenknooppunt

Name Type Description
OsDisk

string

De besturingssysteemschijf op het rekenknooppunt is versleuteld.
TemporaryDisk

string

De tijdelijke schijf op het rekenknooppunt is versleuteld. In Linux is deze versleuteling van toepassing op andere partities (zoals partities op gekoppelde gegevensschijven) wanneer versleuteling plaatsvindt tijdens het opstarten.

DynamicVNetAssignmentScope

Het bereik van dynamische vnet-toewijzing.

Name Type Description
job

string

Dynamische VNet-toewijzing wordt per taak uitgevoerd. Als deze waarde is ingesteld, moet ook de subnet-id van de netwerkconfiguratie worden ingesteld. Deze functie vereist goedkeuring voor gebruik. Neem contact op met ondersteuning
none

string

Er is geen dynamische VNet-toewijzing ingeschakeld.

ElevationLevel

Het hoogteniveau van de gebruiker.

Name Type Description
Admin

string

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

string

De gebruiker is een standaardgebruiker zonder verhoogde toegang.

EnvironmentSetting

Een omgevingsvariabele die moet worden ingesteld voor een taakproces.

Name Type Description
name

string

De naam van de omgevingsvariabele.
value

string

De waarde van de omgevingsvariabele.

FixedScaleSettings

Vaste schaalinstellingen voor de pool.

Name Type Standaardwaarde Description
nodeDeallocationOption

ComputeNodeDeallocationOption

Bepaalt wat er moet worden uitgevoerd met een knooppunt en de actieve taak(en) als de poolgrootte afneemt.
Als u dit weglaat, is de standaardwaarde Opnieuw in de wachtrij plaatsen.
resizeTimeout

string

PT15M

De time-out voor de toewijzing van rekenknooppunten aan de pool.
De standaardwaarde is 15 minuten. Time-outwaarden gebruiken de ISO 8601-indeling. Gebruik bijvoorbeeld PT10M gedurende 10 minuten. De minimumwaarde is 5 minuten. Als u een waarde van minder dan 5 minuten opgeeft, weigert de Batch-service de aanvraag met een fout; Als u de REST API rechtstreeks aanroept, is de HTTP-statuscode 400 (ongeldige aanvraag).
targetDedicatedNodes

integer

Het gewenste aantal toegewezen rekenknooppunten in de pool.
Ten minste één van targetDedicatedNodes, targetLowPriorityNodes moet worden ingesteld.
targetLowPriorityNodes

integer

Het gewenste aantal spot-rekenknooppunten/rekenknooppunten met lage prioriteit in de pool.
Ten minste één van targetDedicatedNodes, targetLowPriorityNodes moet worden ingesteld.

ImageReference

Een verwijzing naar een Azure Virtual Machines Marketplace-installatiekopieën of de Azure-installatiekopieënresource van een aangepaste virtuele machine. Als u de lijst met alle imageReferences wilt ophalen die zijn geverifieerd door Azure Batch, raadpleegt u de bewerking Ondersteunde knooppuntagent-SKU's vermelden.

Name Type Description
id

string

De ARM-resource-id van de installatiekopieën van de Azure Compute Gallery. Rekenknooppunten in de pool worden gemaakt met behulp van deze installatiekopieën-id. Dit heeft de vorm /subscriptions/{subscriptionId}/resourceGroups/{resourceGroup}/providers/Microsoft.Compute/galleries/{galleryName}/images/{imageDefinitionName}/versions/{versionId}.
Deze eigenschap is wederzijds exclusief met andere eigenschappen. De installatiekopieën van de Azure Compute Gallery moeten replica's hebben in dezelfde regio als het Azure Batch-account. Zie voor informatie over de firewallinstellingen voor de Batch-knooppuntagent om te communiceren met de Batch-service https://docs.microsoft.com/en-us/azure/batch/batch-api-basics#virtual-network-vnet-and-firewall-configuration.
offer

string

Het aanbiedingstype van de Azure Virtual Machines Marketplace-installatiekopieën.
Bijvoorbeeld UbuntuServer of WindowsServer.
publisher

string

De uitgever van de Azure Virtual Machines Marketplace-installatiekopieën.
Bijvoorbeeld Canonical of MicrosoftWindowsServer.
sku

string

De SKU van de Azure Virtual Machines Marketplace-installatiekopieën.
Bijvoorbeeld 18.04-LTS of 2022-datacenter.
version

string

De versie van de Azure Virtual Machines Marketplace-installatiekopieën.
De waarde 'meest recente' kan worden opgegeven om de meest recente versie van een installatiekopieën te selecteren. Als u dit weglaat, is de standaardwaarde 'nieuwste'.

InboundEndpointProtocol

Het protocol van het eindpunt.

Name Type Description
TCP

string

Gebruik TCP voor het eindpunt.
UDP

string

Gebruik UDP voor het eindpunt.

InboundNatPool

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

Name Type Description
backendPort

integer

Het poortnummer op het rekenknooppunt.
Dit moet uniek zijn binnen een Batch-pool. Acceptabele waarden liggen tussen 1 en 65535, met uitzondering van 22, 3389, 29876 en 29877, omdat deze zijn gereserveerd. Als er gereserveerde waarden worden opgegeven, mislukt de aanvraag met HTTP-statuscode 400.
frontendPortRangeEnd

integer

Het laatste poortnummer in het bereik van externe poorten dat wordt gebruikt om binnenkomende toegang te bieden tot de backendPort op afzonderlijke rekenknooppunten.
Acceptabele waarden liggen tussen 1 en 65534, met uitzondering van poorten van 50000 tot 55000 die zijn gereserveerd door de Batch-service. Alle bereiken binnen een pool moeten verschillend zijn en mogen elkaar niet overlappen. Als er gereserveerde of overlappende waarden worden opgegeven, mislukt de aanvraag met HTTP-statuscode 400.
frontendPortRangeStart

integer

Het eerste poortnummer in het bereik van externe poorten dat wordt gebruikt om binnenkomende toegang te bieden tot de backendPort op afzonderlijke rekenknooppunten.
Acceptabele waarden liggen tussen 1 en 65534, met uitzondering van poorten van 50000 tot 55000 die zijn gereserveerd. Alle bereiken binnen een pool moeten verschillend zijn en mogen elkaar niet overlappen. Als er gereserveerde of overlappende waarden worden opgegeven, mislukt de aanvraag met HTTP-statuscode 400.
name

string

De naam van het eindpunt.
De naam moet uniek zijn binnen een Batch-pool en mag letters, cijfers, onderstrepingstekens, punten en afbreekstreepjes bevatten. Namen moeten beginnen met een letter of cijfer, moeten eindigen op een letter, cijfer of onderstrepingsteken en mogen niet langer zijn dan 77 tekens. Als er ongeldige waarden worden opgegeven, mislukt de aanvraag met HTTP-statuscode 400.
networkSecurityGroupRules

NetworkSecurityGroupRule[]

Een lijst met netwerkbeveiligingsgroepsregels die worden toegepast op het eindpunt.
Het maximum aantal regels dat kan worden opgegeven voor alle eindpunten in een Batch-pool is 25. Als er geen regels voor netwerkbeveiligingsgroepen zijn opgegeven, wordt er een standaardregel gemaakt om binnenkomende toegang tot de opgegeven backendPort toe te staan. Als het maximum aantal regels voor netwerkbeveiligingsgroepen wordt overschreden, mislukt de aanvraag met HTTP-statuscode 400.
protocol

InboundEndpointProtocol

Het protocol van het eindpunt.

InterNodeCommunicationState

Of de pool directe communicatie tussen knooppunten toestaat.

Name Type Description
Disabled

string

Schakel netwerkcommunicatie tussen virtuele machines uit.
Enabled

string

Schakel netwerkcommunicatie tussen virtuele machines in.

IPAddressProvisioningType

Het inrichtingstype voor openbare IP-adressen voor de Batch-pool.

Name Type Description
BatchManaged

string

Er wordt een openbaar IP-adres gemaakt en beheerd door Batch. Er kunnen meerdere openbare IP-adressen zijn, afhankelijk van de grootte van de pool.
NoPublicIPAddresses

string

Er wordt geen openbaar IP-adres gemaakt voor de rekenknooppunten in de pool.
UserManaged

string

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

LinuxUserConfiguration

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

Name Type Description
gid

integer

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

string

De persoonlijke SSH-sleutel voor het gebruikersaccount.
De persoonlijke sleutel mag niet met een wachtwoord zijn beveiligd. De persoonlijke sleutel wordt gebruikt voor het automatisch configureren van verificatie op basis van asymmetrische sleutels voor SSH tussen knooppunten in een Linux-pool wanneer de eigenschap enableInterNodeCommunication van de pool waar is (deze wordt genegeerd als enableInterNodeCommunication onwaar is). Dit doet u door het sleutelpaar in de .ssh-map van de gebruiker te plaatsen. Als dit niet is opgegeven, wordt SSH zonder wachtwoord niet geconfigureerd tussen knooppunten (er wordt geen wijziging van de .ssh-map van de gebruiker uitgevoerd).
uid

integer

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

LoginMode

Aanmeldingsmodus voor gebruiker

Name Type Description
Batch

string

De LOGON32_LOGON_BATCH Win32-aanmeldingsmodus. De modus batchaanmelding wordt aanbevolen voor langdurige parallelle processen.
Interactive

string

De LOGON32_LOGON_INTERACTIVE Win32-aanmeldingsmodus. Voor sommige toepassingen moeten machtigingen zijn gekoppeld aan de interactieve aanmeldingsmodus. Als dit het geval is voor een toepassing die in uw taak wordt gebruikt, wordt deze optie aanbevolen.

ManagedDisk

Name Type Description
storageAccountType

StorageAccountType

Het opslagaccounttype voor de beheerde schijf.

MetadataItem

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

Name Type Description
name

string

De naam van het metagegevensitem.
value

string

De waarde van het metagegevensitem.

MountConfiguration

Het bestandssysteem dat aan elk knooppunt moet worden gekoppeld.

Name Type Description
azureBlobFileSystemConfiguration

AzureBlobFileSystemConfiguration

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

AzureFileShareConfiguration

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

CIFSMountConfiguration

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

NFSMountConfiguration

Het NFS-bestandssysteem dat aan elk knooppunt moet worden gekoppeld.
Deze eigenschap is wederzijds exclusief met alle andere eigenschappen.

NetworkConfiguration

De netwerkconfiguratie voor een pool.

Name Type Standaardwaarde Description
dynamicVnetAssignmentScope

DynamicVNetAssignmentScope

none

Het bereik van dynamische vnet-toewijzing.
enableAcceleratedNetworking

boolean

Of deze pool versneld netwerken moet inschakelen.
Versneld netwerken maakt I/O-virtualisatie met één hoofdmap (SR-IOV) voor een VM mogelijk, wat kan leiden tot verbeterde netwerkprestaties. Zie https://learn.microsoft.com/azure/virtual-network/accelerated-networking-overview voor meer informatie.
endpointConfiguration

PoolEndpointConfiguration

De configuratie voor eindpunten op rekenknooppunten in de Batch-pool.
Configuratie van pooleindpunten wordt alleen ondersteund in pools met de eigenschap virtualMachineConfiguration.
publicIPAddressConfiguration

PublicIPAddressConfiguration

De configuratie van het openbare IP-adres voor rekenknooppunten in de Batch-pool.
Deze eigenschap wordt alleen ondersteund in pools met de eigenschap virtualMachineConfiguration.
subnetId

string

De ARM-resource-id van het subnet van het virtuele netwerk waaraan de rekenknooppunten van de pool worden gekoppeld. Dit heeft de vorm /subscriptions/{subscription}/resourceGroups/{group}/providers/{provider}/virtualNetworks/{network}/subnets/{subnet}.
Het virtuele netwerk moet zich in dezelfde regio en hetzelfde abonnement bevinden als het Azure Batch-account. Het opgegeven subnet moet voldoende vrije IP-adressen hebben voor het aantal knooppunten in de groep. Als het subnet onvoldoende vrije IP-adressen heeft, wijst de groep gedeeltelijk rekenknooppunten toe en treedt er een fout bij het wijzigen van het formaat op. De service-principal MicrosoftAzureBatch moet de rol Inzender voor klassieke virtuele machines Role-Based Access Control (RBAC) hebben voor het opgegeven VNet. Het opgegeven subnet moet communicatie van de Azure Batch-service toestaan om taken op de rekenknooppunten te kunnen plannen. Dit kan worden gecontroleerd door te controleren of het opgegeven VNet gekoppelde netwerkbeveiligingsgroepen (NSG's) heeft. Als communicatie met de rekenknooppunten in het opgegeven subnet wordt geweigerd door een NSG, stelt de Batch-service de status van de rekenknooppunten in op onbruikbaar. Als aan het opgegeven VNet NSG’s (netwerkbeveiligingsgroepen) zijn gekoppeld, moeten een paar gereserveerde poorten worden ingeschakeld voor binnenkomende communicatie. Voor pools die zijn gemaakt met een virtuele-machineconfiguratie schakelt u poort 29876 en 29877 in, evenals poort 22 voor Linux en poort 3389 voor Windows. Voor pools die zijn gemaakt met een cloudserviceconfiguratie schakelt u poort 10100, 20100 en 30100 in. Schakel ook uitgaande verbindingen met Azure Storage in op poort 443. Voor cloudServiceConfiguration-pools worden alleen 'klassieke' VNET's ondersteund. Zie voor meer informatie: https://docs.microsoft.com/en-us/azure/batch/batch-api-basics#virtual-network-vnet-and-firewall-configuration

NetworkSecurityGroupRule

Een netwerkbeveiligingsgroepregel die moet worden toegepast op een binnenkomend eindpunt.

Name Type Description
access

NetworkSecurityGroupRuleAccess

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

integer

De prioriteit voor deze regel.
Prioriteiten binnen een pool moeten uniek zijn en worden geëvalueerd in volgorde van prioriteit. Hoe lager het getal, hoe hoger de prioriteit. Regels kunnen bijvoorbeeld worden opgegeven met volgnummers van 150, 250 en 350. De regel met het volgordenummer 150 heeft voorrang op de regel met een volgorde van 250. Toegestane prioriteiten zijn 150 tot 4096. Als er gereserveerde of dubbele waarden worden opgegeven, mislukt de aanvraag met HTTP-statuscode 400.
sourceAddressPrefix

string

Het bronadresvoorvoegsel of de tag die overeenkomt met de regel.
Geldige waarden zijn één IP-adres (bijvoorbeeld 10.10.10.10), IP-subnet (bijvoorbeeld 192.168.1.0/24), standaardtag of * (voor alle adressen). Als er andere waarden worden opgegeven, mislukt de aanvraag met HTTP-statuscode 400.
sourcePortRanges

string[]

De bronpoortbereiken die overeenkomen met de regel.
Geldige waarden zijn *(voor alle poorten 0 - 65535) of matrices van poorten of poortbereiken (bijvoorbeeld 100-200). De poorten moeten tussen 0 en 65535 liggen en de poortbereiken of poorten mogen elkaar niet overlappen. Als er andere waarden worden opgegeven, mislukt de aanvraag met HTTP-statuscode 400. De standaardwaarde is *.

NetworkSecurityGroupRuleAccess

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

Name Type Description
Allow

string

Toegang toestaan.
Deny

string

Toegang weigeren.

NFSMountConfiguration

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

Name Type Description
mountOptions

string

Aanvullende opdrachtregelopties die moeten worden doorgegeven aan de koppelingsopdracht.
Dit zijn 'net use'-opties in Windows en 'koppelopties' in Linux.
relativeMountPath

string

Het relatieve pad op het rekenknooppunt waar het bestandssysteem wordt gekoppeld
Alle bestandssystemen worden gekoppeld ten opzichte van de Batch-koppelingsmap, toegankelijk via de omgevingsvariabele AZ_BATCH_NODE_MOUNTS_DIR.
source

string

De URI van het bestandssysteem dat moet worden gekoppeld.

NodeCommunicationMode

Bepaalt hoe een pool communiceert met de Batch-service.

Name Type Description
Classic

string

Knooppunten die de klassieke communicatiemodus gebruiken, vereisen binnenkomende TCP-communicatie op poorten 29876 en 29877 van batchnodemanagement. Servicetag {region} en uitgaande TCP-communicatie op poort 443 naar storage.region en BatchNodeManagement. {region}' servicetags.
Default

string

De communicatiemodus van het knooppunt wordt automatisch ingesteld door de Batch-service.
Simplified

string

Knooppunten die gebruikmaken van de vereenvoudigde communicatiemodus vereisen uitgaande TCP-communicatie op poort 443 naar batchnodemanagement. Servicetag {region}. Er zijn geen open binnenkomende poorten vereist.

NodePlacementConfiguration

Configuratie van knooppuntplaatsing voor batchgroepen.

Name Type Description
policy

NodePlacementPolicyType

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

NodePlacementPolicyType

Het plaatsingsbeleid voor het toewijzen van knooppunten in de pool.

Name Type Description
Regional

string

Alle knooppunten in de pool worden toegewezen in dezelfde regio.
Zonal

string

Knooppunten in de pool worden verdeeld over verschillende zones met best effort balancing.

OSDisk

Instellingen voor de besturingssysteemschijf van de virtuele machine.

Name Type Description
caching

CachingType

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

integer

De initiële schijfgrootte in GB bij het maken van een nieuwe besturingssysteemschijf.
ephemeralOSDiskSettings

DiffDiskSettings

Hiermee geeft u de tijdelijke schijfinstellingen voor de besturingssysteemschijf die wordt gebruikt door de virtuele machine.
managedDisk

ManagedDisk

De parameters van de beheerde schijf.
writeAcceleratorEnabled

boolean

Hiermee geeft u op of writeAccelerator moet worden in- of uitgeschakeld op de schijf.

Pool

Bevat informatie over een groep.

Name Type Standaardwaarde Description
etag

string

De ETag van de resource, die wordt gebruikt voor gelijktijdigheidsinstructies.
id

string

De id van de resource.
identity

BatchPoolIdentity

Het type identiteit dat wordt gebruikt voor de Batch-pool.
Het type identiteit dat wordt gebruikt voor de Batch-pool.
name

string

De naam van de resource.
properties.allocationState

AllocationState

Of de grootte van de pool wordt gewijzigd.
properties.allocationStateTransitionTime

string

Het tijdstip waarop de pool de huidige toewijzingsstatus heeft bereikt.
properties.applicationLicenses

string[]

De lijst met toepassingslicenties die de Batch-service beschikbaar maakt op elk rekenknooppunt in de pool.
De lijst met toepassingslicenties moet een subset zijn van beschikbare licenties voor Batch-servicetoepassingen. Als er een licentie wordt aangevraagd die niet wordt ondersteund, mislukt het maken van de pool.
properties.applicationPackages

ApplicationPackageReference[]

De lijst met toepassingspakketten die moeten worden geïnstalleerd op elk rekenknooppunt in de pool.
Wijzigingen in verwijzingen naar toepassingspakketten zijn van invloed op alle nieuwe rekenknooppunten die lid worden van de pool, maar hebben geen invloed op rekenknooppunten die zich al in de pool bevinden totdat ze opnieuw worden opgestart of opnieuw zijn geïnstalleerd. Er zijn maximaal 10 verwijzingen naar toepassingspakketten voor een bepaalde groep.
properties.autoScaleRun

AutoScaleRun

De resultaten en fouten van de laatste uitvoering van de formule voor automatische schaalaanpassing.
Deze eigenschap wordt alleen ingesteld als de pool automatisch wordt geschaald, dat wil zeggen dat autoScaleSettings worden gebruikt.
properties.certificates

CertificateReference[]

De lijst met certificaten die op elk rekenknooppunt in de pool moeten worden geïnstalleerd.
Voor Windows-rekenknooppunten installeert de Batch-service de certificaten in het opgegeven certificaatarchief en de opgegeven locatie. Voor Linux-rekenknooppunten worden de certificaten opgeslagen in een map in de werkmap van de taak en wordt een omgevingsvariabele AZ_BATCH_CERTIFICATES_DIR opgegeven voor de taak om een query uit te voeren voor deze locatie. Voor certificaten met zichtbaarheid van 'remoteUser' wordt een map met certificaten gemaakt in de basismap van de gebruiker (bijvoorbeeld /home/{user-name}/certs) en worden certificaten in die map geplaatst.

Waarschuwing: deze eigenschap is afgeschaft en wordt na februari 2024 verwijderd. Gebruik in plaats daarvan de Azure KeyVault-extensie .
properties.creationTime

string

De aanmaaktijd van het zwembad.
properties.currentDedicatedNodes

integer

Het aantal toegewezen rekenknooppunten dat zich momenteel in de pool bevindt.
properties.currentLowPriorityNodes

integer

Het aantal spot-rekenknooppunten/rekenknooppunten met lage prioriteit dat zich momenteel in de pool bevindt.
properties.currentNodeCommunicationMode

NodeCommunicationMode

De huidige status van de communicatiemodus van de pool.
properties.deploymentConfiguration

DeploymentConfiguration

Deze eigenschap beschrijft hoe de poolknooppunten worden geïmplementeerd met behulp van Cloud Services of Virtual Machines.
Met CloudServiceConfiguration geeft u op dat de knooppunten moeten worden gemaakt met behulp van Azure Cloud Services (PaaS), terwijl VirtualMachineConfiguration Gebruikmaakt van Azure Virtual Machines (IaaS).
properties.displayName

string

De weergavenaam voor de pool.
De weergavenaam hoeft niet uniek te zijn en kan Unicode-tekens bevatten met een maximale lengte van 1024.
properties.interNodeCommunication

InterNodeCommunicationState

Of de pool directe communicatie tussen knooppunten toestaat.
Dit legt beperkingen op aan welke knooppunten kunnen worden toegewezen aan de pool. Als u deze waarde inschakelt, wordt de kans verkleind dat het aangevraagde aantal knooppunten in de pool wordt toegewezen. Als dit niet is opgegeven, wordt deze waarde standaard ingesteld op 'Uitgeschakeld'.
properties.lastModified

string

De laatste wijzigingstijd van het zwembad.
Dit is de laatste keer dat de gegevens op groepsniveau, zoals de targetDedicatedNodes of autoScaleSettings, zijn gewijzigd. Er wordt geen rekening houden met wijzigingen op knooppuntniveau, zoals het wijzigen van de status van een rekenknooppunt.
properties.metadata

MetadataItem[]

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

MountConfiguration[]

Een lijst met bestandssystemen die aan elk knooppunt in de pool moeten worden gekoppeld.
Dit ondersteunt Azure Files, NFS, CIFS/SMB en Blobfuse.
properties.networkConfiguration

NetworkConfiguration

De netwerkconfiguratie voor de pool.
De netwerkconfiguratie voor een pool.
properties.provisioningState

PoolProvisioningState

De huidige status van de pool.
properties.provisioningStateTransitionTime

string

Het tijdstip waarop de pool de huidige status heeft bereikt.
properties.resizeOperationStatus

ResizeOperationStatus

Bevat details over de huidige of laatste voltooide bewerking voor het wijzigen van het formaat.
Beschrijft de huidige bewerking (als de pool AllocationState het formaat wijzigt) of de eerder voltooide bewerking (als allocationstate Steady is).
properties.resourceTags

object

De door de gebruiker opgegeven tags die zijn gekoppeld aan de pool.
De door de gebruiker gedefinieerde tags die moeten worden gekoppeld aan de Azure Batch pool. Indien opgegeven, worden deze tags doorgegeven aan de Backing Azure-resources die zijn gekoppeld aan de pool. Deze eigenschap kan alleen worden opgegeven wanneer het Batch-account is gemaakt met de eigenschap poolAllocationMode ingesteld op UserSubscription.
properties.scaleSettings

ScaleSettings

Instellingen waarmee het aantal knooppunten in de pool wordt geconfigureerd.
Hiermee definieert u de gewenste grootte van de pool. Dit kan 'fixedScale' zijn waarbij de aangevraagde targetDedicatedNodes is opgegeven, of 'autoScale' waarmee een formule wordt gedefinieerd die periodiek opnieuw wordt geëvalueerd. Als deze eigenschap niet is opgegeven, heeft de pool een vaste schaal met 0 targetDedicatedNodes.
properties.startTask

StartTask

Een taak die is opgegeven om te worden uitgevoerd op elk rekenknooppunt wanneer het lid wordt van de pool.
In een PATCH-bewerking (update) kan deze eigenschap worden ingesteld op een leeg object om de begintaak uit de pool te verwijderen.
properties.targetNodeCommunicationMode

NodeCommunicationMode

De gewenste knooppuntcommunicatiemodus voor de pool.
Als u dit weglaat, is de standaardwaarde Standaard.
properties.taskSchedulingPolicy

TaskSchedulingPolicy

Hoe taken worden verdeeld over rekenknooppunten in een pool.
Als dit niet is opgegeven, is de standaardwaarde spread.
properties.taskSlotsPerNode

integer

1

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.
properties.upgradePolicy

UpgradePolicy

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

UserAccount[]

De lijst met gebruikersaccounts die moeten worden gemaakt op elk knooppunt in de pool.
properties.vmSize

string

De grootte van virtuele machines in de pool. Alle VM's in een pool hebben dezelfde grootte.
Zie Grootten voor Cloud Services () voor informatie over de beschikbare grootten van virtuele machines voor Cloud Services pools (https://azure.microsoft.com/documentation/articles/cloud-services-sizes-specs/pools die zijn gemaakt met cloudServiceConfiguration). Batch ondersteunt alle vm-grootten van Cloud Services behalve ExtraSmall. Zie Grootten voor Virtual Machines (Linux) () of Grootten voor Virtual Machines (Windows)https://azure.microsoft.com/documentation/articles/virtual-machines-linux-sizes/ voor informatie over beschikbare VM-grootten voor pools met behulp van installatiekopieën uit de Virtual Machines Marketplace (pools die zijn gemaakt met virtualMachineConfiguration).https://azure.microsoft.com/documentation/articles/virtual-machines-windows-sizes/ Batch ondersteunt alle Vm-grootten van Azure, met uitzondering van STANDARD_A0 en grootten met Premium Storage (STANDARD_GS, STANDARD_DS en STANDARD_DSV2 serie).
type

string

Het type resource.

PoolEndpointConfiguration

De eindpuntconfiguratie voor een pool.

Name Type Description
inboundNatPools

InboundNatPool[]

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

PoolIdentityType

Het type identiteit dat wordt gebruikt voor de Batch-pool.

Name Type Description
None

string

Er is geen identiteit aan de Batch-pool gekoppeld. Als u de updategroep instelt None , worden bestaande identiteiten verwijderd.
UserAssigned

string

Batch-pool heeft door de gebruiker toegewezen identiteiten.

PoolProvisioningState

De huidige status van de pool.

Name Type Description
Deleting

string

De gebruiker heeft gevraagd om de groep te verwijderen, maar de verwijderbewerking is nog niet voltooid.
Succeeded

string

De pool is beschikbaar om taken uit te voeren, afhankelijk van de beschikbaarheid van rekenknooppunten.

PublicIPAddressConfiguration

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

Name Type Description
ipAddressIds

string[]

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

IPAddressProvisioningType

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

ResizeError

Een fout die is opgetreden bij het wijzigen van het formaat van een pool.

Name Type Description
code

string

Een id voor de fout. Codes zijn invariant en zijn bedoeld om programmatisch te worden gebruikt.
details

ResizeError[]

Aanvullende informatie over de fout.
message

string

Een bericht met een beschrijving van de fout, bedoeld om te worden weergegeven in een gebruikersinterface.

ResizeOperationStatus

Details over de huidige of laatste voltooide bewerking voor het wijzigen van de grootte.

Name Type Description
errors

ResizeError[]

Details van eventuele fouten die zijn opgetreden tijdens het uitvoeren van de laatste grootte van de groep.
Deze eigenschap wordt alleen ingesteld als er een fout is opgetreden tijdens de laatste groepsgrootte en alleen wanneer de pool allocationState Steady is.
nodeDeallocationOption

ComputeNodeDeallocationOption

Bepaalt wat er moet worden uitgevoerd met een knooppunt en de actieve taak(en) als de poolgrootte afneemt.
De standaardwaarde is requeue.
resizeTimeout

string

De time-out voor het toewijzen van rekenknooppunten aan de pool of het verwijderen van rekenknooppunten uit de pool.
De standaardwaarde is 15 minuten. De minimumwaarde is 5 minuten. Als u een waarde van minder dan 5 minuten opgeeft, retourneert de Batch-service een fout; Als u de REST API rechtstreeks aanroept, is de HTTP-statuscode 400 (Ongeldige aanvraag).
startTime

string

Het tijdstip waarop deze bewerking voor het wijzigen van het formaat is gestart.
targetDedicatedNodes

integer

Het gewenste aantal toegewezen rekenknooppunten in de pool.
targetLowPriorityNodes

integer

Het gewenste aantal spot-rekenknooppunten/rekenknooppunten met lage prioriteit in de pool.

ResourceFile

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

Name Type Description
autoStorageContainerName

string

De naam van de opslagcontainer in het automatische opslagaccount.
De eigenschappen autoStorageContainerName, storageContainerUrl en httpUrl sluiten elkaar uit en een van deze eigenschappen moet worden opgegeven.
blobPrefix

string

Het blobvoorvoegsel dat moet worden gebruikt bij het downloaden van blobs uit een Azure Storage-container. Alleen de blobs waarvan de naam begint met het opgegeven voorvoegsel, worden gedownload.
De eigenschap is alleen geldig wanneer autoStorageContainerName of storageContainerUrl wordt gebruikt. Dit voorvoegsel kan een gedeeltelijke bestandsnaam of een submap zijn. Als er geen voorvoegsel is opgegeven, worden alle bestanden in de container gedownload.
fileMode

string

Het kenmerk bestandsmachtigingsmodus in octale indeling.
Deze eigenschap is alleen van toepassing op bestanden die worden gedownload naar Linux-rekenknooppunten. Deze wordt genegeerd als het is opgegeven voor een resourceBestand dat wordt gedownload naar een Windows-knooppunt. Als deze eigenschap niet is opgegeven voor een Linux-knooppunt, wordt de standaardwaarde 0770 toegepast op het bestand.
filePath

string

De locatie op het rekenknooppunt waarnaar het bestand moet worden gedownload, ten opzichte van de werkmap van de taak.
Als de eigenschap httpUrl is opgegeven, is het filePath vereist en wordt het pad beschreven waarnaar het bestand wordt gedownload, inclusief de bestandsnaam. Als de eigenschap autoStorageContainerName of storageContainerUrl is opgegeven, is filePath optioneel en is het de map waar de bestanden naar moeten worden gedownload. In het geval dat filePath wordt gebruikt als een map, wordt elke mapstructuur die al aan de invoergegevens is gekoppeld, volledig bewaard en toegevoegd aan de opgegeven filePath-map. Het opgegeven relatieve pad kan niet worden doorbroken uit de werkmap van de taak (bijvoorbeeld met behulp van '..').
httpUrl

string

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

ComputeNodeIdentityReference

De verwijzing naar de door de gebruiker toegewezen identiteit die moet worden gebruikt voor toegang tot Azure Blob Storage opgegeven door storageContainerUrl of httpUrl
De verwijzing naar een door de gebruiker toegewezen identiteit die is gekoppeld aan de Batch-pool die door een rekenknooppunt wordt gebruikt.
storageContainerUrl

string

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

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 het updatedomein en maxBatchInstancePercent in overweging om de batchgrootte te bepalen. Als dit veld niet is ingesteld, stelt Azure Azure Batch de standaardwaarde niet in. De waarde van enableCrossZoneUpgrade op de gemaakte VirtualMachineScaleSet wordt bepaald door de standaardconfiguraties op VirtualMachineScaleSet. Dit veld kan alleen worden ingesteld op true of false wanneer NodePlacementConfiguration wordt gebruikt als zonegebonden.
maxBatchInstancePercent

integer

Het maximumpercentage van het totale aantal exemplaren van virtuele machines dat tegelijkertijd door de rolling upgrade in één batch wordt bijgewerkt. Omdat dit een maximum is, kunnen beschadigde exemplaren in eerdere of toekomstige batches ertoe leiden 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 zijn toegewezen met waarde, mag de waarde van maxBatchInstancePercent niet meer zijn dan maxUnhealthyInstancePercent.
maxUnhealthyInstancePercent

integer

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 doordat de status niet in orde is door de status van de virtuele machine voordat de rolling upgrade wordt afgebroken. Deze beperking wordt gecontroleerd voordat een batch wordt gestart. De waarde van dit veld moet tussen 5 en 100 liggen, inclusief. Als zowel maxBatchInstancePercent als maxUnhealthyInstancePercent zijn toegewezen met waarde, mag de waarde van maxBatchInstancePercent niet meer zijn dan maxUnhealthyInstancePercent.
maxUnhealthyUpgradedInstancePercent

integer

Het maximumpercentage van bijgewerkte exemplaren van virtuele machines dat een beschadigde status heeft. 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 liggen, inclusief.
pauseTimeBetweenBatches

string

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

Voer een upgrade uit van alle beschadigde exemplaren in een schaalset vóór een goed functionerende instantie.
rollbackFailedInstancesOnPolicyBreach

boolean

Mislukte exemplaren terugdraaien naar het vorige model als het beleid voor rolling upgrades wordt geschonden.

ScaleSettings

Schaalinstellingen voor de pool

Name Type Description
autoScale

AutoScaleSettings

Instellingen voor automatische schaalaanpassing voor de pool.
Deze eigenschap en fixedScale sluiten elkaar uit en een van de eigenschappen moet worden opgegeven.
fixedScale

FixedScaleSettings

Vaste schaalinstellingen voor de pool.
Deze eigenschap en automatische schaalaanpassing sluiten elkaar uit en een van de eigenschappen moet worden opgegeven.

SecurityProfile

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

Name Type Description
encryptionAtHost

boolean

Deze eigenschap kan door de gebruiker in de aanvraag worden gebruikt om hostversleuteling voor de virtuele machine of virtuele-machineschaalset in of uit te schakelen. Hiermee schakelt u de versleuteling in voor alle schijven, inclusief de resource-/tijdelijke schijf op de host zelf.
securityType

SecurityTypes

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

UefiSettings

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

SecurityTypes

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

Name Type Description
trustedLaunch

string

Vertrouwde lancering beschermt tegen geavanceerde en permanente aanvalstechnieken.

ServiceArtifactReference

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

Name Type Description
id

string

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

StartTask

Een taak die wordt uitgevoerd wanneer een rekenknooppunt lid wordt van een pool in de Azure Batch-service, of wanneer het rekenknooppunt opnieuw wordt opgestart of een nieuwe installatiekopie wordt gemaakt.

Name Type Standaardwaarde Description
commandLine

string

De opdrachtregel van de starttaak.
De opdrachtregel wordt niet uitgevoerd onder een shell en kan daarom niet profiteren van shellfuncties zoals omgevingsvariabeleuitbreiding. Als u van dergelijke functies wilt profiteren, moet u de shell in de opdrachtregel aanroepen, bijvoorbeeld met behulp van 'cmd /c Mijnopdracht' in Windows of '/bin/sh -c MyCommand' in Linux. Vereist als er andere eigenschappen van de startTask zijn opgegeven.
containerSettings

TaskContainerSettings

De instellingen voor de container waaronder de begintaak wordt uitgevoerd.
Wanneer dit is opgegeven, worden alle mappen recursief onder de AZ_BATCH_NODE_ROOT_DIR (de hoofdmap van Azure Batch mappen op het knooppunt) toegewezen aan de container, worden alle taakomgevingsvariabelen toegewezen aan de container en wordt de taakopdrachtregel uitgevoerd in de container.
environmentSettings

EnvironmentSetting[]

Een lijst met omgevingsvariabele-instellingen voor de starttaak.
maxTaskRetryCount

integer

0

Het maximum aantal keren dat de taak opnieuw kan worden uitgevoerd.
De Batch-service probeert een taak opnieuw uit te voeren als de afsluitcode een andere is dan nul. Houd er rekening mee dat deze waarde specifiek het aantal nieuwe pogingen bepaalt. De Batch-service probeert de taak eenmaal uit te voeren en kan het vervolgens opnieuw proberen tot deze limiet. Als het maximumaantal nieuwe pogingen bijvoorbeeld 3 is, probeert Batch de taak maximaal 4 keer (één eerste poging en 3 nieuwe pogingen). Als het maximumaantal nieuwe pogingen 0 is, voert de Batch-service de taak niet opnieuw uit. Als het maximumaantal nieuwe pogingen -1 is, voert de Batch-service de taak opnieuw uit zonder limiet. De standaardwaarde is 0
resourceFiles

ResourceFile[]

Een lijst met bestanden die de Batch-service naar het rekenknooppunt downloadt voordat de opdrachtregel wordt uitgevoerd.
userIdentity

UserIdentity

De gebruikersidentiteit waaronder de begintaak wordt uitgevoerd.
Als u dit weglaat, wordt de taak uitgevoerd als een gebruiker zonder beheerdersrechten die uniek is voor de taak.
waitForSuccess

boolean

Of de Batch-service moet wachten tot de starttaak is voltooid (dat wil gezegd, afsluiten met afsluitcode 0) voordat taken op het rekenknooppunt worden gepland.
Als waar is en de starttaak mislukt op een rekenknooppunt, probeert de Batch-service de opstarttaak opnieuw tot het maximale aantal nieuwe pogingen (maxTaskRetryCount). Als de taak na alle nieuwe pogingen nog steeds niet is voltooid, markeert de Batch-service het rekenknooppunt onbruikbaar en worden er geen taken op gepland. Deze voorwaarde kan worden gedetecteerd via de details van de knooppuntstatus en de planningsfout. Indien onwaar, wacht de Batch-service niet tot de starttaak is voltooid. In dit geval kunnen andere taken worden uitgevoerd op het rekenknooppunt terwijl de begintaak nog wordt uitgevoerd; en zelfs als de begintaak mislukt, worden er nog steeds nieuwe taken gepland op het knooppunt. De standaardwaarde is true.

StorageAccountType

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

Name Type Description
Premium_LRS

string

De gegevensschijf/besturingssysteemschijf moet gebruikmaken van premium lokaal redundante opslag.
StandardSSD_LRS

string

De gegevensschijf/besturingssysteemschijf moet gebruikmaken van standaard lokaal redundante SSD-opslag.
Standard_LRS

string

De gegevensschijf/besturingssysteemschijf moet gebruikmaken van standaard lokaal redundante opslag.

TaskContainerSettings

De containerinstellingen voor een taak.

Name Type Description
containerRunOptions

string

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

string

De installatiekopieën die moeten worden gebruikt om de container te maken waarin de taak wordt uitgevoerd.
Dit is de volledige installatiekopiereferentie, zoals wordt opgegeven bij 'docker pull'. Als er geen tag wordt opgegeven als onderdeel van de naam van de installatiekopieën, wordt de tag ':latest' standaard gebruikt.
registry

ContainerRegistry

Het privéregister dat de containerinstallatiekopieën bevat.
Deze instelling kan worden weggelaten als deze al is opgegeven bij het maken van de pool.
workingDirectory

ContainerWorkingDirectory

Een vlag om aan te geven waar de werkmap van de containertaak zich bevindt. De standaardwaarde is taskWorkingDirectory.

TaskSchedulingPolicy

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

Name Type Standaardwaarde Description
nodeFillType

ComputeNodeFillType

Spread

Hoe taken moeten worden verdeeld over rekenknooppunten.

UefiSettings

Hiermee geeft u de beveiligingsinstellingen op, zoals beveiligd opstarten en vTPM die worden gebruikt bij 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.

UpgradeMode

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

Mogelijke waarden zijn:

Handmatig : u bepaalt de toepassing van updates op virtuele machines in de schaalset. U doet dit met behulp van de actie manualUpgrade.

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

Rolling : schaalset voert updates uit in batches met een optionele pauzetijd ertussen.

Name Type Description
automatic

string

Alle virtuele machines in de schaalset worden automatisch tegelijkertijd bijgewerkt.
manual

string

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

string

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

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:

Handmatig : u bepaalt de toepassing van updates op virtuele machines in de schaalset. U doet dit met behulp van de handmatige actieUpgrade.

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.
Deze eigenschap wordt alleen ondersteund in pools met de eigenschap virtualMachineConfiguration.

UserAccount

Eigenschappen die worden gebruikt om een gebruiker te maken op een Azure Batch-knooppunt.

Name Type Description
elevationLevel

ElevationLevel

Het uitbreidingsniveau van het gebruikersaccount.
nonAdmin: de automatische gebruiker is een standaardgebruiker zonder verhoogde toegang. admin: de automatische gebruiker is een gebruiker met verhoogde toegang en werkt met volledige beheerdersmachtigingen. De standaardwaarde is nonAdmin.
linuxUserConfiguration

LinuxUserConfiguration

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

string

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

string

Het wachtwoord voor het gebruikersaccount.
windowsUserConfiguration

WindowsUserConfiguration

De Windows-specifieke gebruikersconfiguratie voor het gebruikersaccount.
Deze eigenschap kan alleen worden opgegeven als de gebruiker zich in een Windows-groep bevindt. Als dit niet is opgegeven en in een Windows-pool, wordt de gebruiker gemaakt met de standaardopties.

UserAssignedIdentities

De lijst met gekoppelde gebruikersidentiteiten.

Name Type Description
clientId

string

De client-id van de door de gebruiker toegewezen identiteit.
principalId

string

De principal-id van de door de gebruiker toegewezen identiteit.

UserIdentity

De definitie van de gebruikersidentiteit waaronder de taak wordt uitgevoerd.

Name Type Description
autoUser

AutoUserSpecification

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

string

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

VirtualMachineConfiguration

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

Name Type Description
containerConfiguration

ContainerConfiguration

De containerconfiguratie voor de pool.
Indien opgegeven, wordt de installatie uitgevoerd op elk knooppunt in de pool, zodat taken kunnen worden uitgevoerd in containers. Alle reguliere taken en taakbeheertaken die in deze pool worden uitgevoerd, moeten de eigenschap containerSettings opgeven, en alle andere taken kunnen deze opgeven.
dataDisks

DataDisk[]

De configuratie voor gegevensschijven die zijn gekoppeld aan de rekenknooppunten in de groep.
Deze eigenschap moet worden opgegeven als aan de rekenknooppunten in de pool lege gegevensschijven moeten zijn gekoppeld.
diskEncryptionConfiguration

DiskEncryptionConfiguration

De schijfversleutelingsconfiguratie voor de pool.
Indien opgegeven, wordt versleuteling uitgevoerd op elk knooppunt in de pool tijdens het inrichten van knooppunten.
extensions

VMExtension[]

De extensie van de virtuele machine voor de pool.
Indien opgegeven, worden de extensies die in deze configuratie worden vermeld op elk knooppunt geïnstalleerd.
imageReference

ImageReference

Een verwijzing naar de Azure Virtual Machines Marketplace-installatiekopieën of de aangepaste vm-installatiekopieën die moeten worden gebruikt.
licenseType

string

Het type on-premises licentie dat moet worden gebruikt bij het implementeren van het besturingssysteem.
Dit geldt alleen voor installatiekopieën die het Windows-besturingssysteem bevatten en mag alleen worden gebruikt wanneer u geldige on-premises licenties hebt voor de knooppunten die worden geïmplementeerd. Als u dit weglaat, wordt er geen on-premises licentiekorting toegepast. Waarden zijn:

Windows_Server: de on-premises licentie is voor Windows Server. Windows_Client: de on-premises licentie is voor Windows Client.
nodeAgentSkuId

string

De SKU van de Batch-knooppuntagent die moet worden ingericht op rekenknooppunten in de pool.
De Batch-knooppuntagent is een programma dat wordt uitgevoerd op elk knooppunt in de pool en biedt de command-and-control-interface tussen het knooppunt en de Batch-service. Er zijn verschillende implementaties van de knooppuntagent, ook wel SKU's genoemd, voor verschillende besturingssystemen. U moet een knooppuntagent-SKU opgeven die overeenkomt met de geselecteerde afbeeldingsreferentie. Zie de bewerking Ondersteunde knooppuntagent-SKU's weergeven voor informatie over de lijst met ondersteunde knooppuntagent-SKU's, samen met de bijbehorende lijst met geverifieerde verwijzingen naar installatiekopieën.
nodePlacementConfiguration

NodePlacementConfiguration

De configuratie van de knooppuntplaatsing voor de pool.
Met deze configuratie worden regels opgegeven voor de wijze waarop knooppunten in de pool fysiek worden toegewezen.
osDisk

OSDisk

Instellingen voor de besturingssysteemschijf van de virtuele machine.
Bevat configuratie voor tijdelijke OSDisk-instellingen.
securityProfile

SecurityProfile

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

ServiceArtifactReference

Hiermee geeft u de referentie-id voor serviceartefacten op die wordt gebruikt om dezelfde versie van de installatiekopieën in te stellen voor alle virtuele machines in de schaalset bij het gebruik van de meest recente versie van de installatiekopieën.
De serviceartefactreferentie-id in de vorm van /subscriptions/{subscriptionId}/resourceGroups/{resourceGroup}/providers/Microsoft.Compute/galleries/{galleryName}/serviceArtifacts/{serviceArtifactName}/vmArtifactsProfiles/{vmArtifactsProfilesName}
windowsConfiguration

WindowsConfiguration

Windows-besturingssysteeminstellingen op de virtuele machine.
Deze eigenschap mag niet worden opgegeven als de imageReference een Linux-besturingssysteeminstallatiekopie opgeeft.

VMExtension

De configuratie voor extensies van virtuele machines.

Name Type Description
autoUpgradeMinorVersion

boolean

Geeft aan of de extensie een nieuwere secundaire versie moet gebruiken als deze beschikbaar is tijdens de implementatie. Zodra de extensie is geïmplementeerd, worden secundaire versies echter niet bijgewerkt, tenzij opnieuw geïmplementeerd, zelfs als deze eigenschap is ingesteld op true.
enableAutomaticUpgrade

boolean

Geeft aan of de extensie automatisch moet worden bijgewerkt door het platform als er een nieuwere versie van de extensie beschikbaar is.
name

string

De naam van de extensie van de virtuele machine.
protectedSettings

object

De extensie kan protectedSettings of protectedSettingsFromKeyVault bevatten of helemaal geen beveiligde instellingen bevatten.
provisionAfterExtensions

string[]

De verzameling extensienamen.
Verzameling extensienamen waarna deze extensie moet worden ingericht.
publisher

string

De naam van de uitgever van de extensie-handler.
settings

object

Met JSON opgemaakte openbare instellingen voor de extensie.
type

string

Het type van de extensies.
typeHandlerVersion

string

De versie van scripthandler.

WindowsConfiguration

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

Name Type Description
enableAutomaticUpdates

boolean

Of automatische updates zijn ingeschakeld op de virtuele machine.
Als u dit weglaat, is de standaardwaarde true.

WindowsUserConfiguration

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

Name Type Description
loginMode

LoginMode

Aanmeldingsmodus voor gebruiker
Hiermee geeft u de aanmeldingsmodus voor de gebruiker op. De standaardwaarde voor VirtualMachineConfiguration-pools is de interactieve modus en voor CloudServiceConfiguration-pools is de batchmodus.