Merge branch 'restapi_auto_datamigration/resource-manager' of https://github.com/vchske/azure-sdk-for-python into restapi_auto_datamigration/resource-manager

Author: vchske

azure-batch/HISTORY.rst

@@ -3,6 +3,12 @@
 Release History
 ===============
 
+4.1.3 (2018-04-24)
+++++++++++++++++++
+
+- Update some APIs' comments
+- New property `leaving_pool` in `node_counts` type.
+
 4.1.2 (2018-04-23)
 ++++++++++++++++++
 

azure-batch/azure/batch/models/cloud_job.py

@@ -99,7 +99,9 @@ class CloudJob(Model):
     :param execution_info: The execution information for the job.
     :type execution_info: ~azure.batch.models.JobExecutionInformation
     :param stats: Resource usage statistics for the entire lifetime of the
-     job.
+     job. The statistics may not be immediately available. The Batch service
+     performs periodic roll-up of statistics. The typical delay is about 30
+     minutes.
     :type stats: ~azure.batch.models.JobStatistics
     """
 

azure-batch/azure/batch/models/cloud_job_schedule.py

@@ -64,6 +64,9 @@ class CloudJobSchedule(Model):
      is solely for the use of user code.
     :type metadata: list[~azure.batch.models.MetadataItem]
     :param stats: The lifetime resource usage statistics for the job schedule.
+     The statistics may not be immediately available. The Batch service
+     performs periodic roll-up of statistics. The typical delay is about 30
+     minutes.
     :type stats: ~azure.batch.models.JobScheduleStatistics
     """
 

azure-batch/azure/batch/models/cloud_pool.py

@@ -56,7 +56,7 @@ class CloudPool(Model):
      machines in a pool are the same size. For information about available
      sizes of virtual machines for Cloud Services pools (pools created with
      cloudServiceConfiguration), see Sizes for Cloud Services
-     (http://azure.microsoft.com/documentation/articles/cloud-services-sizes-specs/).
+     (https://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
@@ -165,7 +165,9 @@ class CloudPool(Model):
      metadata.
     :type metadata: list[~azure.batch.models.MetadataItem]
     :param stats: Utilization and resource usage statistics for the entire
-     lifetime of the pool.
+     lifetime of the pool. The statistics may not be immediately available. The
+     Batch service performs periodic roll-up of statistics. The typical delay
+     is about 30 minutes.
     :type stats: ~azure.batch.models.PoolStatistics
     """
 

azure-batch/azure/batch/models/cloud_task.py

@@ -15,6 +15,17 @@
 class CloudTask(Model):
     """An Azure Batch task.
 
+    Batch will retry tasks when a recovery operation is triggered on a compute
+    node. Examples of recovery operations include (but are not limited to) when
+    an unhealthy compute node is rebooted or a compute node disappeared due to
+    host failure. Retries due to recovery operations are independent of and are
+    not counted against the maxTaskRetryCount. Even if the maxTaskRetryCount is
+    0, an internal retry due to a recovery operation may occur. Because of
+    this, all tasks should be idempotent. This means tasks need to tolerate
+    being interrupted and restarted without causing any corruption or duplicate
+    data. The best practice for long running tasks is to use some form of
+    checkpointing.
+
     :param id: A string that uniquely identifies the task within the job. The
      ID can contain any combination of alphanumeric characters including
      hyphens and underscores, and cannot contain more than 64 characters.
@@ -59,7 +70,10 @@ class CloudTask(Model):
      take advantage of shell features such as environment variable expansion.
      If you want to take advantage of such features, you should invoke the
      shell in the command line, for example using "cmd /c MyCommand" in Windows
-     or "/bin/sh -c MyCommand" in Linux.
+     or "/bin/sh -c MyCommand" in Linux. If the command line refers to file
+     paths, it should use a relative path (relative to the task working
+     directory), or use the Batch provided environment variable
+     (https://docs.microsoft.com/en-us/azure/batch/batch-compute-node-environment-variables).
     :type command_line: str
     :param container_settings: The settings for the container under which the
      task runs. If the pool that will run this task has containerConfiguration

azure-batch/azure/batch/models/compute_node.py

@@ -56,7 +56,7 @@ class ComputeNode(Model):
      For information about available sizes of virtual machines for Cloud
      Services pools (pools created with cloudServiceConfiguration), see Sizes
      for Cloud Services
-     (http://azure.microsoft.com/documentation/articles/cloud-services-sizes-specs/).
+     (https://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

azure-batch/azure/batch/models/job_manager_task.py

@@ -28,6 +28,16 @@ class JobManagerTask(Model):
     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.
+    Batch will retry tasks when a recovery operation is triggered on a compute
+    node. Examples of recovery operations include (but are not limited to) when
+    an unhealthy compute node is rebooted or a compute node disappeared due to
+    host failure. Retries due to recovery operations are independent of and are
+    not counted against the maxTaskRetryCount. Even if the maxTaskRetryCount is
+    0, an internal retry due to a recovery operation may occur. Because of
+    this, all tasks should be idempotent. This means tasks need to tolerate
+    being interrupted and restarted without causing any corruption or duplicate
+    data. The best practice for long running tasks is to use some form of
+    checkpointing.
 
     :param id: A string that uniquely identifies the Job Manager task within
      the job. The ID can contain any combination of alphanumeric characters
@@ -43,7 +53,10 @@ class JobManagerTask(Model):
      shell features such as environment variable expansion. If you want to take
      advantage of such features, you should invoke the shell in the command
      line, for example using "cmd /c MyCommand" in Windows or "/bin/sh -c
-     MyCommand" in Linux.
+     MyCommand" in Linux. If the command line refers to file paths, it should
+     use a relative path (relative to the task working directory), or use the
+     Batch provided environment variable
+     (https://docs.microsoft.com/en-us/azure/batch/batch-compute-node-environment-variables).
     :type command_line: str
     :param container_settings: The settings for the container under which the
      Job Manager task runs. If the pool that will run this task has
@@ -118,7 +131,7 @@ class JobManagerTask(Model):
     :type authentication_token_settings:
      ~azure.batch.models.AuthenticationTokenSettings
     :param allow_low_priority_node: Whether the Job Manager task may run on a
-     low-priority compute node. The default value is false.
+     low-priority compute node. The default value is true.
     :type allow_low_priority_node: bool
     """
 

azure-batch/azure/batch/models/job_preparation_task.py

@@ -32,7 +32,17 @@ class JobPreparationTask(Model):
     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.
+    Preparation task is run again before scheduling any task of the job. Batch
+    will retry tasks when a recovery operation is triggered on a compute node.
+    Examples of recovery operations include (but are not limited to) when an
+    unhealthy compute node is rebooted or a compute node disappeared due to
+    host failure. Retries due to recovery operations are independent of and are
+    not counted against the maxTaskRetryCount. Even if the maxTaskRetryCount is
+    0, an internal retry due to a recovery operation may occur. Because of
+    this, all tasks should be idempotent. This means tasks need to tolerate
+    being interrupted and restarted without causing any corruption or duplicate
+    data. The best practice for long running tasks is to use some form of
+    checkpointing.
 
     :param id: A string that uniquely identifies the Job Preparation task
      within the job. The ID can contain any combination of alphanumeric
@@ -49,7 +59,10 @@ class JobPreparationTask(Model):
      advantage of shell features such as environment variable expansion. If you
      want to take advantage of such features, you should invoke the shell in
      the command line, for example using "cmd /c MyCommand" in Windows or
-     "/bin/sh -c MyCommand" in Linux.
+     "/bin/sh -c MyCommand" in Linux. If the command line refers to file paths,
+     it should use a relative path (relative to the task working directory), or
+     use the Batch provided environment variable
+     (https://docs.microsoft.com/en-us/azure/batch/batch-compute-node-environment-variables).
     :type command_line: str
     :param container_settings: The settings for the container under which the
      Job Preparation task runs. When this is specified, all directories

azure-batch/azure/batch/models/job_release_task.py

@@ -48,7 +48,10 @@ class JobReleaseTask(Model):
      shell features such as environment variable expansion. If you want to take
      advantage of such features, you should invoke the shell in the command
      line, for example using "cmd /c MyCommand" in Windows or "/bin/sh -c
-     MyCommand" in Linux.
+     MyCommand" in Linux. If the command line refers to file paths, it should
+     use a relative path (relative to the task working directory), or use the
+     Batch provided environment variable
+     (https://docs.microsoft.com/en-us/azure/batch/batch-compute-node-environment-variables).
     :type command_line: str
     :param container_settings: The settings for the container under which the
      Job Release task runs. When this is specified, all directories recursively

azure-batch/azure/batch/models/node_counts.py

@@ -34,6 +34,8 @@ class NodeCounts(Model):
     :param start_task_failed: The number of nodes in the startTaskFailed
      state.
     :type start_task_failed: int
+    :param leaving_pool: The number of nodes in the leavingPool state.
+    :type leaving_pool: int
     :param unknown: The number of nodes in the unknown state.
     :type unknown: int
     :param unusable: The number of nodes in the unusable state.
@@ -55,6 +57,7 @@ class NodeCounts(Model):
         'running': {'required': True},
         'starting': {'required': True},
         'start_task_failed': {'required': True},
+        'leaving_pool': {'required': True},
         'unknown': {'required': True},
         'unusable': {'required': True},
         'waiting_for_start_task': {'required': True},
@@ -71,13 +74,14 @@ class NodeCounts(Model):
         'running': {'key': 'running', 'type': 'int'},
         'starting': {'key': 'starting', 'type': 'int'},
         'start_task_failed': {'key': 'startTaskFailed', 'type': 'int'},
+        'leaving_pool': {'key': 'leavingPool', 'type': 'int'},
         'unknown': {'key': 'unknown', 'type': 'int'},
         'unusable': {'key': 'unusable', 'type': 'int'},
         'waiting_for_start_task': {'key': 'waitingForStartTask', 'type': 'int'},
         'total': {'key': 'total', 'type': 'int'},
     }
 
-    def __init__(self, creating, idle, offline, preempted, rebooting, reimaging, running, starting, start_task_failed, unknown, unusable, waiting_for_start_task, total):
+    def __init__(self, creating, idle, offline, preempted, rebooting, reimaging, running, starting, start_task_failed, leaving_pool, unknown, unusable, waiting_for_start_task, total):
         super(NodeCounts, self).__init__()
         self.creating = creating
         self.idle = idle
@@ -88,6 +92,7 @@ def __init__(self, creating, idle, offline, preempted, rebooting, reimaging, run
         self.running = running
         self.starting = starting
         self.start_task_failed = start_task_failed
+        self.leaving_pool = leaving_pool
         self.unknown = unknown
         self.unusable = unusable
         self.waiting_for_start_task = waiting_for_start_task

azure-batch/azure/batch/models/pool_add_parameter.py

@@ -29,7 +29,7 @@ class PoolAddParameter(Model):
      machines in a pool are the same size. For information about available
      sizes of virtual machines for Cloud Services pools (pools created with
      cloudServiceConfiguration), see Sizes for Cloud Services
-     (http://azure.microsoft.com/documentation/articles/cloud-services-sizes-specs/).
+     (https://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

azure-batch/azure/batch/models/pool_specification.py

@@ -23,7 +23,7 @@ class PoolSpecification(Model):
      machines in a pool are the same size. For information about available
      sizes of virtual machines for Cloud Services pools (pools created with
      cloudServiceConfiguration), see Sizes for Cloud Services
-     (http://azure.microsoft.com/documentation/articles/cloud-services-sizes-specs/).
+     (https://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

azure-batch/azure/batch/models/start_task.py

@@ -16,12 +16,26 @@ class StartTask(Model):
     """A task which is run when a compute node joins a pool in the Azure Batch
     service, or when the compute node is rebooted or reimaged.
 
+    Batch will retry tasks when a recovery operation is triggered on a compute
+    node. Examples of recovery operations include (but are not limited to) when
+    an unhealthy compute node is rebooted or a compute node disappeared due to
+    host failure. Retries due to recovery operations are independent of and are
+    not counted against the maxTaskRetryCount. Even if the maxTaskRetryCount is
+    0, an internal retry due to a recovery operation may occur. Because of
+    this, all tasks should be idempotent. This means tasks need to tolerate
+    being interrupted and restarted without causing any corruption or duplicate
+    data. The best practice for long running tasks is to use some form of
+    checkpointing.
+
     :param command_line: The command line of the start task. The command line
      does not run under a shell, and therefore cannot take advantage of shell
      features such as environment variable expansion. If you want to take
      advantage of such features, you should invoke the shell in the command
      line, for example using "cmd /c MyCommand" in Windows or "/bin/sh -c
-     MyCommand" in Linux.
+     MyCommand" in Linux. If the command line refers to file paths, it should
+     use a relative path (relative to the task working directory), or use the
+     Batch provided environment variable
+     (https://docs.microsoft.com/en-us/azure/batch/batch-compute-node-environment-variables).
     :type command_line: str
     :param container_settings: The settings for the container under which the
      start task runs. When this is specified, all directories recursively below

azure-batch/azure/batch/models/task_add_parameter.py

@@ -15,6 +15,17 @@
 class TaskAddParameter(Model):
     """An Azure Batch task to add.
 
+    Batch will retry tasks when a recovery operation is triggered on a compute
+    node. Examples of recovery operations include (but are not limited to) when
+    an unhealthy compute node is rebooted or a compute node disappeared due to
+    host failure. Retries due to recovery operations are independent of and are
+    not counted against the maxTaskRetryCount. Even if the maxTaskRetryCount is
+    0, an internal retry due to a recovery operation may occur. Because of
+    this, all tasks should be idempotent. This means tasks need to tolerate
+    being interrupted and restarted without causing any corruption or duplicate
+    data. The best practice for long running tasks is to use some form of
+    checkpointing.
+
     :param id: A string that uniquely identifies the task within the job. The
      ID can contain any combination of alphanumeric characters including
      hyphens and underscores, and cannot contain more than 64 characters. The
@@ -32,7 +43,10 @@ class TaskAddParameter(Model):
      take advantage of shell features such as environment variable expansion.
      If you want to take advantage of such features, you should invoke the
      shell in the command line, for example using "cmd /c MyCommand" in Windows
-     or "/bin/sh -c MyCommand" in Linux.
+     or "/bin/sh -c MyCommand" in Linux. If the command line refers to file
+     paths, it should use a relative path (relative to the task working
+     directory), or use the Batch provided environment variable
+     (https://docs.microsoft.com/en-us/azure/batch/batch-compute-node-environment-variables).
     :type command_line: str
     :param container_settings: The settings for the container under which the
      task runs. If the pool that will run this task has containerConfiguration

azure-batch/azure/batch/models/task_constraints.py

@@ -28,12 +28,15 @@ class TaskConstraints(Model):
     :type retention_time: timedelta
     :param max_task_retry_count: The maximum number of times the task may be
      retried. The Batch service retries a task if its exit code is nonzero.
-     Note that this value specifically controls the number of retries. The
-     Batch service will try the task once, and may then retry up to this limit.
-     For example, if the maximum retry count is 3, Batch tries the task up to 4
-     times (one initial try and 3 retries). If the maximum retry count is 0,
-     the Batch service does not retry the task. If the maximum retry count is
-     -1, the Batch service retries the task without limit.
+     Note that this value specifically controls the number of retries for the
+     task executable due to a nonzero exit code. The Batch service will try the
+     task once, and may then retry up to this limit. For example, if the
+     maximum retry count is 3, Batch tries the task up to 4 times (one initial
+     try and 3 retries). If the maximum retry count is 0, the Batch service
+     does not retry the task after the first attempt. If the maximum retry
+     count is -1, the Batch service retries the task without limit. Resource
+     files and application packages are only downloaded again if the task is
+     retried on a new compute node.
     :type max_task_retry_count: int
     """
 

azure-batch/azure/batch/models/user_identity.py

@@ -15,7 +15,10 @@
 class UserIdentity(Model):
     """The definition of the user identity under which the task is run.
 
-    Specify either the userName or autoUser property, but not both.
+    Specify either the userName or autoUser property, but not both. On
+    CloudServiceConfiguration pools, this user is logged in with the
+    INTERACTIVE flag. On Windows VirtualMachineConfiguration pools, this user
+    is logged in with the BATCH flag.
 
     :param user_name: The name of the user identity under which the task is
      run. The userName and autoUser properties are mutually exclusive; you must