Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Empty file modified azure-batch/azure/batch/__init__.py
100755 → 100644
Empty file.
Empty file modified azure-batch/azure/batch/batch_service_client.py
100755 → 100644
Empty file.
Empty file modified azure-batch/azure/batch/models/__init__.py
100755 → 100644
Empty file.
Empty file.
6 changes: 4 additions & 2 deletions azure-batch/azure/batch/models/affinity_information.py
100755 → 100644
Original file line number Diff line number Diff line change
Expand Up @@ -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
"""

Expand Down
Empty file modified azure-batch/azure/batch/models/application_get_options.py
100755 → 100644
Empty file.
Empty file modified azure-batch/azure/batch/models/application_list_options.py
100755 → 100644
Empty file.
9 changes: 5 additions & 4 deletions azure-batch/azure/batch/models/application_package_reference.py
100755 → 100644
Original file line number Diff line number Diff line change
Expand Up @@ -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
"""

Expand Down
2 changes: 1 addition & 1 deletion azure-batch/azure/batch/models/application_summary.py
100755 → 100644
Original file line number Diff line number Diff line change
Expand Up @@ -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
"""

Expand Down
2 changes: 1 addition & 1 deletion azure-batch/azure/batch/models/application_summary_paged.py
100755 → 100644
Original file line number Diff line number Diff line change
Expand Up @@ -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 <azure.batch.models.ApplicationSummary>` object
"""

_attribute_map = {
Expand Down
Empty file modified azure-batch/azure/batch/models/authentication_token_settings.py
100755 → 100644
Empty file.
15 changes: 9 additions & 6 deletions azure-batch/azure/batch/models/auto_pool_specification.py
100755 → 100644
Original file line number Diff line number Diff line change
Expand Up @@ -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
<azure.batch.models.PoolLifetimeOption>`
:param keep_alive: Whether to keep an auto pool alive after its lifetime
Expand Down
Empty file modified azure-batch/azure/batch/models/auto_scale_run.py
100755 → 100644
Empty file.
Empty file modified azure-batch/azure/batch/models/auto_scale_run_error.py
100755 → 100644
Empty file.
9 changes: 5 additions & 4 deletions azure-batch/azure/batch/models/auto_user_specification.py
100755 → 100644
Original file line number Diff line number Diff line change
Expand Up @@ -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
<azure.batch.models.AutoUserScope>`
:param elevation_level: The elevation level of the auto user. nonAdmin -
Expand Down
Empty file modified azure-batch/azure/batch/models/batch_error.py
100755 → 100644
Empty file.
Empty file modified azure-batch/azure/batch/models/batch_error_detail.py
100755 → 100644
Empty file.
Empty file modified azure-batch/azure/batch/models/batch_service_client_enums.py
100755 → 100644
Empty file.
Empty file modified azure-batch/azure/batch/models/certificate.py
100755 → 100644
Empty file.
Empty file modified azure-batch/azure/batch/models/certificate_add_options.py
100755 → 100644
Empty file.
Empty file modified azure-batch/azure/batch/models/certificate_add_parameter.py
100755 → 100644
Empty file.
Empty file.
Empty file modified azure-batch/azure/batch/models/certificate_delete_options.py
100755 → 100644
Empty file.
Empty file modified azure-batch/azure/batch/models/certificate_get_options.py
100755 → 100644
Empty file.
Empty file modified azure-batch/azure/batch/models/certificate_list_options.py
100755 → 100644
Empty file.
2 changes: 1 addition & 1 deletion azure-batch/azure/batch/models/certificate_paged.py
100755 → 100644
Original file line number Diff line number Diff line change
Expand Up @@ -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 <azure.batch.models.Certificate>` object
"""

_attribute_map = {
Expand Down
18 changes: 12 additions & 6 deletions azure-batch/azure/batch/models/certificate_reference.py
100755 → 100644
Original file line number Diff line number Diff line change
Expand Up @@ -34,14 +34,20 @@ class CertificateReference(Model):
:type store_location: str or :class:`CertificateStoreLocation
<azure.batch.models.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
<azure.batch.models.CertificateVisibility>`
"""
Expand Down
28 changes: 15 additions & 13 deletions azure-batch/azure/batch/models/cloud_job.py
100755 → 100644
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down Expand Up @@ -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
<azure.batch.models.EnvironmentSetting>`
:param pool_info: The pool settings associated with the job.
Expand All @@ -95,13 +95,15 @@ class CloudJob(Model):
:type on_all_tasks_complete: str or :class:`OnAllTasksComplete
<azure.batch.models.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
<azure.batch.models.OnTaskFailure>`
:param metadata: A list of name-value pairs associated with the job as
Expand Down
2 changes: 1 addition & 1 deletion azure-batch/azure/batch/models/cloud_job_paged.py
100755 → 100644
Original file line number Diff line number Diff line change
Expand Up @@ -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 <azure.batch.models.CloudJob>` object
"""

_attribute_map = {
Expand Down
2 changes: 1 addition & 1 deletion azure-batch/azure/batch/models/cloud_job_schedule.py
100755 → 100644
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
2 changes: 1 addition & 1 deletion azure-batch/azure/batch/models/cloud_job_schedule_paged.py
100755 → 100644
Original file line number Diff line number Diff line change
Expand Up @@ -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 <azure.batch.models.CloudJobSchedule>` object
"""

_attribute_map = {
Expand Down
45 changes: 24 additions & 21 deletions azure-batch/azure/batch/models/cloud_pool.py
100755 → 100644
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand All @@ -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 <azure.batch.models.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
<azure.batch.models.AllocationState>`
:param allocation_state_transition_time: The time at which the pool
Expand Down Expand Up @@ -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
<azure.batch.models.TaskSchedulingPolicy>`
:param user_accounts: The list of user accounts to be created on each node
Expand Down
2 changes: 1 addition & 1 deletion azure-batch/azure/batch/models/cloud_pool_paged.py
100755 → 100644
Original file line number Diff line number Diff line change
Expand Up @@ -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 <azure.batch.models.CloudPool>` object
"""

_attribute_map = {
Expand Down
Empty file modified azure-batch/azure/batch/models/cloud_service_configuration.py
100755 → 100644
Empty file.
7 changes: 6 additions & 1 deletion azure-batch/azure/batch/models/cloud_task.py
100755 → 100644
Original file line number Diff line number Diff line change
Expand Up @@ -112,7 +112,12 @@ class CloudTask(Model):
<azure.batch.models.TaskDependencies>`
: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
<azure.batch.models.ApplicationPackageReference>`
Expand Down
Empty file.
2 changes: 1 addition & 1 deletion azure-batch/azure/batch/models/cloud_task_paged.py
100755 → 100644
Original file line number Diff line number Diff line change
Expand Up @@ -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 <azure.batch.models.CloudTask>` object
"""

_attribute_map = {
Expand Down
Loading