Package-level declarations

Types

Link copied to clipboard
enum AutoUserScope : Enum<AutoUserScope> , ConvertibleToJava<AutoUserScope>

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.

Link copied to clipboard
enum CachingType : Enum<CachingType> , ConvertibleToJava<CachingType>

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/.

Link copied to clipboard
enum CertificateFormat : Enum<CertificateFormat> , ConvertibleToJava<CertificateFormat>

The format of the certificate - either Pfx or Cer. If omitted, the default is Pfx.

Link copied to clipboard
enum CertificateStoreLocation : Enum<CertificateStoreLocation> , ConvertibleToJava<CertificateStoreLocation>

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.

Link copied to clipboard
enum CertificateVisibility : Enum<CertificateVisibility> , ConvertibleToJava<CertificateVisibility>
Link copied to clipboard
enum ComputeNodeDeallocationOption : Enum<ComputeNodeDeallocationOption> , ConvertibleToJava<ComputeNodeDeallocationOption>

If omitted, the default value is Requeue.

Link copied to clipboard
enum ComputeNodeFillType : Enum<ComputeNodeFillType> , ConvertibleToJava<ComputeNodeFillType>
Link copied to clipboard
enum ContainerType : Enum<ContainerType> , ConvertibleToJava<ContainerType>
Link copied to clipboard
enum ContainerWorkingDirectory : Enum<ContainerWorkingDirectory> , ConvertibleToJava<ContainerWorkingDirectory>
Link copied to clipboard
enum DiskEncryptionTarget : Enum<DiskEncryptionTarget> , ConvertibleToJava<DiskEncryptionTarget>

If omitted, no disks on the compute nodes in the pool will be encrypted.

Link copied to clipboard
enum ElevationLevel : Enum<ElevationLevel> , ConvertibleToJava<ElevationLevel>

nonAdmin - The auto user is a standard user without elevated access. admin - The auto user is a user with elevated access and operates with full Administrator permissions. The default value is nonAdmin.

Link copied to clipboard
enum InboundEndpointProtocol : Enum<InboundEndpointProtocol> , ConvertibleToJava<InboundEndpointProtocol>
Link copied to clipboard
enum InterNodeCommunicationState : Enum<InterNodeCommunicationState> , ConvertibleToJava<InterNodeCommunicationState>

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'.

Link copied to clipboard
enum IPAddressProvisioningType : Enum<IPAddressProvisioningType> , ConvertibleToJava<IPAddressProvisioningType>

The default value is BatchManaged

Link copied to clipboard
enum KeySource : Enum<KeySource> , ConvertibleToJava<KeySource>

Type of the key source.

Link copied to clipboard
enum LoginMode : Enum<LoginMode> , ConvertibleToJava<LoginMode>

Specifies login mode for the user. The default value for VirtualMachineConfiguration pools is interactive mode and for CloudServiceConfiguration pools is batch mode.

Link copied to clipboard
enum NetworkSecurityGroupRuleAccess : Enum<NetworkSecurityGroupRuleAccess> , ConvertibleToJava<NetworkSecurityGroupRuleAccess>
Link copied to clipboard
enum NodePlacementPolicyType : Enum<NodePlacementPolicyType> , ConvertibleToJava<NodePlacementPolicyType>

Allocation policy used by Batch Service to provision the nodes. If not specified, Batch will use the regional policy.

Link copied to clipboard
enum PoolAllocationMode : Enum<PoolAllocationMode> , ConvertibleToJava<PoolAllocationMode>

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.

Link copied to clipboard
enum PoolIdentityType : Enum<PoolIdentityType> , ConvertibleToJava<PoolIdentityType>

The type of identity used for the Batch Pool.

Link copied to clipboard
enum PublicNetworkAccessType : Enum<PublicNetworkAccessType> , ConvertibleToJava<PublicNetworkAccessType>

If not specified, the default value is 'enabled'.

Link copied to clipboard
enum ResourceIdentityType : Enum<ResourceIdentityType> , ConvertibleToJava<ResourceIdentityType>

The type of identity used for the Batch account.

Link copied to clipboard
enum StorageAccountType : Enum<StorageAccountType> , ConvertibleToJava<StorageAccountType>

If omitted, the default is "Standard_LRS". Values are: Standard_LRS - The data disk should use standard locally redundant storage. Premium_LRS - The data disk should use premium locally redundant storage.