azure.mgmt.batch.models module

class azure.mgmt.batch.models.AutoStorageBaseProperties(storage_account_id)[source]

Bases: msrest.serialization.Model

The properties related to the auto-storage account.

Parameters:storage_account_id (str) – The resource ID of the storage account to be used for auto-storage account.
class azure.mgmt.batch.models.KeyVaultReference(id, url)[source]

Bases: msrest.serialization.Model

Identifies the Azure key vault associated with a Batch account.

Parameters:
  • id (str) – The resource ID of the Azure key vault associated with the Batch account.
  • url (str) – The URL of the Azure key vault associated with the Batch account.
class azure.mgmt.batch.models.BatchAccountCreateParameters(location, tags=None, auto_storage=None, pool_allocation_mode=None, key_vault_reference=None)[source]

Bases: msrest.serialization.Model

Parameters supplied to the Create operation.

Parameters:
  • location (str) – The region in which to create the account.
  • tags (dict) – The user-specified tags associated with the account.
  • auto_storage (AutoStorageBaseProperties) – The properties related to the auto-storage account.
  • pool_allocation_mode (str or PoolAllocationMode) – The allocation mode to use for creating pools in the Batch account. The pool allocation mode also affects how clients may authenticate to the Batch Service API. If the mode is BatchService, clients may authenticate using access keys or Azure Active Directory. If the mode is UserSubscription, clients must use Azure Active Directory. The default is BatchService. Possible values include: ‘BatchService’, ‘UserSubscription’
  • key_vault_reference (KeyVaultReference) – A reference to the Azure key vault associated with the Batch account.
class azure.mgmt.batch.models.AutoStorageProperties(storage_account_id, last_key_sync)[source]

Bases: azure.mgmt.batch.models.auto_storage_base_properties.AutoStorageBaseProperties

Contains information about the auto-storage account associated with a Batch account.

Parameters:
  • storage_account_id (str) – The resource ID of the storage account to be used for auto-storage account.
  • last_key_sync (datetime) – The UTC time at which storage keys were last synchronized with the Batch account.
class azure.mgmt.batch.models.BatchAccount[source]

Bases: azure.mgmt.batch.models.resource.Resource

Contains information about an Azure Batch account.

Variables are only populated by the server, and will be ignored when sending a request.

Variables:
  • id (str) – The ID of the resource.
  • name (str) – The name of the resource.
  • type (str) – The type of the resource.
  • location (str) – The location of the resource.
  • tags (dict) – The tags of the resource.
  • account_endpoint (str) – The account endpoint used to interact with the Batch service.
  • provisioning_state (str or ProvisioningState) – The provisioned state of the resource. Possible values include: ‘Invalid’, ‘Creating’, ‘Deleting’, ‘Succeeded’, ‘Failed’, ‘Cancelled’
  • pool_allocation_mode (str or PoolAllocationMode) – The allocation mode to use for creating pools in the Batch account. Possible values include: ‘BatchService’, ‘UserSubscription’
  • key_vault_reference (KeyVaultReference) – A reference to the Azure key vault associated with the Batch account.
  • auto_storage (AutoStorageProperties) – The properties and status of any auto-storage account associated with the Batch account.
  • dedicated_core_quota (int) – The dedicated core quota for this Batch account.
  • low_priority_core_quota (int) – The low-priority core quota for this Batch account.
  • pool_quota (int) – The pool quota for this Batch account.
  • active_job_and_job_schedule_quota (int) – The active job and job schedule quota for this Batch account.
class azure.mgmt.batch.models.BatchAccountUpdateParameters(tags=None, auto_storage=None)[source]

Bases: msrest.serialization.Model

Parameters for updating an Azure Batch account.

Parameters:
  • tags (dict) – The user-specified tags associated with the account.
  • auto_storage (AutoStorageBaseProperties) – The properties related to the auto-storage account.
class azure.mgmt.batch.models.BatchAccountRegenerateKeyParameters(key_name)[source]

Bases: msrest.serialization.Model

Parameters supplied to the RegenerateKey operation.

Parameters:key_name (str or AccountKeyType) – The type of account key to regenerate. Possible values include: ‘Primary’, ‘Secondary’
class azure.mgmt.batch.models.BatchAccountKeys[source]

Bases: msrest.serialization.Model

A set of Azure Batch account keys.

Variables are only populated by the server, and will be ignored when sending a request.

Variables:
  • account_name (str) – The Batch account name.
  • primary (str) – The primary key associated with the account.
  • secondary (str) – The secondary key associated with the account.
class azure.mgmt.batch.models.ActivateApplicationPackageParameters(format)[source]

Bases: msrest.serialization.Model

Parameters for an activating an application package.

Parameters:format (str) – The format of the application package binary file.
class azure.mgmt.batch.models.ApplicationCreateParameters(allow_updates=None, display_name=None)[source]

Bases: msrest.serialization.Model

Parameters for adding an Application.

Parameters:
  • allow_updates (bool) – A value indicating whether packages within the application may be overwritten using the same version string.
  • display_name (str) – The display name for the application.
class azure.mgmt.batch.models.ApplicationPackage[source]

Bases: msrest.serialization.Model

An application package which represents a particular version of an application.

Variables are only populated by the server, and will be ignored when sending a request.

Variables:
  • id (str) – The ID of the application.
  • version (str) – The version of the application package.
  • state (str or PackageState) – The current state of the application package. Possible values include: ‘pending’, ‘active’, ‘unmapped’
  • format (str) – The format of the application package, if the package is active.
  • storage_url (str) – The URL for the application package in Azure Storage.
  • storage_url_expiry (datetime) – The UTC time at which the Azure Storage URL will expire.
  • last_activation_time (datetime) – The time at which the package was last activated, if the package is active.
class azure.mgmt.batch.models.Application(id=None, display_name=None, packages=None, allow_updates=None, default_version=None)[source]

Bases: msrest.serialization.Model

Contains information about an application in a Batch account.

Parameters:
  • id (str) – A string that uniquely identifies the application within the account.
  • display_name (str) – The display name for the application.
  • packages (list of ApplicationPackage) – The list of packages under this application.
  • allow_updates (bool) – A value indicating whether packages within the application may be overwritten using the same version string.
  • default_version (str) – The package to use if a client requests the application but does not specify a version.
class azure.mgmt.batch.models.ApplicationUpdateParameters(allow_updates=None, default_version=None, display_name=None)[source]

Bases: msrest.serialization.Model

Parameters for an update application request.

Parameters:
  • allow_updates (bool) – A value indicating whether packages within the application may be overwritten using the same version string.
  • default_version (str) – The package to use if a client requests the application but does not specify a version.
  • display_name (str) – The display name for the application.
class azure.mgmt.batch.models.BatchLocationQuota[source]

Bases: msrest.serialization.Model

Quotas associated with a Batch region for a particular subscription.

Variables are only populated by the server, and will be ignored when sending a request.

Variables:account_quota (int) – The number of Batch accounts that may be created under the subscription in the specified region.
class azure.mgmt.batch.models.Resource[source]

Bases: msrest.serialization.Model

A definition of an Azure resource.

Variables are only populated by the server, and will be ignored when sending a request.

Variables:
  • id (str) – The ID of the resource.
  • name (str) – The name of the resource.
  • type (str) – The type of the resource.
  • location (str) – The location of the resource.
  • tags (dict) – The tags of the resource.
class azure.mgmt.batch.models.OperationDisplay(provider=None, operation=None, resource=None, description=None)[source]

Bases: msrest.serialization.Model

The object that describes the operation.

Parameters:
  • provider (str) – Friendly name of the resource provider.
  • operation (str) – The operation type. For example: read, write, delete, or listKeys/action
  • resource (str) – The resource type on which the operation is performed.
  • description (str) – The friendly name of the operation.
class azure.mgmt.batch.models.Operation(name=None, display=None, origin=None, properties=None)[source]

Bases: msrest.serialization.Model

A REST API operation.

Parameters:
  • name (str) – The operation name. This is of the format {provider}/{resource}/{operation}
  • display (OperationDisplay) – The object that describes the operation.
  • origin (str) – The intended executor of the operation.
  • properties (object) – Properties of the operation.
class azure.mgmt.batch.models.CheckNameAvailabilityParameters(name)[source]

Bases: msrest.serialization.Model

Parameters for a check name availability request.

Variables are only populated by the server, and will be ignored when sending a request.

Parameters:name (str) – The name to check for availability
Variables:type (str) – The resource type. Must be set to Microsoft.Batch/batchAccounts. Default value: “Microsoft.Batch/batchAccounts” .
type = 'Microsoft.Batch/batchAccounts'
class azure.mgmt.batch.models.CheckNameAvailabilityResult[source]

Bases: msrest.serialization.Model

The CheckNameAvailability operation response.

Variables are only populated by the server, and will be ignored when sending a request.

Variables:
  • name_available (bool) – Gets a boolean value that indicates whether the name is available for you to use. If true, the name is available. If false, the name has already been taken or invalid and cannot be used.
  • reason (str or NameAvailabilityReason) – Gets the reason that a Batch account name could not be used. The Reason element is only returned if NameAvailable is false. Possible values include: ‘Invalid’, ‘AlreadyExists’
  • message (str) – Gets an error message explaining the Reason value in more detail.
class azure.mgmt.batch.models.BatchAccountPaged(*args, **kwargs)[source]

Bases: msrest.paging.Paged

A paging container for iterating over a list of BatchAccount object

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

Bases: msrest.paging.Paged

A paging container for iterating over a list of Application object

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

Bases: msrest.paging.Paged

A paging container for iterating over a list of Operation object

class azure.mgmt.batch.models.PoolAllocationMode[source]

Bases: enum.Enum

batch_service = 'BatchService'
user_subscription = 'UserSubscription'
class azure.mgmt.batch.models.ProvisioningState[source]

Bases: enum.Enum

cancelled = 'Cancelled'
creating = 'Creating'
deleting = 'Deleting'
failed = 'Failed'
invalid = 'Invalid'
succeeded = 'Succeeded'
class azure.mgmt.batch.models.AccountKeyType[source]

Bases: enum.Enum

primary = 'Primary'
secondary = 'Secondary'
class azure.mgmt.batch.models.PackageState[source]

Bases: enum.Enum

active = 'active'
pending = 'pending'
unmapped = 'unmapped'
class azure.mgmt.batch.models.NameAvailabilityReason[source]

Bases: enum.Enum

already_exists = 'AlreadyExists'
invalid = 'Invalid'