Delen via

Pool - Create

  • Referentie
Service:
Batch Management
API-versie:
2024-07-01

Hiermee maakt u een nieuwe pool binnen het opgegeven account.

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

URI-parameters

Name In Vereist Type Description
accountName
 path True

string

De naam van het Batch-account.

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

string

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

Regex-patroon: ^[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 met GUID-indeling (bijvoorbeeld 00000000-0000-0000-0000-000000000000000)
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. Een waarde van *kan worden gebruikt om de bewerking alleen toe te passen als de pool al bestaat. Als u dit weglaat, wordt deze bewerking altijd toegepast.
If-None-Match

string

Stel in op *, zodat een nieuwe pool kan worden gemaakt, maar om te voorkomen dat een bestaande pool 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 van beschikbare Licenties voor Batch-servicetoepassingen zijn. Als er een licentie wordt aangevraagd die niet wordt ondersteund, mislukt het maken van een pool.
properties.applicationPackages

ApplicationPackageReference[]

De lijst met toepassingspakketten die op elk rekenknooppunt in de pool moeten worden geïnstalleerd.
Wijzigingen in toepassingspakketverwijzingen zijn van invloed op alle nieuwe rekenknooppunten die lid zijn van de pool, maar hebben geen invloed op rekenknooppunten die al in de pool staan totdat ze opnieuw worden opgestart of opnieuw worden gemaakt. Er zijn maximaal 10 toepassingspakketverwijzingen 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 naar 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 aan de taak geleverd om een query uit te voeren op deze locatie. Voor certificaten met zichtbaarheid van remoteUser wordt een map met certificaten gemaakt in de basismap van de gebruiker (bijvoorbeeld /home/{user-name}/certs) en worden certificaten in die map geplaatst.

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

DeploymentConfiguration

Deze eigenschap beschrijft de virtuele machines waarop de poolknooppunten worden geïmplementeerd.
properties.displayName

string

De weergavenaam voor de pool.
De weergavenaam hoeft niet uniek te zijn en mag unicode-tekens bevatten tot een maximale lengte van 1024.
properties.interNodeCommunication

InterNodeCommunicationState

Of de pool directe communicatie tussen knooppunten toestaat.
Hiermee worden beperkingen opgelegd aan welke knooppunten aan de pool kunnen worden toegewezen. Als u deze waarde inschakelt, kan de kans op het aangevraagde aantal knooppunten dat in de pool moet worden toegewezen, verminderen. Als deze waarde niet is opgegeven, wordt deze waarde standaard ingesteld op Uitgeschakeld.
properties.metadata

MetadataItem[]

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

MountConfiguration[]

Een lijst met bestandssystemen die op 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 aan de pool zijn gekoppeld.
De door de gebruiker gedefinieerde tags die moeten worden gekoppeld aan de Azure Batch-pool. Wanneer deze tags zijn 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.
Definieert 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 moet worden uitgevoerd op elk rekenknooppunt terwijl deze aan de pool wordt toegevoegd.
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 communicatiemodus voor knooppunten 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, wordt de standaardwaarde verspreid.
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 op elk knooppunt in de pool moeten worden gemaakt.
properties.vmSize

string

De grootte van virtuele machines in de pool. Alle VM's in een pool hebben dezelfde grootte.
Zie Grootten voor virtuele machines in Azure (https://learn.microsoft.com/azure/virtual-machines/sizes/overview) voor meer informatie over beschikbare VM-grootten. Batch ondersteunt alle azure-VM-grootten, behalve STANDARD_A0 en vm's met Premium Storage (STANDARD_GS, STANDARD_DS en STANDARD_DSV2 reeks).
tags

object

De tags van de resource.

Antwoorden

Name Type Description
200 OK

Pool

De bewerking is geslaagd. Het antwoord bevat de poolentiteit.

Kopteksten

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
Stroom: implicit
Autorisatie-URL: https://login.microsoftonline.com/common/oauth2/authorize

Bereiken

Name Description
user_impersonation Uw gebruikersaccount imiteren

Voorbeelden

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

CreatePool - accelerated networking

Voorbeeldaanvraag

PUT https://management.azure.com/subscriptions/subid/resourceGroups/default-azurebatch-japaneast/providers/Microsoft.Batch/batchAccounts/sampleacct/pools/testpool?api-version=2024-07-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
      }
    }
  }
}

Voorbeeldrespons

Statuscode:
200 
ETag: W/"0x8DB46CB72A227E2"
{
  "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

Voorbeeldaanvraag

PUT https://management.azure.com/subscriptions/subid/resourceGroups/default-azurebatch-japaneast/providers/Microsoft.Batch/batchAccounts/sampleacct/pools/testpool?api-version=2024-07-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"
      }
    }
  }
}

Voorbeeldrespons

Statuscode:
200 
ETag: W/"0x8D4EDFEBFADF4AB"
{
  "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 VirtualMachineConfiguration

Voorbeeldaanvraag

PUT https://management.azure.com/subscriptions/subid/resourceGroups/default-azurebatch-japaneast/providers/Microsoft.Batch/batchAccounts/sampleacct/pools/testpool?api-version=2024-07-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"
      }
    }
  }
}

Voorbeeldrespons

Statuscode:
200 
ETag: W/"0x8D4EDFEBFADF4AB"
{
  "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 VirtualMachineConfiguration

Voorbeeldaanvraag

PUT https://management.azure.com/subscriptions/subid/resourceGroups/default-azurebatch-japaneast/providers/Microsoft.Batch/batchAccounts/sampleacct/pools/testpool?api-version=2024-07-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"
      }
    }
  }
}

Voorbeeldrespons

Statuscode:
200 
ETag: W/"0x8D4EDFEBFADF4AB"
{
  "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

Voorbeeldaanvraag

PUT https://management.azure.com/subscriptions/subid/resourceGroups/default-azurebatch-japaneast/providers/Microsoft.Batch/batchAccounts/sampleacct/pools/testpool?api-version=2024-07-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"
      }
    }
  }
}

Voorbeeldrespons

Statuscode:
200 
ETag: W/"0x8D4EDFEBFADF4AB"
{
  "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

Voorbeeldaanvraag

PUT https://management.azure.com/subscriptions/subid/resourceGroups/default-azurebatch-japaneast/providers/Microsoft.Batch/batchAccounts/sampleacct/pools/testpool?api-version=2024-07-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"
      }
    }
  }
}

Voorbeeldrespons

Statuscode:
200 
ETag: W/"0x8D4EDFEBFADF4AB"
{
  "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

Voorbeeldaanvraag

PUT https://management.azure.com/subscriptions/subid/resourceGroups/default-azurebatch-japaneast/providers/Microsoft.Batch/batchAccounts/sampleacct/pools/testpool?api-version=2024-07-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
      }
    }
  }
}

Voorbeeldrespons

Statuscode:
200 
ETag: W/"0x8DB554F8E08BCF4"
{
  "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

Voorbeeldaanvraag

PUT https://management.azure.com/subscriptions/subid/resourceGroups/default-azurebatch-japaneast/providers/Microsoft.Batch/batchAccounts/sampleacct/pools/testpool?api-version=2024-07-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
      }
    }
  }
}

Voorbeeldrespons

Statuscode:
200 
ETag: W/"0x8DB554F8E08BCF4"
{
  "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 - Tags

Voorbeeldaanvraag

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

{
  "tags": {
    "TagName1": "TagValue1",
    "TagName2": "TagValue2"
  },
  "properties": {
    "vmSize": "Standard_d4s_v3",
    "deploymentConfiguration": {
      "virtualMachineConfiguration": {
        "imageReference": {
          "publisher": "Canonical",
          "offer": "0001-com-ubuntu-server-jammy",
          "sku": "22_04-lts",
          "version": "latest"
        },
        "nodeAgentSkuId": "batch.node.ubuntu 22.04"
      }
    },
    "scaleSettings": {
      "fixedScale": {
        "targetDedicatedNodes": 1,
        "targetLowPriorityNodes": 0
      }
    }
  }
}

Voorbeeldrespons

Statuscode:
200 
ETag: W/"0x8DB554F8E08BCF4"
{
  "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": "0001-com-ubuntu-server-jammy",
          "sku": "22_04-lts",
          "version": "latest"
        },
        "nodeAgentSkuId": "batch.node.ubuntu 22.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
  },
  "tags": {
    "TagName1": "TagValue1",
    "TagName2": "TagValue2"
  }
}

CreatePool - UpgradePolicy

Voorbeeldaanvraag

PUT https://management.azure.com/subscriptions/subid/resourceGroups/default-azurebatch-japaneast/providers/Microsoft.Batch/batchAccounts/sampleacct/pools/testpool?api-version=2024-07-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
      }
    }
  }
}

Voorbeeldrespons

Statuscode:
200 
ETag: W/"0x8DB51E64D3C3B69"
{
  "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

Voorbeeldaanvraag

PUT https://management.azure.com/subscriptions/subid/resourceGroups/default-azurebatch-japaneast/providers/Microsoft.Batch/batchAccounts/sampleacct/pools/testpool?api-version=2024-07-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": {}
    }
  }
}

Voorbeeldrespons

Statuscode:
200 
ETag: W/"0x8D4EDFEBFADF4AB"
{
  "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

Voorbeeldaanvraag

PUT https://management.azure.com/subscriptions/subid/resourceGroups/default-azurebatch-japaneast/providers/Microsoft.Batch/batchAccounts/sampleacct/pools/testpool?api-version=2024-07-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"
  }
}

Voorbeeldrespons

Statuscode:
200 
ETag: W/"0x8D4EDFEBFADF4AB"
{
  "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

Voorbeeldaanvraag

PUT https://management.azure.com/subscriptions/subid/resourceGroups/default-azurebatch-japaneast/providers/Microsoft.Batch/batchAccounts/sampleacct/pools/testpool?api-version=2024-07-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
      }
    }
  }
}

Voorbeeldrespons

Statuscode:
200 
ETag: W/"0x8DB51F14DC1A8AD"
{
  "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

Voorbeeldaanvraag

PUT https://management.azure.com/subscriptions/subid/resourceGroups/default-azurebatch-japaneast/providers/Microsoft.Batch/batchAccounts/sampleacct/pools/testpool?api-version=2024-07-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
      }
    }
  }
}

Voorbeeldrespons

Statuscode:
200 
ETag: W/"0x8DB51F14DC1A8AD"
{
  "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 batchaccount
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 pools.
AutoScaleRunError

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

Instellingen voor automatisch schalen 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 op de Batch-service.
AzureBlobFileSystemConfiguration

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

Informatie die wordt gebruikt om verbinding te maken met een Azure Fileshare.
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 tot 0 de bijgewerkte identiteiten
CachingType

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

Een verwijzing naar een certificaat dat moet worden geïnstalleerd op rekenknooppunten in een pool. Dit moet bestaan binnen hetzelfde account 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 toegang moeten 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.
ComputeNodeDeallocationOption

Bepaalt wat u moet doen 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 containers.
ContainerHostBatchBindMountEntry

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

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

Een privécontainerregister.
ContainerType

De containertechnologie die moet worden gebruikt.
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 vanuit een virtuele machine koppelen en formatteren om ze te kunnen gebruiken.
DeploymentConfiguration

Configuratie-eigenschappen voor implementatie.
DiffDiskPlacement

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

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

De schijfversleutelingsconfiguratie die is toegepast op rekenknooppunten in de pool. 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 Gallery.
DiskEncryptionTarget

De lijst met schijfdoelen die batchservice zal versleutelen 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. Zie de bewerking Ondersteunde knooppuntagent-SKU's weergeven om de lijst met alle imageReferences op te halen die door Azure Batch zijn geverifieerd.
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 aan te pakken.
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 op elk knooppunt moet worden gekoppeld.
NetworkConfiguration

De netwerkconfiguratie voor een pool.
NetworkSecurityGroupRule

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

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 voor plaatsing van knooppunten 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 pool.
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

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

Details over de huidige of laatste voltooide formaatbewerking.
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 aanpassen
SecurityEncryptionTypes

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

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

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

Hiermee geeft u de referentie-id voor serviceartefacten op die wordt gebruikt voor het instellen van dezelfde installatiekopieënversie voor alle virtuele machines in de schaalset wanneer u de meest recente installatiekopieënversie gebruikt.
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 opnieuw wordt gemaakt.
StorageAccountType

Het type opslagaccount voor gebruik bij het maken van gegevensschijven of een besturingssysteemschijf.
TaskContainerSettings

De containerinstellingen voor een taak.
TaskSchedulingPolicy

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

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

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

Mogelijke waarden zijn:

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

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

Rolling - Schaalset voert updates uit in batches met een optionele onderbrekingstijd ertussen.
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.
VMDiskSecurityProfile

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

De configuratie voor extensies van virtuele machines.
WindowsConfiguration

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

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

AllocationState

Of de grootte van de pool wordt gewijzigd.

Name Type Description
Resizing

string

Het formaat van de pool wordt gewijzigd; Dat wil gezegd, rekenknooppunten worden toegevoegd aan of verwijderd uit de pool.
Steady

string

Het formaat van de pool wordt niet gewijzigd. Er zijn geen wijzigingen in het aantal knooppunten in de pool dat wordt uitgevoerd. Een pool voert deze status in wanneer deze wordt gemaakt en wanneer er geen bewerkingen worden uitgevoerd in de pool om het aantal knooppunten te wijzigen.
Stopping

string

De grootte van de pool is gewijzigd, maar de gebruiker heeft gevraagd de grootte te stoppen, maar de stopaanvraag is nog niet voltooid.

ApplicationPackageReference

Een koppeling maken naar een toepassingspakket in het batchaccount

Name Type Description
id

string

De id van het toepassingspakket dat moet worden geïnstalleerd. Dit moet zich binnen hetzelfde batchaccount bevinden als de pool. Dit kan een verwijzing naar een specifieke versie zijn 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 terugdraaien van installatiekopieën van het besturingssysteem moet worden uitgeschakeld.
enableAutomaticOSUpgrade

boolean

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

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

boolean

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

boolean

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

AutoScaleRun

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

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 mislukt is.
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 automatische schaalaanpassing.
Elke variabelewaarde wordt geretourneerd in het formulier $variable=waarde en variabelen worden gescheiden door puntkomma's.

AutoScaleRunError

Er is een fout 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 automatisch schalen voor de pool.

Name Type Description
evaluationInterval

string

Het tijdsinterval waarmee de poolgrootte automatisch moet worden aangepast volgens 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 op de Batch-service.

Name Type Description
elevationLevel

ElevationLevel

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

AutoUserScope

Het bereik voor de automatische gebruiker
De standaardwaarde is Pool. Als de pool Windows uitvoert, moet een waarde van Taak worden opgegeven als strengere isolatie tussen taken vereist is. Als de taak bijvoorbeeld het register op een manier muteert die van invloed kan zijn op andere taken, of als certificaten zijn opgegeven in de pool die niet toegankelijk moet zijn voor normale taken, maar toegankelijk moeten zijn voor begintaken.

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 om door te geven aan de koppelingsopdracht.
Dit zijn opties voor 'net use' in Windows en opties voor koppelen in Linux.
containerName

string

De naam van de Azure Blob Storage-container.
identityReference

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 map batchkoppelingen, die toegankelijk zijn via de omgevingsvariabele AZ_BATCH_NODE_MOUNTS_DIR.
sasKey

string

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

AzureFileShareConfiguration

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

Name Type Description
accountKey

string

De sleutel van het Azure Storage-account.
accountName

string

De naam van het Azure Storage-account.
azureFileUrl

string

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

string

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

string

Het relatieve pad op het rekenknooppunt waar het bestandssysteem wordt gekoppeld
Alle bestandssystemen worden gekoppeld ten opzichte van de map batchkoppelingen, die toegankelijk zijn 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 tot 0 de bijgewerkte identiteiten

Name Type Description
type

PoolIdentityType

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

<string,  UserAssignedIdentities>

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

CachingType

Het type caching dat voor de schijf moet worden ingeschakeld.

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 bestaan binnen hetzelfde account als de pool.

Name Type Description
id

string

De volledig gekwalificeerde id van het certificaat dat moet worden geïnstalleerd in de groep. Dit moet zich binnen 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-rekenknooppunten. Voor Linux-rekenknooppunten worden de certificaten opgeslagen in een map in de werkmap van de taak en wordt een omgevingsvariabele AZ_BATCH_CERTIFICATES_DIR aan de taak geleverd om een query uit te voeren op deze locatie. Voor certificaten met zichtbaarheid van remoteUser wordt een map met certificaten gemaakt in de basismap van de gebruiker (bijvoorbeeld /home/{user-name}/certs) en worden certificaten in die map geplaatst.
storeName

string

De naam van het certificaatarchief op het rekenknooppunt waarin het certificaat moet worden geïnstalleerd.
Deze eigenschap is alleen van toepassing op pools die zijn geconfigureerd met Windows-rekenknooppunten. 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 toegang moeten 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 toegang moeten hebben tot de persoonlijke gegevens van het certificaat.

Name Type Description
RemoteUser

string

Het certificaat moet zichtbaar zijn voor de gebruikersaccounts waaronder gebruikers extern 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 het Bereik van AutoUser 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 om door te geven aan de koppelingsopdracht.
Dit zijn opties voor 'net use' in Windows en opties voor koppelen in Linux.
password

string

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

string

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

string

De URI van het bestandssysteem die moet worden gekoppeld.
userName

string

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

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.

ComputeNodeDeallocationOption

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

Name Type Description
Requeue

string

Beëindig actieve taakprocessen en volg de taken opnieuw. De taken worden opnieuw uitgevoerd wanneer een knooppunt beschikbaar is. Verwijder knooppunten zodra taken zijn beëindigd.
RetainedData

string

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

string

Sta toe dat taken die momenteel worden uitgevoerd, worden voltooid. 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 worden niet opnieuw uitgevoerd. Verwijder knooppunten zodra taken zijn beëindigd.

ComputeNodeFillType

Hoe taken moeten worden verdeeld over rekenknooppunten.

Name Type Description
Pack

string

Zo veel mogelijk taken (taskSlotsPerNode) moeten 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 aan 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 containers.

Name Type Description
containerImageNames

string[]

De verzameling containerinstallatiekopieën.
Dit is de volledige naslaginformatie over de installatiekopie, zoals wordt opgegeven voor 'docker pull'. Een installatiekopieën worden afkomstig 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 persoonlijk register waarvoor referenties zijn vereist, moeten deze referenties hier worden opgegeven.
type

ContainerType

De containertechnologie die moet worden gebruikt.

ContainerHostBatchBindMountEntry

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

Name Type Description
isReadOnly

boolean

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

ContainerHostDataPath

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

ContainerHostDataPath

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

Name Type Description
Applications

string

Het pad naar toepassingen.
JobPrep

string

Het taakpad voor de taakvoorbereiding.
Shared

string

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

string

Het pad voor de begintaak.
Task

string

Het taakpad.
VfsMounts

string

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

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 een gebruikersnaam en wachtwoord.
De verwijzing naar een door de gebruiker toegewezen identiteit die is gekoppeld aan de Batch-pool die door een rekenknooppunt wordt gebruikt.
password

string

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

string

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

string

De gebruikersnaam om u aan te melden bij de registerserver.

ContainerType

De containertechnologie die moet worden gebruikt.

Name Type Description
CriCompatible

string

Een op CRI gebaseerde technologie wordt 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

De gedefinieerde werkmap van de containerinstallatiekopieën gebruiken. Let erop dat deze map niet de resourcebestanden bevat die door Batch zijn gedownload.
TaskWorkingDirectory

string

Gebruik de standaardwerkmap voor Batch-servicetaken, die de taakresourcebestanden bevat die door Batch zijn ingevuld.

DataDisk

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

Name Type Description
caching

CachingType

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

geen: 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 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 nummer van de logische eenheid.
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 standaard lokaal redundante opslag gebruiken. Premium_LRS: de gegevensschijf moet premium lokaal redundante opslag gebruiken.

DeploymentConfiguration

Configuratie-eigenschappen voor implementatie.

Name Type Description
virtualMachineConfiguration

VirtualMachineConfiguration

De configuratie van de virtuele machine voor de pool.

DiffDiskPlacement

Hiermee geeft u de tijdelijke schijfplaatsing voor 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 door de virtuele machine wordt gebruikt.

Name Type Description
placement

DiffDiskPlacement

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

DiskEncryptionConfiguration

De schijfversleutelingsconfiguratie die is toegepast op rekenknooppunten in de pool. 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 Gallery.

Name Type Description
targets

DiskEncryptionTarget[]

De lijst met schijfdoelen die batchservice zal versleutelen op het rekenknooppunt
In linux-pool wordt alleen 'TemporaryDisk' ondersteund; in windows-pool moeten 'OsDisk' en 'TemporaryDisk' worden opgegeven.

DiskEncryptionTarget

De lijst met schijfdoelen die batchservice zal versleutelen op het rekenknooppunt

Name Type Description
OsDisk

string

De besturingssysteemschijf op het rekenknooppunt is versleuteld.
TemporaryDisk

string

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

DynamicVNetAssignmentScope

Het bereik van dynamische vnet-toewijzing.

Name Type Description
job

string

Dynamische VNet-toewijzing wordt per taak uitgevoerd. Als deze waarde is ingesteld, moet ook de subnet-id van de netwerkconfiguratie worden ingesteld. Voor deze functie is goedkeuring vereist voordat u deze gebruikt. Neem contact op met de 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 Default value Description
nodeDeallocationOption

ComputeNodeDeallocationOption

Bepaalt wat u moet doen met een knooppunt en de bijbehorende actieve taken als de grootte van de pool afneemt.
Als u dit weglaat, is de standaardwaarde Requeue.
resizeTimeout

string

PT15M

De time-out voor de toewijzing van rekenknooppunten aan de pool.
De standaardwaarde is 15 minuten. Time-outwaarden maken gebruik van iso 8601-indeling. Gebruik bijvoorbeeld PT10M gedurende 10 minuten. De minimumwaarde is 5 minuten. Als u een waarde opgeeft die minder dan 5 minuten duurt, 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 rekenknooppunten met spot/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. Zie de bewerking Ondersteunde knooppuntagent-SKU's weergeven om de lijst met alle imageReferences op te halen die door Azure Batch zijn geverifieerd.

Name Type Description
communityGalleryImageId

string

De unieke id van de communitygalerieafbeelding
Deze eigenschap is wederzijds exclusief met andere eigenschappen en kan worden opgehaald uit de get-aanroep van de communitygalerieafbeelding.
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 is van het formulier /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 https://learn.microsoft.com/azure/batch/batch-api-basics#virtual-network-vnet-and-firewall-configurationvoor informatie over de firewallinstellingen voor de Batch-knooppuntagent om te communiceren met de Batch-service.
offer

string

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

string

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

string

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

string

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

string

De versie van de Azure Virtual Machines Marketplace-installatiekopieën.
Er kan een waarde van 'latest' 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 aan te pakken.

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 29876 en 29877, aangezien 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 voor binnenkomende toegang tot de backendPort op afzonderlijke rekenknooppunten.
Acceptabele waarden variëren tussen 1 en 65534, behalve poorten van 50000 tot 55000, die zijn gereserveerd door de Batch-service. Alle bereiken binnen een pool moeten uniek zijn en mogen 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 voor binnenkomende toegang tot de backendPort op afzonderlijke rekenknooppunten.
Acceptabele waarden variëren tussen 1 en 65534, met uitzondering van poorten van 50000 tot 55000 die zijn gereserveerd. Alle bereiken binnen een pool moeten uniek zijn en mogen 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, kan 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 regels voor netwerkbeveiligingsgroepen 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

Netwerkcommunicatie tussen virtuele machines inschakelen.

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 uid- en gid-eigenschappen moeten samen worden opgegeven of helemaal niet. Als het onderliggende besturingssysteem niet is opgegeven, kiest u 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 om automatisch verificatie op basis van asymmetrische sleutels te configureren 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 map .ssh van de gebruiker te plaatsen. Als dit niet is opgegeven, is 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 uid- en gid-eigenschappen moeten samen worden opgegeven of helemaal niet. Als het onderliggende besturingssysteem niet is opgegeven, wordt de uid gekozen.

LoginMode

Aanmeldingsmodus voor gebruiker

Name Type Description
Batch

string

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

string

De LOGON32_LOGON_INTERACTIVE Win32-aanmeldingsmodus. Voor sommige toepassingen zijn machtigingen vereist die 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
securityProfile

VMDiskSecurityProfile

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

StorageAccountType

Het type opslagaccount voor 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 op elk knooppunt moet worden gekoppeld.

Name Type Description
azureBlobFileSystemConfiguration

AzureBlobFileSystemConfiguration

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

AzureFileShareConfiguration

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

CIFSMountConfiguration

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

NFSMountConfiguration

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

NetworkConfiguration

De netwerkconfiguratie voor een pool.

Name Type Default value Description
dynamicVnetAssignmentScope

DynamicVNetAssignmentScope

none

Het bereik van dynamische vnet-toewijzing.
enableAcceleratedNetworking

boolean

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

PoolEndpointConfiguration

De configuratie voor eindpunten op rekenknooppunten in de Batch-pool.
publicIPAddressConfiguration

PublicIPAddressConfiguration

De openbare IPAddress-configuratie voor rekenknooppunten in de Batch-pool.
De configuratie van het openbare IP-adres van de netwerkconfiguratie van een pool.
subnetId

string

De ARM-resource-id van het subnet van het virtuele netwerk waaraan de rekenknooppunten van de pool worden toegevoegd. Dit is van het formulier /subscriptions/{subscription}/resourceGroups/{group}/providers/{provider}/virtualNetworks/{network}/subnetten/{subnet}.
Het virtuele netwerk moet zich in dezelfde regio en hetzelfde abonnement bevinden als het Azure Batch-account. Het opgegeven subnet moet voldoende vrije IP-adressen hebben om tegemoet te komen aan het aantal knooppunten in de groep. Als het subnet niet voldoende vrije IP-adressen heeft, wijst de pool gedeeltelijk rekenknooppunten toe en treedt er een fout op bij het wijzigen van de grootte. De service-principal 'MicrosoftAzureBatch' moet de rol 'Inzender voor klassieke virtuele machines' hebben Role-Based RBAC-rol (Access Control) 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' 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 het opgegeven VNet gekoppelde netwerkbeveiligingsgroepen (NSG) heeft, moeten enkele gereserveerde systeempoorten zijn ingeschakeld voor binnenkomende communicatie, inclusief poorten 29876 en 29877. Schakel ook uitgaande verbindingen met Azure Storage in op poort 443. Zie voor meer informatie: https://learn.microsoft.com/azure/batch/batch-api-basics#virtual-network-vnet-and-firewall-configuration

NetworkSecurityGroupRule

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

Name Type Description
access

NetworkSecurityGroupRuleAccess

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

integer

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 ordernummers van 150, 250 en 350. De regel met het volgordenummer 150 heeft voorrang op de regel met een volgorde van 250. Toegestane prioriteiten zijn 150 tot 4096. Als er gereserveerde of dubbele waarden worden opgegeven, mislukt de aanvraag met HTTP-statuscode 400.
sourceAddressPrefix

string

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

string[]

De bronpoortbereiken die overeenkomen met de regel.
Geldige waarden zijn *(voor alle poorten 0 - 65535) of matrices van poorten of poortbereiken (bijvoorbeeld 100-200). De poorten moeten tussen 0 en 65535 liggen en de poortbereiken of poorten mogen 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 om door te geven aan de koppelingsopdracht.
Dit zijn opties voor 'net use' in Windows en opties voor koppelen in Linux.
relativeMountPath

string

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

string

De URI van het bestandssysteem die moet worden gekoppeld.

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. {region}-servicetag en uitgaande TCP-communicatie op poort 443 naar storage.region en BatchNodeManagement. Servicetags van {region}.
Default

string

De communicatiemodus voor knooppunten 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 geopende binnenkomende poorten vereist.

NodePlacementConfiguration

Configuratie voor plaatsing van knooppunten voor batchgroepen.

Name Type Description
policy

NodePlacementPolicyType

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

NodePlacementPolicyType

Het plaatsingsbeleid voor het toewijzen van knooppunten in de pool.

Name Type Description
Regional

string

Alle knooppunten in de pool worden in dezelfde regio toegewezen.
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: Geen, ReadOnly, ReadWrite. De standaardwaarden zijn: Geen voor Standard-opslag. ReadOnly voor Premium-opslag.
diskSizeGB

integer

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

DiffDiskSettings

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

ManagedDisk

De parameters van de beheerde schijf.
writeAcceleratorEnabled

boolean

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

Pool

Bevat informatie over een pool.

Name Type Default value 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 ingevoerd.
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 van beschikbare Licenties voor Batch-servicetoepassingen zijn. Als er een licentie wordt aangevraagd die niet wordt ondersteund, mislukt het maken van een pool.
properties.applicationPackages

ApplicationPackageReference[]

De lijst met toepassingspakketten die op elk rekenknooppunt in de pool moeten worden geïnstalleerd.
Wijzigingen in toepassingspakketverwijzingen zijn van invloed op alle nieuwe rekenknooppunten die lid zijn van de pool, maar hebben geen invloed op rekenknooppunten die al in de pool staan totdat ze opnieuw worden opgestart of opnieuw worden gemaakt. Er zijn maximaal 10 toepassingspakketverwijzingen 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, bijvoorbeeld autoScaleSettings.
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 naar 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 aan de taak geleverd om een query uit te voeren op deze locatie. Voor certificaten met zichtbaarheid van remoteUser wordt een map met certificaten gemaakt in de basismap van de gebruiker (bijvoorbeeld /home/{user-name}/certs) en worden certificaten in die map geplaatst.

Waarschuwing: deze eigenschap is afgeschaft en wordt na februari 2024 verwijderd. Gebruik in plaats daarvan de Azure KeyVault-extensie.
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 rekenknooppunten met spot-/lage prioriteit die zich momenteel in de pool bevinden.
properties.currentNodeCommunicationMode

NodeCommunicationMode

De huidige status van de groepscommunicatiemodus.
properties.deploymentConfiguration

DeploymentConfiguration

Deze eigenschap beschrijft de virtuele machines waarop de poolknooppunten worden geïmplementeerd.
properties.displayName

string

De weergavenaam voor de pool.
De weergavenaam hoeft niet uniek te zijn en mag unicode-tekens bevatten tot een maximale lengte van 1024.
properties.interNodeCommunication

InterNodeCommunicationState

Of de pool directe communicatie tussen knooppunten toestaat.
Hiermee worden beperkingen opgelegd aan welke knooppunten aan de pool kunnen worden toegewezen. Als u deze waarde inschakelt, kan de kans op het aangevraagde aantal knooppunten dat in de pool moet worden toegewezen, verminderen. Als deze waarde 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 targetDedicatedNodes of autoScaleSettings, zijn gewijzigd. Dit houdt geen rekening met wijzigingen op knooppuntniveau, zoals een wijzigingsstatus van een rekenknooppunt.
properties.metadata

MetadataItem[]

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

MountConfiguration[]

Een lijst met bestandssystemen die op 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 ingevoerd.
properties.resizeOperationStatus

ResizeOperationStatus

Bevat details over de huidige of laatste voltooide formaatbewerking.
Beschrijft de huidige bewerking (als de pool AllocationState het formaat wijzigt) of de eerder voltooide bewerking (als de AllocationState stabiel is).
properties.resourceTags

object

De door de gebruiker opgegeven tags die aan de pool zijn gekoppeld.
De door de gebruiker gedefinieerde tags die moeten worden gekoppeld aan de Azure Batch-pool. Wanneer deze tags zijn 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.
Definieert 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 moet worden uitgevoerd op elk rekenknooppunt terwijl deze aan de pool wordt toegevoegd.
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 communicatiemodus voor knooppunten 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, wordt de standaardwaarde verspreid.
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 op elk knooppunt in de pool moeten worden gemaakt.
properties.vmSize

string

De grootte van virtuele machines in de pool. Alle VM's in een pool hebben dezelfde grootte.
Zie Grootten voor virtuele machines in Azure (https://learn.microsoft.com/azure/virtual-machines/sizes/overview) voor meer informatie over beschikbare VM-grootten. Batch ondersteunt alle azure-VM-grootten, behalve STANDARD_A0 en vm's met Premium Storage (STANDARD_GS, STANDARD_DS en STANDARD_DSV2 reeks).
tags

object

De tags van de resource.
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

Batch-pool heeft geen identiteit eraan gekoppeld. Als u None instelt in de updategroep, 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 pool te verwijderen, maar de verwijderbewerking is nog niet voltooid.
Succeeded

string

De pool is beschikbaar voor het uitvoeren van taken die afhankelijk zijn 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, heeft ten minste 3 openbare IP-adressen nodig. Elk element van deze verzameling heeft de volgende vorm: /subscriptions/{subscription}/resourceGroups/{group}/providers/Microsoft.Network/publicIPAddresses/{ip}.
provision

IPAddressProvisioningType

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

ResizeError

Er is een fout 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 formaatbewerking.

Name Type Description
errors

ResizeError[]

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

ComputeNodeDeallocationOption

Bepaalt wat u moet doen met een knooppunt en de bijbehorende actieve taken als de grootte van de pool afneemt.
De standaardwaarde wordt opnieuw weergegeven.
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 opgeeft die minder dan 5 minuten is, retourneert de Batch-service een fout; als u de REST API rechtstreeks aanroept, is de HTTP-statuscode 400 (Ongeldige aanvraag).
startTime

string

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

integer

Het gewenste aantal toegewezen rekenknooppunten in de pool.
targetLowPriorityNodes

integer

Het gewenste aantal rekenknooppunten met spot/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 wederzijds uit en een van deze moet worden opgegeven.
blobPrefix

string

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

string

Het kenmerk bestandsmachtigingsmodus in octale indeling.
Deze eigenschap is alleen van toepassing op bestanden die worden gedownload naar Linux-rekenknooppunten. Deze wordt genegeerd als deze is opgegeven voor een resourceFile die wordt gedownload naar een Windows-knooppunt. Als deze eigenschap niet is opgegeven voor een Linux-knooppunt, wordt een standaardwaarde van 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 anders de eigenschap autoStorageContainerName of storageContainerUrl is opgegeven, is filePath optioneel en is het de map waarin de bestanden moeten worden gedownload. In het geval dat filePath wordt gebruikt als map, wordt elke mapstructuur die al aan de invoergegevens is gekoppeld, volledig bewaard en toegevoegd aan de opgegeven filePath-map. Het opgegeven relatieve pad kan niet worden uitgesplitsd uit de werkmap van de taak (bijvoorbeeld met '..').
httpUrl

string

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

ComputeNodeIdentityReference

De verwijzing naar de door de gebruiker toegewezen identiteit die moet worden gebruikt voor toegang tot Azure Blob Storage die is 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 wederzijds uit en een van deze moet worden opgegeven. Deze URL moet kunnen worden gelezen en vermeld vanuit rekenknooppunten. Er zijn drie manieren om een dergelijke URL op te halen voor een container in Azure Storage: neem een SAS (Shared Access Signature) op die lees- en lijstmachtigingen voor de container verleent, gebruik een beheerde identiteit met lees- en lijstmachtigingen of stel de ACL voor de container in om openbare toegang toe te staan.

RollingUpgradePolicy

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

Name Type Description
enableCrossZoneUpgrade

boolean

Toestaan dat VMSS AZ-grenzen negeert bij het maken van upgradebatches. Neem rekening met het updatedomein en maxBatchInstancePercent om de batchgrootte te bepalen. Als dit veld niet is ingesteld, wordt de standaardwaarde van Azure Batch niet ingesteld. De waarde van enableCrossZoneUpgrade op de gemaakte VirtualMachineScaleSet wordt bepaald door de standaardconfiguraties op VirtualMachineScaleSet. Dit veld kan alleen worden ingesteld op waar of onwaar wanneer u NodePlacementConfiguration als zonegebonden gebruikt.
maxBatchInstancePercent

integer

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

integer

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

integer

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

string

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

boolean

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

boolean

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

ScaleSettings

Schaalinstellingen voor de pool aanpassen

Name Type Description
autoScale

AutoScaleSettings

Instellingen voor automatisch schalen voor de pool.
Deze eigenschap en fixedScale sluiten elkaar wederzijds uit en een van de eigenschappen moet worden opgegeven.
fixedScale

FixedScaleSettings

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

SecurityEncryptionTypes

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

Name Type Description
NonPersistedTPM

string

VMGuestStateOnly

string

SecurityProfile

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

Name Type Description
encryptionAtHost

boolean

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

SecurityTypes

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

UefiSettings

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

SecurityTypes

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

Name Type Description
confidentialVM

string

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

string

Vertrouwde lancering beschermt tegen geavanceerde en permanente aanvalstechnieken.

ServiceArtifactReference

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

Name Type Description
id

string

De naslag-id van ServiceArtifactReference
De referentie-id van het serviceartefact 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 opnieuw wordt gemaakt.

Name Type Default value Description
commandLine

string

De opdrachtregel van de begintaak.
De opdrachtregel wordt niet uitgevoerd onder een shell en kan daarom niet profiteren van shell-functies zoals uitbreiding van omgevingsvariabelen. Als u van dergelijke functies wilt profiteren, moet u de shell aanroepen op de opdrachtregel, bijvoorbeeld met 'cmd /c MyCommand' in Windows of '/bin/sh -c MyCommand' in Linux. 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 omgevingsvariabelen voor taken toegewezen aan de container en wordt de opdrachtregel van de taak uitgevoerd in de container.
environmentSettings

EnvironmentSetting[]

Een lijst met omgevingsvariabeleinstellingen voor de begintaak.
maxTaskRetryCount

integer

0

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

ResourceFile[]

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

UserIdentity

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

boolean

Of de Batch-service moet wachten totdat de begintaak is voltooid (dat wil gezegd, om af te sluiten met afsluitcode 0) voordat u taken op het rekenknooppunt plant.
Als waar is en de begintaak mislukt op een rekenknooppunt, probeert de Batch-service de opstarttaak opnieuw uit te voeren tot het maximumaantal nieuwe pogingen (maxTaskRetryCount). Als de taak na alle nieuwe pogingen nog steeds niet is voltooid, markeert de Batch-service het rekenknooppunt onbruikbaar en worden er geen taken naar gepland. Deze voorwaarde kan worden gedetecteerd via de knooppuntstatus en planningsfoutdetails. Als dit onwaar is, wacht de Batch-service niet totdat de begintaak is voltooid. In dit geval kunnen andere taken worden uitgevoerd op het rekenknooppunt terwijl de begintaak nog steeds wordt uitgevoerd; en zelfs als de begintaak mislukt, blijven nieuwe taken gepland op het knooppunt. De standaardwaarde is waar.

StorageAccountType

Het type opslagaccount voor gebruik bij het maken van gegevensschijven of een besturingssysteemschijf.

Name Type Description
Premium_LRS

string

De gegevensschijf/besturingssysteemschijf moet premium lokaal redundante opslag gebruiken.
StandardSSD_LRS

string

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

string

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

TaskContainerSettings

De containerinstellingen voor een taak.

Name Type Description
containerHostBatchBindMounts

ContainerHostBatchBindMountEntry[]

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

string

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

string

De installatiekopieën die moeten worden gebruikt om de container te maken waarin de taak wordt uitgevoerd.
Dit is de volledige naslaginformatie over de installatiekopie, zoals wordt opgegeven voor 'docker pull'. Als er geen tag wordt opgegeven als onderdeel van de naam van de installatiekopieën, wordt de tag ':latest' als 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 een 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 Default value 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 tijdens het maken van de virtuele machine.

Name Type Description
secureBootEnabled

boolean

Hiermee geeft u op of beveiligd opstarten moet worden ingeschakeld op de virtuele machine.
vTpmEnabled

boolean

Hiermee geeft u op of vTPM moet worden ingeschakeld op de virtuele machine.

UpgradeMode

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

Mogelijke waarden zijn:

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

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

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

Name Type Description
automatic

string

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

string

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

string

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

UpgradePolicy

Beschrijft een upgradebeleid: automatisch, handmatig of rolling.

Name Type Description
automaticOSUpgradePolicy

AutomaticOSUpgradePolicy

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

UpgradeMode

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

Mogelijke waarden zijn:

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

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

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

RollingUpgradePolicy

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

UserAccount

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

Name Type Description
elevationLevel

ElevationLevel

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

LinuxUserConfiguration

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

string

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

string

Het wachtwoord voor het gebruikersaccount.
windowsUserConfiguration

WindowsUserConfiguration

De windows-specifieke gebruikersconfiguratie voor het gebruikersaccount.
Deze eigenschap kan alleen worden opgegeven als de gebruiker zich in een Windows-pool bevindt. Als dit niet is opgegeven en in een Windows-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 wederzijds uit; u moet één, maar niet beide opgeven.
userName

string

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

VirtualMachineConfiguration

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

Name Type Description
containerConfiguration

ContainerConfiguration

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

DataDisk[]

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

DiskEncryptionConfiguration

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

VMExtension[]

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

ImageReference

Een verwijzing naar de Marketplace-installatiekopieën van Azure Virtual Machines of de aangepaste vm-installatiekopieën die u wilt gebruiken.
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 mogen alleen worden gebruikt wanneer u geldige on-premises licenties hebt voor de knooppunten die worden geïmplementeerd. Als u dit weglaat, wordt er geen korting op on-premises licenties toegepast. Waarden zijn:

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

string

De SKU van de Batch-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 interface voor opdracht en beheer 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 agent-SKU's voor ondersteunde knooppunten, samen met de lijst met geverifieerde afbeeldingsverwijzingen, de bewerking Ondersteunde knooppuntagent-SKU's weergeven.
nodePlacementConfiguration

NodePlacementConfiguration

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

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 voor het instellen van dezelfde installatiekopieënversie voor alle virtuele machines in de schaalset wanneer u de meest recente installatiekopieënversie gebruikt.
De referentie-id van het serviceartefact in de vorm van /subscriptions/{subscriptionId}/resourceGroups/{resourceGroup}/providers/Microsoft.Compute/galleries/{galleryName}/serviceArtifacts/{serviceArtifactName}/vmArtifactsProfiles/{vmArtifactsProfilesName}
windowsConfiguration

WindowsConfiguration

Windows-besturingssysteeminstellingen op de virtuele machine.
Deze eigenschap mag niet worden opgegeven als de imageReference een Installatiekopie van het Linux-besturingssysteem opgeeft.

VMDiskSecurityProfile

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

Name Type Description
securityEncryptionType

SecurityEncryptionTypes

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

VMExtension

De configuratie voor extensies van virtuele machines.

Name Type Description
autoUpgradeMinorVersion

boolean

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

boolean

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

string

De naam van de extensie van de virtuele machine.
protectedSettings

object

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

string[]

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

string

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

object

Openbare instellingen met JSON-indeling voor de extensie.
type

string

Het type extensies.
typeHandlerVersion

string

De versie van de scripthandler.

WindowsConfiguration

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

Name Type Description
enableAutomaticUpdates

boolean

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

WindowsUserConfiguration

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

Name Type Description
loginMode

LoginMode

Aanmeldingsmodus voor gebruiker
Hiermee geeft u de aanmeldingsmodus voor de gebruiker. De standaardwaarde is Interactief.