Pool - Create

Tjänst:

Batch Management

API-versionen:

2025-06-01

Skapar en ny pool i det angivna kontot.

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

URI-parametrar

Namn	I	Krävs	Typ	Beskrivning
accountName	path	True	string minLength: 3 maxLength: 24 pattern: ^[a-zA-Z0-9]+$	Ett namn för batchkontot som måste vara unikt inom regionen. Batchkontonamn måste vara mellan 3 och 24 tecken långa och endast använda siffror och gemener. Detta namn används som en del av DNS-namnet som används för att komma åt Batch-tjänsten i den region där kontot skapas. Till exempel: http://accountname.region.batch.azure.com/.
poolName	path	True	string minLength: 1 maxLength: 64 pattern: ^[a-zA-Z0-9_-]+$	Poolnamnet. Detta måste vara unikt i kontot.
resourceGroupName	path	True	string minLength: 1 maxLength: 90	Namnet på resursgruppen. Namnet är skiftlägesokänsligt.
subscriptionId	path	True	string (uuid)	ID för målprenumerationen. Värdet måste vara ett UUID.
api-version	query	True	string minLength: 1	Den API-version som ska användas för den här åtgärden.

Begäran-huvud

Namn	Krävs	Typ	Beskrivning
If-Match		string	Den entitetstillståndsversion (ETag) av poolen som ska uppdateras. Värdet "*" kan endast användas för att tillämpa åtgärden om poolen redan finns. Om den utelämnas tillämpas alltid den här åtgärden.
If-None-Match		string	Ange till *för att tillåta att en ny pool skapas, men för att förhindra uppdatering av en befintlig pool. Andra värden ignoreras.

Begäranarorgan

Namn	Typ	Beskrivning
identity	BatchPoolIdentity	Den typ av identitet som används för Batch-poolen.
properties.applicationPackages	ApplicationPackageReference[]	Listan över programpaket som ska installeras på varje beräkningsnod i poolen. Ändringar i programpaketreferenser påverkar alla nya beräkningsnoder som ansluter till poolen, men påverkar inte beräkningsnoder som redan finns i poolen förrän de startas om eller omskapas. Det finns högst 10 programpaketreferenser i en viss pool.
properties.deploymentConfiguration	DeploymentConfiguration	Den här egenskapen beskriver de virtuella datorer som poolnoderna ska distribueras på. Egenskaper för distributionskonfiguration.
properties.displayName	string	Visningsnamnet för poolen. Visningsnamnet behöver inte vara unikt och kan innehålla unicode-tecken upp till en maximal längd på 1024.
properties.interNodeCommunication	InterNodeCommunicationState	Om poolen tillåter direkt kommunikation mellan noder. Detta medför begränsningar för vilka noder som kan tilldelas till poolen. Om du aktiverar det här värdet kan du minska risken för att det begärda antalet noder allokeras i poolen. Om det inte anges är det här värdet som standard inaktiverat.
properties.metadata	MetadataItem[]	En lista över namn/värde-par som är associerade med poolen som metadata. Batch-tjänsten tilldelar ingen betydelse för metadata. det är endast för användning av användarkod.
properties.mountConfiguration	MountConfiguration[]	En lista över filsystem som ska monteras på varje nod i poolen. Detta stöder Azure Files, NFS, CIFS/SMB och Blobfuse.
properties.networkConfiguration	NetworkConfiguration	Nätverkskonfigurationen för poolen. Nätverkskonfigurationen för en pool.
properties.scaleSettings	ScaleSettings	Inställningar som konfigurerar antalet noder i poolen. Definierar poolens önskade storlek. Detta kan antingen vara "fixedScale" där det begärda targetDedicatedNodes har angetts, eller "autoskala" som definierar en formel som regelbundet omvärderas. Om den här egenskapen inte anges har poolen en fast skalning med 0 targetDedicatedNodes.
properties.startTask	StartTask	En uppgift som har angetts för att köras på varje beräkningsnod när den ansluter till poolen. I en PATCH-åtgärd (uppdatering) kan den här egenskapen anges till ett tomt objekt för att ta bort startaktiviteten från poolen.
properties.taskSchedulingPolicy	TaskSchedulingPolicy	Hur aktiviteter distribueras mellan beräkningsnoder i en pool. Om det inte anges är standardvärdet utspritt.
properties.taskSlotsPerNode	integer (int32)	Antalet aktivitetsfack som kan användas för att köra samtidiga uppgifter på en enda beräkningsnod i poolen. Standardvärdet är 1. Det maximala värdet är mindre än 4 gånger antalet kärnor i vmSize för poolen eller 256.
properties.upgradePolicy	UpgradePolicy	Uppgraderingsprincipen för poolen. Beskriver en uppgraderingsprincip – automatisk, manuell eller rullande.
properties.userAccounts	UserAccount[]	Listan över användarkonton som ska skapas på varje nod i poolen. Listan över användarkonton som ska skapas på varje nod i poolen.
properties.vmSize	string	Storleken på virtuella datorer i poolen. Alla virtuella datorer i en pool har samma storlek. Information om tillgängliga VM-storlekar finns i Storlekar för virtuella datorer i Azure (https://learn.microsoft.com/azure/virtual-machines/sizes/overview). Batch har stöd för alla storlekar på virtuella Azure-datorer förutom STANDARD_A0 och de med premiumlagring (STANDARD_GS, STANDARD_DS och STANDARD_DSV2-serien).
tags	object	Taggarna för resursen.

Svaren

Namn	Typ	Beskrivning
200 OK	Pool	Begäran har slutförts. Headers ETag: string
Other Status Codes	CloudError	Ett oväntat felsvar.

Säkerhet

azure_auth

Azure Active Directory OAuth2-flöde.

Typ: oauth2
Rinna: implicit
Auktorisations-URL: https://login.microsoftonline.com/common/oauth2/authorize

Scope

Namn	Beskrivning
user_impersonation	personifiera ditt användarkonto

Exempel

CreatePool - accelerated networking

CreatePool - confidential disk encryption set for user subscription accounts

CreatePool - Custom Image

CreatePool - customer managed key for Batch managed accounts

CreatePool - disk encryption set for user subscription accounts

CreatePool - dual stack networking

CreatePool - Full VirtualMachineConfiguration

CreatePool - Minimal VirtualMachineConfiguration

CreatePool - No public IP

CreatePool - Public IPs

CreatePool - SecurityProfile

CreatePool - Tags

CreatePool - UpgradePolicy

CreatePool - UserAssignedIdentities

CreatePool - VirtualMachineConfiguration Extensions

CreatePool - VirtualMachineConfiguration OSDisk

CreatePool - VirtualMachineConfiguration ServiceArtifactReference

CreatePool - accelerated networking

Exempelförfrågan

HTTP

PUT https://management.azure.com/subscriptions/12345678-1234-1234-1234-123456789012/resourceGroups/default-azurebatch-japaneast/providers/Microsoft.Batch/batchAccounts/sampleacct/pools/testpool?api-version=2025-06-01

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

Exempelsvar

Statuskod:

200

ETag: W/"0x8DB46CB72A227E2"

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

CreatePool - confidential disk encryption set for user subscription accounts

Exempelförfrågan

HTTP

PUT https://management.azure.com/subscriptions/12345678-1234-1234-1234-123456789012/resourceGroups/default-azurebatch-japaneast/providers/Microsoft.Batch/batchAccounts/sampleacct/pools/testpool?api-version=2025-06-01

{
  "properties": {
    "vmSize": "Standard_DC2as_v5",
    "taskSchedulingPolicy": {
      "nodeFillType": "Pack"
    },
    "deploymentConfiguration": {
      "virtualMachineConfiguration": {
        "imageReference": {
          "publisher": "MicrosoftWindowsServer",
          "offer": "WindowsServer",
          "sku": "2019-datacenter-core-g2",
          "version": "latest"
        },
        "nodeAgentSkuId": "batch.node.windows amd64",
        "securityProfile": {
          "securityType": "confidentialVM",
          "encryptionAtHost": false,
          "uefiSettings": {
            "vTpmEnabled": true,
            "secureBootEnabled": true
          }
        },
        "osDisk": {
          "managedDisk": {
            "storageAccountType": "Standard_LRS",
            "diskEncryptionSet": {
              "id": "/subscriptions/12345678-1234-1234-1234-123456789012/resourceGroups/default-azurebatch-japaneast/providers/Microsoft.Compute/diskEncryptionSets/DiskEncryptionSetId"
            },
            "securityProfile": {
              "securityEncryptionType": "DiskWithVMGuestState",
              "diskEncryptionSet": {
                "id": "/subscriptions/12345678-1234-1234-1234-123456789012/resourceGroups/default-azurebatch-japaneast/providers/Microsoft.Compute/diskEncryptionSets/ConfidentialDiskEncryptionSetId"
              }
            }
          }
        },
        "dataDisks": [
          {
            "lun": 0,
            "diskSizeGB": 1024,
            "managedDisk": {
              "storageAccountType": "Standard_LRS",
              "diskEncryptionSet": {
                "id": "/subscriptions/12345678-1234-1234-1234-123456789012/resourceGroups/default-azurebatch-japaneast/providers/Microsoft.Compute/diskEncryptionSets/DiskEncryptionSetId"
              }
            }
          }
        ]
      }
    },
    "scaleSettings": {
      "fixedScale": {
        "targetDedicatedNodes": 1,
        "resizeTimeout": "PT15M"
      }
    }
  }
}

Exempelsvar

Statuskod:

200

ETag: W/"0x8D4EDFEBFADF4AB"

{
  "id": "/subscriptions/12345678-1234-1234-1234-123456789012/resourceGroups/default-azurebatch-japaneast/providers/Microsoft.Batch/batchAccounts/sampleacct/pools/testpool",
  "name": "testpool",
  "type": "Microsoft.Batch/batchAccounts/pools",
  "etag": "W/\"0x8D4EDFEBFADF4AB\"",
  "properties": {
    "lastModified": "2025-06-30T07:30:49.7522647Z",
    "creationTime": "2025-06-30T07:30:49.7522634Z",
    "provisioningState": "Succeeded",
    "provisioningStateTransitionTime": "2025-06-30T07:30:49.7522634Z",
    "allocationState": "Resizing",
    "allocationStateTransitionTime": "2025-06-30T07:30:49.7522647Z",
    "vmSize": "STANDARD_DC2as_v5",
    "interNodeCommunication": "Disabled",
    "taskSlotsPerNode": 1,
    "taskSchedulingPolicy": {
      "nodeFillType": "Pack",
      "jobDefaultOrder": "None"
    },
    "deploymentConfiguration": {
      "virtualMachineConfiguration": {
        "imageReference": {
          "publisher": "MicrosoftWindowsServer",
          "offer": "WindowsServer",
          "sku": "2019-datacenter-core-g2",
          "version": "latest"
        },
        "nodeAgentSkuId": "batch.node.windows amd64",
        "dataDisks": [
          {
            "lun": 0,
            "caching": "None",
            "diskSizeGB": 1024,
            "managedDisk": {
              "storageAccountType": "Standard_LRS",
              "diskEncryptionSet": {
                "id": "/subscriptions/12345678-1234-1234-1234-123456789012/resourceGroups/default-azurebatch-japaneast/providers/Microsoft.Compute/diskEncryptionSets/DiskEncryptionSetId"
              }
            }
          }
        ],
        "osDisk": {
          "caching": "None",
          "managedDisk": {
            "storageAccountType": "Standard_LRS",
            "securityProfile": {
              "securityEncryptionType": "DiskWithVMGuestState",
              "diskEncryptionSet": {
                "id": "/subscriptions/12345678-1234-1234-1234-123456789012/resourceGroups/default-azurebatch-japaneast/providers/Microsoft.Compute/diskEncryptionSets/ConfidentialDiskEncryptionSetId"
              }
            },
            "diskEncryptionSet": {
              "id": "/subscriptions/12345678-1234-1234-1234-123456789012/resourceGroups/default-azurebatch-japaneast/providers/Microsoft.Compute/diskEncryptionSets/DiskEncryptionSetId"
            }
          }
        },
        "securityProfile": {
          "securityType": "confidentialVM",
          "encryptionAtHost": false,
          "uefiSettings": {
            "secureBootEnabled": true,
            "vTpmEnabled": true
          }
        }
      }
    },
    "scaleSettings": {
      "fixedScale": {
        "targetDedicatedNodes": 1,
        "targetLowPriorityNodes": 0,
        "resizeTimeout": "PT15M"
      }
    },
    "resizeOperationStatus": {
      "targetDedicatedNodes": 1,
      "nodeDeallocationOption": "Requeue",
      "resizeTimeout": "PT15M",
      "startTime": "2025-06-30T07:30:49.7522324Z"
    },
    "currentDedicatedNodes": 0,
    "currentLowPriorityNodes": 0
  }
}

CreatePool - Custom Image

Exempelförfrågan

HTTP

PUT https://management.azure.com/subscriptions/12345678-1234-1234-1234-123456789012/resourceGroups/default-azurebatch-japaneast/providers/Microsoft.Batch/batchAccounts/sampleacct/pools/testpool?api-version=2025-06-01

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

Exempelsvar

Statuskod:

200

ETag: W/"0x8D4EDFEBFADF4AB"

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

CreatePool - customer managed key for Batch managed accounts

Exempelförfrågan

HTTP

PUT https://management.azure.com/subscriptions/12345678-1234-1234-1234-123456789012/resourceGroups/default-azurebatch-japaneast/providers/Microsoft.Batch/batchAccounts/sampleacct/pools/testpool?api-version=2025-06-01

{
  "properties": {
    "vmSize": "Standard_D4ds_v5",
    "deploymentConfiguration": {
      "virtualMachineConfiguration": {
        "imageReference": {
          "sku": "2022-Datacenter",
          "publisher": "MicrosoftWindowsServer",
          "version": "latest",
          "offer": "WindowsServer"
        },
        "nodeAgentSkuId": "batch.node.windows amd64",
        "diskEncryptionConfiguration": {
          "targets": [
            "OsDisk"
          ],
          "customerManagedKey": {
            "keyUrl": "http://sample.vault.azure.net//keys/cmk/bb60031a6d4545d3a60d3f94588538c9",
            "identityReference": {
              "resourceId": "/subscriptions/12345678-1234-1234-1234-123456789012/resourceGroups/default-azurebatch-japaneast/providers/Microsoft.ManagedIdentity/userAssignedIdentities/id1"
            }
          }
        }
      }
    },
    "scaleSettings": {
      "fixedScale": {
        "targetDedicatedNodes": 1,
        "resizeTimeout": "PT15M"
      }
    }
  },
  "identity": {
    "type": "UserAssigned",
    "userAssignedIdentities": {
      "/subscriptions/12345678-1234-1234-1234-123456789012/resourceGroups/default-azurebatch-japaneast/providers/Microsoft.ManagedIdentity/userAssignedIdentities/id1": {}
    }
  }
}

Exempelsvar

Statuskod:

200

ETag: W/"0x8D4EDFEBFADF4AB"

{
  "identity": {
    "type": "UserAssigned",
    "userAssignedIdentities": {
      "/subscriptions/12345678-1234-1234-1234-123456789012/resourceGroups/default-azurebatch-japaneast/providers/Microsoft.ManagedIdentity/userAssignedIdentities/id1": {
        "principalId": "principalId",
        "clientId": "clientId"
      }
    }
  },
  "id": "/subscriptions/12345678-1234-1234-1234-123456789012/resourceGroups/default-azurebatch-japaneast/providers/Microsoft.Batch/batchAccounts/sampleacct/pools/testpool",
  "name": "testpool",
  "type": "Microsoft.Batch/batchAccounts/pools",
  "etag": "W/\"0x8D4EDFEBFADF4AB\"",
  "properties": {
    "lastModified": "2025-06-30T07:16:33.4309281Z",
    "creationTime": "2025-06-30T07:16:33.4309266Z",
    "provisioningState": "Succeeded",
    "provisioningStateTransitionTime": "2025-06-30T07:16:33.4309266Z",
    "allocationState": "Resizing",
    "allocationStateTransitionTime": "2025-06-30T07:16:33.4309281Z",
    "vmSize": "Standard_D4ds_v5",
    "interNodeCommunication": "Disabled",
    "taskSlotsPerNode": 1,
    "taskSchedulingPolicy": {
      "nodeFillType": "Spread",
      "jobDefaultOrder": "None"
    },
    "deploymentConfiguration": {
      "virtualMachineConfiguration": {
        "imageReference": {
          "publisher": "MicrosoftWindowsServer",
          "offer": "WindowsServer",
          "sku": "2022-Datacenter",
          "version": "latest"
        },
        "nodeAgentSkuId": "batch.node.windows amd64",
        "diskEncryptionConfiguration": {
          "targets": [
            "OsDisk"
          ],
          "customerManagedKey": {
            "keyUrl": "http://sample.vault.azure.net//keys/cmk/bb60031a6d4545d3a60d3f94588538c9",
            "identityReference": {
              "resourceId": "/subscriptions/12345678-1234-1234-1234-123456789012/resourceGroups/default-azurebatch-japaneast/providers/Microsoft.ManagedIdentity/userAssignedIdentities/id1"
            }
          }
        }
      }
    },
    "scaleSettings": {
      "fixedScale": {
        "targetDedicatedNodes": 1,
        "targetLowPriorityNodes": 0,
        "resizeTimeout": "PT15M"
      }
    },
    "resizeOperationStatus": {
      "targetDedicatedNodes": 1,
      "nodeDeallocationOption": "Requeue",
      "resizeTimeout": "PT15M",
      "startTime": "2025-06-30T07:16:33.4309126Z"
    },
    "currentDedicatedNodes": 0,
    "currentLowPriorityNodes": 0
  }
}

CreatePool - disk encryption set for user subscription accounts

Exempelförfrågan

HTTP

PUT https://management.azure.com/subscriptions/12345678-1234-1234-1234-123456789012/resourceGroups/default-azurebatch-japaneast/providers/Microsoft.Batch/batchAccounts/sampleacct/pools/testpool?api-version=2025-06-01

{
  "properties": {
    "vmSize": "Standard_D4ds_v5",
    "taskSchedulingPolicy": {
      "nodeFillType": "Pack"
    },
    "deploymentConfiguration": {
      "virtualMachineConfiguration": {
        "imageReference": {
          "sku": "2022-Datacenter",
          "publisher": "MicrosoftWindowsServer",
          "version": "latest",
          "offer": "WindowsServer"
        },
        "nodeAgentSkuId": "batch.node.windows amd64",
        "securityProfile": {
          "encryptionAtHost": false
        },
        "osDisk": {
          "managedDisk": {
            "storageAccountType": "Standard_LRS",
            "diskEncryptionSet": {
              "id": "/subscriptions/12345678-1234-1234-1234-123456789012/resourceGroups/default-azurebatch-japaneast/providers/Microsoft.Compute/diskEncryptionSets/DiskEncryptionSetId"
            }
          }
        }
      }
    },
    "scaleSettings": {
      "fixedScale": {
        "targetDedicatedNodes": 1,
        "resizeTimeout": "PT15M"
      }
    }
  }
}

Exempelsvar

Statuskod:

200

ETag: W/"0x8D4EDFEBFADF4AB"

{
  "id": "/subscriptions/12345678-1234-1234-1234-123456789012/resourceGroups/default-azurebatch-japaneast/providers/Microsoft.Batch/batchAccounts/sampleacct/pools/testpool",
  "name": "testpool",
  "type": "Microsoft.Batch/batchAccounts/pools",
  "etag": "W/\"0x8D4EDFEBFADF4AB\"",
  "properties": {
    "lastModified": "2025-06-30T07:45:46.1580726Z",
    "creationTime": "2025-06-30T07:35:44.5579791Z",
    "provisioningState": "Succeeded",
    "provisioningStateTransitionTime": "2025-06-30T07:35:44.5579791Z",
    "allocationState": "Resizing",
    "allocationStateTransitionTime": "2025-06-30T07:45:46.1580727Z",
    "vmSize": "Standard_D4ds_v5",
    "interNodeCommunication": "Disabled",
    "taskSlotsPerNode": 1,
    "taskSchedulingPolicy": {
      "nodeFillType": "Pack",
      "jobDefaultOrder": "None"
    },
    "deploymentConfiguration": {
      "virtualMachineConfiguration": {
        "imageReference": {
          "publisher": "MicrosoftWindowsServer",
          "offer": "WindowsServer",
          "sku": "2022-Datacenter",
          "version": "latest"
        },
        "nodeAgentSkuId": "batch.node.windows amd64",
        "osDisk": {
          "caching": "None",
          "managedDisk": {
            "storageAccountType": "Standard_LRS",
            "diskEncryptionSet": {
              "id": "/subscriptions/12345678-1234-1234-1234-123456789012/resourceGroups/default-azurebatch-japaneast/providers/Microsoft.Compute/diskEncryptionSets/DiskEncryptionSetId"
            }
          }
        },
        "securityProfile": {
          "encryptionAtHost": false
        }
      }
    },
    "scaleSettings": {
      "fixedScale": {
        "targetDedicatedNodes": 1,
        "targetLowPriorityNodes": 0,
        "resizeTimeout": "PT15M"
      }
    },
    "resizeOperationStatus": {
      "targetDedicatedNodes": 1,
      "nodeDeallocationOption": "Requeue",
      "resizeTimeout": "PT15M",
      "startTime": "2025-06-30T07:45:46.1580724Z"
    },
    "currentDedicatedNodes": 0,
    "currentLowPriorityNodes": 0
  }
}

CreatePool - dual stack networking

Exempelförfrågan

HTTP

PUT https://management.azure.com/subscriptions/12345678-1234-1234-1234-123456789012/resourceGroups/default-azurebatch/providers/Microsoft.Batch/batchAccounts/exampleacc/pools/dualstackpool?api-version=2025-06-01

{
  "properties": {
    "vmSize": "Standard_D4ds_v5",
    "networkConfiguration": {
      "publicIPAddressConfiguration": {
        "ipFamilies": [
          "IPv4",
          "IPv6"
        ]
      },
      "endpointConfiguration": {
        "inboundNatPools": [
          {
            "backendPort": 22,
            "frontendPortRangeStart": 40000,
            "frontendPortRangeEnd": 40500,
            "name": "sshpool",
            "protocol": "TCP",
            "networkSecurityGroupRules": [
              {
                "access": "Allow",
                "priority": 1000,
                "sourceAddressPrefix": "*",
                "sourcePortRanges": [
                  "*"
                ]
              }
            ]
          }
        ]
      }
    },
    "deploymentConfiguration": {
      "virtualMachineConfiguration": {
        "imageReference": {
          "publisher": "Canonical",
          "offer": "ubuntu-24_04-lts",
          "sku": "server"
        },
        "nodeAgentSkuId": "batch.node.ubuntu 24.04"
      }
    },
    "scaleSettings": {
      "fixedScale": {
        "targetDedicatedNodes": 1,
        "targetLowPriorityNodes": 0
      }
    }
  }
}

Exempelsvar

Statuskod:

200

ETag: W/"0x8D4EDFEBFADF4AB"

{
  "id": "/subscriptions/12345678-1234-1234-1234-123456789012/resourceGroups/default-azurebatch-japaneast/providers/Microsoft.Batch/batchAccounts/sampleacct/pools/dualstackpool",
  "name": "dualstackpool",
  "type": "Microsoft.Batch/batchAccounts/pools",
  "etag": "W/\"0x8DDC34D4A01A419\"",
  "properties": {
    "lastModified": "2025-07-15T03:11:27.7998105Z",
    "creationTime": "2025-07-15T03:11:27.7997967Z",
    "provisioningState": "Succeeded",
    "provisioningStateTransitionTime": "2025-07-15T03:11:27.7997967Z",
    "allocationState": "Resizing",
    "allocationStateTransitionTime": "2025-07-15T03:11:27.7998136Z",
    "vmSize": "Standard_D4ds_v5",
    "interNodeCommunication": "Disabled",
    "taskSlotsPerNode": 1,
    "taskSchedulingPolicy": {
      "nodeFillType": "Spread",
      "jobDefaultOrder": "None"
    },
    "deploymentConfiguration": {
      "virtualMachineConfiguration": {
        "imageReference": {
          "publisher": "Canonical",
          "offer": "ubuntu-24_04-lts",
          "sku": "server",
          "version": "latest"
        },
        "nodeAgentSkuId": "batch.node.ubuntu 24.04"
      }
    },
    "networkConfiguration": {
      "publicIPAddressConfiguration": {
        "ipFamilies": [
          "IPv4",
          "IPv6"
        ]
      },
      "endpointConfiguration": {
        "inboundNatPools": [
          {
            "name": "sshpool",
            "protocol": "TCP",
            "backendPort": 22,
            "frontendPortRangeStart": 40000,
            "frontendPortRangeEnd": 40500,
            "networkSecurityGroupRules": [
              {
                "access": "Allow",
                "sourceAddressPrefix": "*",
                "priority": 1000,
                "sourcePortRanges": [
                  "*"
                ]
              }
            ]
          }
        ]
      },
      "dynamicVnetAssignmentScope": "none",
      "enableAcceleratedNetworking": false
    },
    "scaleSettings": {
      "fixedScale": {
        "targetDedicatedNodes": 1,
        "targetLowPriorityNodes": 0,
        "resizeTimeout": "PT15M"
      }
    },
    "resizeOperationStatus": {
      "targetDedicatedNodes": 1,
      "nodeDeallocationOption": "Requeue",
      "resizeTimeout": "PT15M",
      "startTime": "2025-07-15T03:11:27.7994621Z"
    },
    "currentDedicatedNodes": 0,
    "currentLowPriorityNodes": 0
  }
}

CreatePool - Full VirtualMachineConfiguration

Exempelförfrågan

HTTP

PUT https://management.azure.com/subscriptions/12345678-1234-1234-1234-123456789012/resourceGroups/default-azurebatch-japaneast/providers/Microsoft.Batch/batchAccounts/sampleacct/pools/testpool?api-version=2025-06-01

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

Exempelsvar

Statuskod:

200

ETag: W/"0x8D4EDFEBFADF4AB"

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

CreatePool - Minimal VirtualMachineConfiguration

Exempelförfrågan

HTTP

PUT https://management.azure.com/subscriptions/12345678-1234-1234-1234-123456789012/resourceGroups/default-azurebatch-japaneast/providers/Microsoft.Batch/batchAccounts/sampleacct/pools/testpool?api-version=2025-06-01

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

Exempelsvar

Statuskod:

200

ETag: W/"0x8D4EDFEBFADF4AB"

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

CreatePool - No public IP

Exempelförfrågan

HTTP

PUT https://management.azure.com/subscriptions/12345678-1234-1234-1234-123456789012/resourceGroups/default-azurebatch-japaneast/providers/Microsoft.Batch/batchAccounts/sampleacct/pools/testpool?api-version=2025-06-01

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

Exempelsvar

Statuskod:

200

ETag: W/"0x8D4EDFEBFADF4AB"

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

CreatePool - Public IPs

Exempelförfrågan

HTTP

PUT https://management.azure.com/subscriptions/12345678-1234-1234-1234-123456789012/resourceGroups/default-azurebatch-japaneast/providers/Microsoft.Batch/batchAccounts/sampleacct/pools/testpool?api-version=2025-06-01

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

Exempelsvar

Statuskod:

200

ETag: W/"0x8D4EDFEBFADF4AB"

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

CreatePool - SecurityProfile

Exempelförfrågan

HTTP

PUT https://management.azure.com/subscriptions/12345678-1234-1234-1234-123456789012/resourceGroups/default-azurebatch-japaneast/providers/Microsoft.Batch/batchAccounts/sampleacct/pools/testpool?api-version=2025-06-01

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

Exempelsvar

Statuskod:

200

ETag: W/"0x8DB554F8E08BCF4"

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

CreatePool - Tags

Exempelförfrågan

HTTP

PUT https://management.azure.com/subscriptions/12345678-1234-1234-1234-123456789012/resourceGroups/default-azurebatch-japaneast/providers/Microsoft.Batch/batchAccounts/sampleacct/pools/testpool?api-version=2025-06-01

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

Exempelsvar

Statuskod:

200

ETag: W/"0x8DB554F8E08BCF4"

{
  "name": "testpool",
  "type": "Microsoft.Batch/batchAccounts/pools",
  "id": "/subscriptions/12345678-1234-1234-1234-123456789012/resourceGroups/default-azurebatch-japaneast/providers/Microsoft.Batch/batchAccounts/sampleacct/pools/testpool",
  "properties": {
    "allocationState": "Resizing",
    "allocationStateTransitionTime": "2023-06-14T07:03:58.3231917Z",
    "creationTime": "2023-06-14T07:03:58.3231917Z",
    "currentDedicatedNodes": 0,
    "currentLowPriorityNodes": 0,
    "deploymentConfiguration": {
      "virtualMachineConfiguration": {
        "imageReference": {
          "offer": "0001-com-ubuntu-server-jammy",
          "publisher": "Canonical",
          "sku": "22_04-lts",
          "version": "latest"
        },
        "nodeAgentSkuId": "batch.node.ubuntu 22.04"
      }
    },
    "interNodeCommunication": "Disabled",
    "lastModified": "2023-06-14T07:03:58.3231917Z",
    "provisioningState": "Succeeded",
    "provisioningStateTransitionTime": "2023-06-14T07:03:58.3231917Z",
    "resizeOperationStatus": {
      "nodeDeallocationOption": "Requeue",
      "resizeTimeout": "PT15M",
      "startTime": "2023-09-27T07:33:13.0625789Z",
      "targetDedicatedNodes": 1
    },
    "scaleSettings": {
      "fixedScale": {
        "resizeTimeout": "PT15M",
        "targetDedicatedNodes": 1,
        "targetLowPriorityNodes": 0
      }
    },
    "taskSchedulingPolicy": {
      "nodeFillType": "Spread"
    },
    "taskSlotsPerNode": 1,
    "vmSize": "STANDARD_D4S_V3"
  }
}

CreatePool - UpgradePolicy

Exempelförfrågan

HTTP

PUT https://management.azure.com/subscriptions/12345678-1234-1234-1234-123456789012/resourceGroups/default-azurebatch-japaneast/providers/Microsoft.Batch/batchAccounts/sampleacct/pools/testpool?api-version=2025-06-01

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

Exempelsvar

Statuskod:

200

ETag: W/"0x8DB51E64D3C3B69"

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

CreatePool - UserAssignedIdentities

Exempelförfrågan

HTTP

PUT https://management.azure.com/subscriptions/12345678-1234-1234-1234-123456789012/resourceGroups/default-azurebatch-japaneast/providers/Microsoft.Batch/batchAccounts/sampleacct/pools/testpool?api-version=2025-06-01

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

Exempelsvar

Statuskod:

200

ETag: W/"0x8D4EDFEBFADF4AB"

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

CreatePool - VirtualMachineConfiguration Extensions

Exempelförfrågan

HTTP

PUT https://management.azure.com/subscriptions/12345678-1234-1234-1234-123456789012/resourceGroups/default-azurebatch-japaneast/providers/Microsoft.Batch/batchAccounts/sampleacct/pools/testpool?api-version=2025-06-01

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

Exempelsvar

Statuskod:

200

ETag: W/"0x8D4EDFEBFADF4AB"

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

CreatePool - VirtualMachineConfiguration OSDisk

Exempelförfrågan

HTTP

PUT https://management.azure.com/subscriptions/12345678-1234-1234-1234-123456789012/resourceGroups/default-azurebatch-japaneast/providers/Microsoft.Batch/batchAccounts/sampleacct/pools/testpool?api-version=2025-06-01

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

Exempelsvar

Statuskod:

200

ETag: W/"0x8DB51F14DC1A8AD"

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

CreatePool - VirtualMachineConfiguration ServiceArtifactReference

Exempelförfrågan

HTTP

PUT https://management.azure.com/subscriptions/12345678-1234-1234-1234-123456789012/resourceGroups/default-azurebatch-japaneast/providers/Microsoft.Batch/batchAccounts/sampleacct/pools/testpool?api-version=2025-06-01

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

Exempelsvar

Statuskod:

200

ETag: W/"0x8DB51F14DC1A8AD"

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

Definitioner

Namn	Beskrivning
AllocationState	Om poolen ändrar storlek.
ApplicationPackageReference	Länka till ett programpaket i batchkontot
AutomaticOSUpgradePolicy	De konfigurationsparametrar som används för att utföra automatisk operativsystemuppgradering.
AutoScaleRun	Resultatet och felen från en körning av en autoskalningsformel för pooler.
AutoScaleRunError	Ett fel uppstod vid automatisk skalning av en pool.
AutoScaleSettings	Autoskalningsinställningar för poolen.
AutoUserScope	Standardvärdet är Pool. Om poolen kör Windows ska värdet Aktivitet anges om striktare isolering mellan aktiviteter krävs. Till exempel om aktiviteten muterar registret på ett sätt som kan påverka andra uppgifter.
AutoUserSpecification	Anger parametrarna för den automatiska användare som kör en uppgift i Batch-tjänsten.
AzureBlobFileSystemConfiguration	Information som används för att ansluta till en Azure Storage-container med blobfuse.
AzureFileShareConfiguration	Information som används för att ansluta till en Azure Fileshare.
BatchPoolIdentity	Identiteten för Batch-poolen, om den är konfigurerad. Om poolidentiteten uppdateras under uppdateringen av en befintlig pool kommer endast de nya virtuella datorer som skapas efter att poolen krymper till 0 att ha de uppdaterade identiteterna
CachingType	Typ av cachelagring som ska aktiveras för disken.
CIFSMountConfiguration	Information som används för att ansluta till ett CIFS-filsystem.
CloudError	Ett felsvar från Batch-tjänsten.
CloudErrorBody	Ett felsvar från Batch-tjänsten.
ComputeNodeDeallocationOption	Avgör vad du ska göra med en nod och dess aktiviteter som körs när den har valts för frigöring.
ComputeNodeFillType	Hur aktiviteter ska distribueras mellan beräkningsnoder.
ComputeNodeIdentityReference	Referensen till en användartilldelad identitet som är associerad med Batch-poolen som en beräkningsnod ska använda.
ContainerConfiguration	Konfigurationen för containeraktiverade pooler.
ContainerHostBatchBindMountEntry	Posten för sökvägen och monteringsläget som du vill montera i aktivitetscontainern.
ContainerHostDataPath	Sökvägarna som ska monteras på containeraktivitetens container.
ContainerRegistry	Ett privat containerregister.
ContainerType	Den containerteknik som ska användas.
ContainerWorkingDirectory	En flagga som anger var containeruppgiftens arbetskatalog finns. Standardvärdet är "taskWorkingDirectory".
createdByType	Den typ av identitet som skapade resursen.
DataDisk	Inställningar som ska användas av de datadiskar som är associerade med beräkningsnoder i poolen. När du använder anslutna datadiskar måste du montera och formatera diskarna från en virtuell dator för att kunna använda dem.
DeploymentConfiguration	Egenskaper för distributionskonfiguration.
DiffDiskPlacement	Platsen där OS-disken ska placeras.
DiffDiskSettings	Anger tillfälliga diskinställningar för den operativsystemdisk som används av den virtuella datorn.
DiskCustomerManagedKey	Referensen för den kundhanterade nyckeln för att kryptera disken.
DiskEncryptionConfiguration	Diskkrypteringskonfigurationen som tillämpas på beräkningsnoder i poolen. Diskkrypteringskonfiguration stöds inte i Linux-pool som skapats med Virtual Machine Image eller Azure Compute Gallery Image.
DiskEncryptionSetParameters	ARM-resurs-ID:t för diskkrypteringsuppsättningen.
DiskEncryptionTarget	Om det utelämnas krypteras inga diskar på beräkningsnoderna i poolen.
DynamicVNetAssignmentScope	Omfånget för dynamisk vnet-tilldelning.
ElevationLevel	Användarens höjdnivå.
EnvironmentSetting	En miljövariabel som ska anges i en uppgiftsprocess.
FixedScaleSettings	Inställningar för fast skalning för poolen.
HostEndpointSettings	Anger specifika inställningar för värdslutpunkten.
HostEndpointSettingsModeTypes	Anger körningsläget för principen för åtkomstkontroll.
ImageReference	En referens till en Azure Virtual Machines Marketplace-avbildning eller Azure Image-resursen för en anpassad virtuell dator. Information om hur du hämtar listan över alla imageReferences som verifierats av Azure Batch finns i åtgärden "List supported node agent SKU:er".
InboundEndpointProtocol	Slutpunktens protokoll.
InboundNatPool	En inkommande NAT-pool som kan användas för att hantera specifika portar på beräkningsnoder i en Batch-pool externt.
InterNodeCommunicationState	Detta medför begränsningar för vilka noder som kan tilldelas till poolen. Om du aktiverar det här värdet kan du minska risken för att det begärda antalet noder allokeras i poolen. Om det inte anges är det här värdet som standard inaktiverat.
IPAddressProvisioningType	Etableringstypen för offentliga IP-adresser för Batch-poolen.
IPFamily	IP-familjerna som används för att ange IP-versioner som är tillgängliga för poolen.
IPTag	Anger hur aktiviteter ska distribueras mellan beräkningsnoder.
JobDefaultOrder	Ordningen för schemaläggning av uppgifter från olika jobb med samma prioritet.
LinuxUserConfiguration	Egenskaper som används för att skapa ett användarkonto på en Linux-nod.
LoginMode	Anger inloggningsläge för användaren. Standardvärdet är Interaktivt.
ManagedDisk	Parametrarna för hanterade diskar.
MetadataItem	Ett namn/värde-par som är associerat med en Batch-tjänstresurs.
MountConfiguration	Filsystemet som ska monteras på varje nod.
NetworkConfiguration	Nätverkskonfigurationen för en pool.
NetworkSecurityGroupRule	En regel för nätverkssäkerhetsgrupp som ska tillämpas på en inkommande slutpunkt.
NetworkSecurityGroupRuleAccess	Den åtgärd som ska vidtas för en angiven IP-adress, undernätsintervall eller tagg.
NFSMountConfiguration	Information som används för att ansluta till ett NFS-filsystem.
NodePlacementConfiguration	Nodplaceringskonfiguration för batchpooler.
NodePlacementPolicyType	Standardvärdet är regionalt.
OSDisk	Inställningar för den virtuella datorns operativsystemdisk.
Pool	Innehåller information om en pool.
PoolEndpointConfiguration	Slutpunktskonfigurationen för en pool.
PoolIdentityType	Den typ av identitet som används för Batch-poolen.
PoolProvisioningState	Poolens aktuella tillstånd.
ProxyAgentSettings	Anger ProxyAgent-inställningar när den virtuella datorn skapas.
PublicIPAddressConfiguration	Den offentliga IP-adresskonfigurationen för nätverkskonfigurationen för en pool.
ResizeError	Ett fel uppstod vid storleksändring av en pool.
ResizeOperationStatus	Information om den aktuella eller senast slutförda storleksändringsåtgärden.
ResourceFile	En enda fil eller flera filer som ska laddas ned till en beräkningsnod.
RollingUpgradePolicy	De konfigurationsparametrar som används vid löpande uppgradering.
ScaleSettings	Skalningsinställningar för poolen
SecurityEncryptionTypes	Anger EncryptionType för den hanterade disken. Den är inställd på DiskWithVMGuestState för kryptering av den hanterade disken tillsammans med VMGuestState-blobben, VMGuestStateOnly för kryptering av endast VMGuestState-blobben, och NonPersistedTPM för att inte behålla firmware-tillståndet i VMGuestState-blobben. Obs: Det kan endast anges för konfidentiella virtuella datorer och krävs när du använder konfidentiella virtuella datorer.
SecurityProfile	Anger säkerhetsprofilinställningarna för den virtuella datorn eller vm-skalningsuppsättningen.
SecurityTypes	Anger SecurityType för den virtuella datorn. Det måste anges till ett angivet värde för att aktivera UefiSettings.
ServiceArtifactReference	Anger tjänstartefaktreferens-ID:t som används för att ange samma avbildningsversion för alla virtuella datorer i skalningsuppsättningen när du använder den senaste avbildningsversionen.
StartTask	En uppgift som körs när en beräkningsnod ansluter till en pool i Azure Batch-tjänsten, eller när beräkningsnoden startas om eller omskapas.
StorageAccountType	Lagringskontotypen som ska användas för att skapa datadiskar eller OS-diskar.
systemData	Metadata som rör skapande och senaste ändring av resursen.
TaskContainerSettings	Containerinställningarna för en uppgift.
TaskSchedulingPolicy	Anger hur aktiviteter ska distribueras mellan beräkningsnoder.
UefiSettings	Anger de säkerhetsinställningar som säker start och vTPM som används när den virtuella datorn skapas.
UpgradeMode	Anger läget för en uppgradering till virtuella datorer i skalningsuppsättningen. Möjliga värden är: Manuell – Du styr programmet för uppdateringar av virtuella datorer i skalningsuppsättningen. Du gör detta med hjälp av åtgärden manualUpgrade. Automatisk – Alla virtuella datorer i skalningsuppsättningen uppdateras automatiskt samtidigt. Rullande – Skalningsuppsättningen utför uppdateringar i batchar med en valfri paustid däremellan.
UpgradePolicy	Beskriver en uppgraderingsprincip – automatisk, manuell eller rullande.
UserAccount	Egenskaper som används för att skapa en användare på en Azure Batch-nod.
UserAssignedIdentities	Listan över associerade användaridentiteter.
UserIdentity	Definitionen av användaridentiteten under vilken uppgiften körs.
VirtualMachineConfiguration	Konfigurationen för beräkningsnoder i en pool baserat på Azure Virtual Machines-infrastrukturen.
VMDiskSecurityProfile	Anger säkerhetsprofilinställningarna för den hanterade disken. Obs: Det kan bara anges för konfidentiella virtuella datorer och krävs när du använder konfidentiella virtuella datorer.
VMExtension	Konfigurationen för tillägg för virtuella datorer.
WindowsConfiguration	Inställningar för Windows-operativsystem som ska tillämpas på den virtuella datorn.
WindowsUserConfiguration	Egenskaper som används för att skapa ett användarkonto på en Windows-nod.

AllocationState

Uppräkning

Om poolen ändrar storlek.

Värde	Beskrivning
Steady	Poolen ändrar inte storlek. Det finns inga ändringar i antalet noder i poolen som pågår. En pool anger det här tillståndet när den skapas och när inga åtgärder utförs i poolen för att ändra antalet noder.
Resizing	Poolen ändrar storlek. d.v.s. att beräkningsnoder läggs till eller tas bort från poolen.
Stopping	Poolen ändrade storlek, men användaren har begärt att storleksändringen ska stoppas, men stoppbegäran har ännu inte slutförts.

ApplicationPackageReference

Objekt

Länka till ett programpaket i batchkontot

Namn	Typ	Beskrivning
id	string	ID:t för programpaketet som ska installeras. Detta måste vara i samma batchkonto som poolen. Detta kan antingen vara en referens till en viss version eller standardversionen om det finns en sådan. ID:t för programpaketet som ska installeras. Detta måste finnas i samma batchkonto som poolen. Detta kan antingen vara en referens till en viss version eller standardversionen om det finns en sådan.
version	string	Den version av programmet som ska distribueras. Om den utelämnas distribueras standardversionen. Om detta utelämnas och ingen standardversion har angetts för det här programmet misslyckas begäran med felkoden InvalidApplicationPackageReferences. Om du anropar REST-API:et direkt är HTTP-statuskoden 409.

AutomaticOSUpgradePolicy

Objekt

De konfigurationsparametrar som används för att utföra automatisk operativsystemuppgradering.

Namn	Typ	Beskrivning
disableAutomaticRollback	boolean	Om funktionen för återställning av os-avbildning ska inaktiveras.
enableAutomaticOSUpgrade	boolean	Anger om OS-uppgraderingar automatiskt ska tillämpas på skalningsuppsättningsinstanser på ett löpande sätt när en nyare version av OS-avbildningen blir tillgänglig. Om detta är inställt på sant för Windows-baserade pooler kan WindowsConfiguration.enableAutomaticUpdates inte anges till true.
osRollingUpgradeDeferral	boolean	Skjut upp OS-uppgraderingar på TV-datorerna om de kör uppgifter.
useRollingUpgradePolicy	boolean	Anger om principen för löpande uppgradering ska användas under automatisk operativsystemuppgradering. Automatisk os-uppgradering återgår till standardprincipen om ingen princip har definierats på VMSS.

AutoScaleRun

Objekt

Resultatet och felen från en körning av en autoskalningsformel för pooler.

Namn	Typ	Beskrivning
error	AutoScaleRunError	Information om felet vid utvärdering av autoskalningsformeln i poolen, om utvärderingen misslyckades. Ett fel uppstod vid automatisk skalning av en pool.
evaluationTime	string (date-time)	Den tid då autoskalningsformeln senast utvärderades. Den tid då autoskalningsformeln senast utvärderades.
results	string	De slutliga värdena för alla variabler som används i utvärderingen av autoskalningsformeln. Varje variabelvärde returneras i formuläret $variable=value, och variabler avgränsas med semikolon.

AutoScaleRunError

Objekt

Ett fel uppstod vid automatisk skalning av en pool.

Namn	Typ	Beskrivning
code	string	En identifierare för felet. Koder är invarianta och är avsedda att användas programmatiskt.
details	AutoScaleRunError[]	Ytterligare information om felet. Ytterligare information om felet.
message	string	Ett meddelande som beskriver felet, avsett att vara lämpligt för visning i ett användargränssnitt.

AutoScaleSettings

Objekt

Autoskalningsinställningar för poolen.

Namn	Typ	Beskrivning
evaluationInterval	string (duration)	Tidsintervallet då poolstorleken ska justeras automatiskt enligt autoskalningsformeln. Om det utelämnas är standardvärdet 15 minuter (PT15M).
formula	string	En formel för önskat antal beräkningsnoder i poolen. En formel för önskat antal beräkningsnoder i poolen.

AutoUserScope

Uppräkning

Standardvärdet är Pool. Om poolen kör Windows ska värdet Aktivitet anges om striktare isolering mellan aktiviteter krävs. Till exempel om aktiviteten muterar registret på ett sätt som kan påverka andra uppgifter.

Värde	Beskrivning
Task	Anger att tjänsten ska skapa en ny användare för uppgiften.
Pool	Anger att aktiviteten körs som det vanliga automatiska användarkontot som skapas på varje nod i en pool.

AutoUserSpecification

Objekt

Anger parametrarna för den automatiska användare som kör en uppgift i Batch-tjänsten.

Namn	Typ	Beskrivning
elevationLevel	ElevationLevel	Användarens höjdnivå. Standardvärdet är nonAdmin.
scope	AutoUserScope	Omfånget för den automatiska användaren Standardvärdet är Pool. Om poolen kör Windows ska värdet Aktivitet anges om striktare isolering mellan aktiviteter krävs. Om uppgiften till exempel muterar registret på ett sätt som kan påverka andra uppgifter, eller om certifikat har angetts i poolen som inte ska vara tillgängliga för normala uppgifter men bör vara tillgängliga genom startaktiviteter.

AzureBlobFileSystemConfiguration

Objekt

Information som används för att ansluta till en Azure Storage-container med blobfuse.

Namn	Typ	Beskrivning
accountKey	string (password)	Azure Storage-kontonyckeln. Den här egenskapen är ömsesidigt uteslutande med både sasKey och identitet; exakt ett måste anges.
accountName	string	Namnet på Azure Storage-kontot. Namnet på Azure Storage-kontot.
blobfuseOptions	string	Ytterligare kommandoradsalternativ för att skicka till monteringskommandot. Det här är alternativ för "net use" i Windows och "monteringsalternativ" i Linux.
containerName	string	Namnet på Azure Blob Storage-containern. Namnet på Azure Blob Storage-containern.
identityReference	ComputeNodeIdentityReference	Referensen till den användartilldelade identitet som ska användas för att komma åt containerName Den här egenskapen är ömsesidigt uteslutande med både accountKey och sasKey; exakt ett måste anges.
relativeMountPath	string	Den relativa sökvägen på beräkningsnoden där filsystemet ska monteras Alla filsystem monteras i förhållande till katalogen Batch-monteringar, som är tillgängliga via AZ_BATCH_NODE_MOUNTS_DIR miljövariabeln.
sasKey	string (password)	Sas-token för Azure Storage. Den här egenskapen är ömsesidigt uteslutande med både accountKey och identitet; exakt ett måste anges.

AzureFileShareConfiguration

Objekt

Information som används för att ansluta till en Azure Fileshare.

Namn	Typ	Beskrivning
accountKey	string (password)	Azure Storage-kontonyckeln. Azure Storage-kontonyckeln.
accountName	string	Namnet på Azure Storage-kontot. Namnet på Azure Storage-kontot.
azureFileUrl	string	Url:en för Azure Files. Det här är formuläret "https://{account}.file.core.windows.net/".
mountOptions	string	Ytterligare kommandoradsalternativ för att skicka till monteringskommandot. Det här är alternativ för "net use" i Windows och "monteringsalternativ" i Linux.
relativeMountPath	string	Den relativa sökvägen på beräkningsnoden där filsystemet ska monteras Alla filsystem monteras i förhållande till katalogen Batch-monteringar, som är tillgängliga via AZ_BATCH_NODE_MOUNTS_DIR miljövariabeln.

BatchPoolIdentity

Objekt

Identiteten för Batch-poolen, om den är konfigurerad. Om poolidentiteten uppdateras under uppdateringen av en befintlig pool kommer endast de nya virtuella datorer som skapas efter att poolen krymper till 0 att ha de uppdaterade identiteterna

Namn	Typ	Beskrivning
type	PoolIdentityType	Den typ av identitet som används för Batch-poolen.
userAssignedIdentities	<string,  UserAssignedIdentities>	Listan över användaridentiteter som är associerade med Batch-poolen.

CachingType

Uppräkning

Typ av cachelagring som ska aktiveras för disken.

Värde	Beskrivning
None	Cachelagringsläget för disken är inte aktiverat.
ReadOnly	Cachelagringsläget för disken är skrivskyddat.
ReadWrite	Cachelagringsläget för disken är läs- och skrivläge.

CIFSMountConfiguration

Objekt

Information som används för att ansluta till ett CIFS-filsystem.

Namn	Typ	Beskrivning
mountOptions	string	Ytterligare kommandoradsalternativ för att skicka till monteringskommandot. Det här är alternativ för "net use" i Windows och "monteringsalternativ" i Linux.
password	string (password)	Lösenordet som ska användas för autentisering mot CIFS-filsystemet. Lösenordet som ska användas för autentisering mot CIFS-filsystemet.
relativeMountPath	string	Den relativa sökvägen på beräkningsnoden där filsystemet ska monteras Alla filsystem monteras i förhållande till katalogen Batch-monteringar, som är tillgängliga via AZ_BATCH_NODE_MOUNTS_DIR miljövariabeln.
source	string	URI:n för filsystemet som ska monteras. URI:n för filsystemet som ska monteras.
userName	string	Användaren som ska användas för autentisering mot CIFS-filsystemet. Användaren som ska användas för autentisering mot CIFS-filsystemet.

CloudError

Objekt

Ett felsvar från Batch-tjänsten.

Namn	Typ	Beskrivning
error	CloudErrorBody	Brödtexten i felsvaret.

CloudErrorBody

Objekt

Ett felsvar från Batch-tjänsten.

Namn	Typ	Beskrivning
code	string	En identifierare för felet. Koder är invarianta och är avsedda att användas programmatiskt.
details	CloudErrorBody[]	En lista med ytterligare information om felet.
message	string	Ett meddelande som beskriver felet, avsett att vara lämpligt för visning i ett användargränssnitt.
target	string	Målet för det specifika felet. Till exempel namnet på egenskapen i fel.

ComputeNodeDeallocationOption

Uppräkning

Avgör vad du ska göra med en nod och dess aktiviteter som körs när den har valts för frigöring.

Värde	Beskrivning
Requeue	Avsluta aktivitetsprocesser som körs och skicka aktiviteterna på nytt. Aktiviteterna körs igen när en nod är tillgänglig. Ta bort noder så snart aktiviteterna har avslutats.
Terminate	Avsluta aktiviteter som körs. Aktiviteterna kommer att slutföras med failureInfo som anger att de har avslutats och inte körs igen. Ta bort noder så snart aktiviteterna har avslutats.
TaskCompletion	Tillåt att aktiviteter som körs för närvarande slutförs. Schemalägg inga nya aktiviteter medan du väntar. Ta bort noder när alla aktiviteter har slutförts.
RetainedData	Tillåt att aktiviteter som körs för närvarande kan slutföras och vänta tills alla kvarhållningsperioder för uppgiftsdata upphör att gälla. Schemalägg inga nya aktiviteter medan du väntar. Ta bort noder när alla kvarhållningsperioder för aktiviteter har upphört att gälla.

ComputeNodeFillType

Uppräkning

Hur aktiviteter ska distribueras mellan beräkningsnoder.

Värde	Beskrivning
Spread	Aktiviteter bör tilldelas jämnt över alla noder i poolen.
Pack	Så många aktiviteter som möjligt (taskSlotsPerNode) ska tilldelas till varje nod i poolen innan några aktiviteter tilldelas till nästa nod i poolen.

ComputeNodeIdentityReference

Objekt

Referensen till en användartilldelad identitet som är associerad med Batch-poolen som en beräkningsnod ska använda.

Namn	Typ	Beskrivning
resourceId	string	ARM-resurs-ID för den användartilldelade identiteten.

ContainerConfiguration

Objekt

Konfigurationen för containeraktiverade pooler.

Namn	Typ	Beskrivning
containerImageNames	string[]	Samlingen med containeravbildningsnamn. Det här är den fullständiga avbildningsreferensen, som skulle anges till "docker pull". En avbildning kommer att hämtas från Docker-standardregistret om inte avbildningen är fullständigt kvalificerad med ett alternativt register.
containerRegistries	ContainerRegistry[]	Ytterligare privata register från vilka containrar kan hämtas. Om några avbildningar måste laddas ned från ett privat register som kräver autentiseringsuppgifter måste dessa autentiseringsuppgifter anges här.
type	ContainerType	Den containerteknik som ska användas. Den containerteknik som ska användas.

ContainerHostBatchBindMountEntry

Objekt

Posten för sökvägen och monteringsläget som du vill montera i aktivitetscontainern.

Namn	Typ	Beskrivning
isReadOnly	boolean	Montera den här källsökvägen som skrivskyddat läge eller inte. Standardvärdet är falskt (läs-/skrivläge). För Linux, om du monterar den här sökvägen som ett läs-/skrivläge betyder det inte att alla användare i containern har läs-/skrivåtkomst för sökvägen, det beror på åtkomsten i den virtuella värddatorn. Om den här sökvägen är skrivskyddad kan inte alla användare i containern ändra sökvägen.
source	ContainerHostDataPath	Sökvägarna som ska monteras på containeraktivitetens container. Sökvägarna som ska monteras på containeraktivitetens container.

ContainerHostDataPath

Uppräkning

Sökvägarna som ska monteras på containeraktivitetens container.

Värde	Beskrivning
Shared	Sökvägen för uppgift för flera instanser att dela sina filer.
Startup	Sökvägen för startaktiviteten.
VfsMounts	Sökvägen innehåller alla virtuella filsystem som är monterade på den här noden.
Task	Aktivitetssökvägen.
JobPrep	Jobbförberedelseaktivitetssökvägen.
Applications	Programsökvägen.

ContainerRegistry

Objekt

Ett privat containerregister.

Namn	Typ	Beskrivning
identityReference	ComputeNodeIdentityReference	Referensen till den användartilldelade identitet som ska användas för att komma åt ett Azure Container Registry i stället för användarnamn och lösenord. Referensen till en användartilldelad identitet som är associerad med Batch-poolen som en beräkningsnod ska använda.
password	string (password)	Lösenordet för att logga in på registerservern. Lösenordet för att logga in på registerservern.
registryServer	string	Registrets URL. Om det utelämnas är standardvärdet "docker.io".
username	string	Användarnamnet för att logga in på registerservern. Användarnamnet för att logga in på registerservern.

ContainerType

Uppräkning

Den containerteknik som ska användas.

Värde	Beskrivning
DockerCompatible	En Docker-kompatibel containerteknik används för att starta containrarna.
CriCompatible	En CRI-baserad teknik kommer att användas för att starta containrarna.

ContainerWorkingDirectory

Uppräkning

En flagga som anger var containeruppgiftens arbetskatalog finns. Standardvärdet är "taskWorkingDirectory".

Värde	Beskrivning
TaskWorkingDirectory	Använd standardarbetskatalogen för Batch-tjänsten, som innehåller resursfilerna för aktiviteten som fylls i av Batch.
ContainerImageDefault	Använda containeravbildningsdefinierad arbetskatalog. Se upp för att den här katalogen inte innehåller de resursfiler som laddats ned av Batch.

createdByType

Uppräkning

Den typ av identitet som skapade resursen.

Värde	Beskrivning
User
Application
ManagedIdentity
Key

DataDisk

Objekt

Inställningar som ska användas av de datadiskar som är associerade med beräkningsnoder i poolen. När du använder anslutna datadiskar måste du montera och formatera diskarna från en virtuell dator för att kunna använda dem.

Namn	Typ	Beskrivning
caching	CachingType	Typ av cachelagring som ska aktiveras för disken. Värden är: none – Cachelagringsläget för disken är inte aktiverat. readOnly – Cachelagringsläget för disken är skrivskyddat. readWrite – Cachelagringsläget för disken är läs- och skrivläge. Standardvärdet för cachelagring är inget. Information om cachelagringsalternativen finns i: https://blogs.msdn.microsoft.com/windowsazurestorage/2012/06/27/exploring-windows-azure-drives-disks-and-images/.
diskSizeGB	integer (int32)	Den ursprungliga diskstorleken i GB när du skapar en ny datadisk. Den ursprungliga diskstorleken i GB när du skapar en ny datadisk.
lun	integer (int32)	Det logiska enhetsnumret. Lun används för att unikt identifiera varje datadisk. Om du ansluter flera diskar bör var och en ha ett distinkt lun. Värdet måste vara mellan 0 och 63, inklusive.
managedDisk	ManagedDisk	Parametrarna för hanterade diskar. Parametrarna för hanterade diskar.

DeploymentConfiguration

Objekt

Egenskaper för distributionskonfiguration.

Namn	Typ	Beskrivning
virtualMachineConfiguration	VirtualMachineConfiguration	Konfigurationen av den virtuella datorn för poolen. Konfigurationen för beräkningsnoder i en pool baserat på Azure Virtual Machines-infrastrukturen.

DiffDiskPlacement

Uppräkning

Platsen där OS-disken ska placeras.

Värde	Beskrivning
CacheDisk	OS-disken placeras på VM:ns cachedisk.

DiffDiskSettings

Objekt

Anger tillfälliga diskinställningar för den operativsystemdisk som används av den virtuella datorn.

Namn	Typ	Beskrivning
placement	DiffDiskPlacement	Anger den tillfälliga diskplaceringen för operativsystemdisken för alla virtuella datorer i poolen. Den här egenskapen kan användas av användaren i begäran för att välja vilken plats operativsystemet ska finnas på. t.ex. cachelagring av diskutrymme för tillfällig OS-disketablering. Mer information om krav för tillfällig os-diskstorlek finns i Krav på tillfällig os-diskstorlek för virtuella Windows-datorer på https://learn.microsoft.com/azure/virtual-machines/windows/ephemeral-os-disks#size-requirements och virtuella Linux-datorer på https://learn.microsoft.com/azure/virtual-machines/linux/ephemeral-os-disks#size-requirements.

DiskCustomerManagedKey

Objekt

Referensen för den kundhanterade nyckeln för att kryptera disken.

Namn	Typ	Beskrivning
identityReference	ComputeNodeIdentityReference	Referensen till en av poolidentiteterna för att kryptera disken. Den här identiteten används för att komma åt KeyVault.
keyUrl	string (uri)	Fullständigt versionshanterad nyckel-URL som pekar på en nyckel i KeyVault. Versionssegmentet för URL:en krävs oavsett rotationToLatestKeyVersionEnabled-värde.
rotationToLatestKeyVersionEnabled	boolean	Ställ in den här flaggan på true för att aktivera automatisk uppdatering av diskkrypteringen till den senaste nyckelversionen. Standardvärdet är false.

DiskEncryptionConfiguration

Objekt

Diskkrypteringskonfigurationen som tillämpas på beräkningsnoder i poolen. Diskkrypteringskonfiguration stöds inte i Linux-pool som skapats med Virtual Machine Image eller Azure Compute Gallery Image.

Namn	Typ	Beskrivning
customerManagedKey	DiskCustomerManagedKey	Referensen för den kundhanterade nyckeln för att kryptera OS-disken. Kundhanterad nyckel krypterar OS-disken med EncryptionAtRest, och som standard krypterar vi även datadisken. Den kan bara användas när poolen har konfigurerats med en identitet och OsDisk har angetts som ett av målen för DiskEncryption.
targets	DiskEncryptionTarget[]	Listan över diskmål som Batch Service krypterar på beräkningsnoden I Linux-poolen stöds endast "TemporaryDisk". i Windows-poolen måste "OsDisk" och "TemporaryDisk" anges.

DiskEncryptionSetParameters

Objekt

ARM-resurs-ID:t för diskkrypteringsuppsättningen.

Namn	Typ	Beskrivning
id	string (arm-id)	Resurs-id för diskens krypteringsuppsättning. ARM-resurs-ID:t för diskkrypteringsuppsättningen. Resursen ska finnas i samma prenumeration som batchkontot.

DiskEncryptionTarget

Uppräkning

Om det utelämnas krypteras inga diskar på beräkningsnoderna i poolen.

Värde	Beskrivning
OsDisk	OS-disken på beräkningsnoden är krypterad.
TemporaryDisk	Den tillfälliga disken på beräkningsnoden krypteras. I Linux gäller den här krypteringen för andra partitioner (till exempel de på monterade datadiskar) när kryptering sker vid start.

DynamicVNetAssignmentScope

Uppräkning

Omfånget för dynamisk vnet-tilldelning.

Värde	Beskrivning
none	Ingen dynamisk VNet-tilldelning är aktiverad.
job	Dynamisk VNet-tilldelning görs per jobb. Om det här värdet anges måste även nätverkskonfigurationens undernäts-ID anges. Den här funktionen kräver godkännande före användning. Kontakta supporten

ElevationLevel

Uppräkning

Användarens höjdnivå.

Värde	Beskrivning
NonAdmin	Användaren är en standardanvändare utan förhöjd åtkomst.
Admin	Användaren är en användare med förhöjd åtkomst och fungerar med fullständig administratörsbehörighet.

EnvironmentSetting

Objekt

En miljövariabel som ska anges i en uppgiftsprocess.

Namn	Typ	Beskrivning
name	string	Namnet på miljövariabeln. Namnet på miljövariabeln.
value	string	Värdet för miljövariabeln. Värdet för miljövariabeln.

FixedScaleSettings

Objekt

Inställningar för fast skalning för poolen.

Namn	Typ	Standardvärde	Beskrivning
nodeDeallocationOption	ComputeNodeDeallocationOption		Avgör vad du ska göra med en nod och dess aktiviteter som körs när den har valts för frigöring. Om det utelämnas är standardvärdet Requeue.
resizeTimeout	string (duration)	PT15M	Tidsgränsen för allokering av beräkningsnoder till poolen. Standardvärdet är 15 minuter. Tidsgränsvärden använder ISO 8601-format. Använd till exempel PT10M i 10 minuter. Minimivärdet är 5 minuter. Om du anger ett värde som är mindre än 5 minuter avvisar Batch-tjänsten begäran med ett fel. Om du anropar REST-API:et direkt är HTTP-statuskoden 400 (felaktig begäran).
targetDedicatedNodes	integer (int32)		Önskat antal dedikerade beräkningsnoder i poolen. Minst en av targetDedicatedNodes, targetLowPriorityNodes måste anges.
targetLowPriorityNodes	integer (int32)		Önskat antal beräkningsnoder med oanvänd kapacitet/låg prioritet i poolen. Minst en av targetDedicatedNodes, targetLowPriorityNodes måste anges.

HostEndpointSettings

Objekt

Anger specifika inställningar för värdslutpunkten.

Namn	Typ	Beskrivning
inVMAccessControlProfileReferenceId	string (arm-id)	Anger referensen till resurs-ID:t InVMAccessControlProfileVersion i form av /subscriptions/{SubscriptionId}/resourceGroups/{ResourceGroupName}/providers/Microsoft.Compute/galleries/{galleryName}/inVMAccessControlProfiles/{profile}/versions/{version}.
mode	HostEndpointSettingsModeTypes	Anger körningsläget för principen för åtkomstkontroll.

HostEndpointSettingsModeTypes

Uppräkning

Anger körningsläget för principen för åtkomstkontroll.

Värde	Beskrivning
Audit	I granskningsläge fungerar systemet som om det tillämpar åtkomstkontrollprincipen, inklusive att generera åtkomstnekande poster i loggarna, men det nekar faktiskt inte några begäranden om värdslutpunkter.
Enforce	Enforce-läget är det rekommenderade driftsläget och systemet kommer att upprätthålla åtkomstkontrollpolicyn. Denna egenskap kan inte användas tillsammans med 'inVMAccessControlProfileReferenceId'.

ImageReference

Objekt

En referens till en Azure Virtual Machines Marketplace-avbildning eller Azure Image-resursen för en anpassad virtuell dator. Information om hur du hämtar listan över alla imageReferences som verifierats av Azure Batch finns i åtgärden "List supported node agent SKU:er".

Namn	Typ	Beskrivning
communityGalleryImageId	string	Unik identifierare för communitygalleribilden Den här egenskapen är ömsesidigt uteslutande med andra egenskaper och kan hämtas från community gallery image GET-anrop.
id	string	ARM-resursidentifieraren för Azure Compute Gallery Image. Beräkningsnoder i poolen skapas med det här avbildnings-ID:t. Det här är formuläret /subscriptions/{subscriptionId}/resourceGroups/{resourceGroup}/providers/Microsoft.Compute/galleries/{galleryName}/images/{imageDefinitionName}/versions/{versionId}. Den här egenskapen är ömsesidigt uteslutande med andra egenskaper. Azure Compute Gallery Image måste ha repliker i samma region som Azure Batch-kontot. Information om brandväggsinställningarna för Batch-nodagenten som ska kommunicera med Batch-tjänsten finns i https://learn.microsoft.com/azure/batch/batch-api-basics#virtual-network-vnet-and-firewall-configuration.
offer	string	Erbjudandetypen för Azure Virtual Machines Marketplace-avbildningen. Till exempel UbuntuServer eller WindowsServer.
publisher	string	Utgivaren av Azure Virtual Machines Marketplace-avbildningen. Till exempel Canonical eller MicrosoftWindowsServer.
sharedGalleryImageId	string	Unik identifierare för den delade galleribilden Den här egenskapen är ömsesidigt uteslutande med andra egenskaper och kan hämtas från get-anropet för den delade galleribilden.
sku	string	SKU:n för Azure Virtual Machines Marketplace-avbildningen. Till exempel 18.04-LTS eller 2022-datacenter.
version	string	Versionen av Azure Virtual Machines Marketplace-avbildningen. Du kan ange värdet "senaste" för att välja den senaste versionen av en bild. Om det utelämnas är standardvärdet "senaste".

InboundEndpointProtocol

Uppräkning

Slutpunktens protokoll.

Värde	Beskrivning
TCP	Använd TCP för slutpunkten.
UDP	Använd UDP för slutpunkten.

InboundNatPool

Objekt

En inkommande NAT-pool som kan användas för att hantera specifika portar på beräkningsnoder i en Batch-pool externt.

Namn	Typ	Beskrivning
backendPort	integer (int32)	Portnumret på beräkningsnoden. Detta måste vara unikt i en Batch-pool. Godtagbara värden är mellan 1 och 65535 förutom 29876 och 29877 eftersom dessa är reserverade. Om några reserverade värden anges misslyckas begäran med HTTP-statuskod 400.
frontendPortRangeEnd	integer (int32)	Det sista portnumret i intervallet för externa portar som ska användas för att ge inkommande åtkomst till backendPort på enskilda beräkningsnoder. Acceptabla värden varierar mellan 1 och 65534 förutom portar från 50000 till 55000 som reserveras av Batch-tjänsten. Alla intervall i en pool måste vara distinkta och får inte överlappa varandra. Om några reserverade eller överlappande värden anges misslyckas begäran med HTTP-statuskod 400.
frontendPortRangeStart	integer (int32)	Det första portnumret i intervallet för externa portar som ska användas för att ge inkommande åtkomst till backendPort på enskilda beräkningsnoder. Godtagbara värden varierar mellan 1 och 65534 förutom portar från 50000 till 55000 som är reserverade. Alla intervall i en pool måste vara distinkta och får inte överlappa varandra. Om några reserverade eller överlappande värden anges misslyckas begäran med HTTP-statuskod 400.
name	string	Namnet på slutpunkten. Namnet måste vara unikt i en Batch-pool, kan innehålla bokstäver, siffror, understreck, punkter och bindestreck. Namn måste börja med en bokstav eller siffra, måste sluta med en bokstav, ett tal eller understreck och får inte överstiga 77 tecken. Om ogiltiga värden anges misslyckas begäran med HTTP-statuskod 400.
networkSecurityGroupRules	NetworkSecurityGroupRule[]	En lista över regler för nätverkssäkerhetsgrupper som ska tillämpas på slutpunkten. Det maximala antalet regler som kan anges för alla slutpunkter i en Batch-pool är 25. Om inga regler för nätverkssäkerhetsgrupper har angetts skapas en standardregel för att tillåta inkommande åtkomst till den angivna backendPort. Om det maximala antalet regler för nätverkssäkerhetsgrupper överskrids misslyckas begäran med HTTP-statuskod 400.
protocol	InboundEndpointProtocol	Slutpunktens protokoll. Slutpunktens protokoll.

InterNodeCommunicationState

Uppräkning

Detta medför begränsningar för vilka noder som kan tilldelas till poolen. Om du aktiverar det här värdet kan du minska risken för att det begärda antalet noder allokeras i poolen. Om det inte anges är det här värdet som standard inaktiverat.

Värde	Beskrivning
Enabled	Aktivera nätverkskommunikation mellan virtuella datorer.
Disabled	Inaktivera nätverkskommunikation mellan virtuella datorer.

IPAddressProvisioningType

Uppräkning

Etableringstypen för offentliga IP-adresser för Batch-poolen.

Värde	Beskrivning
BatchManaged	En offentlig IP-adress skapas och hanteras av Batch. Det kan finnas flera offentliga IP-adresser beroende på poolens storlek.
UserManaged	Offentliga IP-adresser tillhandahålls av användaren och används för att etablera beräkningsnoderna.
NoPublicIPAddresses	Ingen offentlig IP-adress skapas för beräkningsnoderna i poolen.

IPFamily

Uppräkning

IP-familjerna som används för att ange IP-versioner som är tillgängliga för poolen.

Värde	Beskrivning
IPv4	IPv4 är tillgängligt för poolen.
IPv6	IPv6 är tillgängligt för poolen.

IPTag

Objekt

Anger hur aktiviteter ska distribueras mellan beräkningsnoder.

Namn	Typ	Beskrivning
ipTagType	string	Typ av IP-tagg. Exempel: FirstPartyUsage.
tag	string	Värdet för IP-taggen som är associerad med den offentliga IP-adressen. Exempel: SQL.

JobDefaultOrder

Uppräkning

Ordningen för schemaläggning av uppgifter från olika jobb med samma prioritet.

Värde	Beskrivning
None	Uppgifter bör schemaläggas enhetligt från alla jobb med lika hög prioritet i poolen.
CreationTime	Om jobb har lika hög prioritet bör uppgifter från tidigare jobb schemaläggas först.

LinuxUserConfiguration

Objekt

Egenskaper som används för att skapa ett användarkonto på en Linux-nod.

Namn	Typ	Beskrivning
gid	integer (int32)	Grupp-ID för användarkontot. Egenskaperna uid och gid måste anges tillsammans eller inte alls. Om det inte anges väljer det underliggande operativsystemet gid.
sshPrivateKey	string (password)	Den privata SSH-nyckeln för användarkontot. Den privata nyckeln får inte vara lösenordsskyddad. Den privata nyckeln används för att automatiskt konfigurera asymmetrisk nyckelbaserad autentisering för SSH mellan noder i en Linux-pool när poolens enableInterNodeCommunication-egenskap är sann (den ignoreras om enableInterNodeCommunication är falskt). Det gör du genom att placera nyckelparet i användarens .ssh-katalog. Om det inte anges konfigureras inte lösenordsfri SSH mellan noder (ingen ändring av användarens .ssh-katalog görs).
uid	integer (int32)	Användarkontots användar-ID. Egenskaperna uid och gid måste anges tillsammans eller inte alls. Om det inte anges väljer det underliggande operativsystemet uid.

LoginMode

Uppräkning

Anger inloggningsläge för användaren. Standardvärdet är Interaktivt.

Värde	Beskrivning
Batch	Inloggningsläget LOGON32_LOGON_BATCH Win32. Batchinloggningsläget rekommenderas för långvariga parallella processer.
Interactive	Inloggningsläget LOGON32_LOGON_INTERACTIVE Win32. Vissa program kräver behörigheter som är associerade med det interaktiva inloggningsläget. Om detta är fallet för ett program som används i din uppgift rekommenderas det här alternativet.

ManagedDisk

Objekt

Parametrarna för hanterade diskar.

Namn	Typ	Beskrivning
diskEncryptionSet	DiskEncryptionSetParameters	Anger resurs-ID för kundhanterad diskkrypteringsuppsättning för den hanterade disken. Den kan endast ställas in i UserSubscription-läge.
securityProfile	VMDiskSecurityProfile	Anger säkerhetsprofilen för den hanterade disken. Anger säkerhetsprofilinställningarna för den hanterade disken. Obs: Det kan bara anges för konfidentiella virtuella datorer och krävs när du använder konfidentiella virtuella datorer.
storageAccountType	StorageAccountType	Lagringskontotypen som ska användas för att skapa datadiskar eller OS-diskar. Lagringskontotypen som ska användas för att skapa datadiskar eller OS-diskar.

MetadataItem

Objekt

Ett namn/värde-par som är associerat med en Batch-tjänstresurs.

Namn	Typ	Beskrivning
name	string	Namnet på metadataobjektet. Namnet på metadataobjektet.
value	string	Värdet för metadataobjektet. Värdet för metadataobjektet.

MountConfiguration

Objekt

Filsystemet som ska monteras på varje nod.

Namn	Typ	Beskrivning
azureBlobFileSystemConfiguration	AzureBlobFileSystemConfiguration	Azure Storage-containern som ska monteras med blob-FUSE på varje nod. Den här egenskapen är ömsesidigt uteslutande med alla andra egenskaper.
azureFileShareConfiguration	AzureFileShareConfiguration	Den Azure-filresurs som ska monteras på varje nod. Den här egenskapen är ömsesidigt uteslutande med alla andra egenskaper.
cifsMountConfiguration	CIFSMountConfiguration	CIFS/SMB-filsystemet som ska monteras på varje nod. Den här egenskapen är ömsesidigt uteslutande med alla andra egenskaper.
nfsMountConfiguration	NFSMountConfiguration	NFS-filsystemet som ska monteras på varje nod. Den här egenskapen är ömsesidigt uteslutande med alla andra egenskaper.

NetworkConfiguration

Objekt

Nätverkskonfigurationen för en pool.

Namn	Typ	Standardvärde	Beskrivning
dynamicVnetAssignmentScope	DynamicVNetAssignmentScope	none	Omfånget för dynamisk vnet-tilldelning. Omfånget för dynamisk vnet-tilldelning.
enableAcceleratedNetworking	boolean		Om den här poolen ska aktivera accelererat nätverk. Accelererat nätverk möjliggör enkel rot-I/O-virtualisering (SR-IOV) till en virtuell dator, vilket kan leda till bättre nätverksprestanda. Mer information finns i: https://learn.microsoft.com/azure/virtual-network/accelerated-networking-overview.
endpointConfiguration	PoolEndpointConfiguration		Konfigurationen för slutpunkter på beräkningsnoder i Batch-poolen. Slutpunktskonfigurationen för en pool.
publicIPAddressConfiguration	PublicIPAddressConfiguration		Den offentliga IPAddress-konfigurationen för beräkningsnoder i Batch-poolen. Den offentliga IP-adresskonfigurationen för nätverkskonfigurationen för en pool.
subnetId	string		ARM-resursidentifieraren för det virtuella nätverksundernätet som poolens beräkningsnoder ansluter till. Det här är formuläret /subscriptions/{subscription}/resourceGroups/{group}/providers/{provider}/virtualNetworks/{network}/subnets/{subnet}. Det virtuella nätverket måste finnas i samma region och prenumeration som Azure Batch-kontot. Det angivna undernätet bör ha tillräckligt med kostnadsfria IP-adresser för att hantera antalet noder i poolen. Om undernätet inte har tillräckligt med kostnadsfria IP-adresser allokerar poolen delvis beräkningsnoder och ett storleksändringsfel uppstår. Tjänstens huvudnamn för MicrosoftAzureBatch måste ha rollen "Klassisk virtuell datordeltagare" Role-Based åtkomstkontroll (RBAC) för det angivna virtuella nätverket. Det angivna undernätet måste tillåta kommunikation från Azure Batch-tjänsten för att kunna schemalägga uppgifter på beräkningsnoderna. Detta kan verifieras genom att kontrollera om det angivna virtuella nätverket har några associerade nätverkssäkerhetsgrupper (NSG). Om kommunikationen till beräkningsnoderna i det angivna undernätet nekas av en NSG anger Batch-tjänsten tillståndet för beräkningsnoderna till oanvändbar. Om det angivna virtuella nätverket har några associerade nätverkssäkerhetsgrupper (NSG) måste några reserverade systemportar aktiveras för inkommande kommunikation, inklusive portarna 29876 och 29877. Aktivera även utgående anslutningar till Azure Storage på port 443. Mer information finns i: https://learn.microsoft.com/azure/batch/batch-api-basics#virtual-network-vnet-and-firewall-configuration

NetworkSecurityGroupRule

Objekt

En regel för nätverkssäkerhetsgrupp som ska tillämpas på en inkommande slutpunkt.

Namn	Typ	Beskrivning
access	NetworkSecurityGroupRuleAccess	Den åtgärd som ska vidtas för en angiven IP-adress, undernätsintervall eller tagg. Den åtgärd som ska vidtas för en angiven IP-adress, undernätsintervall eller tagg.
priority	integer (int32)	Prioriteten för den här regeln. Prioriteringar i en pool måste vara unika och utvärderas i prioritetsordning. Desto lägre är talet, desto högre prioritet. Regler kan till exempel anges med ordernummer 150, 250 och 350. Regeln med ordernumret 150 har företräde framför regeln som har en ordning på 250. Tillåtna prioriteringar är mellan 150 och 4 096. Om några reserverade eller duplicerade värden anges misslyckas begäran med HTTP-statuskod 400.
sourceAddressPrefix	string	Källadressprefixet eller taggen som ska matchas för regeln. Giltiga värden är en enskild IP-adress (dvs. 10.10.10.10), IP-undernät (dvs. 192.168.1.0/24), standardtagg eller * (för alla adresser). Om andra värden anges misslyckas begäran med HTTP-statuskod 400.
sourcePortRanges	string[]	Källportintervallen som ska matchas för regeln. Giltiga värden är *( för alla portar 0–65535) eller matriser med portar eller portintervall (dvs. 100–200). Portarna ska ligga mellan 0 och 65535 och portintervallen eller portarna får inte överlappa varandra. Om andra värden anges misslyckas begäran med HTTP-statuskod 400. Standardvärdet är *.

NetworkSecurityGroupRuleAccess

Uppräkning

Den åtgärd som ska vidtas för en angiven IP-adress, undernätsintervall eller tagg.

Värde	Beskrivning
Allow	Tillåt åtkomst.
Deny	Neka åtkomst.

NFSMountConfiguration

Objekt

Information som används för att ansluta till ett NFS-filsystem.

Namn	Typ	Beskrivning
mountOptions	string	Ytterligare kommandoradsalternativ för att skicka till monteringskommandot. Det här är alternativ för "net use" i Windows och "monteringsalternativ" i Linux.
relativeMountPath	string	Den relativa sökvägen på beräkningsnoden där filsystemet ska monteras Alla filsystem monteras i förhållande till katalogen Batch-monteringar, som är tillgängliga via AZ_BATCH_NODE_MOUNTS_DIR miljövariabeln.
source	string	URI:n för filsystemet som ska monteras. URI:n för filsystemet som ska monteras.

NodePlacementConfiguration

Objekt

Nodplaceringskonfiguration för batchpooler.

Namn	Typ	Beskrivning
policy	NodePlacementPolicyType	Typ av nodplaceringspolicy på batchpooler. Allokeringsprincip som används av Batch Service för att etablera noderna. Om det inte anges använder Batch regionalprincipen.

NodePlacementPolicyType

Uppräkning

Standardvärdet är regionalt.

Värde	Beskrivning
Regional	Alla noder i poolen allokeras i samma region.
Zonal	Noder i poolen kommer att spridas över olika zoner med bästa möjliga balansering.

OSDisk

Objekt

Inställningar för den virtuella datorns operativsystemdisk.

Namn	Typ	Beskrivning
caching	CachingType	Typ av cachelagring som ska aktiveras för disken. Typ av cachelagring som ska aktiveras för disken.
diskSizeGB	integer (int32)	Den ursprungliga diskstorleken i GB när du skapar en ny OS-disk. Den ursprungliga diskstorleken i GB när du skapar en ny OS-disk.
ephemeralOSDiskSettings	DiffDiskSettings	Anger tillfälliga diskinställningar för den operativsystemdisk som används av den virtuella datorn. Anger tillfälliga diskinställningar för den operativsystemdisk som används av den virtuella datorn.
managedDisk	ManagedDisk	Parametrarna för hanterade diskar. Parametrarna för hanterade diskar.
writeAcceleratorEnabled	boolean	Anger om writeAccelerator ska aktiveras eller inaktiveras på disken. Anger om writeAccelerator ska aktiveras eller inaktiveras på disken.

Pool

Objekt

Innehåller information om en pool.

Namn	Typ	Standardvärde	Beskrivning
etag	string		ETag för resursen, som används för samtidighetsinstruktioner.
id	string (arm-id)		Fullständigt kvalificerat resurs-ID för resursen. Till exempel "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
identity	BatchPoolIdentity		Den typ av identitet som används för Batch-poolen.
name	string		Namnet på resursen
properties.allocationState	AllocationState		Om poolen ändrar storlek. Om poolen ändrar storlek.
properties.allocationStateTransitionTime	string (date-time)		Den tid då poolen övergick till det aktuella allokeringstillståndet. Den tid då poolen övergick till det aktuella allokeringstillståndet.
properties.applicationPackages	ApplicationPackageReference[]		Listan över programpaket som ska installeras på varje beräkningsnod i poolen. Ändringar i programpaketreferenser påverkar alla nya beräkningsnoder som ansluter till poolen, men påverkar inte beräkningsnoder som redan finns i poolen förrän de startas om eller omskapas. Det finns högst 10 programpaketreferenser i en viss pool.
properties.autoScaleRun	AutoScaleRun		Resultatet och felen från den senaste körningen av autoskalningsformeln. Den här egenskapen anges endast om poolen skalar automatiskt, dvs. autoScaleSettings används.
properties.creationTime	string (date-time)		Skapandetiden för poolen. Skapandetiden för poolen.
properties.currentDedicatedNodes	integer (int32)		Antalet dedikerade beräkningsnoder som för närvarande finns i poolen. Antalet dedikerade beräkningsnoder som för närvarande finns i poolen.
properties.currentLowPriorityNodes	integer (int32)		Antalet beräkningsnoder med oanvänd kapacitet/låg prioritet som för närvarande finns i poolen. Antalet beräkningsnoder med oanvänd kapacitet/låg prioritet som för närvarande finns i poolen.
properties.deploymentConfiguration	DeploymentConfiguration		Den här egenskapen beskriver de virtuella datorer som poolnoderna ska distribueras på. Egenskaper för distributionskonfiguration.
properties.displayName	string		Visningsnamnet för poolen. Visningsnamnet behöver inte vara unikt och kan innehålla unicode-tecken upp till en maximal längd på 1024.
properties.interNodeCommunication	InterNodeCommunicationState		Om poolen tillåter direkt kommunikation mellan noder. Detta medför begränsningar för vilka noder som kan tilldelas till poolen. Om du aktiverar det här värdet kan du minska risken för att det begärda antalet noder allokeras i poolen. Om det inte anges är det här värdet som standard inaktiverat.
properties.lastModified	string (date-time)		Den senaste ändrade tiden för poolen. Det här är sista gången data på poolnivå, till exempel targetDedicatedNodes eller autoScaleSettings, ändrades. Den tar inte hänsyn till ändringar på nodnivå, till exempel ett ändringstillstånd för beräkningsnoder.
properties.metadata	MetadataItem[]		En lista över namn/värde-par som är associerade med poolen som metadata. Batch-tjänsten tilldelar ingen betydelse för metadata. det är endast för användning av användarkod.
properties.mountConfiguration	MountConfiguration[]		En lista över filsystem som ska monteras på varje nod i poolen. Detta stöder Azure Files, NFS, CIFS/SMB och Blobfuse.
properties.networkConfiguration	NetworkConfiguration		Nätverkskonfigurationen för poolen. Nätverkskonfigurationen för en pool.
properties.provisioningState	PoolProvisioningState		Poolens aktuella tillstånd. Poolens aktuella tillstånd.
properties.provisioningStateTransitionTime	string (date-time)		Den tid då poolen övergick till sitt aktuella tillstånd. Den tid då poolen övergick till sitt aktuella tillstånd.
properties.resizeOperationStatus	ResizeOperationStatus		Innehåller information om den aktuella eller senast slutförda storleksändringsåtgärden. Beskriver antingen den aktuella åtgärden (om poolen AllocationState ändrar storlek) eller den tidigare slutförda åtgärden (om AllocationState är stabil).
properties.scaleSettings	ScaleSettings		Inställningar som konfigurerar antalet noder i poolen. Definierar poolens önskade storlek. Detta kan antingen vara "fixedScale" där det begärda targetDedicatedNodes har angetts, eller "autoskala" som definierar en formel som regelbundet omvärderas. Om den här egenskapen inte anges har poolen en fast skalning med 0 targetDedicatedNodes.
properties.startTask	StartTask		En uppgift som har angetts för att köras på varje beräkningsnod när den ansluter till poolen. I en PATCH-åtgärd (uppdatering) kan den här egenskapen anges till ett tomt objekt för att ta bort startaktiviteten från poolen.
properties.taskSchedulingPolicy	TaskSchedulingPolicy		Hur aktiviteter distribueras mellan beräkningsnoder i en pool. Om det inte anges är standardvärdet utspritt.
properties.taskSlotsPerNode	integer (int32)	1	Antalet aktivitetsfack som kan användas för att köra samtidiga uppgifter på en enda beräkningsnod i poolen. Standardvärdet är 1. Det maximala värdet är mindre än 4 gånger antalet kärnor i vmSize för poolen eller 256.
properties.upgradePolicy	UpgradePolicy		Uppgraderingsprincipen för poolen. Beskriver en uppgraderingsprincip – automatisk, manuell eller rullande.
properties.userAccounts	UserAccount[]		Listan över användarkonton som ska skapas på varje nod i poolen. Listan över användarkonton som ska skapas på varje nod i poolen.
properties.vmSize	string		Storleken på virtuella datorer i poolen. Alla virtuella datorer i en pool har samma storlek. Information om tillgängliga VM-storlekar finns i Storlekar för virtuella datorer i Azure (https://learn.microsoft.com/azure/virtual-machines/sizes/overview). Batch har stöd för alla storlekar på virtuella Azure-datorer förutom STANDARD_A0 och de med premiumlagring (STANDARD_GS, STANDARD_DS och STANDARD_DSV2-serien).
systemData	systemData		Azure Resource Manager-metadata som innehåller createdBy och modifiedBy information.
tags	object		Taggarna för resursen.
type	string		Resurstypen. Till exempel "Microsoft.Compute/virtualMachines" eller "Microsoft.Storage/storageAccounts"

PoolEndpointConfiguration

Objekt

Slutpunktskonfigurationen för en pool.

Namn	Typ	Beskrivning
inboundNatPools	InboundNatPool[]	En lista över inkommande NAT-pooler som kan användas för att hantera specifika portar på en enskild beräkningsnod externt. Det maximala antalet inkommande NAT-pooler per Batch-pool är 5. Om det maximala antalet inkommande NAT-pooler överskrids misslyckas begäran med HTTP-statuskod 400. Detta kan inte anges om IPAddressProvisioningType är NoPublicIPAddresses.

PoolIdentityType

Uppräkning

Den typ av identitet som används för Batch-poolen.

Värde	Beskrivning
UserAssigned	Batch-poolen har användartilldelade identiteter med sig.
None	Batch-poolen har ingen associerad identitet. Om du anger None i uppdateringspoolen tas befintliga identiteter bort.

PoolProvisioningState

Uppräkning

Poolens aktuella tillstånd.

Värde	Beskrivning
Succeeded	Poolen är tillgänglig för att köra uppgifter beroende på tillgängligheten för beräkningsnoder.
Deleting	Användaren har begärt att poolen ska tas bort, men borttagningsåtgärden har ännu inte slutförts.

ProxyAgentSettings

Objekt

Anger ProxyAgent-inställningar när den virtuella datorn skapas.

Namn	Typ	Beskrivning
enabled	boolean	Anger om funktionen Metadata Security Protocol ska vara aktiverad på den virtuella datorn eller VM-skalningsuppsättningen. Standardvärdet är False.
imds	HostEndpointSettings	Inställningar för IMDS-slutpunkten.
wireServer	HostEndpointSettings	Inställningar för WireServer-slutpunkten.

PublicIPAddressConfiguration

Objekt

Den offentliga IP-adresskonfigurationen för nätverkskonfigurationen för en pool.

Namn	Typ	Beskrivning
ipAddressIds	string[]	Listan över offentliga IP-adresser som Batch-tjänsten ska använda vid etablering av beräkningsnoder. Antalet IP-adresser som anges här begränsar den maximala storleken på poolen – 100 dedikerade noder eller 100 noder med oanvänd kapacitet/låg prioritet kan allokeras för varje offentlig IP-adress. En pool som behöver 250 dedikerade virtuella datorer skulle till exempel behöva minst 3 offentliga IP-adresser angivna. Varje element i den här samlingen är av formuläret : /subscriptions/{subscription}/resourceGroups/{group}/providers/Microsoft.Network/publicIPAddresses/{ip}.
ipFamilies	IPFamily[]	IP-familjerna som används för att ange IP-versioner som är tillgängliga för poolen. IP-familjer används för att fastställa pooler med en eller två stackar. För en stack är det förväntade värdet IPv4. För dubbla staplar är de förväntade värdena IPv4 och IPv6.
ipTags	IPTag[]	IP-taggar som kommer att tillämpas på nya publika IP-adresser som batch-skapar. IP-taggar som kommer att tillämpas på nya publika IP-adresser som batch-skapar.
provision	IPAddressProvisioningType	Etableringstypen för offentliga IP-adresser för Batch-poolen. Standardvärdet är BatchManaged

ResizeError

Objekt

Ett fel uppstod vid storleksändring av en pool.

Namn	Typ	Beskrivning
code	string	En identifierare för felet. Koder är invarianta och är avsedda att användas programmatiskt.
details	ResizeError[]	Ytterligare information om felet. Ytterligare information om felet.
message	string	Ett meddelande som beskriver felet, avsett att vara lämpligt för visning i ett användargränssnitt.

ResizeOperationStatus

Objekt

Information om den aktuella eller senast slutförda storleksändringsåtgärden.

Namn	Typ	Beskrivning
errors	ResizeError[]	Information om eventuella fel som påträffades när du utförde den senaste storleksändringen i poolen. Den här egenskapen anges endast om ett fel uppstod under den senaste poolens storleksändring och endast när poolallokeringenState är Stabil.
nodeDeallocationOption	ComputeNodeDeallocationOption	Avgör vad du ska göra med en nod och dess aktiviteter som körs när den har valts för frigöring. Standardvärdet skickas på nytt.
resizeTimeout	string (duration)	Tidsgränsen för allokering av beräkningsnoder till poolen eller borttagning av beräkningsnoder från poolen. Standardvärdet är 15 minuter. Minimivärdet är 5 minuter. Om du anger ett värde som är mindre än 5 minuter returnerar Batch-tjänsten ett fel. Om du anropar REST-API:et direkt är HTTP-statuskoden 400 (felaktig begäran).
startTime	string (date-time)	Tiden då den här storleksändringsåtgärden startades. Tiden då den här storleksändringsåtgärden startades.
targetDedicatedNodes	integer (int32)	Önskat antal dedikerade beräkningsnoder i poolen. Önskat antal dedikerade beräkningsnoder i poolen.
targetLowPriorityNodes	integer (int32)	Önskat antal beräkningsnoder med oanvänd kapacitet/låg prioritet i poolen. Önskat antal beräkningsnoder med oanvänd kapacitet/låg prioritet i poolen.

ResourceFile

Objekt

En enda fil eller flera filer som ska laddas ned till en beräkningsnod.

Namn	Typ	Beskrivning
autoStorageContainerName	string	Namnet på lagringscontainern i det automatiska lagringskontot. Egenskaperna autoStorageContainerName, storageContainerUrl och httpUrl är ömsesidigt uteslutande och en av dem måste anges.
blobPrefix	string	Blobprefixet som ska användas vid nedladdning av blobar från en Azure Storage-container. Endast de blobar vars namn börjar med det angivna prefixet laddas ned. Egenskapen är endast giltig när autoStorageContainerName eller storageContainerUrl används. Det här prefixet kan vara ett partiellt filnamn eller en underkatalog. Om inget prefix har angetts laddas alla filer i containern ned.
fileMode	string	Attributet för filbehörighetsläge i oktalt format. Den här egenskapen gäller endast filer som laddas ned till Linux-beräkningsnoder. Den ignoreras om den har angetts för en resourceFile som laddas ned till en Windows-nod. Om den här egenskapen inte har angetts för en Linux-nod tillämpas standardvärdet 0770 på filen.
filePath	string	Platsen på beräkningsnoden som filen ska laddas ned till i förhållande till aktivitetens arbetskatalog. Om egenskapen httpUrl har angetts krävs filePath och beskriver sökvägen som filen ska laddas ned till, inklusive filnamnet. Om egenskapen autoStorageContainerName eller storageContainerUrl har angetts är filePath valfritt och är den katalog som filerna ska laddas ned till. Om filePath används som en katalog behålls alla katalogstrukturer som redan är associerade med indata i sin helhet och läggs till i den angivna filePath-katalogen. Den angivna relativa sökvägen kan inte bryta sig ut ur aktivitetens arbetskatalog (till exempel med hjälp av ..).
httpUrl	string	URL:en för filen som ska laddas ned. Egenskaperna autoStorageContainerName, storageContainerUrl och httpUrl är ömsesidigt uteslutande och en av dem måste anges. Om URL:en pekar på Azure Blob Storage måste den vara läsbar från beräkningsnoder. Det finns tre sätt att hämta en sådan URL för en blob i Azure Storage: inkludera en signatur för delad åtkomst (SAS) som beviljar läsbehörigheter för blobben, använda en hanterad identitet med läsbehörighet eller ange ACL för blobben eller dess container för att tillåta offentlig åtkomst.
identityReference	ComputeNodeIdentityReference	Referensen till den användartilldelade identitet som ska användas för åtkomst till Azure Blob Storage som anges av storageContainerUrl eller httpUrl Referensen till en användartilldelad identitet som är associerad med Batch-poolen som en beräkningsnod ska använda.
storageContainerUrl	string	URL:en för blobcontainern i Azure Blob Storage. Egenskaperna autoStorageContainerName, storageContainerUrl och httpUrl är ömsesidigt uteslutande och en av dem måste anges. Den här URL:en måste vara läsbar och listbar från beräkningsnoder. Det finns tre sätt att hämta en sådan URL för en container i Azure Storage: inkludera en signatur för delad åtkomst (SAS) som beviljar läs- och listbehörigheter för containern, använder en hanterad identitet med läs- och listbehörigheter eller anger ACL för containern för att tillåta offentlig åtkomst.

RollingUpgradePolicy

Objekt

De konfigurationsparametrar som används vid löpande uppgradering.

Namn	Typ	Beskrivning
enableCrossZoneUpgrade	boolean	Tillåt ATT VMSS ignorerar AZ-gränser när du skapar uppgraderingsbatch. Ta hänsyn till uppdateringsdomänen och maxBatchInstancePercent för att fastställa batchstorleken. Om det här fältet inte har angetts kommer Azure Azure Batch inte att ange sitt standardvärde. Värdet för enableCrossZoneUpgrade på den skapade VirtualMachineScaleSet bestäms av standardkonfigurationerna på VirtualMachineScaleSet. Det här fältet kan endast anges till sant eller falskt när nodePlacementConfiguration används som zonindelning.
maxBatchInstancePercent	integer (int32) minimum: 5 maximum: 100	Den maximala procentandelen av de totala virtuella datorinstanserna som uppgraderas samtidigt av den löpande uppgraderingen i en batch. Eftersom detta är ett maximalt antal felaktiga instanser i tidigare eller framtida batchar kan procentandelen instanser i en batch minska för att säkerställa högre tillförlitlighet. Värdet för det här fältet ska vara mellan 5 och 100, inklusive. Om både maxBatchInstancePercent och maxUnhealthyInstancePercent tilldelas med värde bör värdet för maxBatchInstancePercent inte vara mer än maxUnhealthyInstancePercent.
maxUnhealthyInstancePercent	integer (int32) minimum: 5 maximum: 100	Den maximala procentandelen av de totala virtuella datorinstanserna i skalningsuppsättningen som kan vara felfritt samtidigt, antingen till följd av uppgraderingen eller genom att hittas i ett feltillstånd av hälsokontrollerna för den virtuella datorn innan den löpande uppgraderingen avbryts. Den här begränsningen kontrolleras innan någon batch startas. Värdet för det här fältet ska vara mellan 5 och 100, inklusive. Om både maxBatchInstancePercent och maxUnhealthyInstancePercent tilldelas med värde bör värdet för maxBatchInstancePercent inte vara mer än maxUnhealthyInstancePercent.
maxUnhealthyUpgradedInstancePercent	integer (int32) minimum: 0 maximum: 100	Den maximala procentandelen uppgraderade virtuella datorinstanser som kan konstateras vara i ett feltillstånd. Den här kontrollen sker när varje batch har uppgraderats. Om den här procentandelen någonsin överskrids avbryts den löpande uppdateringen. Värdet för det här fältet ska vara mellan 0 och 100, inklusive.
pauseTimeBetweenBatches	string	Väntetiden mellan att slutföra uppdateringen för alla virtuella datorer i en batch och starta nästa batch. Varaktigheten ska anges i ISO 8601-format.
prioritizeUnhealthyInstances	boolean	Uppgradera alla instanser med feltillstånd i en skalningsuppsättning före eventuella felfria instanser.
rollbackFailedInstancesOnPolicyBreach	boolean	Återställningen misslyckades för instanser till en tidigare modell om principen för löpande uppgradering överträds.

ScaleSettings

Objekt

Skalningsinställningar för poolen

Namn	Typ	Beskrivning
autoScale	AutoScaleSettings	Autoskalningsinställningar för poolen. Den här egenskapen och fixedScale är ömsesidigt uteslutande och en av egenskaperna måste anges.
fixedScale	FixedScaleSettings	Inställningar för fast skalning för poolen. Den här egenskapen och autoskalan är ömsesidigt uteslutande och en av egenskaperna måste anges.

SecurityEncryptionTypes

Uppräkning

Anger EncryptionType för den hanterade disken. Den är inställd på DiskWithVMGuestState för kryptering av den hanterade disken tillsammans med VMGuestState-blobben, VMGuestStateOnly för kryptering av endast VMGuestState-blobben, och NonPersistedTPM för att inte behålla firmware-tillståndet i VMGuestState-blobben. Obs: Det kan endast anges för konfidentiella virtuella datorer och krävs när du använder konfidentiella virtuella datorer.

Värde	Beskrivning
NonPersistedTPM	EncryptionType för den hanterade disken är inställd på NonPersistedTPM för att inte bevara tillståndet för inbyggd programvara i VMGuestState-bloben.
VMGuestStateOnly	EncryptionType för den hanterade disken är inställd på VMGuestStateOnly för kryptering av bara VMGuestState-bloben.
DiskWithVMGuestState	EncryptionType för den hanterade disken är inställd på DiskWithVMGuestState för kryptering av den hanterade disken tillsammans med VMGuestState-bloben. Det stöds inte i datadiskar.

SecurityProfile

Objekt

Anger säkerhetsprofilinställningarna för den virtuella datorn eller vm-skalningsuppsättningen.

Namn	Typ	Beskrivning
encryptionAtHost	boolean	Den här egenskapen kan användas av användaren i begäran för att aktivera eller inaktivera värdkryptering för den virtuella datorn eller vm-skalningsuppsättningen. Detta aktiverar krypteringen för alla diskar, inklusive resurs/temp-disk på själva värden.
proxyAgentSettings	ProxyAgentSettings	Anger ProxyAgent-inställningar när den virtuella datorn skapas.
securityType	SecurityTypes	Anger SecurityType för den virtuella datorn. Det måste anges till ett angivet värde för att aktivera UefiSettings. Anger SecurityType för den virtuella datorn. Det måste anges till ett angivet värde för att aktivera UefiSettings.
uefiSettings	UefiSettings	Anger de säkerhetsinställningar som säker start och vTPM som används när den virtuella datorn skapas. Anger de säkerhetsinställningar som säker start och vTPM som används när den virtuella datorn skapas.

SecurityTypes

Uppräkning

Anger SecurityType för den virtuella datorn. Det måste anges till ett angivet värde för att aktivera UefiSettings.

Värde	Beskrivning
trustedLaunch	Betrodd start skyddar mot avancerade och beständiga attacktekniker.
confidentialVM	Konfidentiell databehandling i Azure erbjuder konfidentiella virtuella datorer för klienter med höga krav på säkerhet och konfidentialitet. Dessa virtuella datorer tillhandahåller en stark, maskinvarubaserad gräns som hjälper dig att uppfylla dina säkerhetsbehov. Du kan använda konfidentiella virtuella datorer för migreringar utan att göra ändringar i koden, där plattformen skyddar den virtuella datorns tillstånd från att läsas eller ändras.

ServiceArtifactReference

Objekt

Anger tjänstartefaktreferens-ID:t som används för att ange samma avbildningsversion för alla virtuella datorer i skalningsuppsättningen när du använder den senaste avbildningsversionen.

Namn	Typ	Beskrivning
id	string	Tjänstartefaktens referens-ID för ServiceArtifactReference Referens-ID för tjänstartefakt i form av /subscriptions/{subscriptionId}/resourceGroups/{resourceGroup}/providers/Microsoft.Compute/galleries/{galleryName}/serviceArtifacts/{serviceArtifactName}/vmArtifactsProfiles/{vmArtifactsProfilesName}

StartTask

Objekt

En uppgift som körs när en beräkningsnod ansluter till en pool i Azure Batch-tjänsten, eller när beräkningsnoden startas om eller omskapas.

Namn	Typ	Standardvärde	Beskrivning
commandLine	string		Kommandoraden för startaktiviteten. Kommandoraden körs inte under ett gränssnitt och kan därför inte dra nytta av gränssnittsfunktioner som miljövariabelexpansion. Om du vill dra nytta av sådana funktioner bör du anropa gränssnittet på kommandoraden, till exempel med hjälp av "cmd /c MyCommand" i Windows eller "/bin/sh -c MyCommand" i Linux. Krävs om några andra egenskaper för startTask anges.
containerSettings	TaskContainerSettings		Inställningarna för containern under vilken startaktiviteten körs. När detta anges mappas alla kataloger rekursivt under AZ_BATCH_NODE_ROOT_DIR (roten för Azure Batch-kataloger på noden) till containern, alla aktivitetsmiljövariabler mappas till containern och aktivitetskommandoraden körs i containern.
environmentSettings	EnvironmentSetting[]		En lista över miljövariabelinställningar för startaktiviteten. En lista över miljövariabelinställningar för startaktiviteten.
maxTaskRetryCount	integer (int32)	0	Det maximala antalet gånger som aktiviteten kan försökas igen. Batch-tjänsten försöker utföra en aktivitet igen om dess slutkod inte är noll. Observera att det här värdet specifikt styr antalet återförsök. Batch-tjänsten provar uppgiften en gång och kan sedan försöka upp till den här gränsen igen. Om det maximala antalet återförsök till exempel är 3, försöker Batch aktiviteten upp till 4 gånger (ett första försök och 3 återförsök). Om det maximala antalet återförsök är 0 försöker inte Batch-tjänsten uppgiften igen. Om det maximala antalet återförsök är -1, försöker Batch-tjänsten uppgiften utan begränsning. Standardvärdet är 0
resourceFiles	ResourceFile[]		En lista över filer som Batch-tjänsten laddar ned till beräkningsnoden innan kommandoraden körs. En lista över filer som Batch-tjänsten laddar ned till beräkningsnoden innan kommandoraden körs.
userIdentity	UserIdentity		Användaridentiteten som startaktiviteten körs under. Om den utelämnas körs aktiviteten som en icke-administrativ användare som är unik för aktiviteten.
waitForSuccess	boolean		Om Batch-tjänsten ska vänta tills startaktiviteten har slutförts (d.v.s. avsluta med slutkod 0) innan du schemalägger några aktiviteter på beräkningsnoden. Om sant och startaktiviteten misslyckas på en beräkningsnod, försöker Batch-tjänsten starta aktiviteten igen upp till maximalt antal återförsök (maxTaskRetryCount). Om aktiviteten fortfarande inte har slutförts efter alla återförsök markerar Batch-tjänsten beräkningsnoden oanvändbar och schemalägger inte aktiviteter till den. Det här villkoret kan identifieras via nodtillståndet och schemaläggningsfelinformationen. Om det är falskt väntar inte Batch-tjänsten på att startaktiviteten ska slutföras. I det här fallet kan andra aktiviteter börja köras på beräkningsnoden medan startaktiviteten fortfarande körs. och även om startaktiviteten misslyckas fortsätter nya aktiviteter att schemaläggas på noden. Standardvärdet är sant.

StorageAccountType

Uppräkning

Lagringskontotypen som ska användas för att skapa datadiskar eller OS-diskar.

Värde	Beskrivning
Standard_LRS	Datadisken/OS-disken bör använda lokalt redundant standardlagring.
Premium_LRS	Datadisken/OS-disken bör använda premium lokalt redundant lagring.
StandardSSD_LRS	Datadisken/OS-disken ska använda standardlagring med lokalt redundant SSD.

systemData

Objekt

Metadata som rör skapande och senaste ändring av resursen.

Namn	Typ	Beskrivning
createdAt	string (date-time)	Tidsstämpeln för resursskapande (UTC).
createdBy	string	Identiteten som skapade resursen.
createdByType	createdByType	Den typ av identitet som skapade resursen.
lastModifiedAt	string (date-time)	Tidsstämpeln för senaste ändring av resurs (UTC)
lastModifiedBy	string	Identiteten som senast ändrade resursen.
lastModifiedByType	createdByType	Den typ av identitet som senast ändrade resursen.

TaskContainerSettings

Objekt

Containerinställningarna för en uppgift.

Namn	Typ	Beskrivning
containerHostBatchBindMounts	ContainerHostBatchBindMountEntry[]	Sökvägarna som du vill montera på containeraktiviteten. Om den här matrisen är null eller inte finns monterar containeraktiviteten hela den tillfälliga diskenheten i Windows (eller AZ_BATCH_NODE_ROOT_DIR i Linux). Den monterar inga datasökvägar i containern om den här matrisen har angetts som tom.
containerRunOptions	string	Ytterligare alternativ för kommandot container create. Dessa ytterligare alternativ anges som argument till kommandot "docker create", utöver de som styrs av Batch-tjänsten.
imageName	string	Avbildningen som ska användas för att skapa containern där uppgiften ska köras. Det här är den fullständiga avbildningsreferensen, som skulle anges till "docker pull". Om ingen tagg anges som en del av avbildningsnamnet används taggen ":latest" som standard.
registry	ContainerRegistry	Det privata registret som innehåller containeravbildningen. Den här inställningen kan utelämnas om den redan angavs när poolen skapades.
workingDirectory	ContainerWorkingDirectory	En flagga som anger var containeruppgiftens arbetskatalog finns. Standardvärdet är "taskWorkingDirectory". En flagga som anger var containeruppgiftens arbetskatalog finns. Standardvärdet är "taskWorkingDirectory".

TaskSchedulingPolicy

Objekt

Anger hur aktiviteter ska distribueras mellan beräkningsnoder.

Namn	Typ	Standardvärde	Beskrivning
jobDefaultOrder	JobDefaultOrder		Om inget anges är standardvärdet none. Ordningen för schemaläggning av uppgifter från olika jobb med samma prioritet.
nodeFillType	ComputeNodeFillType	Spread	Hur aktiviteter ska distribueras mellan beräkningsnoder. Hur aktiviteter ska distribueras mellan beräkningsnoder.

UefiSettings

Objekt

Anger de säkerhetsinställningar som säker start och vTPM som används när den virtuella datorn skapas.

Namn	Typ	Beskrivning
secureBootEnabled	boolean	Anger om säker start ska aktiveras på den virtuella datorn.
vTpmEnabled	boolean	Anger om vTPM ska aktiveras på den virtuella datorn.

UpgradeMode

Uppräkning

Anger läget för en uppgradering till virtuella datorer i skalningsuppsättningen.

Möjliga värden är:

Manuell – Du styr programmet för uppdateringar av virtuella datorer i skalningsuppsättningen. Du gör detta med hjälp av åtgärden manualUpgrade.

Automatisk – Alla virtuella datorer i skalningsuppsättningen uppdateras automatiskt samtidigt.

Rullande – Skalningsuppsättningen utför uppdateringar i batchar med en valfri paustid däremellan.

Värde	Beskrivning
automatic	Alla virtuella datorer i skalningsuppsättningen uppdateras automatiskt samtidigt.
manual	Du styr programmet för uppdateringar av virtuella datorer i skalningsuppsättningen. Du gör detta med hjälp av åtgärden manualUpgrade.
rolling	De befintliga instanserna i en skalningsuppsättning tas ned i batchar som ska uppgraderas. När den uppgraderade batchen är klar börjar instanserna ta trafik igen och nästa batch börjar. Detta fortsätter tills alla instanser har up-to-date.

UpgradePolicy

Objekt

Beskriver en uppgraderingsprincip – automatisk, manuell eller rullande.

Namn	Typ	Beskrivning
automaticOSUpgradePolicy	AutomaticOSUpgradePolicy	Konfigurationsparametrar som används för att utföra automatisk operativsystemuppgradering. De konfigurationsparametrar som används för att utföra automatisk operativsystemuppgradering.
mode	UpgradeMode	Anger läget för en uppgradering till virtuella datorer i skalningsuppsättningen. Möjliga värden är: Manuell – Du styr programmet för uppdateringar av virtuella datorer i skalningsuppsättningen. Du gör detta med hjälp av åtgärden manualUpgrade. Automatisk – Alla virtuella datorer i skalningsuppsättningen uppdateras automatiskt samtidigt. Rullande – Skalningsuppsättningen utför uppdateringar i batchar med en valfri paustid däremellan. Anger läget för en uppgradering till virtuella datorer i skalningsuppsättningen. Möjliga värden är: Manuell – Du styr programmet för uppdateringar av virtuella datorer i skalningsuppsättningen. Du gör detta med hjälp av åtgärden manualUpgrade. Automatisk – Alla virtuella datorer i skalningsuppsättningen uppdateras automatiskt samtidigt. Rullande – Skalningsuppsättningen utför uppdateringar i batchar med en valfri paustid däremellan.
rollingUpgradePolicy	RollingUpgradePolicy	De konfigurationsparametrar som används vid löpande uppgradering. De konfigurationsparametrar som används vid löpande uppgradering.

UserAccount

Objekt

Egenskaper som används för att skapa en användare på en Azure Batch-nod.

Namn	Typ	Beskrivning
elevationLevel	ElevationLevel	Användarens höjdnivå. nonAdmin – Den automatiska användaren är en standardanvändare utan förhöjd åtkomst. admin – Den automatiska användaren är en användare med förhöjd åtkomst och fungerar med fullständig administratörsbehörighet. Standardvärdet är nonAdmin.
linuxUserConfiguration	LinuxUserConfiguration	Den Linux-specifika användarkonfigurationen för användarkontot. Den här egenskapen ignoreras om den anges i en Windows-pool. Om det inte anges skapas användaren med standardalternativen.
name	string	Namnet på användarkontot. Namn kan innehålla alla Unicode-tecken upp till en maximal längd på 20. Namnet på användarkontot. Namn kan innehålla alla Unicode-tecken upp till en maximal längd på 20.
password	string (password)	Lösenordet för användarkontot. Lösenordet för användarkontot.
windowsUserConfiguration	WindowsUserConfiguration	Den Windows-specifika användarkonfigurationen för användarkontot. Den här egenskapen kan bara anges om användaren finns i en Windows-pool. Om det inte anges och i en Windows-pool skapas användaren med standardalternativen.

UserAssignedIdentities

Objekt

Listan över associerade användaridentiteter.

Namn	Typ	Beskrivning
clientId	string	Klient-ID för användartilldelad identitet.
principalId	string	Huvud-ID för användartilldelad identitet.

UserIdentity

Objekt

Definitionen av användaridentiteten under vilken uppgiften körs.

Namn	Typ	Beskrivning
autoUser	AutoUserSpecification	Den automatiska användare under vilken aktiviteten körs. Egenskaperna userName och autoUser är ömsesidigt uteslutande. du måste ange en men inte båda.
userName	string	Namnet på den användaridentitet som aktiviteten körs under. Egenskaperna userName och autoUser är ömsesidigt uteslutande. du måste ange en men inte båda.

VirtualMachineConfiguration

Objekt

Konfigurationen för beräkningsnoder i en pool baserat på Azure Virtual Machines-infrastrukturen.

Namn	Typ	Beskrivning
containerConfiguration	ContainerConfiguration	Containerkonfigurationen för poolen. Om det anges utförs konfigurationen på varje nod i poolen så att aktiviteter kan köras i containrar. Alla vanliga uppgifter och jobbhanteraraktiviteter som körs i den här poolen måste ange egenskapen containerSettings och alla andra uppgifter kan ange den.
dataDisks	DataDisk[]	Konfigurationen för datadiskar som är anslutna till beräkningsnoderna i poolen. Den här egenskapen måste anges om beräkningsnoderna i poolen måste ha tomma datadiskar kopplade till sig.
diskEncryptionConfiguration	DiskEncryptionConfiguration	Diskkrypteringskonfigurationen för poolen. Om det anges utförs kryptering på varje nod i poolen under nodetablering.
extensions	VMExtension[]	Tillägget för den virtuella datorn för poolen. Om det anges installeras tilläggen som nämns i den här konfigurationen på varje nod.
imageReference	ImageReference	En referens till Azure Virtual Machines Marketplace-avbildningen eller den anpassade virtual machine-avbildningen som ska användas. En referens till en Azure Virtual Machines Marketplace-avbildning eller Azure Image-resursen för en anpassad virtuell dator. Information om hur du hämtar listan över alla imageReferences som verifierats av Azure Batch finns i åtgärden "List supported node agent SKU:er".
licenseType	string	Den typ av lokal licens som ska användas vid distribution av operativsystemet. Detta gäller endast för avbildningar som innehåller Windows-operativsystemet och bör endast användas när du har giltiga lokala licenser för noderna som ska distribueras. Om det utelämnas tillämpas ingen lokal licensrabatt. Värden är: Windows_Server – Den lokala licensen gäller för Windows Server. Windows_Client – Den lokala licensen gäller för Windows-klienten.
nodeAgentSkuId	string	SKU:n för Batch-nodagenten som ska etableras på beräkningsnoder i poolen. Batch-nodagenten är ett program som körs på varje nod i poolen och tillhandahåller kommando- och kontrollgränssnittet mellan noden och Batch-tjänsten. Det finns olika implementeringar av nodagenten, så kallade SKU:er, för olika operativsystem. Du måste ange en nodagent-SKU som matchar den valda bildreferensen. Information om hur du hämtar listan över nodagent-SKU:er som stöds tillsammans med deras lista över verifierade bildreferenser finns i åtgärden "List supported node agent SKU:er".
nodePlacementConfiguration	NodePlacementConfiguration	Nodplaceringskonfigurationen för poolen. Den här konfigurationen anger regler för hur noder i poolen ska allokeras fysiskt.
osDisk	OSDisk	Inställningar för den virtuella datorns operativsystemdisk. Innehåller konfiguration för tillfälliga OSDisk-inställningar.
securityProfile	SecurityProfile	Anger säkerhetsprofilinställningarna för den virtuella datorn eller vm-skalningsuppsättningen. Anger säkerhetsprofilinställningarna för den virtuella datorn eller vm-skalningsuppsättningen.
serviceArtifactReference	ServiceArtifactReference	Anger tjänstartefaktreferens-ID:t som används för att ange samma avbildningsversion för alla virtuella datorer i skalningsuppsättningen när du använder den senaste avbildningsversionen. Referens-ID för tjänstartefakt i form av /subscriptions/{subscriptionId}/resourceGroups/{resourceGroup}/providers/Microsoft.Compute/galleries/{galleryName}/serviceArtifacts/{serviceArtifactName}/vmArtifactsProfiles/{vmArtifactsProfilesName}
windowsConfiguration	WindowsConfiguration	Inställningar för Windows-operativsystem på den virtuella datorn. Den här egenskapen får inte anges om imageReference anger en Linux OS-avbildning.

VMDiskSecurityProfile

Objekt

Anger säkerhetsprofilinställningarna för den hanterade disken. Obs: Det kan bara anges för konfidentiella virtuella datorer och krävs när du använder konfidentiella virtuella datorer.

Namn	Typ	Beskrivning
diskEncryptionSet	DiskEncryptionSetParameters	Anger resurs-ID för kundhanterad diskkrypteringsuppsättning för den hanterade disk som används för customer managed key encrypted ConfidentialVM OS Disk och VMGuest blob. Den kan endast ställas in i UserSubscription-läge.
securityEncryptionType	SecurityEncryptionTypes	Anger EncryptionType för den hanterade disken. Den är inställd på VMGuestStateOnly för kryptering av bara VMGuestState-bloben och NonPersistedTPM för att inte bevara tillståndet för inbyggd programvara i VMGuestState-bloben. Obs: Det kan endast anges för konfidentiella virtuella datorer och krävs när du använder konfidentiella virtuella datorer. Anger EncryptionType för den hanterade disken. Den är inställd på VMGuestStateOnly för kryptering av bara VMGuestState-bloben och NonPersistedTPM för att inte bevara tillståndet för inbyggd programvara i VMGuestState-bloben. Obs: Det kan endast anges för konfidentiella virtuella datorer och krävs när du använder konfidentiella virtuella datorer.

VMExtension

Objekt

Konfigurationen för tillägg för virtuella datorer.

Namn	Typ	Beskrivning
autoUpgradeMinorVersion	boolean	Anger om tillägget ska använda en nyare delversion om en är tillgänglig vid distributionstillfället. När tillägget har distribuerats uppgraderas dock inte mindre versioner om de inte distribueras om, även med den här egenskapen inställd på true.
enableAutomaticUpgrade	boolean	Anger om tillägget ska uppgraderas automatiskt av plattformen om det finns en nyare version av tillägget tillgängligt.
name	string	Namnet på tillägget för den virtuella datorn. Namnet på tillägget för den virtuella datorn.
protectedSettings		Tillägget kan innehålla antingen protectedSettings eller protectedSettingsFromKeyVault eller inga skyddade inställningar alls.
provisionAfterExtensions	string[]	Samlingen med tilläggsnamn. Samling tilläggsnamn varefter tillägget måste etableras.
publisher	string	Namnet på tilläggshanterarens utgivare. Namnet på tilläggshanterarens utgivare.
settings		JSON-formaterade offentliga inställningar för tillägget. JSON-formaterade offentliga inställningar för tillägget.
type	string	Typ av tillägg. Typ av tillägg.
typeHandlerVersion	string	Versionen av skripthanteraren. Versionen av skripthanteraren.

WindowsConfiguration

Objekt

Inställningar för Windows-operativsystem som ska tillämpas på den virtuella datorn.

Namn	Typ	Beskrivning
enableAutomaticUpdates	boolean	Om automatiska uppdateringar är aktiverade på den virtuella datorn. Om det utelämnas är standardvärdet sant.

WindowsUserConfiguration

Objekt

Egenskaper som används för att skapa ett användarkonto på en Windows-nod.

Namn	Typ	Beskrivning
loginMode	LoginMode	Inloggningsläge för användare Anger inloggningsläge för användaren. Standardvärdet är Interaktivt.