Batch Management REST API Versioning

Operations provided by the Batch Management REST API may have multiple versions for backwards compatibility as the API evolves over time. You must specify which version of an operation you wish to use when it is called by providing the version with your REST call. If your application calls an older version of an operation, you can choose to continue calling the older version, or modify your code to call a newer version. If the version is not specified or an incorrect version is specified, then an error is returned.

To specify which version of an operation to use, set the api-version query parameter. The version is of the format YYYY-MM-DD.

Latest version: 2025-06-01

• Job level FIFO

  • Added JobDefaultOrder type.
  • Extended TaskSchedulingPolicy with a new jobDefaultOrder property to support job-level FIFO scheduling.

• CMK support on Pools

  • Added DiskCustomerManagedKey for customer-managed key (CMK) support on pools.
  • Extended DiskEncryptionConfiguration with a new customerManagedKey property.
  • Extended ManagedDisk with a new diskEncryptionSet property.
  • Added DiskEncryptionSetParameters for referencing disk encryption sets.

• IPv6 support on Pools

  • Added IPFamily type.
  • Extended PublicIPAddressConfiguration with new ipFamilies and ipTags properties.

• Metadata Security Protocol Support on Pools

  • Added HostEndpointSettings and HostEndpointSettingsModeTypes.
  • Added ProxyAgentSettings.
  • Extended SecurityProfile with a new proxyAgentSettings property for metadata security protocol support.

• IP Tag Support

  • Added IPTag type.
  • Extended PublicIPAddressConfiguration with new ipTags property for IP tag support.

• [Breaking] Removed Support for Certificates:

  • Removed Certificate APIs: Certificate_ListByBatchAccount, Certificate_Get, Certificate_Create, Certificate_Update, Certificate_Delete, and Certificate_CancelDeletion.
  • Removed Certificate Models: Certificate, CertificateCreateOrUpdateParameters, CertificateBaseProperties, CertificateCreateOrUpdateProperties, CertificateProperties, CertificateFormat, CertificateProvisioningState, CertificateReference, CertificateStoreLocation, CertificateVisibility, and DeleteCertificateError.
  • Removed certificates property from Pool.

• [Breaking] Removed NodeCommunicationMode model and properties targetNodeCommunicationMode and currentNodeCommunicationMode from Pool.

• [Breaking] Removed applicationLicenses property from Pool.

• [Breaking] Removed storageAccountType from DataDisk. Use ManagedDisk.storageAccountType instead.

• [Breaking] Removed resourceTags from Pool.

Previous Versions

Previous versions include:

• 2024-07-01
• 2024-02-01
• 2023-11-01
• 2023-05-01
• 2022-10-01
• 2022-06-01
• 2022-01-01
• 2021-06-01
• 2021-01-01
• 2020-09-01
• 2020-05-01
• 2020-03-01
• 2019-08-01
• 2019-04-01
• 2018-12-01
• 2017-09-01
• 2017-05-01
• 2017-01-01
• 2015-12-01

Version: 2024-07-01

• Added Network Security Perimeter (NSP) support:

  • Added NetworkSecurityPerimeter_ListConfigurations operation to list all NSP configurations in a Batch account.
  • Added NetworkSecurityPerimeter_GetConfiguration operation to get a specific NSP configuration.
  • Added NetworkSecurityPerimeter_ReconcileConfiguration operation to reconcile an NSP configuration.
  • Added SecuredByPerimeter value to PublicNetworkAccessType enum.

• Added Confidential VM support:

  • Added VMDiskSecurityProfile model with a securityEncryptionType property.
  • Added securityProfile property to ManagedDisk.
  • Added confidentialVM as a new value for SecurityTypes enum.

• Added Shared Gallery and Community Gallery image reference support:

  • Added sharedGalleryImageId and communityGalleryImageId properties to ImageReference.

• Added container bind mount support for tasks:

  • Added ContainerHostBatchBindMountEntry model with source and isReadOnly properties.
  • Added ContainerHostDataPath enum with values Shared, Startup, VfsMounts, Task, JobPrep, and Applications.
  • Added containerHostBatchBindMounts property to TaskContainerSettings.

• [Breaking] Removed Cloud Service Configuration pool support:

  • Removed CloudServiceConfiguration model.
  • Removed cloudServiceConfiguration property from DeploymentConfiguration.
  • Removed Location_ListSupportedCloudServiceSkus operation.

Version: 2024-02-01

• Added OS upgrade policy support for VM pools:

  • Added UpgradePolicy model with properties mode, automaticOSUpgradePolicy, and rollingUpgradePolicy.
  • Added AutomaticOSUpgradePolicy model with properties disableAutomaticRollback, enableAutomaticOSUpgrade, useRollingUpgradePolicy, and osRollingUpgradeDeferral.
  • Added RollingUpgradePolicy model with properties enableCrossZoneUpgrade, maxBatchInstancePercent, maxUnhealthyInstancePercent, maxUnhealthyUpgradedInstancePercent, pauseTimeBetweenBatches, prioritizeUnhealthyInstances, and rollbackFailedInstancesOnPolicyBreach.
  • Added upgradePolicy property to Pool.
  • Added UpgradeMode enum with values automatic, manual, and rolling.

• Added batchSupportEndOfLife property to SupportedSku.

Version: 2023-11-01

• Added Trusted Launch / security profile support for VM pools:

  • Added SecurityProfile model with properties encryptionAtHost, securityType, and uefiSettings.
  • Added UefiSettings model with properties secureBootEnabled and vTpmEnabled.
  • Added SecurityTypes enum with values trustedLaunch.
  • Added securityProfile property to VirtualMachineConfiguration.

• Added service artifact reference support for scale sets:

  • Added ServiceArtifactReference model with a required id property.
  • Added serviceArtifactReference property to VirtualMachineConfiguration.

• Enhanced OS disk configuration:

  • Added ManagedDisk model with a storageAccountType property.
  • Added caching, diskSizeGB, managedDisk, and writeAcceleratorEnabled properties to OSDisk.

• Added StandardSSD_LRS as a new value for StorageAccountType.

• Added resourceTags property to Pool to allow user-defined tags to be propagated to backing Azure resources. Only applicable when poolAllocationMode is UserSubscription.

Version: 2023-05-01

• Added boolean property enableAcceleratedNetworking to NetworkConfiguration.

  • This property determines whether this pool should enable accelerated networking, with default value as false.
  • Whether this feature can be enabled is also related to whether an operating system/VM instance is supported, which should align with AcceleratedNetworking Policy.

• Added boolean property enableAutomaticUpgrade to VMExtension.

  • This property determines whether the extension should be automatically upgraded if there is a newer version of the extension available.

• The property type of ContainerConfiguration now supports two values: DockerCompatible and CriCompatible.

Version: 2022-10-01

• Added NodeCommunicationMode enum with values Default, Classic, and Simplified to determine how a pool communicates with the Batch service.
• Added currentNodeCommunicationMode property to Pool to refer to the current state of the pool communication mode.
• Added targetNodeCommunicationMode property to Pool to refer to the desired node communication mode for the pool.

Version: 2022-06-01

• Added PrivateEndpointConnection_Delete operation to delete a private endpoint connection.
• Added allowedAuthenticationModes property to BatchAccountCreateProperties and BatchAccountUpdateProperties to control authentication modes.
• Added TaskAuthenticationToken as a new value for AuthenticationMode enum.

Version: 2022-01-01

• Added Location_ListSupportedVirtualMachineSkus operation to list supported VM SKUs at a given location.
• Added SupportedSku model with properties name, familyName, and capabilities.
• Added SupportedSkusResult model.
• Added SkuCapability model.

Version: 2021-06-01

• Added ability to assign user-assigned managed identities to BatchPoolIdentity.
• Added identityReference property to AzureBlobFileSystemConfiguration, ContainerRegistry, and ResourceFile to support accessing resources via managed identity.
• Added VM Extension support:
  • Added extensions property to VirtualMachineConfiguration.
  • Added VMExtension model.
• Added the ability to specify availability zones using a new property nodePlacementConfiguration on VirtualMachineConfiguration.
  • Added NodePlacementConfiguration model with a policy property.
  • Added NodePlacementPolicyType enum with values Regional and Zonal.
• Added osDisk property to VirtualMachineConfiguration with ephemeral OS disk support via DiffDiskSettings.

Version: 2021-01-01

• Added ability to encrypt customer data with customer-managed keys:
  • Added EncryptionProperties model with keySource and keyVaultProperties.
  • Added KeySource enum.
  • Added KeyVaultProperties model.
  • Added encryption property to BatchAccountCreateProperties and BatchAccountProperties.
• Added BatchAccountIdentity model supporting SystemAssigned, UserAssigned, and None identity types.
• Added identity property to BatchAccountCreateParameters and BatchAccountUpdateParameters.
• Added allowedAuthenticationModes property to BatchAccountProperties.
• Added ListOutboundNetworkDependenciesEndpoints operation to list endpoints a Batch compute node may call.

Version: 2020-09-01

• Added taskSlotsPerNode property to Pool, replacing the fixed task-per-node behavior.
• Added BatchAccountProperties.publicNetworkAccess to control public network access.
• Added NetworkProfile model for controlling network access rules per endpoint.

Version: 2020-05-01

• Added Private Link support:

  • Added PrivateEndpointConnection_ListByBatchAccount operation.
  • Added PrivateEndpointConnection_Get operation.
  • Added PrivateEndpointConnection_Update operation.
  • Added PrivateLinkResource_ListByBatchAccount operation.
  • Added PrivateLinkResource_Get operation.
  • Added PrivateEndpointConnection, PrivateEndpoint, PrivateLinkResource, and PrivateLinkServiceConnectionState models.

• Added publicNetworkAccess property to BatchAccountCreateProperties.

Version: 2020-03-01

• Added ability to encrypt compute node disk drives using the DiskEncryptionConfiguration property of VirtualMachineConfiguration.
• Added PublicIPAddressConfiguration model to NetworkConfiguration to support pools without public IPs.
  • Added IPAddressProvisioningType enum with values BatchManaged, UserManaged, and NoPublicIPAddresses.
  • Added ipAddressIds property to PublicIPAddressConfiguration.

Version: 2019-08-01

• Added ability to specify a collection of public IPs on NetworkConfiguration via the publicIPs property.
• Added ability to mount remote file-systems on each node of a pool via MountConfiguration:
  • Added AzureBlobFileSystemConfiguration, NFSMountConfiguration, CIFSMountConfiguration, and AzureFileShareConfiguration models.
  • Added mountConfiguration property to Pool.

Version: 2019-04-01

• Added Location_CheckNameAvailability operation to check if a Batch account name is available.
• Added CheckNameAvailabilityParameters and CheckNameAvailabilityResult models.
• Added DetectorResponse support:
  • Added BatchAccount_ListDetectors operation.
  • Added BatchAccount_GetDetector operation.

Version: 2018-12-01

• Added containerConfiguration property to VirtualMachineConfiguration for container-enabled pools.
  • Added ContainerConfiguration model.
  • Added ContainerRegistry model.
  • Added TaskContainerSettings model.
• Added startTask property to Pool with full StartTask model support.
• Added dataDisks property to VirtualMachineConfiguration for attaching data disks.
• Added licenseType property to VirtualMachineConfiguration for Azure Hybrid Use Benefit.
• Added AutoStorageAuthenticationMode enum with values StorageKeys and BatchAccountManagedIdentity.
• Added nodeIdentityReference property to AutoStorageBaseProperties.
• Added NetworkConfiguration model with subnetId, endpointConfiguration, and dynamicVnetAssignmentScope properties.
• Added PoolEndpointConfiguration and InboundNatPool models for specifying inbound endpoints.

Version: 2017-09-01

• Added Pool management support via ARM:
  • Added Pool_ListByBatchAccount, Pool_Get, Pool_Create, Pool_Update, Pool_Delete operations.
  • Added Pool_DisableAutoScale and Pool_StopResize operations.
  • Added Pool resource model with comprehensive pool properties.
• Added Certificate management via ARM:
  • Added Certificate_ListByBatchAccount, Certificate_Get, Certificate_Create, Certificate_Update, Certificate_Delete, Certificate_CancelDeletion operations.
• Added Application and ApplicationPackage management:
  • Added Application_List, Application_Get, Application_Create, Application_Update, Application_Delete operations.
  • Added ApplicationPackage_List, ApplicationPackage_Get, ApplicationPackage_Create, ApplicationPackage_Delete, ApplicationPackage_Activate operations.
• Added VirtualMachineConfiguration model for IaaS VM-based pool configuration.
• Added ScaleSettings model with FixedScaleSettings and AutoScaleSettings for controlling pool size.

Version: 2017-05-01

• Added KeyVaultReference model for Azure Key Vault integration with Batch accounts.
• Added poolAllocationMode property to BatchAccountCreateProperties with BatchService and UserSubscription modes.
• Added dedicatedCoreQuotaPerVMFamily and dedicatedCoreQuotaPerVMFamilyEnforced properties to BatchAccountProperties.
• Added lowPriorityCoreQuota property to BatchAccountProperties.

Version: 2017-01-01

• Added support for user-assigned storage accounts via auto-storage configuration.
• Added storageAccountId property to AutoStorageBaseProperties.
• Added AutoStorageProperties model with lastKeySync property.
• Added BatchAccount_SynchronizeAutoStorageKeys operation.

Version: 2015-12-01

This is the initial version of the Batch Management REST API. It provides the following core capabilities:

• Batch Account Management:
  • BatchAccount_Create - Creates a new Batch account with specified parameters.
  • BatchAccount_Update - Updates the properties of an existing Batch account.
  • BatchAccount_Delete - Deletes the specified Batch account.
  • BatchAccount_Get - Gets information about the specified Batch account.
  • BatchAccount_List - Lists all Batch accounts under a subscription.
  • BatchAccount_ListByResourceGroup - Lists all Batch accounts under a resource group.
  • BatchAccount_GetKeys - Gets the account keys for the specified Batch account.
  • BatchAccount_RegenerateKey - Regenerates the specified account key for the Batch account.
• Location Operations:
  • Location_GetQuotas - Gets the Batch service quotas for the specified subscription at the given location.
• Operations:
  • Operations_List - Lists available operations for the Batch provider.