Give AlbumentationsX a star on GitHub — it powers this leaderboard

Star on GitHub

azure-batch

Microsoft Azure Batch Client Library for Python

Downloads: 0 (30 days)
View on PyPIGitHubOwner: Azure

Description

Microsoft Azure SDK for Python

This is the Microsoft Azure Batch Client Library.

This package has been tested with Python 3.6+

For a more complete set of Azure libraries, see https://aka.ms/azsdk/python/all

Usage

For code examples, see the Batch samples repo on GitHub or see Batch on docs.microsoft.com.

Provide Feedback

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

Impressions

Release History

14.2.0 (2024-02-01)

Features Added

  • Added UpgradePolicy to CloudPool definition for pool creation
    • Added AutomaticOSUpgradePolicy to include configuration parameters for automatic OS upgrades
    • Added RollingUpgradePolicy to include configuration parameters for rolling upgrades

14.1.0 (2023-11-01)

Features Added

  • Added ResourceTags support to Pool Creation so users are able to specify resource tags for a pool. This feature is currently only supported for pool creation but will be updatable in the future.

    • Added resourceTags property to PoolSpecification definition
    • Added resourceTags property to CloudPool definition

  • Added SecurityProfile support to Pool Creation. Trusted Launch provides advanced security to Guest OS preventing boot-kits/rootkits (like un-signed driver or kernel modification) to be introduced into boot-chain.

    • Added serviceArtifactReference and securityProfile property to VirtualMachineConfiguration definition

  • Added ServiceArtifactReference and OSDisk support to Pool Creation

    • Added standardssd_lrs value to StorageAccountType enum
    • Added caching, managedDisk, diskSizeGB, and writeAcceleratorEnabled property to NodePlacementPolicyType definition
    • Added scaleSetVmResourceID property to VirtualMachineInfo definition

14.0.0 (2023-05-01)

Features Added

  • 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 (AcceleratedNetworking Limitations and constraints).
  • Added boolean property enableAutomaticUpgrade to VMExtension.
    • This property determines whether the extension should be automatically upgraded by the platform if there is a newer version of the extension available.
  • Added a new property type to ContainerConfiguration. Possible values include: dockerCompatible and criCompatible.

Breaking Changes

  • Removed lifetime statistics API. This API is no longer supported.
    • Removed job.get_all_lifetime_statistics API.
    • Removed pool.get_all_lifetime_statistics API.

Other Changes

  • Deprecating CertificateOperations related methods.

13.0.0 (2022-11-08)

Features Added

  • Added new custom enum type NodeCommunicationMode.
    • This property determines how a pool communicates with the Batch service.
    • Possible values: Default, Classic, Simplified.
  • Added properties current_node_communication_mode and target_node_communication_mode of type NodeCommunicationMode to CloudPool.
  • Added property target_node_communication_mode of type NodeCommunicationMode to PoolSpecification, PoolAddParameter, PoolPatchParameter, and PoolUpdatePropertiesParameter.

12.0.0 (2022-02-01)

Features

  • Added property uploadHeaders to OutputFileBlobContainerDestination.
    • Allows users to set custom HTTP headers on resource file uploads.
    • Array of type HttpHeader (also being added).
  • Added boolean property allow_task_preemption to JobSpecification, CloudJob, JobAddParameter, JobPatchParameter, JobUpdateParameter
    • Mark Tasks as preemptible for higher priority Tasks (requires Comms-Enabled or Single Tenant Pool).
  • Replaced comment (title, description, etc.) references of "low-priority" with "Spot/Low-Priority", to reflect new service behavior.

11.0.0 (2021-07-30)

Features

  • Add ability to assign user-assigned managed identities to CloudPool. These identities will be made available on each node in the pool, and can be used to access various resources.
  • Added identity_reference property to the following models to support accessing resources via managed identity:
    • AzureBlobFileSystemConfiguration
    • OutputFileBlobContainerDestination
    • ContainerRegistry
    • ResourceFile
    • UploadBatchServiceLogsConfiguration
  • Added new compute_node_extension operations to BatchServiceClient for getting/listing VM extensions on a node
  • Added new extensions property to VirtualMachineConfiguration on CloudPool to specify virtual machine extensions for nodes
  • Added the ability to specify availability zones using a new property node_placement_configuration on VirtualMachineConfiguration
  • Added new os_disk property to VirtualMachineConfiguration, which contains settings for the operating system disk of the Virtual Machine.
    • The placement property on DiffDiskSettings specifies the ephemeral disk placement for operating system disks for all VMs in the pool. Setting it to "CacheDisk" will store the ephemeral OS disk on the VM cache.
  • Added max_parallel_tasks property on CloudJob to control the maximum allowed tasks per job (defaults to -1, meaning unlimited).
  • Added virtual_machine_info property on ComputeNode which contains information about the current state of the virtual machine, including the exact version of the marketplace image the VM is using.

10.0.0 (2020-09-01)

Features

  • [Breaking] Replaced property maxTasksPerNode with taskSlotsPerNode on the pool. Using this property tasks in a job can consume a dynamic amount of slots allowing for more fine-grained control over resource consumption.
  • [Breaking] Changed the response type of GetTaskCounts to return TaskCountsResult, which is a complex object containing the previous TaskCounts object and a new TaskSlotCounts object providing similar information in the context of slots being used.
  • Added property requiredSlots to the task allowing user to specify how many slots on a node it should take up.

9.0.0 (2020-03-24)

Features

  • Added ability to encrypt ComputeNode disk drives using the new disk_encryption_configuration property of VirtualMachineConfiguration.
  • [Breaking] The virtual_machine_id property of ImageReference can now only refer to a Shared Image Gallery image.
  • [Breaking] Pools can now be provisioned without a public IP using the new public_ip_address_configuration property of NetworkConfiguration.
    • The public_ips property of NetworkConfiguration has moved in to public_ip_address_configuration as well. This property can only be specified if ip_provisioning_type is UserManaged.

REST API version

This version of the Batch .NET client library targets version 2020-03-01.11.0 of the Azure Batch REST API.

8.0.0 (2019-8-5)

  • Using REST API version 2019-08-01.10.0.
    • Added ability to specify a collection of public IPs on NetworkConfiguration via the new public_ips property. This guarantees nodes in the Pool will have an IP from the list user provided IPs.
    • Added ability to mount remote file-systems on each node of a pool via the mount_configuration property on CloudPool.
    • Shared Image Gallery images can now be specified on the virtual_machine_image_id property of ImageReference by referencing the image via its ARM ID.
    • Breaking When not specified, the default value for wait_for_success on StartTask is now True (was False).
    • Breaking When not specified, the default value for scope on AutoUserSpecification is now always Pool (was Task on Windows nodes, Pool on Linux nodes).

7.0.0 (2019-6-11)

  • Using REST API version 2019-06-01.9.0.
    • Breaking Replaced AccountOperations.list_node_agent_skus with AccountOperations.list_supported_images. list_supported_images contains all of the same information originally available in list_node_agent_skus but in a clearer format. New non-verified images are also now returned. Additional information about capabilities and batch_support_end_of_life is accessible on the ImageInformation object returned by list_supported_images.
    • Now support network security rules blocking network access to a CloudPool based on the source port of the traffic. This is done via the source_port_ranges property on network_security_group_rules.
    • When running a container, Batch now supports executing the task in the container working directory or in the Batch task working directory. This is controlled by the working_directory property on TaskContainerSettings.

6.0.1 (2019-2-26)

  • Fix bug in TaskOperations.add_collection methods exception handling

6.0