Freigeben über

Pool - Create

  • Referenz
Dienst:
Batch Management
API-Version:
2024-07-01

Erstellt einen neuen Pool innerhalb des angegebenen Kontos.

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

URI-Parameter

Name In Erforderlich Typ Beschreibung
accountName
 path True

string

Der Name des Batchkontos.

RegEx-Muster: ^[a-zA-Z0-9]+$
poolName
 path True

string

Der Poolname. Dies muss innerhalb des Kontos eindeutig sein.

RegEx-Muster: ^[a-zA-Z0-9_-]+$
resourceGroupName
 path True

string

Der Name der Ressourcengruppe, die das Batchkonto enthält.
subscriptionId
 path True

string

Die Azure-Abonnement-ID. Dies ist eine GUID-formatierte Zeichenfolge (z. B. 0000000-0000-0000-0000-0000000000000)
api-version
 query True

string

Die API-Version, die mit der HTTP-Anforderung verwendet werden soll.

Anforderungsheader

Name Erforderlich Typ Beschreibung
If-Match

string

Die ETag-Version (Entity State) des zu aktualisierenden Pools. Ein Wert von "*" kann verwendet werden, um den Vorgang nur anzuwenden, wenn der Pool bereits vorhanden ist. Wenn dieser Vorgang nicht angegeben wird, wird dieser Vorgang immer angewendet.
If-None-Match

string

Legen Sie auf '*' fest, damit ein neuer Pool erstellt werden kann, aber um zu verhindern, dass ein vorhandener Pool aktualisiert wird. Andere Werte werden ignoriert.

Anforderungstext

Name Typ Beschreibung
identity

BatchPoolIdentity

Der Identitätstyp, der für den Batchpool verwendet wird.
Der Identitätstyp, der für den Batchpool verwendet wird.
properties.applicationLicenses

string[]

Die Liste der Anwendungslizenzen, die der Batchdienst für jeden Computeknoten im Pool zur Verfügung stellt.
Die Liste der Anwendungslizenzen muss eine Teilmenge der verfügbaren Batchdienstanwendungslizenzen sein. Wenn eine Lizenz angefordert wird, die nicht unterstützt wird, schlägt die Poolerstellung fehl.
properties.applicationPackages

ApplicationPackageReference[]

Die Liste der Anwendungspakete, die auf jedem Computeknoten im Pool installiert werden sollen.
Änderungen an Anwendungspaketverweise wirken sich auf alle neuen Computeknoten aus, die dem Pool beitreten, wirken sich jedoch nicht auf Computeknoten aus, die sich bereits im Pool befinden, bis sie neu gestartet oder umimages aktualisiert werden. Es gibt maximal 10 Anwendungspaketverweise für einen bestimmten Pool.
properties.certificates

CertificateReference[]

Die Liste der Zertifikate, die auf jedem Computeknoten im Pool installiert werden sollen.
Für Windows-Computeknoten installiert der Batchdienst die Zertifikate im angegebenen Zertifikatspeicher und -speicherort. Bei Linux-Computeknoten werden die Zertifikate in einem Verzeichnis im Arbeitsverzeichnis der Aufgabe gespeichert, und eine Umgebungsvariable AZ_BATCH_CERTIFICATES_DIR der Aufgabe bereitgestellt wird, um diesen Speicherort abzufragen. Für Zertifikate mit Sichtbarkeit von "remoteUser" wird ein Verzeichnis "certs" im Startverzeichnis des Benutzers (z. B. /home/{user-name}/certs) erstellt und Zertifikate in diesem Verzeichnis platziert.

Warnung: Diese Eigenschaft ist veraltet und wird nach Februar 2024 entfernt. Verwenden Sie stattdessen die Azure KeyVault-Erweiterung.
properties.deploymentConfiguration

DeploymentConfiguration

Diese Eigenschaft beschreibt die virtuellen Computer, auf denen die Poolknoten bereitgestellt werden.
properties.displayName

string

Der Anzeigename für den Pool.
Der Anzeigename muss nicht eindeutig sein und kann alle Unicode-Zeichen bis zu einer maximalen Länge von 1024 enthalten.
properties.interNodeCommunication

InterNodeCommunicationState

Gibt an, ob der Pool die direkte Kommunikation zwischen Knoten zulässt.
Dadurch werden Einschränkungen auferlegt, denen dem Pool Knoten zugewiesen werden können. Durch Aktivieren dieses Werts kann die Wahrscheinlichkeit verringert werden, dass die angeforderte Anzahl von Knoten im Pool zugewiesen werden soll. Wenn nicht angegeben, wird dieser Wert standardmäßig auf "Deaktiviert" festgelegt.
properties.metadata

MetadataItem[]

Eine Liste von Name-Wert-Paaren, die dem Pool als Metadaten zugeordnet sind.
Der Batchdienst weist Metadaten keine Bedeutung zu; sie ist ausschließlich für die Verwendung von Benutzercode vorgesehen.
properties.mountConfiguration

MountConfiguration[]

Eine Liste der Dateisysteme, die auf jedem Knoten im Pool bereitgestellt werden sollen.
Dies unterstützt Azure Files, NFS, CIFS/SMB und Blobfuse.
properties.networkConfiguration

NetworkConfiguration

Die Netzwerkkonfiguration für den Pool.
Die Netzwerkkonfiguration für einen Pool.
properties.resourceTags

object

Die vom Benutzer angegebenen Tags, die dem Pool zugeordnet sind.
Die benutzerdefinierten Tags, die dem Azure-Batchpool zugeordnet werden sollen. Wenn angegeben, werden diese Tags an die zugrunde stehenden Azure-Ressourcen verteilt, die dem Pool zugeordnet sind. Diese Eigenschaft kann nur angegeben werden, wenn das Batchkonto mit der poolAllocationMode-Eigenschaft auf "UserSubscription" festgelegt wurde.
properties.scaleSettings

ScaleSettings

Einstellungen, die die Anzahl der Knoten im Pool konfigurieren.
Definiert die gewünschte Größe des Pools. Dies kann entweder "fixedScale" sein, bei dem die angeforderten targetDedicatedNodes angegeben sind, oder 'autoScale', die eine Formel definiert, die regelmäßig neu ausgewertet wird. Wenn diese Eigenschaft nicht angegeben ist, hat der Pool eine feste Skalierung mit 0 targetDedicatedNodes.
properties.startTask

StartTask

Eine Aufgabe, die für jeden Computeknoten ausgeführt werden soll, während er dem Pool beitritt.
In einem PATCH-Vorgang (Update) kann diese Eigenschaft auf ein leeres Objekt festgelegt werden, um die Startaufgabe aus dem Pool zu entfernen.
properties.targetNodeCommunicationMode

NodeCommunicationMode

Der gewünschte Knotenkommunikationsmodus für den Pool.
Wenn dieser Wert nicht angegeben wird, lautet der Standardwert "Default".
properties.taskSchedulingPolicy

TaskSchedulingPolicy

Wie Aufgaben über Computeknoten in einem Pool verteilt werden.
Wenn nicht angegeben, wird die Standardeinstellung verteilt.
properties.taskSlotsPerNode

integer

Die Anzahl der Aufgabenplätze, die zum Ausführen gleichzeitiger Aufgaben auf einem einzelnen Computeknoten im Pool verwendet werden können.
Der Standardwert ist 1. Der Maximalwert ist kleiner als 4 Mal die Anzahl der Kerne der vmSize des Pools oder 256.
properties.upgradePolicy

UpgradePolicy

Die Upgraderichtlinie für den Pool.
Beschreibt eine Upgraderichtlinie – automatisch, manuell oder rolliert.
properties.userAccounts

UserAccount[]

Die Liste der Benutzerkonten, die auf jedem Knoten im Pool erstellt werden sollen.
properties.vmSize

string

Die Größe virtueller Computer im Pool. Alle virtuellen Computer in einem Pool sind die gleiche Größe.
Informationen zu verfügbaren VM-Größen finden Sie unter Größen für virtuelle Computer (Linux) (https://azure.microsoft.com/documentation/articles/virtual-machines-linux-sizes/) oder Größen für virtuelle Computer (Windows) (https://azure.microsoft.com/documentation/articles/virtual-machines-windows-sizes/). Batch unterstützt alle Azure VM-Größen außer STANDARD_A0 und denen mit Premiumspeicher (STANDARD_GS, STANDARD_DS und STANDARD_DSV2 Serie).
tags

object

Die Tags der Ressource.

Antworten

Name Typ Beschreibung
200 OK

Pool

Der Vorgang war erfolgreich. Die Antwort enthält die Poolentität.

Header

ETag: string
Other Status Codes

CloudError

Fehlerantwort, die beschreibt, warum der Vorgang fehlgeschlagen ist.

Sicherheit

azure_auth

Microsoft Entra OAuth 2.0-Authentifizierungscodefluss

Typ: oauth2
Ablauf: implicit
Autorisierungs-URL: https://login.microsoftonline.com/common/oauth2/authorize

Bereiche

Name Beschreibung
user_impersonation Identitätswechsel ihres Benutzerkontos

Beispiele

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

Beispielanforderung

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
      }
    }
  }
}

Beispiel für eine Antwort

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

Beispielanforderung

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"
      }
    }
  }
}

Beispiel für eine Antwort

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

Beispielanforderung

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"
      }
    }
  }
}

Beispiel für eine Antwort

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

Beispielanforderung

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"
      }
    }
  }
}

Beispiel für eine Antwort

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

Beispielanforderung

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"
      }
    }
  }
}

Beispiel für eine Antwort

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

Beispielanforderung

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"
      }
    }
  }
}

Beispiel für eine Antwort

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

Beispielanforderung

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
      }
    }
  }
}

Beispiel für eine Antwort

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

Beispielanforderung

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
      }
    }
  }
}

Beispiel für eine Antwort

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

Beispielanforderung

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
      }
    }
  }
}

Beispiel für eine Antwort

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

Beispielanforderung

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
      }
    }
  }
}

Beispiel für eine Antwort

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

Beispielanforderung

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": {}
    }
  }
}

Beispiel für eine Antwort

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

Beispielanforderung

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"
  }
}

Beispiel für eine Antwort

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

Beispielanforderung

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
      }
    }
  }
}

Beispiel für eine Antwort

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

Beispielanforderung

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
      }
    }
  }
}

Beispiel für eine Antwort

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
      }
    }
  }
}

Definitionen

Name Beschreibung
AllocationState

Gibt an, ob die Größe des Pools geändert wird.
ApplicationPackageReference

Verknüpfen mit einem Anwendungspaket innerhalb des Batchkontos
AutomaticOSUpgradePolicy

Die Konfigurationsparameter, die zum Ausführen eines automatischen Betriebssystemupgrades verwendet werden.
AutoScaleRun

Die Ergebnisse und Fehler aus einer Ausführung einer Formel für die automatische Skalierung eines Pools.
AutoScaleRunError

Fehler beim automatischenCaling eines Pools.
AutoScaleSettings

AutoScale-Einstellungen für den Pool.
AutoUserScope

Der Bereich für den automatischen Benutzer
AutoUserSpecification

Gibt die Parameter für den automatischen Benutzer an, der eine Aufgabe im Batchdienst ausführt.
AzureBlobFileSystemConfiguration

Informationen, die zum Herstellen einer Verbindung mit einem Azure Storage-Container mithilfe von Blobfuse verwendet werden.
AzureFileShareConfiguration

Informationen, die zum Herstellen einer Verbindung mit einer Azure Fileshare verwendet werden.
BatchPoolIdentity

Die Identität des Batchpools, falls konfiguriert. Wenn die Poolidentität während der Aktualisierung eines vorhandenen Pools aktualisiert wird, verfügen nur die neuen vms, die nach dem Verkleinern des Pools auf 0 erstellt werden, über die aktualisierten Identitäten.
CachingType

Der Typ der Zwischenspeicherung, die für den Datenträger aktiviert werden soll.
CertificateReference

Ein Verweis auf ein Zertifikat, das auf Computeknoten in einem Pool installiert werden soll. Dies muss innerhalb desselben Kontos wie der Pool vorhanden sein.
CertificateStoreLocation

Der Speicherort des Zertifikatspeichers auf dem Computeknoten, in den das Zertifikat installiert werden soll.
CertificateVisibility

Welche Benutzerkonten auf dem Computeknoten Zugriff auf die privaten Daten des Zertifikats haben sollen.
CIFSMountConfiguration

Informationen, die zum Herstellen einer Verbindung mit einem CIFS-Dateisystem verwendet werden.
CloudError

Eine Fehlerantwort des Batchdiensts.
CloudErrorBody

Eine Fehlerantwort des Batchdiensts.
ComputeNodeDeallocationOption

Bestimmt, was mit einem Knoten und seinen ausgeführten Aufgaben ausgeführt werden soll, nachdem sie für die Deallocation ausgewählt wurde.
ComputeNodeFillType

Wie Aufgaben über Computeknoten verteilt werden sollen.
ComputeNodeIdentityReference

Der Verweis auf eine vom Benutzer zugewiesene Identität, die dem Batchpool zugeordnet ist, den ein Computeknoten verwendet.
ContainerConfiguration

Die Konfiguration für containerfähige Pools.
ContainerHostBatchBindMountEntry

Der Eintrag des Pfad- und Bereitstellungsmodus, den Sie in Aufgabencontainer bereitstellen möchten.
ContainerHostDataPath

Die Pfade, die im Container der Containeraufgabe bereitgestellt werden.
ContainerRegistry

Eine private Containerregistrierung.
ContainerType

Die zu verwendende Containertechnologie.
ContainerWorkingDirectory

Ein Kennzeichen, das angibt, wo sich das Arbeitsverzeichnis der Containeraufgabe befindet. Der Standardwert ist "taskWorkingDirectory".
DataDisk

Einstellungen, die von den Datenträgern verwendet werden, die Computeknoten im Pool zugeordnet sind. Wenn Sie angefügte Datenträger verwenden, müssen Sie die Datenträger innerhalb einer VM bereitstellen und formatieren, um sie zu verwenden.
DeploymentConfiguration

Eigenschaften der Bereitstellungskonfiguration.
DiffDiskPlacement

Gibt die kurzlebige Datenträgerplatzierung für den Betriebssystemdatenträger für alle virtuellen Computer im Pool an.
DiffDiskSettings

Gibt die kurzlebigen Datenträgereinstellungen für den Betriebssystemdatenträger an, der vom virtuellen Computer verwendet wird.
DiskEncryptionConfiguration

Die Auf Computeknoten im Pool angewendete Datenträgerverschlüsselungskonfiguration. Die Datenträgerverschlüsselungskonfiguration wird im Linux-Pool, der mit virtual Machine Image oder Azure Compute Gallery Image erstellt wurde, nicht unterstützt.
DiskEncryptionTarget

Die Liste der Datenträgerziele für den Batchdienst wird auf dem Computeknoten verschlüsselt.
DynamicVNetAssignmentScope

Der Umfang der dynamischen vnet-Zuordnung.
ElevationLevel

Die Höhe des Benutzers.
EnvironmentSetting

Eine Umgebungsvariable, die für einen Aufgabenprozess festgelegt werden soll.
FixedScaleSettings

Feste Skalierungseinstellungen für den Pool.
ImageReference

Ein Verweis auf ein Azure Virtual Machines Marketplace-Image oder die Azure Image-Ressource eines benutzerdefinierten virtuellen Computers. Informationen zum Abrufen der Liste aller imageReferences, die von Azure Batch überprüft wurden, finden Sie im Vorgang "Auflisten unterstützter Knoten-Agent-SKUs".
InboundEndpointProtocol

Das Protokoll des Endpunkts.
InboundNatPool

Ein eingehender NAT-Pool, der verwendet werden kann, um bestimmte Ports auf Computeknoten in einem Batchpool extern zu adressieren.
InterNodeCommunicationState

Gibt an, ob der Pool die direkte Kommunikation zwischen Knoten zulässt.
IPAddressProvisioningType

Der Bereitstellungstyp für öffentliche IP-Adressen für den Batchpool.
LinuxUserConfiguration

Eigenschaften, die zum Erstellen eines Benutzerkontos auf einem Linux-Knoten verwendet werden.
LoginMode

Anmeldemodus für Benutzer
ManagedDisk
MetadataItem

Ein Name-Wert-Paar, das einer Batchdienstressource zugeordnet ist.
MountConfiguration

Das Dateisystem, das auf jedem Knoten bereitgestellt werden soll.
NetworkConfiguration

Die Netzwerkkonfiguration für einen Pool.
NetworkSecurityGroupRule

Eine Netzwerksicherheitsgruppenregel, die auf einen eingehenden Endpunkt angewendet werden soll.
NetworkSecurityGroupRuleAccess

Die Aktion, die für eine angegebene IP-Adresse, einen Subnetzbereich oder ein Bestimmtes Tag ausgeführt werden soll.
NFSMountConfiguration

Informationen, die zum Herstellen einer Verbindung mit einem NFS-Dateisystem verwendet werden.
NodeCommunicationMode

Bestimmt, wie ein Pool mit dem Batchdienst kommuniziert.
NodePlacementConfiguration

Knotenplatzierungskonfiguration für Batchpools.
NodePlacementPolicyType

Die Platzierungsrichtlinie zum Zuordnen von Knoten im Pool.
OSDisk

Einstellungen für den Betriebssystemdatenträger des virtuellen Computers.
Pool

Enthält Informationen zu einem Pool.
PoolEndpointConfiguration

Die Endpunktkonfiguration für einen Pool.
PoolIdentityType

Der Identitätstyp, der für den Batchpool verwendet wird.
PoolProvisioningState

Der aktuelle Zustand des Pools.
PublicIPAddressConfiguration

Die konfiguration der öffentlichen IP-Adresse der Netzwerkkonfiguration eines Pools.
ResizeError

Fehler beim Ändern der Größe eines Pools.
ResizeOperationStatus

Details zum aktuellen oder letzten abgeschlossenen Größenänderungsvorgang.
ResourceFile

Eine einzelne Datei oder mehrere Dateien, die auf einen Computeknoten heruntergeladen werden sollen.
RollingUpgradePolicy

Die Konfigurationsparameter, die beim Ausführen eines rollierenden Upgrades verwendet werden.
ScaleSettings

Skalierungseinstellungen für den Pool
SecurityEncryptionTypes

Gibt den EncryptionType des verwalteten Datenträgers an. Sie ist für die Verschlüsselung nur des VMGuestState-Blobs auf "VMGuestStateOnly" und "NonPersistedTPM" festgelegt, damit der Firmwarestatus im VMGuestState-Blob nicht beibehalten wird. Hinweis: Sie kann nur für vertrauliche VMs festgelegt werden und ist bei Verwendung vertraulicher VMs erforderlich.
SecurityProfile

Gibt die Sicherheitsprofileinstellungen für den virtuellen Computer oder die Skalierungsgruppe des virtuellen Computers an.
SecurityTypes

Gibt den SecurityType des virtuellen Computers an. Sie muss auf einen beliebigen angegebenen Wert festgelegt werden, um UefiSettings zu aktivieren.
ServiceArtifactReference

Gibt die Dienstartefaktereferenz-ID an, die zum Festlegen derselben Imageversion für alle virtuellen Computer im Skalierungssatz bei Verwendung der neuesten Imageversion verwendet wird.
StartTask

Eine Aufgabe, die ausgeführt wird, wenn ein Computeknoten einem Pool im Azure Batch-Dienst beitritt oder wenn der Computeknoten neu gestartet oder umimages erstellt wird.
StorageAccountType

Der Speicherkontotyp zum Erstellen von Datenträgern oder Betriebssystemdatenträgern.
TaskContainerSettings

Die Containereinstellungen für eine Aufgabe.
TaskSchedulingPolicy

Gibt an, wie Aufgaben über Computeknoten verteilt werden sollen.
UefiSettings

Gibt die Sicherheitseinstellungen wie sicherer Start und vTPM an, die beim Erstellen des virtuellen Computers verwendet werden.
UpgradeMode

Gibt den Modus eines Upgrades auf virtuelle Computer im Skalierungssatz an.

Mögliche Werte sind:

manuelle – Sie steuern die Anwendung von Updates auf virtuelle Computer im Skalierungssatz. Dazu verwenden Sie die ManualUpgrade-Aktion.

Automatische – Alle virtuellen Computer im Skalierungssatz werden automatisch gleichzeitig aktualisiert.

Roll- – Skalierungssatz führt Aktualisierungen in Batches mit einer optionalen Pausenzeit dazwischen durch.
UpgradePolicy

Beschreibt eine Upgraderichtlinie – automatisch, manuell oder rolliert.
UserAccount

Eigenschaften, die zum Erstellen eines Benutzers auf einem Azure Batch-Knoten verwendet werden.
UserAssignedIdentities

Die Liste der zugeordneten Benutzeridentitäten.
UserIdentity

Die Definition der Benutzeridentität, unter der die Aufgabe ausgeführt wird.
VirtualMachineConfiguration

Die Konfiguration für Computeknoten in einem Pool basierend auf der Azure Virtual Machines-Infrastruktur.
VMDiskSecurityProfile

Gibt die Sicherheitsprofileinstellungen für den verwalteten Datenträger an. Hinweis: Sie kann nur für vertrauliche VMs festgelegt werden und ist bei Verwendung vertraulicher VMs erforderlich.
VMExtension

Die Konfiguration für Erweiterungen virtueller Computer.
WindowsConfiguration

Windows-Betriebssystemeinstellungen, die auf den virtuellen Computer angewendet werden sollen.
WindowsUserConfiguration

Eigenschaften, die zum Erstellen eines Benutzerkontos auf einem Windows-Knoten verwendet werden.

AllocationState

Gibt an, ob die Größe des Pools geändert wird.

Name Typ Beschreibung
Resizing

string

Der Pool ändert die Größe. d. h., Computeknoten werden dem Pool hinzugefügt oder daraus entfernt.
Steady

string

Der Pool ändert die Größe nicht. Es gibt keine Änderungen an der Anzahl der Knoten im laufenden Pool. Ein Pool gibt diesen Zustand ein, wenn er erstellt wird und wenn keine Vorgänge für den Pool ausgeführt werden, um die Anzahl der Knoten zu ändern.
Stopping

string

Die Größe des Pools wurde geändert, der Benutzer hat jedoch angefordert, dass die Größenänderung beendet wurde, die Beendigungsanforderung wurde jedoch noch nicht abgeschlossen.

ApplicationPackageReference

Verknüpfen mit einem Anwendungspaket innerhalb des Batchkontos

Name Typ Beschreibung
id

string

Die ID des zu installierenden Anwendungspakets. Dies muss sich innerhalb desselben Batchkontos wie der Pool befinden. Dies kann entweder ein Verweis auf eine bestimmte Version oder die Standardversion sein, falls vorhanden.
version

string

Die Version der bereitzustellenden Anwendung. Wenn sie weggelassen wird, wird die Standardversion bereitgestellt.
Wenn dies nicht angegeben wird und für diese Anwendung keine Standardversion angegeben wird, schlägt die Anforderung mit dem Fehlercode InvalidApplicationPackageReferences fehl. Wenn Sie die REST-API direkt aufrufen, lautet der HTTP-Statuscode 409.

AutomaticOSUpgradePolicy

Die Konfigurationsparameter, die zum Ausführen eines automatischen Betriebssystemupgrades verwendet werden.

Name Typ Beschreibung
disableAutomaticRollback

boolean

Gibt an, ob das Rollbackfeature des Betriebssystemimages deaktiviert werden soll.
enableAutomaticOSUpgrade

boolean

Gibt an, ob Betriebssystemupgrades automatisch auf Skalierungssatzinstanzen angewendet werden sollen, wenn eine neuere Version des Betriebssystemimages verfügbar wird.

Wenn dies für Windows-basierte Pools auf "true" festgelegt ist, können "WindowsConfiguration.enableAutomaticUpdates"- nicht auf "true" festgelegt werden.
osRollingUpgradeDeferral

boolean

Verzögern Sie Betriebssystemupgrades auf tvMs, wenn sie Aufgaben ausführen.
useRollingUpgradePolicy

boolean

Gibt an, ob die Rollupgraderichtlinie während des Automatischen Betriebssystemupgrades verwendet werden soll. Das automatische Betriebssystemupgrade wird auf die Standardrichtlinie zurückfallen, wenn keine Richtlinie für vmSS definiert ist.

AutoScaleRun

Die Ergebnisse und Fehler aus einer Ausführung einer Formel für die automatische Skalierung eines Pools.

Name Typ Beschreibung
error

AutoScaleRunError

Details zum Fehler beim Auswerten der Autoskalenformel im Pool, wenn die Auswertung nicht erfolgreich war.
evaluationTime

string

Die Zeit, zu der die Autoskalenformel zuletzt ausgewertet wurde.
results

string

Die Endwerte aller Variablen, die bei der Auswertung der Autoskalenformel verwendet werden.
Jeder Variablenwert wird im Formular $variable=Wert zurückgegeben, und Variablen werden durch Semikolons getrennt.

AutoScaleRunError

Fehler beim automatischenCaling eines Pools.

Name Typ Beschreibung
code

string

Ein Bezeichner für den Fehler. Codes sind unveränderlich und sollen programmgesteuert genutzt werden.
details

AutoScaleRunError[]

Weitere Details zum Fehler.
message

string

Eine Meldung, die den Fehler beschreibt, der für die Anzeige in einer Benutzeroberfläche geeignet ist.

AutoScaleSettings

AutoScale-Einstellungen für den Pool.

Name Typ Beschreibung
evaluationInterval

string

Das Zeitintervall, in dem die Poolgröße automatisch entsprechend der Autoskalenformel angepasst werden soll.
Wenn dieser Wert nicht angegeben wird, beträgt der Standardwert 15 Minuten (PT15M).
formula

string

Eine Formel für die gewünschte Anzahl von Computeknoten im Pool.

AutoUserScope

Der Bereich für den automatischen Benutzer

Name Typ Beschreibung
Pool

string

Gibt an, dass die Aufgabe als allgemeines automatisches Benutzerkonto ausgeführt wird, das auf jedem Knoten in einem Pool erstellt wird.
Task

string

Gibt an, dass der Dienst einen neuen Benutzer für die Aufgabe erstellen soll.

AutoUserSpecification

Gibt die Parameter für den automatischen Benutzer an, der eine Aufgabe im Batchdienst ausführt.

Name Typ Beschreibung
elevationLevel

ElevationLevel

Die Höhenstufe des automatischen Benutzers.
Der Standardwert ist "nonAdmin".
scope

AutoUserScope

Der Bereich für den automatischen Benutzer
Der Standardwert ist Pool. Wenn der Pool Windows ausführt, sollte ein Wert der Aufgabe angegeben werden, wenn eine strengere Isolierung zwischen Vorgängen erforderlich ist. Wenn die Aufgabe z. B. die Registrierung auf eine Weise stummschaltet, die sich auf andere Aufgaben auswirken könnte, oder wenn Zertifikate auf dem Pool angegeben wurden, auf die nicht durch normale Aufgaben zugegriffen werden sollte, sondern durch Startaufgaben zugänglich sein sollte.

AzureBlobFileSystemConfiguration

Informationen, die zum Herstellen einer Verbindung mit einem Azure Storage-Container mithilfe von Blobfuse verwendet werden.

Name Typ Beschreibung
accountKey

string

Der Azure Storage-Kontoschlüssel.
Diese Eigenschaft schließt sich gegenseitig mit sasKey und Identität aus; genau einer muss angegeben werden.
accountName

string

Der Name des Azure Storage-Kontos.
blobfuseOptions

string

Zusätzliche Befehlszeilenoptionen, die an den Bereitstellungsbefehl übergeben werden sollen.
Dies sind "net use"-Optionen in Windows und "Mount"-Optionen in Linux.
containerName

string

Der Name des Azure Blob Storage-Containers.
identityReference

ComputeNodeIdentityReference

Der Verweis auf die vom Benutzer zugewiesene Identität für den Zugriff auf containerName
Diese Eigenschaft schließt sich gegenseitig mit accountKey und sasKey aus. genau einer muss angegeben werden.
relativeMountPath

string

Der relative Pfad auf dem Computeknoten, in dem das Dateisystem bereitgestellt wird
Alle Dateisysteme werden relativ zum Batch-Bereitstellungsverzeichnis bereitgestellt, auf das über die Umgebungsvariable AZ_BATCH_NODE_MOUNTS_DIR zugegriffen werden kann.
sasKey

string

Das Azure Storage SAS-Token.
Diese Eigenschaft schließt sich gegenseitig mit AccountKey und Identität aus; genau einer muss angegeben werden.

AzureFileShareConfiguration

Informationen, die zum Herstellen einer Verbindung mit einer Azure Fileshare verwendet werden.

Name Typ Beschreibung
accountKey

string

Der Azure Storage-Kontoschlüssel.
accountName

string

Der Name des Azure Storage-Kontos.
azureFileUrl

string

Die Azure Files-URL.
Dies ist das Format "https://{account}.file.core.windows.net/".
mountOptions

string

Zusätzliche Befehlszeilenoptionen, die an den Bereitstellungsbefehl übergeben werden sollen.
Dies sind "net use"-Optionen in Windows und "Mount"-Optionen in Linux.
relativeMountPath

string

Der relative Pfad auf dem Computeknoten, in dem das Dateisystem bereitgestellt wird
Alle Dateisysteme werden relativ zum Batch-Bereitstellungsverzeichnis bereitgestellt, auf das über die Umgebungsvariable AZ_BATCH_NODE_MOUNTS_DIR zugegriffen werden kann.

BatchPoolIdentity

Die Identität des Batchpools, falls konfiguriert. Wenn die Poolidentität während der Aktualisierung eines vorhandenen Pools aktualisiert wird, verfügen nur die neuen vms, die nach dem Verkleinern des Pools auf 0 erstellt werden, über die aktualisierten Identitäten.

Name Typ Beschreibung
type

PoolIdentityType

Der Identitätstyp, der für den Batchpool verwendet wird.
userAssignedIdentities

<string,  UserAssignedIdentities>

Die Liste der Benutzeridentitäten, die dem Batchpool zugeordnet sind.

CachingType

Der Typ der Zwischenspeicherung, die für den Datenträger aktiviert werden soll.

Name Typ Beschreibung
None

string

Der Cachemodus für den Datenträger ist nicht aktiviert.
ReadOnly

string

Der Cachemodus für den Datenträger ist schreibgeschützt.
ReadWrite

string

Der Cachemodus für den Datenträger ist lese- und schreibgeschützt.

CertificateReference

Ein Verweis auf ein Zertifikat, das auf Computeknoten in einem Pool installiert werden soll. Dies muss innerhalb desselben Kontos wie der Pool vorhanden sein.

Name Typ Beschreibung
id

string

Die vollqualifizierte ID des Zertifikats, das im Pool installiert werden soll. Dies muss sich innerhalb desselben Batchkontos wie der Pool befinden.
storeLocation

CertificateStoreLocation

Der Speicherort des Zertifikatspeichers auf dem Computeknoten, in den das Zertifikat installiert werden soll.
Der Standardwert ist currentUser. Diese Eigenschaft gilt nur für Pools, die mit Windows-Computeknoten konfiguriert sind. Bei Linux-Computeknoten werden die Zertifikate in einem Verzeichnis im Arbeitsverzeichnis der Aufgabe gespeichert, und eine Umgebungsvariable AZ_BATCH_CERTIFICATES_DIR der Aufgabe bereitgestellt wird, um diesen Speicherort abzufragen. Für Zertifikate mit Sichtbarkeit von "remoteUser" wird ein Verzeichnis "certs" im Startverzeichnis des Benutzers (z. B. /home/{user-name}/certs) erstellt und Zertifikate in diesem Verzeichnis platziert.
storeName

string

Der Name des Zertifikatspeichers auf dem Computeknoten, in den das Zertifikat installiert werden soll.
Diese Eigenschaft gilt nur für Pools, die mit Windows-Computeknoten konfiguriert sind. Allgemeine Store-Namen sind: My, Root, CA, Trust, Disallowed, TrustedPeople, TrustedPublisher, AuthRoot, AddressBook, but any custom store name can also be used. Der Standardwert ist "Mein".
visibility

CertificateVisibility[]

Welche Benutzerkonten auf dem Computeknoten Zugriff auf die privaten Daten des Zertifikats haben sollen.

CertificateStoreLocation

Der Speicherort des Zertifikatspeichers auf dem Computeknoten, in den das Zertifikat installiert werden soll.

Name Typ Beschreibung
CurrentUser

string

Zertifikate sollten im CurrentUser-Zertifikatspeicher installiert werden.
LocalMachine

string

Zertifikate sollten im LocalMachine-Zertifikatspeicher installiert werden.

CertificateVisibility

Welche Benutzerkonten auf dem Computeknoten Zugriff auf die privaten Daten des Zertifikats haben sollen.

Name Typ Beschreibung
RemoteUser

string

Das Zertifikat sollte für die Benutzerkonten sichtbar sein, unter denen Benutzer remote auf den Knoten zugreifen.
StartTask

string

Das Zertifikat sollte für das Benutzerkonto sichtbar sein, unter dem die Startaufgabe ausgeführt wird. Beachten Sie, dass dieses Zertifikat auch für die Aufgabe sichtbar ist, wenn der Bereich "AutoUser" sowohl für den StartTask als auch für einen Vorgang vorhanden ist.
Task

string

Das Zertifikat sollte für die Benutzerkonten sichtbar sein, unter denen Auftragsaufgaben ausgeführt werden.

CIFSMountConfiguration

Informationen, die zum Herstellen einer Verbindung mit einem CIFS-Dateisystem verwendet werden.

Name Typ Beschreibung
mountOptions

string

Zusätzliche Befehlszeilenoptionen, die an den Bereitstellungsbefehl übergeben werden sollen.
Dies sind "net use"-Optionen in Windows und "Mount"-Optionen in Linux.
password

string

Das Kennwort, das für die Authentifizierung im CIFS-Dateisystem verwendet werden soll.
relativeMountPath

string

Der relative Pfad auf dem Computeknoten, in dem das Dateisystem bereitgestellt wird
Alle Dateisysteme werden relativ zum Batch-Bereitstellungsverzeichnis bereitgestellt, auf das über die Umgebungsvariable AZ_BATCH_NODE_MOUNTS_DIR zugegriffen werden kann.
source

string

Der URI des zu mountden Dateisystems.
userName

string

Der Benutzer, der für die Authentifizierung gegen das CIFS-Dateisystem verwendet werden soll.

CloudError

Eine Fehlerantwort des Batchdiensts.

Name Typ Beschreibung
error

CloudErrorBody

Der Textkörper der Fehlerantwort.

CloudErrorBody

Eine Fehlerantwort des Batchdiensts.

Name Typ Beschreibung
code

string

Ein Bezeichner für den Fehler. Codes sind unveränderlich und sollen programmgesteuert genutzt werden.
details

CloudErrorBody[]

Eine Liste mit zusätzlichen Details zum Fehler.
message

string

Eine Meldung, die den Fehler beschreibt, der für die Anzeige in einer Benutzeroberfläche geeignet ist.
target

string

Das Ziel des bestimmten Fehlers. Beispielsweise der Name der Eigenschaft im Fehler.

ComputeNodeDeallocationOption

Bestimmt, was mit einem Knoten und seinen ausgeführten Aufgaben ausgeführt werden soll, nachdem sie für die Deallocation ausgewählt wurde.

Name Typ Beschreibung
Requeue

string

Beenden Sie die Ausführung von Aufgabenprozessen, und stellen Sie die Aufgaben erneut ab. Die Aufgaben werden erneut ausgeführt, wenn ein Knoten verfügbar ist. Entfernen Sie Knoten, sobald Vorgänge beendet wurden.
RetainedData

string

Zulassen, dass derzeit ausgeführte Aufgaben abgeschlossen werden, und warten Sie dann, bis alle Aufbewahrungszeiträume für Aufgabendaten ablaufen. Planen Sie beim Warten keine neuen Vorgänge. Entfernen Sie Knoten, wenn alle Aufbewahrungszeiträume für Vorgänge abgelaufen sind.
TaskCompletion

string

Das Ausführen von derzeit ausgeführten Aufgaben zulassen. Planen Sie beim Warten keine neuen Vorgänge. Entfernen Sie Knoten, wenn alle Aufgaben abgeschlossen wurden.
Terminate

string

Beenden Sie die Ausführung von Aufgaben. Die Aufgaben werden mit failureInfo abgeschlossen, die angeben, dass sie beendet wurden und nicht erneut ausgeführt werden. Entfernen Sie Knoten, sobald Vorgänge beendet wurden.

ComputeNodeFillType

Wie Aufgaben über Computeknoten verteilt werden sollen.

Name Typ Beschreibung
Pack

string

So viele Aufgaben wie möglich (taskSlotsPerNode) sollten jedem Knoten im Pool zugewiesen werden, bevor vorgänge dem nächsten Knoten im Pool zugewiesen werden.
Spread

string

Vorgänge sollten gleichmäßig auf allen Knoten im Pool zugewiesen werden.

ComputeNodeIdentityReference

Der Verweis auf eine vom Benutzer zugewiesene Identität, die dem Batchpool zugeordnet ist, den ein Computeknoten verwendet.

Name Typ Beschreibung
resourceId

string

Die ARM-Ressourcen-ID der vom Benutzer zugewiesenen Identität.

ContainerConfiguration

Die Konfiguration für containerfähige Pools.

Name Typ Beschreibung
containerImageNames

string[]

Die Sammlung von Containerimagenamen.
Dies ist der vollständige Imageverweis, wie für "Docker Pull" angegeben. Ein Image wird aus der Docker-Standardregistrierung stammen, es sei denn, das Image ist vollqualifizierte mit einer alternativen Registrierung.
containerRegistries

ContainerRegistry[]

Zusätzliche private Register, aus denen Container abgerufen werden können.
Wenn Bilder aus einer privaten Registrierung heruntergeladen werden müssen, die Anmeldeinformationen erfordert, müssen diese Anmeldeinformationen hier angegeben werden.
type

ContainerType

Die zu verwendende Containertechnologie.

ContainerHostBatchBindMountEntry

Der Eintrag des Pfad- und Bereitstellungsmodus, den Sie in Aufgabencontainer bereitstellen möchten.

Name Typ Beschreibung
isReadOnly

boolean

Stellen Sie diesen Quellpfad als schreibgeschützten Modus ein oder nicht. Der Standardwert ist false (Lese-/Schreibmodus).
Wenn Sie diesen Pfad für Linux als Lese-/Schreibmodus bereitstellen, bedeutet dies nicht, dass alle Benutzer im Container über den Lese-/Schreibzugriff für den Pfad verfügen, hängt sie vom Zugriff auf die Host-VM ab. Wenn dieser Pfad schreibgeschützt bereitgestellt wird, können alle Benutzer im Container den Pfad nicht ändern.
source

ContainerHostDataPath

Der Pfad, der für containerkunden bereitgestellt werden kann.

ContainerHostDataPath

Die Pfade, die im Container der Containeraufgabe bereitgestellt werden.

Name Typ Beschreibung
Applications

string

Der Anwendungspfad.
JobPrep

string

Der Auftragsvorstellungsvorgangspfad.
Shared

string

Der Pfad für die Aufgabe mit mehreren Instanzen, um ihre Dateien freigegeben zu haben.
Startup

string

Der Pfad für die Startaufgabe.
Task

string

Der Vorgangspfad.
VfsMounts

string

Der Pfad enthält alle virtuellen Dateisysteme, die auf diesem Knoten bereitgestellt werden.

ContainerRegistry

Eine private Containerregistrierung.

Name Typ Beschreibung
identityReference

ComputeNodeIdentityReference

Der Verweis auf die vom Benutzer zugewiesene Identität, die für den Zugriff auf eine Azure-Containerregistrierung anstelle von Benutzername und Kennwort verwendet werden soll.
Der Verweis auf eine vom Benutzer zugewiesene Identität, die dem Batchpool zugeordnet ist, den ein Computeknoten verwendet.
password

string

Das Kennwort für die Anmeldung beim Registrierungsserver.
registryServer

string

Die Registrierungs-URL.
Wenn nicht angegeben, lautet der Standardwert "docker.io".
username

string

Der Benutzername, der sich beim Registrierungsserver anmeldet.

ContainerType

Die zu verwendende Containertechnologie.

Name Typ Beschreibung
CriCompatible

string

Eine CRI-basierte Technologie wird verwendet, um die Container zu starten.
DockerCompatible

string

Eine Docker-kompatible Containertechnologie wird verwendet, um die Container zu starten.

ContainerWorkingDirectory

Ein Kennzeichen, das angibt, wo sich das Arbeitsverzeichnis der Containeraufgabe befindet. Der Standardwert ist "taskWorkingDirectory".

Name Typ Beschreibung
ContainerImageDefault

string

Verwenden des definierten Arbeitsverzeichnisses des Containerimages. Achten Sie darauf, dass dieses Verzeichnis die von Batch heruntergeladenen Ressourcendateien nicht enthält.
TaskWorkingDirectory

string

Verwenden Sie das standardmäßige Arbeitsverzeichnis für Batchdienstaufgaben, das die Vorgangsressourcendateien enthält, die von Batch aufgefüllt werden.

DataDisk

Einstellungen, die von den Datenträgern verwendet werden, die Computeknoten im Pool zugeordnet sind. Wenn Sie angefügte Datenträger verwenden, müssen Sie die Datenträger innerhalb einer VM bereitstellen und formatieren, um sie zu verwenden.

Name Typ Beschreibung
caching

CachingType

Der Typ der Zwischenspeicherung, die für die Datenträger aktiviert werden soll.
Werte sind:

none – Der Cachemodus für den Datenträger ist nicht aktiviert. readOnly – Der Cachemodus für den Datenträger ist schreibgeschützt. readWrite – Der Cachemodus für den Datenträger ist lese- und schreibgeschützt.

Der Standardwert für die Zwischenspeicherung ist keine. Informationen zu den Zwischenspeicherungsoptionen finden Sie unter: https://blogs.msdn.microsoft.com/windowsazurestorage/2012/06/27/exploring-windows-azure-drives-disks-and-images/.
diskSizeGB

integer

Die anfängliche Datenträgergröße in GB beim Erstellen eines neuen Datenträgers.
lun

integer

Die wahrheitslogische Einheitsnummer.
Die Lun wird verwendet, um jeden Datenträger eindeutig zu identifizieren. Wenn sie mehrere Datenträger anfügen, sollte jeder eine unterschiedliche Lun aufweisen. Der Wert muss zwischen 0 und 63 (einschließlich) liegen.
storageAccountType

StorageAccountType

Der Speicherkontotyp, der für den Datenträger verwendet werden soll.
Wenn nicht angegeben, lautet der Standardwert "Standard_LRS". Werte sind:

Standard_LRS – Der Datenträger sollte standardmäßigen lokal redundanten Speicher verwenden. Premium_LRS – Der Datenträger sollte einen lokal redundanten Premiumspeicher verwenden.

DeploymentConfiguration

Eigenschaften der Bereitstellungskonfiguration.

Name Typ Beschreibung
virtualMachineConfiguration

VirtualMachineConfiguration

Die Konfiguration des virtuellen Computers für den Pool.

DiffDiskPlacement

Gibt die kurzlebige Datenträgerplatzierung für den Betriebssystemdatenträger für alle virtuellen Computer im Pool an.

Name Typ Beschreibung
CacheDisk

string

Der ephemerale Betriebssystemdatenträger wird im VM-Cache gespeichert.

DiffDiskSettings

Gibt die kurzlebigen Datenträgereinstellungen für den Betriebssystemdatenträger an, der vom virtuellen Computer verwendet wird.

Name Typ Beschreibung
placement

DiffDiskPlacement

Gibt die kurzlebige Datenträgerplatzierung für den Betriebssystemdatenträger für alle virtuellen Computer im Pool an.
Diese Eigenschaft kann vom Benutzer in der Anforderung verwendet werden, um auszuwählen, an welchem Speicherort sich das Betriebssystem befinden soll. z. B. Cachespeicherplatz für ephemerale Betriebssystemdatenträgerbereitstellung. Weitere Informationen zu den Anforderungen an ephemerale Betriebssystemdatenträgergrößen finden Sie unter ephemeren Betriebssystemgrößenanforderungen für Windows-VMs unter https://docs.microsoft.com/en-us/azure/virtual-machines/windows/ephemeral-os-disks#size-requirements und Linux-VMs unter https://docs.microsoft.com/en-us/azure/virtual-machines/linux/ephemeral-os-disks#size-requirements.

DiskEncryptionConfiguration

Die Auf Computeknoten im Pool angewendete Datenträgerverschlüsselungskonfiguration. Die Datenträgerverschlüsselungskonfiguration wird im Linux-Pool, der mit virtual Machine Image oder Azure Compute Gallery Image erstellt wurde, nicht unterstützt.

Name Typ Beschreibung
targets

DiskEncryptionTarget[]

Die Liste der Datenträgerziele für den Batchdienst wird auf dem Computeknoten verschlüsselt.
Unter Linux-Pool wird nur "TemporaryDisk" unterstützt; unter Windows-Pool muss "OsDisk" und "TemporaryDisk" angegeben werden.

DiskEncryptionTarget

Die Liste der Datenträgerziele für den Batchdienst wird auf dem Computeknoten verschlüsselt.

Name Typ Beschreibung
OsDisk

string

Der Betriebssystemdatenträger auf dem Computeknoten ist verschlüsselt.
TemporaryDisk

string

Der temporäre Datenträger auf dem Computeknoten ist verschlüsselt. Unter Linux gilt diese Verschlüsselung für andere Partitionen (z. B. auf bereitgestellten Datenträgern), wenn die Verschlüsselung zur Startzeit auftritt.

DynamicVNetAssignmentScope

Der Umfang der dynamischen vnet-Zuordnung.

Name Typ Beschreibung
job

string

Die dynamische VNet-Zuordnung erfolgt pro Auftrag. Wenn dieser Wert festgelegt ist, muss auch die Netzwerkkonfigurations-Subnetz-ID festgelegt werden. Dieses Feature erfordert eine Genehmigung vor der Verwendung. Wenden Sie sich an den Support.
none

string

Es ist keine dynamische VNet-Zuweisung aktiviert.

ElevationLevel

Die Höhe des Benutzers.

Name Typ Beschreibung
Admin

string

Der Benutzer ist ein Benutzer mit erhöhtem Zugriff und arbeitet mit vollständigen Administratorberechtigungen.
NonAdmin

string

Der Benutzer ist ein Standardbenutzer ohne erhöhten Zugriff.

EnvironmentSetting

Eine Umgebungsvariable, die für einen Aufgabenprozess festgelegt werden soll.

Name Typ Beschreibung
name

string

Der Name der Umgebungsvariable.
value

string

Der Wert der Umgebungsvariable.

FixedScaleSettings

Feste Skalierungseinstellungen für den Pool.

Name Typ Standardwert Beschreibung
nodeDeallocationOption

ComputeNodeDeallocationOption

Bestimmt, was mit einem Knoten und den ausgeführten Aufgaben(en) geschieht, wenn die Poolgröße verringert wird.
Wenn dieser Wert nicht angegeben wird, lautet der Standardwert "Requeue".
resizeTimeout

string

PT15M

Das Timeout für die Zuordnung von Computeknoten für den Pool.
Der Standardwert beträgt 15 Minuten. Timeoutwerte verwenden das ISO 8601-Format. Verwenden Sie z. B. PT10M für 10 Minuten. Der Mindestwert beträgt 5 Minuten. Wenn Sie einen Wert kleiner als 5 Minuten angeben, lehnt der Batchdienst die Anforderung mit einem Fehler ab; wenn Sie die REST-API direkt aufrufen, lautet der HTTP-Statuscode 400 (Ungültige Anforderung).
targetDedicatedNodes

integer

Die gewünschte Anzahl dedizierter Computeknoten im Pool.
Mindestens einer von targetDedicatedNodes muss "targetLowPriorityNodes" festgelegt werden.
targetLowPriorityNodes

integer

Die gewünschte Anzahl von Spot-/Low-Priority-Computeknoten im Pool.
Mindestens einer von targetDedicatedNodes muss "targetLowPriorityNodes" festgelegt werden.

ImageReference

Ein Verweis auf ein Azure Virtual Machines Marketplace-Image oder die Azure Image-Ressource eines benutzerdefinierten virtuellen Computers. Informationen zum Abrufen der Liste aller imageReferences, die von Azure Batch überprüft wurden, finden Sie im Vorgang "Auflisten unterstützter Knoten-Agent-SKUs".

Name Typ Beschreibung
communityGalleryImageId

string

Eindeutiger Bezeichner des Communitykatalogbilds
Diese Eigenschaft schließt sich gegenseitig mit anderen Eigenschaften aus und kann aus dem Get-Aufruf der Communitygalerie abgerufen werden.
id

string

Der ARM-Ressourcenbezeichner des Azure Compute Gallery Image. Computeknoten im Pool werden mithilfe dieser Image-ID erstellt. Dies ist das Format /subscriptions/{subscriptionId}/resourceGroups/{resourceGroup}/providers/Microsoft.Compute/gallerys/{galleryName}/images/{imageDefinitionName}/versions/{versionId}.
Diese Eigenschaft schließt sich gegenseitig mit anderen Eigenschaften aus. Das Azure Compute Gallery Image muss Replikate in derselben Region wie das Azure Batch-Konto haben. Informationen zu den Firewalleinstellungen für den Batchknoten-Agent für die Kommunikation mit dem Batchdienst finden Sie unter https://docs.microsoft.com/en-us/azure/batch/batch-api-basics#virtual-network-vnet-and-firewall-configuration.
offer

string

Der Angebotstyp des Azure Virtual Machines Marketplace-Images.
Beispiel: UbuntuServer oder WindowsServer.
publisher

string

Der Herausgeber des Azure Virtual Machines Marketplace-Images.
Beispiel: Canonical oder MicrosoftWindowsServer.
sharedGalleryImageId

string

Eindeutiger Bezeichner des freigegebenen Katalogbilds
Diese Eigenschaft schließt sich gegenseitig mit anderen Eigenschaften aus und kann aus dem GET-Aufruf des freigegebenen Katalogbilds abgerufen werden.
sku

string

Die SKU des Azure Virtual Machines Marketplace-Images.
Beispiel: 18.04-LTS oder 2022-Datacenter.
version

string

Die Version des Azure Virtual Machines Marketplace-Images.
Ein Wert von "latest" kann angegeben werden, um die neueste Version eines Bilds auszuwählen. Wenn dieser Wert nicht angegeben wird, lautet der Standardwert "latest".

InboundEndpointProtocol

Das Protokoll des Endpunkts.

Name Typ Beschreibung
TCP

string

Verwenden Sie TCP für den Endpunkt.
UDP

string

Verwenden Sie UDP für den Endpunkt.

InboundNatPool

Ein eingehender NAT-Pool, der verwendet werden kann, um bestimmte Ports auf Computeknoten in einem Batchpool extern zu adressieren.

Name Typ Beschreibung
backendPort

integer

Die Portnummer auf dem Computeknoten.
Dies muss innerhalb eines Batchpools eindeutig sein. Zulässige Werte liegen zwischen 1 und 65535, mit Ausnahme von 29876 und 29877, da diese reserviert sind. Wenn reservierte Werte bereitgestellt werden, schlägt die Anforderung mit dem HTTP-Statuscode 400 fehl.
frontendPortRangeEnd

integer

Die letzte Portnummer im Bereich externer Ports, die verwendet werden, um eingehenden Zugriff auf den Back-EndPort auf einzelnen Computeknoten bereitzustellen.
Zulässige Werte liegen zwischen 1 und 65534 mit Ausnahme von Ports von 50000 bis 55000, die vom Batchdienst reserviert sind. Alle Bereiche innerhalb eines Pools müssen eindeutig sein und können nicht überlappen. Wenn reservierte oder überlappende Werte bereitgestellt werden, schlägt die Anforderung mit dem HTTP-Statuscode 400 fehl.
frontendPortRangeStart

integer

Die erste Portnummer im Bereich externer Ports, die verwendet werden, um eingehenden Zugriff auf den Back-EndPort auf einzelnen Computeknoten bereitzustellen.
Zulässige Werte liegen zwischen 1 und 65534 mit Ausnahme von Ports von 50000 bis 55000, die reserviert sind. Alle Bereiche innerhalb eines Pools müssen eindeutig sein und können nicht überlappen. Wenn reservierte oder überlappende Werte bereitgestellt werden, schlägt die Anforderung mit dem HTTP-Statuscode 400 fehl.
name

string

Der Name des Endpunkts.
Der Name muss innerhalb eines Batchpools eindeutig sein, kann Buchstaben, Zahlen, Unterstriche, Punkte und Bindestriche enthalten. Namen müssen mit einem Buchstaben oder einer Zahl beginnen, müssen mit einem Buchstaben, einer Zahl oder einem Unterstrich enden und dürfen 77 Zeichen nicht überschreiten. Wenn ungültige Werte bereitgestellt werden, schlägt die Anforderung mit dem HTTP-Statuscode 400 fehl.
networkSecurityGroupRules

NetworkSecurityGroupRule[]

Eine Liste der Regeln für Netzwerksicherheitsgruppen, die auf den Endpunkt angewendet werden.
Die maximale Anzahl von Regeln, die für alle Endpunkte in einem Batchpool angegeben werden können, beträgt 25. Wenn keine Regeln für Netzwerksicherheitsgruppen angegeben sind, wird eine Standardregel erstellt, um den eingehenden Zugriff auf den angegebenen Back-EndPort zuzulassen. Wenn die maximale Anzahl von Netzwerksicherheitsgruppenregeln überschritten wird, schlägt die Anforderung mit dem HTTP-Statuscode 400 fehl.
protocol

InboundEndpointProtocol

Das Protokoll des Endpunkts.

InterNodeCommunicationState

Gibt an, ob der Pool die direkte Kommunikation zwischen Knoten zulässt.

Name Typ Beschreibung
Disabled

string

Deaktivieren Sie die Netzwerkkommunikation zwischen virtuellen Computern.
Enabled

string

Aktivieren sie die Netzwerkkommunikation zwischen virtuellen Computern.

IPAddressProvisioningType

Der Bereitstellungstyp für öffentliche IP-Adressen für den Batchpool.

Name Typ Beschreibung
BatchManaged

string

Eine öffentliche IP wird von Batch erstellt und verwaltet. Je nach Größe des Pools können mehrere öffentliche IPs vorhanden sein.
NoPublicIPAddresses

string

Für die Computeknoten im Pool wird keine öffentliche IP-Adresse erstellt.
UserManaged

string

Öffentliche IPs werden vom Benutzer bereitgestellt und zum Bereitstellen der Computeknoten verwendet.

LinuxUserConfiguration

Eigenschaften, die zum Erstellen eines Benutzerkontos auf einem Linux-Knoten verwendet werden.

Name Typ Beschreibung
gid

integer

Die Gruppen-ID für das Benutzerkonto.
Die Uid- und gid-Eigenschaften müssen zusammen oder gar nicht angegeben werden. Wenn das zugrunde liegende Betriebssystem nicht angegeben ist, wird das Gid ausgewählt.
sshPrivateKey

string

Der private SSH-Schlüssel für das Benutzerkonto.
Der private Schlüssel darf nicht kennwortgeschützter Schlüssel sein. Der private Schlüssel wird verwendet, um die asymmetrische schlüsselbasierte Authentifizierung für SSH zwischen Knoten in einem Linux-Pool automatisch zu konfigurieren, wenn die Eigenschaft enableInterNodeCommunication des Pools wahr ist (wird ignoriert, wenn enableInterNodeCommunication false ist). Dazu wird das Schlüsselpaar in das SSH-Verzeichnis des Benutzers eingefügt. Wenn nicht angegeben, wird kennwortloses SSH nicht zwischen Knoten konfiguriert (es erfolgt keine Änderung des SSH-Verzeichnisses des Benutzers).
uid

integer

Die Benutzer-ID des Benutzerkontos.
Die Uid- und gid-Eigenschaften müssen zusammen oder gar nicht angegeben werden. Wenn das zugrunde liegende Betriebssystem nicht angegeben ist, wird die UID ausgewählt.

LoginMode

Anmeldemodus für Benutzer

Name Typ Beschreibung
Batch

string

Der LOGON32_LOGON_BATCH Win32-Anmeldemodus. Der Batchanmeldungsmodus wird für lange ausgeführte parallele Prozesse empfohlen.
Interactive

string

Der LOGON32_LOGON_INTERACTIVE Win32-Anmeldemodus. Für einige Anwendungen sind Berechtigungen erforderlich, die dem interaktiven Anmeldemodus zugeordnet sind. Wenn dies für eine Anwendung in Ihrer Aufgabe der Fall ist, wird diese Option empfohlen.

ManagedDisk

Name Typ Beschreibung
securityProfile

VMDiskSecurityProfile

Gibt das Sicherheitsprofil für den verwalteten Datenträger an.
Gibt die Sicherheitsprofileinstellungen für den verwalteten Datenträger an. Hinweis: Sie kann nur für vertrauliche VMs festgelegt werden und ist bei Verwendung vertraulicher VMs erforderlich.
storageAccountType

StorageAccountType

Der Speicherkontotyp für verwaltete Datenträger.

MetadataItem

Ein Name-Wert-Paar, das einer Batchdienstressource zugeordnet ist.

Name Typ Beschreibung
name

string

Der Name des Metadatenelements.
value

string

Der Wert des Metadatenelements.

MountConfiguration

Das Dateisystem, das auf jedem Knoten bereitgestellt werden soll.

Name Typ Beschreibung
azureBlobFileSystemConfiguration

AzureBlobFileSystemConfiguration

Der Azure Storage-Container, der mithilfe von BLOB-FUSE auf jedem Knoten bereitgestellt werden soll.
Diese Eigenschaft schließt sich gegenseitig mit allen anderen Eigenschaften aus.
azureFileShareConfiguration

AzureFileShareConfiguration

Die Azure-Dateifreigabe, die auf jedem Knoten bereitgestellt werden soll.
Diese Eigenschaft schließt sich gegenseitig mit allen anderen Eigenschaften aus.
cifsMountConfiguration

CIFSMountConfiguration

Das CIFS/SMB-Dateisystem, das auf jedem Knoten bereitgestellt werden soll.
Diese Eigenschaft schließt sich gegenseitig mit allen anderen Eigenschaften aus.
nfsMountConfiguration

NFSMountConfiguration

Das NFS-Dateisystem, das auf jedem Knoten bereitgestellt werden soll.
Diese Eigenschaft schließt sich gegenseitig mit allen anderen Eigenschaften aus.

NetworkConfiguration

Die Netzwerkkonfiguration für einen Pool.

Name Typ Standardwert Beschreibung
dynamicVnetAssignmentScope

DynamicVNetAssignmentScope

none

Der Umfang der dynamischen vnet-Zuordnung.
enableAcceleratedNetworking

boolean

Gibt an, ob dieser Pool beschleunigte Netzwerke aktivieren soll.
Das beschleunigte Netzwerk ermöglicht die einzelne E/A-Virtualisierung (SR-IOV) für einen virtuellen Computer, was zu einer verbesserten Netzwerkleistung führen kann. Weitere Informationen finden Sie unter: https://learn.microsoft.com/azure/virtual-network/accelerated-networking-overview.
endpointConfiguration

PoolEndpointConfiguration

Die Konfiguration für Endpunkte auf Computeknoten im Batchpool.
publicIPAddressConfiguration

PublicIPAddressConfiguration

Die Öffentliche IPAddress-Konfiguration für Computeknoten im Batchpool.
Die konfiguration der öffentlichen IP-Adresse der Netzwerkkonfiguration eines Pools.
subnetId

string

Der ARM-Ressourcenbezeichner des virtuellen Netzwerksubnetz, dem die Computeknoten des Pools beitreten. Dies ist das Format "/subscriptions/{subscription}/resourceGroups/{group}/providers/{provider}/virtualNetworks/{network}/subnets/{subnet}".
Das virtuelle Netzwerk muss sich in derselben Region und im gleichen Abonnement wie das Azure Batch-Konto befinden. Das angegebene Subnetz sollte über genügend freie IP-Adressen verfügen, um die Anzahl der Knoten im Pool aufzunehmen. Wenn das Subnetz nicht über genügend freie IP-Adressen verfügt, weist der Pool teilweise Computeknoten zu, und es tritt ein Fehler bei der Größenänderung auf. Der Dienstprinzipal "MicrosoftAzureBatch" muss über die Rolle "Classic Virtual Machine Contributor" Role-Based Access Control (RBAC) für das angegebene VNet verfügen. Das angegebene Subnetz muss zulassen, dass die Kommunikation vom Azure Batch-Dienst Vorgänge auf den Computeknoten planen kann. Dies kann überprüft werden, indem überprüft wird, ob das angegebene VNet über alle zugehörigen Netzwerksicherheitsgruppen (Network Security Groups, NSG) verfügt. Wenn die Kommunikation mit den Computeknoten im angegebenen Subnetz von einer NSG verweigert wird, legt der Batchdienst den Status der Computeknoten auf unbrauchbar fest. Wenn das angegebene VNet über zugeordnete Netzwerksicherheitsgruppen (Network Security Groups, NSG) verfügt, müssen einige reservierte Systemports für eingehende Kommunikation aktiviert werden, einschließlich ports 29876 und 29877. Aktivieren Sie auch ausgehende Verbindungen mit Azure Storage auf Port 443. Weitere Informationen finden Sie unter: https://docs.microsoft.com/en-us/azure/batch/batch-api-basics#virtual-network-vnet-and-firewall-configuration

NetworkSecurityGroupRule

Eine Netzwerksicherheitsgruppenregel, die auf einen eingehenden Endpunkt angewendet werden soll.

Name Typ Beschreibung
access

NetworkSecurityGroupRuleAccess

Die Aktion, die für eine angegebene IP-Adresse, einen Subnetzbereich oder ein Bestimmtes Tag ausgeführt werden soll.
priority

integer

Die Priorität für diese Regel.
Prioritäten innerhalb eines Pools müssen eindeutig sein und in der Reihenfolge der Priorität ausgewertet werden. Je niedriger die Zahl ist, desto höher ist die Priorität. Regeln können beispielsweise mit den Bestellnummern 150, 250 und 350 angegeben werden. Die Regel mit der Bestellnummer 150 hat Vorrang vor der Regel mit einer Reihenfolge von 250. Zulässige Prioritäten sind 150 bis 4096. Wenn reservierte oder doppelte Werte bereitgestellt werden, schlägt die Anforderung mit dem HTTP-Statuscode 400 fehl.
sourceAddressPrefix

string

Das Quelladressenpräfix oder -tag, das für die Regel übereinstimmen soll.
Gültige Werte sind eine einzelne IP-Adresse (d. h. 10.10.10.10), IP-Subnetz (d. h. 192.168.1.0/24), Standardtag oder * (für alle Adressen). Wenn andere Werte bereitgestellt werden, schlägt die Anforderung mit dem HTTP-Statuscode 400 fehl.
sourcePortRanges

string[]

Die Quellportbereiche, die für die Regel übereinstimmen sollen.
Gültige Werte sind '*' (für alle Ports 0 - 65535) oder Arrays von Ports oder Portbereichen (d. h. 100-200). Die Ports sollten im Bereich von 0 bis 65535 liegen, und die Portbereiche oder Ports können sich nicht überlappen. Wenn andere Werte bereitgestellt werden, schlägt die Anforderung mit dem HTTP-Statuscode 400 fehl. Der Standardwert ist *.

NetworkSecurityGroupRuleAccess

Die Aktion, die für eine angegebene IP-Adresse, einen Subnetzbereich oder ein Bestimmtes Tag ausgeführt werden soll.

Name Typ Beschreibung
Allow

string

Zugriff zulassen.
Deny

string

Zugriff verweigern.

NFSMountConfiguration

Informationen, die zum Herstellen einer Verbindung mit einem NFS-Dateisystem verwendet werden.

Name Typ Beschreibung
mountOptions

string

Zusätzliche Befehlszeilenoptionen, die an den Bereitstellungsbefehl übergeben werden sollen.
Dies sind "net use"-Optionen in Windows und "Mount"-Optionen in Linux.
relativeMountPath

string

Der relative Pfad auf dem Computeknoten, in dem das Dateisystem bereitgestellt wird
Alle Dateisysteme werden relativ zum Batch-Bereitstellungsverzeichnis bereitgestellt, auf das über die Umgebungsvariable AZ_BATCH_NODE_MOUNTS_DIR zugegriffen werden kann.
source

string

Der URI des zu mountden Dateisystems.

NodeCommunicationMode

Bestimmt, wie ein Pool mit dem Batchdienst kommuniziert.

Name Typ Beschreibung
Classic

string

Knoten, die den klassischen Kommunikationsmodus verwenden, erfordern eingehende TCP-Kommunikation an den Ports 29876 und 29877 aus dem "BatchNodeManagement". {region}" -Diensttag und ausgehende TCP-Kommunikation am Port 443 zu "Storage.region" und "BatchNodeManagement". {region}"-Diensttags.
Default

string

Der Knotenkommunikationsmodus wird automatisch vom Batchdienst festgelegt.
Simplified

string

Knoten, die den vereinfachten Kommunikationsmodus verwenden, erfordern ausgehende TCP-Kommunikation an Port 443 zum "BatchNodeManagement". {region}" -Diensttag. Es sind keine offenen eingehenden Ports erforderlich.

NodePlacementConfiguration

Knotenplatzierungskonfiguration für Batchpools.

Name Typ Beschreibung
policy

NodePlacementPolicyType

Knotenplatzierungsrichtlinientyp in Batchpools.
Zuordnungsrichtlinie, die vom Batchdienst zum Bereitstellen der Knoten verwendet wird. Wenn nicht angegeben, verwendet Batch die Regionalrichtlinie.

NodePlacementPolicyType

Die Platzierungsrichtlinie zum Zuordnen von Knoten im Pool.

Name Typ Beschreibung
Regional

string

Alle Knoten im Pool werden in derselben Region zugewiesen.
Zonal

string

Knoten im Pool werden über verschiedene Zonen verteilt, wobei der Best-Effort-Ausgleich erfolgt.

OSDisk

Einstellungen für den Betriebssystemdatenträger des virtuellen Computers.

Name Typ Beschreibung
caching

CachingType

Gibt die Zwischenspeicherungsanforderungen an. Mögliche Werte sind: None, ReadOnly, ReadWrite. Die Standardwerte sind: Keine für den Standardspeicher. ReadOnly für Premium-Speicher.
diskSizeGB

integer

Die anfängliche Datenträgergröße in GB beim Erstellen eines neuen Betriebssystemdatenträgers.
ephemeralOSDiskSettings

DiffDiskSettings

Gibt die kurzlebigen Datenträgereinstellungen für den Betriebssystemdatenträger an, der vom virtuellen Computer verwendet wird.
managedDisk

ManagedDisk

Die Parameter des verwalteten Datenträgers.
writeAcceleratorEnabled

boolean

Gibt an, ob writeAccelerator auf dem Datenträger aktiviert oder deaktiviert werden soll.

Pool

Enthält Informationen zu einem Pool.

Name Typ Standardwert Beschreibung
etag

string

Das ETag der Ressource, das für Parallelitätsanweisungen verwendet wird.
id

string

Die ID der Ressource.
identity

BatchPoolIdentity

Der Identitätstyp, der für den Batchpool verwendet wird.
Der Identitätstyp, der für den Batchpool verwendet wird.
name

string

Der Name der Ressource.
properties.allocationState

AllocationState

Gibt an, ob die Größe des Pools geändert wird.
properties.allocationStateTransitionTime

string

Die Zeit, zu der der Pool seinen aktuellen Zuordnungsstatus eingegeben hat.
properties.applicationLicenses

string[]

Die Liste der Anwendungslizenzen, die der Batchdienst für jeden Computeknoten im Pool zur Verfügung stellt.
Die Liste der Anwendungslizenzen muss eine Teilmenge der verfügbaren Batchdienstanwendungslizenzen sein. Wenn eine Lizenz angefordert wird, die nicht unterstützt wird, schlägt die Poolerstellung fehl.
properties.applicationPackages

ApplicationPackageReference[]

Die Liste der Anwendungspakete, die auf jedem Computeknoten im Pool installiert werden sollen.
Änderungen an Anwendungspaketverweise wirken sich auf alle neuen Computeknoten aus, die dem Pool beitreten, wirken sich jedoch nicht auf Computeknoten aus, die sich bereits im Pool befinden, bis sie neu gestartet oder umimages aktualisiert werden. Es gibt maximal 10 Anwendungspaketverweise für einen bestimmten Pool.
properties.autoScaleRun

AutoScaleRun

Die Ergebnisse und Fehler aus der letzten Ausführung der Autoskalenformel.
Diese Eigenschaft wird nur festgelegt, wenn der Pool automatisch skaliert wird, d. h. autoScaleSettings verwendet werden.
properties.certificates

CertificateReference[]

Die Liste der Zertifikate, die auf jedem Computeknoten im Pool installiert werden sollen.
Für Windows-Computeknoten installiert der Batchdienst die Zertifikate im angegebenen Zertifikatspeicher und -speicherort. Bei Linux-Computeknoten werden die Zertifikate in einem Verzeichnis im Arbeitsverzeichnis der Aufgabe gespeichert, und eine Umgebungsvariable AZ_BATCH_CERTIFICATES_DIR der Aufgabe bereitgestellt wird, um diesen Speicherort abzufragen. Für Zertifikate mit Sichtbarkeit von "remoteUser" wird ein Verzeichnis "certs" im Startverzeichnis des Benutzers (z. B. /home/{user-name}/certs) erstellt und Zertifikate in diesem Verzeichnis platziert.

Warnung: Diese Eigenschaft ist veraltet und wird nach Februar 2024 entfernt. Verwenden Sie stattdessen die Azure KeyVault-Erweiterung.
properties.creationTime

string

Die Erstellungszeit des Pools.
properties.currentDedicatedNodes

integer

Die Anzahl der dedizierten Computeknoten, die sich derzeit im Pool befinden.
properties.currentLowPriorityNodes

integer

Die Anzahl der Derzeit im Pool befindlichen Computeknoten spot/low-priority.
properties.currentNodeCommunicationMode

NodeCommunicationMode

Der aktuelle Status des Poolkommunikationsmodus.
properties.deploymentConfiguration

DeploymentConfiguration

Diese Eigenschaft beschreibt die virtuellen Computer, auf denen die Poolknoten bereitgestellt werden.
properties.displayName

string

Der Anzeigename für den Pool.
Der Anzeigename muss nicht eindeutig sein und kann alle Unicode-Zeichen bis zu einer maximalen Länge von 1024 enthalten.
properties.interNodeCommunication

InterNodeCommunicationState

Gibt an, ob der Pool die direkte Kommunikation zwischen Knoten zulässt.
Dadurch werden Einschränkungen auferlegt, denen dem Pool Knoten zugewiesen werden können. Durch Aktivieren dieses Werts kann die Wahrscheinlichkeit verringert werden, dass die angeforderte Anzahl von Knoten im Pool zugewiesen werden soll. Wenn nicht angegeben, wird dieser Wert standardmäßig auf "Deaktiviert" festgelegt.
properties.lastModified

string

Der Zeitpunkt der letzten Änderung des Pools.
Dies ist das letzte Mal, zu dem die Daten auf Poolebene geändert wurden, z. B. "targetDedicatedNodes" oder "autoScaleSettings". Es spielt keine Rolle bei Änderungen auf Knotenebene, z. B. beim Ändern des Zustands eines Computeknotens.
properties.metadata

MetadataItem[]

Eine Liste von Name-Wert-Paaren, die dem Pool als Metadaten zugeordnet sind.
Der Batchdienst weist Metadaten keine Bedeutung zu; sie ist ausschließlich für die Verwendung von Benutzercode vorgesehen.
properties.mountConfiguration

MountConfiguration[]

Eine Liste der Dateisysteme, die auf jedem Knoten im Pool bereitgestellt werden sollen.
Dies unterstützt Azure Files, NFS, CIFS/SMB und Blobfuse.
properties.networkConfiguration

NetworkConfiguration

Die Netzwerkkonfiguration für den Pool.
Die Netzwerkkonfiguration für einen Pool.
properties.provisioningState

PoolProvisioningState

Der aktuelle Zustand des Pools.
properties.provisioningStateTransitionTime

string

Die Uhrzeit, zu der der Pool seinen aktuellen Zustand eingegeben hat.
properties.resizeOperationStatus

ResizeOperationStatus

Enthält Details zum aktuellen oder letzten abgeschlossenen Größenänderungsvorgang.
Beschreibt entweder den aktuellen Vorgang (wenn die Größe des Pools "AllocationState" geändert wird) oder den zuvor abgeschlossenen Vorgang (wenn der AllocationState-Wert konstant ist).
properties.resourceTags

object

Die vom Benutzer angegebenen Tags, die dem Pool zugeordnet sind.
Die benutzerdefinierten Tags, die dem Azure-Batchpool zugeordnet werden sollen. Wenn angegeben, werden diese Tags an die zugrunde stehenden Azure-Ressourcen verteilt, die dem Pool zugeordnet sind. Diese Eigenschaft kann nur angegeben werden, wenn das Batchkonto mit der poolAllocationMode-Eigenschaft auf "UserSubscription" festgelegt wurde.
properties.scaleSettings

ScaleSettings

Einstellungen, die die Anzahl der Knoten im Pool konfigurieren.
Definiert die gewünschte Größe des Pools. Dies kann entweder "fixedScale" sein, bei dem die angeforderten targetDedicatedNodes angegeben sind, oder 'autoScale', die eine Formel definiert, die regelmäßig neu ausgewertet wird. Wenn diese Eigenschaft nicht angegeben ist, hat der Pool eine feste Skalierung mit 0 targetDedicatedNodes.
properties.startTask

StartTask

Eine Aufgabe, die für jeden Computeknoten ausgeführt werden soll, während er dem Pool beitritt.
In einem PATCH-Vorgang (Update) kann diese Eigenschaft auf ein leeres Objekt festgelegt werden, um die Startaufgabe aus dem Pool zu entfernen.
properties.targetNodeCommunicationMode

NodeCommunicationMode

Der gewünschte Knotenkommunikationsmodus für den Pool.
Wenn dieser Wert nicht angegeben wird, lautet der Standardwert "Default".
properties.taskSchedulingPolicy

TaskSchedulingPolicy

Wie Aufgaben über Computeknoten in einem Pool verteilt werden.
Wenn nicht angegeben, wird die Standardeinstellung verteilt.
properties.taskSlotsPerNode

integer

1

Die Anzahl der Aufgabenplätze, die zum Ausführen gleichzeitiger Aufgaben auf einem einzelnen Computeknoten im Pool verwendet werden können.
Der Standardwert ist 1. Der Maximalwert ist kleiner als 4 Mal die Anzahl der Kerne der vmSize des Pools oder 256.
properties.upgradePolicy

UpgradePolicy

Die Upgraderichtlinie für den Pool.
Beschreibt eine Upgraderichtlinie – automatisch, manuell oder rolliert.
properties.userAccounts

UserAccount[]

Die Liste der Benutzerkonten, die auf jedem Knoten im Pool erstellt werden sollen.
properties.vmSize

string

Die Größe virtueller Computer im Pool. Alle virtuellen Computer in einem Pool sind die gleiche Größe.
Informationen zu verfügbaren VM-Größen finden Sie unter Größen für virtuelle Computer (Linux) (https://azure.microsoft.com/documentation/articles/virtual-machines-linux-sizes/) oder Größen für virtuelle Computer (Windows) (https://azure.microsoft.com/documentation/articles/virtual-machines-windows-sizes/). Batch unterstützt alle Azure VM-Größen außer STANDARD_A0 und denen mit Premiumspeicher (STANDARD_GS, STANDARD_DS und STANDARD_DSV2 Serie).
tags

object

Die Tags der Ressource.
type

string

Der Typ der Ressource.

PoolEndpointConfiguration

Die Endpunktkonfiguration für einen Pool.

Name Typ Beschreibung
inboundNatPools

InboundNatPool[]

Eine Liste der eingehenden NAT-Pools, die verwendet werden können, um bestimmte Ports auf einem einzelnen Computeknoten extern zu adressieren.
Die maximale Anzahl eingehender NAT-Pools pro Batchpool beträgt 5. Wenn die maximale Anzahl eingehender NAT-Pools überschritten wird, schlägt die Anforderung mit dem HTTP-Statuscode 400 fehl. Dies kann nicht angegeben werden, wenn der IPAddressProvisioningType NoPublicIPAddresses ist.

PoolIdentityType

Der Identitätstyp, der für den Batchpool verwendet wird.

Name Typ Beschreibung
None

string

Dem Batchpool ist keine Identität zugeordnet. Wenn Sie None im Updatepool festlegen, werden vorhandene Identitäten entfernt.
UserAssigned

string

Der Batchpool hat ihm Benutzeridentitäten zugewiesen.

PoolProvisioningState

Der aktuelle Zustand des Pools.

Name Typ Beschreibung
Deleting

string

Der Benutzer hat angefordert, dass der Pool gelöscht wird, der Löschvorgang wurde jedoch noch nicht abgeschlossen.
Succeeded

string

Der Pool steht zur Verfügung, um Aufgaben auszuführen, die der Verfügbarkeit von Computeknoten unterliegen.

PublicIPAddressConfiguration

Die konfiguration der öffentlichen IP-Adresse der Netzwerkkonfiguration eines Pools.

Name Typ Beschreibung
ipAddressIds

string[]

Die Liste der öffentlichen IPs, die der Batchdienst beim Bereitstellen von Computeknoten verwendet.
Die hier angegebene Anzahl von IPs begrenzt die maximale Größe des Pools – 100 dedizierte Knoten oder 100 Spot/Low-Priority-Knoten können für jede öffentliche IP zugewiesen werden. Ein Pool, der 250 dedizierte VMs benötigt, benötigt beispielsweise mindestens 3 öffentliche IPs. Jedes Element dieser Auflistung weist das Format auf: /subscriptions/{subscription}/resourceGroups/{group}/providers/Microsoft.Network/publicIPAddresses/{ip}.
provision

IPAddressProvisioningType

Der Bereitstellungstyp für öffentliche IP-Adressen für den Pool
Der Standardwert ist BatchManaged

ResizeError

Fehler beim Ändern der Größe eines Pools.

Name Typ Beschreibung
code

string

Ein Bezeichner für den Fehler. Codes sind unveränderlich und sollen programmgesteuert genutzt werden.
details

ResizeError[]

Weitere Details zum Fehler.
message

string

Eine Meldung, die den Fehler beschreibt, der für die Anzeige in einer Benutzeroberfläche geeignet ist.

ResizeOperationStatus

Details zum aktuellen oder letzten abgeschlossenen Größenänderungsvorgang.

Name Typ Beschreibung
errors

ResizeError[]

Details zu Fehlern, die beim Ausführen der letzten Größenänderung im Pool aufgetreten sind.
Diese Eigenschaft wird nur festgelegt, wenn während der letzten Poolgröße ein Fehler aufgetreten ist, und nur, wenn der Pool allocationState stabil ist.
nodeDeallocationOption

ComputeNodeDeallocationOption

Bestimmt, was mit einem Knoten und den ausgeführten Aufgaben(en) geschieht, wenn die Poolgröße verringert wird.
Der Standardwert wird erneut abfragt.
resizeTimeout

string

Das Timeout für die Zuordnung von Computeknoten an den Pool oder das Entfernen von Computeknoten aus dem Pool.
Der Standardwert beträgt 15 Minuten. Der Mindestwert beträgt 5 Minuten. Wenn Sie einen Wert kleiner als 5 Minuten angeben, gibt der Batchdienst einen Fehler zurück. wenn Sie die REST-API direkt aufrufen, lautet der HTTP-Statuscode 400 (Ungültige Anforderung).
startTime

string

Der Zeitpunkt, zu dem dieser Größenänderungsvorgang gestartet wurde.
targetDedicatedNodes

integer

Die gewünschte Anzahl dedizierter Computeknoten im Pool.
targetLowPriorityNodes

integer

Die gewünschte Anzahl von Spot-/Low-Priority-Computeknoten im Pool.

ResourceFile

Eine einzelne Datei oder mehrere Dateien, die auf einen Computeknoten heruntergeladen werden sollen.

Name Typ Beschreibung
autoStorageContainerName

string

Der Name des Speichercontainers im automatischen Speicherkonto.
Die Eigenschaften autoStorageContainerName, storageContainerUrl und httpUrl schließen sich gegenseitig aus, und eine davon muss angegeben werden.
blobPrefix

string

Das Blobpräfix, das beim Herunterladen von Blobs aus einem Azure Storage-Container verwendet werden soll. Nur die Blobs, deren Namen mit dem angegebenen Präfix beginnen, werden heruntergeladen.
Die Eigenschaft ist nur gültig, wenn autoStorageContainerName oder storageContainerUrl verwendet wird. Dieses Präfix kann ein teilweiser Dateiname oder ein Unterverzeichnis sein. Wenn kein Präfix angegeben ist, werden alle Dateien im Container heruntergeladen.
fileMode

string

Das Attribut für den Dateiberechtigungsmodus im oktalen Format.
Diese Eigenschaft gilt nur für Dateien, die auf Linux-Computeknoten heruntergeladen werden. Sie wird ignoriert, wenn sie für eine resourceFile angegeben wird, die auf einen Windows-Knoten heruntergeladen wird. Wenn diese Eigenschaft für einen Linux-Knoten nicht angegeben ist, wird auf die Datei ein Standardwert von 0770 angewendet.
filePath

string

Der Speicherort auf dem Computeknoten, in den die Datei heruntergeladen werden soll, relativ zum Arbeitsverzeichnis der Aufgabe.
Wenn die httpUrl-Eigenschaft angegeben ist, ist der FilePath erforderlich und beschreibt den Pfad, in den die Datei heruntergeladen wird, einschließlich des Dateinamens. Andernfalls ist filePath optional, wenn die autoStorageContainerName- oder storageContainerUrl-Eigenschaft angegeben ist, und das Verzeichnis, in das die Dateien heruntergeladen werden sollen. Wenn FilePath als Verzeichnis verwendet wird, werden alle bereits den Eingabedaten zugeordneten Verzeichnisstruktur vollständig aufbewahrt und an das angegebene FilePath-Verzeichnis angefügt. Der angegebene relative Pfad kann nicht aus dem Arbeitsverzeichnis des Vorgangs (z. B. mit '.') herausbrechen.
httpUrl

string

Die URL der herunterzuladenden Datei.
Die Eigenschaften autoStorageContainerName, storageContainerUrl und httpUrl schließen sich gegenseitig aus, und eine davon muss angegeben werden. Wenn die URL auf Azure Blob Storage verweist, muss sie von Computeknoten gelesen werden. Es gibt drei Möglichkeiten, eine solche URL für ein Blob im Azure-Speicher abzurufen: Fügen Sie eine SAS (Shared Access Signature) hinzu, die Leseberechtigungen für das Blob gewährt, eine verwaltete Identität mit Leseberechtigung verwenden oder die ACL für das Blob oder dessen Container so festlegen, dass der öffentliche Zugriff zulässig ist.
identityReference

ComputeNodeIdentityReference

Der Verweis auf die vom Benutzer zugewiesene Identität für den Zugriff auf Azure Blob Storage, der durch "storageContainerUrl" oder "httpUrl" angegeben wird
Der Verweis auf eine vom Benutzer zugewiesene Identität, die dem Batchpool zugeordnet ist, den ein Computeknoten verwendet.
storageContainerUrl

string

Die URL des Blobcontainers in Azure Blob Storage.
Die Eigenschaften autoStorageContainerName, storageContainerUrl und httpUrl schließen sich gegenseitig aus, und eine davon muss angegeben werden. Diese URL muss von Computeknoten lesbar und auflistenbar sein. Es gibt drei Möglichkeiten, eine solche URL für einen Container in Azure Storage abzurufen: Fügen Sie eine SAS (Shared Access Signature) hinzu, die Lese- und Listenberechtigungen für den Container gewährt, eine verwaltete Identität mit Lese- und Listenberechtigungen verwenden oder die ACL für den Container so festlegen, dass der öffentliche Zugriff zugelassen wird.

RollingUpgradePolicy

Die Konfigurationsparameter, die beim Ausführen eines rollierenden Upgrades verwendet werden.

Name Typ Beschreibung
enableCrossZoneUpgrade

boolean

Zulassen, dass VMSS AZ-Grenzen beim Erstellen von Upgradebatches ignoriert. Berücksichtigen Sie die Updatedomäne und maxBatchInstancePercent, um die Batchgröße zu ermitteln. Wenn dieses Feld nicht festgelegt ist, legt Azure Batch den Standardwert nicht fest. Der Wert von enableCrossZoneUpgrade für das erstellte VirtualMachineScaleSet wird durch die Standardkonfigurationen auf VirtualMachineScaleSet entschieden. Dieses Feld kann nur bei Verwendung von NodePlacementConfiguration als Zonal auf "true" oder "false" festgelegt werden.
maxBatchInstancePercent

integer

Der maximale Prozentsatz der gesamten Instanzen des virtuellen Computers, die gleichzeitig durch das rollierende Upgrade in einem Batch aktualisiert werden. Da dies ein Maximum ist, können fehlerhafte Instanzen in früheren oder zukünftigen Batches dazu führen, dass der Prozentsatz der Instanzen in einem Batch verringert wird, um eine höhere Zuverlässigkeit sicherzustellen. Der Wert dieses Felds sollte zwischen 5 und 100 (einschließlich) liegen. Wenn "maxBatchInstancePercent" und "maxUnhealthyInstancePercent" mit dem Wert zugewiesen sind, sollte der Wert von "maxBatchInstancePercent" nicht größer als "maxUnhealthyInstancePercent" sein.
maxUnhealthyInstancePercent

integer

Der maximale Prozentsatz der Instanzen des virtuellen Computers im Skalierungssatz, der gleichzeitig fehlerhaft sein kann, entweder aufgrund eines Upgrades oder durch die Integritätsprüfungen des virtuellen Computers in einem fehlerhaften Zustand gefunden wird, bevor das Rollupgrade abgebrochen wird. Diese Einschränkung wird vor dem Starten eines Batches überprüft. Der Wert dieses Felds sollte zwischen 5 und 100 (einschließlich) liegen. Wenn "maxBatchInstancePercent" und "maxUnhealthyInstancePercent" mit dem Wert zugewiesen sind, sollte der Wert von "maxBatchInstancePercent" nicht größer als "maxUnhealthyInstancePercent" sein.
maxUnhealthyUpgradedInstancePercent

integer

Der maximale Prozentsatz der aktualisierten Virtuellen Computerinstanzen, die sich in einem fehlerhaften Zustand befinden. Diese Überprüfung erfolgt, nachdem jeder Batch aktualisiert wurde. Wenn dieser Prozentsatz jemals überschritten wird, wird das rollierende Update abgebrochen. Der Wert dieses Felds sollte zwischen 0 und 100 (einschließlich) liegen.
pauseTimeBetweenBatches

string

Die Wartezeit zwischen Abschluss des Updates für alle virtuellen Computer in einem Batch und starten den nächsten Batch. Die Zeitdauer sollte im ISO 8601-Format angegeben werden.
prioritizeUnhealthyInstances

boolean

Aktualisieren Sie alle fehlerhaften Instanzen in einem Skalierungssatz, bevor alle fehlerfreien Instanzen auftreten.
rollbackFailedInstancesOnPolicyBreach

boolean

Fehler bei Rollbackinstanzen beim vorherigen Modell, wenn die Richtlinie für das Rollupgrade verletzt wird.

ScaleSettings

Skalierungseinstellungen für den Pool

Name Typ Beschreibung
autoScale

AutoScaleSettings

AutoScale-Einstellungen für den Pool.
Diese Eigenschaft und fixedScale schließen sich gegenseitig aus, und eine der Eigenschaften muss angegeben werden.
fixedScale

FixedScaleSettings

Feste Skalierungseinstellungen für den Pool.
Diese Eigenschaft und autoScale schließen sich gegenseitig aus, und eine der Eigenschaften muss angegeben werden.

SecurityEncryptionTypes

Gibt den EncryptionType des verwalteten Datenträgers an. Sie ist für die Verschlüsselung nur des VMGuestState-Blobs auf "VMGuestStateOnly" und "NonPersistedTPM" festgelegt, damit der Firmwarestatus im VMGuestState-Blob nicht beibehalten wird. Hinweis: Sie kann nur für vertrauliche VMs festgelegt werden und ist bei Verwendung vertraulicher VMs erforderlich.

Name Typ Beschreibung
NonPersistedTPM

string

VMGuestStateOnly

string

SecurityProfile

Gibt die Sicherheitsprofileinstellungen für den virtuellen Computer oder die Skalierungsgruppe des virtuellen Computers an.

Name Typ Beschreibung
encryptionAtHost

boolean

Diese Eigenschaft kann vom Benutzer in der Anforderung verwendet werden, um die Hostverschlüsselung für den virtuellen Computer oder die Skalierungsgruppe des virtuellen Computers zu aktivieren oder zu deaktivieren. Dadurch wird die Verschlüsselung für alle Datenträger einschließlich Ressourcen-/Temp-Datenträger auf dem Host selbst aktiviert.
securityType

SecurityTypes

Gibt den SecurityType des virtuellen Computers an. Sie muss auf einen beliebigen angegebenen Wert festgelegt werden, um UefiSettings zu aktivieren.
uefiSettings

UefiSettings

Gibt die Sicherheitseinstellungen wie sicherer Start und vTPM an, die beim Erstellen des virtuellen Computers verwendet werden.
Gibt die Sicherheitseinstellungen wie sicherer Start und vTPM an, die beim Erstellen des virtuellen Computers verwendet werden.

SecurityTypes

Gibt den SecurityType des virtuellen Computers an. Sie muss auf einen beliebigen angegebenen Wert festgelegt werden, um UefiSettings zu aktivieren.

Name Typ Beschreibung
confidentialVM

string

Azure Vertraulich Computing bietet vertrauliche VMs für Mandanten mit hohen Sicherheits- und Vertraulichkeitsanforderungen. Diese virtuellen Computer bieten eine starke, hardwaregezwungene Grenze, um Ihre Sicherheitsanforderungen zu erfüllen. Sie können vertrauliche VMs für Migrationen verwenden, ohne Änderungen an Ihrem Code vorzunehmen, wobei die Plattform, die den Status Ihrer VM schützt, nicht gelesen oder geändert wird.
trustedLaunch

string

Der vertrauenswürdige Start schützt vor erweiterten und beständigen Angriffstechniken.

ServiceArtifactReference

Gibt die Dienstartefaktereferenz-ID an, die zum Festlegen derselben Imageversion für alle virtuellen Computer im Skalierungssatz bei Verwendung der neuesten Imageversion verwendet wird.

Name Typ Beschreibung
id

string

Die Dienstartefaktereferenz-ID von ServiceArtifactReference
Die Dienstartefaktereferenz-ID in Form von /subscriptions/{subscriptionId}/resourceGroups/{resourceGroup}/providers/Microsoft.Compute/gallerys/{galleryName}/serviceArtifacts/{serviceArtifactName}/vmArtifactsProfiles/{vmArtifactsProfilesName}

StartTask

Eine Aufgabe, die ausgeführt wird, wenn ein Computeknoten einem Pool im Azure Batch-Dienst beitritt oder wenn der Computeknoten neu gestartet oder umimages erstellt wird.

Name Typ Standardwert Beschreibung
commandLine

string

Die Befehlszeile der Startaufgabe.
Die Befehlszeile wird nicht unter einer Shell ausgeführt und kann daher nicht von Shellfeatures wie der Erweiterung der Umgebungsvariablen profitieren. Wenn Sie diese Features nutzen möchten, sollten Sie die Shell in der Befehlszeile aufrufen, z. B. mit "cmd /c MyCommand" in Windows oder "/bin/sh -c MyCommand" in Linux. Erforderlich, wenn andere Eigenschaften des startTask angegeben werden.
containerSettings

TaskContainerSettings

Die Einstellungen für den Container, unter dem die Startaufgabe ausgeführt wird.
Wenn dies angegeben wird, werden alle Verzeichnisse rekursiv unterhalb der AZ_BATCH_NODE_ROOT_DIR (der Stamm von Azure Batchverzeichnissen auf dem Knoten) dem Container zugeordnet, alle Aufgabenumgebungsvariablen werden dem Container zugeordnet, und die Aufgabenbefehlszeile wird im Container ausgeführt.
environmentSettings

EnvironmentSetting[]

Eine Liste der Umgebungsvariableneinstellungen für die Startaufgabe.
maxTaskRetryCount

integer

0

Die maximale Anzahl der Wiederholungsversuche des Vorgangs.
Der Batchdienst ruft eine Aufgabe erneut auf, wenn der Beendigungscode nicht null ist. Beachten Sie, dass dieser Wert speziell die Anzahl der Wiederholungen steuert. Der Batchdienst versucht die Aufgabe einmal und kann dann bis zu diesem Grenzwert erneut versuchen. Wenn beispielsweise die maximale Wiederholungsanzahl 3 ist, versucht Batch den Vorgang bis zu 4 Mal (ein erster Versuch und 3 Wiederholungsversuche). Wenn die maximale Wiederholungsanzahl 0 ist, führt der Batchdienst den Vorgang nicht erneut aus. Wenn die maximale Wiederholungsanzahl -1 ist, wiederholt der Batchdienst den Vorgang ohne Beschränkung. Der Standardwert ist 0.
resourceFiles

ResourceFile[]

Eine Liste der Dateien, die der Batchdienst vor dem Ausführen der Befehlszeile auf den Computeknoten herunterladen wird.
userIdentity

UserIdentity

Die Benutzeridentität, unter der die Startaufgabe ausgeführt wird.
Wenn sie weggelassen wird, wird die Aufgabe als nicht administrativer Benutzer ausgeführt, der für die Aufgabe eindeutig ist.
waitForSuccess

boolean

Gibt an, ob der Batchdienst warten soll, bis die Startaufgabe erfolgreich abgeschlossen wurde (d. h. zum Beenden mit Beendigungscode 0), bevor Vorgänge auf dem Computeknoten geplant werden.
Wenn true und die Startaufgabe auf einem Computeknoten fehlschlägt, wiederholt der Batchdienst die Startaufgabe bis zur maximalen Wiederholungsanzahl (maxTaskRetryCount). Wenn der Vorgang nach allen Wiederholungen noch nicht erfolgreich abgeschlossen wurde, markiert der Batchdienst den Computeknoten nicht mehr verwendbar, und er plant keine Vorgänge. Diese Bedingung kann über den Knotenstatus und das Planungsfehlerdetails erkannt werden. Wenn false, wartet der Batchdienst nicht, bis die Startaufgabe abgeschlossen ist. In diesem Fall können andere Aufgaben mit der Ausführung auf dem Computeknoten beginnen, während die Startaufgabe noch ausgeführt wird. und auch wenn der Startvorgang fehlschlägt, werden neue Vorgänge weiterhin auf dem Knoten geplant. Der Standardwert ist "true".

StorageAccountType

Der Speicherkontotyp zum Erstellen von Datenträgern oder Betriebssystemdatenträgern.

Name Typ Beschreibung
Premium_LRS

string

Der Datenträger/Betriebssystemdatenträger sollte einen lokal redundanten Premiumspeicher verwenden.
StandardSSD_LRS

string

Der Datenträger/Betriebssystemdatenträger sollte standardmäßigen SSD lokal redundanten Speicher verwenden.
Standard_LRS

string

Der Datenträger/Betriebssystemdatenträger sollte standardmäßigen lokal redundanten Speicher verwenden.

TaskContainerSettings

Die Containereinstellungen für eine Aufgabe.

Name Typ Beschreibung
containerHostBatchBindMounts

ContainerHostBatchBindMountEntry[]

Die Pfade, die Sie an containeraufgaben bereitstellen möchten.
Wenn dieses Array null ist oder nicht vorhanden ist, stellt die Containeraufgabe das gesamte temporäre Laufwerk in Windows (oder AZ_BATCH_NODE_ROOT_DIR in Linux) ein. Es werden keine Datenpfade in Container bereitgestellt, wenn dieses Array als leer festgelegt ist.
containerRunOptions

string

Zusätzliche Optionen für den Befehl "Container erstellen".
Diese zusätzlichen Optionen werden zusätzlich zu den vom Batchdienst gesteuerten Befehlen als Argumente für den Befehl "docker create" bereitgestellt.
imageName

string

Das Zum Erstellen des Containers zu verwendende Image, in dem die Aufgabe ausgeführt wird.
Dies ist der vollständige Imageverweis, wie für "Docker Pull" angegeben. Wenn kein Tag als Teil des Bildnamens angegeben wird, wird das Tag ":latest" als Standard verwendet.
registry

ContainerRegistry

Die private Registrierung, die das Containerimage enthält.
Diese Einstellung kann weggelassen werden, wenn sie bereits bei der Poolerstellung bereitgestellt wurde.
workingDirectory

ContainerWorkingDirectory

Ein Kennzeichen, das angibt, wo sich das Arbeitsverzeichnis der Containeraufgabe befindet. Der Standardwert ist "taskWorkingDirectory".

TaskSchedulingPolicy

Gibt an, wie Aufgaben über Computeknoten verteilt werden sollen.

Name Typ Standardwert Beschreibung
nodeFillType

ComputeNodeFillType

Spread

Wie Aufgaben über Computeknoten verteilt werden sollen.

UefiSettings

Gibt die Sicherheitseinstellungen wie sicherer Start und vTPM an, die beim Erstellen des virtuellen Computers verwendet werden.

Name Typ Beschreibung
secureBootEnabled

boolean

Gibt an, ob der sichere Start auf dem virtuellen Computer aktiviert werden soll.
vTpmEnabled

boolean

Gibt an, ob vTPM auf dem virtuellen Computer aktiviert werden soll.

UpgradeMode

Gibt den Modus eines Upgrades auf virtuelle Computer im Skalierungssatz an.

Mögliche Werte sind:

manuelle – Sie steuern die Anwendung von Updates auf virtuelle Computer im Skalierungssatz. Dazu verwenden Sie die ManualUpgrade-Aktion.

Automatische – Alle virtuellen Computer im Skalierungssatz werden automatisch gleichzeitig aktualisiert.

Roll- – Skalierungssatz führt Aktualisierungen in Batches mit einer optionalen Pausenzeit dazwischen durch.

Name Typ Beschreibung
automatic

string

Alle virtuellen Computer im Skalierungssatz werden automatisch gleichzeitig aktualisiert.
manual

string

Sie steuern die Anwendung von Updates auf virtuelle Computer im Skalierungssatz. Dazu verwenden Sie die ManualUpgrade-Aktion.
rolling

string

Die vorhandenen Instanzen in einem Skalierungssatz werden in Batches heruntergesetzt, um aktualisiert zu werden. Sobald der aktualisierte Batch abgeschlossen ist, beginnen die Instanzen erneut mit dem Datenverkehr, und der nächste Batch beginnt. Dies wird fortgesetzt, bis alle Instanzen up-to-date gebracht wurden.

UpgradePolicy

Beschreibt eine Upgraderichtlinie – automatisch, manuell oder rolliert.

Name Typ Beschreibung
automaticOSUpgradePolicy

AutomaticOSUpgradePolicy

Konfigurationsparameter, die zum Ausführen des automatischen Betriebssystemupgrades verwendet werden.
Die Konfigurationsparameter, die zum Ausführen eines automatischen Betriebssystemupgrades verwendet werden.
mode

UpgradeMode

Gibt den Modus eines Upgrades auf virtuelle Computer im Skalierungssatz an.

Mögliche Werte sind:

manuelle – Sie steuern die Anwendung von Updates auf virtuelle Computer im Skalierungssatz. Dazu verwenden Sie die ManualUpgrade-Aktion.

Automatische – Alle virtuellen Computer im Skalierungssatz werden automatisch gleichzeitig aktualisiert.

Roll- – Skalierungssatz führt Aktualisierungen in Batches mit einer optionalen Pausenzeit dazwischen durch.
rollingUpgradePolicy

RollingUpgradePolicy

Die Konfigurationsparameter, die beim Ausführen eines rollierenden Upgrades verwendet werden.
Die Konfigurationsparameter, die beim Ausführen eines rollierenden Upgrades verwendet werden.

UserAccount

Eigenschaften, die zum Erstellen eines Benutzers auf einem Azure Batch-Knoten verwendet werden.

Name Typ Beschreibung
elevationLevel

ElevationLevel

Die Höhe des Benutzerkontos.
nonAdmin – Der automatische Benutzer ist ein Standardbenutzer ohne erhöhten Zugriff. admin – Der automatische Benutzer ist ein Benutzer mit erhöhtem Zugriff und arbeitet mit vollständigen Administratorberechtigungen. Der Standardwert ist "nonAdmin".
linuxUserConfiguration

LinuxUserConfiguration

Die Linux-spezifische Benutzerkonfiguration für das Benutzerkonto.
Diese Eigenschaft wird ignoriert, wenn sie in einem Windows-Pool angegeben ist. Wenn nicht angegeben, wird der Benutzer mit den Standardoptionen erstellt.
name

string

Der Name des Benutzerkontos. Namen können bis zu einer maximalen Länge von 20 Unicode-Zeichen enthalten.
password

string

Das Kennwort für das Benutzerkonto.
windowsUserConfiguration

WindowsUserConfiguration

Die Windows-spezifische Benutzerkonfiguration für das Benutzerkonto.
Diese Eigenschaft kann nur angegeben werden, wenn sich der Benutzer in einem Windows-Pool befindet. Wenn nicht angegeben und in einem Windows-Pool, wird der Benutzer mit den Standardoptionen erstellt.

UserAssignedIdentities

Die Liste der zugeordneten Benutzeridentitäten.

Name Typ Beschreibung
clientId

string

Die Client-ID der vom Benutzer zugewiesenen Identität.
principalId

string

Die Prinzipal-ID der vom Benutzer zugewiesenen Identität.

UserIdentity

Die Definition der Benutzeridentität, unter der die Aufgabe ausgeführt wird.

Name Typ Beschreibung
autoUser

AutoUserSpecification

Der automatische Benutzer, unter dem die Aufgabe ausgeführt wird.
Die Eigenschaften "userName" und "autoUser" schließen sich gegenseitig aus; Sie müssen einen, aber nicht beide angeben.
userName

string

Der Name der Benutzeridentität, unter der die Aufgabe ausgeführt wird.
Die Eigenschaften "userName" und "autoUser" schließen sich gegenseitig aus; Sie müssen einen, aber nicht beide angeben.

VirtualMachineConfiguration

Die Konfiguration für Computeknoten in einem Pool basierend auf der Azure Virtual Machines-Infrastruktur.

Name Typ Beschreibung
containerConfiguration

ContainerConfiguration

Die Containerkonfiguration für den Pool.
Wenn angegeben, wird das Setup für jeden Knoten im Pool ausgeführt, damit Aufgaben in Containern ausgeführt werden können. Alle regulären Aufgaben und Auftragsverwaltungsaufgaben, die auf diesem Pool ausgeführt werden, müssen die eigenschaft containerSettings angeben, und alle anderen Aufgaben können sie angeben.
dataDisks

DataDisk[]

Die Konfiguration für Datenträger, die an die Computeknoten im Pool angefügt sind.
Diese Eigenschaft muss angegeben werden, wenn die Computeknoten im Pool über leere Datenträger verfügen müssen, die an sie angefügt sind.
diskEncryptionConfiguration

DiskEncryptionConfiguration

Die Datenträgerverschlüsselungskonfiguration für den Pool.
Wenn angegeben, wird die Verschlüsselung für jeden Knoten im Pool während der Knotenbereitstellung ausgeführt.
extensions

VMExtension[]

Die Erweiterung des virtuellen Computers für den Pool.
Wenn angegeben, werden die in dieser Konfiguration genannten Erweiterungen auf jedem Knoten installiert.
imageReference

ImageReference

Ein Verweis auf das Azure Virtual Machines Marketplace-Image oder das zu verwendende benutzerdefinierte Virtuelle Computerimage.
licenseType

string

Der Typ der lokalen Lizenz, die beim Bereitstellen des Betriebssystems verwendet werden soll.
Dies gilt nur für Images, die das Windows-Betriebssystem enthalten, und sollte nur verwendet werden, wenn Sie gültige lokale Lizenzen für die Knoten halten, die bereitgestellt werden. Ohne Angabe wird kein lokaler Lizenzierungsrabatt angewendet. Werte sind:

Windows_Server – Die lokale Lizenz gilt für Windows Server. Windows_Client – Die lokale Lizenz ist für Windows Client.
nodeAgentSkuId

string

Die SKU des Batchknoten-Agents, der auf Computeknoten im Pool bereitgestellt werden soll.
Der Batchknoten-Agent ist ein Programm, das auf jedem Knoten im Pool ausgeführt wird und die Befehls- und Steuerungsschnittstelle zwischen dem Knoten und dem Batchdienst bereitstellt. Es gibt unterschiedliche Implementierungen des Knoten-Agents, die als SKUs bezeichnet werden, für verschiedene Betriebssysteme. Sie müssen eine Knoten-Agent-SKU angeben, die dem ausgewählten Imageverweis entspricht. Informationen zum Abrufen der Liste der unterstützten Knoten-Agent-SKUs sowie deren Liste der überprüften Bildverweise finden Sie im Vorgang "Auflisten unterstützter Knoten-Agent-SKUs".
nodePlacementConfiguration

NodePlacementConfiguration

Die Knotenplatzierungskonfiguration für den Pool.
Diese Konfiguration gibt Regeln für die physische Zuordnung von Knoten im Pool an.
osDisk

OSDisk

Einstellungen für den Betriebssystemdatenträger des virtuellen Computers.
Enthält die Konfiguration für kurzlebige OSDisk-Einstellungen.
securityProfile

SecurityProfile

Gibt die Sicherheitsprofileinstellungen für den virtuellen Computer oder die Skalierungsgruppe des virtuellen Computers an.
Gibt die Sicherheitsprofileinstellungen für den virtuellen Computer oder die Skalierungsgruppe des virtuellen Computers an.
serviceArtifactReference

ServiceArtifactReference

Gibt die Dienstartefaktereferenz-ID an, die zum Festlegen derselben Imageversion für alle virtuellen Computer im Skalierungssatz bei Verwendung der neuesten Imageversion verwendet wird.
Die Dienstartefaktereferenz-ID in Form von /subscriptions/{subscriptionId}/resourceGroups/{resourceGroup}/providers/Microsoft.Compute/gallerys/{galleryName}/serviceArtifacts/{serviceArtifactName}/vmArtifactsProfiles/{vmArtifactsProfilesName}
windowsConfiguration

WindowsConfiguration

Windows-Betriebssystemeinstellungen auf dem virtuellen Computer.
Diese Eigenschaft darf nicht angegeben werden, wenn das imageReference ein Linux-Betriebssystemimage angibt.

VMDiskSecurityProfile

Gibt die Sicherheitsprofileinstellungen für den verwalteten Datenträger an. Hinweis: Sie kann nur für vertrauliche VMs festgelegt werden und ist bei Verwendung vertraulicher VMs erforderlich.

Name Typ Beschreibung
securityEncryptionType

SecurityEncryptionTypes

Gibt den EncryptionType des verwalteten Datenträgers an. Sie ist für die Verschlüsselung nur des VMGuestState-Blobs auf "VMGuestStateOnly" und "NonPersistedTPM" festgelegt, damit der Firmwarestatus im VMGuestState-Blob nicht beibehalten wird. Hinweis: Sie kann nur für vertrauliche VMs festgelegt werden und ist bei Verwendung vertraulicher VMs erforderlich.

VMExtension

Die Konfiguration für Erweiterungen virtueller Computer.

Name Typ Beschreibung
autoUpgradeMinorVersion

boolean

Gibt an, ob die Erweiterung eine neuere Nebenversion verwenden soll, wenn sie zur Bereitstellungszeit verfügbar ist. Nach der Bereitstellung aktualisiert die Erweiterung jedoch keine Nebenversionen, es sei denn, sie werden erneut bereitgestellt, auch wenn diese Eigenschaft auf "true" festgelegt ist.
enableAutomaticUpgrade

boolean

Gibt an, ob die Erweiterung automatisch von der Plattform aktualisiert werden soll, wenn eine neuere Version der Erweiterung verfügbar ist.
name

string

Der Name der Erweiterung des virtuellen Computers.
protectedSettings

object

Die Erweiterung kann entweder protectedSettings oder protectedSettingsFromKeyVault oder gar keine geschützten Einstellungen enthalten.
provisionAfterExtensions

string[]

Die Sammlung von Erweiterungsnamen.
Sammlung von Erweiterungsnamen, nach denen diese Erweiterung bereitgestellt werden muss.
publisher

string

Der Name des Herausgebers des Erweiterungshandlers.
settings

object

JSON-formatierte öffentliche Einstellungen für die Erweiterung.
type

string

Der Typ der Erweiterungen.
typeHandlerVersion

string

Die Version des Skripthandlers.

WindowsConfiguration

Windows-Betriebssystemeinstellungen, die auf den virtuellen Computer angewendet werden sollen.

Name Typ Beschreibung
enableAutomaticUpdates

boolean

Gibt an, ob automatische Updates auf dem virtuellen Computer aktiviert sind.
Wenn dieser Wert nicht angegeben wird, ist der Standardwert "true".

WindowsUserConfiguration

Eigenschaften, die zum Erstellen eines Benutzerkontos auf einem Windows-Knoten verwendet werden.

Name Typ Beschreibung
loginMode

LoginMode

Anmeldemodus für Benutzer
Gibt den Anmeldemodus für den Benutzer an. Der Standardwert ist Interactive.