# 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)

  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 being aggregated.
  - start_time (datetime) – The start time of the aggregation interval.
  - end_time (datetime) – The end time of the aggregation interval.
  - vm_size (str) – The size of virtual machines in the pool. All VMs in a pool are the same size.
  - 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 in GiB to the pool during this interval.
  - data_egress_gi_b (float) – The cross data center network egress in GiB from the pool during this interval.

class `azure.batch.models.``NodeAgentSku`(id=None, verified_image_references=None, os_type=None)

  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 node agent SKU id.
  - 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 compatible with the node agent SKU. Possible values include: ‘linux’, ‘windows’, ‘unmapped’

class `azure.batch.models.``ImageReference`(publisher, offer, sku, version=None)

  Bases: `msrest.serialization.Model`

  A reference to an Azure Virtual Machines Marketplace image.

  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.``UsageStatistics`(start_time, last_update_time, dedicated_core_time)

  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)

  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)

  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)

  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 gibibytes read from disk by all tasks in the job.
  - write_io_gi_b (float) – The total gibibytes 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.
  - num_failed_tasks (long) – The total number of tasks in the job that failed during the given time range.
  - 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.)

class `azure.batch.models.``NameValuePair`(name=None, value=None)

  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)

  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.

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)

  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.
  - 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)

  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.

class `azure.batch.models.``ApplicationSummary`(id, display_name, versions)

  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)

  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’, ‘unmapped’
  - password (str) – The password to access the certificate’s private key.

class `azure.batch.models.``FileProperties`(last_modified, content_length, creation_time=None, content_type=None, file_mode=None)

  Bases: `msrest.serialization.Model`

  The properties of a file on a compute node.

  Parameters:

  - creation_time (datetime) – The file creation time.
  - 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. This property will be returned only from a Linux compute node.

class `azure.batch.models.``NodeFile`(name=None, url=None, is_directory=None, properties=None)

  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)

  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.
  - 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.
  - 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.

class `azure.batch.models.``JobConstraints`(max_wall_clock_time=None, max_task_retry_count=None)

  Bases: `msrest.serialization.Model`

  Specifies the execution constraints for jobs created on a schedule.

  Parameters:

  - max_wall_clock_time (timedelta) – The maximum elapsed time that the job may run, measured from the time the job starts. If the job does not complete within the time limit, the Batch service terminates it and any tasks that are still running.
  - 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.

class `azure.batch.models.``ResourceFile`(blob_source, file_path, file_mode=None)

  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 should include a shared access signature if the blob is not publicly readable.
  - file_path (str) – The location to which to download the file, relative to the task’s working directory.
  - file_mode (str) – The file mode attribute in octal format. This property will be ignored if it is specified for a resourceFile which will be downloaded to a Windows compute node.

class `azure.batch.models.``EnvironmentSetting`(name, value=None)

  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.``ExitConditions`(exit_codes=None, exit_code_ranges=None, scheduling_error=None, default=None)

  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 codes ranges and how the Batch service should respond to them.
  - scheduling_error (`ExitOptions`) – How the Batch service should respond if the task fails with a scheduling error.
  - default (`ExitOptions`) – How the Batch service should respond if the task fails with an exit condition not covered by any of the other properties – that is, any nonzero exit code not listed in the exitCodes or exitCodeRanges collection, or a scheduling error if the schedulingError property is not present.

class `azure.batch.models.``ExitCodeMapping`(code, exit_options)

  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.``ExitOptions`(job_action=None)

  Bases: `msrest.serialization.Model`

  How the Batch service should respond 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’. Possible values include: ‘none’, ‘disable’, ‘terminate’

class `azure.batch.models.``ExitCodeRangeMapping`(start, end, exit_options)

  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`) – An exitOptions specifying how the Batch service should respond if the task exits with an exit code in the range start to end.

class `azure.batch.models.``TaskConstraints`(max_wall_clock_time=None, retention_time=None, max_task_retry_count=None)

  Bases: `msrest.serialization.Model`

  Constraints to apply to the Job Manager 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.
  - retention_time (timedelta) – The minimum time to retain the working directory for the task on the compute node where it ran, from the time it completes execution. After this time, the Batch service may delete the working directory and all its contents. The default is infinite.
  - 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.

class `azure.batch.models.``JobManagerTask`(id, command_line, display_name=None, resource_files=None, environment_settings=None, constraints=None, kill_job_on_completion=None, run_elevated=None, run_exclusive=None, application_package_references=None)

  Bases: `msrest.serialization.Model`

  Specifies details of a Job Manager task.

  Parameters:

  - id (str) – A string that uniquely identifies the Job Manager task.
  - display_name (str) – The display name of the Job Manager task.
  - 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.
  - 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.
  - run_elevated (bool) – Whether to run the Job Manager task in elevated mode. The default value is false.
  - 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.
  - 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.

class `azure.batch.models.``JobPreparationTask`(command_line, id=None, resource_files=None, environment_settings=None, constraints=None, wait_for_success=None, run_elevated=None, rerun_on_node_reboot_after_success=None)

  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.
  - 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.
  - 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.
  - run_elevated (bool) – Whether to run the Job Preparation task in elevated mode. The default value is false.
  - rerun_on_node_reboot_after_success (bool) – Whether the Batch service should rerun the Job Preparation task after a compute node reboots. Note that the Job Preparation task should still be written to be idempotent because it can be rerun if the compute node is rebooted while Job Preparation task is still running. 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, run_elevated=None)

  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.
  - 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.
  - 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.
  - retention_time (timedelta) – The minimum time to retain the working directory for the Job Release task on the compute node. After this time, the Batch service may delete the working directory and all its contents. The default is infinite.
  - run_elevated (bool) – Whether to run the Job Release task in elevated mode. The default value is false.

class `azure.batch.models.``TaskSchedulingPolicy`(node_fill_type)

  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’, ‘unmapped’

class `azure.batch.models.``StartTask`(command_line, resource_files=None, environment_settings=None, run_elevated=None, max_task_retry_count=None, wait_for_success=None)

  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.
  - run_elevated (bool) – Whether to run the start task in elevated mode. The default value is false.
  - max_task_retry_count (int) – The maximum number of times the task may be retried.
  - 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.

class `azure.batch.models.``CertificateReference`(thumbprint, thumbprint_algorithm, store_location=None, store_name=None, visibility=None)

  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. Possible values include: ‘currentuser’, ‘localmachine’, ‘unmapped’
  - store_name (str) – The name of the certificate store on the compute node into which to install the certificate. The default value is My.
  - 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)

  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.``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=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, metadata=None)

  Bases: `msrest.serialization.Model`

  Specification for creating a new pool.

  Parameters:

  - display_name (str) – The display name for the pool.
  - vm_size (str) – The size of the virtual machines in the pool. All virtual machines in a pool are the same size.
  - 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.
  - 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.
  - 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 tasks are distributed among compute nodes in the pool.
  - resize_timeout (timedelta) – The timeout for allocation of compute nodes to the pool.
  - target_dedicated (int) – The desired number of compute nodes in the pool.
  - enable_auto_scale (bool) – Whether the pool size should automatically adjust over time.
  - auto_scale_formula (str) – The formula for the desired number of compute nodes in the pool.
  - auto_scale_evaluation_interval (timedelta) – A time interval for the desired AutoScale evaluation period in the pool.
  - enable_inter_node_communication (bool) – Whether the pool permits direct communication between nodes.
  - 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.
  - application_package_references (list of `ApplicationPackageReference`) – The list of application packages to be installed on each compute node in the pool.
  - metadata (list of `MetadataItem`) – A list of name-value pairs associated with the pool as metadata.

class `azure.batch.models.``CloudServiceConfiguration`(os_family, target_os_version=None, current_os_version=None)

  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.
  - 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.

class `azure.batch.models.``VirtualMachineConfiguration`(image_reference, node_agent_sku_id, windows_configuration=None)

  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.
  - node_agent_sku_id (str) – The SKU of Batch Node Agent to be provisioned on the compute node. 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.
  - windows_configuration (`WindowsConfiguration`) – Windows operating system settings on the virtual machine. This property must not be specified if the imageReference property specifies a Linux OS image.

class `azure.batch.models.``WindowsConfiguration`(enable_automatic_updates=None)

  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.``NetworkConfiguration`(subnet_id=None)

  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. The virtual network must be in the same region and subscription as the Azure Batch account. This property can only be specified for pools created with a cloudServiceConfiguration.

class `azure.batch.models.``AutoPoolSpecification`(pool_lifetime_option, auto_pool_id_prefix=None, keep_alive=None, pool=None)

  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 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. Possible values include: ‘jobschedule’, ‘job’, ‘unmapped’
  - keep_alive (bool) – Whether to keep an auto pool alive after its lifetime expires.
  - pool (`PoolSpecification`) – The pool specification for the auto pool.

class `azure.batch.models.``PoolInformation`(pool_id=None, auto_pool_specification=None)

  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 specify either poolId or autoPoolSpecification, 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. You must specify either poolId or autoPoolSpecification, but not both.

class `azure.batch.models.``JobSpecification`(pool_info, priority=None, display_name=None, uses_task_dependencies=None, constraints=None, job_manager_task=None, job_preparation_task=None, job_release_task=None, common_environment_settings=None, metadata=None)

  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.
  - 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.
  - 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.
  - job_preparation_task (`JobPreparationTask`) – The Job Preparation task for jobs created under this schedule.
  - job_release_task (`JobReleaseTask`) – The Job Release task for jobs created under this schedule.
  - 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).
  - 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.

class `azure.batch.models.``RecentJob`(id=None, url=None)

  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)

  Bases: `msrest.serialization.Model`

  Specifies how tasks should be run in a job associated with a job schedule.

  Parameters:

  - next_run_time (datetime) – The next time at which a job will be created under this schedule.
  - recent_job (`RecentJob`) – Information about the most recent job under the job 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)

  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.
  - 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.).

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)

  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.
  - last_modified (datetime) – The last modified time of the job schedule.
  - 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. Possible values include: ‘active’, ‘completed’, ‘disabled’, ‘terminating’, ‘deleting’
  - previous_state_transition_time (datetime) – The time at which the job schedule entered its previous 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.
  - 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)

  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.
  - display_name (str) – The display name for the schedule.
  - 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.

class `azure.batch.models.``JobSchedulingError`(category, code=None, message=None, details=None)

  Bases: `msrest.serialization.Model`

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

  Parameters:

  - category (str or `SchedulingErrorCategory`) – The category of the job scheduling error. Possible values include: ‘usererror’, ‘servererror’, ‘unmapped’
  - 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)

  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.
  - 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.
  - scheduling_error (`JobSchedulingError`) – Details of any error encountered by the service in starting the job.
  - terminate_reason (str) – A string describing the reason the job ended.

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)

  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.
  - last_modified (datetime) – The last modified time of the job.
  - 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.
  - job_release_task (`JobReleaseTask`) – The Job Release task.
  - 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. 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. Possible values include: ‘noAction’, ‘performExitOptionsJobAction’
  - metadata (list of `MetadataItem`) – A list of name-value pairs associated with the job as metadata.
  - 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)

  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.
  - 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.
  - job_release_task (`JobReleaseTask`) – The Job Release task.
  - 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. 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. Possible values include: ‘noAction’, ‘performExitOptionsJobAction’
  - metadata (list of `MetadataItem`) – A list of name-value pairs associated with the job as metadata.
  - uses_task_dependencies (bool) – The flag that determines if this job will use tasks with dependencies.

class `azure.batch.models.``TaskSchedulingError`(category, code=None, message=None, details=None)

  Bases: `msrest.serialization.Model`

  Information about an error when scheduling a task.

  Parameters:

  - category (str or `SchedulingErrorCategory`) – The category of the task scheduling error. Possible values include: ‘usererror’, ‘servererror’, ‘unmapped’
  - code (str) – An identifier for the task scheduling error. Codes are invariant and are intended to be consumed programmatically.
  - message (str) – A message describing the task scheduling error, intended to be suitable for display in a user interface.
  - details (list of `NameValuePair`) – The list of additional error details related to the scheduling 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, scheduling_error=None, last_retry_time=None)

  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. 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.
  - scheduling_error (`TaskSchedulingError`) – The error encountered by the Batch service when starting the task.
  - retry_count (int) – The number of times the task has been retried by the Batch service. Every time the task exits with a non-zero exit code, it is deemed a task failure. 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).

class `azure.batch.models.``JobReleaseTaskExecutionInformation`(start_time, state, end_time=None, task_root_directory=None, task_root_directory_url=None, exit_code=None, scheduling_error=None)

  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. 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.
  - scheduling_error (`TaskSchedulingError`) – The scheduling error encountered by the Batch service when starting the task.

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)

  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)

  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)

  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)

  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_error=None, current_dedicated=None, target_dedicated=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, max_tasks_per_node=None, task_scheduling_policy=None, metadata=None, stats=None)

  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.
  - url (str) – The URL of the pool.
  - e_tag (str) – The ETag of the pool.
  - last_modified (datetime) – The last modified time of the pool.
  - creation_time (datetime) – The creation time of the pool.
  - state (str or `PoolState`) – The current state of the pool. 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. 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.
  - 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.
  - 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 default value is 10 minutes.
  - resize_error (`ResizeError`) – Details of any error encountered while performing the last resize on the pool. This property is set only if an error occurred during the last pool resize, and only when the pool allocationState is Steady.
  - current_dedicated (int) – The number of compute nodes currently in the pool.
  - target_dedicated (int) – The desired number of compute nodes in the pool. This property must have the default value if enableAutoScale is true. It is required if enableAutoScale is false.
  - enable_auto_scale (bool) – Whether the pool size should automatically adjust over time. If true, the autoScaleFormula property must be set. If false, the targetDedicated property must be set.
  - auto_scale_formula (str) – A formula for the desired number of compute nodes in the pool.
  - auto_scale_evaluation_interval (timedelta) – A time interval for the desired AutoScale evaluation period in the pool.
  - auto_scale_run (`AutoScaleRun`) – The results and errors from the last execution of the autoscale formula.
  - enable_inter_node_communication (bool) – Whether the pool permits direct communication between nodes.
  - 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.
  - application_package_references (list of `ApplicationPackageReference`) – The list of application packages to be installed on each compute node in the pool.
  - 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.
  - 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=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, max_tasks_per_node=None, task_scheduling_policy=None, metadata=None)

  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. It is common to use a GUID for the id.
  - display_name (str) – The display name for the pool.
  - vm_size (str) – The size of virtual machines in the pool. All virtual machines in a pool are the same size.
  - 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.
  - 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. The default value is 10 minutes.
  - target_dedicated (int) – The desired number of compute nodes in the pool. This property must have the default value if enableAutoScale is true. It is required if enableAutoScale is false.
  - enable_auto_scale (bool) – Whether the pool size should automatically adjust over time. If true, the autoScaleFormula property must be set. If false, the targetDedicated property must be set.
  - auto_scale_formula (str) – A formula for the desired number of compute nodes in the pool.
  - auto_scale_evaluation_interval (timedelta) – A time interval for the desired autoscale evaluation period in the pool.
  - enable_inter_node_communication (bool) – Whether the pool permits direct communication between nodes.
  - 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.
  - application_package_references (list of `ApplicationPackageReference`) – The list of application packages to be installed on each compute node in the pool.
  - 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.
  - metadata (list of `MetadataItem`) – A list of name-value pairs associated with the pool as metadata.

class `azure.batch.models.``AffinityInformation`(affinity_id)

  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, scheduling_error=None, last_retry_time=None, last_requeue_time=None)

  Bases: `msrest.serialization.Model`

  Information about the execution of a task.

  Parameters:

  - start_time (datetime) – The time at which the task started running. If the task has been restarted or retried, this is the most recent time at which the task started running.
  - 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 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.
  - scheduling_error (`TaskSchedulingError`) – Details of any error encountered scheduling the task.
  - retry_count (int) – The number of times the task has been retried by the Batch service.
  - last_retry_time (datetime) – The most recent time at which a retry of the task started running.
  - requeue_count (int) – The number of times the task has been requeued by the Batch service as the result of a user request.
  - 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.

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)

  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)

  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 multi-instance task.
  - coordination_command_line (str) – The command to run on the compute node instances for coordinating among the subtasks.
  - 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)

  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.
  - 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.``TaskDependencies`(task_ids=None, task_id_ranges=None)

  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 must complete before this task can be scheduled.
  - task_id_ranges (list of `TaskIdRange`) – The list of task ranges that must complete before this task can be scheduled.

class `azure.batch.models.``TaskIdRange`(start, end)

  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.

  Parameters:

  - start (int) – The first task id in the range.
  - end (int) – The last task id in the range.

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, environment_settings=None, affinity_info=None, constraints=None, run_elevated=None, execution_info=None, node_info=None, multi_instance_settings=None, stats=None, depends_on=None, application_package_references=None)

  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. It is common to use a GUID for the id.
  - display_name (str) – A display name for the task.
  - url (str) – The URL of the task.
  - e_tag (str) – The ETag of the task.
  - 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 on the primary subtask after all the subtasks have finished executing the coordianation 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 subtask 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.
  - run_elevated (bool) – Whether to run the task in elevated mode.
  - 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`) – Information about how to run the multi-instance task.
  - stats (`TaskStatistics`) – Resource usage statistics for the task.
  - depends_on (`TaskDependencies`) – Any dependencies this task has.
  - 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.

class `azure.batch.models.``TaskAddParameter`(id, command_line, display_name=None, exit_conditions=None, resource_files=None, environment_settings=None, affinity_info=None, constraints=None, run_elevated=None, multi_instance_settings=None, depends_on=None, application_package_references=None)

  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. It is common to use a GUID for the id.
  - display_name (str) – A display name for the task.
  - command_line (str) – The command line of the task. For multi-instance tasks, the command line is executed on the primary subtask after all the subtasks have finished executing the coordianation 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 subtask 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.
  - run_elevated (bool) – Whether to run the task in elevated mode.
  - multi_instance_settings (`MultiInstanceSettings`) – Information about how to run the multi-instance task.
  - depends_on (`TaskDependencies`) – Any other tasks that this task depends on.
  - 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.

class `azure.batch.models.``TaskAddCollectionParameter`(value)

  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.``TaskAddResult`(status, task_id, e_tag=None, last_modified=None, location=None, error=None)

  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’, ‘unmapped’
  - 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.``BatchError`(code=None, message=None, values=None)

  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)

  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.``ErrorMessage`(lang=None, value=None)

  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)

  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.``TaskAddCollectionResult`(value=None)

  Bases: `msrest.serialization.Model`

  Response to a TaskOperations.AddCollection request.

  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, scheduling_error=None, state=None, state_transition_time=None, previous_state=None, previous_state_transition_time=None)

  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 parameter is returned only if the subtask 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.
  - scheduling_error (`TaskSchedulingError`) – Details of any error encountered scheduling the subtask.
  - state (str or `TaskState`) – The current state of the subtask. Possible values include: ‘active’, ‘preparing’, ‘running’, ‘completed’
  - state_transition_time (datetime) – The time at which the subtask entered its current state.
  - previous_state (str or `TaskState`) – The previous state of the subtask. This property is not set if the subtask is in its initial Active state. Possible values include: ‘active’, ‘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 Active state.

class `azure.batch.models.``CloudTaskListSubtasksResult`(value=None)

  Bases: `msrest.serialization.Model`

  Response to a CloudTaskOperations.ListSubtasks request.

  Parameters: | value (list of `SubtaskInformation`) – The list of information of subtasks.

class `azure.batch.models.``TaskInformation`(task_state, task_url=None, job_id=None, task_id=None, subtask_id=None, execution_info=None)

  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, scheduling_error=None, last_retry_time=None)

  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. Possible values include: ‘running’, ‘completed’
  - start_time (datetime) – The time at which the start task started running.
  - end_time (datetime) – The time at which the start task stopped running.
  - 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.
  - scheduling_error (`TaskSchedulingError`) – Any error encountered scheduling the start task.
  - retry_count (int) – The number of times the task has been retried by the Batch service.
  - last_retry_time (datetime) – The most recent time at which a retry of the task started running.

class `azure.batch.models.``ComputeNodeError`(code=None, message=None, error_details=None)

  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)

  Bases: `msrest.serialization.Model`

  A compute node in the Batch service.

  Parameters:

  - id (str) – The id of the compute node.
  - 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’
  - scheduling_state (str or `SchedulingState`) – Whether the compute node should be available for task scheduling. 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.
  - 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.
  - affinity_id (str) – An identifier which can be passed in the Add Task API 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.
  - 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.
  - errors (list of `ComputeNodeError`) – The list of errors that are currently being encountered by the compute node.

class `azure.batch.models.``ComputeNodeUser`(name, is_admin=None, expiry_time=None, password=None, ssh_public_key=None)

  Bases: `msrest.serialization.Model`

  An user account 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.
  - expiry_time (datetime) – The time at which the account should expire. If omitted, the default is 1 day from the current time.
  - password (str) – The password of the account.
  - ssh_public_key (str) – The SSH public key that can be used for remote login to the compute node.

class `azure.batch.models.``ComputeNodeGetRemoteLoginSettingsResult`(remote_login_ip_address, remote_login_port)

  Bases: `msrest.serialization.Model`

  Response to a ComputeNodeOperation.GetRemoteLoginSettings request.

  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)

  Bases: `msrest.serialization.Model`

  Parameters for a CloudJobScheduleOperations.Patch request.

  Parameters:

  - 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 job schedule as metadata.

class `azure.batch.models.``JobScheduleUpdateParameter`(schedule, job_specification, metadata=None)

  Bases: `msrest.serialization.Model`

  Parameters for a CloudJobScheduleOperations.Update request.

  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.
  - 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)

  Bases: `msrest.serialization.Model`

  Parameters for a CloudJobOperations.Disable request.

  Parameters: | disable_tasks (str or `DisableJobOption`) – What to do with active tasks associated with the job. Possible values include: ‘requeue’, ‘terminate’, ‘wait’

class `azure.batch.models.``JobTerminateParameter`(terminate_reason=None)

  Bases: `msrest.serialization.Model`

  Parameters for a CloudJobOperations.Terminate request.

  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)

  Bases: `msrest.serialization.Model`

  Parameters for a CloudJobOperations.Patch request.

  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`) – Specifies an action the Batch service should take when all tasks in the job are in the completed state. 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)

  Bases: `msrest.serialization.Model`

  Parameters for a CloudJobOperations.Update request.

  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`) – Specifies an action the Batch service should take when all tasks in the job are in the completed state. Possible values include: ‘noAction’, ‘terminateJob’

class `azure.batch.models.``PoolEnableAutoScaleParameter`(auto_scale_formula=None, auto_scale_evaluation_interval=None)

  Bases: `msrest.serialization.Model`

  Parameters for a CloudPoolOperations.EnableAutoScale request.

  Parameters:

  - auto_scale_formula (str) – The formula for the desired number of compute nodes in the pool.
  - auto_scale_evaluation_interval (timedelta) – A time interval for the desired autoscale evaluation period in the pool.

class `azure.batch.models.``PoolEvaluateAutoScaleParameter`(auto_scale_formula)

  Bases: `msrest.serialization.Model`

  Parameters for a CloudJobOperations.EvaluateAutoScale request.

  Parameters: | auto_scale_formula (str) – A formula for the desired number of compute nodes in the pool.

class `azure.batch.models.``PoolResizeParameter`(target_dedicated, resize_timeout=None, node_deallocation_option=None)

  Bases: `msrest.serialization.Model`

  Parameters for a CloudPoolOperations.Resize request.

  Parameters:

  - target_dedicated (int) – The desired number of 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 10 minutes.
  - node_deallocation_option (str or `ComputeNodeDeallocationOption`) – When nodes may be removed from the pool, if the pool size is decreasing. Possible values include: ‘requeue’, ‘terminate’, ‘taskcompletion’, ‘retaineddata’

class `azure.batch.models.``PoolUpdatePropertiesParameter`(certificate_references, application_package_references, metadata, start_task=None)

  Bases: `msrest.serialization.Model`

  Parameters for a CloudPoolOperations.UpdateProperties request.

  Parameters:

  - start_task (`StartTask`) – A task to run on each compute node as it joins the pool. 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.
  - application_package_references (list of `ApplicationPackageReference`) – A list of application packages to be installed on each compute node in the pool. 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. If you specify an empty collection, any existing metadata is removed from the pool.

class `azure.batch.models.``PoolUpgradeOSParameter`(target_os_version)

  Bases: `msrest.serialization.Model`

  Parameters for a CloudPoolOperations.UpgradeOS request.

  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)

  Bases: `msrest.serialization.Model`

  Parameters for a CloudPoolOperations.Patch request.

  Parameters:

  - start_task (`StartTask`) – A task to run on each compute node as it joins the pool. 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.
  - application_package_references (list of `ApplicationPackageReference`) – A list of application packages to be installed on each compute node in 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 omitted, any existing metadata is left unchanged.

class `azure.batch.models.``TaskUpdateParameter`(constraints=None)

  Bases: `msrest.serialization.Model`

  Parameters for a CloudTaskOperations.Update request.

  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)

  Bases: `msrest.serialization.Model`

  Parameters for a ComputeNodeOperations.UpdateUser request.

  Parameters:

  - password (str) – The password of the account.
  - expiry_time (datetime) – The time at which the account should expire. If omitted, the default is 1 day from the current time.
  - ssh_public_key (str) – The SSH public key that can be used for remote login to the compute node.

class `azure.batch.models.``NodeRebootParameter`(node_reboot_option=None)

  Bases: `msrest.serialization.Model`

  Parameters for a ComputeNodeOperations.Reboot request.

  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)

  Bases: `msrest.serialization.Model`

  Parameters for a ComputeNodeOperations.Reimage request.

  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)

  Bases: `msrest.serialization.Model`

  Parameters for a ComputeNodeOperations.DisableScheduling request.

  Parameters: | node_disable_scheduling_option (str or `DisableComputeNodeSchedulingOption`) – What to do with currently running tasks when disable 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)

  Bases: `msrest.serialization.Model`

  Parameters for a ComputeNodeOperations.Remove request.

  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 10 minutes.
  - node_deallocation_option (str or `ComputeNodeDeallocationOption`) – When compute nodes may be removed from the pool. Possible values include: ‘requeue’, ‘terminate’, ‘taskcompletion’, ‘retaineddata’

class `azure.batch.models.``ApplicationListOptions`(max_results=None, timeout=30, client_request_id=None, return_client_request_id=None, ocp_date=None)

  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.
  - 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 identifier in the response.
  - ocp_date (datetime) – The time the request was issued. If not specified, this header will be automatically populated with the current system clock time.

class `azure.batch.models.``ApplicationGetOptions`(timeout=30, client_request_id=None, return_client_request_id=None, ocp_date=None)

  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 identifier in the response.
  - ocp_date (datetime) – The time the request was issued. If not specified, this header will be automatically populated with the current system clock time.

class `azure.batch.models.``PoolListPoolUsageMetricsOptions`(start_time=None, end_time=None, filter=None, max_results=None, timeout=30, client_request_id=None, return_client_request_id=None, ocp_date=None)

  Bases: `msrest.serialization.Model`

  Additional parameters for the Pool_ListPoolUsageMetrics 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.
  - end_time (datetime) – The latest time from which to include metrics. This must be at least two hours before the current time.
  - filter (str) – An OData $filter clause.
  - max_results (int) – The maximum number of items to return in the response.
  - 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 identifier in the response.
  - ocp_date (datetime) – The time the request was issued. If not specified, this header will be automatically populated with the current system clock time.

class `azure.batch.models.``AccountListNodeAgentSkusOptions`(filter=None, max_results=None, timeout=30, client_request_id=None, return_client_request_id=None, ocp_date=None)

  Bases: `msrest.serialization.Model`

  Additional parameters for the Account_ListNodeAgentSkus operation.

  Parameters:

  - filter (str) – An OData $filter clause.
  - max_results (int) – The maximum number of items to return in the response.
  - 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 identifier in the response.
  - ocp_date (datetime) – The time the request was issued. If not specified, this header will be automatically populated with the current system clock time.

class `azure.batch.models.``PoolGetAllPoolsLifetimeStatisticsOptions`(timeout=30, client_request_id=None, return_client_request_id=None, ocp_date=None)

  Bases: `msrest.serialization.Model`

  Additional parameters for the Pool_GetAllPoolsLifetimeStatistics 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 identifier in the response.
  - ocp_date (datetime) – The time the request was issued. If not specified, this header will be automatically populated with the current system clock time.

class `azure.batch.models.``JobGetAllJobsLifetimeStatisticsOptions`(timeout=30, client_request_id=None, return_client_request_id=None, ocp_date=None)

  Bases: `msrest.serialization.Model`

  Additional parameters for the Job_GetAllJobsLifetimeStatistics 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 identifier in the response.
  - ocp_date (datetime) – The time the request was issued. If not specified, this header will be automatically populated with the current system clock time.

class `azure.batch.models.``CertificateAddOptions`(timeout=30, client_request_id=None, return_client_request_id=None, ocp_date=None)

  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 identifier in the response.
  - ocp_date (datetime) – The time the request was issued. If not specified, this header will be automatically populated with the current system clock time.

class `azure.batch.models.``CertificateListOptions`(filter=None, select=None, max_results=None, timeout=30, client_request_id=None, return_client_request_id=None, ocp_date=None)

  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.
  - 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 identifier in the response.
  - ocp_date (datetime) – The time the request was issued. If not specified, this header will be automatically populated with the current system clock time.

class `azure.batch.models.``CertificateCancelDeletionOptions`(timeout=30, client_request_id=None, return_client_request_id=None, ocp_date=None)

  Bases: `msrest.serialization.Model`

  Additional parameters for the Certificate_CancelDeletion 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 identifier in the response.
  - ocp_date (datetime) – The time the request was issued. If not specified, this header will be automatically populated with the current system clock time.

class `azure.batch.models.``CertificateDeleteOptions`(timeout=30, client_request_id=None, return_client_request_id=None, ocp_date=None)

  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 identifier in the response.
  - ocp_date (datetime) – The time the request was issued. If not specified, this header will be automatically populated with the current system clock time.

class `azure.batch.models.``CertificateGetOptions`(select=None, timeout=30, client_request_id=None, return_client_request_id=None, ocp_date=None)

  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 identifier in the response.
  - ocp_date (datetime) – The time the request was issued. If not specified, this header will be automatically populated with the current system clock time.

class `azure.batch.models.``FileDeleteFromTaskOptions`(timeout=30, client_request_id=None, return_client_request_id=None, ocp_date=None)

  Bases: `msrest.serialization.Model`

  Additional parameters for the File_DeleteFromTask 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 identifier in the response.
  - ocp_date (datetime) – The time the request was issued. If not specified, this header will be automatically populated with the current system clock time.

class `azure.batch.models.``FileGetFromTaskOptions`(timeout=30, client_request_id=None, return_client_request_id=None, ocp_date=None, ocp_range=None, if_modified_since=None, if_unmodified_since=None)

  Bases: `msrest.serialization.Model`

  Additional parameters for the File_GetFromTask 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 identifier in the response.
  - ocp_date (datetime) – The time the request was issued. If not specified, this header will be automatically populated with the current system clock time.
  - 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) – Specify this header to perform the operation only if the resource has been modified since the specified date/time.
  - if_unmodified_since (datetime) – Specify this header to perform the operation only if the resource has not been modified since the specified date/time.

class `azure.batch.models.``FileGetNodeFilePropertiesFromTaskOptions`(timeout=30, client_request_id=None, return_client_request_id=None, ocp_date=None, if_modified_since=None, if_unmodified_since=None)

  Bases: `msrest.serialization.Model`

  Additional parameters for the File_GetNodeFilePropertiesFromTask 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 identifier in the response.
  - ocp_date (datetime) – The time the request was issued. If not specified, this header will be automatically populated with the current system clock time.
  - if_modified_since (datetime) – Specify this header to perform the operation only if the resource has been modified since the specified date/time.
  - if_unmodified_since (datetime) – Specify this header to perform the operation only if the resource has not been modified since the specified date/time.

class `azure.batch.models.``FileDeleteFromComputeNodeOptions`(timeout=30, client_request_id=None, return_client_request_id=None, ocp_date=None)

  Bases: `msrest.serialization.Model`

  Additional parameters for the File_DeleteFromComputeNode 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 identifier in the response.
  - ocp_date (datetime) – The time the request was issued. If not specified, this header will be automatically populated with the current system clock time.

class `azure.batch.models.``FileGetFromComputeNodeOptions`(timeout=30, client_request_id=None, return_client_request_id=None, ocp_date=None, ocp_range=None, if_modified_since=None, if_unmodified_since=None)

  Bases: `msrest.serialization.Model`

  Additional parameters for the File_GetFromComputeNode 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 identifier in the response.
  - ocp_date (datetime) – The time the request was issued. If not specified, this header will be automatically populated with the current system clock time.
  - 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) – Specify this header to perform the operation only if the resource has been modified since the specified date/time.
  - if_unmodified_since (datetime) – Specify this header to perform the operation only if the resource has not been modified since the specified date/time.

class `azure.batch.models.``FileGetNodeFilePropertiesFromComputeNodeOptions`(timeout=30, client_request_id=None, return_client_request_id=None, ocp_date=None, if_modified_since=None, if_unmodified_since=None)

  Bases: `msrest.serialization.Model`

  Additional parameters for the File_GetNodeFilePropertiesFromComputeNode 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 identifier in the response.
  - ocp_date (datetime) – The time the request was issued. If not specified, this header will be automatically populated with the current system clock time.
  - if_modified_since (datetime) – Specify this header to perform the operation only if the resource has been modified since the specified date/time.
  - if_unmodified_since (datetime) – Specify this header to perform the operation only if the resource has not been modified since the specified date/time.

class `azure.batch.models.``FileListFromTaskOptions`(filter=None, max_results=None, timeout=30, client_request_id=None, return_client_request_id=None, ocp_date=None)

  Bases: `msrest.serialization.Model`

  Additional parameters for the File_ListFromTask operation.

  Parameters:

  - filter (str) – An OData $filter clause.
  - max_results (int) – The maximum number of items to return in the response.
  - 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 identifier in the response.
  - ocp_date (datetime) – The time the request was issued. If not specified, this header will be automatically populated with the current system clock time.

class `azure.batch.models.``FileListFromComputeNodeOptions`(filter=None, max_results=None, timeout=30, client_request_id=None, return_client_request_id=None, ocp_date=None)

  Bases: `msrest.serialization.Model`

  Additional parameters for the File_ListFromComputeNode operation.

  Parameters:

  - filter (str) – An OData $filter clause.
  - max_results (int) – The maximum number of items to return in the response.
  - 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 identifier in the response.
  - ocp_date (datetime) – The time the request was issued. If not specified, this header will be automatically populated with the current system clock time.

class `azure.batch.models.``JobScheduleExistsOptions`(timeout=30, client_request_id=None, return_client_request_id=None, ocp_date=None, if_match=None, if_none_match=None, if_modified_since=None, if_unmodified_since=None)

  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 identifier in the response.
  - ocp_date (datetime) – The time the request was issued. If not specified, this header will be automatically populated with the current system clock time.
  - if_match (str) – An ETag is specified. Specify this header to perform the operation only if the resource’s ETag is an exact match as specified.
  - if_none_match (str) – An ETag is specified. Specify this header to perform the operation only if the resource’s ETag does not match the specified ETag.
  - if_modified_since (datetime) – Specify this header to perform the operation only if the resource has been modified since the specified date/time.
  - if_unmodified_since (datetime) – Specify this header to perform the operation only if the resource has not been modified since the specified date/time.

class `azure.batch.models.``JobScheduleDeleteOptions`(timeout=30, client_request_id=None, return_client_request_id=None, ocp_date=None, if_match=None, if_none_match=None, if_modified_since=None, if_unmodified_since=None)

  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 identifier in the response.
  - ocp_date (datetime) – The time the request was issued. If not specified, this header will be automatically populated with the current system clock time.
  - if_match (str) – An ETag is specified. Specify this header to perform the operation only if the resource’s ETag is an exact match as specified.
  - if_none_match (str) – An ETag is specified. Specify this header to perform the operation only if the resource’s ETag does not match the specified ETag.
  - if_modified_since (datetime) – Specify this header to perform the operation only if the resource has been modified since the specified date/time.
  - if_unmodified_since (datetime) – Specify this header to perform the operation only if the resource has not been modified since the specified date/time.

class `azure.batch.models.``JobScheduleGetOptions`(select=None, expand=None, timeout=30, client_request_id=None, return_client_request_id=None, ocp_date=None, if_match=None, if_none_match=None, if_modified_since=None, if_unmodified_since=None)

  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 identifier in the response.
  - ocp_date (datetime) – The time the request was issued. If not specified, this header will be automatically populated with the current system clock time.
  - if_match (str) – An ETag is specified. Specify this header to perform the operation only if the resource’s ETag is an exact match as specified.
  - if_none_match (str) – An ETag is specified. Specify this header to perform the operation only if the resource’s ETag does not match the specified ETag.
  - if_modified_since (datetime) – Specify this header to perform the operation only if the resource has been modified since the specified date/time.
  - if_unmodified_since (datetime) – Specify this header to perform the operation only if the resource has not been modified since the specified date/time.

class `azure.batch.models.``JobSchedulePatchOptions`(timeout=30, client_request_id=None, return_client_request_id=None, ocp_date=None, if_match=None, if_none_match=None, if_modified_since=None, if_unmodified_since=None)

  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 identifier in the response.
  - ocp_date (datetime) – The time the request was issued. If not specified, this header will be automatically populated with the current system clock time.
  - if_match (str) – An ETag is specified. Specify this header to perform the operation only if the resource’s ETag is an exact match as specified.
  - if_none_match (str) – An ETag is specified. Specify this header to perform the operation only if the resource’s ETag does not match the specified ETag.
  - if_modified_since (datetime) – Specify this header to perform the operation only if the resource has been modified since the specified date/time.
  - if_unmodified_since (datetime) – Specify this header to perform the operation only if the resource has not been modified since the specified date/time.

class `azure.batch.models.``JobScheduleUpdateOptions`(timeout=30, client_request_id=None, return_client_request_id=None, ocp_date=None, if_match=None, if_none_match=None, if_modified_since=None, if_unmodified_since=None)

  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 identifier in the response.
  - ocp_date (datetime) – The time the request was issued. If not specified, this header will be automatically populated with the current system clock time.
  - if_match (str) – An ETag is specified. Specify this header to perform the operation only if the resource’s ETag is an exact match as specified.
  - if_none_match (str) – An ETag is specified. Specify this header to perform the operation only if the resource’s ETag does not match the specified ETag.
  - if_modified_since (datetime) – Specify this header to perform the operation only if the resource has been modified since the specified date/time.
  - if_unmodified_since (datetime) – Specify this header to perform the operation only if the resource has not been modified since the specified date/time.

class `azure.batch.models.``JobScheduleDisableOptions`(timeout=30, client_request_id=None, return_client_request_id=None, ocp_date=None, if_match=None, if_none_match=None, if_modified_since=None, if_unmodified_since=None)

  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 identifier in the response.
  - ocp_date (datetime) – The time the request was issued. If not specified, this header will be automatically populated with the current system clock time.
  - if_match (str) – An ETag is specified. Specify this header to perform the operation only if the resource’s ETag is an exact match as specified.
  - if_none_match (str) – An ETag is specified. Specify this header to perform the operation only if the resource’s ETag does not match the specified ETag.
  - if_modified_since (datetime) – Specify this header to perform the operation only if the resource has been modified since the specified date/time.
  - if_unmodified_since (datetime) – Specify this header to perform the operation only if the resource has not been modified since the specified date/time.

class `azure.batch.models.``JobScheduleEnableOptions`(timeout=30, client_request_id=None, return_client_request_id=None, ocp_date=None, if_match=None, if_none_match=None, if_modified_since=None, if_unmodified_since=None)

  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 identifier in the response.
  - ocp_date (datetime) – The time the request was issued. If not specified, this header will be automatically populated with the current system clock time.
  - if_match (str) – An ETag is specified. Specify this header to perform the operation only if the resource’s ETag is an exact match as specified.
  - if_none_match (str) – An ETag is specified. Specify this header to perform the operation only if the resource’s ETag does not match the specified ETag.
  - if_modified_since (datetime) – Specify this header to perform the operation only if the resource has been modified since the specified date/time.
  - if_unmodified_since (datetime) – Specify this header to perform the operation only if the resource has not been modified since the specified date/time.

class `azure.batch.models.``JobScheduleTerminateOptions`(timeout=30, client_request_id=None, return_client_request_id=None, ocp_date=None, if_match=None, if_none_match=None, if_modified_since=None, if_unmodified_since=None)

  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 identifier in the response.
  - ocp_date (datetime) – The time the request was issued. If not specified, this header will be automatically populated with the current system clock time.
  - if_match (str) – An ETag is specified. Specify this header to perform the operation only if the resource’s ETag is an exact match as specified.
  - if_none_match (str) – An ETag is specified. Specify this header to perform the operation only if the resource’s ETag does not match the specified ETag.
  - if_modified_since (datetime) – Specify this header to perform the operation only if the resource has been modified since the specified date/time.
  - if_unmodified_since (datetime) – Specify this header to perform the operation only if the resource has not been modified since the specified date/time.

class `azure.batch.models.``JobScheduleAddOptions`(timeout=30, client_request_id=None, return_client_request_id=None, ocp_date=None)

  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 identifier in the response.
  - ocp_date (datetime) – The time the request was issued. If not specified, this header will be automatically populated with the current system clock time.

class `azure.batch.models.``JobScheduleListOptions`(filter=None, select=None, expand=None, max_results=None, timeout=30, client_request_id=None, return_client_request_id=None, ocp_date=None)

  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.
  - 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 identifier in the response.
  - ocp_date (datetime) – The time the request was issued. If not specified, this header will be automatically populated with the current system clock time.

class `azure.batch.models.``JobDeleteOptions`(timeout=30, client_request_id=None, return_client_request_id=None, ocp_date=None, if_match=None, if_none_match=None, if_modified_since=None, if_unmodified_since=None)

  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 identifier in the response.
  - ocp_date (datetime) – The time the request was issued. If not specified, this header will be automatically populated with the current system clock time.
  - if_match (str) – An ETag is specified. Specify this header to perform the operation only if the resource’s ETag is an exact match as specified.
  - if_none_match (str) – An ETag is specified. Specify this header to perform the operation only if the resource’s ETag does not match the specified ETag.
  - if_modified_since (datetime) – Specify this header to perform the operation only if the resource has been modified since the specified date/time.
  - if_unmodified_since (datetime) – Specify this header to perform the operation only if the resource has not been modified since the specified date/time.

class `azure.batch.models.``JobGetOptions`(select=None, expand=None, timeout=30, client_request_id=None, return_client_request_id=None, ocp_date=None, if_match=None, if_none_match=None, if_modified_since=None, if_unmodified_since=None)

  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 identifier in the response.
  - ocp_date (datetime) – The time the request was issued. If not specified, this header will be automatically populated with the current system clock time.
  - if_match (str) – An ETag is specified. Specify this header to perform the operation only if the resource’s ETag is an exact match as specified.
  - if_none_match (str) – An ETag is specified. Specify this header to perform the operation only if the resource’s ETag does not match the specified ETag.
  - if_modified_since (datetime) – Specify this header to perform the operation only if the resource has been modified since the specified date/time.
  - if_unmodified_since (datetime) – Specify this header to perform the operation only if the resource has not been modified since the specified date/time.

class `azure.batch.models.``JobPatchOptions`(timeout=30, client_request_id=None, return_client_request_id=None, ocp_date=None, if_match=None, if_none_match=None, if_modified_since=None, if_unmodified_since=None)

  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 identifier in the response.
  - ocp_date (datetime) – The time the request was issued. If not specified, this header will be automatically populated with the current system clock time.
  - if_match (str) – An ETag is specified. Specify this header to perform the operation only if the resource’s ETag is an exact match as specified.
  - if_none_match (str) – An ETag is specified. Specify this header to perform the operation only if the resource’s ETag does not match the specified ETag.
  - if_modified_since (datetime) – Specify this header to perform the operation only if the resource has been modified since the specified date/time.
  - if_unmodified_since (datetime) – Specify this header to perform the operation only if the resource has not been modified since the specified date/time.

class `azure.batch.models.``JobUpdateOptions`(timeout=30, client_request_id=None, return_client_request_id=None, ocp_date=None, if_match=None, if_none_match=None, if_modified_since=None, if_unmodified_since=None)

  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 identifier in the response.
  - ocp_date (datetime) – The time the request was issued. If not specified, this header will be automatically populated with the current system clock time.
  - if_match (str) – An ETag is specified. Specify this header to perform the operation only if the resource’s ETag is an exact match as specified.
  - if_none_match (str) – An ETag is specified. Specify this header to perform the operation only if the resource’s ETag does not match the specified ETag.
  - if_modified_since (datetime) – Specify this header to perform the operation only if the resource has been modified since the specified date/time.
  - if_unmodified_since (datetime) – Specify this header to perform the operation only if the resource has not been modified since the specified date/time.

class `azure.batch.models.``JobDisableOptions`(timeout=30, client_request_id=None, return_client_request_id=None, ocp_date=None, if_match=None, if_none_match=None, if_modified_since=None, if_unmodified_since=None)

  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 identifier in the response.
  - ocp_date (datetime) – The time the request was issued. If not specified, this header will be automatically populated with the current system clock time.
  - if_match (str) – An ETag is specified. Specify this header to perform the operation only if the resource’s ETag is an exact match as specified.
  - if_none_match (str) – An ETag is specified. Specify this header to perform the operation only if the resource’s ETag does not match the specified ETag.
  - if_modified_since (datetime) – Specify this header to perform the operation only if the resource has been modified since the specified date/time.
  - if_unmodified_since (datetime) – Specify this header to perform the operation only if the resource has not been modified since the specified date/time.

class `azure.batch.models.``JobEnableOptions`(timeout=30, client_request_id=None, return_client_request_id=None, ocp_date=None, if_match=None, if_none_match=None, if_modified_since=None, if_unmodified_since=None)

  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 identifier in the response.
  - ocp_date (datetime) – The time the request was issued. If not specified, this header will be automatically populated with the current system clock time.
  - if_match (str) – An ETag is specified. Specify this header to perform the operation only if the resource’s ETag is an exact match as specified.
  - if_none_match (str) – An ETag is specified. Specify this header to perform the operation only if the resource’s ETag does not match the specified ETag.
  - if_modified_since (datetime) – Specify this header to perform the operation only if the resource has been modified since the specified date/time.
  - if_unmodified_since (datetime) – Specify this header to perform the operation only if the resource has not been modified since the specified date/time.

class `azure.batch.models.``JobTerminateOptions`(timeout=30, client_request_id=None, return_client_request_id=None, ocp_date=None, if_match=None, if_none_match=None, if_modified_since=None, if_unmodified_since=None)

  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 identifier in the response.
  - ocp_date (datetime) – The time the request was issued. If not specified, this header will be automatically populated with the current system clock time.
  - if_match (str) – An ETag is specified. Specify this header to perform the operation only if the resource’s ETag is an exact match as specified.
  - if_none_match (str) – An ETag is specified. Specify this header to perform the operation only if the resource’s ETag does not match the specified ETag.
  - if_modified_since (datetime) – Specify this header to perform the operation only if the resource has been modified since the specified date/time.
  - if_unmodified_since (datetime) – Specify this header to perform the operation only if the resource has not been modified since the specified date/time.

class `azure.batch.models.``JobAddOptions`(timeout=30, client_request_id=None, return_client_request_id=None, ocp_date=None)

  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 identifier in the response.
  - ocp_date (datetime) – The time the request was issued. If not specified, this header will be automatically populated with the current system clock time.

class `azure.batch.models.``JobListOptions`(filter=None, select=None, expand=None, max_results=None, timeout=30, client_request_id=None, return_client_request_id=None, ocp_date=None)

  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.
  - 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 identifier in the response.
  - ocp_date (datetime) – The time the request was issued. If not specified, this header will be automatically populated with the current system clock time.

class `azure.batch.models.``JobListFromJobScheduleOptions`(filter=None, select=None, expand=None, max_results=None, timeout=30, client_request_id=None, return_client_request_id=None, ocp_date=None)

  Bases: `msrest.serialization.Model`

  Additional parameters for the Job_ListFromJobSchedule 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.
  - 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 identifier in the response.
  - ocp_date (datetime) – The time the request was issued. If not specified, this header will be automatically populated with the current system clock time.

class `azure.batch.models.``JobListPreparationAndReleaseTaskStatusOptions`(filter=None, select=None, max_results=None, timeout=30, client_request_id=None, return_client_request_id=None, ocp_date=None)

  Bases: `msrest.serialization.Model`

  Additional parameters for the Job_ListPreparationAndReleaseTaskStatus 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.
  - 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 identifier in the response.
  - ocp_date (datetime) – The time the request was issued. If not specified, this header will be automatically populated with the current system clock time.

class `azure.batch.models.``PoolAddOptions`(timeout=30, client_request_id=None, return_client_request_id=None, ocp_date=None)

  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 identifier in the response.
  - ocp_date (datetime) – The time the request was issued. If not specified, this header will be automatically populated with the current system clock time.

class `azure.batch.models.``PoolListOptions`(filter=None, select=None, expand=None, max_results=None, timeout=30, client_request_id=None, return_client_request_id=None, ocp_date=None)

  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.
  - 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 identifier in the response.
  - ocp_date (datetime) – The time the request was issued. If not specified, this header will be automatically populated with the current system clock time.

class `azure.batch.models.``PoolDeleteOptions`(timeout=30, client_request_id=None, return_client_request_id=None, ocp_date=None, if_match=None, if_none_match=None, if_modified_since=None, if_unmodified_since=None)

  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 identifier in the response.
  - ocp_date (datetime) – The time the request was issued. If not specified, this header will be automatically populated with the current system clock time.
  - if_match (str) – An ETag is specified. Specify this header to perform the operation only if the resource’s ETag is an exact match as specified.
  - if_none_match (str) – An ETag is specified. Specify this header to perform the operation only if the resource’s ETag does not match the specified ETag.
  - if_modified_since (datetime) – Specify this header to perform the operation only if the resource has been modified since the specified date/time.
  - if_unmodified_since (datetime) – Specify this header to perform the operation only if the resource has not been modified since the specified date/time.

class `azure.batch.models.``PoolExistsOptions`(timeout=30, client_request_id=None, return_client_request_id=None, ocp_date=None, if_match=None, if_none_match=None, if_modified_since=None, if_unmodified_since=None)

  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 identifier in the response.
  - ocp_date (datetime) – The time the request was issued. If not specified, this header will be automatically populated with the current system clock time.
  - if_match (str) – An ETag is specified. Specify this header to perform the operation only if the resource’s ETag is an exact match as specified.
  - if_none_match (str) – An ETag is specified. Specify this header to perform the operation only if the resource’s ETag does not match the specified ETag.
  - if_modified_since (datetime) – Specify this header to perform the operation only if the resource has been modified since the specified date/time.
  - if_unmodified_since (datetime) – Specify this header to perform the operation only if the resource has not been modified since the specified date/time.

class `azure.batch.models.``PoolGetOptions`(select=None, expand=None, timeout=30, client_request_id=None, return_client_request_id=None, ocp_date=None, if_match=None, if_none_match=None, if_modified_since=None, if_unmodified_since=None)

  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 identifier in the response.
  - ocp_date (datetime) – The time the request was issued. If not specified, this header will be automatically populated with the current system clock time.
  - if_match (str) – An ETag is specified. Specify this header to perform the operation only if the resource’s ETag is an exact match as specified.
  - if_none_match (str) – An ETag is specified. Specify this header to perform the operation only if the resource’s ETag does not match the specified ETag.
  - if_modified_since (datetime) – Specify this header to perform the operation only if the resource has been modified since the specified date/time.
  - if_unmodified_since (datetime) – Specify this header to perform the operation only if the resource has not been modified since the specified date/time.

class `azure.batch.models.``PoolPatchOptions`(timeout=30, client_request_id=None, return_client_request_id=None, ocp_date=None, if_match=None, if_none_match=None, if_modified_since=None, if_unmodified_since=None)

  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 identifier in the response.
  - ocp_date (datetime) – The time the request was issued. If not specified, this header will be automatically populated with the current system clock time.
  - if_match (str) – An ETag is specified. Specify this header to perform the operation only if the resource’s ETag is an exact match as specified.
  - if_none_match (str) – An ETag is specified. Specify this header to perform the operation only if the resource’s ETag does not match the specified ETag.
  - if_modified_since (datetime) – Specify this header to perform the operation only if the resource has been modified since the specified date/time.
  - if_unmodified_since (datetime) – Specify this header to perform the operation only if the resource has not been modified since the specified date/time.

class `azure.batch.models.``PoolDisableAutoScaleOptions`(timeout=30, client_request_id=None, return_client_request_id=None, ocp_date=None)

  Bases: `msrest.serialization.Model`

  Additional parameters for the Pool_DisableAutoScale 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 identifier in the response.
  - ocp_date (datetime) – The time the request was issued. If not specified, this header will be automatically populated with the current system clock time.

class `azure.batch.models.``PoolEnableAutoScaleOptions`(timeout=30, client_request_id=None, return_client_request_id=None, ocp_date=None, if_match=None, if_none_match=None, if_modified_since=None, if_unmodified_since=None)

  Bases: `msrest.serialization.Model`

  Additional parameters for the Pool_EnableAutoScale 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 identifier in the response.
  - ocp_date (datetime) – The time the request was issued. If not specified, this header will be automatically populated with the current system clock time.
  - if_match (str) – An ETag is specified. Specify this header to perform the operation only if the resource’s ETag is an exact match as specified.
  - if_none_match (str) – An ETag is specified. Specify this header to perform the operation only if the resource’s ETag does not match the specified ETag.
  - if_modified_since (datetime) – Specify this header to perform the operation only if the resource has been modified since the specified date/time.
  - if_unmodified_since (datetime) – Specify this header to perform the operation only if the resource has not been modified since the specified date/time.

class `azure.batch.models.``PoolEvaluateAutoScaleOptions`(timeout=30, client_request_id=None, return_client_request_id=None, ocp_date=None)

  Bases: `msrest.serialization.Model`

  Additional parameters for the Pool_EvaluateAutoScale 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 identifier in the response.
  - ocp_date (datetime) – The time the request was issued. If not specified, this header will be automatically populated with the current system clock time.

class `azure.batch.models.``PoolResizeOptions`(timeout=30, client_request_id=None, return_client_request_id=None, ocp_date=None, if_match=None, if_none_match=None, if_modified_since=None, if_unmodified_since=None)

  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 identifier in the response.
  - ocp_date (datetime) – The time the request was issued. If not specified, this header will be automatically populated with the current system clock time.
  - if_match (str) – An ETag is specified. Specify this header to perform the operation only if the resource’s ETag is an exact match as specified.
  - if_none_match (str) – An ETag is specified. Specify this header to perform the operation only if the resource’s ETag does not match the specified ETag.
  - if_modified_since (datetime) – Specify this header to perform the operation only if the resource has been modified since the specified date/time.
  - if_unmodified_since (datetime) – Specify this header to perform the operation only if the resource has not been modified since the specified date/time.

class `azure.batch.models.``PoolStopResizeOptions`(timeout=30, client_request_id=None, return_client_request_id=None, ocp_date=None, if_match=None, if_none_match=None, if_modified_since=None, if_unmodified_since=None)

  Bases: `msrest.serialization.Model`

  Additional parameters for the Pool_StopResize 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 identifier in the response.
  - ocp_date (datetime) – The time the request was issued. If not specified, this header will be automatically populated with the current system clock time.
  - if_match (str) – An ETag is specified. Specify this header to perform the operation only if the resource’s ETag is an exact match as specified.
  - if_none_match (str) – An ETag is specified. Specify this header to perform the operation only if the resource’s ETag does not match the specified ETag.
  - if_modified_since (datetime) – Specify this header to perform the operation only if the resource has been modified since the specified date/time.
  - if_unmodified_since (datetime) – Specify this header to perform the operation only if the resource has not been modified since the specified date/time.

class `azure.batch.models.``PoolUpdatePropertiesOptions`(timeout=30, client_request_id=None, return_client_request_id=None, ocp_date=None)

  Bases: `msrest.serialization.Model`

  Additional parameters for the Pool_UpdateProperties 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 identifier in the response.
  - ocp_date (datetime) – The time the request was issued. If not specified, this header will be automatically populated with the current system clock time.

class `azure.batch.models.``PoolUpgradeOSOptions`(timeout=30, client_request_id=None, return_client_request_id=None, ocp_date=None, if_match=None, if_none_match=None, if_modified_since=None, if_unmodified_since=None)

  Bases: `msrest.serialization.Model`

  Additional parameters for the Pool_UpgradeOS 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 identifier in the response.
  - ocp_date (datetime) – The time the request was issued. If not specified, this header will be automatically populated with the current system clock time.
  - if_match (str) – An ETag is specified. Specify this header to perform the operation only if the resource’s ETag is an exact match as specified.
  - if_none_match (str) – An ETag is specified. Specify this header to perform the operation only if the resource’s ETag does not match the specified ETag.
  - if_modified_since (datetime) – Specify this header to perform the operation only if the resource has been modified since the specified date/time.
  - if_unmodified_since (datetime) – Specify this header to perform the operation only if the resource has not been modified since the specified date/time.

class `azure.batch.models.``PoolRemoveNodesOptions`(timeout=30, client_request_id=None, return_client_request_id=None, ocp_date=None, if_match=None, if_none_match=None, if_modified_since=None, if_unmodified_since=None)

  Bases: `msrest.serialization.Model`

  Additional parameters for the Pool_RemoveNodes 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 identifier in the response.
  - ocp_date (datetime) – The time the request was issued. If not specified, this header will be automatically populated with the current system clock time.
  - if_match (str) – An ETag is specified. Specify this header to perform the operation only if the resource’s ETag is an exact match as specified.
  - if_none_match (str) – An ETag is specified. Specify this header to perform the operation only if the resource’s ETag does not match the specified ETag.
  - if_modified_since (datetime) – Specify this header to perform the operation only if the resource has been modified since the specified date/time.
  - if_unmodified_since (datetime) – Specify this header to perform the operation only if the resource has not been modified since the specified date/time.

class `azure.batch.models.``TaskAddOptions`(timeout=30, client_request_id=None, return_client_request_id=None, ocp_date=None)

  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 identifier in the response.
  - ocp_date (datetime) – The time the request was issued. If not specified, this header will be automatically populated with the current system clock time.

class `azure.batch.models.``TaskListOptions`(filter=None, select=None, expand=None, max_results=None, timeout=30, client_request_id=None, return_client_request_id=None, ocp_date=None)

  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.
  - 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 identifier in the response.
  - ocp_date (datetime) – The time the request was issued. If not specified, this header will be automatically populated with the current system clock time.

class `azure.batch.models.``TaskAddCollectionOptions`(timeout=30, client_request_id=None, return_client_request_id=None, ocp_date=None)

  Bases: `msrest.serialization.Model`

  Additional parameters for the Task_AddCollection 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 identifier in the response.
  - ocp_date (datetime) – The time the request was issued. If not specified, this header will be automatically populated with the current system clock time.

class `azure.batch.models.``TaskDeleteOptions`(timeout=30, client_request_id=None, return_client_request_id=None, ocp_date=None, if_match=None, if_none_match=None, if_modified_since=None, if_unmodified_since=None)

  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 identifier in the response.
  - ocp_date (datetime) – The time the request was issued. If not specified, this header will be automatically populated with the current system clock time.
  - if_match (str) – An ETag is specified. Specify this header to perform the operation only if the resource’s ETag is an exact match as specified.
  - if_none_match (str) – An ETag is specified. Specify this header to perform the operation only if the resource’s ETag does not match the specified ETag.
  - if_modified_since (datetime) – Specify this header to perform the operation only if the resource has been modified since the specified date/time.
  - if_unmodified_since (datetime) – Specify this header to perform the operation only if the resource has not been modified since the specified date/time.

class `azure.batch.models.``TaskGetOptions`(select=None, expand=None, timeout=30, client_request_id=None, return_client_request_id=None, ocp_date=None, if_match=None, if_none_match=None, if_modified_since=None, if_unmodified_since=None)

  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 identifier in the response.
  - ocp_date (datetime) – The time the request was issued. If not specified, this header will be automatically populated with the current system clock time.
  - if_match (str) – An ETag is specified. Specify this header to perform the operation only if the resource’s ETag is an exact match as specified.
  - if_none_match (str) – An ETag is specified. Specify this header to perform the operation only if the resource’s ETag does not match the specified ETag.
  - if_modified_since (datetime) – Specify this header to perform the operation only if the resource has been modified since the specified date/time.
  - if_unmodified_since (datetime) – Specify this header to perform the operation only if the resource has not been modified since the specified date/time.

class `azure.batch.models.``TaskUpdateOptions`(timeout=30, client_request_id=None, return_client_request_id=None, ocp_date=None, if_match=None, if_none_match=None, if_modified_since=None, if_unmodified_since=None)

  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 identifier in the response.
  - ocp_date (datetime) – The time the request was issued. If not specified, this header will be automatically populated with the current system clock time.
  - if_match (str) – An ETag is specified. Specify this header to perform the operation only if the resource’s ETag is an exact match as specified.
  - if_none_match (str) – An ETag is specified. Specify this header to perform the operation only if the resource’s ETag does not match the specified ETag.
  - if_modified_since (datetime) – Specify this header to perform the operation only if the resource has been modified since the specified date/time.
  - if_unmodified_since (datetime) – Specify this header to perform the operation only if the resource has not been modified since the specified date/time.

class `azure.batch.models.``TaskListSubtasksOptions`(select=None, timeout=30, client_request_id=None, return_client_request_id=None, ocp_date=None)

  Bases: `msrest.serialization.Model`

  Additional parameters for the Task_ListSubtasks 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 identifier in the response.
  - ocp_date (datetime) – The time the request was issued. If not specified, this header will be automatically populated with the current system clock time.

class `azure.batch.models.``TaskTerminateOptions`(timeout=30, client_request_id=None, return_client_request_id=None, ocp_date=None, if_match=None, if_none_match=None, if_modified_since=None, if_unmodified_since=None)

  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 identifier in the response.
  - ocp_date (datetime) – The time the request was issued. If not specified, this header will be automatically populated with the current system clock time.
  - if_match (str) – An ETag is specified. Specify this header to perform the operation only if the resource’s ETag is an exact match as specified.
  - if_none_match (str) – An ETag is specified. Specify this header to perform the operation only if the resource’s ETag does not match the specified ETag.
  - if_modified_since (datetime) – Specify this header to perform the operation only if the resource has been modified since the specified date/time.
  - if_unmodified_since (datetime) – Specify this header to perform the operation only if the resource has not been modified since the specified date/time.

class `azure.batch.models.``ComputeNodeAddUserOptions`(timeout=30, client_request_id=None, return_client_request_id=None, ocp_date=None)

  Bases: `msrest.serialization.Model`

  Additional parameters for the ComputeNode_AddUser 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 identifier in the response.
  - ocp_date (datetime) – The time the request was issued. If not specified, this header will be automatically populated with the current system clock time.

class `azure.batch.models.``ComputeNodeDeleteUserOptions`(timeout=30, client_request_id=None, return_client_request_id=None, ocp_date=None)

  Bases: `msrest.serialization.Model`

  Additional parameters for the ComputeNode_DeleteUser 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 identifier in the response.
  - ocp_date (datetime) – The time the request was issued. If not specified, this header will be automatically populated with the current system clock time.

class `azure.batch.models.``ComputeNodeUpdateUserOptions`(timeout=30, client_request_id=None, return_client_request_id=None, ocp_date=None)

  Bases: `msrest.serialization.Model`

  Additional parameters for the ComputeNode_UpdateUser 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 identifier in the response.
  - ocp_date (datetime) – The time the request was issued. If not specified, this header will be automatically populated with the current system clock time.

class `azure.batch.models.``ComputeNodeGetOptions`(select=None, timeout=30, client_request_id=None, return_client_request_id=None, ocp_date=None)

  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 identifier in the response.
  - ocp_date (datetime) – The time the request was issued. If not specified, this header will be automatically populated with the current system clock time.

class `azure.batch.models.``ComputeNodeRebootOptions`(timeout=30, client_request_id=None, return_client_request_id=None, ocp_date=None)

  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 identifier in the response.
  - ocp_date (datetime) – The time the request was issued. If not specified, this header will be automatically populated with the current system clock time.

class `azure.batch.models.``ComputeNodeReimageOptions`(timeout=30, client_request_id=None, return_client_request_id=None, ocp_date=None)

  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 identifier in the response.
  - ocp_date (datetime) – The time the request was issued. If not specified, this header will be automatically populated with the current system clock time.

class `azure.batch.models.``ComputeNodeDisableSchedulingOptions`(timeout=30, client_request_id=None, return_client_request_id=None, ocp_date=None)

  Bases: `msrest.serialization.Model`

  Additional parameters for the ComputeNode_DisableScheduling 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 identifier in the response.
  - ocp_date (datetime) – The time the request was issued. If not specified, this header will be automatically populated with the current system clock time.

class `azure.batch.models.``ComputeNodeEnableSchedulingOptions`(timeout=30, client_request_id=None, return_client_request_id=None, ocp_date=None)

  Bases: `msrest.serialization.Model`

  Additional parameters for the ComputeNode_EnableScheduling 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 identifier in the response.
  - ocp_date (datetime) – The time the request was issued. If not specified, this header will be automatically populated with the current system clock time.

class `azure.batch.models.``ComputeNodeGetRemoteLoginSettingsOptions`(timeout=30, client_request_id=None, return_client_request_id=None, ocp_date=None)

  Bases: `msrest.serialization.Model`

  Additional parameters for the ComputeNode_GetRemoteLoginSettings 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 identifier in the response.
  - ocp_date (datetime) – The time the request was issued. If not specified, this header will be automatically populated with the current system clock time.

class `azure.batch.models.``ComputeNodeGetRemoteDesktopOptions`(timeout=30, client_request_id=None, return_client_request_id=None, ocp_date=None)

  Bases: `msrest.serialization.Model`

  Additional parameters for the ComputeNode_GetRemoteDesktop 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 identifier in the response.
  - ocp_date (datetime) – The time the request was issued. If not specified, this header will be automatically populated with the current system clock time.

class `azure.batch.models.``ComputeNodeListOptions`(filter=None, select=None, max_results=None, timeout=30, client_request_id=None, return_client_request_id=None, ocp_date=None)

  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.
  - 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 identifier in the response.
  - ocp_date (datetime) – The time the request was issued. If not specified, this header will be automatically populated with the current system clock time.

class `azure.batch.models.``ApplicationSummaryPaged`(*args, **kwargs)

  Bases: `msrest.paging.Paged`

  A paging container for iterating over a list of ApplicationSummary object

class `azure.batch.models.``PoolUsageMetricsPaged`(*args, **kwargs)

  Bases: `msrest.paging.Paged`

  A paging container for iterating over a list of PoolUsageMetrics object

class `azure.batch.models.``NodeAgentSkuPaged`(*args, **kwargs)

  Bases: `msrest.paging.Paged`

  A paging container for iterating over a list of NodeAgentSku object

class `azure.batch.models.``CertificatePaged`(*args, **kwargs)

  Bases: `msrest.paging.Paged`

  A paging container for iterating over a list of Certificate object

class `azure.batch.models.``NodeFilePaged`(*args, **kwargs)

  Bases: `msrest.paging.Paged`

  A paging container for iterating over a list of NodeFile object

class `azure.batch.models.``CloudJobSchedulePaged`(*args, **kwargs)

  Bases: `msrest.paging.Paged`

  A paging container for iterating over a list of CloudJobSchedule object

class `azure.batch.models.``CloudJobPaged`(*args, **kwargs)

  Bases: `msrest.paging.Paged`

  A paging container for iterating over a list of CloudJob object

class `azure.batch.models.``JobPreparationAndReleaseTaskExecutionInformationPaged`(*args, **kwargs)

  Bases: `msrest.paging.Paged`

  A paging container for iterating over a list of JobPreparationAndReleaseTaskExecutionInformation object

class `azure.batch.models.``CloudPoolPaged`(*args, **kwargs)

  Bases: `msrest.paging.Paged`

  A paging container for iterating over a list of CloudPool object

class `azure.batch.models.``CloudTaskPaged`(*args, **kwargs)

  Bases: `msrest.paging.Paged`

  A paging container for iterating over a list of CloudTask object

class `azure.batch.models.``ComputeNodePaged`(*args, **kwargs)

  Bases: `msrest.paging.Paged`

  A paging container for iterating over a list of ComputeNode object

class `azure.batch.models.``OSType`

  Bases: `enum.Enum`

  `linux` = 'linux'
  `unmapped` = 'unmapped'
  `windows` = 'windows'

class `azure.batch.models.``CertificateState`

  Bases: `enum.Enum`

  `active` = 'active'
  `deletefailed` = 'deletefailed'
  `deleting` = 'deleting'

class `azure.batch.models.``CertificateFormat`

  Bases: `enum.Enum`

  `cer` = 'cer'
  `pfx` = 'pfx'
  `unmapped` = 'unmapped'

class `azure.batch.models.``JobAction`

  Bases: `enum.Enum`

  `disable` = 'disable'
  `none` = 'none'
  `terminate` = 'terminate'

class `azure.batch.models.``ComputeNodeFillType`

  Bases: `enum.Enum`

  `pack` = 'pack'
  `spread` = 'spread'
  `unmapped` = 'unmapped'

class `azure.batch.models.``CertificateStoreLocation`

  Bases: `enum.Enum`

  `currentuser` = 'currentuser'
  `localmachine` = 'localmachine'
  `unmapped` = 'unmapped'

class `azure.batch.models.``CertificateVisibility`

  Bases: `enum.Enum`

  `remoteuser` = 'remoteuser'
  `starttask` = 'starttask'
  `task` = 'task'
  `unmapped` = 'unmapped'

class `azure.batch.models.``PoolLifetimeOption`

  Bases: `enum.Enum`

  `job` = 'job'
  `jobschedule` = 'jobschedule'
  `unmapped` = 'unmapped'

class `azure.batch.models.``JobScheduleState`

  Bases: `enum.Enum`

  `active` = 'active'
  `completed` = 'completed'
  `deleting` = 'deleting'
  `disabled` = 'disabled'
  `terminating` = 'terminating'

class `azure.batch.models.``SchedulingErrorCategory`

  Bases: `enum.Enum`

  `servererror` = 'servererror'
  `unmapped` = 'unmapped'
  `usererror` = 'usererror'

class `azure.batch.models.``JobState`

  Bases: `enum.Enum`

  `active` = 'active'
  `completed` = 'completed'
  `deleting` = 'deleting'
  `disabled` = 'disabled'
  `disabling` = 'disabling'
  `enabling` = 'enabling'
  `terminating` = 'terminating'

class `azure.batch.models.``OnAllTasksComplete`

  Bases: `enum.Enum`

  `no_action` = 'noAction'
  `terminate_job` = 'terminateJob'

class `azure.batch.models.``OnTaskFailure`

  Bases: `enum.Enum`

  `no_action` = 'noAction'
  `perform_exit_options_job_action` = 'performExitOptionsJobAction'

class `azure.batch.models.``JobPreparationTaskState`

  Bases: `enum.Enum`

  `completed` = 'completed'
  `running` = 'running'

class `azure.batch.models.``JobReleaseTaskState`

  Bases: `enum.Enum`

  `completed` = 'completed'
  `running` = 'running'

class `azure.batch.models.``PoolState`

  Bases: `enum.Enum`

  `active` = 'active'
  `deleting` = 'deleting'
  `upgrading` = 'upgrading'

class `azure.batch.models.``AllocationState`

  Bases: `enum.Enum`

  `resizing` = 'resizing'
  `steady` = 'steady'
  `stopping` = 'stopping'

class `azure.batch.models.``TaskState`

  Bases: `enum.Enum`

  `active` = 'active'
  `completed` = 'completed'
  `preparing` = 'preparing'
  `running` = 'running'

class `azure.batch.models.``TaskAddStatus`

  Bases: `enum.Enum`

  `clienterror` = 'clienterror'
  `servererror` = 'servererror'
  `success` = 'success'
  `unmapped` = 'unmapped'

class `azure.batch.models.``StartTaskState`

  Bases: `enum.Enum`

  `completed` = 'completed'
  `running` = 'running'

class `azure.batch.models.``ComputeNodeState`

  Bases: `enum.Enum`

  `creating` = 'creating'
  `idle` = 'idle'
  `leavingpool` = 'leavingpool'
  `offline` = 'offline'
  `rebooting` = 'rebooting'
  `reimaging` = 'reimaging'
  `running` = 'running'
  `starting` = 'starting'
  `starttaskfailed` = 'starttaskfailed'
  `unknown` = 'unknown'
  `unusable` = 'unusable'
  `waitingforstarttask` = 'waitingforstarttask'

class `azure.batch.models.``SchedulingState`

  Bases: `enum.Enum`

  `disabled` = 'disabled'
  `enabled` = 'enabled'

class `azure.batch.models.``DisableJobOption`

  Bases: `enum.Enum`

  `requeue` = 'requeue'
  `terminate` = 'terminate'
  `wait` = 'wait'

class `azure.batch.models.``ComputeNodeDeallocationOption`

  Bases: `enum.Enum`

  `requeue` = 'requeue'
  `retaineddata` = 'retaineddata'
  `taskcompletion` = 'taskcompletion'
  `terminate` = 'terminate'

class `azure.batch.models.``ComputeNodeRebootOption`

  Bases: `enum.Enum`

  `requeue` = 'requeue'
  `retaineddata` = 'retaineddata'
  `taskcompletion` = 'taskcompletion'
  `terminate` = 'terminate'

class `azure.batch.models.``ComputeNodeReimageOption`

  Bases: `enum.Enum`

  `requeue` = 'requeue'
  `retaineddata` = 'retaineddata'
  `taskcompletion` = 'taskcompletion'
  `terminate` = 'terminate'

class `azure.batch.models.``DisableComputeNodeSchedulingOption`

  Bases: `enum.Enum`

  `requeue` = 'requeue'
  `taskcompletion` = 'taskcompletion'
  `terminate` = 'terminate'