azure.batch.models module

class azure.batch.models.PoolUsageMetrics(pool_id, start_time, end_time, vm_size, total_core_hours, data_ingress_gi_b, data_egress_gi_b)[source]

Bases: msrest.serialization.Model

Usage metrics for a pool across an aggregation interval.

Parameters:
  • pool_id (str) – The ID of the pool whose metrics are aggregated in this entry.
  • start_time (datetime) – The start time of the aggregation interval covered by this entry.
  • end_time (datetime) – The end time of the aggregation interval covered by this entry.
  • vm_size (str) – The size of virtual machines in the pool. All VMs in a pool are the same size. For information about available sizes of virtual machines for Cloud Services pools (pools created with cloudServiceConfiguration), see Sizes for Cloud Services (http://azure.microsoft.com/documentation/articles/cloud-services-sizes-specs/). Batch supports all Cloud Services VM sizes except ExtraSmall, A1V2 and A2V2. For information about available VM sizes for pools using images from the Virtual Machines Marketplace (pools created with virtualMachineConfiguration) see Sizes for Virtual Machines (Linux) (https://azure.microsoft.com/documentation/articles/virtual-machines-linux-sizes/) or Sizes for Virtual Machines (Windows) (https://azure.microsoft.com/documentation/articles/virtual-machines-windows-sizes/). Batch supports all Azure VM sizes except STANDARD_A0 and those with premium storage (STANDARD_GS, STANDARD_DS, and STANDARD_DSV2 series).
  • total_core_hours (float) – The total core hours used in the pool during this aggregation interval.
  • data_ingress_gi_b (float) – The cross data center network ingress to the pool during this interval, in GiB.
  • data_egress_gi_b (float) – The cross data center network egress from the pool during this interval, in GiB.
class azure.batch.models.ImageReference(publisher, offer, sku, version=None)[source]

Bases: msrest.serialization.Model

A reference to an Azure Virtual Machines Marketplace image. To get the list of all imageReferences verified by Azure Batch, see the ‘List supported node agent SKUs’ operation.

Parameters:
  • publisher (str) – The publisher of the Azure Virtual Machines Marketplace image. For example, Canonical or MicrosoftWindowsServer.
  • offer (str) – The offer type of the Azure Virtual Machines Marketplace image. For example, UbuntuServer or WindowsServer.
  • sku (str) – The SKU of the Azure Virtual Machines Marketplace image. For example, 14.04.0-LTS or 2012-R2-Datacenter.
  • version (str) – The version of the Azure Virtual Machines Marketplace image. A value of ‘latest’ can be specified to select the latest version of an image. If omitted, the default is ‘latest’.
class azure.batch.models.NodeAgentSku(id=None, verified_image_references=None, os_type=None)[source]

Bases: msrest.serialization.Model

A node agent SKU supported by the Batch service.

The Batch node agent is a program that runs on each node in the pool, and provides the command-and-control interface between the node and the Batch service. There are different implementations of the node agent, known as SKUs, for different operating systems.

Parameters:
  • id (str) – The ID of the node agent SKU.
  • verified_image_references (list of ImageReference) – The list of images verified to be compatible with this node agent SKU. This collection is not exhaustive (the node agent may be compatible with other images).
  • os_type (str or OSType) – The type of operating system (e.g. Windows or Linux) compatible with the node agent SKU. Possible values include: ‘linux’, ‘windows’
class azure.batch.models.AuthenticationTokenSettings(access=None)[source]

Bases: msrest.serialization.Model

The settings for an authentication token that the task can use to perform Batch service operations.

Parameters:access (list of str or AccessScope) – The Batch resources to which the token grants access. The authentication token grants access to a limited set of Batch service operations. Currently the only supported value for the access property is ‘job’, which grants access to all operations related to the job which contains the task.
class azure.batch.models.UsageStatistics(start_time, last_update_time, dedicated_core_time)[source]

Bases: msrest.serialization.Model

Statistics related to pool usage information.

Parameters:
  • start_time (datetime) – The start time of the time range covered by the statistics.
  • last_update_time (datetime) – The time at which the statistics were last updated. All statistics are limited to the range between startTime and lastUpdateTime.
  • dedicated_core_time (timedelta) – The aggregated wall-clock time of the dedicated compute node cores being part of the pool.
class azure.batch.models.ResourceStatistics(start_time, last_update_time, avg_cpu_percentage, avg_memory_gi_b, peak_memory_gi_b, avg_disk_gi_b, peak_disk_gi_b, disk_read_iops, disk_write_iops, disk_read_gi_b, disk_write_gi_b, network_read_gi_b, network_write_gi_b)[source]

Bases: msrest.serialization.Model

Statistics related to resource consumption by compute nodes in a pool.

Parameters:
  • start_time (datetime) – The start time of the time range covered by the statistics.
  • last_update_time (datetime) – The time at which the statistics were last updated. All statistics are limited to the range between startTime and lastUpdateTime.
  • avg_cpu_percentage (float) – The average CPU usage across all nodes in the pool (percentage per node).
  • avg_memory_gi_b (float) – The average memory usage in GiB across all nodes in the pool.
  • peak_memory_gi_b (float) – The peak memory usage in GiB across all nodes in the pool.
  • avg_disk_gi_b (float) – The average used disk space in GiB across all nodes in the pool.
  • peak_disk_gi_b (float) – The peak used disk space in GiB across all nodes in the pool.
  • disk_read_iops (long) – The total number of disk read operations across all nodes in the pool.
  • disk_write_iops (long) – The total number of disk write operations across all nodes in the pool.
  • disk_read_gi_b (float) – The total amount of data in GiB of disk reads across all nodes in the pool.
  • disk_write_gi_b (float) – The total amount of data in GiB of disk writes across all nodes in the pool.
  • network_read_gi_b (float) – The total amount of data in GiB of network reads across all nodes in the pool.
  • network_write_gi_b (float) – The total amount of data in GiB of network writes across all nodes in the pool.
class azure.batch.models.PoolStatistics(url, start_time, last_update_time, usage_stats=None, resource_stats=None)[source]

Bases: msrest.serialization.Model

Contains utilization and resource usage statistics for the lifetime of a pool.

Parameters:
  • url (str) – The URL for the statistics.
  • start_time (datetime) – The start time of the time range covered by the statistics.
  • last_update_time (datetime) – The time at which the statistics were last updated. All statistics are limited to the range between startTime and lastUpdateTime.
  • usage_stats (UsageStatistics) – Statistics related to pool usage, such as the amount of core-time used.
  • resource_stats (ResourceStatistics) – Statistics related to resource consumption by compute nodes in the pool.
class azure.batch.models.JobStatistics(url, start_time, last_update_time, user_cpu_time, kernel_cpu_time, wall_clock_time, read_iops, write_iops, read_io_gi_b, write_io_gi_b, num_succeeded_tasks, num_failed_tasks, num_task_retries, wait_time)[source]

Bases: msrest.serialization.Model

Resource usage statistics for a job.

Parameters:
  • url (str) – The URL of the statistics.
  • start_time (datetime) – The start time of the time range covered by the statistics.
  • last_update_time (datetime) – The time at which the statistics were last updated. All statistics are limited to the range between startTime and lastUpdateTime.
  • user_cpu_time (timedelta) – The total user mode CPU time (summed across all cores and all compute nodes) consumed by all tasks in the job.
  • kernel_cpu_time (timedelta) – The total kernel mode CPU time (summed across all cores and all compute nodes) consumed by all tasks in the job.
  • wall_clock_time (timedelta) – The total wall clock time of all tasks in the job.
  • read_iops (long) – The total number of disk read operations made by all tasks in the job.
  • write_iops (long) – The total number of disk write operations made by all tasks in the job.
  • read_io_gi_b (float) – The total amount of data in GiB read from disk by all tasks in the job.
  • write_io_gi_b (float) – The total amount of data in GiB written to disk by all tasks in the job.
  • num_succeeded_tasks (long) – The total number of tasks successfully completed in the job during the given time range. A task completes successfully if it returns exit code 0.
  • num_failed_tasks (long) – The total number of tasks in the job that failed during the given time range. A task fails if it exhausts its maximum retry count without returning exit code 0.
  • num_task_retries (long) – The total number of retries on all the tasks in the job during the given time range.
  • wait_time (timedelta) – The total wait time of all tasks in the job. The wait time for a task is defined as the elapsed time between the creation of the task and the start of task execution. (If the task is retried due to failures, the wait time is the time to the most recent task execution.) This value is only reported in the account lifetime statistics; it is not included in the job statistics.
class azure.batch.models.NameValuePair(name=None, value=None)[source]

Bases: msrest.serialization.Model

Represents a name-value pair.

Parameters:
  • name (str) – The name in the name-value pair.
  • value (str) – The value in the name-value pair.
class azure.batch.models.DeleteCertificateError(code=None, message=None, values=None)[source]

Bases: msrest.serialization.Model

An error encountered by the Batch service when deleting a certificate.

Parameters:
  • code (str) – An identifier for the certificate deletion error. Codes are invariant and are intended to be consumed programmatically.
  • message (str) – A message describing the certificate deletion error, intended to be suitable for display in a user interface.
  • values (list of NameValuePair) – A list of additional error details related to the certificate deletion error. This list includes details such as the active pools and nodes referencing this certificate. However, if a large number of resources reference the certificate, the list contains only about the first hundred.
class azure.batch.models.Certificate(thumbprint=None, thumbprint_algorithm=None, url=None, state=None, state_transition_time=None, previous_state=None, previous_state_transition_time=None, public_data=None, delete_certificate_error=None)[source]

Bases: msrest.serialization.Model

A certificate that can be installed on compute nodes and can be used to authenticate operations on the machine.

Parameters:
  • thumbprint (str) – The X.509 thumbprint of the certificate. This is a sequence of up to 40 hex digits.
  • thumbprint_algorithm (str) – The algorithm used to derive the thumbprint.
  • url (str) – The URL of the certificate.
  • state (str or CertificateState) – The current state of the certificate. Possible values include: ‘active’, ‘deleting’, ‘deleteFailed’
  • state_transition_time (datetime) – The time at which the certificate entered its current state.
  • previous_state (str or CertificateState) – The previous state of the certificate. This property is not set if the certificate is in its initial active state. Possible values include: ‘active’, ‘deleting’, ‘deleteFailed’
  • previous_state_transition_time (datetime) – The time at which the certificate entered its previous state. This property is not set if the certificate is in its initial Active state.
  • public_data (str) – The public part of the certificate as a base-64 encoded .cer file.
  • delete_certificate_error (DeleteCertificateError) – The error that occurred on the last attempt to delete this certificate. This property is set only if the certificate is in the DeleteFailed state.
class azure.batch.models.ApplicationPackageReference(application_id, version=None)[source]

Bases: msrest.serialization.Model

A reference to an application package to be deployed to compute nodes.

Parameters:
  • application_id (str) – The ID of the application to deploy.
  • version (str) – The version of the application to deploy. If omitted, the default version is deployed. If this is omitted, and no default version is specified for this application, the request fails with the error code InvalidApplicationPackageReferences. If you are calling the REST API directly, the HTTP status code is 409.
class azure.batch.models.ApplicationSummary(id, display_name, versions)[source]

Bases: msrest.serialization.Model

Contains information about an application in an Azure Batch account.

Parameters:
  • id (str) – A string that uniquely identifies the application within the account.
  • display_name (str) – The display name for the application.
  • versions (list of str) – The versions of the application which are available.
class azure.batch.models.CertificateAddParameter(thumbprint, thumbprint_algorithm, data, certificate_format=None, password=None)[source]

Bases: msrest.serialization.Model

A certificate that can be installed on compute nodes and can be used to authenticate operations on the machine.

Parameters:
  • thumbprint (str) – The X.509 thumbprint of the certificate. This is a sequence of up to 40 hex digits (it may include spaces but these are removed).
  • thumbprint_algorithm (str) – The algorithm used to derive the thumbprint. This must be sha1.
  • data (str) – The base64-encoded contents of the certificate. The maximum size is 10KB.
  • certificate_format (str or CertificateFormat) – The format of the certificate data. Possible values include: ‘pfx’, ‘cer’
  • password (str) – The password to access the certificate’s private key. This is required if the certificate format is pfx. It should be omitted if the certificate format is cer.
class azure.batch.models.FileProperties(last_modified, content_length, creation_time=None, content_type=None, file_mode=None)[source]

Bases: msrest.serialization.Model

The properties of a file on a compute node.

Parameters:
  • creation_time (datetime) – The file creation time. The creation time is not returned for files on Linux compute nodes.
  • last_modified (datetime) – The time at which the file was last modified.
  • content_length (long) – The length of the file.
  • content_type (str) – The content type of the file.
  • file_mode (str) – The file mode attribute in octal format. The file mode is returned only for files on Linux compute nodes.
class azure.batch.models.NodeFile(name=None, url=None, is_directory=None, properties=None)[source]

Bases: msrest.serialization.Model

Information about a file or directory on a compute node.

Parameters:
  • name (str) – The file path.
  • url (str) – The URL of the file.
  • is_directory (bool) – Whether the object represents a directory.
  • properties (FileProperties) – The file properties.
class azure.batch.models.Schedule(do_not_run_until=None, do_not_run_after=None, start_window=None, recurrence_interval=None)[source]

Bases: msrest.serialization.Model

The schedule according to which jobs will be created.

Parameters:
  • do_not_run_until (datetime) – The earliest time at which any job may be created under this job schedule. If you do not specify a doNotRunUntil time, the schedule becomes ready to create jobs immediately.
  • do_not_run_after (datetime) – A time after which no job will be created under this job schedule. The schedule will move to the completed state as soon as this deadline is past and there is no active job under this job schedule. If you do not specify a doNotRunAfter time, and you are creating a recurring job schedule, the job schedule will remain active until you explicitly terminate it.
  • start_window (timedelta) – The time interval, starting from the time at which the schedule indicates a job should be created, within which a job must be created. If a job is not created within the startWindow interval, then the ‘opportunity’ is lost; no job will be created until the next recurrence of the schedule. If the schedule is recurring, and the startWindow is longer than the recurrence interval, then this is equivalent to an infinite startWindow, because the job that is ‘due’ in one recurrenceInterval is not carried forward into the next recurrence interval. The default is infinite. The minimum value is 1 minute. If you specify a lower value, the Batch service rejects the schedule with an error; if you are calling the REST API directly, the HTTP status code is 400 (Bad Request).
  • recurrence_interval (timedelta) – The time interval between the start times of two successive jobs under the job schedule. A job schedule can have at most one active job under it at any given time. Because a job schedule can have at most one active job under it at any given time, if it is time to create a new job under a job schedule, but the previous job is still running, the Batch service will not create the new job until the previous job finishes. If the previous job does not finish within the startWindow period of the new recurrenceInterval, then no new job will be scheduled for that interval. For recurring jobs, you should normally specify a jobManagerTask in the jobSpecification. If you do not use jobManagerTask, you will need an external process to monitor when jobs are created, add tasks to the jobs and terminate the jobs ready for the next recurrence. The default is that the schedule does not recur: one job is created, within the startWindow after the doNotRunUntil time, and the schedule is complete as soon as that job finishes. The minimum value is 1 minute. If you specify a lower value, the Batch service rejects the schedule with an error; if you are calling the REST API directly, the HTTP status code is 400 (Bad Request).
class azure.batch.models.JobConstraints(max_wall_clock_time=None, max_task_retry_count=None)[source]

Bases: msrest.serialization.Model

The execution constraints for a job.

Parameters:
  • max_wall_clock_time (timedelta) – The maximum elapsed time that the job may run, measured from the time the job is created. If the job does not complete within the time limit, the Batch service terminates it and any tasks that are still running. In this case, the termination reason will be MaxWallClockTimeExpiry. If this property is not specified, there is no time limit on how long the job may run.
  • max_task_retry_count (int) – The maximum number of times each task may be retried. The Batch service retries a task if its exit code is nonzero. Note that this value specifically controls the number of retries. The Batch service will try each task once, and may then retry up to this limit. For example, if the maximum retry count is 3, Batch tries a task up to 4 times (one initial try and 3 retries). If the maximum retry count is 0, the Batch service does not retry tasks. If the maximum retry count is -1, the Batch service retries tasks without limit. The default value is 0 (no retries).
class azure.batch.models.ResourceFile(blob_source, file_path, file_mode=None)[source]

Bases: msrest.serialization.Model

A file to be downloaded from Azure blob storage to a compute node.

Parameters:
  • blob_source (str) – The URL of the file within Azure Blob Storage. This URL must be readable using anonymous access; that is, the Batch service does not present any credentials when downloading the blob. There are two ways to get such a URL for a blob in Azure storage: include a Shared Access Signature (SAS) granting read permissions on the blob, or set the ACL for the blob or its container to allow public access.
  • file_path (str) – The location on the compute node to which to download the file, relative to the task’s working directory.
  • file_mode (str) – The file permission mode attribute in octal format. This property applies only to files being downloaded to Linux compute nodes. It will be ignored if it is specified for a resourceFile which will be downloaded to a Windows node. If this property is not specified for a Linux node, then a default value of 0770 is applied to the file.
class azure.batch.models.EnvironmentSetting(name, value=None)[source]

Bases: msrest.serialization.Model

An environment variable to be set on a task process.

Parameters:
  • name (str) – The name of the environment variable.
  • value (str) – The value of the environment variable.
class azure.batch.models.ExitOptions(job_action=None, dependency_action=None)[source]

Bases: msrest.serialization.Model

Specifies how the Batch service responds to a particular exit condition.

Parameters:
  • job_action (str or JobAction) – An action to take on the job containing the task, if the task completes with the given exit condition and the job’s onTaskFailed property is ‘performExitOptionsJobAction’. The default is none for exit code 0 and terminate for all other exit conditions. If the job’s onTaskFailed property is noAction, then specify this property returns an error. The add task request fails with an invalid property value error;; if you are calling the REST API directly, the HTTP status code is 400 (Bad Request). Possible values include: ‘none’, ‘disable’, ‘terminate’
  • dependency_action (str or DependencyAction) – An action that the Batch service performs on tasks that depend on this task. The default is ‘satisfy’ for exit code 0, and ‘block’ for all other exit conditions. If the job’s usesTaskDependencies property is set to false, then specifying the dependencyAction property returns an error. The add task request fails with an invalid property value error; if you are calling the REST API directly, the HTTP status code is 400 (Bad Request). Possible values include: ‘satisfy’, ‘block’
class azure.batch.models.ExitCodeMapping(code, exit_options)[source]

Bases: msrest.serialization.Model

How the Batch service should respond if a task exits with a particular exit code.

Parameters:
  • code (int) – A process exit code.
  • exit_options (ExitOptions) – How the Batch service should respond if the task exits with this exit code.
class azure.batch.models.ExitCodeRangeMapping(start, end, exit_options)[source]

Bases: msrest.serialization.Model

A range of exit codes and how the Batch service should respond to exit codes within that range.

Parameters:
  • start (int) – The first exit code in the range.
  • end (int) – The last exit code in the range.
  • exit_options (ExitOptions) – How the Batch service should respond if the task exits with an exit code in the range start to end (inclusive).
class azure.batch.models.ExitConditions(exit_codes=None, exit_code_ranges=None, pre_processing_error=None, file_upload_error=None, default=None)[source]

Bases: msrest.serialization.Model

Specifies how the Batch service should respond when the task completes.

Parameters:
  • exit_codes (list of ExitCodeMapping) – A list of individual task exit codes and how the Batch service should respond to them.
  • exit_code_ranges (list of ExitCodeRangeMapping) – A list of task exit code ranges and how the Batch service should respond to them.
  • pre_processing_error (ExitOptions) – How the Batch service should respond if the task fails to start due to an error.
  • file_upload_error (ExitOptions) – How the Batch service should respond if a file upload error occurs. If the task exited with an exit code that was specified via exitCodes or exitCodeRanges, and then encountered a file upload error, then the action specified by the exit code takes precedence.
  • default (ExitOptions) – How the Batch service should respond if the task fails with an exit condition not covered by any of the other properties. This value is used if the task exits with any nonzero exit code not listed in the exitCodes or exitCodeRanges collection, with a pre-processing error if the preProcessingError property is not present, or with a file upload error if the fileUploadError property is not present. If you want non-default behaviour on exit code 0, you must list it explicitly using the exitCodes or exitCodeRanges collection.
class azure.batch.models.AutoUserSpecification(scope=None, elevation_level=None)[source]

Bases: msrest.serialization.Model

Specifies the parameters for the auto user that runs a task on the Batch service.

Parameters:
  • scope (str or AutoUserScope) – The scope for the auto user. pool - specifies that the task runs as the common auto user account which is created on every node in a pool. task - specifies that the service should create a new user for the task. The default value is task. Possible values include: ‘task’, ‘pool’
  • elevation_level (str or ElevationLevel) – The elevation level of the auto user. nonAdmin - The auto user is a standard user without elevated access. admin - The auto user is a user with elevated access and operates with full Administrator permissions. The default value is nonAdmin. Possible values include: ‘nonAdmin’, ‘admin’
class azure.batch.models.UserIdentity(user_name=None, auto_user=None)[source]

Bases: msrest.serialization.Model

The definition of the user identity under which the task is run.

Specify either the userName or autoUser property, but not both.

Parameters:
  • user_name (str) – The name of the user identity under which the task is run. The userName and autoUser properties are mutually exclusive; you must specify one but not both.
  • auto_user (AutoUserSpecification) – The auto user under which the task is run. The userName and autoUser properties are mutually exclusive; you must specify one but not both.
class azure.batch.models.LinuxUserConfiguration(uid=None, gid=None, ssh_private_key=None)[source]

Bases: msrest.serialization.Model

Properties used to create a user account on a Linux node.

Parameters:
  • uid (int) – The user ID of the user account. The uid and gid properties must be specified together or not at all. If not specified the underlying operating system picks the uid.
  • gid (int) – The group ID for the user account. The uid and gid properties must be specified together or not at all. If not specified the underlying operating system picks the gid.
  • ssh_private_key (str) – The SSH private key for the user account. The private key must not be password protected. The private key is used to automatically configure asymmetric-key based authentication for SSH between nodes in a Linux pool when the pool’s enableInterNodeCommunication property is true (it is ignored if enableInterNodeCommunication is false). It does this by placing the key pair into the user’s .ssh directory. If not specified, password-less SSH is not configured between nodes (no modification of the user’s .ssh directory is done).
class azure.batch.models.UserAccount(name, password, elevation_level=None, linux_user_configuration=None)[source]

Bases: msrest.serialization.Model

Properties used to create a user used to execute tasks on an Azure Batch node.

Parameters:
  • name (str) – The name of the user account.
  • password (str) – The password for the user account.
  • elevation_level (str or ElevationLevel) – The elevation level of the user account. nonAdmin - The auto user is a standard user without elevated access. admin - The auto user is a user with elevated access and operates with full Administrator permissions. The default value is nonAdmin. Possible values include: ‘nonAdmin’, ‘admin’
  • linux_user_configuration (LinuxUserConfiguration) – The Linux-specific user configuration for the user account. This property is ignored if specified on a Windows pool. If not specified, the user is created with the default options.
class azure.batch.models.TaskConstraints(max_wall_clock_time=None, retention_time=None, max_task_retry_count=None)[source]

Bases: msrest.serialization.Model

Execution constraints to apply to a task.

Parameters:
  • max_wall_clock_time (timedelta) – The maximum elapsed time that the task may run, measured from the time the task starts. If the task does not complete within the time limit, the Batch service terminates it. If this is not specified, there is no time limit on how long the task may run.
  • retention_time (timedelta) – The minimum time to retain the task directory on the compute node where it ran, from the time it completes execution. After this time, the Batch service may delete the task directory and all its contents. The default is infinite, i.e. the task directory will be retained until the compute node is removed or reimaged.
  • max_task_retry_count (int) – The maximum number of times the task may be retried. The Batch service retries a task if its exit code is nonzero. Note that this value specifically controls the number of retries. The Batch service will try the task once, and may then retry up to this limit. For example, if the maximum retry count is 3, Batch tries the task up to 4 times (one initial try and 3 retries). If the maximum retry count is 0, the Batch service does not retry the task. If the maximum retry count is -1, the Batch service retries the task without limit.
class azure.batch.models.OutputFileBlobContainerDestination(container_url, path=None)[source]

Bases: msrest.serialization.Model

Specifies a file upload destination within an Azure blob storage container.

Parameters:
  • path (str) – The destination blob or virtual directory within the Azure Storage container. If filePattern refers to a specific file (i.e. contains no wildcards), then path is the name of the blob to which to upload that file. If filePattern contains one or more wildcards (and therefore may match multiple files), then path is the name of the blob virtual directory (which is prepended to each blob name) to which to upload the file(s). If omitted, file(s) are uploaded to the root of the container with a blob name matching their file name.
  • container_url (str) – The URL of the container within Azure Blob Storage to which to upload the file(s). The URL must include a Shared Access Signature (SAS) granting write permissions to the container.
class azure.batch.models.OutputFileDestination(container=None)[source]

Bases: msrest.serialization.Model

The destination to which a file should be uploaded.

Parameters:container (OutputFileBlobContainerDestination) – A location in Azure blob storage to which files are uploaded.
class azure.batch.models.OutputFileUploadOptions(upload_condition)[source]

Bases: msrest.serialization.Model

Details about an output file upload operation, including under what conditions to perform the upload.

Parameters:upload_condition (str or OutputFileUploadCondition) – The conditions under which the task output file or set of files should be uploaded. The default is taskCompletion. Possible values include: ‘taskSuccess’, ‘taskFailure’, ‘taskCompletion’
class azure.batch.models.OutputFile(file_pattern, destination, upload_options)[source]

Bases: msrest.serialization.Model

A specification for uploading files from an Azure Batch node to another location after the Batch service has finished executing the task process.

Parameters:
  • file_pattern (str) – A pattern indicating which file(s) to upload. Both relative and absolute paths are supported. Relative paths are relative to the task working directory. For wildcards, use * to match any character and ** to match any directory. For example, ***.txt matches any file ending in .txt in the task working directory or any subdirectory. Note that and / are treated interchangeably and mapped to the correct directory separator on the compute node operating system.
  • destination (OutputFileDestination) – The destination for the output file(s).
  • upload_options (OutputFileUploadOptions) – Additional options for the upload operation, including under what conditions to perform the upload.
class azure.batch.models.JobManagerTask(id, command_line, display_name=None, resource_files=None, output_files=None, environment_settings=None, constraints=None, kill_job_on_completion=None, user_identity=None, run_exclusive=None, application_package_references=None, authentication_token_settings=None, allow_low_priority_node=None)[source]

Bases: msrest.serialization.Model

Specifies details of a Job Manager task.

Parameters:
  • id (str) – A string that uniquely identifies the Job Manager taskwithin the job. The id can contain any combination of alphanumeric characters including hyphens and underscores and cannot contain more than 64 characters.
  • display_name (str) – The display name of the Job Manager task. It need not be unique and can contain any Unicode characters up to a maximum length of 1024.
  • command_line (str) – The command line of the Job Manager task. The command line does not run under a shell, and therefore cannot take advantage of shell features such as environment variable expansion. If you want to take advantage of such features, you should invoke the shell in the command line, for example using “cmd /c MyCommand” in Windows or “/bin/sh -c MyCommand” in Linux.
  • resource_files (list of ResourceFile) – A list of files that the Batch service will download to the compute node before running the command line. Files listed under this element are located in the task’s working directory.
  • output_files (list of OutputFile) – A list of files that the Batch service will upload from the compute node after running the command line.
  • environment_settings (list of EnvironmentSetting) – A list of environment variable settings for the Job Manager task.
  • constraints (TaskConstraints) – Constraints that apply to the Job Manager task.
  • kill_job_on_completion (bool) – Whether completion of the Job Manager task signifies completion of the entire job. If true, when the Job Manager task completes, the Batch service marks the job as complete. If any tasks are still running at this time (other than Job Release), those tasks are terminated. If false, the completion of the Job Manager task does not affect the job status. In this case, you should either use the onAllTasksComplete attribute to terminate the job, or have a client or user terminate the job explicitly. An example of this is if the Job Manager creates a set of tasks but then takes no further role in their execution. The default value is true. If you are using the onAllTasksComplete and onTaskFailure attributes to control job lifetime, and using the Job Manager task only to create the tasks for the job (not to monitor progress), then it is important to set killJobOnCompletion to false.
  • user_identity (UserIdentity) – The user identity under which the Job Manager task runs. If omitted, the task runs as a non-administrative user unique to the task.
  • run_exclusive (bool) – Whether the Job Manager task requires exclusive use of the compute node where it runs. If true, no other tasks will run on the same compute node for as long as the Job Manager is running. If false, other tasks can run simultaneously with the Job Manager on a compute node. The Job Manager task counts normally against the node’s concurrent task limit, so this is only relevant if the node allows multiple concurrent tasks. The default value is true.
  • application_package_references (list of ApplicationPackageReference) – A list of application packages that the Batch service will deploy to the compute node before running the command line. Application packages are downloaded and deployed to a shared directory, not the task directory. Therefore, if a referenced package is already on the compute node, and is up to date, then it is not re-downloaded; the existing copy on the compute node is used. If a referenced application package cannot be installed, for example because the package has been deleted or because download failed, the task fails with a scheduling error. This property is currently not supported on jobs running on pools created using the virtualMachineConfiguration (IaaS) property. If a task specifying applicationPackageReferences runs on such a pool, it fails with a scheduling error with code TaskSchedulingConstraintFailed.
  • authentication_token_settings (AuthenticationTokenSettings) – The settings for an authentication token that the task can use to perform Batch service operations. If this property is set, the Batch service provides the task with an authentication token which can be used to authenticate Batch service operations without requiring an account access key. The token is provided via the AZ_BATCH_AUTHENTICATION_TOKEN environment variable. The operations that the task can carry out using the token depend on the settings. For example, a task can request job permissions in order to add other tasks to the job, or check the status of the job or of other tasks under the job.
  • allow_low_priority_node (bool) – Whether the Job Manager task may run on a low-priority compute node. The default value is false.
class azure.batch.models.JobPreparationTask(command_line, id=None, resource_files=None, environment_settings=None, constraints=None, wait_for_success=None, user_identity=None, rerun_on_node_reboot_after_success=None)[source]

Bases: msrest.serialization.Model

A Job Preparation task to run before any tasks of the job on any given compute node.

Parameters:
  • id (str) – A string that uniquely identifies the Job Preparation task within the job. The ID can contain any combination of alphanumeric characters including hyphens and underscores and cannot contain more than 64 characters. If you do not specify this property, the Batch service assigns a default value of ‘jobpreparation’. No other task in the job can have the same id as the Job Preparation task. If you try to submit a task with the same id, the Batch service rejects the request with error code TaskIdSameAsJobPreparationTask; if you are calling the REST API directly, the HTTP status code is 409 (Conflict).
  • command_line (str) – The command line of the Job Preparation task. The command line does not run under a shell, and therefore cannot take advantage of shell features such as environment variable expansion. If you want to take advantage of such features, you should invoke the shell in the command line, for example using “cmd /c MyCommand” in Windows or “/bin/sh -c MyCommand” in Linux.
  • resource_files (list of ResourceFile) – A list of files that the Batch service will download to the compute node before running the command line. Files listed under this element are located in the task’s working directory.
  • environment_settings (list of EnvironmentSetting) – A list of environment variable settings for the Job Preparation task.
  • constraints (TaskConstraints) – Constraints that apply to the Job Preparation task.
  • wait_for_success (bool) – Whether the Batch service should wait for the Job Preparation task to complete successfully before scheduling any other tasks of the job on the compute node. If true and the Job Preparation task fails on a compute node, the Batch service retries the Job Preparation task up to its maximum retry count (as specified in the constraints element). If the task has still not completed successfully after all retries, then the Batch service will not schedule tasks of the job to the compute node. The compute node remains active and eligible to run tasks of other jobs. If false, the Batch service will not wait for the Job Preparation task to complete. In this case, other tasks of the job can start executing on the compute node while the Job Preparation task is still running; and even if the Job Preparation task fails, new tasks will continue to be scheduled on the node. The default value is true.
  • user_identity (UserIdentity) – The user identity under which the Job Preparation task runs. If omitted, the task runs as a non-administrative user unique to the task.
  • rerun_on_node_reboot_after_success (bool) – Whether the Batch service should rerun the Job Preparation task after a compute node reboots. The Job Preparation task is always rerun if a compute node is reimaged, or if the Job Preparation task did not complete (e.g. because the reboot occurred while the task was running). Therefore, you should always write a Job Preparation task to be idempotent and to behave correctly if run multiple times. The default value is true.
class azure.batch.models.JobReleaseTask(command_line, id=None, resource_files=None, environment_settings=None, max_wall_clock_time=None, retention_time=None, user_identity=None)[source]

Bases: msrest.serialization.Model

A Job Release task to run on job completion on any compute node where the job has run.

Parameters:
  • id (str) – A string that uniquely identifies the Job Release task within the job. The ID can contain any combination of alphanumeric characters including hyphens and underscores and cannot contain more than 64 characters. If you do not specify this property, the Batch service assigns a default value of ‘jobrelease’. No other task in the job can have the same id as the Job Release task. If you try to submit a task with the same id, the Batch service rejects the request with error code TaskIdSameAsJobReleaseTask; if you are calling the REST API directly, the HTTP status code is 409 (Conflict).
  • command_line (str) – The command line of the Job Release task. The command line does not run under a shell, and therefore cannot take advantage of shell features such as environment variable expansion. If you want to take advantage of such features, you should invoke the shell in the command line, for example using “cmd /c MyCommand” in Windows or “/bin/sh -c MyCommand” in Linux.
  • resource_files (list of ResourceFile) – A list of files that the Batch service will download to the compute node before running the command line. Files listed under this element are located in the task’s working directory.
  • environment_settings (list of EnvironmentSetting) – A list of environment variable settings for the Job Release task.
  • max_wall_clock_time (timedelta) – The maximum elapsed time that the Job Release task may run on a given compute node, measured from the time the task starts. If the task does not complete within the time limit, the Batch service terminates it. The default value is 15 minutes. You may not specify a timeout longer than 15 minutes. If you do, the Batch service rejects it with an error; if you are calling the REST API directly, the HTTP status code is 400 (Bad Request).
  • retention_time (timedelta) – The minimum time to retain the task directory for the Job Release task on the compute node. After this time, the Batch service may delete the task directory and all its contents. The default is infinite, i.e. the task directory will be retained until the compute node is removed or reimaged.
  • user_identity (UserIdentity) – The user identity under which the Job Release task runs. If omitted, the task runs as a non-administrative user unique to the task.
class azure.batch.models.TaskSchedulingPolicy(node_fill_type)[source]

Bases: msrest.serialization.Model

Specifies how tasks should be distributed across compute nodes.

Parameters:node_fill_type (str or ComputeNodeFillType) – How tasks should be distributed across compute nodes. Possible values include: ‘spread’, ‘pack’
class azure.batch.models.StartTask(command_line, resource_files=None, environment_settings=None, user_identity=None, max_task_retry_count=None, wait_for_success=None)[source]

Bases: msrest.serialization.Model

A task which is run when a compute node joins a pool in the Azure Batch service, or when the compute node is rebooted or reimaged.

Parameters:
  • command_line (str) – The command line of the start task. The command line does not run under a shell, and therefore cannot take advantage of shell features such as environment variable expansion. If you want to take advantage of such features, you should invoke the shell in the command line, for example using “cmd /c MyCommand” in Windows or “/bin/sh -c MyCommand” in Linux.
  • resource_files (list of ResourceFile) – A list of files that the Batch service will download to the compute node before running the command line.
  • environment_settings (list of EnvironmentSetting) – A list of environment variable settings for the start task.
  • user_identity (UserIdentity) – The user identity under which the start task runs. If omitted, the task runs as a non-administrative user unique to the task.
  • max_task_retry_count (int) – The maximum number of times the task may be retried. The Batch service retries a task if its exit code is nonzero. Note that this value specifically controls the number of retries. The Batch service will try the task once, and may then retry up to this limit. For example, if the maximum retry count is 3, Batch tries the task up to 4 times (one initial try and 3 retries). If the maximum retry count is 0, the Batch service does not retry the task. If the maximum retry count is -1, the Batch service retries the task without limit.
  • wait_for_success (bool) – Whether the Batch service should wait for the start task to complete successfully (that is, to exit with exit code 0) before scheduling any tasks on the compute node. If true and the start task fails on a compute node, the Batch service retries the start task up to its maximum retry count (maxTaskRetryCount). If the task has still not completed successfully after all retries, then the Batch service marks the compute node unusable, and will not schedule tasks to it. This condition can be detected via the node state and scheduling error detail. If false, the Batch service will not wait for the start task to complete. In this case, other tasks can start executing on the compute node while the start task is still running; and even if the start task fails, new tasks will continue to be scheduled on the node. The default is false.
class azure.batch.models.CertificateReference(thumbprint, thumbprint_algorithm, store_location=None, store_name=None, visibility=None)[source]

Bases: msrest.serialization.Model

A reference to a certificate to be installed on compute nodes in a pool.

Parameters:
  • thumbprint (str) – The thumbprint of the certificate.
  • thumbprint_algorithm (str) – The algorithm with which the thumbprint is associated. This must be sha1.
  • store_location (str or CertificateStoreLocation) – The location of the certificate store on the compute node into which to install the certificate. The default value is currentUser. This property is applicable only for pools configured with Windows nodes (that is, created with cloudServiceConfiguration, or with virtualMachineConfiguration using a Windows image reference). For Linux compute nodes, the certificates are stored in a directory inside the task working directory and an environment variable AZ_BATCH_CERTIFICATES_DIR is supplied to the task to query for this location. For certificates with visibility of ‘remoteUser’, a ‘certs’ directory is created in the user’s home directory (e.g., /home/{user-name}/certs) and certificates are placed in that directory. Possible values include: ‘currentUser’, ‘localMachine’
  • store_name (str) – The name of the certificate store on the compute node into which to install the certificate. The default value is My. This property is applicable only for pools configured with Windows nodes (that is, created with cloudServiceConfiguration, or with virtualMachineConfiguration using a Windows image reference).
  • visibility (list of str or CertificateVisibility) – Which user accounts on the compute node should have access to the private data of the certificate. The default is all accounts.
class azure.batch.models.MetadataItem(name, value)[source]

Bases: msrest.serialization.Model

A name-value pair associated with a Batch service resource.

The Batch service does not assign any meaning to this metadata; it is solely for the use of user code.

Parameters:
  • name (str) – The name of the metadata item.
  • value (str) – The value of the metadata item.
class azure.batch.models.CloudServiceConfiguration(os_family, target_os_version=None, current_os_version=None)[source]

Bases: msrest.serialization.Model

The configuration for nodes in a pool based on the Azure Cloud Services platform.

Parameters:
  • os_family (str) – The Azure Guest OS family to be installed on the virtual machines in the pool. Possible values are: 2 - OS Family 2, equivalent to Windows Server 2008 R2 SP1. 3 - OS Family 3, equivalent to Windows Server 2012. 4 - OS Family 4, equivalent to Windows Server 2012 R2. 5 - OS Family 5, equivalent to Windows Server 2016. For more information, see Azure Guest OS Releases (https://azure.microsoft.com/documentation/articles/cloud-services-guestos-update-matrix/#releases).
  • target_os_version (str) – The Azure Guest OS version to be installed on the virtual machines in the pool. The default value is * which specifies the latest operating system version for the specified OS family.
  • current_os_version (str) – The Azure Guest OS Version currently installed on the virtual machines in the pool. This may differ from targetOSVersion if the pool state is Upgrading. In this case some virtual machines may be on the targetOSVersion and some may be on the currentOSVersion during the upgrade process. Once all virtual machines have upgraded, currentOSVersion is updated to be the same as targetOSVersion.
class azure.batch.models.OSDisk(image_uris, caching=None)[source]

Bases: msrest.serialization.Model

A reference to an OS disk image.

Parameters:
  • image_uris (list of str) – The collection of Virtual Hard Disk (VHD) URIs. All the VHDs must be identical and must reside in an Azure Storage account within the same subscription and same region as the Batch account. For best performance, it is recommended that each VHD resides in a separate Azure Storage account. Each VHD can serve upto 20 Windows compute nodes or 40 Linux compute nodes. You must supply enough VHD URIs to satisfy the ‘targetDedicated’ property of the pool. If you do not supply enough VHD URIs, the pool will partially allocate compute nodes, and a resize error will occur.
  • caching (str or CachingType) – The type of caching to enable for the OS disk. none - The caching mode for the disk is not enabled. readOnly - The caching mode for the disk is read only. readWrite - The caching mode for the disk is read and write. The default value for caching is none. For information about the caching options see: https://blogs.msdn.microsoft.com/windowsazurestorage/2012/06/27/exploring-windows-azure-drives-disks-and-images/. Possible values include: ‘none’, ‘readOnly’, ‘readWrite’
class azure.batch.models.WindowsConfiguration(enable_automatic_updates=None)[source]

Bases: msrest.serialization.Model

Windows operating system settings to apply to the virtual machine.

Parameters:enable_automatic_updates (bool) – Whether automatic updates are enabled on the virtual machine. If omitted, the default value is true.
class azure.batch.models.VirtualMachineConfiguration(node_agent_sku_id, image_reference=None, os_disk=None, windows_configuration=None)[source]

Bases: msrest.serialization.Model

The configuration for compute nodes in a pool based on the Azure Virtual Machines infrastructure.

Parameters:
  • image_reference (ImageReference) – A reference to the Azure Virtual Machines Marketplace image to use. This property and osDisk are mutually exclusive and one of the properties must be specified.
  • os_disk (OSDisk) – A reference to the OS disk image to use. This property can be specified only if the Batch account was created with its poolAllocationMode property set to ‘UserSubscription’. This property and imageReference are mutually exclusive and one of the properties must be specified.
  • node_agent_sku_id (str) – The SKU of the Batch node agent to be provisioned on compute nodes in the pool. The Batch node agent is a program that runs on each node in the pool, and provides the command-and-control interface between the node and the Batch service. There are different implementations of the node agent, known as SKUs, for different operating systems. You must specify a node agent SKU which matches the selected image reference. To get the list of supported node agent SKUs along with their list of verified image references, see the ‘List supported node agent SKUs’ operation.
  • windows_configuration (WindowsConfiguration) – Windows operating system settings on the virtual machine. This property must not be specified if the imageReference or osDisk property specifies a Linux OS image.
class azure.batch.models.NetworkConfiguration(subnet_id=None)[source]

Bases: msrest.serialization.Model

The network configuration for a pool.

Parameters:subnet_id (str) – The ARM resource identifier of the virtual network subnet which the compute nodes of the pool will join. This is of the form /subscriptions/{subscription}/resourceGroups/{group}/providers/{provider}/virtualNetworks/{network}/subnets/{subnet}. The virtual network must be in the same region and subscription as the Azure Batch account. The specified subnet should have enough free IP addresses to accommodate the number of nodes in the pool. If the subnet doesn’t have enough free IP addresses, the pool will partially allocate compute nodes, and a resize error will occur. The Batch service principal, named ‘Microsoft Azure Batch’ or ‘MicrosoftAzureBatch’, must have the ‘Classic Virtual Machine Contributor’ Role-Based Access Control (RBAC) role for the specified VNet. The specified subnet must allow communication from the Azure Batch service to be able to schedule tasks on the compute nodes. This can be verified by checking if the specified VNet has any associated Network Security Groups (NSG). If communication to the compute nodes in the specified subnet is denied by an NSG, then the Batch service will set the state of the compute nodes to unusable. For pools created via virtualMachineConfiguration the Batch account must have poolAllocationMode userSubscription in order to use a VNet.
class azure.batch.models.PoolSpecification(vm_size, display_name=None, cloud_service_configuration=None, virtual_machine_configuration=None, max_tasks_per_node=None, task_scheduling_policy=None, resize_timeout=None, target_dedicated_nodes=None, target_low_priority_nodes=None, enable_auto_scale=None, auto_scale_formula=None, auto_scale_evaluation_interval=None, enable_inter_node_communication=None, network_configuration=None, start_task=None, certificate_references=None, application_package_references=None, application_licenses=None, user_accounts=None, metadata=None)[source]

Bases: msrest.serialization.Model

Specification for creating a new pool.

Parameters:
  • display_name (str) – The display name for the pool. The display name need not be unique and can contain any Unicode characters up to a maximum length of 1024.
  • vm_size (str) – The size of the virtual machines in the pool. All virtual machines in a pool are the same size. For information about available sizes of virtual machines for Cloud Services pools (pools created with cloudServiceConfiguration), see Sizes for Cloud Services (http://azure.microsoft.com/documentation/articles/cloud-services-sizes-specs/). Batch supports all Cloud Services VM sizes except ExtraSmall, A1V2 and A2V2. For information about available VM sizes for pools using images from the Virtual Machines Marketplace (pools created with virtualMachineConfiguration) see Sizes for Virtual Machines (Linux) (https://azure.microsoft.com/documentation/articles/virtual-machines-linux-sizes/) or Sizes for Virtual Machines (Windows) (https://azure.microsoft.com/documentation/articles/virtual-machines-windows-sizes/). Batch supports all Azure VM sizes except STANDARD_A0 and those with premium storage (STANDARD_GS, STANDARD_DS, and STANDARD_DSV2 series).
  • cloud_service_configuration (CloudServiceConfiguration) – The cloud service configuration for the pool. This property must be specified if the pool needs to be created with Azure PaaS VMs. This property and virtualMachineConfiguration are mutually exclusive and one of the properties must be specified. If neither is specified then the Batch service returns an error; if you are calling the REST API directly, the HTTP status code is 400 (Bad Request). This property cannot be specified if the Batch account was created with its poolAllocationMode property set to ‘UserSubscription’.
  • virtual_machine_configuration (VirtualMachineConfiguration) – The virtual machine configuration for the pool. This property must be specified if the pool needs to be created with Azure IaaS VMs. This property and cloudServiceConfiguration are mutually exclusive and one of the properties must be specified. If neither is specified then the Batch service returns an error; if you are calling the REST API directly, the HTTP status code is 400 (Bad Request).
  • max_tasks_per_node (int) – The maximum number of tasks that can run concurrently on a single compute node in the pool. The default value is 1. The maximum value of this setting depends on the size of the compute nodes in the pool (the vmSize setting).
  • task_scheduling_policy (TaskSchedulingPolicy) – How tasks are distributed among compute nodes in the pool.
  • resize_timeout (timedelta) – The timeout for allocation of compute nodes to the pool. This timeout applies only to manual scaling; it has no effect when enableAutoScale is set to true. The default value is 15 minutes. The minimum value is 5 minutes. If you specify a value less than 5 minutes, the Batch service rejects the request with an error; if you are calling the REST API directly, the HTTP status code is 400 (Bad Request).
  • target_dedicated_nodes (int) – The desired number of dedicated compute nodes in the pool. This property must not be specified if enableAutoScale is set to true. If enableAutoScale is set to false, then you must set either targetDedicatedNodes, targetLowPriorityNodes, or both.
  • target_low_priority_nodes (int) – The desired number of low-priority compute nodes in the pool. This property must not be specified if enableAutoScale is set to true. If enableAutoScale is set to false, then you must set either targetDedicatedNodes, targetLowPriorityNodes, or both.
  • enable_auto_scale (bool) – Whether the pool size should automatically adjust over time. If false, at least one of targetDedicateNodes and targetLowPriorityNodes must be specified. If true, the autoScaleFormula element is required. The pool automatically resizes according to the formula. The default value is false.
  • auto_scale_formula (str) – The formula for the desired number of compute nodes in the pool. This property must not be specified if enableAutoScale is set to false. It is required if enableAutoScale is set to true. The formula is checked for validity before the pool is created. If the formula is not valid, the Batch service rejects the request with detailed error information.
  • auto_scale_evaluation_interval (timedelta) – The time interval at which to automatically adjust the pool size according to the autoscale formula. The default value is 15 minutes. The minimum and maximum value are 5 minutes and 168 hours respectively. If you specify a value less than 5 minutes or greater than 168 hours, the Batch service rejects the request with an invalid property value error; if you are calling the REST API directly, the HTTP status code is 400 (Bad Request).
  • enable_inter_node_communication (bool) – Whether the pool permits direct communication between nodes. Enabling inter-node communication limits the maximum size of the pool due to deployment restrictions on the nodes of the pool. This may result in the pool not reaching its desired size. The default value is false.
  • network_configuration (NetworkConfiguration) – The network configuration for the pool.
  • start_task (StartTask) – A task to run on each compute node as it joins the pool. The task runs when the node is added to the pool or when the node is restarted.
  • certificate_references (list of CertificateReference) – A list of certificates to be installed on each compute node in the pool. For Windows compute nodes, the Batch service installs the certificates to the specified certificate store and location. For Linux compute nodes, the certificates are stored in a directory inside the task working directory and an environment variable AZ_BATCH_CERTIFICATES_DIR is supplied to the task to query for this location. For certificates with visibility of ‘remoteUser’, a ‘certs’ directory is created in the user’s home directory (e.g., /home/{user-name}/certs) and certificates are placed in that directory.
  • application_package_references (list of ApplicationPackageReference) – The list of application packages to be installed on each compute node in the pool. This property is currently not supported on auto pools created with the virtualMachineConfiguration (IaaS) property.
  • application_licenses (list of str) – The list of application licenses the Batch service will make available on each compute node in the pool. The list of application licenses must be a subset of available Batch service application licenses. If a license is requested which is not supported, pool creation will fail.
  • user_accounts (list of UserAccount) – The list of user accounts to be created on each node in the pool.
  • metadata (list of MetadataItem) – A list of name-value pairs associated with the pool as metadata. The Batch service does not assign any meaning to metadata; it is solely for the use of user code.
class azure.batch.models.AutoPoolSpecification(pool_lifetime_option, auto_pool_id_prefix=None, keep_alive=None, pool=None)[source]

Bases: msrest.serialization.Model

Specifies characteristics for a temporary ‘auto pool’. The Batch service will create this auto pool when the job is submitted.

Parameters:
  • auto_pool_id_prefix (str) – A prefix to be added to the unique identifier when a pool is automatically created. The Batch service assigns each auto pool a unique identifier on creation. To distinguish between pools created for different purposes, you can specify this element to add a prefix to the id that is assigned. The prefix can be up to 20 characters long.
  • pool_lifetime_option (str or PoolLifetimeOption) – The minimum lifetime of created auto pools, and how multiple jobs on a schedule are assigned to pools. When the pool lifetime scope is jobSchedule level, the Batch service keeps track of the last autopool created for the job schedule, and deletes that pool when the job schedule completes. Batch will also delete this pool if the user updates the auto pool specification in a way that changes this lifetime. Possible values include: ‘jobSchedule’, ‘job’
  • keep_alive (bool) – Whether to keep an auto pool alive after its lifetime expires. If false, the Batch service deletes the pool once its lifetime (as determined by the poolLifetimeOption setting) expires; that is, when the job or job schedule completes. If true, the Batch service does not delete the pool automatically. It is up to the user to delete auto pools created with this option.
  • pool (PoolSpecification) – The pool specification for the auto pool.
class azure.batch.models.PoolInformation(pool_id=None, auto_pool_specification=None)[source]

Bases: msrest.serialization.Model

Specifies how a job should be assigned to a pool.

Parameters:
  • pool_id (str) – The ID of an existing pool. All the tasks of the job will run on the specified pool. You must ensure that the pool referenced by this property exists. If the pool does not exist at the time the Batch service tries to schedule a job, no tasks for the job will run until you create a pool with that id. Note that the Batch service will not reject the job request; it will simply not run tasks until the pool exists. You must specify either the pool ID or the auto pool specification, but not both.
  • auto_pool_specification (AutoPoolSpecification) – Characteristics for a temporary ‘auto pool’. The Batch service will create this auto pool when the job is submitted. If auto pool creation fails, the Batch service moves the job to a completed state, and the pool creation error is set in the job’s scheduling error property. The Batch service manages the lifetime (both creation and, unless keepAlive is specified, deletion) of the auto pool. Any user actions that affect the lifetime of the auto pool while the job is active will result in unexpected behavior. You must specify either the pool ID or the auto pool specification, but not both.
class azure.batch.models.JobSpecification(pool_info, priority=None, display_name=None, uses_task_dependencies=None, on_all_tasks_complete=None, on_task_failure=None, constraints=None, job_manager_task=None, job_preparation_task=None, job_release_task=None, common_environment_settings=None, metadata=None)[source]

Bases: msrest.serialization.Model

Specifies details of the jobs to be created on a schedule.

Parameters:
  • priority (int) – The priority of jobs created under this schedule. Priority values can range from -1000 to 1000, with -1000 being the lowest priority and 1000 being the highest priority. The default value is 0. This priority is used as the default for all jobs under the job schedule. You can update a job’s priority after it has been created using by using the update job API.
  • display_name (str) – The display name for jobs created under this schedule. The name need not be unique and can contain any Unicode characters up to a maximum length of 1024.
  • uses_task_dependencies (bool) – The flag that determines if this job will use tasks with dependencies.
  • on_all_tasks_complete (str or OnAllTasksComplete) – The action the Batch service should take when all tasks in a job created under this schedule are in the completed state. Note that if a job contains no tasks, then all tasks are considered complete. This option is therefore most commonly used with a Job Manager task; if you want to use automatic job termination without a Job Manager, you should initially set onAllTasksComplete to noAction and update the job properties to set onAllTasksComplete to terminateJob once you have finished adding tasks. The default is noAction. Possible values include: ‘noAction’, ‘terminateJob’
  • on_task_failure (str or OnTaskFailure) – The action the Batch service should take when any task fails in a job created under this schedule. A task is considered to have failed if it completes with a non-zero exit code and has exhausted its retry count, or if it had a scheduling error. The default is noAction. Possible values include: ‘noAction’, ‘performExitOptionsJobAction’
  • constraints (JobConstraints) – The execution constraints for jobs created under this schedule.
  • job_manager_task (JobManagerTask) – The details of a Job Manager task to be launched when a job is started under this schedule. If the job does not specify a Job Manager task, the user must explicitly add tasks to the job using the Task API. If the job does specify a Job Manager task, the Batch service creates the Job Manager task when the job is created, and will try to schedule the Job Manager task before scheduling other tasks in the job.
  • job_preparation_task (JobPreparationTask) – The Job Preparation task for jobs created under this schedule. If a job has a Job Preparation task, the Batch service will run the Job Preparation task on a compute node before starting any tasks of that job on that compute node.
  • job_release_task (JobReleaseTask) – The Job Release task for jobs created under this schedule. The primary purpose of the Job Release task is to undo changes to compute nodes made by the Job Preparation task. Example activities include deleting local files, or shutting down services that were started as part of job preparation. A Job Release task cannot be specified without also specifying a Job Preparation task for the job. The Batch service runs the Job Release task on the compute nodes that have run the Job Preparation task.
  • common_environment_settings (list of EnvironmentSetting) – A list of common environment variable settings. These environment variables are set for all tasks in jobs created under this schedule (including the Job Manager, Job Preparation and Job Release tasks). Individual tasks can override an environment setting specified here by specifying the same setting name with a different value.
  • pool_info (PoolInformation) – The pool on which the Batch service runs the tasks of jobs created under this schedule.
  • metadata (list of MetadataItem) – A list of name-value pairs associated with each job created under this schedule as metadata. The Batch service does not assign any meaning to metadata; it is solely for the use of user code.
class azure.batch.models.RecentJob(id=None, url=None)[source]

Bases: msrest.serialization.Model

Information about the most recent job to run under the job schedule.

Parameters:
  • id (str) – The ID of the job.
  • url (str) – The URL of the job.
class azure.batch.models.JobScheduleExecutionInformation(next_run_time=None, recent_job=None, end_time=None)[source]

Bases: msrest.serialization.Model

Contains information about jobs that have been and will be run under a job schedule.

Parameters:
  • next_run_time (datetime) – The next time at which a job will be created under this schedule. This property is meaningful only if the schedule is in the active state when the time comes around. For example, if the schedule is disabled, no job will be created at nextRunTime unless the job is enabled before then.
  • recent_job (RecentJob) – Information about the most recent job under the job schedule. This property is present only if the at least one job has run under the schedule.
  • end_time (datetime) – The time at which the schedule ended. This property is set only if the job schedule is in the completed state.
class azure.batch.models.JobScheduleStatistics(url, start_time, last_update_time, user_cpu_time, kernel_cpu_time, wall_clock_time, read_iops, write_iops, read_io_gi_b, write_io_gi_b, num_succeeded_tasks, num_failed_tasks, num_task_retries, wait_time)[source]

Bases: msrest.serialization.Model

Resource usage statistics for a job schedule.

Parameters:
  • url (str) – The URL of the statistics.
  • start_time (datetime) – The start time of the time range covered by the statistics.
  • last_update_time (datetime) – The time at which the statistics were last updated. All statistics are limited to the range between startTime and lastUpdateTime.
  • user_cpu_time (timedelta) – The total user mode CPU time (summed across all cores and all compute nodes) consumed by all tasks in all jobs created under the schedule.
  • kernel_cpu_time (timedelta) – The total kernel mode CPU time (summed across all cores and all compute nodes) consumed by all tasks in all jobs created under the schedule.
  • wall_clock_time (timedelta) – The total wall clock time of all the tasks in all the jobs created under the schedule. The wall clock time is the elapsed time from when the task started running on a compute node to when it finished (or to the last time the statistics were updated, if the task had not finished by then). If a task was retried, this includes the wall clock time of all the task retries.
  • read_iops (long) – The total number of disk read operations made by all tasks in all jobs created under the schedule.
  • write_iops (long) – The total number of disk write operations made by all tasks in all jobs created under the schedule.
  • read_io_gi_b (float) – The total gibibytes read from disk by all tasks in all jobs created under the schedule.
  • write_io_gi_b (float) – The total gibibytes written to disk by all tasks in all jobs created under the schedule.
  • num_succeeded_tasks (long) – The total number of tasks successfully completed during the given time range in jobs created under the schedule. A task completes successfully if it returns exit code 0.
  • num_failed_tasks (long) – The total number of tasks that failed during the given time range in jobs created under the schedule. A task fails if it exhausts its maximum retry count without returning exit code 0.
  • num_task_retries (long) – The total number of retries during the given time range on all tasks in all jobs created under the schedule.
  • wait_time (timedelta) – The total wait time of all tasks in all jobs created under the schedule. The wait time for a task is defined as the elapsed time between the creation of the task and the start of task execution. (If the task is retried due to failures, the wait time is the time to the most recent task execution.). This value is only reported in the account lifetime statistics; it is not included in the job statistics.
class azure.batch.models.CloudJobSchedule(id=None, display_name=None, url=None, e_tag=None, last_modified=None, creation_time=None, state=None, state_transition_time=None, previous_state=None, previous_state_transition_time=None, schedule=None, job_specification=None, execution_info=None, metadata=None, stats=None)[source]

Bases: msrest.serialization.Model

A job schedule that allows recurring jobs by specifying when to run jobs and a specification used to create each job.

Parameters:
  • id (str) – A string that uniquely identifies the schedule within the account. It is common to use a GUID for the id.
  • display_name (str) – The display name for the schedule.
  • url (str) – The URL of the job schedule.
  • e_tag (str) – The ETag of the job schedule. This is an opaque string. You can use it to detect whether the job schedule has changed between requests. In particular, you can be pass the ETag with an Update Job Schedule request to specify that your changes should take effect only if nobody else has modified the schedule in the meantime.
  • last_modified (datetime) – The last modified time of the job schedule. This is the last time at which the schedule level data, such as the job specification or recurrence information, changed. It does not factor in job-level changes such as new jobs being created or jobs changing state.
  • creation_time (datetime) – The creation time of the job schedule.
  • state (str or JobScheduleState) – The current state of the job schedule. Possible values include: ‘active’, ‘completed’, ‘disabled’, ‘terminating’, ‘deleting’
  • state_transition_time (datetime) – The time at which the job schedule entered the current state.
  • previous_state (str or JobScheduleState) – The previous state of the job schedule. This property is not present if the job schedule is in its initial active state. Possible values include: ‘active’, ‘completed’, ‘disabled’, ‘terminating’, ‘deleting’
  • previous_state_transition_time (datetime) – The time at which the job schedule entered its previous state. This property is not present if the job schedule is in its initial active state.
  • schedule (Schedule) – The schedule according to which jobs will be created.
  • job_specification (JobSpecification) – The details of the jobs to be created on this schedule.
  • execution_info (JobScheduleExecutionInformation) – Information about jobs that have been and will be run under this schedule.
  • metadata (list of MetadataItem) – A list of name-value pairs associated with the schedule as metadata. The Batch service does not assign any meaning to metadata; it is solely for the use of user code.
  • stats (JobScheduleStatistics) – The lifetime resource usage statistics for the job schedule.
class azure.batch.models.JobScheduleAddParameter(id, schedule, job_specification, display_name=None, metadata=None)[source]

Bases: msrest.serialization.Model

A job schedule that allows recurring jobs by specifying when to run jobs and a specification used to create each job.

Parameters:
  • id (str) – A string that uniquely identifies the schedule within the account. The ID can contain any combination of alphanumeric characters including hyphens and underscores, and cannot contain more than 64 characters. The id is case-preserving and case-insensitive (that is, you may not have two ids within an account that differ only by case).
  • display_name (str) – The display name for the schedule. The display name need not be unique and can contain any Unicode characters up to a maximum length of 1024.
  • schedule (Schedule) – The schedule according to which jobs will be created.
  • job_specification (JobSpecification) – The details of the jobs to be created on this schedule.
  • metadata (list of MetadataItem) – A list of name-value pairs associated with the schedule as metadata. The Batch service does not assign any meaning to metadata; it is solely for the use of user code.
class azure.batch.models.JobSchedulingError(category, code=None, message=None, details=None)[source]

Bases: msrest.serialization.Model

An error encountered by the Batch service when scheduling a job.

Parameters:
  • category (str or ErrorCategory) – The category of the job scheduling error. Possible values include: ‘userError’, ‘serverError’
  • code (str) – An identifier for the job scheduling error. Codes are invariant and are intended to be consumed programmatically.
  • message (str) – A message describing the job scheduling error, intended to be suitable for display in a user interface.
  • details (list of NameValuePair) – A list of additional error details related to the scheduling error.
class azure.batch.models.JobExecutionInformation(start_time, end_time=None, pool_id=None, scheduling_error=None, terminate_reason=None)[source]

Bases: msrest.serialization.Model

Contains information about the execution of a job in the Azure Batch service.

Parameters:
  • start_time (datetime) – The start time of the job. This is the time at which the job was created.
  • end_time (datetime) – The completion time of the job. This property is set only if the job is in the completed state.
  • pool_id (str) – The ID of the pool to which this job is assigned. This element contains the actual pool where the job is assigned. When you get job details from the service, they also contain a poolInfo element, which contains the pool configuration data from when the job was added or updated. That poolInfo element may also contain a poolId element. If it does, the two IDs are the same. If it does not, it means the job ran on an auto pool, and this property contains the id of that auto pool.
  • scheduling_error (JobSchedulingError) – Details of any error encountered by the service in starting the job. This property is not set if there was no error starting the job.
  • terminate_reason (str) – A string describing the reason the job ended. This property is set only if the job is in the completed state. If the Batch service terminates the job, it sets the reason as follows: JMComplete - the Job Manager task completed, and killJobOnCompletion was set to true. MaxWallClockTimeExpiry - the job reached its maxWallClockTime constraint. TerminateJobSchedule - the job ran as part of a schedule, and the schedule terminated. AllTasksComplete - the job’s onAllTasksComplete attribute is set to terminateJob, and all tasks in the job are complete. TaskFailed - the job’s onTaskFailure attribute is set to performExitOptionsJobAction, and a task in the job failed with an exit condition that specified a jobAction of terminateJob. Any other string is a user-defined reason specified in a call to the ‘Terminate a job’ operation.
class azure.batch.models.CloudJob(id=None, display_name=None, uses_task_dependencies=None, url=None, e_tag=None, last_modified=None, creation_time=None, state=None, state_transition_time=None, previous_state=None, previous_state_transition_time=None, priority=None, constraints=None, job_manager_task=None, job_preparation_task=None, job_release_task=None, common_environment_settings=None, pool_info=None, on_all_tasks_complete=None, on_task_failure=None, metadata=None, execution_info=None, stats=None)[source]

Bases: msrest.serialization.Model

An Azure Batch job.

Parameters:
  • id (str) – A string that uniquely identifies the job within the account. The ID can contain any combination of alphanumeric characters including hyphens and underscores, and cannot contain more than 64 characters. It is common to use a GUID for the id.
  • display_name (str) – The display name for the job.
  • uses_task_dependencies (bool) – The flag that determines if this job will use tasks with dependencies.
  • url (str) – The URL of the job.
  • e_tag (str) – The ETag of the job. This is an opaque string. You can use it to detect whether the job has changed between requests. In particular, you can be pass the ETag when updating a job to specify that your changes should take effect only if nobody else has modified the job in the meantime.
  • last_modified (datetime) – The last modified time of the job. This is the last time at which the job level data, such as the job state or priority, changed. It does not factor in task-level changes such as adding new tasks or tasks changing state.
  • creation_time (datetime) – The creation time of the job.
  • state (str or JobState) – The current state of the job. Possible values include: ‘active’, ‘disabling’, ‘disabled’, ‘enabling’, ‘terminating’, ‘completed’, ‘deleting’
  • state_transition_time (datetime) – The time at which the job entered its current state.
  • previous_state (str or JobState) – The previous state of the job. This property is not set if the job is in its initial Active state. Possible values include: ‘active’, ‘disabling’, ‘disabled’, ‘enabling’, ‘terminating’, ‘completed’, ‘deleting’
  • previous_state_transition_time (datetime) – The time at which the job entered its previous state. This property is not set if the job is in its initial Active state.
  • priority (int) – The priority of the job. Priority values can range from -1000 to 1000, with -1000 being the lowest priority and 1000 being the highest priority. The default value is 0.
  • constraints (JobConstraints) – The execution constraints for the job.
  • job_manager_task (JobManagerTask) – Details of a Job Manager task to be launched when the job is started.
  • job_preparation_task (JobPreparationTask) – The Job Preparation task. The Job Preparation task is a special task run on each node before any other task of the job.
  • job_release_task (JobReleaseTask) – The Job Release task. The Job Release task is a special task run at the end of the job on each node that has run any other task of the job.
  • common_environment_settings (list of EnvironmentSetting) – The list of common environment variable settings. These environment variables are set for all tasks in the job (including the Job Manager, Job Preparation and Job Release tasks).
  • pool_info (PoolInformation) – The pool settings associated with the job.
  • on_all_tasks_complete (str or OnAllTasksComplete) – The action the Batch service should take when all tasks in the job are in the completed state. noAction - do nothing. The job remains active unless terminated or disabled by some other means. terminateJob - terminate the job. The job’s terminateReason is set to ‘AllTasksComplete’. The default is noAction. Possible values include: ‘noAction’, ‘terminateJob’
  • on_task_failure (str or OnTaskFailure) – The action the Batch service should take when any task in the job fails. A task is considered to have failed if it completes with a non-zero exit code and has exhausted its retry count, or if it had a scheduling error. noAction - do nothing. performExitOptionsJobAction - take the action associated with the task exit condition in the task’s exitConditions collection. (This may still result in no action being taken, if that is what the task specifies.) The default is noAction. Possible values include: ‘noAction’, ‘performExitOptionsJobAction’
  • metadata (list of MetadataItem) – A list of name-value pairs associated with the job as metadata. The Batch service does not assign any meaning to metadata; it is solely for the use of user code.
  • execution_info (JobExecutionInformation) – The execution information for the job.
  • stats (JobStatistics) – Resource usage statistics for the entire lifetime of the job.
class azure.batch.models.JobAddParameter(id, pool_info, display_name=None, priority=None, constraints=None, job_manager_task=None, job_preparation_task=None, job_release_task=None, common_environment_settings=None, on_all_tasks_complete=None, on_task_failure=None, metadata=None, uses_task_dependencies=None)[source]

Bases: msrest.serialization.Model

An Azure Batch job to add.

Parameters:
  • id (str) – A string that uniquely identifies the job within the account. The ID can contain any combination of alphanumeric characters including hyphens and underscores, and cannot contain more than 64 characters. It is common to use a GUID for the id.
  • display_name (str) – The display name for the job. The display name need not be unique and can contain any Unicode characters up to a maximum length of 1024.
  • priority (int) – The priority of the job. Priority values can range from -1000 to 1000, with -1000 being the lowest priority and 1000 being the highest priority. The default value is 0.
  • constraints (JobConstraints) – The execution constraints for the job.
  • job_manager_task (JobManagerTask) – Details of a Job Manager task to be launched when the job is started. If the job does not specify a Job Manager task, the user must explicitly add tasks to the job. If the job does specify a Job Manager task, the Batch service creates the Job Manager task when the job is created, and will try to schedule the Job Manager task before scheduling other tasks in the job. The Job Manager task’s typical purpose is to control and/or monitor job execution, for example by deciding what additional tasks to run, determining when the work is complete, etc. (However, a Job Manager task is not restricted to these activities - it is a fully-fledged task in the system and perform whatever actions are required for the job.) For example, a Job Manager task might download a file specified as a parameter, analyze the contents of that file and submit additional tasks based on those contents.
  • job_preparation_task (JobPreparationTask) – The Job Preparation task. If a job has a Job Preparation task, the Batch service will run the Job Preparation task on a compute node before starting any tasks of that job on that compute node.
  • job_release_task (JobReleaseTask) – The Job Release task. A Job Release task cannot be specified without also specifying a Job Preparation task for the job. The Batch service runs the Job Release task on the compute nodes that have run the Job Preparation task. The primary purpose of the Job Release task is to undo changes to compute nodes made by the Job Preparation task. Example activities include deleting local files, or shutting down services that were started as part of job preparation.
  • common_environment_settings (list of EnvironmentSetting) – The list of common environment variable settings. These environment variables are set for all tasks in the job (including the Job Manager, Job Preparation and Job Release tasks).
  • pool_info (PoolInformation) – The pool on which the Batch service runs the job’s tasks.
  • on_all_tasks_complete (str or OnAllTasksComplete) – The action the Batch service should take when all tasks in the job are in the completed state. Note that if a job contains no tasks, then all tasks are considered complete. This option is therefore most commonly used with a Job Manager task; if you want to use automatic job termination without a Job Manager, you should initially set onAllTasksComplete to noAction and update the job properties to set onAllTasksComplete to terminateJob once you have finished adding tasks. Permitted values are: noAction - do nothing. The job remains active unless terminated or disabled by some other means. terminateJob - terminate the job. The job’s terminateReason is set to ‘AllTasksComplete’. The default is noAction. Possible values include: ‘noAction’, ‘terminateJob’
  • on_task_failure (str or OnTaskFailure) – The action the Batch service should take when any task in the job fails. A task is considered to have failed if it completes with a non-zero exit code and has exhausted its retry count, or if it had a scheduling error. noAction - do nothing. performExitOptionsJobAction - take the action associated with the task exit condition in the task’s exitConditions collection. (This may still result in no action being taken, if that is what the task specifies.) The default is noAction. Possible values include: ‘noAction’, ‘performExitOptionsJobAction’
  • metadata (list of MetadataItem) – A list of name-value pairs associated with the job as metadata. The Batch service does not assign any meaning to metadata; it is solely for the use of user code.
  • uses_task_dependencies (bool) – The flag that determines if this job will use tasks with dependencies.
class azure.batch.models.TaskFailureInformation(category, code=None, message=None, details=None)[source]

Bases: msrest.serialization.Model

Information about a task failure.

Parameters:
  • category (str or ErrorCategory) – The category of the task error. Possible values include: ‘userError’, ‘serverError’
  • code (str) – An identifier for the task error. Codes are invariant and are intended to be consumed programmatically.
  • message (str) – A message describing the task error, intended to be suitable for display in a user interface.
  • details (list of NameValuePair) – A list of additional details related to the error.
class azure.batch.models.JobPreparationTaskExecutionInformation(start_time, state, retry_count, end_time=None, task_root_directory=None, task_root_directory_url=None, exit_code=None, failure_info=None, last_retry_time=None, result=None)[source]

Bases: msrest.serialization.Model

Contains information about the execution of a Job Preparation task on a compute node.

Parameters:
  • start_time (datetime) – The time at which the task started running. Note that every time the task is restarted, this value is updated.
  • end_time (datetime) – The time at which the Job Preparation task completed. This property is set only if the task is in the Completed state.
  • state (str or JobPreparationTaskState) – The current state of the Job Preparation task on the compute node. running - the task is currently running (including retrying). completed - the task has exited with exit code 0, or the task has exhausted its retry limit, or the Batch service was unable to start the task due to scheduling errors. Possible values include: ‘running’, ‘completed’
  • task_root_directory (str) – The root directory of the Job Preparation task on the compute node. You can use this path to retrieve files created by the task, such as log files.
  • task_root_directory_url (str) – The URL to the root directory of the Job Preparation task on the compute node.
  • exit_code (int) – The exit code of the program specified on the task command line. This parameter is returned only if the task is in the completed state. The exit code for a process reflects the specific convention implemented by the application developer for that process. If you use the exit code value to make decisions in your code, be sure that you know the exit code convention used by the application process. Note that the exit code may also be generated by the compute node operating system, such as when a process is forcibly terminated.
  • failure_info (TaskFailureInformation) – Information describing the task failure, if any. This property is set only if the task is in the completed state and encountered a failure.
  • retry_count (int) – The number of times the task has been retried by the Batch service. Task application failures (non-zero exit code) are retried, pre-processing errors (the task could not be run) and file upload errors are not retried. The Batch service will retry the task up to the limit specified by the constraints.
  • last_retry_time (datetime) – The most recent time at which a retry of the Job Preparation task started running. This property is set only if the task was retried (i.e. retryCount is nonzero). If present, this is typically the same as startTime, but may be different if the task has been restarted for reasons other than retry; for example, if the compute node was rebooted during a retry, then the startTime is updated but the lastRetryTime is not.
  • result (str or TaskExecutionResult) – The result of the task execution. If the value is ‘failed’, then the details of the failure can be found in the failureInfo property. Possible values include: ‘success’, ‘failure’
class azure.batch.models.JobReleaseTaskExecutionInformation(start_time, state, end_time=None, task_root_directory=None, task_root_directory_url=None, exit_code=None, failure_info=None, result=None)[source]

Bases: msrest.serialization.Model

Contains information about the execution of a Job Release task on a compute node.

Parameters:
  • start_time (datetime) – The time at which the task started running. Note that every time the task is restarted, this value is updated.
  • end_time (datetime) – The time at which the Job Release task completed. This property is set only if the task is in the Completed state.
  • state (str or JobReleaseTaskState) – The current state of the Job Release task on the compute node. running - the task is currently running (including retrying). completed - the task has exited, or the Batch service was unable to start the task due to scheduling errors. Possible values include: ‘running’, ‘completed’
  • task_root_directory (str) – The root directory of the Job Release task on the compute node. You can use this path to retrieve files created by the task, such as log files.
  • task_root_directory_url (str) – The URL to the root directory of the Job Release task on the compute node.
  • exit_code (int) – The exit code of the program specified on the task command line. This parameter is returned only if the task is in the completed state. The exit code for a process reflects the specific convention implemented by the application developer for that process. If you use the exit code value to make decisions in your code, be sure that you know the exit code convention used by the application process. Note that the exit code may also be generated by the compute node operating system, such as when a process is forcibly terminated.
  • failure_info (TaskFailureInformation) – Information describing the task failure, if any. This property is set only if the task is in the completed state and encountered a failure.
  • result (str or TaskExecutionResult) – The result of the task execution. If the value is ‘failed’, then the details of the failure can be found in the failureInfo property. Possible values include: ‘success’, ‘failure’
class azure.batch.models.JobPreparationAndReleaseTaskExecutionInformation(pool_id=None, node_id=None, node_url=None, job_preparation_task_execution_info=None, job_release_task_execution_info=None)[source]

Bases: msrest.serialization.Model

The status of the Job Preparation and Job Release tasks on a compute node.

Parameters:
  • pool_id (str) – The ID of the pool containing the compute node to which this entry refers.
  • node_id (str) – The ID of the compute node to which this entry refers.
  • node_url (str) – The URL of the compute node to which this entry refers.
  • job_preparation_task_execution_info (JobPreparationTaskExecutionInformation) – Information about the execution status of the Job Preparation task on this compute node.
  • job_release_task_execution_info (JobReleaseTaskExecutionInformation) – Information about the execution status of the Job Release task on this compute node. This property is set only if the Job Release task has run on the node.
class azure.batch.models.AutoScaleRunError(code=None, message=None, values=None)[source]

Bases: msrest.serialization.Model

An error that occurred when executing or evaluating a pool autoscale formula.

Parameters:
  • code (str) – An identifier for the autoscale error. Codes are invariant and are intended to be consumed programmatically.
  • message (str) – A message describing the autoscale error, intended to be suitable for display in a user interface.
  • values (list of NameValuePair) – A list of additional error details related to the autoscale error.
class azure.batch.models.AutoScaleRun(timestamp, results=None, error=None)[source]

Bases: msrest.serialization.Model

The results and errors from an execution of a pool autoscale formula.

Parameters:
  • timestamp (datetime) – The time at which the autoscale formula was last evaluated.
  • results (str) – The final values of all variables used in the evaluation of the autoscale formula. Each variable value is returned in the form $variable=value, and variables are separated by semicolons.
  • error (AutoScaleRunError) – Details of the error encountered evaluating the autoscale formula on the pool, if the evaluation was unsuccessful.
class azure.batch.models.ResizeError(code=None, message=None, values=None)[source]

Bases: msrest.serialization.Model

An error that occurred when resizing a pool.

Parameters:
  • code (str) – An identifier for the pool resize error. Codes are invariant and are intended to be consumed programmatically.
  • message (str) – A message describing the pool resize error, intended to be suitable for display in a user interface.
  • values (list of NameValuePair) – A list of additional error details related to the pool resize error.
class azure.batch.models.CloudPool(id=None, display_name=None, url=None, e_tag=None, last_modified=None, creation_time=None, state=None, state_transition_time=None, allocation_state=None, allocation_state_transition_time=None, vm_size=None, cloud_service_configuration=None, virtual_machine_configuration=None, resize_timeout=None, resize_errors=None, current_dedicated_nodes=None, current_low_priority_nodes=None, target_dedicated_nodes=None, target_low_priority_nodes=None, enable_auto_scale=None, auto_scale_formula=None, auto_scale_evaluation_interval=None, auto_scale_run=None, enable_inter_node_communication=None, network_configuration=None, start_task=None, certificate_references=None, application_package_references=None, application_licenses=None, max_tasks_per_node=None, task_scheduling_policy=None, user_accounts=None, metadata=None, stats=None)[source]

Bases: msrest.serialization.Model

A pool in the Azure Batch service.

Parameters:
  • id (str) – A string that uniquely identifies the pool within the account. The ID can contain any combination of alphanumeric characters including hyphens and underscores, and cannot contain more than 64 characters. It is common to use a GUID for the id.
  • display_name (str) – The display name for the pool. The display name need not be unique and can contain any Unicode characters up to a maximum length of 1024.
  • url (str) – The URL of the pool.
  • e_tag (str) – The ETag of the pool. This is an opaque string. You can use it to detect whether the pool has changed between requests. In particular, you can be pass the ETag when updating a pool to specify that your changes should take effect only if nobody else has modified the pool in the meantime.
  • last_modified (datetime) – The last modified time of the pool. This is the last time at which the pool level data, such as the targetDedicatedNodes or enableAutoscale settings, changed. It does not factor in node-level changes such as a compute node changing state.
  • creation_time (datetime) – The creation time of the pool.
  • state (str or PoolState) – The current state of the pool. active - The pool is available to run tasks subject to the availability of compute nodes. deleting - The user has requested that the pool be deleted, but the delete operation has not yet completed. upgrading - The user has requested that the operating system of the pool’s nodes be upgraded, but the upgrade operation has not yet completed (that is, some nodes in the pool have not yet been upgraded). While upgrading, the pool may be able to run tasks (with reduced capacity) but this is not guaranteed. Possible values include: ‘active’, ‘deleting’, ‘upgrading’
  • state_transition_time (datetime) – The time at which the pool entered its current state.
  • allocation_state (str or AllocationState) – Whether the pool is resizing. steady - The pool is not resizing. There are no changes to the number of nodes in the pool in progress. A pool enters this state when it is created and when no operations are being performed on the pool to change the number of dedicated nodes. resizing - The pool is resizing; that is, compute nodes are being added to or removed from the pool. stopping - The pool was resizing, but the user has requested that the resize be stopped, but the stop request has not yet been completed. Possible values include: ‘steady’, ‘resizing’, ‘stopping’
  • allocation_state_transition_time (datetime) – The time at which the pool entered its current allocation state.
  • vm_size (str) – The size of virtual machines in the pool. All virtual machines in a pool are the same size. For information about available sizes of virtual machines for Cloud Services pools (pools created with cloudServiceConfiguration), see Sizes for Cloud Services (http://azure.microsoft.com/documentation/articles/cloud-services-sizes-specs/). Batch supports all Cloud Services VM sizes except ExtraSmall, A1V2 and A2V2. For information about available VM sizes for pools using images from the Virtual Machines Marketplace (pools created with virtualMachineConfiguration) see Sizes for Virtual Machines (Linux) (https://azure.microsoft.com/documentation/articles/virtual-machines-linux-sizes/) or Sizes for Virtual Machines (Windows) (https://azure.microsoft.com/documentation/articles/virtual-machines-windows-sizes/). Batch supports all Azure VM sizes except STANDARD_A0 and those with premium storage (STANDARD_GS, STANDARD_DS, and STANDARD_DSV2 series).
  • cloud_service_configuration (CloudServiceConfiguration) – The cloud service configuration for the pool. This property and virtualMachineConfiguration are mutually exclusive and one of the properties must be specified. This property cannot be specified if the Batch account was created with its poolAllocationMode property set to ‘UserSubscription’.
  • virtual_machine_configuration (VirtualMachineConfiguration) – The virtual machine configuration for the pool. This property and cloudServiceConfiguration are mutually exclusive and one of the properties must be specified.
  • resize_timeout (timedelta) – The timeout for allocation of compute nodes to the pool. This is the timeout for the most recent resize operation. (The initial sizing when the pool is created counts as a resize.) The default value is 15 minutes.
  • resize_errors (list of ResizeError) – A list of errors encountered while performing the last resize on the pool. This property is set only if one or more errors occurred during the last pool resize, and only when the pool allocationState is Steady.
  • current_dedicated_nodes (int) – The number of dedicated compute nodes currently in the pool.
  • current_low_priority_nodes (int) – The number of low-priority compute nodes currently in the pool. Low-priority compute nodes which have been preempted are included in this count.
  • target_dedicated_nodes (int) – The desired number of dedicated compute nodes in the pool.
  • target_low_priority_nodes (int) – The desired number of low-priority compute nodes in the pool.
  • enable_auto_scale (bool) – Whether the pool size should automatically adjust over time. If false, at least one of targetDedicateNodes and targetLowPriorityNodes must be specified. If true, the autoScaleFormula property is required and the pool automatically resizes according to the formula. The default value is false.
  • auto_scale_formula (str) – A formula for the desired number of compute nodes in the pool. This property is set only if the pool automatically scales, i.e. enableAutoScale is true.
  • auto_scale_evaluation_interval (timedelta) – The time interval at which to automatically adjust the pool size according to the autoscale formula. This property is set only if the pool automatically scales, i.e. enableAutoScale is true.
  • auto_scale_run (AutoScaleRun) – The results and errors from the last execution of the autoscale formula. This property is set only if the pool automatically scales, i.e. enableAutoScale is true.
  • enable_inter_node_communication (bool) – Whether the pool permits direct communication between nodes. This imposes restrictions on which nodes can be assigned to the pool. Specifying this value can reduce the chance of the requested number of nodes to be allocated in the pool.
  • network_configuration (NetworkConfiguration) – The network configuration for the pool.
  • start_task (StartTask) – A task specified to run on each compute node as it joins the pool.
  • certificate_references (list of CertificateReference) – The list of certificates to be installed on each compute node in the pool. For Windows compute nodes, the Batch service installs the certificates to the specified certificate store and location. For Linux compute nodes, the certificates are stored in a directory inside the task working directory and an environment variable AZ_BATCH_CERTIFICATES_DIR is supplied to the task to query for this location. For certificates with visibility of ‘remoteUser’, a ‘certs’ directory is created in the user’s home directory (e.g., /home/{user-name}/certs) and certificates are placed in that directory.
  • application_package_references (list of ApplicationPackageReference) – The list of application packages to be installed on each compute node in the pool.
  • application_licenses (list of str) – The list of application licenses the Batch service will make available on each compute node in the pool. The list of application licenses must be a subset of available Batch service application licenses. If a license is requested which is not supported, pool creation will fail.
  • max_tasks_per_node (int) – The maximum number of tasks that can run concurrently on a single compute node in the pool.
  • task_scheduling_policy (TaskSchedulingPolicy) – How the Batch service distributes tasks between compute nodes in the pool.
  • user_accounts (list of UserAccount) – The list of user accounts to be created on each node in the pool.
  • metadata (list of MetadataItem) – A list of name-value pairs associated with the pool as metadata.
  • stats (PoolStatistics) – Utilization and resource usage statistics for the entire lifetime of the pool.
class azure.batch.models.PoolAddParameter(id, vm_size, display_name=None, cloud_service_configuration=None, virtual_machine_configuration=None, resize_timeout=None, target_dedicated_nodes=None, target_low_priority_nodes=None, enable_auto_scale=None, auto_scale_formula=None, auto_scale_evaluation_interval=None, enable_inter_node_communication=None, network_configuration=None, start_task=None, certificate_references=None, application_package_references=None, application_licenses=None, max_tasks_per_node=None, task_scheduling_policy=None, user_accounts=None, metadata=None)[source]

Bases: msrest.serialization.Model

A pool in the Azure Batch service to add.

Parameters:
  • id (str) – A string that uniquely identifies the pool within the account. The ID can contain any combination of alphanumeric characters including hyphens and underscores, and cannot contain more than 64 characters. The ID is case-preserving and case-insensitive (that is, you may not have two pool IDs within an account that differ only by case).
  • display_name (str) – The display name for the pool. The display name need not be unique and can contain any Unicode characters up to a maximum length of 1024.
  • vm_size (str) – The size of virtual machines in the pool. All virtual machines in a pool are the same size. For information about available sizes of virtual machines for Cloud Services pools (pools created with cloudServiceConfiguration), see Sizes for Cloud Services (http://azure.microsoft.com/documentation/articles/cloud-services-sizes-specs/). Batch supports all Cloud Services VM sizes except ExtraSmall, A1V2 and A2V2. For information about available VM sizes for pools using images from the Virtual Machines Marketplace (pools created with virtualMachineConfiguration) see Sizes for Virtual Machines (Linux) (https://azure.microsoft.com/documentation/articles/virtual-machines-linux-sizes/) or Sizes for Virtual Machines (Windows) (https://azure.microsoft.com/documentation/articles/virtual-machines-windows-sizes/). Batch supports all Azure VM sizes except STANDARD_A0 and those with premium storage (STANDARD_GS, STANDARD_DS, and STANDARD_DSV2 series).
  • cloud_service_configuration (CloudServiceConfiguration) – The cloud service configuration for the pool. This property and virtualMachineConfiguration are mutually exclusive and one of the properties must be specified. This property cannot be specified if the Batch account was created with its poolAllocationMode property set to ‘UserSubscription’.
  • virtual_machine_configuration (VirtualMachineConfiguration) – The virtual machine configuration for the pool. This property and cloudServiceConfiguration are mutually exclusive and one of the properties must be specified.
  • resize_timeout (timedelta) – The timeout for allocation of compute nodes to the pool. This timeout applies only to manual scaling; it has no effect when enableAutoScale is set to true. The default value is 15 minutes. The minimum value is 5 minutes. If you specify a value less than 5 minutes, the Batch service returns an error; if you are calling the REST API directly, the HTTP status code is 400 (Bad Request).
  • target_dedicated_nodes (int) – The desired number of dedicated compute nodes in the pool. This property must not be specified if enableAutoScale is set to true. If enableAutoScale is set to false, then you must set either targetDedicatedNodes, targetLowPriorityNodes, or both.
  • target_low_priority_nodes (int) – The desired number of low-priority compute nodes in the pool. This property must not be specified if enableAutoScale is set to true. If enableAutoScale is set to false, then you must set either targetDedicatedNodes, targetLowPriorityNodes, or both.
  • enable_auto_scale (bool) – Whether the pool size should automatically adjust over time. If false, at least one of targetDedicateNodes and targetLowPriorityNodes must be specified. If true, the autoScaleFormula property is required and the pool automatically resizes according to the formula. The default value is false.
  • auto_scale_formula (str) – A formula for the desired number of compute nodes in the pool. This property must not be specified if enableAutoScale is set to false. It is required if enableAutoScale is set to true. The formula is checked for validity before the pool is created. If the formula is not valid, the Batch service rejects the request with detailed error information. For more information about specifying this formula, see ‘Automatically scale compute nodes in an Azure Batch pool’ (https://azure.microsoft.com/documentation/articles/batch-automatic-scaling/).
  • auto_scale_evaluation_interval (timedelta) – The time interval at which to automatically adjust the pool size according to the autoscale formula. The default value is 15 minutes. The minimum and maximum value are 5 minutes and 168 hours respectively. If you specify a value less than 5 minutes or greater than 168 hours, the Batch service returns an error; if you are calling the REST API directly, the HTTP status code is 400 (Bad Request).
  • enable_inter_node_communication (bool) – Whether the pool permits direct communication between nodes. Enabling inter-node communication limits the maximum size of the pool due to deployment restrictions on the nodes of the pool. This may result in the pool not reaching its desired size. The default value is false.
  • network_configuration (NetworkConfiguration) – The network configuration for the pool.
  • start_task (StartTask) – A task specified to run on each compute node as it joins the pool. The task runs when the node is added to the pool or when the node is restarted.
  • certificate_references (list of CertificateReference) – The list of certificates to be installed on each compute node in the pool. For Windows compute nodes, the Batch service installs the certificates to the specified certificate store and location. For Linux compute nodes, the certificates are stored in a directory inside the task working directory and an environment variable AZ_BATCH_CERTIFICATES_DIR is supplied to the task to query for this location. For certificates with visibility of ‘remoteUser’, a ‘certs’ directory is created in the user’s home directory (e.g., /home/{user-name}/certs) and certificates are placed in that directory.
  • application_package_references (list of ApplicationPackageReference) – The list of application packages to be installed on each compute node in the pool. This property is currently not supported on pools created using the virtualMachineConfiguration (IaaS) property.
  • application_licenses (list of str) – The list of application licenses the Batch service will make available on each compute node in the pool. The list of application licenses must be a subset of available Batch service application licenses. If a license is requested which is not supported, pool creation will fail.
  • max_tasks_per_node (int) – The maximum number of tasks that can run concurrently on a single compute node in the pool. The default value is 1. The maximum value of this setting depends on the size of the compute nodes in the pool (the vmSize setting).
  • task_scheduling_policy (TaskSchedulingPolicy) – How the Batch service distributes tasks between compute nodes in the pool.
  • user_accounts (list of UserAccount) – The list of user accounts to be created on each node in the pool.
  • metadata (list of MetadataItem) – A list of name-value pairs associated with the pool as metadata. The Batch service does not assign any meaning to metadata; it is solely for the use of user code.
class azure.batch.models.AffinityInformation(affinity_id)[source]

Bases: msrest.serialization.Model

A locality hint that can be used by the Batch service to select a compute node on which to start a task.

Parameters:affinity_id (str) – An opaque string representing the location of a compute node or a task that has run previously. You can pass the affinityId of a compute node or task to indicate that this task needs to be placed close to the node or task.
class azure.batch.models.TaskExecutionInformation(retry_count, requeue_count, start_time=None, end_time=None, exit_code=None, failure_info=None, last_retry_time=None, last_requeue_time=None, result=None)[source]

Bases: msrest.serialization.Model

Information about the execution of a task.

Parameters:
  • start_time (datetime) – The time at which the task started running. ‘Running’ corresponds to the running state, so if the task specifies resource files or application packages, then the start time reflects the time at which the task started downloading or deploying these. If the task has been restarted or retried, this is the most recent time at which the task started running. This property is present only for tasks that are in the running or completed state.
  • end_time (datetime) – The time at which the task completed. This property is set only if the task is in the Completed state.
  • exit_code (int) – The exit code of the program specified on the task command line. This property is set only if the task is in the completed state. In general, the exit code for a process reflects the specific convention implemented by the application developer for that process. If you use the exit code value to make decisions in your code, be sure that you know the exit code convention used by the application process. However, if the Batch service terminates the task (due to timeout, or user termination via the API) you may see an operating system-defined exit code.
  • failure_info (TaskFailureInformation) – Information describing the task failure, if any. This property is set only if the task is in the completed state and encountered a failure.
  • retry_count (int) – The number of times the task has been retried by the Batch service. The number of times the task has been retried by the Batch service. Task application failures (non-zero exit code) are retried, pre-processing errors (the task could not be run) and file upload errors are not retried. The Batch service will retry the task up to the limit specified by the constraints.
  • last_retry_time (datetime) – The most recent time at which a retry of the task started running. This element is present only if the task was retried (i.e. retryCount is nonzero). If present, this is typically the same as startTime, but may be different if the task has been restarted for reasons other than retry; for example, if the compute node was rebooted during a retry, then the startTime is updated but the lastRetryTime is not.
  • requeue_count (int) – The number of times the task has been requeued by the Batch service as the result of a user request. When the user removes nodes from a pool (by resizing/shrinking the pool) or when the job is being disabled, the user can specify that running tasks on the nodes be requeued for execution. This count tracks how many times the task has been requeued for these reasons.
  • last_requeue_time (datetime) – The most recent time at which the task has been requeued by the Batch service as the result of a user request. This property is set only if the requeueCount is nonzero.
  • result (str or TaskExecutionResult) – The result of the task execution. If the value is ‘failed’, then the details of the failure can be found in the failureInfo property. Possible values include: ‘success’, ‘failure’
class azure.batch.models.ComputeNodeInformation(affinity_id=None, node_url=None, pool_id=None, node_id=None, task_root_directory=None, task_root_directory_url=None)[source]

Bases: msrest.serialization.Model

Information about the compute node on which a task ran.

Parameters:
  • affinity_id (str) – An identifier for the compute node on which the task ran, which can be passed when adding a task to request that the task be scheduled close to this compute node.
  • node_url (str) – The URL of the node on which the task ran. .
  • pool_id (str) – The ID of the pool on which the task ran.
  • node_id (str) – The ID of the node on which the task ran.
  • task_root_directory (str) – The root directory of the task on the compute node.
  • task_root_directory_url (str) – The URL to the root directory of the task on the compute node.
class azure.batch.models.MultiInstanceSettings(number_of_instances, coordination_command_line=None, common_resource_files=None)[source]

Bases: msrest.serialization.Model

Settings which specify how to run a multi-instance task.

Multi-instance tasks are commonly used to support MPI tasks.

Parameters:
  • number_of_instances (int) – The number of compute nodes required by the task.
  • coordination_command_line (str) – The command line to run on all the compute nodes to enable them to coordinate when the primary runs the main task command. A typical coordination command line launches a background service and verifies that the service is ready to process inter-node messages.
  • common_resource_files (list of ResourceFile) – A list of files that the Batch service will download before running the coordination command line. The difference between common resource files and task resource files is that common resource files are downloaded for all subtasks including the primary, whereas task resource files are downloaded only for the primary.
class azure.batch.models.TaskStatistics(url, start_time, last_update_time, user_cpu_time, kernel_cpu_time, wall_clock_time, read_iops, write_iops, read_io_gi_b, write_io_gi_b, wait_time)[source]

Bases: msrest.serialization.Model

Resource usage statistics for a task.

Parameters:
  • url (str) – The URL of the statistics.
  • start_time (datetime) – The start time of the time range covered by the statistics.
  • last_update_time (datetime) – The time at which the statistics were last updated. All statistics are limited to the range between startTime and lastUpdateTime.
  • user_cpu_time (timedelta) – The total user mode CPU time (summed across all cores and all compute nodes) consumed by the task.
  • kernel_cpu_time (timedelta) – The total kernel mode CPU time (summed across all cores and all compute nodes) consumed by the task.
  • wall_clock_time (timedelta) – The total wall clock time of the task. The wall clock time is the elapsed time from when the task started running on a compute node to when it finished (or to the last time the statistics were updated, if the task had not finished by then). If the task was retried, this includes the wall clock time of all the task retries.
  • read_iops (long) – The total number of disk read operations made by the task.
  • write_iops (long) – The total number of disk write operations made by the task.
  • read_io_gi_b (float) – The total gibibytes read from disk by the task.
  • write_io_gi_b (float) – The total gibibytes written to disk by the task.
  • wait_time (timedelta) – The total wait time of the task. The wait time for a task is defined as the elapsed time between the creation of the task and the start of task execution. (If the task is retried due to failures, the wait time is the time to the most recent task execution.).
class azure.batch.models.TaskIdRange(start, end)[source]

Bases: msrest.serialization.Model

A range of task IDs that a task can depend on. All tasks with IDs in the range must complete successfully before the dependent task can be scheduled.

The start and end of the range are inclusive. For example, if a range has start 9 and end 12, then it represents tasks ‘9’, ‘10’, ‘11’ and ‘12’.

Parameters:
  • start (int) – The first task ID in the range.
  • end (int) – The last task ID in the range.
class azure.batch.models.TaskDependencies(task_ids=None, task_id_ranges=None)[source]

Bases: msrest.serialization.Model

Specifies any dependencies of a task. Any task that is explicitly specified or within a dependency range must complete before the dependant task will be scheduled.

Parameters:
  • task_ids (list of str) – The list of task IDs that this task depends on. All tasks in this list must complete successfully before the dependent task can be scheduled.
  • task_id_ranges (list of TaskIdRange) – The list of task ID ranges that this task depends on. All tasks in all ranges must complete successfully before the dependent task can be scheduled.
class azure.batch.models.CloudTask(id=None, display_name=None, url=None, e_tag=None, last_modified=None, creation_time=None, exit_conditions=None, state=None, state_transition_time=None, previous_state=None, previous_state_transition_time=None, command_line=None, resource_files=None, output_files=None, environment_settings=None, affinity_info=None, constraints=None, user_identity=None, execution_info=None, node_info=None, multi_instance_settings=None, stats=None, depends_on=None, application_package_references=None, authentication_token_settings=None)[source]

Bases: msrest.serialization.Model

An Azure Batch task.

Parameters:
  • id (str) – A string that uniquely identifies the task within the job. The ID can contain any combination of alphanumeric characters including hyphens and underscores, and cannot contain more than 64 characters.
  • display_name (str) – A display name for the task. The display name need not be unique and can contain any Unicode characters up to a maximum length of 1024.
  • url (str) – The URL of the task.
  • e_tag (str) – The ETag of the task. This is an opaque string. You can use it to detect whether the task has changed between requests. In particular, you can be pass the ETag when updating a task to specify that your changes should take effect only if nobody else has modified the task in the meantime.
  • last_modified (datetime) – The last modified time of the task.
  • creation_time (datetime) – The creation time of the task.
  • exit_conditions (ExitConditions) – How the Batch service should respond when the task completes.
  • state (str or TaskState) – The current state of the task. Possible values include: ‘active’, ‘preparing’, ‘running’, ‘completed’
  • state_transition_time (datetime) – The time at which the task entered its current state.
  • previous_state (str or TaskState) – The previous state of the task. This property is not set if the task is in its initial Active state. Possible values include: ‘active’, ‘preparing’, ‘running’, ‘completed’
  • previous_state_transition_time (datetime) – The time at which the task entered its previous state. This property is not set if the task is in its initial Active state.
  • command_line (str) – The command line of the task. For multi-instance tasks, the command line is executed as the primary task, after the primary task and all subtasks have finished executing the coordination command line. The command line does not run under a shell, and therefore cannot take advantage of shell features such as environment variable expansion. If you want to take advantage of such features, you should invoke the shell in the command line, for example using “cmd /c MyCommand” in Windows or “/bin/sh -c MyCommand” in Linux.
  • resource_files (list of ResourceFile) – A list of files that the Batch service will download to the compute node before running the command line. For multi-instance tasks, the resource files will only be downloaded to the compute node on which the primary task is executed.
  • output_files (list of OutputFile) – A list of files that the Batch service will upload from the compute node after running the command line. For multi-instance tasks, the files will only be uploaded from the compute node on which the primary task is executed.
  • environment_settings (list of EnvironmentSetting) – A list of environment variable settings for the task.
  • affinity_info (AffinityInformation) – A locality hint that can be used by the Batch service to select a compute node on which to start the new task.
  • constraints (TaskConstraints) – The execution constraints that apply to this task.
  • user_identity (UserIdentity) – The user identity under which the task runs. If omitted, the task runs as a non-administrative user unique to the task.
  • execution_info (TaskExecutionInformation) – Information about the execution of the task.
  • node_info (ComputeNodeInformation) – Information about the compute node on which the task ran.
  • multi_instance_settings (MultiInstanceSettings) – An object that indicates that the task is a multi-instance task, and contains information about how to run the multi-instance task.
  • stats (TaskStatistics) – Resource usage statistics for the task.
  • depends_on (TaskDependencies) – The tasks that this task depends on. This task will not be scheduled until all tasks that it depends on have completed successfully. If any of those tasks fail and exhaust their retry counts, this task will never be scheduled.
  • application_package_references (list of ApplicationPackageReference) – A list of application packages that the Batch service will deploy to the compute node before running the command line.
  • authentication_token_settings (AuthenticationTokenSettings) – The settings for an authentication token that the task can use to perform Batch service operations. If this property is set, the Batch service provides the task with an authentication token which can be used to authenticate Batch service operations without requiring an account access key. The token is provided via the AZ_BATCH_AUTHENTICATION_TOKEN environment variable. The operations that the task can carry out using the token depend on the settings. For example, a task can request job permissions in order to add other tasks to the job, or check the status of the job or of other tasks under the job.
class azure.batch.models.TaskAddParameter(id, command_line, display_name=None, exit_conditions=None, resource_files=None, output_files=None, environment_settings=None, affinity_info=None, constraints=None, user_identity=None, multi_instance_settings=None, depends_on=None, application_package_references=None, authentication_token_settings=None)[source]

Bases: msrest.serialization.Model

An Azure Batch task to add.

Parameters:
  • id (str) – A string that uniquely identifies the task within the job. The ID can contain any combination of alphanumeric characters including hyphens and underscores, and cannot contain more than 64 characters. The ID is case-preserving and case-insensitive (that is, you may not have two IDs within a job that differ only by case).
  • display_name (str) – A display name for the task. The display name need not be unique and can contain any Unicode characters up to a maximum length of 1024.
  • command_line (str) – The command line of the task. For multi-instance tasks, the command line is executed as the primary task, after the primary task and all subtasks have finished executing the coordination command line. The command line does not run under a shell, and therefore cannot take advantage of shell features such as environment variable expansion. If you want to take advantage of such features, you should invoke the shell in the command line, for example using “cmd /c MyCommand” in Windows or “/bin/sh -c MyCommand” in Linux.
  • exit_conditions (ExitConditions) – How the Batch service should respond when the task completes.
  • resource_files (list of ResourceFile) – A list of files that the Batch service will download to the compute node before running the command line. For multi-instance tasks, the resource files will only be downloaded to the compute node on which the primary task is executed.
  • output_files (list of OutputFile) – A list of files that the Batch service will upload from the compute node after running the command line. For multi-instance tasks, the files will only be uploaded from the compute node on which the primary task is executed.
  • environment_settings (list of EnvironmentSetting) – A list of environment variable settings for the task.
  • affinity_info (AffinityInformation) – A locality hint that can be used by the Batch service to select a compute node on which to start the new task.
  • constraints (TaskConstraints) – The execution constraints that apply to this task. If you do not specify constraints, the maxTaskRetryCount is the maxTaskRetryCount specified for the job, and the maxWallClockTime and retentionTime are infinite.
  • user_identity (UserIdentity) – The user identity under which the task runs. If omitted, the task runs as a non-administrative user unique to the task.
  • multi_instance_settings (MultiInstanceSettings) – An object that indicates that the task is a multi-instance task, and contains information about how to run the multi-instance task.
  • depends_on (TaskDependencies) – The tasks that this task depends on. This task will not be scheduled until all tasks that it depends on have completed successfully. If any of those tasks fail and exhaust their retry counts, this task will never be scheduled. If the job does not have usesTaskDependencies set to true, and this element is present, the request fails with error code TaskDependenciesNotSpecifiedOnJob.
  • application_package_references (list of ApplicationPackageReference) – A list of application packages that the Batch service will deploy to the compute node before running the command line.
  • authentication_token_settings (AuthenticationTokenSettings) – The settings for an authentication token that the task can use to perform Batch service operations. If this property is set, the Batch service provides the task with an authentication token which can be used to authenticate Batch service operations without requiring an account access key. The token is provided via the AZ_BATCH_AUTHENTICATION_TOKEN environment variable. The operations that the task can carry out using the token depend on the settings. For example, a task can request job permissions in order to add other tasks to the job, or check the status of the job or of other tasks under the job.
class azure.batch.models.TaskAddCollectionParameter(value)[source]

Bases: msrest.serialization.Model

A collection of Azure Batch tasks to add.

Parameters:value (list of TaskAddParameter) – The collection of tasks to add.
class azure.batch.models.ErrorMessage(lang=None, value=None)[source]

Bases: msrest.serialization.Model

An error message received in an Azure Batch error response.

Parameters:
  • lang (str) – The language code of the error message.
  • value (str) – The text of the message.
class azure.batch.models.BatchErrorDetail(key=None, value=None)[source]

Bases: msrest.serialization.Model

An item of additional information included in an Azure Batch error response.

Parameters:
  • key (str) – An identifier specifying the meaning of the Value property.
  • value (str) – The additional information included with the error response.
class azure.batch.models.BatchError(code=None, message=None, values=None)[source]

Bases: msrest.serialization.Model

An error response received from the Azure Batch service.

Parameters:
  • code (str) – An identifier for the error. Codes are invariant and are intended to be consumed programmatically.
  • message (ErrorMessage) – A message describing the error, intended to be suitable for display in a user interface.
  • values (list of BatchErrorDetail) – A collection of key-value pairs containing additional details about the error.
exception azure.batch.models.BatchErrorException(deserialize, response, *args)[source]

Bases: msrest.exceptions.HttpOperationError

Server responsed with exception of type: ‘BatchError’.

Parameters:
  • deserialize – A deserializer
  • response – Server response to be deserialized.
class azure.batch.models.TaskAddResult(status, task_id, e_tag=None, last_modified=None, location=None, error=None)[source]

Bases: msrest.serialization.Model

Result for a single task added as part of an add task collection operation.

Parameters:
  • status (str or TaskAddStatus) – The status of the add task request. Possible values include: ‘success’, ‘clientError’, ‘serverError’
  • task_id (str) – The ID of the task for which this is the result.
  • e_tag (str) – The ETag of the task, if the task was successfully added.
  • last_modified (datetime) – The last modified time of the task.
  • location (str) – The URL of the task, if the task was successfully added.
  • error (BatchError) – The error encountered while attempting to add the task.
class azure.batch.models.TaskAddCollectionResult(value=None)[source]

Bases: msrest.serialization.Model

The result of adding a collection of tasks to a job.

Parameters:value (list of TaskAddResult) – The results of the add task collection operation.
class azure.batch.models.SubtaskInformation(id=None, node_info=None, start_time=None, end_time=None, exit_code=None, failure_info=None, state=None, state_transition_time=None, previous_state=None, previous_state_transition_time=None, result=None)[source]

Bases: msrest.serialization.Model

Information about an Azure Batch subtask.

Parameters:
  • id (int) – The ID of the subtask.
  • node_info (ComputeNodeInformation) – Information about the compute node on which the subtask ran.
  • start_time (datetime) – The time at which the subtask started running. If the subtask has been restarted or retried, this is the most recent time at which the subtask started running.
  • end_time (datetime) – The time at which the subtask completed. This property is set only if the subtask is in the Completed state.
  • exit_code (int) – The exit code of the program specified on the subtask command line. This property is set only if the subtask is in the completed state. In general, the exit code for a process reflects the specific convention implemented by the application developer for that process. If you use the exit code value to make decisions in your code, be sure that you know the exit code convention used by the application process. However, if the Batch service terminates the subtask (due to timeout, or user termination via the API) you may see an operating system-defined exit code.
  • failure_info (TaskFailureInformation) – Information describing the task failure, if any. This property is set only if the task is in the completed state and encountered a failure.
  • state (str or SubtaskState) – The current state of the subtask. Possible values include: ‘preparing’, ‘running’, ‘completed’
  • state_transition_time (datetime) – The time at which the subtask entered its current state.
  • previous_state (str or SubtaskState) – The previous state of the subtask. This property is not set if the subtask is in its initial running state. Possible values include: ‘preparing’, ‘running’, ‘completed’
  • previous_state_transition_time (datetime) – The time at which the subtask entered its previous state. This property is not set if the subtask is in its initial running state.
  • result (str or TaskExecutionResult) – The result of the task execution. If the value is ‘failed’, then the details of the failure can be found in the failureInfo property. Possible values include: ‘success’, ‘failure’
class azure.batch.models.CloudTaskListSubtasksResult(value=None)[source]

Bases: msrest.serialization.Model

The result of listing the subtasks of a task.

Parameters:value (list of SubtaskInformation) – The list of subtasks.
class azure.batch.models.TaskInformation(task_state, task_url=None, job_id=None, task_id=None, subtask_id=None, execution_info=None)[source]

Bases: msrest.serialization.Model

Information about a task running on a compute node.

Parameters:
  • task_url (str) – The URL of the task.
  • job_id (str) – The ID of the job to which the task belongs.
  • task_id (str) – The ID of the task.
  • subtask_id (int) – The ID of the subtask if the task is a multi-instance task.
  • task_state (str or TaskState) – The current state of the task. Possible values include: ‘active’, ‘preparing’, ‘running’, ‘completed’
  • execution_info (TaskExecutionInformation) – Information about the execution of the task.
class azure.batch.models.StartTaskInformation(state, start_time, retry_count, end_time=None, exit_code=None, failure_info=None, last_retry_time=None, result=None)[source]

Bases: msrest.serialization.Model

Information about a start task running on a compute node.

Parameters:
  • state (str or StartTaskState) – The state of the start task on the compute node. running - The start task is currently running. completed - The start task has exited with exit code 0, or the start task has failed and the retry limit has reached, or the start task process did not run due to scheduling errors. Possible values include: ‘running’, ‘completed’
  • start_time (datetime) – The time at which the start task started running. This value is reset every time the task is restarted or retried (that is, this is the most recent time at which the start task started running).
  • end_time (datetime) – The time at which the start task stopped running. This is the end time of the most recent run of the start task, if that run has completed (even if that run failed and a retry is pending). This element is not present if the start task is currently running.
  • exit_code (int) – The exit code of the program specified on the start task command line. This property is set only if the start task is in the completed state. In general, the exit code for a process reflects the specific convention implemented by the application developer for that process. If you use the exit code value to make decisions in your code, be sure that you know the exit code convention used by the application process. However, if the Batch service terminates the start task (due to timeout, or user termination via the API) you may see an operating system-defined exit code.
  • failure_info (TaskFailureInformation) – Information describing the task failure, if any. This property is set only if the task is in the completed state and encountered a failure.
  • retry_count (int) – The number of times the task has been retried by the Batch service. The number of times the task has been retried by the Batch service. Task application failures (non-zero exit code) are retried, pre-processing errors (the task could not be run) and file upload errors are not retried. The Batch service will retry the task up to the limit specified by the constraints.
  • last_retry_time (datetime) – The most recent time at which a retry of the task started running. This element is present only if the task was retried (i.e. retryCount is nonzero). If present, this is typically the same as startTime, but may be different if the task has been restarted for reasons other than retry; for example, if the compute node was rebooted during a retry, then the startTime is updated but the lastRetryTime is not.
  • result (str or TaskExecutionResult) – The result of the task execution. If the value is ‘failed’, then the details of the failure can be found in the failureInfo property. Possible values include: ‘success’, ‘failure’
class azure.batch.models.ComputeNodeError(code=None, message=None, error_details=None)[source]

Bases: msrest.serialization.Model

An error encountered by a compute node.

Parameters:
  • code (str) – An identifier for the compute node error. Codes are invariant and are intended to be consumed programmatically.
  • message (str) – A message describing the compute node error, intended to be suitable for display in a user interface.
  • error_details (list of NameValuePair) – The list of additional error details related to the compute node error.
class azure.batch.models.ComputeNode(id=None, url=None, state=None, scheduling_state=None, state_transition_time=None, last_boot_time=None, allocation_time=None, ip_address=None, affinity_id=None, vm_size=None, total_tasks_run=None, running_tasks_count=None, total_tasks_succeeded=None, recent_tasks=None, start_task=None, start_task_info=None, certificate_references=None, errors=None, is_dedicated=None)[source]

Bases: msrest.serialization.Model

A compute node in the Batch service.

Parameters:
  • id (str) – The ID of the compute node. Every node that is added to a pool is assigned a unique ID. Whenever a node is removed from a pool, all of its local files are deleted, and the ID is reclaimed and could be reused for new nodes.
  • url (str) – The URL of the compute node.
  • state (str or ComputeNodeState) – The current state of the compute node. Possible values include: ‘idle’, ‘rebooting’, ‘reimaging’, ‘running’, ‘unusable’, ‘creating’, ‘starting’, ‘waitingForStartTask’, ‘startTaskFailed’, ‘unknown’, ‘leavingPool’, ‘offline’, ‘preempted’
  • scheduling_state (str or SchedulingState) – Whether the compute node is available for task scheduling. enabled - Tasks can be scheduled on the node. disabled - No new tasks will be scheduled on the node. Tasks already running on the node may still run to completion. All nodes start with scheduling enabled. Possible values include: ‘enabled’, ‘disabled’
  • state_transition_time (datetime) – The time at which the compute node entered its current state.
  • last_boot_time (datetime) – The time at which the compute node was started. This property may not be present if the node state is unusable.
  • allocation_time (datetime) – The time at which this compute node was allocated to the pool.
  • ip_address (str) – The IP address that other compute nodes can use to communicate with this compute node. Every node that is added to a pool is assigned a unique IP address. Whenever a node is removed from a pool, all of its local files are deleted, and the IP address is reclaimed and could be reused for new nodes.
  • affinity_id (str) – An identifier which can be passed when adding a task to request that the task be scheduled close to this compute node.
  • vm_size (str) – The size of the virtual machine hosting the compute node. For information about available sizes of virtual machines for Cloud Services pools (pools created with cloudServiceConfiguration), see Sizes for Cloud Services (http://azure.microsoft.com/documentation/articles/cloud-services-sizes-specs/). Batch supports all Cloud Services VM sizes except ExtraSmall, A1V2 and A2V2. For information about available VM sizes for pools using images from the Virtual Machines Marketplace (pools created with virtualMachineConfiguration) see Sizes for Virtual Machines (Linux) (https://azure.microsoft.com/documentation/articles/virtual-machines-linux-sizes/) or Sizes for Virtual Machines (Windows) (https://azure.microsoft.com/documentation/articles/virtual-machines-windows-sizes/). Batch supports all Azure VM sizes except STANDARD_A0 and those with premium storage (STANDARD_GS, STANDARD_DS, and STANDARD_DSV2 series).
  • total_tasks_run (int) – The total number of job tasks completed on the compute node. This includes Job Preparation, Job Release and Job Manager tasks, but not the pool start task.
  • running_tasks_count (int) – The total number of currently running job tasks on the compute node. This includes Job Preparation, Job Release, and Job Manager tasks, but not the pool start task.
  • total_tasks_succeeded (int) – The total number of job tasks which completed successfully (with exitCode 0) on the compute node. This includes Job Preparation, Job Release, and Job Manager tasks, but not the pool start task.
  • recent_tasks (list of TaskInformation) – The list of tasks that are currently running on the compute node.
  • start_task (StartTask) – The task specified to run on the compute node as it joins the pool.
  • start_task_info (StartTaskInformation) – Runtime information about the execution of the start task on the compute node.
  • certificate_references (list of CertificateReference) – The list of certificates installed on the compute node. For Windows compute nodes, the Batch service installs the certificates to the specified certificate store and location. For Linux compute nodes, the certificates are stored in a directory inside the task working directory and an environment variable AZ_BATCH_CERTIFICATES_DIR is supplied to the task to query for this location. For certificates with visibility of ‘remoteUser’, a ‘certs’ directory is created in the user’s home directory (e.g., /home/{user-name}/certs) and certificates are placed in that directory.
  • errors (list of ComputeNodeError) – The list of errors that are currently being encountered by the compute node.
  • is_dedicated (bool) – Whether this compute node is a dedicated node. If false, the node is a low-priority node.
class azure.batch.models.ComputeNodeUser(name, is_admin=None, expiry_time=None, password=None, ssh_public_key=None)[source]

Bases: msrest.serialization.Model

A user account for RDP or SSH access on a compute node.

Parameters:
  • name (str) – The user name of the account.
  • is_admin (bool) – Whether the account should be an administrator on the compute node. The default value is false.
  • expiry_time (datetime) – The time at which the account should expire. If omitted, the default is 1 day from the current time. For Linux compute nodes, the expiryTime has a precision up to a day.
  • password (str) – The password of the account. The password is required for Windows nodes (those created with ‘cloudServiceConfiguration’, or created with ‘virtualMachineConfiguration’ using a Windows image reference). For Linux compute nodes, the password can optionally be specified along with the sshPublicKey property.
  • ssh_public_key (str) – The SSH public key that can be used for remote login to the compute node. The public key should be compatible with OpenSSH encoding and should be base 64 encoded. This property can be specified only for Linux nodes. If this is specified for a Windows node, then the Batch service rejects the request; if you are calling the REST API directly, the HTTP status code is 400 (Bad Request).
class azure.batch.models.ComputeNodeGetRemoteLoginSettingsResult(remote_login_ip_address, remote_login_port)[source]

Bases: msrest.serialization.Model

The remote login settings for a compute node.

Parameters:
  • remote_login_ip_address (str) – The IP address used for remote login to the compute node.
  • remote_login_port (int) – The port used for remote login to the compute node.
class azure.batch.models.JobSchedulePatchParameter(schedule=None, job_specification=None, metadata=None)[source]

Bases: msrest.serialization.Model

The set of changes to be made to a job schedule.

Parameters:
  • schedule (Schedule) – The schedule according to which jobs will be created. If you do not specify this element, the existing schedule is left unchanged.
  • job_specification (JobSpecification) – The details of the jobs to be created on this schedule. Updates affect only jobs that are started after the update has taken place. Any currently active job continues with the older specification.
  • metadata (list of MetadataItem) – A list of name-value pairs associated with the job schedule as metadata. If you do not specify this element, existing metadata is left unchanged.
class azure.batch.models.JobScheduleUpdateParameter(schedule, job_specification, metadata=None)[source]

Bases: msrest.serialization.Model

The set of changes to be made to a job schedule.

Parameters:
  • schedule (Schedule) – The schedule according to which jobs will be created. If you do not specify this element, it is equivalent to passing the default schedule: that is, a single job scheduled to run immediately.
  • job_specification (JobSpecification) – Details of the jobs to be created on this schedule. Updates affect only jobs that are started after the update has taken place. Any currently active job continues with the older specification.
  • metadata (list of MetadataItem) – A list of name-value pairs associated with the job schedule as metadata. If you do not specify this element, it takes the default value of an empty list; in effect, any existing metadata is deleted.
class azure.batch.models.JobDisableParameter(disable_tasks)[source]

Bases: msrest.serialization.Model

Options when disabling a job.

Parameters:disable_tasks (str or DisableJobOption) – What to do with active tasks associated with the job. requeue - Terminate running tasks and requeue them. The tasks will run again when the job is enabled. terminate - Terminate running tasks. The tasks will not run again. wait - Allow currently running tasks to complete. Possible values include: ‘requeue’, ‘terminate’, ‘wait’
class azure.batch.models.JobTerminateParameter(terminate_reason=None)[source]

Bases: msrest.serialization.Model

Options when terminating a job.

Parameters:terminate_reason (str) – The text you want to appear as the job’s TerminateReason. The default is ‘UserTerminate’.
class azure.batch.models.JobPatchParameter(priority=None, on_all_tasks_complete=None, constraints=None, pool_info=None, metadata=None)[source]

Bases: msrest.serialization.Model

The set of changes to be made to a job.

Parameters:
  • priority (int) – The priority of the job. Priority values can range from -1000 to 1000, with -1000 being the lowest priority and 1000 being the highest priority. If omitted, the priority of the job is left unchanged.
  • on_all_tasks_complete (str or OnAllTasksComplete) – The action the Batch service should take when all tasks in the job are in the completed state. If omitted, the completion behavior is left unchanged. You may not change the value from terminateJob to noAction - that is, once you have engaged automatic job termination, you cannot turn it off again. If you try to do this, the request fails with an ‘invalid property value’ error response; if you are calling the REST API directly, the HTTP status code is 400 (Bad Request). Possible values include: ‘noAction’, ‘terminateJob’
  • constraints (JobConstraints) – The execution constraints for the job. If omitted, the existing execution constraints are left unchanged.
  • pool_info (PoolInformation) – The pool on which the Batch service runs the job’s tasks. You may change the pool for a job only when the job is disabled. The Patch Job call will fail if you include the poolInfo element and the job is not disabled. If you specify an autoPoolSpecification specification in the poolInfo, only the keepAlive property can be updated, and then only if the auto pool has a poolLifetimeOption of job. If omitted, the job continues to run on its current pool.
  • metadata (list of MetadataItem) – A list of name-value pairs associated with the job as metadata. If omitted, the existing job metadata is left unchanged.
class azure.batch.models.JobUpdateParameter(pool_info, priority=None, constraints=None, metadata=None, on_all_tasks_complete=None)[source]

Bases: msrest.serialization.Model

The set of changes to be made to a job.

Parameters:
  • priority (int) – The priority of the job. Priority values can range from -1000 to 1000, with -1000 being the lowest priority and 1000 being the highest priority. If omitted, it is set to the default value 0.
  • constraints (JobConstraints) – The execution constraints for the job. If omitted, the constraints are cleared.
  • pool_info (PoolInformation) – The pool on which the Batch service runs the job’s tasks. You may change the pool for a job only when the job is disabled. The Update Job call will fail if you include the poolInfo element and the job is not disabled. If you specify an autoPoolSpecification specification in the poolInfo, only the keepAlive property can be updated, and then only if the auto pool has a poolLifetimeOption of job.
  • metadata (list of MetadataItem) – A list of name-value pairs associated with the job as metadata. If omitted, it takes the default value of an empty list; in effect, any existing metadata is deleted.
  • on_all_tasks_complete (str or OnAllTasksComplete) – The action the Batch service should take when all tasks in the job are in the completed state. If omitted, the completion behavior is set to noAction. If the current value is terminateJob, this is an error because a job’s completion behavior may not be changed from terminateJob to noAction. Possible values include: ‘noAction’, ‘terminateJob’
class azure.batch.models.PoolEnableAutoScaleParameter(auto_scale_formula=None, auto_scale_evaluation_interval=None)[source]

Bases: msrest.serialization.Model

Options for enabling automatic scaling on a pool.

Parameters:
  • auto_scale_formula (str) – The formula for the desired number of compute nodes in the pool. The formula is checked for validity before it is applied to the pool. If the formula is not valid, the Batch service rejects the request with detailed error information. For more information about specifying this formula, see Automatically scale compute nodes in an Azure Batch pool (https://azure.microsoft.com/en-us/documentation/articles/batch-automatic-scaling).
  • auto_scale_evaluation_interval (timedelta) – The time interval at which to automatically adjust the pool size according to the autoscale formula. The default value is 15 minutes. The minimum and maximum value are 5 minutes and 168 hours respectively. If you specify a value less than 5 minutes or greater than 168 hours, the Batch service rejects the request with an invalid property value error; if you are calling the REST API directly, the HTTP status code is 400 (Bad Request). If you specify a new interval, then the existing autoscale evaluation schedule will be stopped and a new autoscale evaluation schedule will be started, with its starting time being the time when this request was issued.
class azure.batch.models.PoolEvaluateAutoScaleParameter(auto_scale_formula)[source]

Bases: msrest.serialization.Model

Options for evaluating an automatic scaling formula on a pool.

Parameters:auto_scale_formula (str) – The formula for the desired number of compute nodes in the pool. The formula is validated and its results calculated, but it is not applied to the pool. To apply the formula to the pool, ‘Enable automatic scaling on a pool’. For more information about specifying this formula, see Automatically scale compute nodes in an Azure Batch pool (https://azure.microsoft.com/en-us/documentation/articles/batch-automatic-scaling).
class azure.batch.models.PoolResizeParameter(target_dedicated_nodes=None, target_low_priority_nodes=None, resize_timeout=None, node_deallocation_option=None)[source]

Bases: msrest.serialization.Model

Options for changing the size of a pool.

Parameters:
  • target_dedicated_nodes (int) – The desired number of dedicated compute nodes in the pool.
  • target_low_priority_nodes (int) – The desired number of low-priority compute nodes in the pool.
  • resize_timeout (timedelta) – The timeout for allocation of compute nodes to the pool or removal of compute nodes from the pool. The default value is 15 minutes. The minimum value is 5 minutes. If you specify a value less than 5 minutes, the Batch service returns an error; if you are calling the REST API directly, the HTTP status code is 400 (Bad Request).
  • node_deallocation_option (str or ComputeNodeDeallocationOption) – Determines what to do with a node and its running task(s) if the pool size is decreasing. The default value is requeue. Possible values include: ‘requeue’, ‘terminate’, ‘taskCompletion’, ‘retainedData’
class azure.batch.models.PoolUpdatePropertiesParameter(certificate_references, application_package_references, metadata, start_task=None)[source]

Bases: msrest.serialization.Model

The set of changes to be made to a pool.

Parameters:
  • start_task (StartTask) – A task to run on each compute node as it joins the pool. The task runs when the node is added to the pool or when the node is restarted. If this element is present, it overwrites any existing start task. If omitted, any existing start task is removed from the pool.
  • certificate_references (list of CertificateReference) – A list of certificates to be installed on each compute node in the pool. If you specify an empty collection, any existing certificate references are removed from the pool. For Windows compute nodes, the Batch service installs the certificates to the specified certificate store and location. For Linux compute nodes, the certificates are stored in a directory inside the task working directory and an environment variable AZ_BATCH_CERTIFICATES_DIR is supplied to the task to query for this location. For certificates with visibility of ‘remoteUser’, a ‘certs’ directory is created in the user’s home directory (e.g., /home/{user-name}/certs) and certificates are placed in that directory.
  • application_package_references (list of ApplicationPackageReference) – A list of application packages to be installed on each compute node in the pool. Changes to application package references affect all new compute nodes joining the pool, but do not affect compute nodes that are already in the pool until they are rebooted or reimaged. The list replaces any existing application package references. If omitted, or if you specify an empty collection, any existing application packages references are removed from the pool.
  • metadata (list of MetadataItem) – A list of name-value pairs associated with the pool as metadata. This list replaces any existing metadata configured on the pool. If omitted, or if you specify an empty collection, any existing metadata is removed from the pool.
class azure.batch.models.PoolUpgradeOSParameter(target_os_version)[source]

Bases: msrest.serialization.Model

Options for upgrading the operating system of compute nodes in a pool.

Parameters:target_os_version (str) – The Azure Guest OS version to be installed on the virtual machines in the pool.
class azure.batch.models.PoolPatchParameter(start_task=None, certificate_references=None, application_package_references=None, metadata=None)[source]

Bases: msrest.serialization.Model

The set of changes to be made to a pool.

Parameters:
  • start_task (StartTask) – A task to run on each compute node as it joins the pool. The task runs when the node is added to the pool or when the node is restarted. If omitted, any existing start task is left unchanged.
  • certificate_references (list of CertificateReference) – A list of certificates to be installed on each compute node in the pool. If omitted, any existing certificate references are left unchanged. For Windows compute nodes, the Batch service installs the certificates to the specified certificate store and location. For Linux compute nodes, the certificates are stored in a directory inside the task working directory and an environment variable AZ_BATCH_CERTIFICATES_DIR is supplied to the task to query for this location. For certificates with visibility of ‘remoteUser’, a ‘certs’ directory is created in the user’s home directory (e.g., /home/{user-name}/certs) and certificates are placed in that directory.
  • application_package_references (list of ApplicationPackageReference) – A list of application packages to be installed on each compute node in the pool. Changes to application package references affect all new compute nodes joining the pool, but do not affect compute nodes that are already in the pool until they are rebooted or reimaged. If this element is present, it replaces any existing application package references. If you specify an empty collection, then all application package references are removed from the pool. If omitted, any existing application package references are left unchanged.
  • metadata (list of MetadataItem) – A list of name-value pairs associated with the pool as metadata. If this element is present, it replaces any existing metadata configured on the pool. If you specify an empty collection, any metadata is removed from the pool. If omitted, any existing metadata is left unchanged.
class azure.batch.models.TaskUpdateParameter(constraints=None)[source]

Bases: msrest.serialization.Model

The set of changes to be made to a task.

Parameters:constraints (TaskConstraints) – Constraints that apply to this task. If omitted, the task is given the default constraints.
class azure.batch.models.NodeUpdateUserParameter(password=None, expiry_time=None, ssh_public_key=None)[source]

Bases: msrest.serialization.Model

The set of changes to be made to a user account on a node.

Parameters:
  • password (str) – The password of the account. The password is required for Windows nodes (those created with ‘cloudServiceConfiguration’, or created with ‘virtualMachineConfiguration’ using a Windows image reference). For Linux compute nodes, the password can optionally be specified along with the sshPublicKey property. If omitted, any existing password is removed.
  • expiry_time (datetime) – The time at which the account should expire. If omitted, the default is 1 day from the current time. For Linux compute nodes, the expiryTime has a precision up to a day.
  • ssh_public_key (str) – The SSH public key that can be used for remote login to the compute node. The public key should be compatible with OpenSSH encoding and should be base 64 encoded. This property can be specified only for Linux nodes. If this is specified for a Windows node, then the Batch service rejects the request; if you are calling the REST API directly, the HTTP status code is 400 (Bad Request). If omitted, any existing SSH public key is removed.
class azure.batch.models.NodeRebootParameter(node_reboot_option=None)[source]

Bases: msrest.serialization.Model

Options for rebooting a compute node.

Parameters:node_reboot_option (str or ComputeNodeRebootOption) – When to reboot the compute node and what to do with currently running tasks. The default value is requeue. Possible values include: ‘requeue’, ‘terminate’, ‘taskCompletion’, ‘retainedData’
class azure.batch.models.NodeReimageParameter(node_reimage_option=None)[source]

Bases: msrest.serialization.Model

Options for reimaging a compute node.

Parameters:node_reimage_option (str or ComputeNodeReimageOption) – When to reimage the compute node and what to do with currently running tasks. The default value is requeue. Possible values include: ‘requeue’, ‘terminate’, ‘taskCompletion’, ‘retainedData’
class azure.batch.models.NodeDisableSchedulingParameter(node_disable_scheduling_option=None)[source]

Bases: msrest.serialization.Model

Options for disabling scheduling on a compute node.

Parameters:node_disable_scheduling_option (str or DisableComputeNodeSchedulingOption) – What to do with currently running tasks when disabling task scheduling on the compute node. The default value is requeue. Possible values include: ‘requeue’, ‘terminate’, ‘taskCompletion’
class azure.batch.models.NodeRemoveParameter(node_list, resize_timeout=None, node_deallocation_option=None)[source]

Bases: msrest.serialization.Model

Options for removing compute nodes from a pool.

Parameters:
  • node_list (list of str) – A list containing the ids of the compute nodes to be removed from the specified pool.
  • resize_timeout (timedelta) – The timeout for removal of compute nodes to the pool. The default value is 15 minutes. The minimum value is 5 minutes. If you specify a value less than 5 minutes, the Batch service returns an error; if you are calling the REST API directly, the HTTP status code is 400 (Bad Request).
  • node_deallocation_option (str or ComputeNodeDeallocationOption) – Determines what to do with a node and its running task(s) after it has been selected for deallocation. The default value is requeue. Possible values include: ‘requeue’, ‘terminate’, ‘taskCompletion’, ‘retainedData’
class azure.batch.models.ApplicationListOptions(max_results=1000, timeout=30, client_request_id=None, return_client_request_id=False, ocp_date=None)[source]

Bases: msrest.serialization.Model

Additional parameters for the Application_list operation.

Parameters:
  • max_results (int) – The maximum number of items to return in the response. A maximum of 1000 applications can be returned. Default value: 1000 .
  • timeout (int) – The maximum time that the server can spend processing the request, in seconds. The default is 30 seconds. Default value: 30 .
  • client_request_id (str) – The caller-generated request identity, in the form of a GUID with no decoration such as curly braces, e.g. 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0.
  • return_client_request_id (bool) – Whether the server should return the client-request-id in the response. Default value: False .
  • ocp_date (datetime) – The time the request was issued. Client libraries typically set this to the current system clock time; set it explicitly if you are calling the REST API directly.
class azure.batch.models.ApplicationGetOptions(timeout=30, client_request_id=None, return_client_request_id=False, ocp_date=None)[source]

Bases: msrest.serialization.Model

Additional parameters for the Application_get operation.

Parameters:
  • timeout (int) – The maximum time that the server can spend processing the request, in seconds. The default is 30 seconds. Default value: 30 .
  • client_request_id (str) – The caller-generated request identity, in the form of a GUID with no decoration such as curly braces, e.g. 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0.
  • return_client_request_id (bool) – Whether the server should return the client-request-id in the response. Default value: False .
  • ocp_date (datetime) – The time the request was issued. Client libraries typically set this to the current system clock time; set it explicitly if you are calling the REST API directly.
class azure.batch.models.PoolListUsageMetricsOptions(start_time=None, end_time=None, filter=None, max_results=1000, timeout=30, client_request_id=None, return_client_request_id=False, ocp_date=None)[source]

Bases: msrest.serialization.Model

Additional parameters for the Pool_list_usage_metrics operation.

Parameters:
  • start_time (datetime) – The earliest time from which to include metrics. This must be at least two and a half hours before the current time. If not specified this defaults to the start time of the last aggregation interval currently available.
  • end_time (datetime) – The latest time from which to include metrics. This must be at least two hours before the current time. If not specified this defaults to the end time of the last aggregation interval currently available.
  • filter (str) – An OData $filter clause. If this is not specified the response includes all pools that existed in the account in the time range of the returned aggregation intervals.
  • max_results (int) – The maximum number of items to return in the response. A maximum of 1000 results will be returned. Default value: 1000 .
  • timeout (int) – The maximum time that the server can spend processing the request, in seconds. The default is 30 seconds. Default value: 30 .
  • client_request_id (str) – The caller-generated request identity, in the form of a GUID with no decoration such as curly braces, e.g. 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0.
  • return_client_request_id (bool) – Whether the server should return the client-request-id in the response. Default value: False .
  • ocp_date (datetime) – The time the request was issued. Client libraries typically set this to the current system clock time; set it explicitly if you are calling the REST API directly.
class azure.batch.models.PoolGetAllLifetimeStatisticsOptions(timeout=30, client_request_id=None, return_client_request_id=False, ocp_date=None)[source]

Bases: msrest.serialization.Model

Additional parameters for the Pool_get_all_lifetime_statistics operation.

Parameters:
  • timeout (int) – The maximum time that the server can spend processing the request, in seconds. The default is 30 seconds. Default value: 30 .
  • client_request_id (str) – The caller-generated request identity, in the form of a GUID with no decoration such as curly braces, e.g. 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0.
  • return_client_request_id (bool) – Whether the server should return the client-request-id in the response. Default value: False .
  • ocp_date (datetime) – The time the request was issued. Client libraries typically set this to the current system clock time; set it explicitly if you are calling the REST API directly.
class azure.batch.models.PoolAddOptions(timeout=30, client_request_id=None, return_client_request_id=False, ocp_date=None)[source]

Bases: msrest.serialization.Model

Additional parameters for the Pool_add operation.

Parameters:
  • timeout (int) – The maximum time that the server can spend processing the request, in seconds. The default is 30 seconds. Default value: 30 .
  • client_request_id (str) – The caller-generated request identity, in the form of a GUID with no decoration such as curly braces, e.g. 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0.
  • return_client_request_id (bool) – Whether the server should return the client-request-id in the response. Default value: False .
  • ocp_date (datetime) – The time the request was issued. Client libraries typically set this to the current system clock time; set it explicitly if you are calling the REST API directly.
class azure.batch.models.PoolListOptions(filter=None, select=None, expand=None, max_results=1000, timeout=30, client_request_id=None, return_client_request_id=False, ocp_date=None)[source]

Bases: msrest.serialization.Model

Additional parameters for the Pool_list operation.

Parameters:
  • filter (str) – An OData $filter clause.
  • select (str) – An OData $select clause.
  • expand (str) – An OData $expand clause.
  • max_results (int) – The maximum number of items to return in the response. A maximum of 1000 pools can be returned. Default value: 1000 .
  • timeout (int) – The maximum time that the server can spend processing the request, in seconds. The default is 30 seconds. Default value: 30 .
  • client_request_id (str) – The caller-generated request identity, in the form of a GUID with no decoration such as curly braces, e.g. 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0.
  • return_client_request_id (bool) – Whether the server should return the client-request-id in the response. Default value: False .
  • ocp_date (datetime) – The time the request was issued. Client libraries typically set this to the current system clock time; set it explicitly if you are calling the REST API directly.
class azure.batch.models.PoolDeleteOptions(timeout=30, client_request_id=None, return_client_request_id=False, ocp_date=None, if_match=None, if_none_match=None, if_modified_since=None, if_unmodified_since=None)[source]

Bases: msrest.serialization.Model

Additional parameters for the Pool_delete operation.

Parameters:
  • timeout (int) – The maximum time that the server can spend processing the request, in seconds. The default is 30 seconds. Default value: 30 .
  • client_request_id (str) – The caller-generated request identity, in the form of a GUID with no decoration such as curly braces, e.g. 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0.
  • return_client_request_id (bool) – Whether the server should return the client-request-id in the response. Default value: False .
  • ocp_date (datetime) – The time the request was issued. Client libraries typically set this to the current system clock time; set it explicitly if you are calling the REST API directly.
  • if_match (str) – An ETag value associated with the version of the resource known to the client. The operation will be performed only if the resource’s current ETag on the service exactly matches the value specified by the client.
  • if_none_match (str) – An ETag value associated with the version of the resource known to the client. The operation will be performed only if the resource’s current ETag on the service does not match the value specified by the client.
  • if_modified_since (datetime) – A timestamp indicating the last modified time of the resource known to the client. The operation will be performed only if the resource on the service has been modified since the specified time.
  • if_unmodified_since (datetime) – A timestamp indicating the last modified time of the resource known to the client. The operation will be performed only if the resource on the service has not been modified since the specified time.
class azure.batch.models.PoolExistsOptions(timeout=30, client_request_id=None, return_client_request_id=False, ocp_date=None, if_match=None, if_none_match=None, if_modified_since=None, if_unmodified_since=None)[source]

Bases: msrest.serialization.Model

Additional parameters for the Pool_exists operation.

Parameters:
  • timeout (int) – The maximum time that the server can spend processing the request, in seconds. The default is 30 seconds. Default value: 30 .
  • client_request_id (str) – The caller-generated request identity, in the form of a GUID with no decoration such as curly braces, e.g. 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0.
  • return_client_request_id (bool) – Whether the server should return the client-request-id in the response. Default value: False .
  • ocp_date (datetime) – The time the request was issued. Client libraries typically set this to the current system clock time; set it explicitly if you are calling the REST API directly.
  • if_match (str) – An ETag value associated with the version of the resource known to the client. The operation will be performed only if the resource’s current ETag on the service exactly matches the value specified by the client.
  • if_none_match (str) – An ETag value associated with the version of the resource known to the client. The operation will be performed only if the resource’s current ETag on the service does not match the value specified by the client.
  • if_modified_since (datetime) – A timestamp indicating the last modified time of the resource known to the client. The operation will be performed only if the resource on the service has been modified since the specified time.
  • if_unmodified_since (datetime) – A timestamp indicating the last modified time of the resource known to the client. The operation will be performed only if the resource on the service has not been modified since the specified time.
class azure.batch.models.PoolGetOptions(select=None, expand=None, timeout=30, client_request_id=None, return_client_request_id=False, ocp_date=None, if_match=None, if_none_match=None, if_modified_since=None, if_unmodified_since=None)[source]

Bases: msrest.serialization.Model

Additional parameters for the Pool_get operation.

Parameters:
  • select (str) – An OData $select clause.
  • expand (str) – An OData $expand clause.
  • timeout (int) – The maximum time that the server can spend processing the request, in seconds. The default is 30 seconds. Default value: 30 .
  • client_request_id (str) – The caller-generated request identity, in the form of a GUID with no decoration such as curly braces, e.g. 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0.
  • return_client_request_id (bool) – Whether the server should return the client-request-id in the response. Default value: False .
  • ocp_date (datetime) – The time the request was issued. Client libraries typically set this to the current system clock time; set it explicitly if you are calling the REST API directly.
  • if_match (str) – An ETag value associated with the version of the resource known to the client. The operation will be performed only if the resource’s current ETag on the service exactly matches the value specified by the client.
  • if_none_match (str) – An ETag value associated with the version of the resource known to the client. The operation will be performed only if the resource’s current ETag on the service does not match the value specified by the client.
  • if_modified_since (datetime) – A timestamp indicating the last modified time of the resource known to the client. The operation will be performed only if the resource on the service has been modified since the specified time.
  • if_unmodified_since (datetime) – A timestamp indicating the last modified time of the resource known to the client. The operation will be performed only if the resource on the service has not been modified since the specified time.
class azure.batch.models.PoolPatchOptions(timeout=30, client_request_id=None, return_client_request_id=False, ocp_date=None, if_match=None, if_none_match=None, if_modified_since=None, if_unmodified_since=None)[source]

Bases: msrest.serialization.Model

Additional parameters for the Pool_patch operation.

Parameters:
  • timeout (int) – The maximum time that the server can spend processing the request, in seconds. The default is 30 seconds. Default value: 30 .
  • client_request_id (str) – The caller-generated request identity, in the form of a GUID with no decoration such as curly braces, e.g. 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0.
  • return_client_request_id (bool) – Whether the server should return the client-request-id in the response. Default value: False .
  • ocp_date (datetime) – The time the request was issued. Client libraries typically set this to the current system clock time; set it explicitly if you are calling the REST API directly.
  • if_match (str) – An ETag value associated with the version of the resource known to the client. The operation will be performed only if the resource’s current ETag on the service exactly matches the value specified by the client.
  • if_none_match (str) – An ETag value associated with the version of the resource known to the client. The operation will be performed only if the resource’s current ETag on the service does not match the value specified by the client.
  • if_modified_since (datetime) – A timestamp indicating the last modified time of the resource known to the client. The operation will be performed only if the resource on the service has been modified since the specified time.
  • if_unmodified_since (datetime) – A timestamp indicating the last modified time of the resource known to the client. The operation will be performed only if the resource on the service has not been modified since the specified time.
class azure.batch.models.PoolDisableAutoScaleOptions(timeout=30, client_request_id=None, return_client_request_id=False, ocp_date=None)[source]

Bases: msrest.serialization.Model

Additional parameters for the Pool_disable_auto_scale operation.

Parameters:
  • timeout (int) – The maximum time that the server can spend processing the request, in seconds. The default is 30 seconds. Default value: 30 .
  • client_request_id (str) – The caller-generated request identity, in the form of a GUID with no decoration such as curly braces, e.g. 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0.
  • return_client_request_id (bool) – Whether the server should return the client-request-id in the response. Default value: False .
  • ocp_date (datetime) – The time the request was issued. Client libraries typically set this to the current system clock time; set it explicitly if you are calling the REST API directly.
class azure.batch.models.PoolEnableAutoScaleOptions(timeout=30, client_request_id=None, return_client_request_id=False, ocp_date=None, if_match=None, if_none_match=None, if_modified_since=None, if_unmodified_since=None)[source]

Bases: msrest.serialization.Model

Additional parameters for the Pool_enable_auto_scale operation.

Parameters:
  • timeout (int) – The maximum time that the server can spend processing the request, in seconds. The default is 30 seconds. Default value: 30 .
  • client_request_id (str) – The caller-generated request identity, in the form of a GUID with no decoration such as curly braces, e.g. 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0.
  • return_client_request_id (bool) – Whether the server should return the client-request-id in the response. Default value: False .
  • ocp_date (datetime) – The time the request was issued. Client libraries typically set this to the current system clock time; set it explicitly if you are calling the REST API directly.
  • if_match (str) – An ETag value associated with the version of the resource known to the client. The operation will be performed only if the resource’s current ETag on the service exactly matches the value specified by the client.
  • if_none_match (str) – An ETag value associated with the version of the resource known to the client. The operation will be performed only if the resource’s current ETag on the service does not match the value specified by the client.
  • if_modified_since (datetime) – A timestamp indicating the last modified time of the resource known to the client. The operation will be performed only if the resource on the service has been modified since the specified time.
  • if_unmodified_since (datetime) – A timestamp indicating the last modified time of the resource known to the client. The operation will be performed only if the resource on the service has not been modified since the specified time.
class azure.batch.models.PoolEvaluateAutoScaleOptions(timeout=30, client_request_id=None, return_client_request_id=False, ocp_date=None)[source]

Bases: msrest.serialization.Model

Additional parameters for the Pool_evaluate_auto_scale operation.

Parameters:
  • timeout (int) – The maximum time that the server can spend processing the request, in seconds. The default is 30 seconds. Default value: 30 .
  • client_request_id (str) – The caller-generated request identity, in the form of a GUID with no decoration such as curly braces, e.g. 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0.
  • return_client_request_id (bool) – Whether the server should return the client-request-id in the response. Default value: False .
  • ocp_date (datetime) – The time the request was issued. Client libraries typically set this to the current system clock time; set it explicitly if you are calling the REST API directly.
class azure.batch.models.PoolResizeOptions(timeout=30, client_request_id=None, return_client_request_id=False, ocp_date=None, if_match=None, if_none_match=None, if_modified_since=None, if_unmodified_since=None)[source]

Bases: msrest.serialization.Model

Additional parameters for the Pool_resize operation.

Parameters:
  • timeout (int) – The maximum time that the server can spend processing the request, in seconds. The default is 30 seconds. Default value: 30 .
  • client_request_id (str) – The caller-generated request identity, in the form of a GUID with no decoration such as curly braces, e.g. 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0.
  • return_client_request_id (bool) – Whether the server should return the client-request-id in the response. Default value: False .
  • ocp_date (datetime) – The time the request was issued. Client libraries typically set this to the current system clock time; set it explicitly if you are calling the REST API directly.
  • if_match (str) – An ETag value associated with the version of the resource known to the client. The operation will be performed only if the resource’s current ETag on the service exactly matches the value specified by the client.
  • if_none_match (str) – An ETag value associated with the version of the resource known to the client. The operation will be performed only if the resource’s current ETag on the service does not match the value specified by the client.
  • if_modified_since (datetime) – A timestamp indicating the last modified time of the resource known to the client. The operation will be performed only if the resource on the service has been modified since the specified time.
  • if_unmodified_since (datetime) – A timestamp indicating the last modified time of the resource known to the client. The operation will be performed only if the resource on the service has not been modified since the specified time.
class azure.batch.models.PoolStopResizeOptions(timeout=30, client_request_id=None, return_client_request_id=False, ocp_date=None, if_match=None, if_none_match=None, if_modified_since=None, if_unmodified_since=None)[source]

Bases: msrest.serialization.Model

Additional parameters for the Pool_stop_resize operation.

Parameters:
  • timeout (int) – The maximum time that the server can spend processing the request, in seconds. The default is 30 seconds. Default value: 30 .
  • client_request_id (str) – The caller-generated request identity, in the form of a GUID with no decoration such as curly braces, e.g. 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0.
  • return_client_request_id (bool) – Whether the server should return the client-request-id in the response. Default value: False .
  • ocp_date (datetime) – The time the request was issued. Client libraries typically set this to the current system clock time; set it explicitly if you are calling the REST API directly.
  • if_match (str) – An ETag value associated with the version of the resource known to the client. The operation will be performed only if the resource’s current ETag on the service exactly matches the value specified by the client.
  • if_none_match (str) – An ETag value associated with the version of the resource known to the client. The operation will be performed only if the resource’s current ETag on the service does not match the value specified by the client.
  • if_modified_since (datetime) – A timestamp indicating the last modified time of the resource known to the client. The operation will be performed only if the resource on the service has been modified since the specified time.
  • if_unmodified_since (datetime) – A timestamp indicating the last modified time of the resource known to the client. The operation will be performed only if the resource on the service has not been modified since the specified time.
class azure.batch.models.PoolUpdatePropertiesOptions(timeout=30, client_request_id=None, return_client_request_id=False, ocp_date=None)[source]

Bases: msrest.serialization.Model

Additional parameters for the Pool_update_properties operation.

Parameters:
  • timeout (int) – The maximum time that the server can spend processing the request, in seconds. The default is 30 seconds. Default value: 30 .
  • client_request_id (str) – The caller-generated request identity, in the form of a GUID with no decoration such as curly braces, e.g. 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0.
  • return_client_request_id (bool) – Whether the server should return the client-request-id in the response. Default value: False .
  • ocp_date (datetime) – The time the request was issued. Client libraries typically set this to the current system clock time; set it explicitly if you are calling the REST API directly.
class azure.batch.models.PoolUpgradeOsOptions(timeout=30, client_request_id=None, return_client_request_id=False, ocp_date=None, if_match=None, if_none_match=None, if_modified_since=None, if_unmodified_since=None)[source]

Bases: msrest.serialization.Model

Additional parameters for the Pool_upgrade_os operation.

Parameters:
  • timeout (int) – The maximum time that the server can spend processing the request, in seconds. The default is 30 seconds. Default value: 30 .
  • client_request_id (str) – The caller-generated request identity, in the form of a GUID with no decoration such as curly braces, e.g. 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0.
  • return_client_request_id (bool) – Whether the server should return the client-request-id in the response. Default value: False .
  • ocp_date (datetime) – The time the request was issued. Client libraries typically set this to the current system clock time; set it explicitly if you are calling the REST API directly.
  • if_match (str) – An ETag value associated with the version of the resource known to the client. The operation will be performed only if the resource’s current ETag on the service exactly matches the value specified by the client.
  • if_none_match (str) – An ETag value associated with the version of the resource known to the client. The operation will be performed only if the resource’s current ETag on the service does not match the value specified by the client.
  • if_modified_since (datetime) – A timestamp indicating the last modified time of the resource known to the client. The operation will be performed only if the resource on the service has been modified since the specified time.
  • if_unmodified_since (datetime) – A timestamp indicating the last modified time of the resource known to the client. The operation will be performed only if the resource on the service has not been modified since the specified time.
class azure.batch.models.PoolRemoveNodesOptions(timeout=30, client_request_id=None, return_client_request_id=False, ocp_date=None, if_match=None, if_none_match=None, if_modified_since=None, if_unmodified_since=None)[source]

Bases: msrest.serialization.Model

Additional parameters for the Pool_remove_nodes operation.

Parameters:
  • timeout (int) – The maximum time that the server can spend processing the request, in seconds. The default is 30 seconds. Default value: 30 .
  • client_request_id (str) – The caller-generated request identity, in the form of a GUID with no decoration such as curly braces, e.g. 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0.
  • return_client_request_id (bool) – Whether the server should return the client-request-id in the response. Default value: False .
  • ocp_date (datetime) – The time the request was issued. Client libraries typically set this to the current system clock time; set it explicitly if you are calling the REST API directly.
  • if_match (str) – An ETag value associated with the version of the resource known to the client. The operation will be performed only if the resource’s current ETag on the service exactly matches the value specified by the client.
  • if_none_match (str) – An ETag value associated with the version of the resource known to the client. The operation will be performed only if the resource’s current ETag on the service does not match the value specified by the client.
  • if_modified_since (datetime) – A timestamp indicating the last modified time of the resource known to the client. The operation will be performed only if the resource on the service has been modified since the specified time.
  • if_unmodified_since (datetime) – A timestamp indicating the last modified time of the resource known to the client. The operation will be performed only if the resource on the service has not been modified since the specified time.
class azure.batch.models.AccountListNodeAgentSkusOptions(filter=None, max_results=1000, timeout=30, client_request_id=None, return_client_request_id=False, ocp_date=None)[source]

Bases: msrest.serialization.Model

Additional parameters for the Account_list_node_agent_skus operation.

Parameters:
  • filter (str) – An OData $filter clause.
  • max_results (int) – The maximum number of items to return in the response. A maximum of 1000 results will be returned. Default value: 1000 .
  • timeout (int) – The maximum time that the server can spend processing the request, in seconds. The default is 30 seconds. Default value: 30 .
  • client_request_id (str) – The caller-generated request identity, in the form of a GUID with no decoration such as curly braces, e.g. 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0.
  • return_client_request_id (bool) – Whether the server should return the client-request-id in the response. Default value: False .
  • ocp_date (datetime) – The time the request was issued. Client libraries typically set this to the current system clock time; set it explicitly if you are calling the REST API directly.
class azure.batch.models.JobGetAllLifetimeStatisticsOptions(timeout=30, client_request_id=None, return_client_request_id=False, ocp_date=None)[source]

Bases: msrest.serialization.Model

Additional parameters for the Job_get_all_lifetime_statistics operation.

Parameters:
  • timeout (int) – The maximum time that the server can spend processing the request, in seconds. The default is 30 seconds. Default value: 30 .
  • client_request_id (str) – The caller-generated request identity, in the form of a GUID with no decoration such as curly braces, e.g. 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0.
  • return_client_request_id (bool) – Whether the server should return the client-request-id in the response. Default value: False .
  • ocp_date (datetime) – The time the request was issued. Client libraries typically set this to the current system clock time; set it explicitly if you are calling the REST API directly.
class azure.batch.models.JobDeleteOptions(timeout=30, client_request_id=None, return_client_request_id=False, ocp_date=None, if_match=None, if_none_match=None, if_modified_since=None, if_unmodified_since=None)[source]

Bases: msrest.serialization.Model

Additional parameters for the Job_delete operation.

Parameters:
  • timeout (int) – The maximum time that the server can spend processing the request, in seconds. The default is 30 seconds. Default value: 30 .
  • client_request_id (str) – The caller-generated request identity, in the form of a GUID with no decoration such as curly braces, e.g. 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0.
  • return_client_request_id (bool) – Whether the server should return the client-request-id in the response. Default value: False .
  • ocp_date (datetime) – The time the request was issued. Client libraries typically set this to the current system clock time; set it explicitly if you are calling the REST API directly.
  • if_match (str) – An ETag value associated with the version of the resource known to the client. The operation will be performed only if the resource’s current ETag on the service exactly matches the value specified by the client.
  • if_none_match (str) – An ETag value associated with the version of the resource known to the client. The operation will be performed only if the resource’s current ETag on the service does not match the value specified by the client.
  • if_modified_since (datetime) – A timestamp indicating the last modified time of the resource known to the client. The operation will be performed only if the resource on the service has been modified since the specified time.
  • if_unmodified_since (datetime) – A timestamp indicating the last modified time of the resource known to the client. The operation will be performed only if the resource on the service has not been modified since the specified time.
class azure.batch.models.JobGetOptions(select=None, expand=None, timeout=30, client_request_id=None, return_client_request_id=False, ocp_date=None, if_match=None, if_none_match=None, if_modified_since=None, if_unmodified_since=None)[source]

Bases: msrest.serialization.Model

Additional parameters for the Job_get operation.

Parameters:
  • select (str) – An OData $select clause.
  • expand (str) – An OData $expand clause.
  • timeout (int) – The maximum time that the server can spend processing the request, in seconds. The default is 30 seconds. Default value: 30 .
  • client_request_id (str) – The caller-generated request identity, in the form of a GUID with no decoration such as curly braces, e.g. 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0.
  • return_client_request_id (bool) – Whether the server should return the client-request-id in the response. Default value: False .
  • ocp_date (datetime) – The time the request was issued. Client libraries typically set this to the current system clock time; set it explicitly if you are calling the REST API directly.
  • if_match (str) – An ETag value associated with the version of the resource known to the client. The operation will be performed only if the resource’s current ETag on the service exactly matches the value specified by the client.
  • if_none_match (str) – An ETag value associated with the version of the resource known to the client. The operation will be performed only if the resource’s current ETag on the service does not match the value specified by the client.
  • if_modified_since (datetime) – A timestamp indicating the last modified time of the resource known to the client. The operation will be performed only if the resource on the service has been modified since the specified time.
  • if_unmodified_since (datetime) – A timestamp indicating the last modified time of the resource known to the client. The operation will be performed only if the resource on the service has not been modified since the specified time.
class azure.batch.models.JobPatchOptions(timeout=30, client_request_id=None, return_client_request_id=False, ocp_date=None, if_match=None, if_none_match=None, if_modified_since=None, if_unmodified_since=None)[source]

Bases: msrest.serialization.Model

Additional parameters for the Job_patch operation.

Parameters:
  • timeout (int) – The maximum time that the server can spend processing the request, in seconds. The default is 30 seconds. Default value: 30 .
  • client_request_id (str) – The caller-generated request identity, in the form of a GUID with no decoration such as curly braces, e.g. 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0.
  • return_client_request_id (bool) – Whether the server should return the client-request-id in the response. Default value: False .
  • ocp_date (datetime) – The time the request was issued. Client libraries typically set this to the current system clock time; set it explicitly if you are calling the REST API directly.
  • if_match (str) – An ETag value associated with the version of the resource known to the client. The operation will be performed only if the resource’s current ETag on the service exactly matches the value specified by the client.
  • if_none_match (str) – An ETag value associated with the version of the resource known to the client. The operation will be performed only if the resource’s current ETag on the service does not match the value specified by the client.
  • if_modified_since (datetime) – A timestamp indicating the last modified time of the resource known to the client. The operation will be performed only if the resource on the service has been modified since the specified time.
  • if_unmodified_since (datetime) – A timestamp indicating the last modified time of the resource known to the client. The operation will be performed only if the resource on the service has not been modified since the specified time.
class azure.batch.models.JobUpdateOptions(timeout=30, client_request_id=None, return_client_request_id=False, ocp_date=None, if_match=None, if_none_match=None, if_modified_since=None, if_unmodified_since=None)[source]

Bases: msrest.serialization.Model

Additional parameters for the Job_update operation.

Parameters:
  • timeout (int) – The maximum time that the server can spend processing the request, in seconds. The default is 30 seconds. Default value: 30 .
  • client_request_id (str) – The caller-generated request identity, in the form of a GUID with no decoration such as curly braces, e.g. 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0.
  • return_client_request_id (bool) – Whether the server should return the client-request-id in the response. Default value: False .
  • ocp_date (datetime) – The time the request was issued. Client libraries typically set this to the current system clock time; set it explicitly if you are calling the REST API directly.
  • if_match (str) – An ETag value associated with the version of the resource known to the client. The operation will be performed only if the resource’s current ETag on the service exactly matches the value specified by the client.
  • if_none_match (str) – An ETag value associated with the version of the resource known to the client. The operation will be performed only if the resource’s current ETag on the service does not match the value specified by the client.
  • if_modified_since (datetime) – A timestamp indicating the last modified time of the resource known to the client. The operation will be performed only if the resource on the service has been modified since the specified time.
  • if_unmodified_since (datetime) – A timestamp indicating the last modified time of the resource known to the client. The operation will be performed only if the resource on the service has not been modified since the specified time.
class azure.batch.models.JobDisableOptions(timeout=30, client_request_id=None, return_client_request_id=False, ocp_date=None, if_match=None, if_none_match=None, if_modified_since=None, if_unmodified_since=None)[source]

Bases: msrest.serialization.Model

Additional parameters for the Job_disable operation.

Parameters:
  • timeout (int) – The maximum time that the server can spend processing the request, in seconds. The default is 30 seconds. Default value: 30 .
  • client_request_id (str) – The caller-generated request identity, in the form of a GUID with no decoration such as curly braces, e.g. 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0.
  • return_client_request_id (bool) – Whether the server should return the client-request-id in the response. Default value: False .
  • ocp_date (datetime) – The time the request was issued. Client libraries typically set this to the current system clock time; set it explicitly if you are calling the REST API directly.
  • if_match (str) – An ETag value associated with the version of the resource known to the client. The operation will be performed only if the resource’s current ETag on the service exactly matches the value specified by the client.
  • if_none_match (str) – An ETag value associated with the version of the resource known to the client. The operation will be performed only if the resource’s current ETag on the service does not match the value specified by the client.
  • if_modified_since (datetime) – A timestamp indicating the last modified time of the resource known to the client. The operation will be performed only if the resource on the service has been modified since the specified time.
  • if_unmodified_since (datetime) – A timestamp indicating the last modified time of the resource known to the client. The operation will be performed only if the resource on the service has not been modified since the specified time.
class azure.batch.models.JobEnableOptions(timeout=30, client_request_id=None, return_client_request_id=False, ocp_date=None, if_match=None, if_none_match=None, if_modified_since=None, if_unmodified_since=None)[source]

Bases: msrest.serialization.Model

Additional parameters for the Job_enable operation.

Parameters:
  • timeout (int) – The maximum time that the server can spend processing the request, in seconds. The default is 30 seconds. Default value: 30 .
  • client_request_id (str) – The caller-generated request identity, in the form of a GUID with no decoration such as curly braces, e.g. 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0.
  • return_client_request_id (bool) – Whether the server should return the client-request-id in the response. Default value: False .
  • ocp_date (datetime) – The time the request was issued. Client libraries typically set this to the current system clock time; set it explicitly if you are calling the REST API directly.
  • if_match (str) – An ETag value associated with the version of the resource known to the client. The operation will be performed only if the resource’s current ETag on the service exactly matches the value specified by the client.
  • if_none_match (str) – An ETag value associated with the version of the resource known to the client. The operation will be performed only if the resource’s current ETag on the service does not match the value specified by the client.
  • if_modified_since (datetime) – A timestamp indicating the last modified time of the resource known to the client. The operation will be performed only if the resource on the service has been modified since the specified time.
  • if_unmodified_since (datetime) – A timestamp indicating the last modified time of the resource known to the client. The operation will be performed only if the resource on the service has not been modified since the specified time.
class azure.batch.models.JobTerminateOptions(timeout=30, client_request_id=None, return_client_request_id=False, ocp_date=None, if_match=None, if_none_match=None, if_modified_since=None, if_unmodified_since=None)[source]

Bases: msrest.serialization.Model

Additional parameters for the Job_terminate operation.

Parameters:
  • timeout (int) – The maximum time that the server can spend processing the request, in seconds. The default is 30 seconds. Default value: 30 .
  • client_request_id (str) – The caller-generated request identity, in the form of a GUID with no decoration such as curly braces, e.g. 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0.
  • return_client_request_id (bool) – Whether the server should return the client-request-id in the response. Default value: False .
  • ocp_date (datetime) – The time the request was issued. Client libraries typically set this to the current system clock time; set it explicitly if you are calling the REST API directly.
  • if_match (str) – An ETag value associated with the version of the resource known to the client. The operation will be performed only if the resource’s current ETag on the service exactly matches the value specified by the client.
  • if_none_match (str) – An ETag value associated with the version of the resource known to the client. The operation will be performed only if the resource’s current ETag on the service does not match the value specified by the client.
  • if_modified_since (datetime) – A timestamp indicating the last modified time of the resource known to the client. The operation will be performed only if the resource on the service has been modified since the specified time.
  • if_unmodified_since (datetime) – A timestamp indicating the last modified time of the resource known to the client. The operation will be performed only if the resource on the service has not been modified since the specified time.
class azure.batch.models.JobAddOptions(timeout=30, client_request_id=None, return_client_request_id=False, ocp_date=None)[source]

Bases: msrest.serialization.Model

Additional parameters for the Job_add operation.

Parameters:
  • timeout (int) – The maximum time that the server can spend processing the request, in seconds. The default is 30 seconds. Default value: 30 .
  • client_request_id (str) – The caller-generated request identity, in the form of a GUID with no decoration such as curly braces, e.g. 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0.
  • return_client_request_id (bool) – Whether the server should return the client-request-id in the response. Default value: False .
  • ocp_date (datetime) – The time the request was issued. Client libraries typically set this to the current system clock time; set it explicitly if you are calling the REST API directly.
class azure.batch.models.JobListOptions(filter=None, select=None, expand=None, max_results=1000, timeout=30, client_request_id=None, return_client_request_id=False, ocp_date=None)[source]

Bases: msrest.serialization.Model

Additional parameters for the Job_list operation.

Parameters:
  • filter (str) – An OData $filter clause.
  • select (str) – An OData $select clause.
  • expand (str) – An OData $expand clause.
  • max_results (int) – The maximum number of items to return in the response. A maximum of 1000 jobs can be returned. Default value: 1000 .
  • timeout (int) – The maximum time that the server can spend processing the request, in seconds. The default is 30 seconds. Default value: 30 .
  • client_request_id (str) – The caller-generated request identity, in the form of a GUID with no decoration such as curly braces, e.g. 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0.
  • return_client_request_id (bool) – Whether the server should return the client-request-id in the response. Default value: False .
  • ocp_date (datetime) – The time the request was issued. Client libraries typically set this to the current system clock time; set it explicitly if you are calling the REST API directly.
class azure.batch.models.JobListFromJobScheduleOptions(filter=None, select=None, expand=None, max_results=1000, timeout=30, client_request_id=None, return_client_request_id=False, ocp_date=None)[source]

Bases: msrest.serialization.Model

Additional parameters for the Job_list_from_job_schedule operation.

Parameters:
  • filter (str) – An OData $filter clause.
  • select (str) – An OData $select clause.
  • expand (str) – An OData $expand clause.
  • max_results (int) – The maximum number of items to return in the response. A maximum of 1000 jobs can be returned. Default value: 1000 .
  • timeout (int) – The maximum time that the server can spend processing the request, in seconds. The default is 30 seconds. Default value: 30 .
  • client_request_id (str) – The caller-generated request identity, in the form of a GUID with no decoration such as curly braces, e.g. 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0.
  • return_client_request_id (bool) – Whether the server should return the client-request-id in the response. Default value: False .
  • ocp_date (datetime) – The time the request was issued. Client libraries typically set this to the current system clock time; set it explicitly if you are calling the REST API directly.
class azure.batch.models.JobListPreparationAndReleaseTaskStatusOptions(filter=None, select=None, max_results=1000, timeout=30, client_request_id=None, return_client_request_id=False, ocp_date=None)[source]

Bases: msrest.serialization.Model

Additional parameters for the Job_list_preparation_and_release_task_status operation.

Parameters:
  • filter (str) – An OData $filter clause.
  • select (str) – An OData $select clause.
  • max_results (int) – The maximum number of items to return in the response. A maximum of 1000 tasks can be returned. Default value: 1000 .
  • timeout (int) – The maximum time that the server can spend processing the request, in seconds. The default is 30 seconds. Default value: 30 .
  • client_request_id (str) – The caller-generated request identity, in the form of a GUID with no decoration such as curly braces, e.g. 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0.
  • return_client_request_id (bool) – Whether the server should return the client-request-id in the response. Default value: False .
  • ocp_date (datetime) – The time the request was issued. Client libraries typically set this to the current system clock time; set it explicitly if you are calling the REST API directly.
class azure.batch.models.CertificateAddOptions(timeout=30, client_request_id=None, return_client_request_id=False, ocp_date=None)[source]

Bases: msrest.serialization.Model

Additional parameters for the Certificate_add operation.

Parameters:
  • timeout (int) – The maximum time that the server can spend processing the request, in seconds. The default is 30 seconds. Default value: 30 .
  • client_request_id (str) – The caller-generated request identity, in the form of a GUID with no decoration such as curly braces, e.g. 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0.
  • return_client_request_id (bool) – Whether the server should return the client-request-id in the response. Default value: False .
  • ocp_date (datetime) – The time the request was issued. Client libraries typically set this to the current system clock time; set it explicitly if you are calling the REST API directly.
class azure.batch.models.CertificateListOptions(filter=None, select=None, max_results=1000, timeout=30, client_request_id=None, return_client_request_id=False, ocp_date=None)[source]

Bases: msrest.serialization.Model

Additional parameters for the Certificate_list operation.

Parameters:
  • filter (str) – An OData $filter clause.
  • select (str) – An OData $select clause.
  • max_results (int) – The maximum number of items to return in the response. A maximum of 1000 certificates can be returned. Default value: 1000 .
  • timeout (int) – The maximum time that the server can spend processing the request, in seconds. The default is 30 seconds. Default value: 30 .
  • client_request_id (str) – The caller-generated request identity, in the form of a GUID with no decoration such as curly braces, e.g. 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0.
  • return_client_request_id (bool) – Whether the server should return the client-request-id in the response. Default value: False .
  • ocp_date (datetime) – The time the request was issued. Client libraries typically set this to the current system clock time; set it explicitly if you are calling the REST API directly.
class azure.batch.models.CertificateCancelDeletionOptions(timeout=30, client_request_id=None, return_client_request_id=False, ocp_date=None)[source]

Bases: msrest.serialization.Model

Additional parameters for the Certificate_cancel_deletion operation.

Parameters:
  • timeout (int) – The maximum time that the server can spend processing the request, in seconds. The default is 30 seconds. Default value: 30 .
  • client_request_id (str) – The caller-generated request identity, in the form of a GUID with no decoration such as curly braces, e.g. 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0.
  • return_client_request_id (bool) – Whether the server should return the client-request-id in the response. Default value: False .
  • ocp_date (datetime) – The time the request was issued. Client libraries typically set this to the current system clock time; set it explicitly if you are calling the REST API directly.
class azure.batch.models.CertificateDeleteOptions(timeout=30, client_request_id=None, return_client_request_id=False, ocp_date=None)[source]

Bases: msrest.serialization.Model

Additional parameters for the Certificate_delete operation.

Parameters:
  • timeout (int) – The maximum time that the server can spend processing the request, in seconds. The default is 30 seconds. Default value: 30 .
  • client_request_id (str) – The caller-generated request identity, in the form of a GUID with no decoration such as curly braces, e.g. 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0.
  • return_client_request_id (bool) – Whether the server should return the client-request-id in the response. Default value: False .
  • ocp_date (datetime) – The time the request was issued. Client libraries typically set this to the current system clock time; set it explicitly if you are calling the REST API directly.
class azure.batch.models.CertificateGetOptions(select=None, timeout=30, client_request_id=None, return_client_request_id=False, ocp_date=None)[source]

Bases: msrest.serialization.Model

Additional parameters for the Certificate_get operation.

Parameters:
  • select (str) – An OData $select clause.
  • timeout (int) – The maximum time that the server can spend processing the request, in seconds. The default is 30 seconds. Default value: 30 .
  • client_request_id (str) – The caller-generated request identity, in the form of a GUID with no decoration such as curly braces, e.g. 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0.
  • return_client_request_id (bool) – Whether the server should return the client-request-id in the response. Default value: False .
  • ocp_date (datetime) – The time the request was issued. Client libraries typically set this to the current system clock time; set it explicitly if you are calling the REST API directly.
class azure.batch.models.FileDeleteFromTaskOptions(timeout=30, client_request_id=None, return_client_request_id=False, ocp_date=None)[source]

Bases: msrest.serialization.Model

Additional parameters for the File_delete_from_task operation.

Parameters:
  • timeout (int) – The maximum time that the server can spend processing the request, in seconds. The default is 30 seconds. Default value: 30 .
  • client_request_id (str) – The caller-generated request identity, in the form of a GUID with no decoration such as curly braces, e.g. 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0.
  • return_client_request_id (bool) – Whether the server should return the client-request-id in the response. Default value: False .
  • ocp_date (datetime) – The time the request was issued. Client libraries typically set this to the current system clock time; set it explicitly if you are calling the REST API directly.
class azure.batch.models.FileGetFromTaskOptions(timeout=30, client_request_id=None, return_client_request_id=False, ocp_date=None, ocp_range=None, if_modified_since=None, if_unmodified_since=None)[source]

Bases: msrest.serialization.Model

Additional parameters for the File_get_from_task operation.

Parameters:
  • timeout (int) – The maximum time that the server can spend processing the request, in seconds. The default is 30 seconds. Default value: 30 .
  • client_request_id (str) – The caller-generated request identity, in the form of a GUID with no decoration such as curly braces, e.g. 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0.
  • return_client_request_id (bool) – Whether the server should return the client-request-id in the response. Default value: False .
  • ocp_date (datetime) – The time the request was issued. Client libraries typically set this to the current system clock time; set it explicitly if you are calling the REST API directly.
  • ocp_range (str) – The byte range to be retrieved. The default is to retrieve the entire file. The format is bytes=startRange-endRange.
  • if_modified_since (datetime) – A timestamp indicating the last modified time of the resource known to the client. The operation will be performed only if the resource on the service has been modified since the specified time.
  • if_unmodified_since (datetime) – A timestamp indicating the last modified time of the resource known to the client. The operation will be performed only if the resource on the service has not been modified since the specified time.
class azure.batch.models.FileGetPropertiesFromTaskOptions(timeout=30, client_request_id=None, return_client_request_id=False, ocp_date=None, if_modified_since=None, if_unmodified_since=None)[source]

Bases: msrest.serialization.Model

Additional parameters for the File_get_properties_from_task operation.

Parameters:
  • timeout (int) – The maximum time that the server can spend processing the request, in seconds. The default is 30 seconds. Default value: 30 .
  • client_request_id (str) – The caller-generated request identity, in the form of a GUID with no decoration such as curly braces, e.g. 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0.
  • return_client_request_id (bool) – Whether the server should return the client-request-id in the response. Default value: False .
  • ocp_date (datetime) – The time the request was issued. Client libraries typically set this to the current system clock time; set it explicitly if you are calling the REST API directly.
  • if_modified_since (datetime) – A timestamp indicating the last modified time of the resource known to the client. The operation will be performed only if the resource on the service has been modified since the specified time.
  • if_unmodified_since (datetime) – A timestamp indicating the last modified time of the resource known to the client. The operation will be performed only if the resource on the service has not been modified since the specified time.
class azure.batch.models.FileDeleteFromComputeNodeOptions(timeout=30, client_request_id=None, return_client_request_id=False, ocp_date=None)[source]

Bases: msrest.serialization.Model

Additional parameters for the File_delete_from_compute_node operation.

Parameters:
  • timeout (int) – The maximum time that the server can spend processing the request, in seconds. The default is 30 seconds. Default value: 30 .
  • client_request_id (str) – The caller-generated request identity, in the form of a GUID with no decoration such as curly braces, e.g. 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0.
  • return_client_request_id (bool) – Whether the server should return the client-request-id in the response. Default value: False .
  • ocp_date (datetime) – The time the request was issued. Client libraries typically set this to the current system clock time; set it explicitly if you are calling the REST API directly.
class azure.batch.models.FileGetFromComputeNodeOptions(timeout=30, client_request_id=None, return_client_request_id=False, ocp_date=None, ocp_range=None, if_modified_since=None, if_unmodified_since=None)[source]

Bases: msrest.serialization.Model

Additional parameters for the File_get_from_compute_node operation.

Parameters:
  • timeout (int) – The maximum time that the server can spend processing the request, in seconds. The default is 30 seconds. Default value: 30 .
  • client_request_id (str) – The caller-generated request identity, in the form of a GUID with no decoration such as curly braces, e.g. 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0.
  • return_client_request_id (bool) – Whether the server should return the client-request-id in the response. Default value: False .
  • ocp_date (datetime) – The time the request was issued. Client libraries typically set this to the current system clock time; set it explicitly if you are calling the REST API directly.
  • ocp_range (str) – The byte range to be retrieved. The default is to retrieve the entire file. The format is bytes=startRange-endRange.
  • if_modified_since (datetime) – A timestamp indicating the last modified time of the resource known to the client. The operation will be performed only if the resource on the service has been modified since the specified time.
  • if_unmodified_since (datetime) – A timestamp indicating the last modified time of the resource known to the client. The operation will be performed only if the resource on the service has not been modified since the specified time.
class azure.batch.models.FileGetPropertiesFromComputeNodeOptions(timeout=30, client_request_id=None, return_client_request_id=False, ocp_date=None, if_modified_since=None, if_unmodified_since=None)[source]

Bases: msrest.serialization.Model

Additional parameters for the File_get_properties_from_compute_node operation.

Parameters:
  • timeout (int) – The maximum time that the server can spend processing the request, in seconds. The default is 30 seconds. Default value: 30 .
  • client_request_id (str) – The caller-generated request identity, in the form of a GUID with no decoration such as curly braces, e.g. 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0.
  • return_client_request_id (bool) – Whether the server should return the client-request-id in the response. Default value: False .
  • ocp_date (datetime) – The time the request was issued. Client libraries typically set this to the current system clock time; set it explicitly if you are calling the REST API directly.
  • if_modified_since (datetime) – A timestamp indicating the last modified time of the resource known to the client. The operation will be performed only if the resource on the service has been modified since the specified time.
  • if_unmodified_since (datetime) – A timestamp indicating the last modified time of the resource known to the client. The operation will be performed only if the resource on the service has not been modified since the specified time.
class azure.batch.models.FileListFromTaskOptions(filter=None, max_results=1000, timeout=30, client_request_id=None, return_client_request_id=False, ocp_date=None)[source]

Bases: msrest.serialization.Model

Additional parameters for the File_list_from_task operation.

Parameters:
  • filter (str) – An OData $filter clause.
  • max_results (int) – The maximum number of items to return in the response. A maximum of 1000 files can be returned. Default value: 1000 .
  • timeout (int) – The maximum time that the server can spend processing the request, in seconds. The default is 30 seconds. Default value: 30 .
  • client_request_id (str) – The caller-generated request identity, in the form of a GUID with no decoration such as curly braces, e.g. 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0.
  • return_client_request_id (bool) – Whether the server should return the client-request-id in the response. Default value: False .
  • ocp_date (datetime) – The time the request was issued. Client libraries typically set this to the current system clock time; set it explicitly if you are calling the REST API directly.
class azure.batch.models.FileListFromComputeNodeOptions(filter=None, max_results=1000, timeout=30, client_request_id=None, return_client_request_id=False, ocp_date=None)[source]

Bases: msrest.serialization.Model

Additional parameters for the File_list_from_compute_node operation.

Parameters:
  • filter (str) – An OData $filter clause.
  • max_results (int) – The maximum number of items to return in the response. A maximum of 1000 files can be returned. Default value: 1000 .
  • timeout (int) – The maximum time that the server can spend processing the request, in seconds. The default is 30 seconds. Default value: 30 .
  • client_request_id (str) – The caller-generated request identity, in the form of a GUID with no decoration such as curly braces, e.g. 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0.
  • return_client_request_id (bool) – Whether the server should return the client-request-id in the response. Default value: False .
  • ocp_date (datetime) – The time the request was issued. Client libraries typically set this to the current system clock time; set it explicitly if you are calling the REST API directly.
class azure.batch.models.JobScheduleExistsOptions(timeout=30, client_request_id=None, return_client_request_id=False, ocp_date=None, if_match=None, if_none_match=None, if_modified_since=None, if_unmodified_since=None)[source]

Bases: msrest.serialization.Model

Additional parameters for the JobSchedule_exists operation.

Parameters:
  • timeout (int) – The maximum time that the server can spend processing the request, in seconds. The default is 30 seconds. Default value: 30 .
  • client_request_id (str) – The caller-generated request identity, in the form of a GUID with no decoration such as curly braces, e.g. 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0.
  • return_client_request_id (bool) – Whether the server should return the client-request-id in the response. Default value: False .
  • ocp_date (datetime) – The time the request was issued. Client libraries typically set this to the current system clock time; set it explicitly if you are calling the REST API directly.
  • if_match (str) – An ETag value associated with the version of the resource known to the client. The operation will be performed only if the resource’s current ETag on the service exactly matches the value specified by the client.
  • if_none_match (str) – An ETag value associated with the version of the resource known to the client. The operation will be performed only if the resource’s current ETag on the service does not match the value specified by the client.
  • if_modified_since (datetime) – A timestamp indicating the last modified time of the resource known to the client. The operation will be performed only if the resource on the service has been modified since the specified time.
  • if_unmodified_since (datetime) – A timestamp indicating the last modified time of the resource known to the client. The operation will be performed only if the resource on the service has not been modified since the specified time.
class azure.batch.models.JobScheduleDeleteOptions(timeout=30, client_request_id=None, return_client_request_id=False, ocp_date=None, if_match=None, if_none_match=None, if_modified_since=None, if_unmodified_since=None)[source]

Bases: msrest.serialization.Model

Additional parameters for the JobSchedule_delete operation.

Parameters:
  • timeout (int) – The maximum time that the server can spend processing the request, in seconds. The default is 30 seconds. Default value: 30 .
  • client_request_id (str) – The caller-generated request identity, in the form of a GUID with no decoration such as curly braces, e.g. 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0.
  • return_client_request_id (bool) – Whether the server should return the client-request-id in the response. Default value: False .
  • ocp_date (datetime) – The time the request was issued. Client libraries typically set this to the current system clock time; set it explicitly if you are calling the REST API directly.
  • if_match (str) – An ETag value associated with the version of the resource known to the client. The operation will be performed only if the resource’s current ETag on the service exactly matches the value specified by the client.
  • if_none_match (str) – An ETag value associated with the version of the resource known to the client. The operation will be performed only if the resource’s current ETag on the service does not match the value specified by the client.
  • if_modified_since (datetime) – A timestamp indicating the last modified time of the resource known to the client. The operation will be performed only if the resource on the service has been modified since the specified time.
  • if_unmodified_since (datetime) – A timestamp indicating the last modified time of the resource known to the client. The operation will be performed only if the resource on the service has not been modified since the specified time.
class azure.batch.models.JobScheduleGetOptions(select=None, expand=None, timeout=30, client_request_id=None, return_client_request_id=False, ocp_date=None, if_match=None, if_none_match=None, if_modified_since=None, if_unmodified_since=None)[source]

Bases: msrest.serialization.Model

Additional parameters for the JobSchedule_get operation.

Parameters:
  • select (str) – An OData $select clause.
  • expand (str) – An OData $expand clause.
  • timeout (int) – The maximum time that the server can spend processing the request, in seconds. The default is 30 seconds. Default value: 30 .
  • client_request_id (str) – The caller-generated request identity, in the form of a GUID with no decoration such as curly braces, e.g. 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0.
  • return_client_request_id (bool) – Whether the server should return the client-request-id in the response. Default value: False .
  • ocp_date (datetime) – The time the request was issued. Client libraries typically set this to the current system clock time; set it explicitly if you are calling the REST API directly.
  • if_match (str) – An ETag value associated with the version of the resource known to the client. The operation will be performed only if the resource’s current ETag on the service exactly matches the value specified by the client.
  • if_none_match (str) – An ETag value associated with the version of the resource known to the client. The operation will be performed only if the resource’s current ETag on the service does not match the value specified by the client.
  • if_modified_since (datetime) – A timestamp indicating the last modified time of the resource known to the client. The operation will be performed only if the resource on the service has been modified since the specified time.
  • if_unmodified_since (datetime) – A timestamp indicating the last modified time of the resource known to the client. The operation will be performed only if the resource on the service has not been modified since the specified time.
class azure.batch.models.JobSchedulePatchOptions(timeout=30, client_request_id=None, return_client_request_id=False, ocp_date=None, if_match=None, if_none_match=None, if_modified_since=None, if_unmodified_since=None)[source]

Bases: msrest.serialization.Model

Additional parameters for the JobSchedule_patch operation.

Parameters:
  • timeout (int) – The maximum time that the server can spend processing the request, in seconds. The default is 30 seconds. Default value: 30 .
  • client_request_id (str) – The caller-generated request identity, in the form of a GUID with no decoration such as curly braces, e.g. 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0.
  • return_client_request_id (bool) – Whether the server should return the client-request-id in the response. Default value: False .
  • ocp_date (datetime) – The time the request was issued. Client libraries typically set this to the current system clock time; set it explicitly if you are calling the REST API directly.
  • if_match (str) – An ETag value associated with the version of the resource known to the client. The operation will be performed only if the resource’s current ETag on the service exactly matches the value specified by the client.
  • if_none_match (str) – An ETag value associated with the version of the resource known to the client. The operation will be performed only if the resource’s current ETag on the service does not match the value specified by the client.
  • if_modified_since (datetime) – A timestamp indicating the last modified time of the resource known to the client. The operation will be performed only if the resource on the service has been modified since the specified time.
  • if_unmodified_since (datetime) – A timestamp indicating the last modified time of the resource known to the client. The operation will be performed only if the resource on the service has not been modified since the specified time.
class azure.batch.models.JobScheduleUpdateOptions(timeout=30, client_request_id=None, return_client_request_id=False, ocp_date=None, if_match=None, if_none_match=None, if_modified_since=None, if_unmodified_since=None)[source]

Bases: msrest.serialization.Model

Additional parameters for the JobSchedule_update operation.

Parameters:
  • timeout (int) – The maximum time that the server can spend processing the request, in seconds. The default is 30 seconds. Default value: 30 .
  • client_request_id (str) – The caller-generated request identity, in the form of a GUID with no decoration such as curly braces, e.g. 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0.
  • return_client_request_id (bool) – Whether the server should return the client-request-id in the response. Default value: False .
  • ocp_date (datetime) – The time the request was issued. Client libraries typically set this to the current system clock time; set it explicitly if you are calling the REST API directly.
  • if_match (str) – An ETag value associated with the version of the resource known to the client. The operation will be performed only if the resource’s current ETag on the service exactly matches the value specified by the client.
  • if_none_match (str) – An ETag value associated with the version of the resource known to the client. The operation will be performed only if the resource’s current ETag on the service does not match the value specified by the client.
  • if_modified_since (datetime) – A timestamp indicating the last modified time of the resource known to the client. The operation will be performed only if the resource on the service has been modified since the specified time.
  • if_unmodified_since (datetime) – A timestamp indicating the last modified time of the resource known to the client. The operation will be performed only if the resource on the service has not been modified since the specified time.
class azure.batch.models.JobScheduleDisableOptions(timeout=30, client_request_id=None, return_client_request_id=False, ocp_date=None, if_match=None, if_none_match=None, if_modified_since=None, if_unmodified_since=None)[source]

Bases: msrest.serialization.Model

Additional parameters for the JobSchedule_disable operation.

Parameters:
  • timeout (int) – The maximum time that the server can spend processing the request, in seconds. The default is 30 seconds. Default value: 30 .
  • client_request_id (str) – The caller-generated request identity, in the form of a GUID with no decoration such as curly braces, e.g. 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0.
  • return_client_request_id (bool) – Whether the server should return the client-request-id in the response. Default value: False .
  • ocp_date (datetime) – The time the request was issued. Client libraries typically set this to the current system clock time; set it explicitly if you are calling the REST API directly.
  • if_match (str) – An ETag value associated with the version of the resource known to the client. The operation will be performed only if the resource’s current ETag on the service exactly matches the value specified by the client.
  • if_none_match (str) – An ETag value associated with the version of the resource known to the client. The operation will be performed only if the resource’s current ETag on the service does not match the value specified by the client.
  • if_modified_since (datetime) – A timestamp indicating the last modified time of the resource known to the client. The operation will be performed only if the resource on the service has been modified since the specified time.
  • if_unmodified_since (datetime) – A timestamp indicating the last modified time of the resource known to the client. The operation will be performed only if the resource on the service has not been modified since the specified time.
class azure.batch.models.JobScheduleEnableOptions(timeout=30, client_request_id=None, return_client_request_id=False, ocp_date=None, if_match=None, if_none_match=None, if_modified_since=None, if_unmodified_since=None)[source]

Bases: msrest.serialization.Model

Additional parameters for the JobSchedule_enable operation.

Parameters:
  • timeout (int) – The maximum time that the server can spend processing the request, in seconds. The default is 30 seconds. Default value: 30 .
  • client_request_id (str) – The caller-generated request identity, in the form of a GUID with no decoration such as curly braces, e.g. 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0.
  • return_client_request_id (bool) – Whether the server should return the client-request-id in the response. Default value: False .
  • ocp_date (datetime) – The time the request was issued. Client libraries typically set this to the current system clock time; set it explicitly if you are calling the REST API directly.
  • if_match (str) – An ETag value associated with the version of the resource known to the client. The operation will be performed only if the resource’s current ETag on the service exactly matches the value specified by the client.
  • if_none_match (str) – An ETag value associated with the version of the resource known to the client. The operation will be performed only if the resource’s current ETag on the service does not match the value specified by the client.
  • if_modified_since (datetime) – A timestamp indicating the last modified time of the resource known to the client. The operation will be performed only if the resource on the service has been modified since the specified time.
  • if_unmodified_since (datetime) – A timestamp indicating the last modified time of the resource known to the client. The operation will be performed only if the resource on the service has not been modified since the specified time.
class azure.batch.models.JobScheduleTerminateOptions(timeout=30, client_request_id=None, return_client_request_id=False, ocp_date=None, if_match=None, if_none_match=None, if_modified_since=None, if_unmodified_since=None)[source]

Bases: msrest.serialization.Model

Additional parameters for the JobSchedule_terminate operation.

Parameters:
  • timeout (int) – The maximum time that the server can spend processing the request, in seconds. The default is 30 seconds. Default value: 30 .
  • client_request_id (str) – The caller-generated request identity, in the form of a GUID with no decoration such as curly braces, e.g. 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0.
  • return_client_request_id (bool) – Whether the server should return the client-request-id in the response. Default value: False .
  • ocp_date (datetime) – The time the request was issued. Client libraries typically set this to the current system clock time; set it explicitly if you are calling the REST API directly.
  • if_match (str) – An ETag value associated with the version of the resource known to the client. The operation will be performed only if the resource’s current ETag on the service exactly matches the value specified by the client.
  • if_none_match (str) – An ETag value associated with the version of the resource known to the client. The operation will be performed only if the resource’s current ETag on the service does not match the value specified by the client.
  • if_modified_since (datetime) – A timestamp indicating the last modified time of the resource known to the client. The operation will be performed only if the resource on the service has been modified since the specified time.
  • if_unmodified_since (datetime) – A timestamp indicating the last modified time of the resource known to the client. The operation will be performed only if the resource on the service has not been modified since the specified time.
class azure.batch.models.JobScheduleAddOptions(timeout=30, client_request_id=None, return_client_request_id=False, ocp_date=None)[source]

Bases: msrest.serialization.Model

Additional parameters for the JobSchedule_add operation.

Parameters:
  • timeout (int) – The maximum time that the server can spend processing the request, in seconds. The default is 30 seconds. Default value: 30 .
  • client_request_id (str) – The caller-generated request identity, in the form of a GUID with no decoration such as curly braces, e.g. 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0.
  • return_client_request_id (bool) – Whether the server should return the client-request-id in the response. Default value: False .
  • ocp_date (datetime) – The time the request was issued. Client libraries typically set this to the current system clock time; set it explicitly if you are calling the REST API directly.
class azure.batch.models.JobScheduleListOptions(filter=None, select=None, expand=None, max_results=1000, timeout=30, client_request_id=None, return_client_request_id=False, ocp_date=None)[source]

Bases: msrest.serialization.Model

Additional parameters for the JobSchedule_list operation.

Parameters:
  • filter (str) – An OData $filter clause.
  • select (str) – An OData $select clause.
  • expand (str) – An OData $expand clause.
  • max_results (int) – The maximum number of items to return in the response. A maximum of 1000 job schedules can be returned. Default value: 1000 .
  • timeout (int) – The maximum time that the server can spend processing the request, in seconds. The default is 30 seconds. Default value: 30 .
  • client_request_id (str) – The caller-generated request identity, in the form of a GUID with no decoration such as curly braces, e.g. 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0.
  • return_client_request_id (bool) – Whether the server should return the client-request-id in the response. Default value: False .
  • ocp_date (datetime) – The time the request was issued. Client libraries typically set this to the current system clock time; set it explicitly if you are calling the REST API directly.
class azure.batch.models.TaskAddOptions(timeout=30, client_request_id=None, return_client_request_id=False, ocp_date=None)[source]

Bases: msrest.serialization.Model

Additional parameters for the Task_add operation.

Parameters:
  • timeout (int) – The maximum time that the server can spend processing the request, in seconds. The default is 30 seconds. Default value: 30 .
  • client_request_id (str) – The caller-generated request identity, in the form of a GUID with no decoration such as curly braces, e.g. 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0.
  • return_client_request_id (bool) – Whether the server should return the client-request-id in the response. Default value: False .
  • ocp_date (datetime) – The time the request was issued. Client libraries typically set this to the current system clock time; set it explicitly if you are calling the REST API directly.
class azure.batch.models.TaskListOptions(filter=None, select=None, expand=None, max_results=1000, timeout=30, client_request_id=None, return_client_request_id=False, ocp_date=None)[source]

Bases: msrest.serialization.Model

Additional parameters for the Task_list operation.

Parameters:
  • filter (str) – An OData $filter clause.
  • select (str) – An OData $select clause.
  • expand (str) – An OData $expand clause.
  • max_results (int) – The maximum number of items to return in the response. A maximum of 1000 tasks can be returned. Default value: 1000 .
  • timeout (int) – The maximum time that the server can spend processing the request, in seconds. The default is 30 seconds. Default value: 30 .
  • client_request_id (str) – The caller-generated request identity, in the form of a GUID with no decoration such as curly braces, e.g. 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0.
  • return_client_request_id (bool) – Whether the server should return the client-request-id in the response. Default value: False .
  • ocp_date (datetime) – The time the request was issued. Client libraries typically set this to the current system clock time; set it explicitly if you are calling the REST API directly.
class azure.batch.models.TaskAddCollectionOptions(timeout=30, client_request_id=None, return_client_request_id=False, ocp_date=None)[source]

Bases: msrest.serialization.Model

Additional parameters for the Task_add_collection operation.

Parameters:
  • timeout (int) – The maximum time that the server can spend processing the request, in seconds. The default is 30 seconds. Default value: 30 .
  • client_request_id (str) – The caller-generated request identity, in the form of a GUID with no decoration such as curly braces, e.g. 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0.
  • return_client_request_id (bool) – Whether the server should return the client-request-id in the response. Default value: False .
  • ocp_date (datetime) – The time the request was issued. Client libraries typically set this to the current system clock time; set it explicitly if you are calling the REST API directly.
class azure.batch.models.TaskDeleteOptions(timeout=30, client_request_id=None, return_client_request_id=False, ocp_date=None, if_match=None, if_none_match=None, if_modified_since=None, if_unmodified_since=None)[source]

Bases: msrest.serialization.Model

Additional parameters for the Task_delete operation.

Parameters:
  • timeout (int) – The maximum time that the server can spend processing the request, in seconds. The default is 30 seconds. Default value: 30 .
  • client_request_id (str) – The caller-generated request identity, in the form of a GUID with no decoration such as curly braces, e.g. 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0.
  • return_client_request_id (bool) – Whether the server should return the client-request-id in the response. Default value: False .
  • ocp_date (datetime) – The time the request was issued. Client libraries typically set this to the current system clock time; set it explicitly if you are calling the REST API directly.
  • if_match (str) – An ETag value associated with the version of the resource known to the client. The operation will be performed only if the resource’s current ETag on the service exactly matches the value specified by the client.
  • if_none_match (str) – An ETag value associated with the version of the resource known to the client. The operation will be performed only if the resource’s current ETag on the service does not match the value specified by the client.
  • if_modified_since (datetime) – A timestamp indicating the last modified time of the resource known to the client. The operation will be performed only if the resource on the service has been modified since the specified time.
  • if_unmodified_since (datetime) – A timestamp indicating the last modified time of the resource known to the client. The operation will be performed only if the resource on the service has not been modified since the specified time.
class azure.batch.models.TaskGetOptions(select=None, expand=None, timeout=30, client_request_id=None, return_client_request_id=False, ocp_date=None, if_match=None, if_none_match=None, if_modified_since=None, if_unmodified_since=None)[source]

Bases: msrest.serialization.Model

Additional parameters for the Task_get operation.

Parameters:
  • select (str) – An OData $select clause.
  • expand (str) – An OData $expand clause.
  • timeout (int) – The maximum time that the server can spend processing the request, in seconds. The default is 30 seconds. Default value: 30 .
  • client_request_id (str) – The caller-generated request identity, in the form of a GUID with no decoration such as curly braces, e.g. 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0.
  • return_client_request_id (bool) – Whether the server should return the client-request-id in the response. Default value: False .
  • ocp_date (datetime) – The time the request was issued. Client libraries typically set this to the current system clock time; set it explicitly if you are calling the REST API directly.
  • if_match (str) – An ETag value associated with the version of the resource known to the client. The operation will be performed only if the resource’s current ETag on the service exactly matches the value specified by the client.
  • if_none_match (str) – An ETag value associated with the version of the resource known to the client. The operation will be performed only if the resource’s current ETag on the service does not match the value specified by the client.
  • if_modified_since (datetime) – A timestamp indicating the last modified time of the resource known to the client. The operation will be performed only if the resource on the service has been modified since the specified time.
  • if_unmodified_since (datetime) – A timestamp indicating the last modified time of the resource known to the client. The operation will be performed only if the resource on the service has not been modified since the specified time.
class azure.batch.models.TaskUpdateOptions(timeout=30, client_request_id=None, return_client_request_id=False, ocp_date=None, if_match=None, if_none_match=None, if_modified_since=None, if_unmodified_since=None)[source]

Bases: msrest.serialization.Model

Additional parameters for the Task_update operation.

Parameters:
  • timeout (int) – The maximum time that the server can spend processing the request, in seconds. The default is 30 seconds. Default value: 30 .
  • client_request_id (str) – The caller-generated request identity, in the form of a GUID with no decoration such as curly braces, e.g. 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0.
  • return_client_request_id (bool) – Whether the server should return the client-request-id in the response. Default value: False .
  • ocp_date (datetime) – The time the request was issued. Client libraries typically set this to the current system clock time; set it explicitly if you are calling the REST API directly.
  • if_match (str) – An ETag value associated with the version of the resource known to the client. The operation will be performed only if the resource’s current ETag on the service exactly matches the value specified by the client.
  • if_none_match (str) – An ETag value associated with the version of the resource known to the client. The operation will be performed only if the resource’s current ETag on the service does not match the value specified by the client.
  • if_modified_since (datetime) – A timestamp indicating the last modified time of the resource known to the client. The operation will be performed only if the resource on the service has been modified since the specified time.
  • if_unmodified_since (datetime) – A timestamp indicating the last modified time of the resource known to the client. The operation will be performed only if the resource on the service has not been modified since the specified time.
class azure.batch.models.TaskListSubtasksOptions(select=None, timeout=30, client_request_id=None, return_client_request_id=False, ocp_date=None)[source]

Bases: msrest.serialization.Model

Additional parameters for the Task_list_subtasks operation.

Parameters:
  • select (str) – An OData $select clause.
  • timeout (int) – The maximum time that the server can spend processing the request, in seconds. The default is 30 seconds. Default value: 30 .
  • client_request_id (str) – The caller-generated request identity, in the form of a GUID with no decoration such as curly braces, e.g. 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0.
  • return_client_request_id (bool) – Whether the server should return the client-request-id in the response. Default value: False .
  • ocp_date (datetime) – The time the request was issued. Client libraries typically set this to the current system clock time; set it explicitly if you are calling the REST API directly.
class azure.batch.models.TaskTerminateOptions(timeout=30, client_request_id=None, return_client_request_id=False, ocp_date=None, if_match=None, if_none_match=None, if_modified_since=None, if_unmodified_since=None)[source]

Bases: msrest.serialization.Model

Additional parameters for the Task_terminate operation.

Parameters:
  • timeout (int) – The maximum time that the server can spend processing the request, in seconds. The default is 30 seconds. Default value: 30 .
  • client_request_id (str) – The caller-generated request identity, in the form of a GUID with no decoration such as curly braces, e.g. 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0.
  • return_client_request_id (bool) – Whether the server should return the client-request-id in the response. Default value: False .
  • ocp_date (datetime) – The time the request was issued. Client libraries typically set this to the current system clock time; set it explicitly if you are calling the REST API directly.
  • if_match (str) – An ETag value associated with the version of the resource known to the client. The operation will be performed only if the resource’s current ETag on the service exactly matches the value specified by the client.
  • if_none_match (str) – An ETag value associated with the version of the resource known to the client. The operation will be performed only if the resource’s current ETag on the service does not match the value specified by the client.
  • if_modified_since (datetime) – A timestamp indicating the last modified time of the resource known to the client. The operation will be performed only if the resource on the service has been modified since the specified time.
  • if_unmodified_since (datetime) – A timestamp indicating the last modified time of the resource known to the client. The operation will be performed only if the resource on the service has not been modified since the specified time.
class azure.batch.models.TaskReactivateOptions(timeout=30, client_request_id=None, return_client_request_id=False, ocp_date=None, if_match=None, if_none_match=None, if_modified_since=None, if_unmodified_since=None)[source]

Bases: msrest.serialization.Model

Additional parameters for the Task_reactivate operation.

Parameters:
  • timeout (int) – The maximum time that the server can spend processing the request, in seconds. The default is 30 seconds. Default value: 30 .
  • client_request_id (str) – The caller-generated request identity, in the form of a GUID with no decoration such as curly braces, e.g. 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0.
  • return_client_request_id (bool) – Whether the server should return the client-request-id in the response. Default value: False .
  • ocp_date (datetime) – The time the request was issued. Client libraries typically set this to the current system clock time; set it explicitly if you are calling the REST API directly.
  • if_match (str) – An ETag value associated with the version of the resource known to the client. The operation will be performed only if the resource’s current ETag on the service exactly matches the value specified by the client.
  • if_none_match (str) – An ETag value associated with the version of the resource known to the client. The operation will be performed only if the resource’s current ETag on the service does not match the value specified by the client.
  • if_modified_since (datetime) – A timestamp indicating the last modified time of the resource known to the client. The operation will be performed only if the resource on the service has been modified since the specified time.
  • if_unmodified_since (datetime) – A timestamp indicating the last modified time of the resource known to the client. The operation will be performed only if the resource on the service has not been modified since the specified time.
class azure.batch.models.ComputeNodeAddUserOptions(timeout=30, client_request_id=None, return_client_request_id=False, ocp_date=None)[source]

Bases: msrest.serialization.Model

Additional parameters for the ComputeNode_add_user operation.

Parameters:
  • timeout (int) – The maximum time that the server can spend processing the request, in seconds. The default is 30 seconds. Default value: 30 .
  • client_request_id (str) – The caller-generated request identity, in the form of a GUID with no decoration such as curly braces, e.g. 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0.
  • return_client_request_id (bool) – Whether the server should return the client-request-id in the response. Default value: False .
  • ocp_date (datetime) – The time the request was issued. Client libraries typically set this to the current system clock time; set it explicitly if you are calling the REST API directly.
class azure.batch.models.ComputeNodeDeleteUserOptions(timeout=30, client_request_id=None, return_client_request_id=False, ocp_date=None)[source]

Bases: msrest.serialization.Model

Additional parameters for the ComputeNode_delete_user operation.

Parameters:
  • timeout (int) – The maximum time that the server can spend processing the request, in seconds. The default is 30 seconds. Default value: 30 .
  • client_request_id (str) – The caller-generated request identity, in the form of a GUID with no decoration such as curly braces, e.g. 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0.
  • return_client_request_id (bool) – Whether the server should return the client-request-id in the response. Default value: False .
  • ocp_date (datetime) – The time the request was issued. Client libraries typically set this to the current system clock time; set it explicitly if you are calling the REST API directly.
class azure.batch.models.ComputeNodeUpdateUserOptions(timeout=30, client_request_id=None, return_client_request_id=False, ocp_date=None)[source]

Bases: msrest.serialization.Model

Additional parameters for the ComputeNode_update_user operation.

Parameters:
  • timeout (int) – The maximum time that the server can spend processing the request, in seconds. The default is 30 seconds. Default value: 30 .
  • client_request_id (str) – The caller-generated request identity, in the form of a GUID with no decoration such as curly braces, e.g. 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0.
  • return_client_request_id (bool) – Whether the server should return the client-request-id in the response. Default value: False .
  • ocp_date (datetime) – The time the request was issued. Client libraries typically set this to the current system clock time; set it explicitly if you are calling the REST API directly.
class azure.batch.models.ComputeNodeGetOptions(select=None, timeout=30, client_request_id=None, return_client_request_id=False, ocp_date=None)[source]

Bases: msrest.serialization.Model

Additional parameters for the ComputeNode_get operation.

Parameters:
  • select (str) – An OData $select clause.
  • timeout (int) – The maximum time that the server can spend processing the request, in seconds. The default is 30 seconds. Default value: 30 .
  • client_request_id (str) – The caller-generated request identity, in the form of a GUID with no decoration such as curly braces, e.g. 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0.
  • return_client_request_id (bool) – Whether the server should return the client-request-id in the response. Default value: False .
  • ocp_date (datetime) – The time the request was issued. Client libraries typically set this to the current system clock time; set it explicitly if you are calling the REST API directly.
class azure.batch.models.ComputeNodeRebootOptions(timeout=30, client_request_id=None, return_client_request_id=False, ocp_date=None)[source]

Bases: msrest.serialization.Model

Additional parameters for the ComputeNode_reboot operation.

Parameters:
  • timeout (int) – The maximum time that the server can spend processing the request, in seconds. The default is 30 seconds. Default value: 30 .
  • client_request_id (str) – The caller-generated request identity, in the form of a GUID with no decoration such as curly braces, e.g. 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0.
  • return_client_request_id (bool) – Whether the server should return the client-request-id in the response. Default value: False .
  • ocp_date (datetime) – The time the request was issued. Client libraries typically set this to the current system clock time; set it explicitly if you are calling the REST API directly.
class azure.batch.models.ComputeNodeReimageOptions(timeout=30, client_request_id=None, return_client_request_id=False, ocp_date=None)[source]

Bases: msrest.serialization.Model

Additional parameters for the ComputeNode_reimage operation.

Parameters:
  • timeout (int) – The maximum time that the server can spend processing the request, in seconds. The default is 30 seconds. Default value: 30 .
  • client_request_id (str) – The caller-generated request identity, in the form of a GUID with no decoration such as curly braces, e.g. 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0.
  • return_client_request_id (bool) – Whether the server should return the client-request-id in the response. Default value: False .
  • ocp_date (datetime) – The time the request was issued. Client libraries typically set this to the current system clock time; set it explicitly if you are calling the REST API directly.
class azure.batch.models.ComputeNodeDisableSchedulingOptions(timeout=30, client_request_id=None, return_client_request_id=False, ocp_date=None)[source]

Bases: msrest.serialization.Model

Additional parameters for the ComputeNode_disable_scheduling operation.

Parameters:
  • timeout (int) – The maximum time that the server can spend processing the request, in seconds. The default is 30 seconds. Default value: 30 .
  • client_request_id (str) – The caller-generated request identity, in the form of a GUID with no decoration such as curly braces, e.g. 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0.
  • return_client_request_id (bool) – Whether the server should return the client-request-id in the response. Default value: False .
  • ocp_date (datetime) – The time the request was issued. Client libraries typically set this to the current system clock time; set it explicitly if you are calling the REST API directly.
class azure.batch.models.ComputeNodeEnableSchedulingOptions(timeout=30, client_request_id=None, return_client_request_id=False, ocp_date=None)[source]

Bases: msrest.serialization.Model

Additional parameters for the ComputeNode_enable_scheduling operation.

Parameters:
  • timeout (int) – The maximum time that the server can spend processing the request, in seconds. The default is 30 seconds. Default value: 30 .
  • client_request_id (str) – The caller-generated request identity, in the form of a GUID with no decoration such as curly braces, e.g. 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0.
  • return_client_request_id (bool) – Whether the server should return the client-request-id in the response. Default value: False .
  • ocp_date (datetime) – The time the request was issued. Client libraries typically set this to the current system clock time; set it explicitly if you are calling the REST API directly.
class azure.batch.models.ComputeNodeGetRemoteLoginSettingsOptions(timeout=30, client_request_id=None, return_client_request_id=False, ocp_date=None)[source]

Bases: msrest.serialization.Model

Additional parameters for the ComputeNode_get_remote_login_settings operation.

Parameters:
  • timeout (int) – The maximum time that the server can spend processing the request, in seconds. The default is 30 seconds. Default value: 30 .
  • client_request_id (str) – The caller-generated request identity, in the form of a GUID with no decoration such as curly braces, e.g. 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0.
  • return_client_request_id (bool) – Whether the server should return the client-request-id in the response. Default value: False .
  • ocp_date (datetime) – The time the request was issued. Client libraries typically set this to the current system clock time; set it explicitly if you are calling the REST API directly.
class azure.batch.models.ComputeNodeGetRemoteDesktopOptions(timeout=30, client_request_id=None, return_client_request_id=False, ocp_date=None)[source]

Bases: msrest.serialization.Model

Additional parameters for the ComputeNode_get_remote_desktop operation.

Parameters:
  • timeout (int) – The maximum time that the server can spend processing the request, in seconds. The default is 30 seconds. Default value: 30 .
  • client_request_id (str) – The caller-generated request identity, in the form of a GUID with no decoration such as curly braces, e.g. 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0.
  • return_client_request_id (bool) – Whether the server should return the client-request-id in the response. Default value: False .
  • ocp_date (datetime) – The time the request was issued. Client libraries typically set this to the current system clock time; set it explicitly if you are calling the REST API directly.
class azure.batch.models.ComputeNodeListOptions(filter=None, select=None, max_results=1000, timeout=30, client_request_id=None, return_client_request_id=False, ocp_date=None)[source]

Bases: msrest.serialization.Model

Additional parameters for the ComputeNode_list operation.

Parameters:
  • filter (str) – An OData $filter clause..
  • select (str) – An OData $select clause.
  • max_results (int) – The maximum number of items to return in the response. A maximum of 1000 nodes can be returned. Default value: 1000 .
  • timeout (int) – The maximum time that the server can spend processing the request, in seconds. The default is 30 seconds. Default value: 30 .
  • client_request_id (str) – The caller-generated request identity, in the form of a GUID with no decoration such as curly braces, e.g. 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0.
  • return_client_request_id (bool) – Whether the server should return the client-request-id in the response. Default value: False .
  • ocp_date (datetime) – The time the request was issued. Client libraries typically set this to the current system clock time; set it explicitly if you are calling the REST API directly.
class azure.batch.models.ApplicationSummaryPaged(*args, **kwargs)[source]

Bases: msrest.paging.Paged

A paging container for iterating over a list of ApplicationSummary object

class azure.batch.models.PoolUsageMetricsPaged(*args, **kwargs)[source]

Bases: msrest.paging.Paged

A paging container for iterating over a list of PoolUsageMetrics object

class azure.batch.models.CloudPoolPaged(*args, **kwargs)[source]

Bases: msrest.paging.Paged

A paging container for iterating over a list of CloudPool object

class azure.batch.models.NodeAgentSkuPaged(*args, **kwargs)[source]

Bases: msrest.paging.Paged

A paging container for iterating over a list of NodeAgentSku object

class azure.batch.models.CloudJobPaged(*args, **kwargs)[source]

Bases: msrest.paging.Paged

A paging container for iterating over a list of CloudJob object

class azure.batch.models.JobPreparationAndReleaseTaskExecutionInformationPaged(*args, **kwargs)[source]

Bases: msrest.paging.Paged

A paging container for iterating over a list of JobPreparationAndReleaseTaskExecutionInformation object

class azure.batch.models.CertificatePaged(*args, **kwargs)[source]

Bases: msrest.paging.Paged

A paging container for iterating over a list of Certificate object

class azure.batch.models.NodeFilePaged(*args, **kwargs)[source]

Bases: msrest.paging.Paged

A paging container for iterating over a list of NodeFile object

class azure.batch.models.CloudJobSchedulePaged(*args, **kwargs)[source]

Bases: msrest.paging.Paged

A paging container for iterating over a list of CloudJobSchedule object

class azure.batch.models.CloudTaskPaged(*args, **kwargs)[source]

Bases: msrest.paging.Paged

A paging container for iterating over a list of CloudTask object

class azure.batch.models.ComputeNodePaged(*args, **kwargs)[source]

Bases: msrest.paging.Paged

A paging container for iterating over a list of ComputeNode object

class azure.batch.models.OSType[source]

Bases: enum.Enum

linux = 'linux'
windows = 'windows'
class azure.batch.models.AccessScope[source]

Bases: enum.Enum

job = 'job'
class azure.batch.models.CertificateState[source]

Bases: enum.Enum

active = 'active'
delete_failed = 'deleteFailed'
deleting = 'deleting'
class azure.batch.models.CertificateFormat[source]

Bases: enum.Enum

cer = 'cer'
pfx = 'pfx'
class azure.batch.models.JobAction[source]

Bases: enum.Enum

disable = 'disable'
none = 'none'
terminate = 'terminate'
class azure.batch.models.DependencyAction[source]

Bases: enum.Enum

block = 'block'
satisfy = 'satisfy'
class azure.batch.models.AutoUserScope[source]

Bases: enum.Enum

pool = 'pool'
task = 'task'
class azure.batch.models.ElevationLevel[source]

Bases: enum.Enum

admin = 'admin'
non_admin = 'nonAdmin'
class azure.batch.models.OutputFileUploadCondition[source]

Bases: enum.Enum

task_completion = 'taskCompletion'
task_failure = 'taskFailure'
task_success = 'taskSuccess'
class azure.batch.models.ComputeNodeFillType[source]

Bases: enum.Enum

pack = 'pack'
spread = 'spread'
class azure.batch.models.CertificateStoreLocation[source]

Bases: enum.Enum

current_user = 'currentUser'
local_machine = 'localMachine'
class azure.batch.models.CertificateVisibility[source]

Bases: enum.Enum

remote_user = 'remoteUser'
start_task = 'startTask'
task = 'task'
class azure.batch.models.CachingType[source]

Bases: enum.Enum

none = 'none'
read_only = 'readOnly'
read_write = 'readWrite'
class azure.batch.models.PoolLifetimeOption[source]

Bases: enum.Enum

job = 'job'
job_schedule = 'jobSchedule'
class azure.batch.models.OnAllTasksComplete[source]

Bases: enum.Enum

no_action = 'noAction'
terminate_job = 'terminateJob'
class azure.batch.models.OnTaskFailure[source]

Bases: enum.Enum

no_action = 'noAction'
perform_exit_options_job_action = 'performExitOptionsJobAction'
class azure.batch.models.JobScheduleState[source]

Bases: enum.Enum

active = 'active'
completed = 'completed'
deleting = 'deleting'
disabled = 'disabled'
terminating = 'terminating'
class azure.batch.models.ErrorCategory[source]

Bases: enum.Enum

server_error = 'serverError'
user_error = 'userError'
class azure.batch.models.JobState[source]

Bases: enum.Enum

active = 'active'
completed = 'completed'
deleting = 'deleting'
disabled = 'disabled'
disabling = 'disabling'
enabling = 'enabling'
terminating = 'terminating'
class azure.batch.models.JobPreparationTaskState[source]

Bases: enum.Enum

completed = 'completed'
running = 'running'
class azure.batch.models.TaskExecutionResult[source]

Bases: enum.Enum

failure = 'failure'
success = 'success'
class azure.batch.models.JobReleaseTaskState[source]

Bases: enum.Enum

completed = 'completed'
running = 'running'
class azure.batch.models.PoolState[source]

Bases: enum.Enum

active = 'active'
deleting = 'deleting'
upgrading = 'upgrading'
class azure.batch.models.AllocationState[source]

Bases: enum.Enum

resizing = 'resizing'
steady = 'steady'
stopping = 'stopping'
class azure.batch.models.TaskState[source]

Bases: enum.Enum

active = 'active'
completed = 'completed'
preparing = 'preparing'
running = 'running'
class azure.batch.models.TaskAddStatus[source]

Bases: enum.Enum

client_error = 'clientError'
server_error = 'serverError'
success = 'success'
class azure.batch.models.SubtaskState[source]

Bases: enum.Enum

completed = 'completed'
preparing = 'preparing'
running = 'running'
class azure.batch.models.StartTaskState[source]

Bases: enum.Enum

completed = 'completed'
running = 'running'
class azure.batch.models.ComputeNodeState[source]

Bases: enum.Enum

creating = 'creating'
idle = 'idle'
leaving_pool = 'leavingPool'
offline = 'offline'
preempted = 'preempted'
rebooting = 'rebooting'
reimaging = 'reimaging'
running = 'running'
start_task_failed = 'startTaskFailed'
starting = 'starting'
unknown = 'unknown'
unusable = 'unusable'
waiting_for_start_task = 'waitingForStartTask'
class azure.batch.models.SchedulingState[source]

Bases: enum.Enum

disabled = 'disabled'
enabled = 'enabled'
class azure.batch.models.DisableJobOption[source]

Bases: enum.Enum

requeue = 'requeue'
terminate = 'terminate'
wait = 'wait'
class azure.batch.models.ComputeNodeDeallocationOption[source]

Bases: enum.Enum

requeue = 'requeue'
retained_data = 'retainedData'
task_completion = 'taskCompletion'
terminate = 'terminate'
class azure.batch.models.ComputeNodeRebootOption[source]

Bases: enum.Enum

requeue = 'requeue'
retained_data = 'retainedData'
task_completion = 'taskCompletion'
terminate = 'terminate'
class azure.batch.models.ComputeNodeReimageOption[source]

Bases: enum.Enum

requeue = 'requeue'
retained_data = 'retainedData'
task_completion = 'taskCompletion'
terminate = 'terminate'
class azure.batch.models.DisableComputeNodeSchedulingOption[source]

Bases: enum.Enum

requeue = 'requeue'
task_completion = 'taskCompletion'
terminate = 'terminate'