# 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](https://github.com/Azure/azure-batch-samples/tree/master/Python)
on GitHub or see [Batch](https://docs.microsoft.com/python/api/overview/azure/batch)
on docs.microsoft.com.
# Provide Feedback
If you encounter any bugs or have suggestions, please file an issue in the
[Issues](https://github.com/Azure/azure-sdk-for-python/issues)
section of the project.
# Release History
## 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](https://learn.microsoft.com/azure/virtual-network/accelerated-networking-overview?tabs=redhat#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.
- This operation is deprecating and will be removed after February 2024. Please use [Azure KeyVault Extension](https://learn.microsoft.com/azure/batch/batch-certificate-migration-guide) instead.
## 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.
- No API change required.
- Low-Priority Compute Nodes (VMs) will continue to be used for User Subscription pools (and only User Subscription pools), as before.
- Spot Compute Nodes (VMs) will now be used for Batch Managed (and only Batch Managed pools) pools.
- Relevant docs:
- https://docs.microsoft.com/azure/batch/nodes-and-pools
- https://docs.microsoft.com/azure/batch/batch-spot-vms
## 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.0 (2018-12-14)
- Using REST API version 2018-12-01.8.0.
* **Breaking** Removed support for the `upgrade_os` API on `CloudServiceConfiguration` pools.
- Removed `PoolOperations.upgrade_os` API.
- Renamed `target_os_version` to `os_version` and removed `current_os_version` on `CloudServiceConfiguration`.
- Removed `upgrading` state from `PoolState` enum.
* **Breaking** Removed `data_egress_gi_b` and `data_ingress_gi_b` from `PoolUsageMetrics`. These properties are no longer supported.
* **Breaking** ResourceFile improvements
* Added the ability specify an entire Azure Storage container in `ResourceFile`. There are now three supported modes for `ResourceFile`:
- `http_url` creates a `ResourceFile` pointing to a single HTTP URL.
- `storage_container_url` creates a `ResourceFile` pointing to the blobs under an Azure Blob Storage container.
- `auto_storage_container_name` creates a `ResourceFile` pointing to the blobs under an Azure Blob Storage container in the Batch registered auto-storage account.
* URLs provided to `ResourceFile` via the `http_url` property can now be any HTTP URL. Previously, these had to be an Azure Blob Storage URL.
* The blobs under the Azure Blob Storage container can be filtered by `blob_prefix` property.
* **Breaking** Removed `os_disk` property from `VirtualMachineConfiguration`. This property is no longer supported.
* Pools which set the `dynamic_vnet_assignment_scope` on `NetworkConfiguration` to be `DynamicVNetAssignmentScope.job` can now dynamically assign a Virtual Network to each node the job's tasks run on. The specific Virtual Network to join the nodes to is specified in the new `network_configuration` property on `CloudJob` and `JobSpecification`.
- Note: This feature is in public preview. It is disabled for all Batch accounts except for those which have contacted us and requested to be in the pilot.
* The maximum lifetime of a task is now 180 days (previously it was 7).
* Added support on Windows pools for creating users with a specific login mode (either `batch` or `interactive`) via `WindowsUserConfiguration.login_mode`.
* The default task retention time for all tasks is now 7 days, previously it was infinite.
- **Breaking** Renamed the `base_url` parameter to `batch_url` on `BatchServiceClient` class, and it is required now.
## 5.1.1 (2018-10-16)
**Bugfixes**
- Fix authentication class to allow HTTP session to be re-used
**Note**
- azure-nspkg is not installed anymore on Python 3 (PEP420-based namespace package)
## 5.1.0 (2018-08-28)
- Update operation TaskOperations.add_collection with the following added functionality:
+ Retry server side errors.
+ Automatically chunk lists of more than 100 tasks to multiple requests.
+ If tasks are too large to be submitted in chunks of 100, reduces number of tasks per request.
+ Add a parameter to specify number of threads to use when submitting tasks.
## 5.0.0 (2018-08-24)
- Using REST API version 2018-08-01.7.0.
+ Added `node_agent_info` in ComputeNode to return the node agent information
+ **Breaking** Removed the `validation_status` property from `TaskCounts`.
+ **Breaking** The default caching type for `DataDisk` and `OSDisk` is now `read_write` instead of `none`.
- `BatchServiceClient` can be used as a context manager to keep the underlying HTTP session open for performance.
- **Breaking** Model signatures are now using only keywords-arguments syntax. Each positional argument must be rewritten as a keyword argument.
- **Breaking** The following operations signatures are changed:
+ Operation PoolOperations.enable_auto_scale
+ Operation TaskOperations.update
+ Operation ComputeNodeOperations.reimage
+ Operation ComputeNodeOperations.disable_scheduling
+ Operation ComputeNodeOperations.reboot
+ Operation JobOperations.terminate
- Enum types now use the "str" mixin (class AzureEnum(str, Enum)) to improve the behavior when unrecognized enum values are encountered.
## 4.1.3 (2018-04-24)
- Update some APIs' comments
- New property `leaving_pool` in `node_counts` type.
## 4.1.2 (2018-04-23)
**Bugfixes**
- Compatibility of the sdist with wheel 0.31.0
- Compatibility with msrestazure 0.4.28
## 4.1.1 (2018-03-26)
- Fix regression on method `enable_auto_scale`.
## 4.1.0 (2018-03-07)
- Using REST API version 2018-03-01.6.1.
- Added the ability to query pool node counts by state, via the new `list_pool_node_counts` method.
- Added the ability to upload Azure Batch node agent logs from a particular node, via the `upload_batch_service_logs` method.
+ This is intended for use in debugging by Microsoft support when there are problems on a node.
## 4.0.0 (2017-09-25)
- Using REST API version 2017-09-01.6.0.
- Added the ability to get a discount on Windows VM pricing if you have on-premises licenses for the OS SKUs you are deploying, via `license_type` on `VirtualMachineConfiguration`.
- Added support for attaching empty data drives to `VirtualMachineConfiguration` based pools, via the new `data_disks` attribute on `VirtualMachineConfiguration`.
- **Breaking** Custom images must now be deployed using a reference to an ARM Image, instead of pointing to .vhd files in blobs directly.
+ The new `virtual_machine_image_id` property on `ImageReference` contains the reference to the ARM Image, and `OSDisk.image_uris` no longer exists.
+ Because of this, `image_reference` is now a required attribute of `VirtualMachineConfiguration`.
- **Breaking** Multi-instance tasks (created using `MultiInstanceSettings`) must now specify a `coordination_commandLine`, and `number_of_instances` is now optional and defaults to 1.
- Added support for tasks run using Docker containers. To run a task using a Docker container you must specify a `container_configuration` on the `VirtualMachineConfiguration` for a pool, and then add `container_settings` on the Task.
## 3.1.0 (2017-07-24)
- Added a new operation `job.get_task_counts` to retrieve the number of tasks in each state.
- Added suuport for inbound endpoint configuration on a pool - there is a new `pool_endpoint_configuration` attribute on `NetworkConfiguration`.
This property is only supported on pools that use `virtual_machine_configuration`.
- A `ComputeNode` now also has an `endpoint_configuration` attribute with the details of the applied endpoint configuration for that node.
## 3.0.0 (2017-05-10)
- Added support for the new low-priority node type; `AddPoolParameter` and `PoolSpecification` now have an additional property `target_low_priority_nodes`.
- `target_dedicated` and `current_dedicated` on `CloudPool`, `AddPoolParameter` and `PoolSpecification` have been renamed to `target_dedicated_nodes` and `current_dedicated_nodes`.
- `resize_error` on `CloudPool` is now a collection called `resize_errors`.
- Added a new `is_dedicated` property on `ComputeNode`, which is `false` for low-priority nodes.
- Added a new `allow_low_priority_node` property to `JobManagerTask`, which if `true` allows the `JobManagerTask` to run on a low-priority compute node.
- `PoolResizeParameter` now takes two optional parameters, `target_dedicated_nodes` and `target_low_priority_nodes`, instead of one required parameter `target_dedicated`.
At least one of these two parameters must be specified.
- Added support for uploading task output files to persistent storage, via the `OutputFiles` property on `CloudTask` and `JobManagerTask`.
- Added support for specifying actions to take based on a task's output file upload status, via the `file_upload_error` property on `ExitConditions`.
- Added support for determining if a task was a success or a failure via the new `result` property on all task execution information objects.
- Renamed `scheduling_error` on all task execution information objects to `failure_information`. `TaskFailureInformation` replaces `TaskSchedulingError` and is returned any
time there is a task failure. This includes all previous scheduling error cases, as well as nonzero task exit codes, and file upload failures from the new output files feature.
- Renamed `SchedulingErrorCategory` enum to `ErrorCategory`.
- Renamed `scheduling_error` on `ExitConditions` to `pre_processing_error` to more clearly clarify when the error took place in the task life-cycle.
- Added support for provisioning application licenses to your pool, via a new `application_licenses` property on `PoolAddParameter`, `CloudPool` and `PoolSpecification`.
Please note that this feature is in gated public preview, and you must request access to it via a support ticket.
- The `ssh_private_key` attribute of a `UserAccount` object has been replaced with an expanded `LinuxUserConfiguration` object with additional settings for a user ID and group ID of the
user account.
- Removed `unmapped` enum state from `AddTaskStatus`, `CertificateFormat`, `CertificateVisibility`, `CertStoreLocation`, `ComputeNodeFillType`, `OSType`, and `PoolLifetimeOption` as they were not ever used.
- Improved and clarified documentation.
## 2.0.1 (2017-04-19)
- This wheel package is now built with the azure wheel extension
## 2.0.0 (2017-02-23)
- AAD token authentication now supported.
- Some operation names have changed (along with their associated parameter model classes):
* pool.list_pool_usage_metrics -> pool.list_usage_metrics
* pool.get_all_pools_lifetime_statistics -> pool.get_all_lifetime_statistics
* job.get_all_jobs_lifetime_statistics -> job.get_all_lifetime_statistics
* file.get_node_file_properties_from_task -> file.get_properties_from_task
* file.get_node_file_properties_from_compute_node -> file.get_properties_from_compute_node
- The attribute 'file_name' in relation to file operations has been renamed to 'file_path'.
- Change in naming convention for enum values to use underscores: e.g. StartTaskState.waitingforstarttask -> StartTaskState.waiting_for_start_task.
- Support for running tasks under a predefined or automatic user account. This includes tasks, job manager tasks, job preparation and release tasks and pool start tasks. This feature replaces the previous 'run_elevated' option on a task.
- Tasks now have an optional scoped authentication token (only applies to tasks and job manager tasks).
- Support for creating pools with a list of user accounts.
- Support for creating pools using a custom VM image (only supported on accounts created with a "User Subscription" pool allocation mode).
## 1.1.0 (2016-09-15)
- Added support for task reactivation
## 1.0.0 (2016-08-09)
- Added support for joining a CloudPool to a virtual network on using the network_configuration property.
- Added support for application package references on CloudTask and JobManagerTask.
- Added support for automatically terminating jobs when all tasks complete or when a task fails, via the on_all_tasks_complete property and
the CloudTask exit_conditions property.
## 0.30.0rc5
- Initial Release
Raw data
{
"_id": null,
"home_page": "https://github.com/Azure/azure-sdk-for-python",
"name": "azure-batch",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.6",
"maintainer_email": null,
"keywords": "azure,azure sdk",
"author": "Microsoft Corporation",
"author_email": "azpysdkhelp@microsoft.com",
"download_url": "https://files.pythonhosted.org/packages/e8/8a/183bba40b773fc2f729ed3c3bbe668ba5b49e80af07a2fbe1a683060b80b/azure-batch-14.1.0.tar.gz",
"platform": null,
"description": "# Microsoft Azure SDK for Python\n\nThis is the Microsoft Azure Batch Client Library.\n\nThis package has been tested with Python 3.6+\n\nFor a more complete set of Azure libraries, see https://aka.ms/azsdk/python/all\n\n# Usage\n\nFor code examples, see [the Batch samples repo](https://github.com/Azure/azure-batch-samples/tree/master/Python)\non GitHub or see [Batch](https://docs.microsoft.com/python/api/overview/azure/batch)\non docs.microsoft.com.\n\n\n# Provide Feedback\n\nIf you encounter any bugs or have suggestions, please file an issue in the\n[Issues](https://github.com/Azure/azure-sdk-for-python/issues)\nsection of the project.\n\n\n\n\n\n# Release History\n\n## 14.1.0 (2023-11-01)\n\n### Features Added\n\n- 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.\n - Added `resourceTags` property to `PoolSpecification` definition\n - Added `resourceTags` property to `CloudPool` definition\n\n- 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.\n - Added `serviceArtifactReference` and `securityProfile` property to `VirtualMachineConfiguration` definition\n \n- Added `ServiceArtifactReference` and `OSDisk` support to Pool Creation\n - Added `standardssd_lrs` value to `StorageAccountType` enum\n - Added `caching`, `managedDisk`, `diskSizeGB`, and `writeAcceleratorEnabled` property to `NodePlacementPolicyType` definition\n - Added `scaleSetVmResourceID` property to `VirtualMachineInfo` definition\n\n## 14.0.0 (2023-05-01)\n\n### Features Added\n\n- Added boolean property `enableAcceleratedNetworking` to `NetworkConfiguration`.\n - This property determines whether this pool should enable accelerated networking, with default value as False.\n - 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](https://learn.microsoft.com/azure/virtual-network/accelerated-networking-overview?tabs=redhat#limitations-and-constraints)).\n- Added boolean property `enableAutomaticUpgrade` to `VMExtension`.\n - This property determines whether the extension should be automatically upgraded by the platform if there is a newer version of the extension available.\n- Added a new property `type` to `ContainerConfiguration`. Possible values include: `dockerCompatible` and `criCompatible`.\n\n### Breaking Changes\n\n- Removed lifetime statistics API. This API is no longer supported.\n - Removed `job.get_all_lifetime_statistics` API.\n - Removed `pool.get_all_lifetime_statistics` API.\n\n### Other Changes\n\n- Deprecating `CertificateOperations` related methods.\n - This operation is deprecating and will be removed after February 2024. Please use [Azure KeyVault Extension](https://learn.microsoft.com/azure/batch/batch-certificate-migration-guide) instead.\n \n## 13.0.0 (2022-11-08)\n\n### Features Added\n\n- Added new custom enum type `NodeCommunicationMode`.\n - This property determines how a pool communicates with the Batch service.\n - Possible values: Default, Classic, Simplified.\n- Added properties `current_node_communication_mode` and `target_node_communication_mode` of type `NodeCommunicationMode` to `CloudPool`.\n- Added property `target_node_communication_mode` of type `NodeCommunicationMode` to `PoolSpecification`, `PoolAddParameter`, `PoolPatchParameter`, and `PoolUpdatePropertiesParameter`.\n\n## 12.0.0 (2022-02-01)\n\n### Features\n\n- Added property uploadHeaders to `OutputFileBlobContainerDestination`.\n - Allows users to set custom HTTP headers on resource file uploads.\n - Array of type HttpHeader (also being added).\n- Added boolean property `allow_task_preemption` to `JobSpecification`, `CloudJob`, `JobAddParameter`, `JobPatchParameter`, `JobUpdateParameter`\n - Mark Tasks as preemptible for higher priority Tasks (requires Comms-Enabled or Single Tenant Pool).\n- Replaced comment (title, description, etc.) references of \"low-priority\" with \"Spot/Low-Priority\", to reflect new service behavior.\n - No API change required.\n - Low-Priority Compute Nodes (VMs) will continue to be used for User Subscription pools (and only User Subscription pools), as before.\n - Spot Compute Nodes (VMs) will now be used for Batch Managed (and only Batch Managed pools) pools.\n - Relevant docs:\n - https://docs.microsoft.com/azure/batch/nodes-and-pools\n - https://docs.microsoft.com/azure/batch/batch-spot-vms\n\n## 11.0.0 (2021-07-30)\n\n### Features\n\n- 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.\n- Added `identity_reference` property to the following models to support accessing resources via managed identity:\n - `AzureBlobFileSystemConfiguration`\n - `OutputFileBlobContainerDestination`\n - `ContainerRegistry`\n - `ResourceFile`\n - `UploadBatchServiceLogsConfiguration`\n- Added new `compute_node_extension` operations to `BatchServiceClient` for getting/listing VM extensions on a node\n- Added new `extensions` property to `VirtualMachineConfiguration` on `CloudPool` to specify virtual machine extensions for nodes\n- Added the ability to specify availability zones using a new property `node_placement_configuration` on `VirtualMachineConfiguration`\n- Added new `os_disk` property to `VirtualMachineConfiguration`, which contains settings for the operating system disk of the Virtual Machine.\n - 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.\n- Added `max_parallel_tasks` property on `CloudJob` to control the maximum allowed tasks per job (defaults to -1, meaning unlimited).\n- 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.\n\n## 10.0.0 (2020-09-01)\n\n### Features\n- **[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.\n- **[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.\n- Added property `requiredSlots` to the task allowing user to specify how many slots on a node it should take up.\n\n## 9.0.0 (2020-03-24)\n\n### Features\n- Added ability to encrypt `ComputeNode` disk drives using the new `disk_encryption_configuration` property of `VirtualMachineConfiguration`.\n- **[Breaking]** The `virtual_machine_id` property of `ImageReference` can now only refer to a Shared Image Gallery image.\n- **[Breaking]** Pools can now be provisioned without a public IP using the new `public_ip_address_configuration` property of `NetworkConfiguration`.\n - 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`.\n\n### REST API version\nThis version of the Batch .NET client library targets version 2020-03-01.11.0 of the Azure Batch REST API.\n\n## 8.0.0 (2019-8-5)\n\n- Using REST API version 2019-08-01.10.0.\n * 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.\n * Added ability to mount remote file-systems on each node of a pool via the `mount_configuration` property on `CloudPool`.\n * 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.\n * **Breaking** When not specified, the default value for `wait_for_success` on `StartTask` is now `True` (was `False`).\n * **Breaking** When not specified, the default value for `scope` on `AutoUserSpecification` is now always `Pool` (was `Task` on Windows nodes, `Pool` on Linux nodes).\n\n## 7.0.0 (2019-6-11)\n\n- Using REST API version 2019-06-01.9.0.\n * **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`.\n * 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`.\n * 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`.\n\n## 6.0.1 (2019-2-26)\n\n- Fix bug in TaskOperations.add_collection methods exception handling\n\n## 6.0.0 (2018-12-14)\n\n- Using REST API version 2018-12-01.8.0.\n * **Breaking** Removed support for the `upgrade_os` API on `CloudServiceConfiguration` pools.\n - Removed `PoolOperations.upgrade_os` API.\n - Renamed `target_os_version` to `os_version` and removed `current_os_version` on `CloudServiceConfiguration`.\n - Removed `upgrading` state from `PoolState` enum.\n * **Breaking** Removed `data_egress_gi_b` and `data_ingress_gi_b` from `PoolUsageMetrics`. These properties are no longer supported.\n * **Breaking** ResourceFile improvements\n * Added the ability specify an entire Azure Storage container in `ResourceFile`. There are now three supported modes for `ResourceFile`:\n - `http_url` creates a `ResourceFile` pointing to a single HTTP URL.\n - `storage_container_url` creates a `ResourceFile` pointing to the blobs under an Azure Blob Storage container.\n - `auto_storage_container_name` creates a `ResourceFile` pointing to the blobs under an Azure Blob Storage container in the Batch registered auto-storage account.\n * URLs provided to `ResourceFile` via the `http_url` property can now be any HTTP URL. Previously, these had to be an Azure Blob Storage URL.\n * The blobs under the Azure Blob Storage container can be filtered by `blob_prefix` property.\n * **Breaking** Removed `os_disk` property from `VirtualMachineConfiguration`. This property is no longer supported.\n * Pools which set the `dynamic_vnet_assignment_scope` on `NetworkConfiguration` to be `DynamicVNetAssignmentScope.job` can now dynamically assign a Virtual Network to each node the job's tasks run on. The specific Virtual Network to join the nodes to is specified in the new `network_configuration` property on `CloudJob` and `JobSpecification`.\n - Note: This feature is in public preview. It is disabled for all Batch accounts except for those which have contacted us and requested to be in the pilot.\n * The maximum lifetime of a task is now 180 days (previously it was 7).\n * Added support on Windows pools for creating users with a specific login mode (either `batch` or `interactive`) via `WindowsUserConfiguration.login_mode`.\n * The default task retention time for all tasks is now 7 days, previously it was infinite.\n- **Breaking** Renamed the `base_url` parameter to `batch_url` on `BatchServiceClient` class, and it is required now.\n\n## 5.1.1 (2018-10-16)\n\n**Bugfixes**\n\n- Fix authentication class to allow HTTP session to be re-used\n\n**Note**\n\n- azure-nspkg is not installed anymore on Python 3 (PEP420-based namespace package)\n\n## 5.1.0 (2018-08-28)\n\n- Update operation TaskOperations.add_collection with the following added functionality:\n + Retry server side errors.\n + Automatically chunk lists of more than 100 tasks to multiple requests.\n + If tasks are too large to be submitted in chunks of 100, reduces number of tasks per request.\n + Add a parameter to specify number of threads to use when submitting tasks.\n\n## 5.0.0 (2018-08-24)\n\n- Using REST API version 2018-08-01.7.0.\n + Added `node_agent_info` in ComputeNode to return the node agent information\n + **Breaking** Removed the `validation_status` property from `TaskCounts`.\n + **Breaking** The default caching type for `DataDisk` and `OSDisk` is now `read_write` instead of `none`.\n- `BatchServiceClient` can be used as a context manager to keep the underlying HTTP session open for performance.\n- **Breaking** Model signatures are now using only keywords-arguments syntax. Each positional argument must be rewritten as a keyword argument.\n- **Breaking** The following operations signatures are changed:\n + Operation PoolOperations.enable_auto_scale\n + Operation TaskOperations.update\n + Operation ComputeNodeOperations.reimage\n + Operation ComputeNodeOperations.disable_scheduling\n + Operation ComputeNodeOperations.reboot\n + Operation JobOperations.terminate\n- Enum types now use the \"str\" mixin (class AzureEnum(str, Enum)) to improve the behavior when unrecognized enum values are encountered.\n\n## 4.1.3 (2018-04-24)\n\n- Update some APIs' comments\n- New property `leaving_pool` in `node_counts` type.\n\n## 4.1.2 (2018-04-23)\n\n**Bugfixes**\n\n- Compatibility of the sdist with wheel 0.31.0\n- Compatibility with msrestazure 0.4.28\n\n## 4.1.1 (2018-03-26)\n\n- Fix regression on method `enable_auto_scale`.\n\n## 4.1.0 (2018-03-07)\n\n- Using REST API version 2018-03-01.6.1.\n- Added the ability to query pool node counts by state, via the new `list_pool_node_counts` method.\n- Added the ability to upload Azure Batch node agent logs from a particular node, via the `upload_batch_service_logs` method.\n + This is intended for use in debugging by Microsoft support when there are problems on a node.\n\n## 4.0.0 (2017-09-25)\n\n- Using REST API version 2017-09-01.6.0.\n- Added the ability to get a discount on Windows VM pricing if you have on-premises licenses for the OS SKUs you are deploying, via `license_type` on `VirtualMachineConfiguration`.\n- Added support for attaching empty data drives to `VirtualMachineConfiguration` based pools, via the new `data_disks` attribute on `VirtualMachineConfiguration`.\n- **Breaking** Custom images must now be deployed using a reference to an ARM Image, instead of pointing to .vhd files in blobs directly.\n + The new `virtual_machine_image_id` property on `ImageReference` contains the reference to the ARM Image, and `OSDisk.image_uris` no longer exists.\n + Because of this, `image_reference` is now a required attribute of `VirtualMachineConfiguration`.\n- **Breaking** Multi-instance tasks (created using `MultiInstanceSettings`) must now specify a `coordination_commandLine`, and `number_of_instances` is now optional and defaults to 1.\n- Added support for tasks run using Docker containers. To run a task using a Docker container you must specify a `container_configuration` on the `VirtualMachineConfiguration` for a pool, and then add `container_settings` on the Task.\n\n## 3.1.0 (2017-07-24)\n\n- Added a new operation `job.get_task_counts` to retrieve the number of tasks in each state.\n- Added suuport for inbound endpoint configuration on a pool - there is a new `pool_endpoint_configuration` attribute on `NetworkConfiguration`.\n This property is only supported on pools that use `virtual_machine_configuration`.\n- A `ComputeNode` now also has an `endpoint_configuration` attribute with the details of the applied endpoint configuration for that node.\n\n## 3.0.0 (2017-05-10)\n\n- Added support for the new low-priority node type; `AddPoolParameter` and `PoolSpecification` now have an additional property `target_low_priority_nodes`.\n- `target_dedicated` and `current_dedicated` on `CloudPool`, `AddPoolParameter` and `PoolSpecification` have been renamed to `target_dedicated_nodes` and `current_dedicated_nodes`.\n- `resize_error` on `CloudPool` is now a collection called `resize_errors`.\n- Added a new `is_dedicated` property on `ComputeNode`, which is `false` for low-priority nodes.\n- Added a new `allow_low_priority_node` property to `JobManagerTask`, which if `true` allows the `JobManagerTask` to run on a low-priority compute node.\n- `PoolResizeParameter` now takes two optional parameters, `target_dedicated_nodes` and `target_low_priority_nodes`, instead of one required parameter `target_dedicated`.\n At least one of these two parameters must be specified.\n- Added support for uploading task output files to persistent storage, via the `OutputFiles` property on `CloudTask` and `JobManagerTask`.\n- Added support for specifying actions to take based on a task's output file upload status, via the `file_upload_error` property on `ExitConditions`.\n- Added support for determining if a task was a success or a failure via the new `result` property on all task execution information objects.\n- Renamed `scheduling_error` on all task execution information objects to `failure_information`. `TaskFailureInformation` replaces `TaskSchedulingError` and is returned any\n time there is a task failure. This includes all previous scheduling error cases, as well as nonzero task exit codes, and file upload failures from the new output files feature.\n- Renamed `SchedulingErrorCategory` enum to `ErrorCategory`.\n- Renamed `scheduling_error` on `ExitConditions` to `pre_processing_error` to more clearly clarify when the error took place in the task life-cycle.\n- Added support for provisioning application licenses to your pool, via a new `application_licenses` property on `PoolAddParameter`, `CloudPool` and `PoolSpecification`.\n Please note that this feature is in gated public preview, and you must request access to it via a support ticket.\n- The `ssh_private_key` attribute of a `UserAccount` object has been replaced with an expanded `LinuxUserConfiguration` object with additional settings for a user ID and group ID of the\n user account.\n- Removed `unmapped` enum state from `AddTaskStatus`, `CertificateFormat`, `CertificateVisibility`, `CertStoreLocation`, `ComputeNodeFillType`, `OSType`, and `PoolLifetimeOption` as they were not ever used.\n- Improved and clarified documentation.\n\n## 2.0.1 (2017-04-19)\n\n- This wheel package is now built with the azure wheel extension\n\n## 2.0.0 (2017-02-23)\n\n- AAD token authentication now supported.\n- Some operation names have changed (along with their associated parameter model classes):\n * pool.list_pool_usage_metrics -> pool.list_usage_metrics\n * pool.get_all_pools_lifetime_statistics -> pool.get_all_lifetime_statistics\n * job.get_all_jobs_lifetime_statistics -> job.get_all_lifetime_statistics\n * file.get_node_file_properties_from_task -> file.get_properties_from_task\n * file.get_node_file_properties_from_compute_node -> file.get_properties_from_compute_node\n- The attribute 'file_name' in relation to file operations has been renamed to 'file_path'.\n- Change in naming convention for enum values to use underscores: e.g. StartTaskState.waitingforstarttask -> StartTaskState.waiting_for_start_task.\n- Support for running tasks under a predefined or automatic user account. This includes tasks, job manager tasks, job preparation and release tasks and pool start tasks. This feature replaces the previous 'run_elevated' option on a task.\n- Tasks now have an optional scoped authentication token (only applies to tasks and job manager tasks).\n- Support for creating pools with a list of user accounts.\n- Support for creating pools using a custom VM image (only supported on accounts created with a \"User Subscription\" pool allocation mode).\n\n## 1.1.0 (2016-09-15)\n\n- Added support for task reactivation\n\n## 1.0.0 (2016-08-09)\n\n- Added support for joining a CloudPool to a virtual network on using the network_configuration property.\n- Added support for application package references on CloudTask and JobManagerTask.\n- Added support for automatically terminating jobs when all tasks complete or when a task fails, via the on_all_tasks_complete property and\n the CloudTask exit_conditions property.\n\n## 0.30.0rc5\n\n- Initial Release\n",
"bugtrack_url": null,
"license": "MIT License",
"summary": "Microsoft Azure Batch Client Library for Python",
"version": "14.1.0",
"project_urls": {
"Homepage": "https://github.com/Azure/azure-sdk-for-python"
},
"split_keywords": [
"azure",
"azure sdk"
],
"urls": [
{
"comment_text": null,
"digests": {
"blake2b_256": "dd90cf0533f89895b0040497f549213b0a3f5249a28bb6aac22bbc86fbed7a26",
"md5": "74fb969c182c45cd64aca89890d697fc",
"sha256": "83a364ec644d5a6e89698b165035083fabe1269ae58f1fb6472ff2531ac12244"
},
"downloads": -1,
"filename": "azure_batch-14.1.0-py3-none-any.whl",
"has_sig": false,
"md5_digest": "74fb969c182c45cd64aca89890d697fc",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.6",
"size": 238285,
"upload_time": "2024-01-09T21:15:10",
"upload_time_iso_8601": "2024-01-09T21:15:10.950493Z",
"url": "https://files.pythonhosted.org/packages/dd/90/cf0533f89895b0040497f549213b0a3f5249a28bb6aac22bbc86fbed7a26/azure_batch-14.1.0-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": null,
"digests": {
"blake2b_256": "e88a183bba40b773fc2f729ed3c3bbe668ba5b49e80af07a2fbe1a683060b80b",
"md5": "851dbae5646f3a1cacb68202ddf5d2d9",
"sha256": "9616b2caa629c7400122d685d557ebcd01797da9889908318f9a547484397acd"
},
"downloads": -1,
"filename": "azure-batch-14.1.0.tar.gz",
"has_sig": false,
"md5_digest": "851dbae5646f3a1cacb68202ddf5d2d9",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.6",
"size": 238485,
"upload_time": "2024-01-09T21:15:08",
"upload_time_iso_8601": "2024-01-09T21:15:08.159042Z",
"url": "https://files.pythonhosted.org/packages/e8/8a/183bba40b773fc2f729ed3c3bbe668ba5b49e80af07a2fbe1a683060b80b/azure-batch-14.1.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-01-09 21:15:08",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "Azure",
"github_project": "azure-sdk-for-python",
"travis_ci": false,
"coveralls": true,
"github_actions": true,
"lcname": "azure-batch"
}
JSON
