Microsoft Azure SDK for Python

This is the Microsoft Azure Batch Management Client Library. This package has been tested with Python 3.7+. For a more complete view of Azure libraries, see the azure sdk python release.

Disclaimer

Azure SDK Python packages support for Python 2.7 has ended 01 January 2022. For more information and questions, please refer to https://github.com/Azure/azure-sdk-for-python/issues/20691

Getting started

Prerequisites

• Python 3.7+ is required to use this package.
• Azure subscription

Install the package

pip install azure-mgmt-batch
pip install azure-identity

Authentication

By default, Azure Active Directory token authentication depends on correct configure of following environment variables.

• AZURE_CLIENT_ID for Azure client ID.
• AZURE_TENANT_ID for Azure tenant ID.
• AZURE_CLIENT_SECRET for Azure client secret.

In addition, Azure subscription ID can be configured via environment variable AZURE_SUBSCRIPTION_ID.

With above configuration, client can be authenticated by following code:

from azure.identity import DefaultAzureCredential
from azure.mgmt.batch import BatchManagementClient
import os

sub_id = os.getenv("AZURE_SUBSCRIPTION_ID")
client = BatchManagementClient(credential=DefaultAzureCredential(), subscription_id=sub_id)

Examples

Code samples for this package can be found at:

• Search Batch Management on docs.microsoft.com
• Azure Python Mgmt SDK Samples Repo

Troubleshooting

Next steps

Provide Feedback

If you encounter any bugs or have suggestions, please file an issue in the Issues section of the project.

Release History

18.0.0 (2024-09-25)

Features Added

• Client BatchManagementClient added operation group network_security_perimeter
• Model Application added parameter tags in method __init__
• Model ApplicationPackage added parameter tags in method __init__
• Model Certificate added parameter tags in method __init__
• Model CertificateCreateOrUpdateParameters added parameter tags in method __init__
• Model DetectorResponse added parameter tags in method __init__
• Model ImageReference added property shared_gallery_image_id
• Model ImageReference added property community_gallery_image_id
• Model ManagedDisk added property security_profile
• Model Pool added parameter tags in method __init__
• Model PrivateEndpointConnection added parameter tags in method __init__
• Model PrivateLinkResource added parameter tags in method __init__
• Model ProxyResource added property system_data
• Model ProxyResource added property additional_properties
• Enum PublicNetworkAccessType added member SECURED_BY_PERIMETER
• Model Resource added property system_data
• Model TaskContainerSettings added property container_host_batch_bind_mounts
• Added model AccessRule
• Added enum AccessRuleDirection
• Added model AccessRuleProperties
• Added model AccessRulePropertiesSubscriptionsItem
• Added model AzureProxyResource
• Added model AzureResource
• Added model ContainerHostBatchBindMountEntry
• Added enum ContainerHostDataPath
• Added enum CreatedByType
• Added model ErrorAdditionalInfo
• Added model ErrorDetail
• Added model ErrorResponse
• Added enum IssueType
• Added model NetworkSecurityPerimeter
• Added model NetworkSecurityPerimeterConfiguration
• Added model NetworkSecurityPerimeterConfigurationListResult
• Added model NetworkSecurityPerimeterConfigurationProperties
• Added enum NetworkSecurityPerimeterConfigurationProvisioningState
• Added model NetworkSecurityProfile
• Added model ProvisioningIssue
• Added model ProvisioningIssueProperties
• Added model ResourceAssociation
• Added enum ResourceAssociationAccessMode
• Added enum SecurityEncryptionTypes
• Added enum SecurityTypes
• Added enum Severity
• Added model SystemData
• Added model VMDiskSecurityProfile
• Added model NetworkSecurityPerimeterOperations

Breaking Changes

• Model DeploymentConfiguration deleted or renamed its instance variable cloud_service_configuration
• Model ProxyResource deleted or renamed its instance variable etag
• Model Resource deleted or renamed its instance variable location
• Model Resource deleted or renamed its instance variable tags
• Deleted or renamed model CloudServiceConfiguration
• Deleted or renamed method LocationOperations.list_supported_cloud_service_skus

17.3.0 (2024-03-19)

Features Added

• Model Pool has a new parameter upgrade_policy
• Model SupportedSku has a new parameter batch_support_end_of_life

17.2.0 (2023-12-18)

Features Added

• Model OSDisk has a new parameter caching
• Model OSDisk has a new parameter disk_size_gb
• Model OSDisk has a new parameter managed_disk
• Model OSDisk has a new parameter write_accelerator_enabled
• Model Pool has a new parameter resource_tags
• Model VirtualMachineConfiguration has a new parameter security_profile
• Model VirtualMachineConfiguration has a new parameter service_artifact_reference

17.1.0 (2023-07-21)

Features Added

• Model NetworkConfiguration has a new parameter enable_accelerated_networking
• Model VMExtension has a new parameter enable_automatic_upgrade
• Model ContainerConfiguration allows two possible values: dockerCompatible and criCompatible instead of fixed value dockerCompatible

17.0.0 (2022-11-23)

Features Added

• Model NetworkConfiguration has a new parameter dynamic_vnet_assignment_scope
• Model Pool has a new parameter current_node_communication_mode
• Model Pool has a new parameter target_node_communication_mode
• Model PrivateLinkServiceConnectionState has a new parameter actions_required

Breaking Changes

• Model CIFSMountConfiguration has a new required parameter user_name
• Model CIFSMountConfiguration no longer has parameter username
• Model NetworkConfiguration no longer has parameter dynamic_v_net_assignment_scope
• Model PrivateLinkServiceConnectionState no longer has parameter action_required

16.2.0 (2022-06-06)

Features

• Added operation PrivateEndpointConnectionOperations.begin_delete
• Model BatchAccount has a new parameter network_profile
• Model BatchAccount has a new parameter node_management_endpoint
• Model BatchAccountCreateParameters has a new parameter network_profile
• Model BatchAccountUpdateParameters has a new parameter network_profile
• Model BatchAccountUpdateParameters has a new parameter public_network_access
• Model PrivateEndpointConnection has a new parameter group_ids

16.1.0 (2022-02-24)

Features

• Added operation BatchAccountOperations.get_detector
• Added operation BatchAccountOperations.list_detectors
• Model NetworkConfiguration has a new parameter dynamic_v_net_assignment_scope

16.0.0 (2021-07-30)

Features

• Model BatchAccount has a new parameter allowed_authentication_modes
• Model AutoStorageBaseProperties has a new parameter node_identity_reference
• Model AutoStorageBaseProperties has a new parameter authentication_mode
• Model AzureBlobFileSystemConfiguration has a new parameter identity_reference
• Model BatchAccountUpdateParameters has a new parameter allowed_authentication_modes
• Model ContainerRegistry has a new parameter identity_reference
• Model Operation has a new parameter is_data_action
• Model BatchAccountCreateParameters has a new parameter allowed_authentication_modes
• Model AutoStorageProperties has a new parameter node_identity_reference
• Model AutoStorageProperties has a new parameter authentication_mode
• Model ResourceFile has a new parameter identity_reference
• Model VirtualMachineConfiguration has a new parameter os_disk
• Added operation BatchAccountOperations.list_outbound_network_dependencies_endpoints
• Added operation LocationOperations.list_supported_cloud_service_skus
• Added operation LocationOperations.list_supported_virtual_machine_skus

Breaking changes

• Rename BatchManagement to BatchManagementClient

15.0.0 (2021-02-01)

• Fix changelog

15.0.0b1 (2021-01-28)

Features

• Added new extensions property to VirtualMachineConfiguration on pools to specify virtual machine extensions for nodes
• Added the ability to specify availability zones using a new property node_placement_configuration on VirtualMachineConfiguration
• Added a new identity property on Pool to specify a managed identity
• Added a new user_assigned_identities on BatchAccountIdentity to specify a user managed identity
• Added certificate operation method PoolOperations.create
• Added certificate operation method CertificateOperations.create

Breaking changes

• Removed certificate operation method PoolOperations.begin_create. Certificate operations are not long running operations so this was incorrect.
• Removed certificate operation method CertificateOperations.begin_create. Certificate operations are not long running operations so this was incorrect.

14.0.0 (2020-12-22)

• GA release

14.0.0b1 (2020-10-23)

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