NewYour coding agent can read the release notes before it upgrades.Set up the MCP server →
PyPI · #1913 most downloaded on PyPI
Microsoft Azure Batch Management Client Library for Python
Last release 6 months ago
12 Mar 2026
Release timing varies
gaps range from 4 weeks to 1.5 years
Nearly every release is documented
notes for 24 of 26 stable releases
Nothing withdrawn
no release was ever pulled
11 years old
32 releases · first in 2016
Model BatchManagementClient added parameter cloud_setting in method __init__
BatchManagementClient added parameter cloud_setting in method __init__BatchManagementClient added method send_requestApplication added property system_dataApplicationPackage added property system_dataAzureResource added property system_dataBatchAccount added property system_dataBatchAccountCreateParameters added property propertiesBatchAccountUpdateParameters added property propertiesCheckNameAvailabilityParameters added property typeDataDisk added property managed_diskDetectorResponse added property system_dataDiskEncryptionConfiguration added property customer_managed_keyIPRule added property actionManagedDisk added property disk_encryption_setPool added property system_dataPrivateEndpointConnection added property system_dataPrivateLinkResource added property system_dataPublicIPAddressConfiguration added property ip_familiesPublicIPAddressConfiguration added property ip_tagsSecurityEncryptionTypes added member DISK_WITH_VM_GUEST_STATESecurityProfile added property proxy_agent_settingsTaskSchedulingPolicy added property job_default_orderVMDiskSecurityProfile added property disk_encryption_setAccessRulePropertiesSubscriptionBatchAccountCreatePropertiesBatchAccountUpdatePropertiesCloudErrorDiffDiskPlacementDiskCustomerManagedKeyDiskEncryptionSetParametersHostEndpointSettingsHostEndpointSettingsModeTypesIPFamilyIPRuleActionIPTagJobDefaultOrderProxyAgentSettingsResourceTypeBatchAccountCreateParameters moved instance variable auto_storage, pool_allocation_mode, key_vault_reference, public_network_access, network_profile, encryption and allowed_authentication_modes under property propertiesBatchAccountUpdateParameters moved instance variable auto_storage, encryption, allowed_authentication_modes, public_network_access and network_profile under property propertiesDataDisk deleted or renamed its instance variable storage_account_typeAzureProxyResourceCertificateCertificateBasePropertiesCertificateCreateOrUpdateParametersCertificateCreateOrUpdatePropertiesCertificateFormatCertificatePropertiesCertificateProvisioningStateCertificateReferenceCertificateStoreLocationCertificateVisibilityDeleteCertificateErrorNodeCommunicationModeApplicationOperations.list changed its parameter maxresults from positional_or_keyword to keyword_onlyApplicationPackageOperations.list changed its parameter maxresults from positional_or_keyword to keyword_onlyLocationOperations.list_supported_virtual_machine_skus changed its parameter maxresults from positional_or_keyword to keyword_onlyPrivateEndpointConnectionOperations.list_by_batch_account changed its parameter maxresults from positional_or_keyword to keyword_onlyPrivateLinkResourceOperations.list_by_batch_account changed its parameter maxresults from positional_or_keyword to keyword_onlyPoolOperations.create replaced positional_or_keyword parameters if_match/if_none_match to keyword_only parameters etag/match_conditionPoolOperations.list_by_batch_account changed its parameter maxresults/select from positional_or_keyword to keyword_onlyPoolOperations.update replaced positional_or_keyword parameter if_match to keyword_only parameter etag/match_conditionPrivateEndpointConnectionOperations.begin_update replaced positional_or_keyword parameter if_match to keyword_only parameter etag/match_conditionCertificateOperationsAccessRulePropertiesSubscriptionsItem/ListApplicationPackagesResult/ListApplicationsResult/ListCertificatesResult/ListPoolsResult/ListPrivateEndpointConnectionsResult/ListPrivateLinkResourcesResult/SupportedSkusResult/OutboundEnvironmentEndpointCollection which actually were not used by SDK usersOne column per quarter.
Client BatchManagementClient added operation group network_security_perimeter
BatchManagementClient added operation group network_security_perimeterApplication added parameter tags in method __init__ApplicationPackage added parameter tags in method __init__Certificate added parameter tags in method __init__CertificateCreateOrUpdateParameters added parameter tags in method __init__DetectorResponse added parameter tags in method __init__ImageReference added property shared_gallery_image_idImageReference added property community_gallery_image_idManagedDisk added property security_profilePool added parameter tags in method __init__PrivateEndpointConnection added parameter tags in method __init__PrivateLinkResource added parameter tags in method __init__ProxyResource added property system_dataProxyResource added property additional_propertiesPublicNetworkAccessType added member SECURED_BY_PERIMETERResource added property system_dataTaskContainerSettings added property container_host_batch_bind_mountsAccessRuleAccessRuleDirectionAccessRulePropertiesAccessRulePropertiesSubscriptionsItemAzureProxyResourceAzureResourceContainerHostBatchBindMountEntryContainerHostDataPathCreatedByTypeErrorAdditionalInfoErrorDetailErrorResponseIssueTypeNetworkSecurityPerimeterNetworkSecurityPerimeterConfigurationNetworkSecurityPerimeterConfigurationListResultNetworkSecurityPerimeterConfigurationPropertiesNetworkSecurityPerimeterConfigurationProvisioningStateNetworkSecurityProfileProvisioningIssueProvisioningIssuePropertiesResourceAssociationResourceAssociationAccessModeSecurityEncryptionTypesSecurityTypesSeveritySystemDataVMDiskSecurityProfileNetworkSecurityPerimeterOperationsDeploymentConfiguration deleted or renamed its instance variable cloud_service_configurationProxyResource deleted or renamed its instance variable etagResource deleted or renamed its instance variable locationResource deleted or renamed its instance variable tagsCloudServiceConfigurationLocationOperations.list_supported_cloud_service_skusModel Pool has a new parameter upgrade_policy
Model OSDisk has a new parameter caching
Model NetworkConfiguration has a new parameter enable_accelerated_networking
dockerCompatible and criCompatible instead of fixed value dockerCompatibleModel NetworkConfiguration has a new parameter dynamic_vnet_assignment_scope
Added operation PrivateEndpointConnectionOperations.begin_delete
Features
Added operation BatchAccountOperations.get_detector
Features
Model BatchAccount has a new parameter allowed_authentication_modes
Features
Breaking changes
BatchManagement to BatchManagementClient- Fix changelog
Added new extensions property to VirtualMachineConfiguration on pools to specify virtual machine extensions for nodes
Features
Breaking changes
- GA release
This version uses a next-generation code generator that introduces important breaking changes, but also important new features (like unified authentic…
This is beta preview version.
This version uses a next-generation code generator that introduces important breaking changes, but also important new features (like unified authentication and async programming).
General breaking changes
Credential system has been completly revamped:
azure.common.credentials or msrestazure.azure_active_directory instances are no longer supported, use the azure-identity classes instead: https://pypi.org/project/azure-identity/credentials parameter has been renamed credentialThe config attribute no longer exists on a client, configuration should be passed as kwarg. Example: MyClient(credential, subscription_id, enable_logging=True). For a complete set of
supported options, see the parameters accept in init documentation of azure-core
You can't import a version module anymore, use __version__ instead
Operations that used to return a msrest.polling.LROPoller now returns a azure.core.polling.LROPoller and are prefixed with begin_.
Exceptions tree have been simplified and most exceptions are now azure.core.exceptions.HttpResponseError (CloudError has been removed).
Most of the operation kwarg have changed. Some of the most noticeable:
raw has been removed. Equivalent feature can be found using cls, a callback that will give access to internal HTTP response for advanced userGeneral new features
typing. SDKs are mypy ready.aio namespace of your package to find the async client.Nothing published for this version
Nothing published for this version
This version targets REST API version 2020-05-01.
public_network_access property on BatchAccount.PrivateLinkResource and PrivateEndpointConnection resource types. These are both only used when the public_network_access property on BatchAccount is set to Disabled.
public_network_access is set to Disabled a new PrivateLinkResource is visible in that account, which can be used to connect to the account using an ARM Private Endpoint in your VNET.ComputeNode disk drives using the new disk_encryption_configuration property of VirtualMachineConfiguration.id property of ImageReference can now only refer to a Shared Image Gallery image.public_ip_configuration property of NetworkConfiguration.
public_ips property of NetworkConfiguration has moved in to PublicIPAddressConfiguration as well. This property can only be specified if IPAddressProvisioningType is UserManaged.identity of type BatchAccountIdentity to BatchAccount. This can be used to configure how customer data is encrypted inside the Batch account.
identity property on BatchAccountCreateParameters and BatchAccountUpdateParametersBatchAccountCreateParameters and BatchAccountUpdateParameters to properly reflect the REST APIThis version targeted an invalid REST API. This version does not honor the associated REST API contract.
This version targeted an invalid REST API. Currently the PrivateEndpoint get() and update() functions do not function correctly. It is advised to use
public_network_access property on BatchAccount.PrivateLinkResource and PrivateEndpointConnection resource types. These are both only used when the public_network_access property on BatchAccount is set to Disabled.
public_network_access is set to Disabled a new PrivateLinkResource is visible in that account, which can be used to connect to the account using an ARM Private Endpoint in your VNET.ComputeNode disk drives using the new disk_encryption_configuration property of VirtualMachineConfiguration.id property of ImageReference can now only refer to a Shared Image Gallery image.public_ip_configuration property of NetworkConfiguration.
public_ips property of NetworkConfiguration has moved in to PublicIPAddressConfiguration as well. This property can only be specified if IPAddressProvisioningType is UserManaged.Added ability to specify a collection of public IPs on NetworkConfiguration via the new public_ips property. This guarantees nodes in the Pool will ha
NetworkConfiguration via the new public_ips property. This
guarantees nodes in the Pool will have an IP from the list user
provided IPs.
mount_configuration property on Pool.id
property of ImageReference by referencing the image via its ARM
ID.wait_for_success on StartTask is now True (was
False).scope
on AutoUserSpecification is now always Pool (was Task on
Windows nodes, Pool on Linux nodes).- [Breaking] ResourceFile improvements
[Breaking] ResourceFile improvements
- Added the ability specify an entire Azure Storage container
in `ResourceFile`.
- A new property `HttpUrl` replaces `BlobSource`. This can
be any HTTP URL. Previously, this had to be an Azure Blob
Storage URL.
- - When constructing a `ResourceFile` you can now choose
from one of the following options:
- `HttpUrl`: Specify an HTTP URL pointing to a
specific file to download.
- `StorageContainerUrl`: Specify an Azure Storage
container URL. All blobs matching the `BlobPrefix`
in the Storage container will be downloaded.
- `AutoStorageContainerName`: Specify the name of a
container in the Batch registered auto-storage
account. All blobs matching the `BlobPrefix` in
the Storage container will be downloaded.
[Breaking] Removed OSDisk property from
VirtualMachineConfiguration. This property is no longer
supported.
[Breaking] Application no longer has a Packages
property, instead the packages can be retrieved via the new
ApplicationPackage.List API.
[Breaking] TargetOsVersion is now OsVersion, and
CurrentOsVersion is no longer supported on
CloudServiceConfiguration.
Added support on Windows pools for creating users with a specific
login mode (either Batch or Interactive) via
WindowsUserConfiguration.LoginMode.
Added support for ContainerConfiguration when creating a pool.
Compatibility of the sdist with wheel 0.31.0
Bugfixes
Batch Pools are now ARM resources that can be created, updated and managed using the new client.PoolOperations.
New operation to check the availability and validity of a Batch account name.
New operation to list the operations available for the Microsoft.Batch provider, includes new Operation and OperationDisplay models.
Operation and
OperationDisplay models.
AddApplicationParameters to
ApplicationCreateParameters.UpdateApplicationParameters to
ApplicationUpdateParameters.core_quota attribute from BatchAccount object, now
replaced by separate dedicated_core_quota and
low_priority_core_quota.BatchAccountKeys object now has additional account_name
attribute.This wheel package is now built with the azure wheel extension
Updated BatchAccount model - support for pool allocation in the user's subscription.
BatchAccount model - support for pool allocation in the
user's subscription.
BatchAccount model - support for referencing an Azure
Key Vault for accounts created with a pool allocation mode of
UserSubscription.BatchAccount model - properties are now read only.ApplicationPackage model - properties are now read only.BatchAccountKeys model - properties are now read only.BatchLocationQuota model - properties are now read only.Renamed AccountResource to BatchAccount.
AccountResource to BatchAccount.
AccountOperations to BatchAccountOperations. The
IBatchManagementClient.Account property was also renamed to
IBatchManagementClient.BatchAccount.Application and ApplicationPackage operations up into
two separate operation groups.Application and ApplicationPackage methods to use
the standard Create, Delete, Update syntax. For example
creating an Application is done via
ApplicationOperations.Create.SubscriptionOperations to LocationOperations and
changed SubscriptionOperations.GetSubscriptionQuotas to be
LocationOperations.GetQuotas.- Initial Release
Nothing published for this version
Nothing published for this version
Nothing published for this version
Nothing published for this version
Your coding agent can read these notes before it upgrades. Set up the MCP server →