diff --git a/azure-batch/azure/batch/__init__.py b/azure-batch/azure/batch/__init__.py old mode 100755 new mode 100644 diff --git a/azure-batch/azure/batch/batch_service_client.py b/azure-batch/azure/batch/batch_service_client.py old mode 100755 new mode 100644 diff --git a/azure-batch/azure/batch/models/__init__.py b/azure-batch/azure/batch/models/__init__.py old mode 100755 new mode 100644 diff --git a/azure-batch/azure/batch/models/account_list_node_agent_skus_options.py b/azure-batch/azure/batch/models/account_list_node_agent_skus_options.py old mode 100755 new mode 100644 diff --git a/azure-batch/azure/batch/models/affinity_information.py b/azure-batch/azure/batch/models/affinity_information.py old mode 100755 new mode 100644 index c8fdcff5dbf7..8b6fba3dfea8 --- a/azure-batch/azure/batch/models/affinity_information.py +++ b/azure-batch/azure/batch/models/affinity_information.py @@ -18,8 +18,10 @@ class AffinityInformation(Model): :param affinity_id: 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. + affinityId of a compute node to indicate that this task needs to run on + that compute node. Note that this is just a soft affinity. If the target + node is busy or unavailable at the time the task is scheduled, then the + task will be scheduled elsewhere. :type affinity_id: str """ diff --git a/azure-batch/azure/batch/models/application_get_options.py b/azure-batch/azure/batch/models/application_get_options.py old mode 100755 new mode 100644 diff --git a/azure-batch/azure/batch/models/application_list_options.py b/azure-batch/azure/batch/models/application_list_options.py old mode 100755 new mode 100644 diff --git a/azure-batch/azure/batch/models/application_package_reference.py b/azure-batch/azure/batch/models/application_package_reference.py old mode 100755 new mode 100644 index 6d154fb7d62b..f427be4de981 --- a/azure-batch/azure/batch/models/application_package_reference.py +++ b/azure-batch/azure/batch/models/application_package_reference.py @@ -18,10 +18,11 @@ class ApplicationPackageReference(Model): :param application_id: The ID of the application to deploy. :type application_id: str :param version: The version of the application to deploy. If omitted, the - default version is deployed. If this is omitted, and no default version is - specified for this application, the request fails with the error code - InvalidApplicationPackageReferences. If you are calling the REST API - directly, the HTTP status code is 409. + default version is deployed. If this is omitted on a pool, and no default + version is specified for this application, the request fails with the + error code InvalidApplicationPackageReferences and HTTP status code 409. + If this is omitted on a task, and no default version is specified for this + application, the task fails with a pre-processing error. :type version: str """ diff --git a/azure-batch/azure/batch/models/application_summary.py b/azure-batch/azure/batch/models/application_summary.py old mode 100755 new mode 100644 index 33bb4daa704a..9ec49d2214e9 --- a/azure-batch/azure/batch/models/application_summary.py +++ b/azure-batch/azure/batch/models/application_summary.py @@ -20,7 +20,7 @@ class ApplicationSummary(Model): :type id: str :param display_name: The display name for the application. :type display_name: str - :param versions: The versions of the application which are available. + :param versions: The list of available versions of the application. :type versions: list of str """ diff --git a/azure-batch/azure/batch/models/application_summary_paged.py b/azure-batch/azure/batch/models/application_summary_paged.py old mode 100755 new mode 100644 index 0c2f5ab50059..64ed9c6bdb85 --- a/azure-batch/azure/batch/models/application_summary_paged.py +++ b/azure-batch/azure/batch/models/application_summary_paged.py @@ -14,7 +14,7 @@ class ApplicationSummaryPaged(Paged): """ - A paging container for iterating over a list of ApplicationSummary object + A paging container for iterating over a list of :class:`ApplicationSummary ` object """ _attribute_map = { diff --git a/azure-batch/azure/batch/models/authentication_token_settings.py b/azure-batch/azure/batch/models/authentication_token_settings.py old mode 100755 new mode 100644 diff --git a/azure-batch/azure/batch/models/auto_pool_specification.py b/azure-batch/azure/batch/models/auto_pool_specification.py old mode 100755 new mode 100644 index 211aea12759b..81995f9791ff --- a/azure-batch/azure/batch/models/auto_pool_specification.py +++ b/azure-batch/azure/batch/models/auto_pool_specification.py @@ -20,15 +20,18 @@ class AutoPoolSpecification(Model): when a pool is automatically created. The Batch service assigns each auto pool a unique identifier on creation. To distinguish between pools created for different purposes, you can specify this element to add a prefix to - the id that is assigned. The prefix can be up to 20 characters long. + the ID that is assigned. The prefix can be up to 20 characters long. :type auto_pool_id_prefix: str :param pool_lifetime_option: The minimum lifetime of created auto pools, and how multiple jobs on a schedule are assigned to pools. When the pool - lifetime scope is jobSchedule level, the Batch service keeps track of the - last autopool created for the job schedule, and deletes that pool when the - job schedule completes. Batch will also delete this pool if the user - updates the auto pool specification in a way that changes this lifetime. - Possible values include: 'jobSchedule', 'job' + lifetime is jobSchedule the pool exists for the lifetime of the job + schedule. The Batch Service creates the pool when it creates the first job + on the schedule. You may apply this option only to job schedules, not to + jobs. When the pool lifetime is job the pool exists for the lifetime of + the job to which it is dedicated. The Batch service creates the pool when + it creates the job. If the 'job' option is applied to a job schedule, the + Batch service creates a new auto pool for every job created on the + schedule. Possible values include: 'jobSchedule', 'job' :type pool_lifetime_option: str or :class:`PoolLifetimeOption ` :param keep_alive: Whether to keep an auto pool alive after its lifetime diff --git a/azure-batch/azure/batch/models/auto_scale_run.py b/azure-batch/azure/batch/models/auto_scale_run.py old mode 100755 new mode 100644 diff --git a/azure-batch/azure/batch/models/auto_scale_run_error.py b/azure-batch/azure/batch/models/auto_scale_run_error.py old mode 100755 new mode 100644 diff --git a/azure-batch/azure/batch/models/auto_user_specification.py b/azure-batch/azure/batch/models/auto_user_specification.py old mode 100755 new mode 100644 index c752ed392248..e18bed83edb9 --- a/azure-batch/azure/batch/models/auto_user_specification.py +++ b/azure-batch/azure/batch/models/auto_user_specification.py @@ -16,10 +16,11 @@ class AutoUserSpecification(Model): """Specifies the parameters for the auto user that runs a task on the Batch service. - :param scope: The scope for the auto user. pool - specifies that the task - runs as the common auto user account which is created on every node in a - pool. task - specifies that the service should create a new user for the - task. The default value is task. Possible values include: 'task', 'pool' + :param scope: The scope for the auto user. Values are: + pool - specifies that the task runs as the common auto user account which + is created on every node in a pool. + task - specifies that the service should create a new user for the task. + The default value is task. Possible values include: 'task', 'pool' :type scope: str or :class:`AutoUserScope ` :param elevation_level: The elevation level of the auto user. nonAdmin - diff --git a/azure-batch/azure/batch/models/batch_error.py b/azure-batch/azure/batch/models/batch_error.py old mode 100755 new mode 100644 diff --git a/azure-batch/azure/batch/models/batch_error_detail.py b/azure-batch/azure/batch/models/batch_error_detail.py old mode 100755 new mode 100644 diff --git a/azure-batch/azure/batch/models/batch_service_client_enums.py b/azure-batch/azure/batch/models/batch_service_client_enums.py old mode 100755 new mode 100644 diff --git a/azure-batch/azure/batch/models/certificate.py b/azure-batch/azure/batch/models/certificate.py old mode 100755 new mode 100644 diff --git a/azure-batch/azure/batch/models/certificate_add_options.py b/azure-batch/azure/batch/models/certificate_add_options.py old mode 100755 new mode 100644 diff --git a/azure-batch/azure/batch/models/certificate_add_parameter.py b/azure-batch/azure/batch/models/certificate_add_parameter.py old mode 100755 new mode 100644 diff --git a/azure-batch/azure/batch/models/certificate_cancel_deletion_options.py b/azure-batch/azure/batch/models/certificate_cancel_deletion_options.py old mode 100755 new mode 100644 diff --git a/azure-batch/azure/batch/models/certificate_delete_options.py b/azure-batch/azure/batch/models/certificate_delete_options.py old mode 100755 new mode 100644 diff --git a/azure-batch/azure/batch/models/certificate_get_options.py b/azure-batch/azure/batch/models/certificate_get_options.py old mode 100755 new mode 100644 diff --git a/azure-batch/azure/batch/models/certificate_list_options.py b/azure-batch/azure/batch/models/certificate_list_options.py old mode 100755 new mode 100644 diff --git a/azure-batch/azure/batch/models/certificate_paged.py b/azure-batch/azure/batch/models/certificate_paged.py old mode 100755 new mode 100644 index e08bf4158a1d..985d7838de29 --- a/azure-batch/azure/batch/models/certificate_paged.py +++ b/azure-batch/azure/batch/models/certificate_paged.py @@ -14,7 +14,7 @@ class CertificatePaged(Paged): """ - A paging container for iterating over a list of Certificate object + A paging container for iterating over a list of :class:`Certificate ` object """ _attribute_map = { diff --git a/azure-batch/azure/batch/models/certificate_reference.py b/azure-batch/azure/batch/models/certificate_reference.py old mode 100755 new mode 100644 index 125927285c43..8632514b9b0a --- a/azure-batch/azure/batch/models/certificate_reference.py +++ b/azure-batch/azure/batch/models/certificate_reference.py @@ -34,14 +34,20 @@ class CertificateReference(Model): :type store_location: str or :class:`CertificateStoreLocation ` :param store_name: The name of the certificate store on the compute node - into which to install the certificate. The default value is My. This - property is applicable only for pools configured with Windows nodes (that - is, created with cloudServiceConfiguration, or with - virtualMachineConfiguration using a Windows image reference). + into which to install the certificate. This property is applicable only + for pools configured with Windows nodes (that is, created with + cloudServiceConfiguration, or with virtualMachineConfiguration using a + Windows image reference). Common store names include: My, Root, CA, Trust, + Disallowed, TrustedPeople, TrustedPublisher, AuthRoot, AddressBook, but + any custom store name can also be used. The default value is My. :type store_name: str :param visibility: Which user accounts on the compute node should have - access to the private data of the certificate. The default is all - accounts. + access to the private data of the certificate. Values are: + starttask - The user account under which the start task is run. + task - The accounts under which job tasks are run. + remoteuser - The accounts under which users remotely access the node. + You can specify more than one visibility in this collection. The default + is all accounts. :type visibility: list of str or :class:`CertificateVisibility ` """ diff --git a/azure-batch/azure/batch/models/cloud_job.py b/azure-batch/azure/batch/models/cloud_job.py old mode 100755 new mode 100644 index cbec37372a86..e977c736b53e --- a/azure-batch/azure/batch/models/cloud_job.py +++ b/azure-batch/azure/batch/models/cloud_job.py @@ -16,14 +16,13 @@ class CloudJob(Model): """An Azure Batch job. :param id: 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. + The ID is case-preserving and case-insensitive (that is, you may not have + two IDs within an account that differ only by case). :type id: str :param display_name: The display name for the job. :type display_name: str - :param uses_task_dependencies: The flag that determines if this job will - use tasks with dependencies. + :param uses_task_dependencies: Whether tasks in the job can define + dependencies on each other. The default is false. :type uses_task_dependencies: bool :param url: The URL of the job. :type url: str @@ -80,7 +79,8 @@ class CloudJob(Model): :param common_environment_settings: 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). + tasks). Individual tasks can override an environment setting specified + here by specifying the same setting name with a different value. :type common_environment_settings: list of :class:`EnvironmentSetting ` :param pool_info: The pool settings associated with the job. @@ -95,13 +95,15 @@ class CloudJob(Model): :type on_all_tasks_complete: str or :class:`OnAllTasksComplete ` :param on_task_failure: The action the Batch service should take when any - task in the job fails. A task is considered to have failed if it completes - with a non-zero exit code and has exhausted its retry count, or if it had - a scheduling error. noAction - do nothing. performExitOptionsJobAction - - take the action associated with the task exit condition in the task's - exitConditions collection. (This may still result in no action being - taken, if that is what the task specifies.) The default is noAction. - Possible values include: 'noAction', 'performExitOptionsJobAction' + task in the job fails. A task is considered to have failed if has a + failureInfo. A failureInfo is set if the task completes with a non-zero + exit code after exhausting its retry count, or if there was an error + starting the task, for example due to a resource file download error. + noAction - do nothing. performExitOptionsJobAction - take the action + associated with the task exit condition in the task's exitConditions + collection. (This may still result in no action being taken, if that is + what the task specifies.) The default is noAction. Possible values + include: 'noAction', 'performExitOptionsJobAction' :type on_task_failure: str or :class:`OnTaskFailure ` :param metadata: A list of name-value pairs associated with the job as diff --git a/azure-batch/azure/batch/models/cloud_job_paged.py b/azure-batch/azure/batch/models/cloud_job_paged.py old mode 100755 new mode 100644 index 9a4560db336c..c642458fc4bc --- a/azure-batch/azure/batch/models/cloud_job_paged.py +++ b/azure-batch/azure/batch/models/cloud_job_paged.py @@ -14,7 +14,7 @@ class CloudJobPaged(Paged): """ - A paging container for iterating over a list of CloudJob object + A paging container for iterating over a list of :class:`CloudJob ` object """ _attribute_map = { diff --git a/azure-batch/azure/batch/models/cloud_job_schedule.py b/azure-batch/azure/batch/models/cloud_job_schedule.py old mode 100755 new mode 100644 index affd5999284f..fba2183228bc --- a/azure-batch/azure/batch/models/cloud_job_schedule.py +++ b/azure-batch/azure/batch/models/cloud_job_schedule.py @@ -17,7 +17,7 @@ class CloudJobSchedule(Model): and a specification used to create each job. :param id: A string that uniquely identifies the schedule within the - account. It is common to use a GUID for the id. + account. :type id: str :param display_name: The display name for the schedule. :type display_name: str diff --git a/azure-batch/azure/batch/models/cloud_job_schedule_paged.py b/azure-batch/azure/batch/models/cloud_job_schedule_paged.py old mode 100755 new mode 100644 index 9c1dce130f6e..3abb6f155b10 --- a/azure-batch/azure/batch/models/cloud_job_schedule_paged.py +++ b/azure-batch/azure/batch/models/cloud_job_schedule_paged.py @@ -14,7 +14,7 @@ class CloudJobSchedulePaged(Paged): """ - A paging container for iterating over a list of CloudJobSchedule object + A paging container for iterating over a list of :class:`CloudJobSchedule ` object """ _attribute_map = { diff --git a/azure-batch/azure/batch/models/cloud_pool.py b/azure-batch/azure/batch/models/cloud_pool.py old mode 100755 new mode 100644 index 3dd6a1e49b1e..0733ef01d75a --- a/azure-batch/azure/batch/models/cloud_pool.py +++ b/azure-batch/azure/batch/models/cloud_pool.py @@ -17,8 +17,9 @@ class CloudPool(Model): :param id: 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. + hyphens and underscores, and cannot contain more than 64 characters. The + ID is case-preserving and case-insensitive (that is, you may not have two + IDs within an account that differ only by case). :type id: str :param display_name: The display name for the pool. The display name need not be unique and can contain any Unicode characters up to a maximum @@ -39,28 +40,30 @@ class CloudPool(Model): :type last_modified: datetime :param creation_time: The creation time of the pool. :type creation_time: datetime - :param state: The current state of the pool. active - The pool is - available to run tasks subject to the availability of compute nodes. + :param state: The current state of the pool. Values are: + active - The pool is available to run tasks subject to the availability of + compute nodes. deleting - The user has requested that the pool be deleted, but the delete - operation has not yet completed. upgrading - The user has requested that - the operating system of the pool's nodes be upgraded, but the upgrade - operation has not yet completed (that is, some nodes in the pool have not - yet been upgraded). While upgrading, the pool may be able to run tasks - (with reduced capacity) but this is not guaranteed. Possible values - include: 'active', 'deleting', 'upgrading' + operation has not yet completed. + upgrading - The user has requested that the operating system of the pool's + nodes be upgraded, but the upgrade operation has not yet completed (that + is, some nodes in the pool have not yet been upgraded). While upgrading, + the pool may be able to run tasks (with reduced capacity) but this is not + guaranteed. Possible values include: 'active', 'deleting', 'upgrading' :type state: str or :class:`PoolState ` :param state_transition_time: The time at which the pool entered its current state. :type state_transition_time: datetime - :param allocation_state: Whether the pool is resizing. steady - The pool - is not resizing. There are no changes to the number of nodes in the pool - in progress. A pool enters this state when it is created and when no - operations are being performed on the pool to change the number of - dedicated nodes. resizing - The pool is resizing; that is, compute nodes - are being added to or removed from the pool. stopping - The pool was - resizing, but the user has requested that the resize be stopped, but the - stop request has not yet been completed. Possible values include: - 'steady', 'resizing', 'stopping' + :param allocation_state: Whether the pool is resizing. Values are: + steady - The pool is not resizing. There are no changes to the number of + nodes in the pool in progress. A pool enters this state when it is created + and when no operations are being performed on the pool to change the + number of dedicated nodes. + resizing - The pool is resizing; that is, compute nodes are being added to + or removed from the pool. + stopping - The pool was resizing, but the user has requested that the + resize be stopped, but the stop request has not yet been completed. + Possible values include: 'steady', 'resizing', 'stopping' :type allocation_state: str or :class:`AllocationState ` :param allocation_state_transition_time: The time at which the pool @@ -173,8 +176,8 @@ class CloudPool(Model): :param max_tasks_per_node: The maximum number of tasks that can run concurrently on a single compute node in the pool. :type max_tasks_per_node: int - :param task_scheduling_policy: How the Batch service distributes tasks - between compute nodes in the pool. + :param task_scheduling_policy: How tasks are distributed across compute + nodes in a pool. :type task_scheduling_policy: :class:`TaskSchedulingPolicy ` :param user_accounts: The list of user accounts to be created on each node diff --git a/azure-batch/azure/batch/models/cloud_pool_paged.py b/azure-batch/azure/batch/models/cloud_pool_paged.py old mode 100755 new mode 100644 index ded9159b4374..c23eb7cdaa97 --- a/azure-batch/azure/batch/models/cloud_pool_paged.py +++ b/azure-batch/azure/batch/models/cloud_pool_paged.py @@ -14,7 +14,7 @@ class CloudPoolPaged(Paged): """ - A paging container for iterating over a list of CloudPool object + A paging container for iterating over a list of :class:`CloudPool ` object """ _attribute_map = { diff --git a/azure-batch/azure/batch/models/cloud_service_configuration.py b/azure-batch/azure/batch/models/cloud_service_configuration.py old mode 100755 new mode 100644 diff --git a/azure-batch/azure/batch/models/cloud_task.py b/azure-batch/azure/batch/models/cloud_task.py old mode 100755 new mode 100644 index 2bbcf0257b7b..1870f6950c18 --- a/azure-batch/azure/batch/models/cloud_task.py +++ b/azure-batch/azure/batch/models/cloud_task.py @@ -112,7 +112,12 @@ class CloudTask(Model): ` :param application_package_references: A list of application packages that the Batch service will deploy to the compute node before running the - command line. + command line. Application packages are downloaded and deployed to a shared + directory, not the task working directory. Therefore, if a referenced + package is already on the compute node, and is up to date, then it is not + re-downloaded; the existing copy on the compute node is used. If a + referenced application package cannot be installed, for example because + the package has been deleted or because download failed, the task fails. :type application_package_references: list of :class:`ApplicationPackageReference ` diff --git a/azure-batch/azure/batch/models/cloud_task_list_subtasks_result.py b/azure-batch/azure/batch/models/cloud_task_list_subtasks_result.py old mode 100755 new mode 100644 diff --git a/azure-batch/azure/batch/models/cloud_task_paged.py b/azure-batch/azure/batch/models/cloud_task_paged.py old mode 100755 new mode 100644 index 6531467baa57..3d8ef7740329 --- a/azure-batch/azure/batch/models/cloud_task_paged.py +++ b/azure-batch/azure/batch/models/cloud_task_paged.py @@ -14,7 +14,7 @@ class CloudTaskPaged(Paged): """ - A paging container for iterating over a list of CloudTask object + A paging container for iterating over a list of :class:`CloudTask ` object """ _attribute_map = { diff --git a/azure-batch/azure/batch/models/compute_node.py b/azure-batch/azure/batch/models/compute_node.py old mode 100755 new mode 100644 index a14a148dba6a..e2cca4a56c33 --- a/azure-batch/azure/batch/models/compute_node.py +++ b/azure-batch/azure/batch/models/compute_node.py @@ -22,17 +22,41 @@ class ComputeNode(Model): :type id: str :param url: The URL of the compute node. :type url: str - :param state: The current state of the compute node. Possible values - include: 'idle', 'rebooting', 'reimaging', 'running', 'unusable', - 'creating', 'starting', 'waitingForStartTask', 'startTaskFailed', - 'unknown', 'leavingPool', 'offline', 'preempted' + :param state: The current state of the compute node. Values are: + idle - The node is not currently running a task. + rebooting - The node is rebooting. + reimaging - The node is reimaging. + running - The node is running one or more tasks (other than a start task). + unusable - The node cannot be used for task execution due to errors. + creating - The Batch service has obtained the underlying virtual machine + from Azure Compute, but it has not yet started to join the pool. + starting - the Batch service is starting on the underlying virtual + machine. + waitingforstarttask - The start task has started running on the compute + node, but waitForSuccess is set and the start task has not yet completed. + starttaskfailed - The start task has failed on the compute node (and + exhausted all retries), and waitForSuccess is set. The node is not usable + for running tasks. + unknown - The Batch service has lost contact with the node, and does not + know its true state. + leavingpool - The node is leaving the pool, either because the user + explicitly removed it or because the pool is resizing or autoscaling down. + offline - The node is not currently running a task, and scheduling of new + tasks to the node is disabled. + preempted - The low-priority node has been preempted. Tasks which were + running on the node when it was pre-empted will be rescheduled when + another node becomes available. Possible values include: 'idle', + 'rebooting', 'reimaging', 'running', 'unusable', 'creating', 'starting', + 'waitingForStartTask', 'startTaskFailed', 'unknown', 'leavingPool', + 'offline', 'preempted' :type state: str or :class:`ComputeNodeState ` :param scheduling_state: Whether the compute node is available for task - scheduling. enabled - Tasks can be scheduled on the node. disabled - No - new tasks will be scheduled on the node. Tasks already running on the node - may still run to completion. All nodes start with scheduling enabled. - Possible values include: 'enabled', 'disabled' + scheduling. Values are: + enabled - Tasks can be scheduled on the node. + disabled - No new tasks will be scheduled on the node. Tasks already + running on the node may still run to completion. All nodes start with + scheduling enabled. Possible values include: 'enabled', 'disabled' :type scheduling_state: str or :class:`SchedulingState ` :param state_transition_time: The time at which the compute node entered @@ -51,7 +75,9 @@ class ComputeNode(Model): be reused for new nodes. :type ip_address: str :param affinity_id: An identifier which can be passed when adding a task - to request that the task be scheduled close to this compute node. + to request that the task be scheduled on this node. Note that this is just + a soft affinity. If the target node is busy or unavailable at the time the + task is scheduled, then the task will be scheduled elsewhere. :type affinity_id: str :param vm_size: The size of the virtual machine hosting the compute node. For information about available sizes of virtual machines for Cloud @@ -81,8 +107,9 @@ class ComputeNode(Model): includes Job Preparation, Job Release, and Job Manager tasks, but not the pool start task. :type total_tasks_succeeded: int - :param recent_tasks: The list of tasks that are currently running on the - compute node. + :param recent_tasks: A list of tasks whose state has recently changed. + This property is present only if at least one task has run on this node + since it was assigned to the pool. :type recent_tasks: list of :class:`TaskInformation ` :param start_task: The task specified to run on the compute node as it diff --git a/azure-batch/azure/batch/models/compute_node_add_user_options.py b/azure-batch/azure/batch/models/compute_node_add_user_options.py old mode 100755 new mode 100644 diff --git a/azure-batch/azure/batch/models/compute_node_delete_user_options.py b/azure-batch/azure/batch/models/compute_node_delete_user_options.py old mode 100755 new mode 100644 diff --git a/azure-batch/azure/batch/models/compute_node_disable_scheduling_options.py b/azure-batch/azure/batch/models/compute_node_disable_scheduling_options.py old mode 100755 new mode 100644 diff --git a/azure-batch/azure/batch/models/compute_node_enable_scheduling_options.py b/azure-batch/azure/batch/models/compute_node_enable_scheduling_options.py old mode 100755 new mode 100644 diff --git a/azure-batch/azure/batch/models/compute_node_error.py b/azure-batch/azure/batch/models/compute_node_error.py old mode 100755 new mode 100644 diff --git a/azure-batch/azure/batch/models/compute_node_get_options.py b/azure-batch/azure/batch/models/compute_node_get_options.py old mode 100755 new mode 100644 diff --git a/azure-batch/azure/batch/models/compute_node_get_remote_desktop_options.py b/azure-batch/azure/batch/models/compute_node_get_remote_desktop_options.py old mode 100755 new mode 100644 diff --git a/azure-batch/azure/batch/models/compute_node_get_remote_login_settings_options.py b/azure-batch/azure/batch/models/compute_node_get_remote_login_settings_options.py old mode 100755 new mode 100644 diff --git a/azure-batch/azure/batch/models/compute_node_get_remote_login_settings_result.py b/azure-batch/azure/batch/models/compute_node_get_remote_login_settings_result.py old mode 100755 new mode 100644 diff --git a/azure-batch/azure/batch/models/compute_node_information.py b/azure-batch/azure/batch/models/compute_node_information.py old mode 100755 new mode 100644 index 62585cc776c5..b94c417d8e65 --- a/azure-batch/azure/batch/models/compute_node_information.py +++ b/azure-batch/azure/batch/models/compute_node_information.py @@ -17,7 +17,7 @@ class ComputeNodeInformation(Model): :param affinity_id: 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. + scheduled on this compute node. :type affinity_id: str :param node_url: The URL of the node on which the task ran. . :type node_url: str diff --git a/azure-batch/azure/batch/models/compute_node_list_options.py b/azure-batch/azure/batch/models/compute_node_list_options.py old mode 100755 new mode 100644 diff --git a/azure-batch/azure/batch/models/compute_node_paged.py b/azure-batch/azure/batch/models/compute_node_paged.py old mode 100755 new mode 100644 index 7493af329ff0..26f41dcb7fcc --- a/azure-batch/azure/batch/models/compute_node_paged.py +++ b/azure-batch/azure/batch/models/compute_node_paged.py @@ -14,7 +14,7 @@ class ComputeNodePaged(Paged): """ - A paging container for iterating over a list of ComputeNode object + A paging container for iterating over a list of :class:`ComputeNode ` object """ _attribute_map = { diff --git a/azure-batch/azure/batch/models/compute_node_reboot_options.py b/azure-batch/azure/batch/models/compute_node_reboot_options.py old mode 100755 new mode 100644 diff --git a/azure-batch/azure/batch/models/compute_node_reimage_options.py b/azure-batch/azure/batch/models/compute_node_reimage_options.py old mode 100755 new mode 100644 diff --git a/azure-batch/azure/batch/models/compute_node_update_user_options.py b/azure-batch/azure/batch/models/compute_node_update_user_options.py old mode 100755 new mode 100644 diff --git a/azure-batch/azure/batch/models/compute_node_user.py b/azure-batch/azure/batch/models/compute_node_user.py old mode 100755 new mode 100644 diff --git a/azure-batch/azure/batch/models/delete_certificate_error.py b/azure-batch/azure/batch/models/delete_certificate_error.py old mode 100755 new mode 100644 diff --git a/azure-batch/azure/batch/models/environment_setting.py b/azure-batch/azure/batch/models/environment_setting.py old mode 100755 new mode 100644 diff --git a/azure-batch/azure/batch/models/error_message.py b/azure-batch/azure/batch/models/error_message.py old mode 100755 new mode 100644 diff --git a/azure-batch/azure/batch/models/exit_code_mapping.py b/azure-batch/azure/batch/models/exit_code_mapping.py old mode 100755 new mode 100644 diff --git a/azure-batch/azure/batch/models/exit_code_range_mapping.py b/azure-batch/azure/batch/models/exit_code_range_mapping.py old mode 100755 new mode 100644 diff --git a/azure-batch/azure/batch/models/exit_conditions.py b/azure-batch/azure/batch/models/exit_conditions.py old mode 100755 new mode 100644 diff --git a/azure-batch/azure/batch/models/exit_options.py b/azure-batch/azure/batch/models/exit_options.py old mode 100755 new mode 100644 index 8d934719d3b5..825ee5a94d93 --- a/azure-batch/azure/batch/models/exit_options.py +++ b/azure-batch/azure/batch/models/exit_options.py @@ -17,22 +17,29 @@ class ExitOptions(Model): :param job_action: An action to take on the job containing the task, if the task completes with the given exit condition and the job's - onTaskFailed property is 'performExitOptionsJobAction'. The default is - none for exit code 0 and terminate for all other exit conditions. If the - job's onTaskFailed property is noAction, then specify this property - returns an error. The add task request fails with an invalid property - value error;; if you are calling the REST API directly, the HTTP status - code is 400 (Bad Request). Possible values include: 'none', 'disable', - 'terminate' + onTaskFailed property is 'performExitOptionsJobAction'. Values are: + none - Take no action. + disable - Disable the job. This is equivalent to calling the disable job + API, with a disableTasks value of requeue. + terminate - Terminate the job. The terminateReason in the job's + executionInfo is set to "TaskFailed". The default is none for exit code 0 + and terminate for all other exit conditions. + If the job's onTaskFailed property is noAction, then specifying this + property returns an error and the add task request fails with an invalid + property value error; if you are calling the REST API directly, the HTTP + status code is 400 (Bad Request). Possible values include: 'none', + 'disable', 'terminate' :type job_action: str or :class:`JobAction ` :param dependency_action: An action that the Batch service performs on - tasks that depend on this task. The default is 'satisfy' for exit code 0, - and 'block' for all other exit conditions. If the job's - usesTaskDependencies property is set to false, then specifying the - dependencyAction property returns an error. The add task request fails - with an invalid property value error; if you are calling the REST API - directly, the HTTP status code is 400 (Bad Request). Possible values - include: 'satisfy', 'block' + tasks that depend on this task. Values are: + satisfy - Satisfy the task's dependencies. + block - Block the task's dependencies. + The default is 'satisfy' for exit code 0, and 'block' for all other exit + conditions. If the job's usesTaskDependencies property is set to false, + then specifying the dependencyAction property returns an erro and the add + task request fails with an invalid property value error; if you are + calling the REST API directly, the HTTP status code is 400 (Bad Request). + Possible values include: 'satisfy', 'block' :type dependency_action: str or :class:`DependencyAction ` """ diff --git a/azure-batch/azure/batch/models/file_delete_from_compute_node_options.py b/azure-batch/azure/batch/models/file_delete_from_compute_node_options.py old mode 100755 new mode 100644 diff --git a/azure-batch/azure/batch/models/file_delete_from_task_options.py b/azure-batch/azure/batch/models/file_delete_from_task_options.py old mode 100755 new mode 100644 diff --git a/azure-batch/azure/batch/models/file_get_from_compute_node_options.py b/azure-batch/azure/batch/models/file_get_from_compute_node_options.py old mode 100755 new mode 100644 diff --git a/azure-batch/azure/batch/models/file_get_from_task_options.py b/azure-batch/azure/batch/models/file_get_from_task_options.py old mode 100755 new mode 100644 diff --git a/azure-batch/azure/batch/models/file_get_properties_from_compute_node_options.py b/azure-batch/azure/batch/models/file_get_properties_from_compute_node_options.py old mode 100755 new mode 100644 diff --git a/azure-batch/azure/batch/models/file_get_properties_from_task_options.py b/azure-batch/azure/batch/models/file_get_properties_from_task_options.py old mode 100755 new mode 100644 diff --git a/azure-batch/azure/batch/models/file_list_from_compute_node_options.py b/azure-batch/azure/batch/models/file_list_from_compute_node_options.py old mode 100755 new mode 100644 diff --git a/azure-batch/azure/batch/models/file_list_from_task_options.py b/azure-batch/azure/batch/models/file_list_from_task_options.py old mode 100755 new mode 100644 diff --git a/azure-batch/azure/batch/models/file_properties.py b/azure-batch/azure/batch/models/file_properties.py old mode 100755 new mode 100644 diff --git a/azure-batch/azure/batch/models/image_reference.py b/azure-batch/azure/batch/models/image_reference.py old mode 100755 new mode 100644 diff --git a/azure-batch/azure/batch/models/job_add_options.py b/azure-batch/azure/batch/models/job_add_options.py old mode 100755 new mode 100644 diff --git a/azure-batch/azure/batch/models/job_add_parameter.py b/azure-batch/azure/batch/models/job_add_parameter.py old mode 100755 new mode 100644 index e2cf95bafa7d..8dd6d7da5e53 --- a/azure-batch/azure/batch/models/job_add_parameter.py +++ b/azure-batch/azure/batch/models/job_add_parameter.py @@ -17,8 +17,9 @@ class JobAddParameter(Model): :param id: 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. + hyphens and underscores, and cannot contain more than 64 characters. The + ID is case-preserving and case-insensitive (that is, you may not have two + IDs within an account that differ only by case). :type id: str :param display_name: The display name for the job. The display name need not be unique and can contain any Unicode characters up to a maximum @@ -63,7 +64,8 @@ class JobAddParameter(Model): :param common_environment_settings: 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). + tasks). Individual tasks can override an environment setting specified + here by specifying the same setting name with a different value. :type common_environment_settings: list of :class:`EnvironmentSetting ` :param pool_info: The pool on which the Batch service runs the job's @@ -84,13 +86,15 @@ class JobAddParameter(Model): :type on_all_tasks_complete: str or :class:`OnAllTasksComplete ` :param on_task_failure: The action the Batch service should take when any - task in the job fails. A task is considered to have failed if it completes - with a non-zero exit code and has exhausted its retry count, or if it had - a scheduling error. noAction - do nothing. performExitOptionsJobAction - - take the action associated with the task exit condition in the task's - exitConditions collection. (This may still result in no action being - taken, if that is what the task specifies.) The default is noAction. - Possible values include: 'noAction', 'performExitOptionsJobAction' + task in the job fails. A task is considered to have failed if has a + failureInfo. A failureInfo is set if the task completes with a non-zero + exit code after exhausting its retry count, or if there was an error + starting the task, for example due to a resource file download error. + noAction - do nothing. performExitOptionsJobAction - take the action + associated with the task exit condition in the task's exitConditions + collection. (This may still result in no action being taken, if that is + what the task specifies.) The default is noAction. Possible values + include: 'noAction', 'performExitOptionsJobAction' :type on_task_failure: str or :class:`OnTaskFailure ` :param metadata: A list of name-value pairs associated with the job as @@ -98,8 +102,8 @@ class JobAddParameter(Model): solely for the use of user code. :type metadata: list of :class:`MetadataItem ` - :param uses_task_dependencies: The flag that determines if this job will - use tasks with dependencies. + :param uses_task_dependencies: Whether tasks in the job can define + dependencies on each other. The default is false. :type uses_task_dependencies: bool """ diff --git a/azure-batch/azure/batch/models/job_constraints.py b/azure-batch/azure/batch/models/job_constraints.py old mode 100755 new mode 100644 diff --git a/azure-batch/azure/batch/models/job_delete_options.py b/azure-batch/azure/batch/models/job_delete_options.py old mode 100755 new mode 100644 diff --git a/azure-batch/azure/batch/models/job_disable_options.py b/azure-batch/azure/batch/models/job_disable_options.py old mode 100755 new mode 100644 diff --git a/azure-batch/azure/batch/models/job_disable_parameter.py b/azure-batch/azure/batch/models/job_disable_parameter.py old mode 100755 new mode 100644 index 527a4d307228..4b47e0b56573 --- a/azure-batch/azure/batch/models/job_disable_parameter.py +++ b/azure-batch/azure/batch/models/job_disable_parameter.py @@ -16,10 +16,12 @@ class JobDisableParameter(Model): """Options when disabling a job. :param disable_tasks: What to do with active tasks associated with the - job. requeue - Terminate running tasks and requeue them. The tasks will - run again when the job is enabled. terminate - Terminate running tasks. - The tasks will not run again. wait - Allow currently running tasks to - complete. Possible values include: 'requeue', 'terminate', 'wait' + job. Values are: + requeue - Terminate running tasks and requeue them. The tasks will run + again when the job is enabled. + terminate - Terminate running tasks. The tasks will not run again. + wait - Allow currently running tasks to complete. Possible values include: + 'requeue', 'terminate', 'wait' :type disable_tasks: str or :class:`DisableJobOption ` """ diff --git a/azure-batch/azure/batch/models/job_enable_options.py b/azure-batch/azure/batch/models/job_enable_options.py old mode 100755 new mode 100644 diff --git a/azure-batch/azure/batch/models/job_execution_information.py b/azure-batch/azure/batch/models/job_execution_information.py old mode 100755 new mode 100644 index 8a25998bcfb7..e782343d5e11 --- a/azure-batch/azure/batch/models/job_execution_information.py +++ b/azure-batch/azure/batch/models/job_execution_information.py @@ -28,7 +28,7 @@ class JobExecutionInformation(Model): contains the pool configuration data from when the job was added or updated. That poolInfo element may also contain a poolId element. If it does, the two IDs are the same. If it does not, it means the job ran on an - auto pool, and this property contains the id of that auto pool. + auto pool, and this property contains the ID of that auto pool. :type pool_id: str :param scheduling_error: Details of any error encountered by the service in starting the job. This property is not set if there was no error diff --git a/azure-batch/azure/batch/models/job_get_all_lifetime_statistics_options.py b/azure-batch/azure/batch/models/job_get_all_lifetime_statistics_options.py old mode 100755 new mode 100644 diff --git a/azure-batch/azure/batch/models/job_get_options.py b/azure-batch/azure/batch/models/job_get_options.py old mode 100755 new mode 100644 diff --git a/azure-batch/azure/batch/models/job_list_from_job_schedule_options.py b/azure-batch/azure/batch/models/job_list_from_job_schedule_options.py old mode 100755 new mode 100644 diff --git a/azure-batch/azure/batch/models/job_list_options.py b/azure-batch/azure/batch/models/job_list_options.py old mode 100755 new mode 100644 diff --git a/azure-batch/azure/batch/models/job_list_preparation_and_release_task_status_options.py b/azure-batch/azure/batch/models/job_list_preparation_and_release_task_status_options.py old mode 100755 new mode 100644 index ad62d561b3ed..0e6c46388eb8 --- a/azure-batch/azure/batch/models/job_list_preparation_and_release_task_status_options.py +++ b/azure-batch/azure/batch/models/job_list_preparation_and_release_task_status_options.py @@ -16,7 +16,9 @@ class JobListPreparationAndReleaseTaskStatusOptions(Model): """Additional parameters for the Job_list_preparation_and_release_task_status operation. - :param filter: An OData $filter clause. + :param filter: An OData $filter clause. To get the status of the Job + Preparation and Job Release tasks on a specific compute node, use "nodeId + eq '{desired-node-id}'" :type filter: str :param select: An OData $select clause. :type select: str diff --git a/azure-batch/azure/batch/models/job_manager_task.py b/azure-batch/azure/batch/models/job_manager_task.py old mode 100755 new mode 100644 index d4577165e7d6..d9c775e6cdca --- a/azure-batch/azure/batch/models/job_manager_task.py +++ b/azure-batch/azure/batch/models/job_manager_task.py @@ -15,8 +15,22 @@ class JobManagerTask(Model): """Specifies details of a Job Manager task. - :param id: A string that uniquely identifies the Job Manager taskwithin - the job. The id can contain any combination of alphanumeric characters + The Job Manager task is automatically started when the job is created. The + Batch service tries to schedule the Job Manager task before any other tasks + in the job. When shrinking a pool, the Batch service tries to preserve + compute nodes where Job Manager tasks are running for as long as possible + (that is, nodes running 'normal' tasks are removed before nodes running Job + Manager tasks). When a Job Manager task fails and needs to be restarted, + the system tries to schedule it at the highest priority. If there are no + idle nodes available, the system may terminate one of the running tasks in + the pool and return it to the queue in order to make room for the Job + Manager task to restart. Note that a Job Manager task in one job does not + have priority over tasks in other jobs. Across jobs, only job level + priorities are observed. For example, if a Job Manager in a priority 0 job + needs to be restarted, it will not displace tasks of a priority 1 job. + + :param id: A string that uniquely identifies the Job Manager task within + the job. The ID can contain any combination of alphanumeric characters including hyphens and underscores and cannot contain more than 64 characters. :type id: str @@ -37,7 +51,9 @@ class JobManagerTask(Model): :type resource_files: list of :class:`ResourceFile ` :param output_files: A list of files that the Batch service will upload - from the compute node after running the command line. + from the compute node after running the command line. For multi-instance + tasks, the files will only be uploaded from the compute node on which the + primary task is executed. :type output_files: list of :class:`OutputFile ` :param environment_settings: A list of environment variable settings for @@ -78,12 +94,11 @@ class JobManagerTask(Model): :param application_package_references: A list of application packages that the Batch service will deploy to the compute node before running the command line. Application packages are downloaded and deployed to a shared - directory, not the task directory. Therefore, if a referenced package is - already on the compute node, and is up to date, then it is not + directory, not the task working directory. Therefore, if a referenced + package is already on the compute node, and is up to date, then it is not re-downloaded; the existing copy on the compute node is used. If a referenced application package cannot be installed, for example because - the package has been deleted or because download failed, the task fails - with a scheduling error. + the package has been deleted or because download failed, the task fails. :type application_package_references: list of :class:`ApplicationPackageReference ` diff --git a/azure-batch/azure/batch/models/job_patch_options.py b/azure-batch/azure/batch/models/job_patch_options.py old mode 100755 new mode 100644 diff --git a/azure-batch/azure/batch/models/job_patch_parameter.py b/azure-batch/azure/batch/models/job_patch_parameter.py old mode 100755 new mode 100644 diff --git a/azure-batch/azure/batch/models/job_preparation_and_release_task_execution_information.py b/azure-batch/azure/batch/models/job_preparation_and_release_task_execution_information.py old mode 100755 new mode 100644 diff --git a/azure-batch/azure/batch/models/job_preparation_and_release_task_execution_information_paged.py b/azure-batch/azure/batch/models/job_preparation_and_release_task_execution_information_paged.py old mode 100755 new mode 100644 index 0f7d1524172e..f1f7d3c4d148 --- a/azure-batch/azure/batch/models/job_preparation_and_release_task_execution_information_paged.py +++ b/azure-batch/azure/batch/models/job_preparation_and_release_task_execution_information_paged.py @@ -14,7 +14,7 @@ class JobPreparationAndReleaseTaskExecutionInformationPaged(Paged): """ - A paging container for iterating over a list of JobPreparationAndReleaseTaskExecutionInformation object + A paging container for iterating over a list of :class:`JobPreparationAndReleaseTaskExecutionInformation ` object """ _attribute_map = { diff --git a/azure-batch/azure/batch/models/job_preparation_task.py b/azure-batch/azure/batch/models/job_preparation_task.py old mode 100755 new mode 100644 index 2cdc419c1d65..8abb7c4c2859 --- a/azure-batch/azure/batch/models/job_preparation_task.py +++ b/azure-batch/azure/batch/models/job_preparation_task.py @@ -16,12 +16,30 @@ class JobPreparationTask(Model): """A Job Preparation task to run before any tasks of the job on any given compute node. + You can use Job Preparation to prepare a compute node to run tasks for the + job. Activities commonly performed in Job Preparation include: Downloading + common resource files used by all the tasks in the job. The Job Preparation + task can download these common resource files to the shared location on the + compute node. (AZ_BATCH_NODE_ROOT_DIR\shared), or starting a local service + on the compute node so that all tasks of that job can communicate with it. + If the Job Preparation task fails (that is, exhausts its retry count before + exiting with exit code 0), Batch will not run tasks of this job on the + compute node. The node remains ineligible to run tasks of this job until it + is reimaged. The node remains active and can be used for other jobs. The + Job Preparation task can run multiple times on the same compute node. + Therefore, you should write the Job Preparation task to handle + re-execution. If the compute node is rebooted, the Job Preparation task is + run again on the node before scheduling any other task of the job, if + rerunOnNodeRebootAfterSuccess is true or if the Job Preparation task did + not previously complete. If the compute node is reimaged, the Job + Preparation task is run again before scheduling any task of the job. + :param id: A string that uniquely identifies the Job Preparation task within the job. The ID can contain any combination of alphanumeric characters including hyphens and underscores and cannot contain more than 64 characters. If you do not specify this property, the Batch service assigns a default value of 'jobpreparation'. No other task in the job can - have the same id as the Job Preparation task. If you try to submit a task + have the same ID as the Job Preparation task. If you try to submit a task with the same id, the Batch service rejects the request with error code TaskIdSameAsJobPreparationTask; if you are calling the REST API directly, the HTTP status code is 409 (Conflict). @@ -47,21 +65,23 @@ class JobPreparationTask(Model): ` :param wait_for_success: Whether the Batch service should wait for the Job Preparation task to complete successfully before scheduling any other - tasks of the job on the compute node. If true and the Job Preparation task - fails on a compute node, the Batch service retries the Job Preparation - task up to its maximum retry count (as specified in the constraints - element). If the task has still not completed successfully after all - retries, then the Batch service will not schedule tasks of the job to the - compute node. The compute node remains active and eligible to run tasks of - other jobs. If false, the Batch service will not wait for the Job - Preparation task to complete. In this case, other tasks of the job can + tasks of the job on the compute node. A Job Preparation task has completed + successfully if it exits with exit code 0. If true and the Job Preparation + task fails on a compute node, the Batch service retries the Job + Preparation task up to its maximum retry count (as specified in the + constraints element). If the task has still not completed successfully + after all retries, then the Batch service will not schedule tasks of the + job to the compute node. The compute node remains active and eligible to + run tasks of other jobs. If false, the Batch service will not wait for the + Job Preparation task to complete. In this case, other tasks of the job can start executing on the compute node while the Job Preparation task is still running; and even if the Job Preparation task fails, new tasks will continue to be scheduled on the node. The default value is true. :type wait_for_success: bool :param user_identity: The user identity under which the Job Preparation task runs. If omitted, the task runs as a non-administrative user unique - to the task. + to the task on Windows nodes, or a a non-administrative user unique to the + pool on Linux nodes. :type user_identity: :class:`UserIdentity ` :param rerun_on_node_reboot_after_success: Whether the Batch service diff --git a/azure-batch/azure/batch/models/job_preparation_task_execution_information.py b/azure-batch/azure/batch/models/job_preparation_task_execution_information.py old mode 100755 new mode 100644 index ef80af604057..7c8a22b3f461 --- a/azure-batch/azure/batch/models/job_preparation_task_execution_information.py +++ b/azure-batch/azure/batch/models/job_preparation_task_execution_information.py @@ -16,18 +16,20 @@ class JobPreparationTaskExecutionInformation(Model): """Contains information about the execution of a Job Preparation task on a compute node. - :param start_time: The time at which the task started running. Note that - every time the task is restarted, this value is updated. + :param start_time: 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. :type start_time: datetime :param end_time: The time at which the Job Preparation task completed. This property is set only if the task is in the Completed state. :type end_time: datetime :param state: The current state of the Job Preparation task on the compute - node. running - the task is currently running (including retrying). + node. Values are: + running - the task is currently running (including retrying). completed - the task has exited with exit code 0, or the task has exhausted its retry limit, or the Batch service was unable to start the - task due to scheduling errors. Possible values include: 'running', - 'completed' + task due to task preparation errors (such as resource file download + failures). Possible values include: 'running', 'completed' :type state: str or :class:`JobPreparationTaskState ` :param task_root_directory: The root directory of the Job Preparation task @@ -55,7 +57,10 @@ class JobPreparationTaskExecutionInformation(Model): Batch service. Task application failures (non-zero exit code) are retried, pre-processing errors (the task could not be run) and file upload errors are not retried. The Batch service will retry the task up to the limit - specified by the constraints. + specified by the constraints. Task application failures (non-zero exit + code) are retried, pre-processing errors (the task could not be run) and + file upload errors are not retried. The Batch service will retry the task + up to the limit specified by the constraints. :type retry_count: int :param last_retry_time: The most recent time at which a retry of the Job Preparation task started running. This property is set only if the task diff --git a/azure-batch/azure/batch/models/job_release_task.py b/azure-batch/azure/batch/models/job_release_task.py old mode 100755 new mode 100644 index 89f19849c397..0e6cc9e81926 --- a/azure-batch/azure/batch/models/job_release_task.py +++ b/azure-batch/azure/batch/models/job_release_task.py @@ -16,12 +16,29 @@ class JobReleaseTask(Model): """A Job Release task to run on job completion on any compute node where the job has run. + The Job Release task runs when the job ends, because of one of the + following: The user calls the Terminate Job API, or the Delete Job API + while the job is still active, the job's maximum wall clock time constraint + is reached, and the job is still active, or the job's Job Manager task + completed, and the job is configured to terminate when the Job Manager + completes. The Job Release task runs on each compute node where tasks of + the job have run and the Job Preparation task ran and completed. If you + reimage a compute node after it has run the Job Preparation task, and the + job ends without any further tasks of the job running on that compute node + (and hence the Job Preparation task does not re-run), then the Job Release + task does not run on that node. If a compute node reboots while the Job + Release task is still running, the Job Release task runs again when the + compute node starts up. The job is not marked as complete until all Job + Release tasks have completed. The Job Release task runs in the background. + It does not occupy a scheduling slot; that is, it does not count towards + the maxTasksPerNode limit specified on the pool. + :param id: A string that uniquely identifies the Job Release task within the job. The ID can contain any combination of alphanumeric characters including hyphens and underscores and cannot contain more than 64 characters. If you do not specify this property, the Batch service assigns a default value of 'jobrelease'. No other task in the job can have the - same id as the Job Release task. If you try to submit a task with the same + same ID as the Job Release task. If you try to submit a task with the same id, the Batch service rejects the request with error code TaskIdSameAsJobReleaseTask; if you are calling the REST API directly, the HTTP status code is 409 (Conflict). diff --git a/azure-batch/azure/batch/models/job_release_task_execution_information.py b/azure-batch/azure/batch/models/job_release_task_execution_information.py old mode 100755 new mode 100644 index 31a963f11a06..c4fca299eb87 --- a/azure-batch/azure/batch/models/job_release_task_execution_information.py +++ b/azure-batch/azure/batch/models/job_release_task_execution_information.py @@ -16,17 +16,19 @@ class JobReleaseTaskExecutionInformation(Model): """Contains information about the execution of a Job Release task on a compute node. - :param start_time: The time at which the task started running. Note that - every time the task is restarted, this value is updated. + :param start_time: 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. :type start_time: datetime :param end_time: The time at which the Job Release task completed. This property is set only if the task is in the Completed state. :type end_time: datetime :param state: The current state of the Job Release task on the compute - node. running - the task is currently running (including retrying). + node. Values are: + running - the task is currently running (including retrying). completed - the task has exited, or the Batch service was unable to start - the task due to scheduling errors. Possible values include: 'running', - 'completed' + the task due to task preparation errors (such as resource file download + failures). Possible values include: 'running', 'completed' :type state: str or :class:`JobReleaseTaskState ` :param task_root_directory: The root directory of the Job Release task on diff --git a/azure-batch/azure/batch/models/job_schedule_add_options.py b/azure-batch/azure/batch/models/job_schedule_add_options.py old mode 100755 new mode 100644 diff --git a/azure-batch/azure/batch/models/job_schedule_add_parameter.py b/azure-batch/azure/batch/models/job_schedule_add_parameter.py old mode 100755 new mode 100644 index cdc679b40350..b81aefc80a1c --- a/azure-batch/azure/batch/models/job_schedule_add_parameter.py +++ b/azure-batch/azure/batch/models/job_schedule_add_parameter.py @@ -19,8 +19,8 @@ class JobScheduleAddParameter(Model): :param id: A string that uniquely identifies the schedule within the account. The ID can contain any combination of alphanumeric characters including hyphens and underscores, and cannot contain more than 64 - characters. The id is case-preserving and case-insensitive (that is, you - may not have two ids within an account that differ only by case). + characters. The ID is case-preserving and case-insensitive (that is, you + may not have two IDs within an account that differ only by case). :type id: str :param display_name: The display name for the schedule. The display name need not be unique and can contain any Unicode characters up to a maximum diff --git a/azure-batch/azure/batch/models/job_schedule_delete_options.py b/azure-batch/azure/batch/models/job_schedule_delete_options.py old mode 100755 new mode 100644 diff --git a/azure-batch/azure/batch/models/job_schedule_disable_options.py b/azure-batch/azure/batch/models/job_schedule_disable_options.py old mode 100755 new mode 100644 diff --git a/azure-batch/azure/batch/models/job_schedule_enable_options.py b/azure-batch/azure/batch/models/job_schedule_enable_options.py old mode 100755 new mode 100644 diff --git a/azure-batch/azure/batch/models/job_schedule_execution_information.py b/azure-batch/azure/batch/models/job_schedule_execution_information.py old mode 100755 new mode 100644 diff --git a/azure-batch/azure/batch/models/job_schedule_exists_options.py b/azure-batch/azure/batch/models/job_schedule_exists_options.py old mode 100755 new mode 100644 diff --git a/azure-batch/azure/batch/models/job_schedule_get_options.py b/azure-batch/azure/batch/models/job_schedule_get_options.py old mode 100755 new mode 100644 diff --git a/azure-batch/azure/batch/models/job_schedule_list_options.py b/azure-batch/azure/batch/models/job_schedule_list_options.py old mode 100755 new mode 100644 diff --git a/azure-batch/azure/batch/models/job_schedule_patch_options.py b/azure-batch/azure/batch/models/job_schedule_patch_options.py old mode 100755 new mode 100644 diff --git a/azure-batch/azure/batch/models/job_schedule_patch_parameter.py b/azure-batch/azure/batch/models/job_schedule_patch_parameter.py old mode 100755 new mode 100644 diff --git a/azure-batch/azure/batch/models/job_schedule_statistics.py b/azure-batch/azure/batch/models/job_schedule_statistics.py old mode 100755 new mode 100644 diff --git a/azure-batch/azure/batch/models/job_schedule_terminate_options.py b/azure-batch/azure/batch/models/job_schedule_terminate_options.py old mode 100755 new mode 100644 diff --git a/azure-batch/azure/batch/models/job_schedule_update_options.py b/azure-batch/azure/batch/models/job_schedule_update_options.py old mode 100755 new mode 100644 diff --git a/azure-batch/azure/batch/models/job_schedule_update_parameter.py b/azure-batch/azure/batch/models/job_schedule_update_parameter.py old mode 100755 new mode 100644 diff --git a/azure-batch/azure/batch/models/job_scheduling_error.py b/azure-batch/azure/batch/models/job_scheduling_error.py old mode 100755 new mode 100644 diff --git a/azure-batch/azure/batch/models/job_specification.py b/azure-batch/azure/batch/models/job_specification.py old mode 100755 new mode 100644 index f3afa32e6092..16c325db41e9 --- a/azure-batch/azure/batch/models/job_specification.py +++ b/azure-batch/azure/batch/models/job_specification.py @@ -26,8 +26,8 @@ class JobSpecification(Model): schedule. The name need not be unique and can contain any Unicode characters up to a maximum length of 1024. :type display_name: str - :param uses_task_dependencies: The flag that determines if this job will - use tasks with dependencies. + :param uses_task_dependencies: Whether tasks in the job can define + dependencies on each other. The default is false. :type uses_task_dependencies: bool :param on_all_tasks_complete: The action the Batch service should take when all tasks in a job created under this schedule are in the completed @@ -42,9 +42,11 @@ class JobSpecification(Model): ` :param on_task_failure: The action the Batch service should take when any task fails in a job created under this schedule. A task is considered to - have failed if it completes with a non-zero exit code and has exhausted - its retry count, or if it had a scheduling error. The default is noAction. - Possible values include: 'noAction', 'performExitOptionsJobAction' + have failed if it have failed if has a failureInfo. A failureInfo is set + if the task completes with a non-zero exit code after exhausting its retry + count, or if there was an error starting the task, for example due to a + resource file download error. The default is noAction. Possible values + include: 'noAction', 'performExitOptionsJobAction' :type on_task_failure: str or :class:`OnTaskFailure ` :param constraints: The execution constraints for jobs created under this diff --git a/azure-batch/azure/batch/models/job_statistics.py b/azure-batch/azure/batch/models/job_statistics.py old mode 100755 new mode 100644 index 6fecef78ba90..db563262604a --- a/azure-batch/azure/batch/models/job_statistics.py +++ b/azure-batch/azure/batch/models/job_statistics.py @@ -31,6 +31,10 @@ class JobStatistics(Model): cores and all compute nodes) consumed by all tasks in the job. :type kernel_cpu_time: timedelta :param wall_clock_time: The total wall clock time of all tasks in the job. + The wall clock time is the elapsed time from when the task started running + on a compute node to when it finished (or to the last time the statistics + were updated, if the task had not finished by then). If a task was + retried, this includes the wall clock time of all the task retries. :type wall_clock_time: timedelta :param read_iops: The total number of disk read operations made by all tasks in the job. diff --git a/azure-batch/azure/batch/models/job_terminate_options.py b/azure-batch/azure/batch/models/job_terminate_options.py old mode 100755 new mode 100644 diff --git a/azure-batch/azure/batch/models/job_terminate_parameter.py b/azure-batch/azure/batch/models/job_terminate_parameter.py old mode 100755 new mode 100644 diff --git a/azure-batch/azure/batch/models/job_update_options.py b/azure-batch/azure/batch/models/job_update_options.py old mode 100755 new mode 100644 diff --git a/azure-batch/azure/batch/models/job_update_parameter.py b/azure-batch/azure/batch/models/job_update_parameter.py old mode 100755 new mode 100644 index 9a139738ed82..e0126764cd12 --- a/azure-batch/azure/batch/models/job_update_parameter.py +++ b/azure-batch/azure/batch/models/job_update_parameter.py @@ -40,7 +40,13 @@ class JobUpdateParameter(Model): when all tasks in the job are in the completed state. If omitted, the completion behavior is set to noAction. If the current value is terminateJob, this is an error because a job's completion behavior may not - be changed from terminateJob to noAction. Possible values include: + be changed from terminateJob to noAction. You may not change the value + from terminatejob to noaction - that is, once you have engaged automatic + job termination, you cannot turn it off again. If you try to do this, the + request fails and Batch returns status code 400 (Bad Request) and an + 'invalid property value' error response. If you do not specify this + element in a PUT request, it is equivalent to passing noaction. This is an + error if the current value is terminatejob. Possible values include: 'noAction', 'terminateJob' :type on_all_tasks_complete: str or :class:`OnAllTasksComplete ` diff --git a/azure-batch/azure/batch/models/linux_user_configuration.py b/azure-batch/azure/batch/models/linux_user_configuration.py old mode 100755 new mode 100644 diff --git a/azure-batch/azure/batch/models/metadata_item.py b/azure-batch/azure/batch/models/metadata_item.py old mode 100755 new mode 100644 diff --git a/azure-batch/azure/batch/models/multi_instance_settings.py b/azure-batch/azure/batch/models/multi_instance_settings.py old mode 100755 new mode 100644 index d4553a7e3d60..f45fedc9199c --- a/azure-batch/azure/batch/models/multi_instance_settings.py +++ b/azure-batch/azure/batch/models/multi_instance_settings.py @@ -30,7 +30,10 @@ class MultiInstanceSettings(Model): 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. + whereas task resource files are downloaded only for the primary. Also note + that these resource files are not downloaded to the task working + directory, but instead are downloaded to the task root directory (one + directory above the working directory). :type common_resource_files: list of :class:`ResourceFile ` """ diff --git a/azure-batch/azure/batch/models/name_value_pair.py b/azure-batch/azure/batch/models/name_value_pair.py old mode 100755 new mode 100644 diff --git a/azure-batch/azure/batch/models/network_configuration.py b/azure-batch/azure/batch/models/network_configuration.py old mode 100755 new mode 100644 index f48d1a981d62..832571e57ca6 --- a/azure-batch/azure/batch/models/network_configuration.py +++ b/azure-batch/azure/batch/models/network_configuration.py @@ -32,7 +32,14 @@ class NetworkConfiguration(Model): denied by an NSG, then the Batch service will set the state of the compute nodes to unusable. For pools created via virtualMachineConfiguration the Batch account must have poolAllocationMode userSubscription in order to - use a VNet. + use a VNet. If the specified VNet has any associated Network Security + Groups (NSG), then a few reserved system ports must be enabled for inbound + communication. For pools created with a virtual machine configuration, + enable ports 29876 and 29877, as well as port 22 for Linux and port 3389 + for Windows. For pools created with a cloud service configuration, enable + ports 10100, 20100, and 30100. Also enable outbound connections to Azure + Storage on port 443. For more details see: + https://docs.microsoft.com/en-us/azure/batch/batch-api-basics#virtual-network-vnet-and-firewall-configuration :type subnet_id: str :param endpoint_configuration: The configuration for endpoints on compute nodes in the Batch pool. Pool endpoint configuration is only supported on diff --git a/azure-batch/azure/batch/models/node_agent_sku.py b/azure-batch/azure/batch/models/node_agent_sku.py old mode 100755 new mode 100644 diff --git a/azure-batch/azure/batch/models/node_agent_sku_paged.py b/azure-batch/azure/batch/models/node_agent_sku_paged.py old mode 100755 new mode 100644 index 1bd49f0a5933..020e753c2995 --- a/azure-batch/azure/batch/models/node_agent_sku_paged.py +++ b/azure-batch/azure/batch/models/node_agent_sku_paged.py @@ -14,7 +14,7 @@ class NodeAgentSkuPaged(Paged): """ - A paging container for iterating over a list of NodeAgentSku object + A paging container for iterating over a list of :class:`NodeAgentSku ` object """ _attribute_map = { diff --git a/azure-batch/azure/batch/models/node_disable_scheduling_parameter.py b/azure-batch/azure/batch/models/node_disable_scheduling_parameter.py old mode 100755 new mode 100644 index 7a9982b9bdfe..75e4613191c0 --- a/azure-batch/azure/batch/models/node_disable_scheduling_parameter.py +++ b/azure-batch/azure/batch/models/node_disable_scheduling_parameter.py @@ -16,9 +16,18 @@ class NodeDisableSchedulingParameter(Model): """Options for disabling scheduling on a compute node. :param node_disable_scheduling_option: What to do with currently running - tasks when disabling task scheduling on the compute node. The default - value is requeue. Possible values include: 'requeue', 'terminate', - 'taskCompletion' + tasks when disabling task scheduling on the compute node. Values are: + requeue - Terminate running task processes and requeue the tasks. The + tasks may run again on other compute nodes, or when task scheduling is + re-enabled on this node. Enter offline state as soon as tasks have been + terminated. + terminate - Terminate running tasks. The tasks will not run again. Enter + offline state as soon as tasks have been terminated. + taskcompletion - Allow currently running tasks to complete. Schedule no + new tasks while waiting. Enter offline state when all tasks have + completed. + The default value is requeue. Possible values include: 'requeue', + 'terminate', 'taskCompletion' :type node_disable_scheduling_option: str or :class:`DisableComputeNodeSchedulingOption ` diff --git a/azure-batch/azure/batch/models/node_file.py b/azure-batch/azure/batch/models/node_file.py old mode 100755 new mode 100644 diff --git a/azure-batch/azure/batch/models/node_file_paged.py b/azure-batch/azure/batch/models/node_file_paged.py old mode 100755 new mode 100644 index 45c0511ea2fe..4463c944ac67 --- a/azure-batch/azure/batch/models/node_file_paged.py +++ b/azure-batch/azure/batch/models/node_file_paged.py @@ -14,7 +14,7 @@ class NodeFilePaged(Paged): """ - A paging container for iterating over a list of NodeFile object + A paging container for iterating over a list of :class:`NodeFile ` object """ _attribute_map = { diff --git a/azure-batch/azure/batch/models/node_reboot_parameter.py b/azure-batch/azure/batch/models/node_reboot_parameter.py old mode 100755 new mode 100644 index bbbc374ca81d..56787ac914ea --- a/azure-batch/azure/batch/models/node_reboot_parameter.py +++ b/azure-batch/azure/batch/models/node_reboot_parameter.py @@ -16,8 +16,19 @@ class NodeRebootParameter(Model): """Options for rebooting a compute node. :param node_reboot_option: 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' + with currently running tasks. Values are: + requeue - Terminate running task processes and requeue the tasks. The + tasks will run again when a node is available. Restart the node as soon as + tasks have been terminated. + terminate - Terminate running tasks. The tasks will not run again. Restart + the node as soon as tasks have been terminated. + taskcompletion - Allow currently running tasks to complete. Schedule no + new tasks while waiting. Restart the node when all tasks have completed. + retaineddata - Allow currently running tasks to complete, then wait for + all task data retention periods to expire. Schedule no new tasks while + waiting. Restart the node when all task retention periods have expired. + The default value is requeue. Possible values include: 'requeue', + 'terminate', 'taskCompletion', 'retainedData' :type node_reboot_option: str or :class:`ComputeNodeRebootOption ` """ diff --git a/azure-batch/azure/batch/models/node_reimage_parameter.py b/azure-batch/azure/batch/models/node_reimage_parameter.py old mode 100755 new mode 100644 index 0fbe0736b336..0872658e4150 --- a/azure-batch/azure/batch/models/node_reimage_parameter.py +++ b/azure-batch/azure/batch/models/node_reimage_parameter.py @@ -16,8 +16,19 @@ class NodeReimageParameter(Model): """Options for reimaging a compute node. :param node_reimage_option: 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' + do with currently running tasks. Values are: + requeue - Terminate running task processes and requeue the tasks. The + tasks will run again when a node is available. Reimage the node as soon as + tasks have been terminated. + terminate - Terminate running tasks. The tasks will not run again. Reimage + the node as soon as tasks have been terminated. + taskcompletion - Allow currently running tasks to complete. Schedule no + new tasks while waiting. Reimage the node when all tasks have completed. + retaineddata - Allow currently running tasks to complete, then wait for + all task data retention periods to expire. Schedule no new tasks while + waiting. Reimage the node when all task retention periods have expired. + The default value is requeue. Possible values include: 'requeue', + 'terminate', 'taskCompletion', 'retainedData' :type node_reimage_option: str or :class:`ComputeNodeReimageOption ` """ diff --git a/azure-batch/azure/batch/models/node_remove_parameter.py b/azure-batch/azure/batch/models/node_remove_parameter.py old mode 100755 new mode 100644 index 9ca4d8d30035..198aaa405834 --- a/azure-batch/azure/batch/models/node_remove_parameter.py +++ b/azure-batch/azure/batch/models/node_remove_parameter.py @@ -15,7 +15,7 @@ class NodeRemoveParameter(Model): """Options for removing compute nodes from a pool. - :param node_list: A list containing the ids of the compute nodes to be + :param node_list: A list containing the IDs of the compute nodes to be removed from the specified pool. :type node_list: list of str :param resize_timeout: The timeout for removal of compute nodes to the diff --git a/azure-batch/azure/batch/models/node_update_user_parameter.py b/azure-batch/azure/batch/models/node_update_user_parameter.py old mode 100755 new mode 100644 diff --git a/azure-batch/azure/batch/models/os_disk.py b/azure-batch/azure/batch/models/os_disk.py old mode 100755 new mode 100644 index 03b5f04020cf..e84bd27f88a3 --- a/azure-batch/azure/batch/models/os_disk.py +++ b/azure-batch/azure/batch/models/os_disk.py @@ -25,11 +25,12 @@ class OSDisk(Model): URIs, the pool will partially allocate compute nodes, and a resize error will occur. :type image_uris: list of str - :param caching: The type of caching to enable for the OS disk. none - The - caching mode for the disk is not enabled. readOnly - The caching mode for - the disk is read only. readWrite - The caching mode for the disk is read - and write. The default value for caching is none. For information about - the caching options see: + :param caching: The type of caching to enable for the OS disk. Values are: + none - The caching mode for the disk is not enabled. + readOnly - The caching mode for the disk is read only. + readWrite - The caching mode for the disk is read and write. + The default value for caching is none. For information about the caching + options see: https://blogs.msdn.microsoft.com/windowsazurestorage/2012/06/27/exploring-windows-azure-drives-disks-and-images/. Possible values include: 'none', 'readOnly', 'readWrite' :type caching: str or :class:`CachingType diff --git a/azure-batch/azure/batch/models/output_file.py b/azure-batch/azure/batch/models/output_file.py old mode 100755 new mode 100644 diff --git a/azure-batch/azure/batch/models/output_file_blob_container_destination.py b/azure-batch/azure/batch/models/output_file_blob_container_destination.py old mode 100755 new mode 100644 diff --git a/azure-batch/azure/batch/models/output_file_destination.py b/azure-batch/azure/batch/models/output_file_destination.py old mode 100755 new mode 100644 diff --git a/azure-batch/azure/batch/models/output_file_upload_options.py b/azure-batch/azure/batch/models/output_file_upload_options.py old mode 100755 new mode 100644 diff --git a/azure-batch/azure/batch/models/pool_add_options.py b/azure-batch/azure/batch/models/pool_add_options.py old mode 100755 new mode 100644 diff --git a/azure-batch/azure/batch/models/pool_add_parameter.py b/azure-batch/azure/batch/models/pool_add_parameter.py old mode 100755 new mode 100644 index 137867d7dc5f..bc50cd0e9c6b --- a/azure-batch/azure/batch/models/pool_add_parameter.py +++ b/azure-batch/azure/batch/models/pool_add_parameter.py @@ -131,8 +131,8 @@ class PoolAddParameter(Model): The maximum value of this setting depends on the size of the compute nodes in the pool (the vmSize setting). :type max_tasks_per_node: int - :param task_scheduling_policy: How the Batch service distributes tasks - between compute nodes in the pool. + :param task_scheduling_policy: How tasks are distributed across compute + nodes in a pool. :type task_scheduling_policy: :class:`TaskSchedulingPolicy ` :param user_accounts: The list of user accounts to be created on each node diff --git a/azure-batch/azure/batch/models/pool_delete_options.py b/azure-batch/azure/batch/models/pool_delete_options.py old mode 100755 new mode 100644 diff --git a/azure-batch/azure/batch/models/pool_disable_auto_scale_options.py b/azure-batch/azure/batch/models/pool_disable_auto_scale_options.py old mode 100755 new mode 100644 diff --git a/azure-batch/azure/batch/models/pool_enable_auto_scale_options.py b/azure-batch/azure/batch/models/pool_enable_auto_scale_options.py old mode 100755 new mode 100644 diff --git a/azure-batch/azure/batch/models/pool_enable_auto_scale_parameter.py b/azure-batch/azure/batch/models/pool_enable_auto_scale_parameter.py old mode 100755 new mode 100644 diff --git a/azure-batch/azure/batch/models/pool_evaluate_auto_scale_options.py b/azure-batch/azure/batch/models/pool_evaluate_auto_scale_options.py old mode 100755 new mode 100644 diff --git a/azure-batch/azure/batch/models/pool_evaluate_auto_scale_parameter.py b/azure-batch/azure/batch/models/pool_evaluate_auto_scale_parameter.py old mode 100755 new mode 100644 diff --git a/azure-batch/azure/batch/models/pool_exists_options.py b/azure-batch/azure/batch/models/pool_exists_options.py old mode 100755 new mode 100644 diff --git a/azure-batch/azure/batch/models/pool_get_all_lifetime_statistics_options.py b/azure-batch/azure/batch/models/pool_get_all_lifetime_statistics_options.py old mode 100755 new mode 100644 diff --git a/azure-batch/azure/batch/models/pool_get_options.py b/azure-batch/azure/batch/models/pool_get_options.py old mode 100755 new mode 100644 diff --git a/azure-batch/azure/batch/models/pool_information.py b/azure-batch/azure/batch/models/pool_information.py old mode 100755 new mode 100644 diff --git a/azure-batch/azure/batch/models/pool_list_options.py b/azure-batch/azure/batch/models/pool_list_options.py old mode 100755 new mode 100644 diff --git a/azure-batch/azure/batch/models/pool_list_usage_metrics_options.py b/azure-batch/azure/batch/models/pool_list_usage_metrics_options.py old mode 100755 new mode 100644 diff --git a/azure-batch/azure/batch/models/pool_patch_options.py b/azure-batch/azure/batch/models/pool_patch_options.py old mode 100755 new mode 100644 diff --git a/azure-batch/azure/batch/models/pool_patch_parameter.py b/azure-batch/azure/batch/models/pool_patch_parameter.py old mode 100755 new mode 100644 index 189e2f353a70..10b0b4a73db5 --- a/azure-batch/azure/batch/models/pool_patch_parameter.py +++ b/azure-batch/azure/batch/models/pool_patch_parameter.py @@ -17,17 +17,19 @@ class PoolPatchParameter(Model): :param start_task: A task to run on each compute node as it joins the pool. The task runs when the node is added to the pool or when the node is - restarted. If omitted, any existing start task is left unchanged. + restarted. If this element is present, it overwrites any existing start + task. If omitted, any existing start task is left unchanged. :type start_task: :class:`StartTask ` :param certificate_references: A list of certificates to be installed on - each compute node in the pool. If omitted, any existing certificate - references are left unchanged. For Windows compute nodes, the Batch - service installs the certificates to the specified certificate store and - location. For Linux compute nodes, the certificates are stored in a - directory inside the task working directory and an environment variable - AZ_BATCH_CERTIFICATES_DIR is supplied to the task to query for this - location. For certificates with visibility of 'remoteUser', a 'certs' - directory is created in the user's home directory (e.g., + each compute node in the pool. If this element is present, it replaces any + existing certificate references configured on the pool. If omitted, any + existing certificate references are left unchanged. For Windows compute + nodes, the Batch service installs the certificates to the specified + certificate store and location. For Linux compute nodes, the certificates + are stored in a directory inside the task working directory and an + environment variable AZ_BATCH_CERTIFICATES_DIR is supplied to the task to + query for this location. For certificates with visibility of 'remoteUser', + a 'certs' directory is created in the user's home directory (e.g., /home/{user-name}/certs) and certificates are placed in that directory. :type certificate_references: list of :class:`CertificateReference ` diff --git a/azure-batch/azure/batch/models/pool_remove_nodes_options.py b/azure-batch/azure/batch/models/pool_remove_nodes_options.py old mode 100755 new mode 100644 diff --git a/azure-batch/azure/batch/models/pool_resize_options.py b/azure-batch/azure/batch/models/pool_resize_options.py old mode 100755 new mode 100644 diff --git a/azure-batch/azure/batch/models/pool_resize_parameter.py b/azure-batch/azure/batch/models/pool_resize_parameter.py old mode 100755 new mode 100644 diff --git a/azure-batch/azure/batch/models/pool_specification.py b/azure-batch/azure/batch/models/pool_specification.py old mode 100755 new mode 100644 index b5d51aa8eb4b..1e5f00f9e814 --- a/azure-batch/azure/batch/models/pool_specification.py +++ b/azure-batch/azure/batch/models/pool_specification.py @@ -57,8 +57,8 @@ class PoolSpecification(Model): The maximum value of this setting depends on the size of the compute nodes in the pool (the vmSize setting). :type max_tasks_per_node: int - :param task_scheduling_policy: How tasks are distributed among compute - nodes in the pool. + :param task_scheduling_policy: How tasks are distributed across compute + nodes in a pool. :type task_scheduling_policy: :class:`TaskSchedulingPolicy ` :param resize_timeout: The timeout for allocation of compute nodes to the diff --git a/azure-batch/azure/batch/models/pool_statistics.py b/azure-batch/azure/batch/models/pool_statistics.py old mode 100755 new mode 100644 diff --git a/azure-batch/azure/batch/models/pool_stop_resize_options.py b/azure-batch/azure/batch/models/pool_stop_resize_options.py old mode 100755 new mode 100644 diff --git a/azure-batch/azure/batch/models/pool_update_properties_options.py b/azure-batch/azure/batch/models/pool_update_properties_options.py old mode 100755 new mode 100644 diff --git a/azure-batch/azure/batch/models/pool_update_properties_parameter.py b/azure-batch/azure/batch/models/pool_update_properties_parameter.py old mode 100755 new mode 100644 index b589c3793d2c..c6634ab0b74e --- a/azure-batch/azure/batch/models/pool_update_properties_parameter.py +++ b/azure-batch/azure/batch/models/pool_update_properties_parameter.py @@ -21,7 +21,8 @@ class PoolUpdatePropertiesParameter(Model): task. If omitted, any existing start task is removed from the pool. :type start_task: :class:`StartTask ` :param certificate_references: A list of certificates to be installed on - each compute node in the pool. If you specify an empty collection, any + each compute node in the pool. This list replaces any existing certificate + references configured on the pool. If you specify an empty collection, any existing certificate references are removed from the pool. For Windows compute nodes, the Batch service installs the certificates to the specified certificate store and location. For Linux compute nodes, the @@ -34,12 +35,13 @@ class PoolUpdatePropertiesParameter(Model): :type certificate_references: list of :class:`CertificateReference ` :param application_package_references: A list of application packages to - be installed on each compute node in the pool. Changes to application - package references affect all new compute nodes joining the pool, but do - not affect compute nodes that are already in the pool until they are - rebooted or reimaged. The list replaces any existing application package - references. If omitted, or if you specify an empty collection, any - existing application packages references are removed from the pool. + be installed on each compute node in the pool. The list replaces any + existing application package references on the pool. Changes to + application package references affect all new compute nodes joining the + pool, but do not affect compute nodes that are already in the pool until + they are rebooted or reimaged. If omitted, or if you specify an empty + collection, any existing application packages references are removed from + the pool. :type application_package_references: list of :class:`ApplicationPackageReference ` diff --git a/azure-batch/azure/batch/models/pool_upgrade_os_options.py b/azure-batch/azure/batch/models/pool_upgrade_os_options.py old mode 100755 new mode 100644 diff --git a/azure-batch/azure/batch/models/pool_upgrade_os_parameter.py b/azure-batch/azure/batch/models/pool_upgrade_os_parameter.py old mode 100755 new mode 100644 diff --git a/azure-batch/azure/batch/models/pool_usage_metrics.py b/azure-batch/azure/batch/models/pool_usage_metrics.py old mode 100755 new mode 100644 index deda0dab1a6c..cc1533c0e47a --- a/azure-batch/azure/batch/models/pool_usage_metrics.py +++ b/azure-batch/azure/batch/models/pool_usage_metrics.py @@ -29,10 +29,11 @@ class PoolUsageMetrics(Model): machines for Cloud Services pools (pools created with cloudServiceConfiguration), see Sizes for Cloud Services (http://azure.microsoft.com/documentation/articles/cloud-services-sizes-specs/). - Batch supports all Cloud Services VM sizes except ExtraSmall, A1V2 and - A2V2. For information about available VM sizes for pools using images from - the Virtual Machines Marketplace (pools created with - virtualMachineConfiguration) see Sizes for Virtual Machines (Linux) + Batch supports all Cloud Services VM sizes except ExtraSmall, + STANDARD_A1_V2 and STANDARD_A2_V2. For information about available VM + sizes for pools using images from the Virtual Machines Marketplace (pools + created with virtualMachineConfiguration) see Sizes for Virtual Machines + (Linux) (https://azure.microsoft.com/documentation/articles/virtual-machines-linux-sizes/) or Sizes for Virtual Machines (Windows) (https://azure.microsoft.com/documentation/articles/virtual-machines-windows-sizes/). diff --git a/azure-batch/azure/batch/models/pool_usage_metrics_paged.py b/azure-batch/azure/batch/models/pool_usage_metrics_paged.py old mode 100755 new mode 100644 index 05b065631a72..891554f198a8 --- a/azure-batch/azure/batch/models/pool_usage_metrics_paged.py +++ b/azure-batch/azure/batch/models/pool_usage_metrics_paged.py @@ -14,7 +14,7 @@ class PoolUsageMetricsPaged(Paged): """ - A paging container for iterating over a list of PoolUsageMetrics object + A paging container for iterating over a list of :class:`PoolUsageMetrics ` object """ _attribute_map = { diff --git a/azure-batch/azure/batch/models/recent_job.py b/azure-batch/azure/batch/models/recent_job.py old mode 100755 new mode 100644 diff --git a/azure-batch/azure/batch/models/resize_error.py b/azure-batch/azure/batch/models/resize_error.py old mode 100755 new mode 100644 diff --git a/azure-batch/azure/batch/models/resource_file.py b/azure-batch/azure/batch/models/resource_file.py old mode 100755 new mode 100644 diff --git a/azure-batch/azure/batch/models/resource_statistics.py b/azure-batch/azure/batch/models/resource_statistics.py old mode 100755 new mode 100644 diff --git a/azure-batch/azure/batch/models/schedule.py b/azure-batch/azure/batch/models/schedule.py old mode 100755 new mode 100644 diff --git a/azure-batch/azure/batch/models/start_task.py b/azure-batch/azure/batch/models/start_task.py old mode 100755 new mode 100644 index c6e90a70ccbd..921e6ad23fec --- a/azure-batch/azure/batch/models/start_task.py +++ b/azure-batch/azure/batch/models/start_task.py @@ -24,7 +24,8 @@ class StartTask(Model): MyCommand" in Linux. :type command_line: str :param resource_files: A list of files that the Batch service will - download to the compute node before running the command line. + download to the compute node before running the command line. Files listed + under this element are located in the task's working directory. :type resource_files: list of :class:`ResourceFile ` :param environment_settings: A list of environment variable settings for @@ -51,10 +52,10 @@ class StartTask(Model): to its maximum retry count (maxTaskRetryCount). If the task has still not completed successfully after all retries, then the Batch service marks the compute node unusable, and will not schedule tasks to it. This condition - can be detected via the node state and scheduling error detail. If false, - the Batch service will not wait for the start task to complete. In this - case, other tasks can start executing on the compute node while the start - task is still running; and even if the start task fails, new tasks will + can be detected via the node state and failure info details. If false, the + Batch service will not wait for the start task to complete. In this case, + other tasks can start executing on the compute node while the start task + is still running; and even if the start task fails, new tasks will continue to be scheduled on the node. The default is false. :type wait_for_success: bool """ diff --git a/azure-batch/azure/batch/models/start_task_information.py b/azure-batch/azure/batch/models/start_task_information.py old mode 100755 new mode 100644 index 491e419dcdfd..854feefe172f --- a/azure-batch/azure/batch/models/start_task_information.py +++ b/azure-batch/azure/batch/models/start_task_information.py @@ -15,11 +15,12 @@ class StartTaskInformation(Model): """Information about a start task running on a compute node. - :param state: The state of the start task on the compute node. running - - The start task is currently running. completed - The start task has exited - with exit code 0, or the start task has failed and the retry limit has - reached, or the start task process did not run due to scheduling errors. - Possible values include: 'running', 'completed' + :param state: The state of the start task on the compute node. Values are: + running - The start task is currently running. + completed - The start task has exited with exit code 0, or the start task + has failed and the retry limit has reached, or the start task process did + not run due to task preparation errors (such as resource file download + failures). Possible values include: 'running', 'completed' :type state: str or :class:`StartTaskState ` :param start_time: The time at which the start task started running. This @@ -47,8 +48,7 @@ class StartTaskInformation(Model): :type failure_info: :class:`TaskFailureInformation ` :param retry_count: The number of times the task has been retried by the - Batch service. The number of times the task has been retried by the Batch - service. Task application failures (non-zero exit code) are retried, + Batch service. Task application failures (non-zero exit code) are retried, pre-processing errors (the task could not be run) and file upload errors are not retried. The Batch service will retry the task up to the limit specified by the constraints. diff --git a/azure-batch/azure/batch/models/subtask_information.py b/azure-batch/azure/batch/models/subtask_information.py old mode 100755 new mode 100644 diff --git a/azure-batch/azure/batch/models/task_add_collection_options.py b/azure-batch/azure/batch/models/task_add_collection_options.py old mode 100755 new mode 100644 diff --git a/azure-batch/azure/batch/models/task_add_collection_parameter.py b/azure-batch/azure/batch/models/task_add_collection_parameter.py old mode 100755 new mode 100644 index 0f349be8c4bb..758d85afddd5 --- a/azure-batch/azure/batch/models/task_add_collection_parameter.py +++ b/azure-batch/azure/batch/models/task_add_collection_parameter.py @@ -15,7 +15,11 @@ class TaskAddCollectionParameter(Model): """A collection of Azure Batch tasks to add. - :param value: The collection of tasks to add. + :param value: The collection of tasks to add. The total serialized size of + this collection must be less than 4MB. If it is greater than 4MB (for + example if each task has 100's of resource files or environment + variables), the request will fail with code 'RequestBodyTooLarge' and + should be retried again with fewer tasks. :type value: list of :class:`TaskAddParameter ` """ diff --git a/azure-batch/azure/batch/models/task_add_collection_result.py b/azure-batch/azure/batch/models/task_add_collection_result.py old mode 100755 new mode 100644 diff --git a/azure-batch/azure/batch/models/task_add_options.py b/azure-batch/azure/batch/models/task_add_options.py old mode 100755 new mode 100644 diff --git a/azure-batch/azure/batch/models/task_add_parameter.py b/azure-batch/azure/batch/models/task_add_parameter.py old mode 100755 new mode 100644 index f6428ef32872..289e42d34d3a --- a/azure-batch/azure/batch/models/task_add_parameter.py +++ b/azure-batch/azure/batch/models/task_add_parameter.py @@ -83,7 +83,12 @@ class TaskAddParameter(Model): ` :param application_package_references: A list of application packages that the Batch service will deploy to the compute node before running the - command line. + command line. Application packages are downloaded and deployed to a shared + directory, not the task working directory. Therefore, if a referenced + package is already on the compute node, and is up to date, then it is not + re-downloaded; the existing copy on the compute node is used. If a + referenced application package cannot be installed, for example because + the package has been deleted or because download failed, the task fails. :type application_package_references: list of :class:`ApplicationPackageReference ` diff --git a/azure-batch/azure/batch/models/task_add_result.py b/azure-batch/azure/batch/models/task_add_result.py old mode 100755 new mode 100644 index f396536bf846..77784288ee12 --- a/azure-batch/azure/batch/models/task_add_result.py +++ b/azure-batch/azure/batch/models/task_add_result.py @@ -15,13 +15,22 @@ class TaskAddResult(Model): """Result for a single task added as part of an add task collection operation. - :param status: The status of the add task request. Possible values - include: 'success', 'clientError', 'serverError' + :param status: The status of the add task request. Values are: + success - Task was added successfully. + clienterror - Task failed to add due to a client error and should not be + retried without modifying the request as appropriate. + servererror - Task failed to add due to a server error and can be retried + without modification. Possible values include: 'success', 'clientError', + 'serverError' :type status: str or :class:`TaskAddStatus ` :param task_id: The ID of the task for which this is the result. :type task_id: str :param e_tag: The ETag of the task, if the task was successfully added. + You can use this to detect whether the task has changed between requests. + In particular, you can be pass the ETag with an Update Task request to + specify that your changes should take effect only if nobody else has + modified the job in the meantime. :type e_tag: str :param last_modified: The last modified time of the task. :type last_modified: datetime diff --git a/azure-batch/azure/batch/models/task_constraints.py b/azure-batch/azure/batch/models/task_constraints.py old mode 100755 new mode 100644 diff --git a/azure-batch/azure/batch/models/task_counts.py b/azure-batch/azure/batch/models/task_counts.py index d253cb82ef3f..439662606f3d 100644 --- a/azure-batch/azure/batch/models/task_counts.py +++ b/azure-batch/azure/batch/models/task_counts.py @@ -27,7 +27,7 @@ class TaskCounts(Model): :param failed: The number of tasks which failed. A task fails if its result (found in the executionInfo property) is 'failure'. :type failed: int - :param validation_status: Whether the task counts have been validated. If + :param validation_status: Whether the task counts have been validated. If the validationStatus is unvalidated, then the Batch service has not been able to check state counts against the task states as reported in the List Tasks API. The validationStatus may be unvalidated if the job contains diff --git a/azure-batch/azure/batch/models/task_delete_options.py b/azure-batch/azure/batch/models/task_delete_options.py old mode 100755 new mode 100644 diff --git a/azure-batch/azure/batch/models/task_dependencies.py b/azure-batch/azure/batch/models/task_dependencies.py old mode 100755 new mode 100644 index 2644d48a025a..6980e986034a --- a/azure-batch/azure/batch/models/task_dependencies.py +++ b/azure-batch/azure/batch/models/task_dependencies.py @@ -19,7 +19,11 @@ class TaskDependencies(Model): :param task_ids: The list of task IDs that this task depends on. All tasks in this list must complete successfully before the dependent task can be - scheduled. + scheduled. The taskIds collection is limited to 64000 characters total + (i.e. the combined length of all task IDs). If the taskIds collection + exceeds the maximum length, the Add Task request fails with error code + TaskDependencyListTooLong. In this case consider using task ID ranges + instead. :type task_ids: list of str :param task_id_ranges: The list of task ID ranges that this task depends on. All tasks in all ranges must complete successfully before the diff --git a/azure-batch/azure/batch/models/task_execution_information.py b/azure-batch/azure/batch/models/task_execution_information.py old mode 100755 new mode 100644 index 9dca3dc55c94..57056fb4d4bd --- a/azure-batch/azure/batch/models/task_execution_information.py +++ b/azure-batch/azure/batch/models/task_execution_information.py @@ -42,8 +42,7 @@ class TaskExecutionInformation(Model): :type failure_info: :class:`TaskFailureInformation ` :param retry_count: The number of times the task has been retried by the - Batch service. The number of times the task has been retried by the Batch - service. Task application failures (non-zero exit code) are retried, + Batch service. Task application failures (non-zero exit code) are retried, pre-processing errors (the task could not be run) and file upload errors are not retried. The Batch service will retry the task up to the limit specified by the constraints. diff --git a/azure-batch/azure/batch/models/task_failure_information.py b/azure-batch/azure/batch/models/task_failure_information.py old mode 100755 new mode 100644 diff --git a/azure-batch/azure/batch/models/task_get_options.py b/azure-batch/azure/batch/models/task_get_options.py old mode 100755 new mode 100644 diff --git a/azure-batch/azure/batch/models/task_id_range.py b/azure-batch/azure/batch/models/task_id_range.py old mode 100755 new mode 100644 diff --git a/azure-batch/azure/batch/models/task_information.py b/azure-batch/azure/batch/models/task_information.py old mode 100755 new mode 100644 diff --git a/azure-batch/azure/batch/models/task_list_options.py b/azure-batch/azure/batch/models/task_list_options.py old mode 100755 new mode 100644 diff --git a/azure-batch/azure/batch/models/task_list_subtasks_options.py b/azure-batch/azure/batch/models/task_list_subtasks_options.py old mode 100755 new mode 100644 diff --git a/azure-batch/azure/batch/models/task_reactivate_options.py b/azure-batch/azure/batch/models/task_reactivate_options.py old mode 100755 new mode 100644 diff --git a/azure-batch/azure/batch/models/task_scheduling_policy.py b/azure-batch/azure/batch/models/task_scheduling_policy.py old mode 100755 new mode 100644 index 781a3bb58b4b..ee131a94218d --- a/azure-batch/azure/batch/models/task_scheduling_policy.py +++ b/azure-batch/azure/batch/models/task_scheduling_policy.py @@ -15,8 +15,13 @@ class TaskSchedulingPolicy(Model): """Specifies how tasks should be distributed across compute nodes. - :param node_fill_type: How tasks should be distributed across compute - nodes. Possible values include: 'spread', 'pack' + :param node_fill_type: How tasks are distributed across compute nodes in a + pool. Values are: + pack - As many tasks as possible (maxTasksPerNode) should be assigned to + each node in the pool before any tasks are assigned to the next node in + the pool. + spread - Tasks should be assigned evenly across all nodes in the pool. + Possible values include: 'spread', 'pack' :type node_fill_type: str or :class:`ComputeNodeFillType ` """ diff --git a/azure-batch/azure/batch/models/task_statistics.py b/azure-batch/azure/batch/models/task_statistics.py old mode 100755 new mode 100644 diff --git a/azure-batch/azure/batch/models/task_terminate_options.py b/azure-batch/azure/batch/models/task_terminate_options.py old mode 100755 new mode 100644 diff --git a/azure-batch/azure/batch/models/task_update_options.py b/azure-batch/azure/batch/models/task_update_options.py old mode 100755 new mode 100644 diff --git a/azure-batch/azure/batch/models/task_update_parameter.py b/azure-batch/azure/batch/models/task_update_parameter.py old mode 100755 new mode 100644 index 649bd832ad51..8ea6cbb93b1d --- a/azure-batch/azure/batch/models/task_update_parameter.py +++ b/azure-batch/azure/batch/models/task_update_parameter.py @@ -16,7 +16,8 @@ class TaskUpdateParameter(Model): """The set of changes to be made to a task. :param constraints: Constraints that apply to this task. If omitted, the - task is given the default constraints. + task is given the default constraints. For multi-instance tasks, updating + the retention time applies only to the primary task and not subtasks. :type constraints: :class:`TaskConstraints ` """ diff --git a/azure-batch/azure/batch/models/usage_statistics.py b/azure-batch/azure/batch/models/usage_statistics.py old mode 100755 new mode 100644 diff --git a/azure-batch/azure/batch/models/user_account.py b/azure-batch/azure/batch/models/user_account.py old mode 100755 new mode 100644 diff --git a/azure-batch/azure/batch/models/user_identity.py b/azure-batch/azure/batch/models/user_identity.py old mode 100755 new mode 100644 diff --git a/azure-batch/azure/batch/models/virtual_machine_configuration.py b/azure-batch/azure/batch/models/virtual_machine_configuration.py old mode 100755 new mode 100644 diff --git a/azure-batch/azure/batch/models/windows_configuration.py b/azure-batch/azure/batch/models/windows_configuration.py old mode 100755 new mode 100644 diff --git a/azure-batch/azure/batch/operations/__init__.py b/azure-batch/azure/batch/operations/__init__.py old mode 100755 new mode 100644 diff --git a/azure-batch/azure/batch/operations/account_operations.py b/azure-batch/azure/batch/operations/account_operations.py old mode 100755 new mode 100644 index 10e2878fdf62..d533a2924cdd --- a/azure-batch/azure/batch/operations/account_operations.py +++ b/azure-batch/azure/batch/operations/account_operations.py @@ -9,8 +9,8 @@ # regenerated. # -------------------------------------------------------------------------- -from msrest.pipeline import ClientRawResponse import uuid +from msrest.pipeline import ClientRawResponse from .. import models @@ -48,6 +48,8 @@ def list_node_agent_skus( deserialized response :param operation_config: :ref:`Operation configuration overrides`. + :return: An iterator like instance of :class:`NodeAgentSku + ` :rtype: :class:`NodeAgentSkuPaged ` :raises: diff --git a/azure-batch/azure/batch/operations/application_operations.py b/azure-batch/azure/batch/operations/application_operations.py old mode 100755 new mode 100644 index 3f9cd4608de1..43ebd8d0e5d0 --- a/azure-batch/azure/batch/operations/application_operations.py +++ b/azure-batch/azure/batch/operations/application_operations.py @@ -9,8 +9,8 @@ # regenerated. # -------------------------------------------------------------------------- -from msrest.pipeline import ClientRawResponse import uuid +from msrest.pipeline import ClientRawResponse from .. import models @@ -53,6 +53,8 @@ def list( deserialized response :param operation_config: :ref:`Operation configuration overrides`. + :return: An iterator like instance of :class:`ApplicationSummary + ` :rtype: :class:`ApplicationSummaryPaged ` :raises: @@ -132,6 +134,12 @@ def get( self, application_id, application_get_options=None, custom_headers=None, raw=False, **operation_config): """Gets information about the specified application. + This operation returns only applications and versions that are + available for use on compute nodes; that is, that can be used in an + application package reference. For administrator information about + applications and versions that are not yet available to compute nodes, + use the Azure portal or the Azure Resource Manager API. + :param application_id: The ID of the application. :type application_id: str :param application_get_options: Additional parameters for the @@ -143,10 +151,13 @@ def get( deserialized response :param operation_config: :ref:`Operation configuration overrides`. + :return: :class:`ApplicationSummary + ` or + :class:`ClientRawResponse` if + raw=true :rtype: :class:`ApplicationSummary - ` - :rtype: :class:`ClientRawResponse` - if raw=true + ` or + :class:`ClientRawResponse` :raises: :class:`BatchErrorException` """ diff --git a/azure-batch/azure/batch/operations/certificate_operations.py b/azure-batch/azure/batch/operations/certificate_operations.py old mode 100755 new mode 100644 index 7a24adbd43ae..615034f898a5 --- a/azure-batch/azure/batch/operations/certificate_operations.py +++ b/azure-batch/azure/batch/operations/certificate_operations.py @@ -9,8 +9,8 @@ # regenerated. # -------------------------------------------------------------------------- -from msrest.pipeline import ClientRawResponse import uuid +from msrest.pipeline import ClientRawResponse from .. import models @@ -50,9 +50,11 @@ def add( deserialized response :param operation_config: :ref:`Operation configuration overrides`. - :rtype: None - :rtype: :class:`ClientRawResponse` - if raw=true + :return: None or + :class:`ClientRawResponse` if + raw=true + :rtype: None or + :class:`ClientRawResponse` :raises: :class:`BatchErrorException` """ @@ -130,6 +132,8 @@ def list( deserialized response :param operation_config: :ref:`Operation configuration overrides`. + :return: An iterator like instance of :class:`Certificate + ` :rtype: :class:`CertificatePaged ` :raises: @@ -243,9 +247,11 @@ def cancel_deletion( deserialized response :param operation_config: :ref:`Operation configuration overrides`. - :rtype: None - :rtype: :class:`ClientRawResponse` - if raw=true + :return: None or + :class:`ClientRawResponse` if + raw=true + :rtype: None or + :class:`ClientRawResponse` :raises: :class:`BatchErrorException` """ @@ -340,9 +346,11 @@ def delete( deserialized response :param operation_config: :ref:`Operation configuration overrides`. - :rtype: None - :rtype: :class:`ClientRawResponse` - if raw=true + :return: None or + :class:`ClientRawResponse` if + raw=true + :rtype: None or + :class:`ClientRawResponse` :raises: :class:`BatchErrorException` """ @@ -424,9 +432,11 @@ def get( deserialized response :param operation_config: :ref:`Operation configuration overrides`. - :rtype: :class:`Certificate ` - :rtype: :class:`ClientRawResponse` - if raw=true + :return: :class:`Certificate ` or + :class:`ClientRawResponse` if + raw=true + :rtype: :class:`Certificate ` or + :class:`ClientRawResponse` :raises: :class:`BatchErrorException` """ diff --git a/azure-batch/azure/batch/operations/compute_node_operations.py b/azure-batch/azure/batch/operations/compute_node_operations.py old mode 100755 new mode 100644 index 6b45150814ad..ea100ab43e71 --- a/azure-batch/azure/batch/operations/compute_node_operations.py +++ b/azure-batch/azure/batch/operations/compute_node_operations.py @@ -9,8 +9,8 @@ # regenerated. # -------------------------------------------------------------------------- -from msrest.pipeline import ClientRawResponse import uuid +from msrest.pipeline import ClientRawResponse from .. import models @@ -58,9 +58,11 @@ def add_user( deserialized response :param operation_config: :ref:`Operation configuration overrides`. - :rtype: None - :rtype: :class:`ClientRawResponse` - if raw=true + :return: None or + :class:`ClientRawResponse` if + raw=true + :rtype: None or + :class:`ClientRawResponse` :raises: :class:`BatchErrorException` """ @@ -153,9 +155,11 @@ def delete_user( deserialized response :param operation_config: :ref:`Operation configuration overrides`. - :rtype: None - :rtype: :class:`ClientRawResponse` - if raw=true + :return: None or + :class:`ClientRawResponse` if + raw=true + :rtype: None or + :class:`ClientRawResponse` :raises: :class:`BatchErrorException` """ @@ -220,7 +224,7 @@ def delete_user( def update_user( self, pool_id, node_id, user_name, node_update_user_parameter, compute_node_update_user_options=None, custom_headers=None, raw=False, **operation_config): - """Updates the password or expiration time of a user account on the + """Updates the password and expiration time of a user account on the specified compute node. This operation replaces of all the updateable properties of the @@ -249,9 +253,11 @@ def update_user( deserialized response :param operation_config: :ref:`Operation configuration overrides`. - :rtype: None - :rtype: :class:`ClientRawResponse` - if raw=true + :return: None or + :class:`ClientRawResponse` if + raw=true + :rtype: None or + :class:`ClientRawResponse` :raises: :class:`BatchErrorException` """ @@ -339,9 +345,11 @@ def get( deserialized response :param operation_config: :ref:`Operation configuration overrides`. - :rtype: :class:`ComputeNode ` - :rtype: :class:`ClientRawResponse` - if raw=true + :return: :class:`ComputeNode ` or + :class:`ClientRawResponse` if + raw=true + :rtype: :class:`ComputeNode ` or + :class:`ClientRawResponse` :raises: :class:`BatchErrorException` """ @@ -434,9 +442,21 @@ def reboot( :type compute_node_reboot_options: :class:`ComputeNodeRebootOptions ` :param node_reboot_option: 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' + do with currently running tasks. Values are: + requeue - Terminate running task processes and requeue the tasks. The + tasks will run again when a node is available. Restart the node as + soon as tasks have been terminated. + terminate - Terminate running tasks. The tasks will not run again. + Restart the node as soon as tasks have been terminated. + taskcompletion - Allow currently running tasks to complete. Schedule + no new tasks while waiting. Restart the node when all tasks have + completed. + retaineddata - Allow currently running tasks to complete, then wait + for all task data retention periods to expire. Schedule no new tasks + while waiting. Restart the node when all task retention periods have + expired. + The default value is requeue. Possible values include: 'requeue', + 'terminate', 'taskCompletion', 'retainedData' :type node_reboot_option: str or :class:`ComputeNodeRebootOption ` :param dict custom_headers: headers that will be added to the request @@ -444,9 +464,11 @@ def reboot( deserialized response :param operation_config: :ref:`Operation configuration overrides`. - :rtype: None - :rtype: :class:`ClientRawResponse` - if raw=true + :return: None or + :class:`ClientRawResponse` if + raw=true + :rtype: None or + :class:`ClientRawResponse` :raises: :class:`BatchErrorException` """ @@ -538,9 +560,21 @@ def reimage( :type compute_node_reimage_options: :class:`ComputeNodeReimageOptions ` :param node_reimage_option: 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' + to do with currently running tasks. Values are: + requeue - Terminate running task processes and requeue the tasks. The + tasks will run again when a node is available. Reimage the node as + soon as tasks have been terminated. + terminate - Terminate running tasks. The tasks will not run again. + Reimage the node as soon as tasks have been terminated. + taskcompletion - Allow currently running tasks to complete. Schedule + no new tasks while waiting. Reimage the node when all tasks have + completed. + retaineddata - Allow currently running tasks to complete, then wait + for all task data retention periods to expire. Schedule no new tasks + while waiting. Reimage the node when all task retention periods have + expired. + The default value is requeue. Possible values include: 'requeue', + 'terminate', 'taskCompletion', 'retainedData' :type node_reimage_option: str or :class:`ComputeNodeReimageOption ` :param dict custom_headers: headers that will be added to the request @@ -548,9 +582,11 @@ def reimage( deserialized response :param operation_config: :ref:`Operation configuration overrides`. - :rtype: None - :rtype: :class:`ClientRawResponse` - if raw=true + :return: None or + :class:`ClientRawResponse` if + raw=true + :rtype: None or + :class:`ClientRawResponse` :raises: :class:`BatchErrorException` """ @@ -629,6 +665,9 @@ def disable_scheduling( self, pool_id, node_id, compute_node_disable_scheduling_options=None, node_disable_scheduling_option=None, custom_headers=None, raw=False, **operation_config): """Disables task scheduling on the specified compute node. + You can disable task scheduling on a node only if its current + scheduling state is enabled. + :param pool_id: The ID of the pool that contains the compute node. :type pool_id: str :param node_id: The ID of the compute node on which you want to @@ -640,8 +679,18 @@ def disable_scheduling( :class:`ComputeNodeDisableSchedulingOptions ` :param node_disable_scheduling_option: What to do with currently - running tasks when disabling task scheduling on the compute node. The - default value is requeue. Possible values include: 'requeue', + running tasks when disabling task scheduling on the compute node. + Values are: + requeue - Terminate running task processes and requeue the tasks. The + tasks may run again on other compute nodes, or when task scheduling is + re-enabled on this node. Enter offline state as soon as tasks have + been terminated. + terminate - Terminate running tasks. The tasks will not run again. + Enter offline state as soon as tasks have been terminated. + taskcompletion - Allow currently running tasks to complete. Schedule + no new tasks while waiting. Enter offline state when all tasks have + completed. + The default value is requeue. Possible values include: 'requeue', 'terminate', 'taskCompletion' :type node_disable_scheduling_option: str or :class:`DisableComputeNodeSchedulingOption @@ -651,9 +700,11 @@ def disable_scheduling( deserialized response :param operation_config: :ref:`Operation configuration overrides`. - :rtype: None - :rtype: :class:`ClientRawResponse` - if raw=true + :return: None or + :class:`ClientRawResponse` if + raw=true + :rtype: None or + :class:`ClientRawResponse` :raises: :class:`BatchErrorException` """ @@ -732,6 +783,9 @@ def enable_scheduling( self, pool_id, node_id, compute_node_enable_scheduling_options=None, custom_headers=None, raw=False, **operation_config): """Enables task scheduling on the specified compute node. + You can enable task scheduling on a node only if its current scheduling + state is disabled. + :param pool_id: The ID of the pool that contains the compute node. :type pool_id: str :param node_id: The ID of the compute node on which you want to enable @@ -747,9 +801,11 @@ def enable_scheduling( deserialized response :param operation_config: :ref:`Operation configuration overrides`. - :rtype: None - :rtype: :class:`ClientRawResponse` - if raw=true + :return: None or + :class:`ClientRawResponse` if + raw=true + :rtype: None or + :class:`ClientRawResponse` :raises: :class:`BatchErrorException` """ @@ -821,7 +877,8 @@ def get_remote_login_settings( Before you can remotely login to a node using the remote login settings, you must create a user account on the node. This API can be invoked only on pools created with the virtual machine configuration - property. + property. For pools created with a cloud service configuration, see the + GetRemoteDesktop API. :param pool_id: The ID of the pool that contains the compute node. :type pool_id: str @@ -838,10 +895,13 @@ def get_remote_login_settings( deserialized response :param operation_config: :ref:`Operation configuration overrides`. + :return: :class:`ComputeNodeGetRemoteLoginSettingsResult + ` or + :class:`ClientRawResponse` if + raw=true :rtype: :class:`ComputeNodeGetRemoteLoginSettingsResult - ` - :rtype: :class:`ClientRawResponse` - if raw=true + ` or + :class:`ClientRawResponse` :raises: :class:`BatchErrorException` """ @@ -920,7 +980,8 @@ def get_remote_desktop( Before you can access a node by using the RDP file, you must create a user account on the node. This API can only be invoked on pools created - with the cloud service configuration property. + with a cloud service configuration. For pools created with a virtual + machine configuration, see the GetRemoteLoginSettings API. :param pool_id: The ID of the pool that contains the compute node. :type pool_id: str @@ -942,9 +1003,11 @@ def get_remote_desktop( :type callback: Callable[Bytes, response=None] :param operation_config: :ref:`Operation configuration overrides`. - :rtype: Generator - :rtype: :class:`ClientRawResponse` - if raw=true + :return: Generator or + :class:`ClientRawResponse` if + raw=true + :rtype: Generator or + :class:`ClientRawResponse` :raises: :class:`BatchErrorException` """ @@ -1032,6 +1095,8 @@ def list( deserialized response :param operation_config: :ref:`Operation configuration overrides`. + :return: An iterator like instance of :class:`ComputeNode + ` :rtype: :class:`ComputeNodePaged ` :raises: diff --git a/azure-batch/azure/batch/operations/file_operations.py b/azure-batch/azure/batch/operations/file_operations.py old mode 100755 new mode 100644 index 37b025e73c15..b99a40f2a058 --- a/azure-batch/azure/batch/operations/file_operations.py +++ b/azure-batch/azure/batch/operations/file_operations.py @@ -9,8 +9,8 @@ # regenerated. # -------------------------------------------------------------------------- -from msrest.pipeline import ClientRawResponse import uuid +from msrest.pipeline import ClientRawResponse from .. import models @@ -43,7 +43,8 @@ def delete_from_task( :type job_id: str :param task_id: The ID of the task whose file you want to delete. :type task_id: str - :param file_path: The path to the task file that you want to delete. + :param file_path: The path to the task file or directory that you want + to delete. :type file_path: str :param recursive: Whether to delete children of a directory. If the filePath parameter represents a directory instead of a file, you can @@ -60,9 +61,11 @@ def delete_from_task( deserialized response :param operation_config: :ref:`Operation configuration overrides`. - :rtype: None - :rtype: :class:`ClientRawResponse` - if raw=true + :return: None or + :class:`ClientRawResponse` if + raw=true + :rtype: None or + :class:`ClientRawResponse` :raises: :class:`BatchErrorException` """ @@ -152,9 +155,11 @@ def get_from_task( :type callback: Callable[Bytes, response=None] :param operation_config: :ref:`Operation configuration overrides`. - :rtype: Generator - :rtype: :class:`ClientRawResponse` - if raw=true + :return: Generator or + :class:`ClientRawResponse` if + raw=true + :rtype: Generator or + :class:`ClientRawResponse` :raises: :class:`BatchErrorException` """ @@ -271,9 +276,11 @@ def get_properties_from_task( deserialized response :param operation_config: :ref:`Operation configuration overrides`. - :rtype: None - :rtype: :class:`ClientRawResponse` - if raw=true + :return: None or + :class:`ClientRawResponse` if + raw=true + :rtype: None or + :class:`ClientRawResponse` :raises: :class:`BatchErrorException` """ @@ -363,7 +370,8 @@ def delete_from_compute_node( :param node_id: The ID of the compute node from which you want to delete the file. :type node_id: str - :param file_path: The path to the file that you want to delete. + :param file_path: The path to the file or directory that you want to + delete. :type file_path: str :param recursive: Whether to delete children of a directory. If the filePath parameter represents a directory instead of a file, you can @@ -381,9 +389,11 @@ def delete_from_compute_node( deserialized response :param operation_config: :ref:`Operation configuration overrides`. - :rtype: None - :rtype: :class:`ClientRawResponse` - if raw=true + :return: None or + :class:`ClientRawResponse` if + raw=true + :rtype: None or + :class:`ClientRawResponse` :raises: :class:`BatchErrorException` """ @@ -474,9 +484,11 @@ def get_from_compute_node( :type callback: Callable[Bytes, response=None] :param operation_config: :ref:`Operation configuration overrides`. - :rtype: Generator - :rtype: :class:`ClientRawResponse` - if raw=true + :return: Generator or + :class:`ClientRawResponse` if + raw=true + :rtype: Generator or + :class:`ClientRawResponse` :raises: :class:`BatchErrorException` """ @@ -592,9 +604,11 @@ def get_properties_from_compute_node( deserialized response :param operation_config: :ref:`Operation configuration overrides`. - :rtype: None - :rtype: :class:`ClientRawResponse` - if raw=true + :return: None or + :class:`ClientRawResponse` if + raw=true + :rtype: None or + :class:`ClientRawResponse` :raises: :class:`BatchErrorException` """ @@ -683,7 +697,7 @@ def list_from_task( :type job_id: str :param task_id: The ID of the task whose files you want to list. :type task_id: str - :param recursive: Whether to list children of a directory. This + :param recursive: Whether to list children of the task directory. This parameter can be used in combination with the filter parameter to list specific type of files. :type recursive: bool @@ -696,6 +710,8 @@ def list_from_task( deserialized response :param operation_config: :ref:`Operation configuration overrides`. + :return: An iterator like instance of :class:`NodeFile + ` :rtype: :class:`NodeFilePaged ` :raises: :class:`BatchErrorException` @@ -804,6 +820,8 @@ def list_from_compute_node( deserialized response :param operation_config: :ref:`Operation configuration overrides`. + :return: An iterator like instance of :class:`NodeFile + ` :rtype: :class:`NodeFilePaged ` :raises: :class:`BatchErrorException` diff --git a/azure-batch/azure/batch/operations/job_operations.py b/azure-batch/azure/batch/operations/job_operations.py old mode 100755 new mode 100644 index d534a4a1492b..888da2854cbb --- a/azure-batch/azure/batch/operations/job_operations.py +++ b/azure-batch/azure/batch/operations/job_operations.py @@ -9,8 +9,8 @@ # regenerated. # -------------------------------------------------------------------------- -from msrest.pipeline import ClientRawResponse import uuid +from msrest.pipeline import ClientRawResponse from .. import models @@ -53,9 +53,11 @@ def get_all_lifetime_statistics( deserialized response :param operation_config: :ref:`Operation configuration overrides`. - :rtype: :class:`JobStatistics ` - :rtype: :class:`ClientRawResponse` - if raw=true + :return: :class:`JobStatistics ` or + :class:`ClientRawResponse` if + raw=true + :rtype: :class:`JobStatistics ` or + :class:`ClientRawResponse` :raises: :class:`BatchErrorException` """ @@ -131,7 +133,11 @@ def delete( all job statistics. This also overrides the retention period for task data; that is, if the job contains tasks which are still retained on compute nodes, the Batch services deletes those tasks' working - directories and all their contents. + directories and all their contents. When a Delete Job request is + received, the Batch service sets the job to the deleting state. All + update operations on a job that is in deleting state will fail with + status code 409 (Conflict), with additional information indicating that + the job is being deleted. :param job_id: The ID of the job to delete. :type job_id: str @@ -143,9 +149,11 @@ def delete( deserialized response :param operation_config: :ref:`Operation configuration overrides`. - :rtype: None - :rtype: :class:`ClientRawResponse` - if raw=true + :return: None or + :class:`ClientRawResponse` if + raw=true + :rtype: None or + :class:`ClientRawResponse` :raises: :class:`BatchErrorException` """ @@ -240,9 +248,11 @@ def get( deserialized response :param operation_config: :ref:`Operation configuration overrides`. - :rtype: :class:`CloudJob ` - :rtype: :class:`ClientRawResponse` - if raw=true + :return: :class:`CloudJob ` or + :class:`ClientRawResponse` if + raw=true + :rtype: :class:`CloudJob ` or + :class:`ClientRawResponse` :raises: :class:`BatchErrorException` """ @@ -365,9 +375,11 @@ def patch( deserialized response :param operation_config: :ref:`Operation configuration overrides`. - :rtype: None - :rtype: :class:`ClientRawResponse` - if raw=true + :return: None or + :class:`ClientRawResponse` if + raw=true + :rtype: None or + :class:`ClientRawResponse` :raises: :class:`BatchErrorException` """ @@ -477,9 +489,11 @@ def update( deserialized response :param operation_config: :ref:`Operation configuration overrides`. - :rtype: None - :rtype: :class:`ClientRawResponse` - if raw=true + :return: None or + :class:`ClientRawResponse` if + raw=true + :rtype: None or + :class:`ClientRawResponse` :raises: :class:`BatchErrorException` """ @@ -584,11 +598,12 @@ def disable( :param job_id: The ID of the job to disable. :type job_id: str :param disable_tasks: What to do with active tasks associated with the - job. requeue - Terminate running tasks and requeue them. The tasks - will run again when the job is enabled. terminate - Terminate running - tasks. The tasks will not run again. wait - Allow currently running - tasks to complete. Possible values include: 'requeue', 'terminate', - 'wait' + job. Values are: + requeue - Terminate running tasks and requeue them. The tasks will run + again when the job is enabled. + terminate - Terminate running tasks. The tasks will not run again. + wait - Allow currently running tasks to complete. Possible values + include: 'requeue', 'terminate', 'wait' :type disable_tasks: str or :class:`DisableJobOption ` :param job_disable_options: Additional parameters for the operation @@ -599,9 +614,11 @@ def disable( deserialized response :param operation_config: :ref:`Operation configuration overrides`. - :rtype: None - :rtype: :class:`ClientRawResponse` - if raw=true + :return: None or + :class:`ClientRawResponse` if + raw=true + :rtype: None or + :class:`ClientRawResponse` :raises: :class:`BatchErrorException` """ @@ -711,9 +728,11 @@ def enable( deserialized response :param operation_config: :ref:`Operation configuration overrides`. - :rtype: None - :rtype: :class:`ClientRawResponse` - if raw=true + :return: None or + :class:`ClientRawResponse` if + raw=true + :rtype: None or + :class:`ClientRawResponse` :raises: :class:`BatchErrorException` """ @@ -819,9 +838,11 @@ def terminate( deserialized response :param operation_config: :ref:`Operation configuration overrides`. - :rtype: None - :rtype: :class:`ClientRawResponse` - if raw=true + :return: None or + :class:`ClientRawResponse` if + raw=true + :rtype: None or + :class:`ClientRawResponse` :raises: :class:`BatchErrorException` """ @@ -941,9 +962,11 @@ def add( deserialized response :param operation_config: :ref:`Operation configuration overrides`. - :rtype: None - :rtype: :class:`ClientRawResponse` - if raw=true + :return: None or + :class:`ClientRawResponse` if + raw=true + :rtype: None or + :class:`ClientRawResponse` :raises: :class:`BatchErrorException` """ @@ -1019,6 +1042,8 @@ def list( deserialized response :param operation_config: :ref:`Operation configuration overrides`. + :return: An iterator like instance of :class:`CloudJob + ` :rtype: :class:`CloudJobPaged ` :raises: :class:`BatchErrorException` @@ -1125,6 +1150,8 @@ def list_from_job_schedule( deserialized response :param operation_config: :ref:`Operation configuration overrides`. + :return: An iterator like instance of :class:`CloudJob + ` :rtype: :class:`CloudJobPaged ` :raises: :class:`BatchErrorException` @@ -1225,7 +1252,10 @@ def list_preparation_and_release_task_status( This API returns the Job Preparation and Job Release task status on all compute nodes that have run the Job Preparation or Job Release task. - This includes nodes which have since been removed from the pool. . + This includes nodes which have since been removed from the pool. If + this API is invoked on a job which has no Job Preparation or Job + Release task, the Batch service returns HTTP status code 409 (Conflict) + with an error code of JobPreparationTaskNotSpecified. :param job_id: The ID of the job. :type job_id: str @@ -1239,6 +1269,9 @@ def list_preparation_and_release_task_status( deserialized response :param operation_config: :ref:`Operation configuration overrides`. + :return: An iterator like instance of + :class:`JobPreparationAndReleaseTaskExecutionInformation + ` :rtype: :class:`JobPreparationAndReleaseTaskExecutionInformationPaged ` :raises: @@ -1351,9 +1384,11 @@ def get_task_counts( deserialized response :param operation_config: :ref:`Operation configuration overrides`. - :rtype: :class:`TaskCounts ` - :rtype: :class:`ClientRawResponse` - if raw=true + :return: :class:`TaskCounts ` or + :class:`ClientRawResponse` if + raw=true + :rtype: :class:`TaskCounts ` or + :class:`ClientRawResponse` :raises: :class:`BatchErrorException` """ diff --git a/azure-batch/azure/batch/operations/job_schedule_operations.py b/azure-batch/azure/batch/operations/job_schedule_operations.py old mode 100755 new mode 100644 index 36694469bf92..630ca4ebf925 --- a/azure-batch/azure/batch/operations/job_schedule_operations.py +++ b/azure-batch/azure/batch/operations/job_schedule_operations.py @@ -9,8 +9,8 @@ # regenerated. # -------------------------------------------------------------------------- -from msrest.pipeline import ClientRawResponse import uuid +from msrest.pipeline import ClientRawResponse from .. import models @@ -50,9 +50,11 @@ def exists( deserialized response :param operation_config: :ref:`Operation configuration overrides`. - :rtype: bool - :rtype: :class:`ClientRawResponse` - if raw=true + :return: bool or + :class:`ClientRawResponse` if + raw=true + :rtype: bool or + :class:`ClientRawResponse` :raises: :class:`BatchErrorException` """ @@ -159,9 +161,11 @@ def delete( deserialized response :param operation_config: :ref:`Operation configuration overrides`. - :rtype: None - :rtype: :class:`ClientRawResponse` - if raw=true + :return: None or + :class:`ClientRawResponse` if + raw=true + :rtype: None or + :class:`ClientRawResponse` :raises: :class:`BatchErrorException` """ @@ -257,10 +261,13 @@ def get( deserialized response :param operation_config: :ref:`Operation configuration overrides`. + :return: :class:`CloudJobSchedule + ` or + :class:`ClientRawResponse` if + raw=true :rtype: :class:`CloudJobSchedule - ` - :rtype: :class:`ClientRawResponse` - if raw=true + ` or + :class:`ClientRawResponse` :raises: :class:`BatchErrorException` """ @@ -387,9 +394,11 @@ def patch( deserialized response :param operation_config: :ref:`Operation configuration overrides`. - :rtype: None - :rtype: :class:`ClientRawResponse` - if raw=true + :return: None or + :class:`ClientRawResponse` if + raw=true + :rtype: None or + :class:`ClientRawResponse` :raises: :class:`BatchErrorException` """ @@ -503,9 +512,11 @@ def update( deserialized response :param operation_config: :ref:`Operation configuration overrides`. - :rtype: None - :rtype: :class:`ClientRawResponse` - if raw=true + :return: None or + :class:`ClientRawResponse` if + raw=true + :rtype: None or + :class:`ClientRawResponse` :raises: :class:`BatchErrorException` """ @@ -610,9 +621,11 @@ def disable( deserialized response :param operation_config: :ref:`Operation configuration overrides`. - :rtype: None - :rtype: :class:`ClientRawResponse` - if raw=true + :return: None or + :class:`ClientRawResponse` if + raw=true + :rtype: None or + :class:`ClientRawResponse` :raises: :class:`BatchErrorException` """ @@ -711,9 +724,11 @@ def enable( deserialized response :param operation_config: :ref:`Operation configuration overrides`. - :rtype: None - :rtype: :class:`ClientRawResponse` - if raw=true + :return: None or + :class:`ClientRawResponse` if + raw=true + :rtype: None or + :class:`ClientRawResponse` :raises: :class:`BatchErrorException` """ @@ -813,9 +828,11 @@ def terminate( deserialized response :param operation_config: :ref:`Operation configuration overrides`. - :rtype: None - :rtype: :class:`ClientRawResponse` - if raw=true + :return: None or + :class:`ClientRawResponse` if + raw=true + :rtype: None or + :class:`ClientRawResponse` :raises: :class:`BatchErrorException` """ @@ -915,9 +932,11 @@ def add( deserialized response :param operation_config: :ref:`Operation configuration overrides`. - :rtype: None - :rtype: :class:`ClientRawResponse` - if raw=true + :return: None or + :class:`ClientRawResponse` if + raw=true + :rtype: None or + :class:`ClientRawResponse` :raises: :class:`BatchErrorException` """ @@ -994,6 +1013,8 @@ def list( deserialized response :param operation_config: :ref:`Operation configuration overrides`. + :return: An iterator like instance of :class:`CloudJobSchedule + ` :rtype: :class:`CloudJobSchedulePaged ` :raises: diff --git a/azure-batch/azure/batch/operations/pool_operations.py b/azure-batch/azure/batch/operations/pool_operations.py old mode 100755 new mode 100644 index a42c6f9754a5..bf5bb6c16815 --- a/azure-batch/azure/batch/operations/pool_operations.py +++ b/azure-batch/azure/batch/operations/pool_operations.py @@ -9,8 +9,8 @@ # regenerated. # -------------------------------------------------------------------------- -from msrest.pipeline import ClientRawResponse import uuid +from msrest.pipeline import ClientRawResponse from .. import models @@ -41,7 +41,10 @@ def list_usage_metrics( If you do not specify a $filter clause including a poolId, the response includes all pools that existed in the account in the time range of the - returned aggregation intervals. + returned aggregation intervals. If you do not specify a $filter clause + including a startTime or endTime these filters default to the start and + end times of the last aggregation interval currently available; that + is, only the last aggregation interval is returned. :param pool_list_usage_metrics_options: Additional parameters for the operation @@ -53,6 +56,8 @@ def list_usage_metrics( deserialized response :param operation_config: :ref:`Operation configuration overrides`. + :return: An iterator like instance of :class:`PoolUsageMetrics + ` :rtype: :class:`PoolUsageMetricsPaged ` :raises: @@ -162,9 +167,11 @@ def get_all_lifetime_statistics( deserialized response :param operation_config: :ref:`Operation configuration overrides`. - :rtype: :class:`PoolStatistics ` - :rtype: :class:`ClientRawResponse` - if raw=true + :return: :class:`PoolStatistics ` + or :class:`ClientRawResponse` if + raw=true + :rtype: :class:`PoolStatistics ` or + :class:`ClientRawResponse` :raises: :class:`BatchErrorException` """ @@ -251,9 +258,11 @@ def add( deserialized response :param operation_config: :ref:`Operation configuration overrides`. - :rtype: None - :rtype: :class:`ClientRawResponse` - if raw=true + :return: None or + :class:`ClientRawResponse` if + raw=true + :rtype: None or + :class:`ClientRawResponse` :raises: :class:`BatchErrorException` """ @@ -329,6 +338,8 @@ def list( deserialized response :param operation_config: :ref:`Operation configuration overrides`. + :return: An iterator like instance of :class:`CloudPool + ` :rtype: :class:`CloudPoolPaged ` :raises: :class:`BatchErrorException` @@ -446,9 +457,11 @@ def delete( deserialized response :param operation_config: :ref:`Operation configuration overrides`. - :rtype: None - :rtype: :class:`ClientRawResponse` - if raw=true + :return: None or + :class:`ClientRawResponse` if + raw=true + :rtype: None or + :class:`ClientRawResponse` :raises: :class:`BatchErrorException` """ @@ -543,9 +556,11 @@ def exists( deserialized response :param operation_config: :ref:`Operation configuration overrides`. - :rtype: bool - :rtype: :class:`ClientRawResponse` - if raw=true + :return: bool or + :class:`ClientRawResponse` if + raw=true + :rtype: bool or + :class:`ClientRawResponse` :raises: :class:`BatchErrorException` """ @@ -644,9 +659,11 @@ def get( deserialized response :param operation_config: :ref:`Operation configuration overrides`. - :rtype: :class:`CloudPool ` - :rtype: :class:`ClientRawResponse` - if raw=true + :return: :class:`CloudPool ` or + :class:`ClientRawResponse` if + raw=true + :rtype: :class:`CloudPool ` or + :class:`ClientRawResponse` :raises: :class:`BatchErrorException` """ @@ -770,9 +787,11 @@ def patch( deserialized response :param operation_config: :ref:`Operation configuration overrides`. - :rtype: None - :rtype: :class:`ClientRawResponse` - if raw=true + :return: None or + :class:`ClientRawResponse` if + raw=true + :rtype: None or + :class:`ClientRawResponse` :raises: :class:`BatchErrorException` """ @@ -877,9 +896,11 @@ def disable_auto_scale( deserialized response :param operation_config: :ref:`Operation configuration overrides`. - :rtype: None - :rtype: :class:`ClientRawResponse` - if raw=true + :return: None or + :class:`ClientRawResponse` if + raw=true + :rtype: None or + :class:`ClientRawResponse` :raises: :class:`BatchErrorException` """ @@ -987,9 +1008,11 @@ def enable_auto_scale( deserialized response :param operation_config: :ref:`Operation configuration overrides`. - :rtype: None - :rtype: :class:`ClientRawResponse` - if raw=true + :return: None or + :class:`ClientRawResponse` if + raw=true + :rtype: None or + :class:`ClientRawResponse` :raises: :class:`BatchErrorException` """ @@ -1083,7 +1106,8 @@ def evaluate_auto_scale( """Gets the result of evaluating an automatic scaling formula on the pool. This API is primarily for validating an autoscale formula, as it simply - returns the result without applying the formula to the pool. + returns the result without applying the formula to the pool. The pool + must have auto scaling enabled in order to evaluate a formula. :param pool_id: The ID of the pool on which to evaluate the automatic scaling formula. @@ -1106,9 +1130,11 @@ def evaluate_auto_scale( deserialized response :param operation_config: :ref:`Operation configuration overrides`. - :rtype: :class:`AutoScaleRun ` - :rtype: :class:`ClientRawResponse` - if raw=true + :return: :class:`AutoScaleRun ` or + :class:`ClientRawResponse` if + raw=true + :rtype: :class:`AutoScaleRun ` or + :class:`ClientRawResponse` :raises: :class:`BatchErrorException` """ @@ -1212,9 +1238,11 @@ def resize( deserialized response :param operation_config: :ref:`Operation configuration overrides`. - :rtype: None - :rtype: :class:`ClientRawResponse` - if raw=true + :return: None or + :class:`ClientRawResponse` if + raw=true + :rtype: None or + :class:`ClientRawResponse` :raises: :class:`BatchErrorException` """ @@ -1308,9 +1336,12 @@ def stop_resize( This does not restore the pool to its previous state before the resize operation: it only stops any further changes being made, and the pool - maintains its current state. A resize operation need not be an explicit - resize pool request; this API can also be used to halt the initial - sizing of the pool when it is created. + maintains its current state. After stopping, the pool stabilizes at the + number of nodes it was at when the stop operation was done. During the + stop operation, the pool allocation state changes first to stopping and + then to steady. A resize operation need not be an explicit resize pool + request; this API can also be used to halt the initial sizing of the + pool when it is created. :param pool_id: The ID of the pool whose resizing you want to stop. :type pool_id: str @@ -1323,9 +1354,11 @@ def stop_resize( deserialized response :param operation_config: :ref:`Operation configuration overrides`. - :rtype: None - :rtype: :class:`ClientRawResponse` - if raw=true + :return: None or + :class:`ClientRawResponse` if + raw=true + :rtype: None or + :class:`ClientRawResponse` :raises: :class:`BatchErrorException` """ @@ -1435,9 +1468,11 @@ def update_properties( deserialized response :param operation_config: :ref:`Operation configuration overrides`. - :rtype: None - :rtype: :class:`ClientRawResponse` - if raw=true + :return: None or + :class:`ClientRawResponse` if + raw=true + :rtype: None or + :class:`ClientRawResponse` :raises: :class:`BatchErrorException` """ @@ -1520,7 +1555,13 @@ def upgrade_os( (particularly on small pools); therefore, the pool may be temporarily unavailable to run tasks. When this operation runs, the pool state changes to upgrading. When all compute nodes have finished upgrading, - the pool state returns to active. + the pool state returns to active. While the upgrade is in progress, the + pool's currentOSVersion reflects the OS version that nodes are + upgrading from, and targetOSVersion reflects the OS version that nodes + are upgrading to. Once the upgrade is complete, currentOSVersion is + updated to reflect the OS version now running on all nodes. This + operation can only be invoked on pools created with the + cloudServiceConfiguration property. :param pool_id: The ID of the pool to upgrade. :type pool_id: str @@ -1536,9 +1577,11 @@ def upgrade_os( deserialized response :param operation_config: :ref:`Operation configuration overrides`. - :rtype: None - :rtype: :class:`ClientRawResponse` - if raw=true + :return: None or + :class:`ClientRawResponse` if + raw=true + :rtype: None or + :class:`ClientRawResponse` :raises: :class:`BatchErrorException` """ @@ -1650,9 +1693,11 @@ def remove_nodes( deserialized response :param operation_config: :ref:`Operation configuration overrides`. - :rtype: None - :rtype: :class:`ClientRawResponse` - if raw=true + :return: None or + :class:`ClientRawResponse` if + raw=true + :rtype: None or + :class:`ClientRawResponse` :raises: :class:`BatchErrorException` """ diff --git a/azure-batch/azure/batch/operations/task_operations.py b/azure-batch/azure/batch/operations/task_operations.py old mode 100755 new mode 100644 index 744aa2cc5698..8bff90a14847 --- a/azure-batch/azure/batch/operations/task_operations.py +++ b/azure-batch/azure/batch/operations/task_operations.py @@ -9,8 +9,8 @@ # regenerated. # -------------------------------------------------------------------------- -from msrest.pipeline import ClientRawResponse import uuid +from msrest.pipeline import ClientRawResponse from .. import models @@ -51,9 +51,11 @@ def add( deserialized response :param operation_config: :ref:`Operation configuration overrides`. - :rtype: None - :rtype: :class:`ClientRawResponse` - if raw=true + :return: None or + :class:`ClientRawResponse` if + raw=true + :rtype: None or + :class:`ClientRawResponse` :raises: :class:`BatchErrorException` """ @@ -139,6 +141,8 @@ def list( deserialized response :param operation_config: :ref:`Operation configuration overrides`. + :return: An iterator like instance of :class:`CloudTask + ` :rtype: :class:`CloudTaskPaged ` :raises: :class:`BatchErrorException` @@ -243,13 +247,20 @@ def add_collection( processed, or not at all. In such cases, the user should re-issue the request. Note that it is up to the user to correctly handle failures when re-issuing a request. For example, you should use the same task - ids during a retry so that if the prior operation succeeded, the retry - will not create extra tasks unexpectedly. + IDs during a retry so that if the prior operation succeeded, the retry + will not create extra tasks unexpectedly. If the response contains any + tasks which failed to add, a client can retry the request. In a retry, + it is most efficient to resubmit only tasks that failed to add, and to + omit tasks that were successfully added on the first attempt. :param job_id: The ID of the job to which the task collection is to be added. :type job_id: str - :param value: The collection of tasks to add. + :param value: The collection of tasks to add. The total serialized + size of this collection must be less than 4MB. If it is greater than + 4MB (for example if each task has 100's of resource files or + environment variables), the request will fail with code + 'RequestBodyTooLarge' and should be retried again with fewer tasks. :type value: list of :class:`TaskAddParameter ` :param task_add_collection_options: Additional parameters for the @@ -261,10 +272,13 @@ def add_collection( deserialized response :param operation_config: :ref:`Operation configuration overrides`. + :return: :class:`TaskAddCollectionResult + ` or + :class:`ClientRawResponse` if + raw=true :rtype: :class:`TaskAddCollectionResult - ` - :rtype: :class:`ClientRawResponse` - if raw=true + ` or + :class:`ClientRawResponse` :raises: :class:`BatchErrorException` """ @@ -361,9 +375,11 @@ def delete( deserialized response :param operation_config: :ref:`Operation configuration overrides`. - :rtype: None - :rtype: :class:`ClientRawResponse` - if raw=true + :return: None or + :class:`ClientRawResponse` if + raw=true + :rtype: None or + :class:`ClientRawResponse` :raises: :class:`BatchErrorException` """ @@ -465,9 +481,11 @@ def get( deserialized response :param operation_config: :ref:`Operation configuration overrides`. - :rtype: :class:`CloudTask ` - :rtype: :class:`ClientRawResponse` - if raw=true + :return: :class:`CloudTask ` or + :class:`ClientRawResponse` if + raw=true + :rtype: :class:`CloudTask ` or + :class:`ClientRawResponse` :raises: :class:`BatchErrorException` """ @@ -583,7 +601,9 @@ def update( :type task_update_options: :class:`TaskUpdateOptions ` :param constraints: Constraints that apply to this task. If omitted, - the task is given the default constraints. + the task is given the default constraints. For multi-instance tasks, + updating the retention time applies only to the primary task and not + subtasks. :type constraints: :class:`TaskConstraints ` :param dict custom_headers: headers that will be added to the request @@ -591,9 +611,11 @@ def update( deserialized response :param operation_config: :ref:`Operation configuration overrides`. - :rtype: None - :rtype: :class:`ClientRawResponse` - if raw=true + :return: None or + :class:`ClientRawResponse` if + raw=true + :rtype: None or + :class:`ClientRawResponse` :raises: :class:`BatchErrorException` """ @@ -704,10 +726,13 @@ def list_subtasks( deserialized response :param operation_config: :ref:`Operation configuration overrides`. + :return: :class:`CloudTaskListSubtasksResult + ` or + :class:`ClientRawResponse` if + raw=true :rtype: :class:`CloudTaskListSubtasksResult - ` - :rtype: :class:`ClientRawResponse` - if raw=true + ` or + :class:`ClientRawResponse` :raises: :class:`BatchErrorException` """ @@ -806,9 +831,11 @@ def terminate( deserialized response :param operation_config: :ref:`Operation configuration overrides`. - :rtype: None - :rtype: :class:`ClientRawResponse` - if raw=true + :return: None or + :class:`ClientRawResponse` if + raw=true + :rtype: None or + :class:`ClientRawResponse` :raises: :class:`BatchErrorException` """ @@ -895,14 +922,16 @@ def terminate( def reactivate( self, job_id, task_id, task_reactivate_options=None, custom_headers=None, raw=False, **operation_config): - """Reactivates the specified task. + """Reactivates a task, allowing it to run again even if its retry count + has been exhausted. Reactivation makes a task eligible to be retried again up to its maximum retry count. The task's state is changed to active. As the task - is no longer in the completed state, any previous exit code or - scheduling error is no longer available after reactivation. This will - fail for tasks that are not completed or that previously completed - successfully (with an exit code of 0). Additionally, this will fail if + is no longer in the completed state, any previous exit code or failure + information is no longer available after reactivation. Each time a task + is reactivated, its retry count is reset to 0. Reactivation will fail + for tasks that are not completed or that previously completed + successfully (with an exit code of 0). Additionally, it will fail if the job has completed (or is terminating or deleting). :param job_id: The ID of the job containing the task. @@ -918,9 +947,11 @@ def reactivate( deserialized response :param operation_config: :ref:`Operation configuration overrides`. - :rtype: None - :rtype: :class:`ClientRawResponse` - if raw=true + :return: None or + :class:`ClientRawResponse` if + raw=true + :rtype: None or + :class:`ClientRawResponse` :raises: :class:`BatchErrorException` """ diff --git a/azure-batch/azure/batch/version.py b/azure-batch/azure/batch/version.py old mode 100755 new mode 100644 index 24a18964e554..9797f3dd0011 --- a/azure-batch/azure/batch/version.py +++ b/azure-batch/azure/batch/version.py @@ -10,3 +10,4 @@ # -------------------------------------------------------------------------- VERSION = "3.1.0" + diff --git a/azure-batch/build.json b/azure-batch/build.json index b32d091aaf04..a409ad31314e 100644 --- a/azure-batch/build.json +++ b/azure-batch/build.json @@ -1 +1 @@ -{"autorest": "1.0.1-20170517-2300-nightly", "date": "2017-05-18T22:46:36Z", "version": ""} \ No newline at end of file +{"autorest": "1.2.2", "date": "2017-08-17T18:02:06Z", "version": ""} \ No newline at end of file