batch/models/_batch_management_client_enums.py

# coding=utf-8
# --------------------------------------------------------------------------
# Copyright (c) Microsoft Corporation. All rights reserved.
# Licensed under the MIT License. See License.txt in the project root for license information.
# Code generated by Microsoft (R) AutoRest Code Generator.
# Changes may cause incorrect behavior and will be lost if the code is regenerated.
# --------------------------------------------------------------------------

from enum import Enum, EnumMeta
from six import with_metaclass

class _CaseInsensitiveEnumMeta(EnumMeta):
    def __getitem__(self, name):
        return super().__getitem__(name.upper())

    def __getattr__(cls, name):
        """Return the enum member matching `name`
        We use __getattr__ instead of descriptors or inserting into the enum
        class' __dict__ in order to support `name` and `value` being both
        properties for enum members (which live in the class' __dict__) and
        enum members themselves.
        """
        try:
            return cls._member_map_[name.upper()]
        except KeyError:
            raise AttributeError(name)


class AccountKeyType(with_metaclass(_CaseInsensitiveEnumMeta, str, Enum)):
    """The type of account key to regenerate.
    """

    #: The primary account key.
    PRIMARY = "Primary"
    #: The secondary account key.
    SECONDARY = "Secondary"

class AllocationState(with_metaclass(_CaseInsensitiveEnumMeta, str, Enum)):
    """Whether the pool is resizing.
    """

    #: 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 nodes.
    STEADY = "Steady"
    #: The pool is resizing; that is, compute nodes are being added to or removed from the pool.
    RESIZING = "Resizing"
    #: The pool was resizing, but the user has requested that the resize be stopped, but the stop
    #: request has not yet been completed.
    STOPPING = "Stopping"

class AuthenticationMode(with_metaclass(_CaseInsensitiveEnumMeta, str, Enum)):
    """The authentication mode for the Batch account.
    """

    #: The authentication mode using shared keys.
    SHARED_KEY = "SharedKey"
    #: The authentication mode using Azure Active Directory.
    AAD = "AAD"
    #: The authentication mode using task authentication tokens.
    TASK_AUTHENTICATION_TOKEN = "TaskAuthenticationToken"

class AutoStorageAuthenticationMode(with_metaclass(_CaseInsensitiveEnumMeta, str, Enum)):
    """The authentication mode which the Batch service will use to manage the auto-storage account.
    """

    #: The Batch service will authenticate requests to auto-storage using storage account keys.
    STORAGE_KEYS = "StorageKeys"
    #: The Batch service will authenticate requests to auto-storage using the managed identity
    #: assigned to the Batch account.
    BATCH_ACCOUNT_MANAGED_IDENTITY = "BatchAccountManagedIdentity"

class AutoUserScope(with_metaclass(_CaseInsensitiveEnumMeta, str, Enum)):
    """The default value is Pool. If the pool is running Windows a value of Task should be specified
    if stricter isolation between tasks is required. For example, if the task mutates the registry
    in a way which could impact other tasks, or if certificates have been specified on the pool
    which should not be accessible by normal tasks but should be accessible by start tasks.
    """

    #: Specifies that the service should create a new user for the task.
    TASK = "Task"
    #: Specifies that the task runs as the common auto user account which is created on every node in
    #: a pool.
    POOL = "Pool"

class CachingType(with_metaclass(_CaseInsensitiveEnumMeta, str, Enum)):
    """The type of caching to enable for the disk.
    """

    #: The caching mode for the disk is not enabled.
    NONE = "None"
    #: The caching mode for the disk is read only.
    READ_ONLY = "ReadOnly"
    #: The caching mode for the disk is read and write.
    READ_WRITE = "ReadWrite"

class CertificateFormat(with_metaclass(_CaseInsensitiveEnumMeta, str, Enum)):
    """The format of the certificate - either Pfx or Cer. If omitted, the default is Pfx.
    """

    #: The certificate is a PFX (PKCS#12) formatted certificate or certificate chain.
    PFX = "Pfx"
    #: The certificate is a base64-encoded X.509 certificate.
    CER = "Cer"

class CertificateProvisioningState(with_metaclass(_CaseInsensitiveEnumMeta, str, Enum)):

    #: The certificate is available for use in pools.
    SUCCEEDED = "Succeeded"
    #: The user has requested that the certificate be deleted, but the delete operation has not yet
    #: completed. You may not reference the certificate when creating or updating pools.
    DELETING = "Deleting"
    #: The user requested that the certificate be deleted, but there are pools that still have
    #: references to the certificate, or it is still installed on one or more compute nodes. (The
    #: latter can occur if the certificate has been removed from the pool, but the node has not yet
    #: restarted. Nodes refresh their certificates only when they restart.) You may use the cancel
    #: certificate delete operation to cancel the delete, or the delete certificate operation to retry
    #: the delete.
    FAILED = "Failed"

class CertificateStoreLocation(with_metaclass(_CaseInsensitiveEnumMeta, str, Enum)):
    """The default value is currentUser. This property is applicable only for pools configured with
    Windows nodes (that is, created with cloudServiceConfiguration, or with
    virtualMachineConfiguration using a Windows image reference). 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.
    """

    #: Certificates should be installed to the CurrentUser certificate store.
    CURRENT_USER = "CurrentUser"
    #: Certificates should be installed to the LocalMachine certificate store.
    LOCAL_MACHINE = "LocalMachine"

class CertificateVisibility(with_metaclass(_CaseInsensitiveEnumMeta, str, Enum)):

    #: The certificate should be visible to the user account under which the start task is run. Note
    #: that if AutoUser Scope is Pool for both the StartTask and a Task, this certificate will be
    #: visible to the Task as well.
    START_TASK = "StartTask"
    #: The certificate should be visible to the user accounts under which job tasks are run.
    TASK = "Task"
    #: The certificate should be visible to the user accounts under which users remotely access the
    #: node.
    REMOTE_USER = "RemoteUser"

class ComputeNodeDeallocationOption(with_metaclass(_CaseInsensitiveEnumMeta, str, Enum)):
    """Determines what to do with a node and its running task(s) after it has been selected for
    deallocation.
    """

    #: Terminate running task processes and requeue the tasks. The tasks will run again when a node is
    #: available. Remove nodes as soon as tasks have been terminated.
    REQUEUE = "Requeue"
    #: Terminate running tasks. The tasks will be completed with failureInfo indicating that they were
    #: terminated, and will not run again. Remove nodes as soon as tasks have been terminated.
    TERMINATE = "Terminate"
    #: Allow currently running tasks to complete. Schedule no new tasks while waiting. Remove nodes
    #: when all tasks have completed.
    TASK_COMPLETION = "TaskCompletion"
    #: Allow currently running tasks to complete, then wait for all task data retention periods to
    #: expire. Schedule no new tasks while waiting. Remove nodes when all task retention periods have
    #: expired.
    RETAINED_DATA = "RetainedData"

class ComputeNodeFillType(with_metaclass(_CaseInsensitiveEnumMeta, str, Enum)):
    """How tasks should be distributed across compute nodes.
    """

    #: Tasks should be assigned evenly across all nodes in the pool.
    SPREAD = "Spread"
    #: As many tasks as possible (taskSlotsPerNode) should be assigned to each node in the pool before
    #: any tasks are assigned to the next node in the pool.
    PACK = "Pack"

class ContainerWorkingDirectory(with_metaclass(_CaseInsensitiveEnumMeta, str, Enum)):
    """A flag to indicate where the container task working directory is. The default is
    'taskWorkingDirectory'.
    """

    #: Use the standard Batch service task working directory, which will contain the Task resource
    #: files populated by Batch.
    TASK_WORKING_DIRECTORY = "TaskWorkingDirectory"
    #: Using container image defined working directory. Beware that this directory will not contain
    #: the resource files downloaded by Batch.
    CONTAINER_IMAGE_DEFAULT = "ContainerImageDefault"

class DiskEncryptionTarget(with_metaclass(_CaseInsensitiveEnumMeta, str, Enum)):
    """If omitted, no disks on the compute nodes in the pool will be encrypted.
    """

    #: The OS Disk on the compute node is encrypted.
    OS_DISK = "OsDisk"
    #: The temporary disk on the compute node is encrypted. On Linux this encryption applies to other
    #: partitions (such as those on mounted data disks) when encryption occurs at boot time.
    TEMPORARY_DISK = "TemporaryDisk"

class ElevationLevel(with_metaclass(_CaseInsensitiveEnumMeta, str, Enum)):
    """The elevation level of the user.
    """

    #: The user is a standard user without elevated access.
    NON_ADMIN = "NonAdmin"
    #: The user is a user with elevated access and operates with full Administrator permissions.
    ADMIN = "Admin"

class InboundEndpointProtocol(with_metaclass(_CaseInsensitiveEnumMeta, str, Enum)):
    """The protocol of the endpoint.
    """

    #: Use TCP for the endpoint.
    TCP = "TCP"
    #: Use UDP for the endpoint.
    UDP = "UDP"

class InterNodeCommunicationState(with_metaclass(_CaseInsensitiveEnumMeta, str, Enum)):
    """This imposes restrictions on which nodes can be assigned to the pool. Enabling this value can
    reduce the chance of the requested number of nodes to be allocated in the pool. If not
    specified, this value defaults to 'Disabled'.
    """

    #: Enable network communication between virtual machines.
    ENABLED = "Enabled"
    #: Disable network communication between virtual machines.
    DISABLED = "Disabled"

class IPAddressProvisioningType(with_metaclass(_CaseInsensitiveEnumMeta, str, Enum)):
    """The provisioning type for Public IP Addresses for the Batch Pool.
    """

    #: A public IP will be created and managed by Batch. There may be multiple public IPs depending on
    #: the size of the Pool.
    BATCH_MANAGED = "BatchManaged"
    #: Public IPs are provided by the user and will be used to provision the Compute Nodes.
    USER_MANAGED = "UserManaged"
    #: No public IP Address will be created for the Compute Nodes in the Pool.
    NO_PUBLIC_IP_ADDRESSES = "NoPublicIPAddresses"

class KeySource(with_metaclass(_CaseInsensitiveEnumMeta, str, Enum)):
    """Type of the key source.
    """

    #: Batch creates and manages the encryption keys used to protect the account data.
    MICROSOFT_BATCH = "Microsoft.Batch"
    #: The encryption keys used to protect the account data are stored in an external key vault. If
    #: this is set then the Batch Account identity must be set to ``SystemAssigned`` and a valid Key
    #: Identifier must also be supplied under the keyVaultProperties.
    MICROSOFT_KEY_VAULT = "Microsoft.KeyVault"

class LoginMode(with_metaclass(_CaseInsensitiveEnumMeta, str, Enum)):
    """Specifies login mode for the user. The default value for VirtualMachineConfiguration pools is
    interactive mode and for CloudServiceConfiguration pools is batch mode.
    """

    #: The LOGON32_LOGON_BATCH Win32 login mode. The batch login mode is recommended for long running
    #: parallel processes.
    BATCH = "Batch"
    #: The LOGON32_LOGON_INTERACTIVE Win32 login mode. Some applications require having permissions
    #: associated with the interactive login mode. If this is the case for an application used in your
    #: task, then this option is recommended.
    INTERACTIVE = "Interactive"

class NameAvailabilityReason(with_metaclass(_CaseInsensitiveEnumMeta, str, Enum)):
    """Gets the reason that a Batch account name could not be used. The Reason element is only
    returned if NameAvailable is false.
    """

    #: The requested name is invalid.
    INVALID = "Invalid"
    #: The requested name is already in use.
    ALREADY_EXISTS = "AlreadyExists"

class NetworkSecurityGroupRuleAccess(with_metaclass(_CaseInsensitiveEnumMeta, str, Enum)):
    """The action that should be taken for a specified IP address, subnet range or tag.
    """

    #: Allow access.
    ALLOW = "Allow"
    #: Deny access.
    DENY = "Deny"

class NodePlacementPolicyType(with_metaclass(_CaseInsensitiveEnumMeta, str, Enum)):
    """The default value is regional.
    """

    #: All nodes in the pool will be allocated in the same region.
    REGIONAL = "Regional"
    #: Nodes in the pool will be spread across different zones with best effort balancing.
    ZONAL = "Zonal"

class PackageState(with_metaclass(_CaseInsensitiveEnumMeta, str, Enum)):
    """The current state of the application package.
    """

    #: The application package has been created but has not yet been activated.
    PENDING = "Pending"
    #: The application package is ready for use.
    ACTIVE = "Active"

class PoolAllocationMode(with_metaclass(_CaseInsensitiveEnumMeta, str, Enum)):
    """The allocation mode for creating pools in the Batch account.
    """

    #: Pools will be allocated in subscriptions owned by the Batch service.
    BATCH_SERVICE = "BatchService"
    #: Pools will be allocated in a subscription owned by the user.
    USER_SUBSCRIPTION = "UserSubscription"

class PoolIdentityType(with_metaclass(_CaseInsensitiveEnumMeta, str, Enum)):
    """The type of identity used for the Batch Pool.
    """

    #: Batch pool has user assigned identities with it.
    USER_ASSIGNED = "UserAssigned"
    #: Batch pool has no identity associated with it. Setting ``None`` in update pool will remove
    #: existing identities.
    NONE = "None"

class PoolProvisioningState(with_metaclass(_CaseInsensitiveEnumMeta, str, Enum)):
    """The current state of the pool.
    """

    #: The pool is available to run tasks subject to the availability of compute nodes.
    SUCCEEDED = "Succeeded"
    #: The user has requested that the pool be deleted, but the delete operation has not yet
    #: completed.
    DELETING = "Deleting"

class PrivateEndpointConnectionProvisioningState(with_metaclass(_CaseInsensitiveEnumMeta, str, Enum)):
    """The provisioning state of the private endpoint connection.
    """

    #: The connection status is final and is ready for use if Status is Approved.
    SUCCEEDED = "Succeeded"
    #: The user has requested that the connection status be updated, but the update operation has not
    #: yet completed. You may not reference the connection when connecting the Batch account.
    UPDATING = "Updating"
    #: The user requested that the connection be updated and it failed. You may retry the update
    #: operation.
    FAILED = "Failed"

class PrivateLinkServiceConnectionStatus(with_metaclass(_CaseInsensitiveEnumMeta, str, Enum)):
    """The status of the Batch private endpoint connection
    """

    #: The private endpoint connection is approved and can be used to access Batch account.
    APPROVED = "Approved"
    #: The private endpoint connection is pending and cannot be used to access Batch account.
    PENDING = "Pending"
    #: The private endpoint connection is rejected and cannot be used to access Batch account.
    REJECTED = "Rejected"
    #: The private endpoint connection is disconnected and cannot be used to access Batch account.
    DISCONNECTED = "Disconnected"

class ProvisioningState(with_metaclass(_CaseInsensitiveEnumMeta, str, Enum)):
    """The provisioned state of the resource
    """

    #: The account is in an invalid state.
    INVALID = "Invalid"
    #: The account is being created.
    CREATING = "Creating"
    #: The account is being deleted.
    DELETING = "Deleting"
    #: The account has been created and is ready for use.
    SUCCEEDED = "Succeeded"
    #: The last operation for the account is failed.
    FAILED = "Failed"
    #: The last operation for the account is cancelled.
    CANCELLED = "Cancelled"

class PublicNetworkAccessType(with_metaclass(_CaseInsensitiveEnumMeta, str, Enum)):
    """The network access type for operating on the resources in the Batch account.
    """

    #: Enables connectivity to Azure Batch through public DNS.
    ENABLED = "Enabled"
    #: Disables public connectivity and enables private connectivity to Azure Batch Service through
    #: private endpoint resource.
    DISABLED = "Disabled"

class ResourceIdentityType(with_metaclass(_CaseInsensitiveEnumMeta, str, Enum)):
    """The type of identity used for the Batch account.
    """

    #: Batch account has a system assigned identity with it.
    SYSTEM_ASSIGNED = "SystemAssigned"
    #: Batch account has user assigned identities with it.
    USER_ASSIGNED = "UserAssigned"
    #: Batch account has no identity associated with it. Setting ``None`` in update account will
    #: remove existing identities.
    NONE = "None"

class StorageAccountType(with_metaclass(_CaseInsensitiveEnumMeta, str, Enum)):
    """The storage account type for use in creating data disks.
    """

    #: The data disk should use standard locally redundant storage.
    STANDARD_LRS = "Standard_LRS"
    #: The data disk should use premium locally redundant storage.
    PREMIUM_LRS = "Premium_LRS"