com.microsoft.azure.management.batch

This package contains the classes for BatchManagementClient. Batch Client.

Classes

ActivateApplicationPackageParameters	Parameters for an activating an application package.
ApplicationPackageReference	Link to an application package inside the batch account.
AutoScaleRun	The results and errors from an execution of a pool autoscale formula.
AutoScaleRunError	An error that occurred when autoscaling a pool.
AutoScaleSettings	AutoScale settings for the pool.
AutoStorageBaseProperties	The properties related to the auto-storage account.
AutoStorageProperties	Contains information about the auto-storage account associated with a Batch account.
AutoUserSpecification	Specifies the parameters for the auto user that runs a task on the Batch service.
AzureBlobFileSystemConfiguration	Information used to connect to an Azure Storage Container using Blobfuse.
AzureFileShareConfiguration	Information used to connect to an Azure Fileshare.
BatchAccountCreateHeaders	Defines headers for Create operation.
BatchAccountCreateParameters	Parameters supplied to the Create operation.
BatchAccountDeleteHeaders	Defines headers for Delete operation.
BatchAccountIdentity	The identity of the Batch account, if configured. This is used when the user specifies 'Microsoft.KeyVault' as their Batch account encryption configuration or when `ManagedIdentity` is selected as the auto-storage authentication mode.
BatchAccountKeys	This class represents the access keys for the batch account.
BatchAccountRegenerateKeyParameters	Parameters supplied to the RegenerateKey operation.
BatchAccountUpdateParameters	Parameters for updating an Azure Batch account.
BatchPoolIdentity	The identity of the Batch pool, if configured. If the pool identity is updated during update an existing pool, only the new vms which are created after the pool shrinks to 0 will have the updated identities.
CertificateBaseProperties	Base certificate properties.
CertificateCancelDeletionHeaders	Defines headers for CancelDeletion operation.
CertificateCreateHeaders	Defines headers for Create operation.
CertificateCreateOrUpdateParameters	Contains information about a certificate.
CertificateDeleteHeaders	Defines headers for Delete operation.
CertificateGetHeaders	Defines headers for Get operation.
CertificateReference	A reference to a certificate to be installed on compute nodes in a pool. This must exist inside the same account as the pool.
CertificateUpdateHeaders	Defines headers for Update operation.
CheckNameAvailabilityParameters	Parameters for a check name availability request.
CIFSMountConfiguration	Information used to connect to a CIFS file system.
CloudServiceConfiguration	The configuration for nodes in a pool based on the Azure Cloud Services platform.
ComputeNodeIdentityReference	The reference to a user assigned identity associated with the Batch pool which a compute node will use.
ContainerConfiguration	The configuration for container-enabled pools.
ContainerRegistry	A private container registry.
DataDisk	Settings which will be used by the data disks associated to Compute Nodes in the Pool. When using attached data disks, you need to mount and format the disks from within a VM to use them.
DeleteCertificateError	An error response from the Batch service.
DeploymentConfiguration	Deployment configuration properties.
DiffDiskSettings	Specifies the ephemeral Disk Settings for the operating system disk used by the virtual machine.
DiskEncryptionConfiguration	The disk encryption configuration applied on compute nodes in the pool. Disk encryption configuration is not supported on Linux pool created with Virtual Machine Image or Shared Image Gallery Image.
EncryptionProperties	Configures how customer data is encrypted inside the Batch account. By default, accounts are encrypted using a Microsoft managed key. For additional control, a customer-managed key can be used instead.
EndpointDependency	A domain name and connection details used to access a dependency.
EndpointDetail	Details about the connection between the Batch service and the endpoint.
EnvironmentSetting	An environment variable to be set on a task process.
FixedScaleSettings	Fixed scale settings for the pool.
ImageReference	A reference to an Azure Virtual Machines Marketplace image or the Azure Image resource of a custom Virtual Machine. To get the list of all imageReferences verified by Azure Batch, see the 'List supported node agent SKUs' operation.
InboundNatPool	A inbound NAT pool that can be used to address specific ports on compute nodes in a Batch pool externally.
KeyVaultProperties	KeyVault configuration when using an encryption KeySource of Microsoft.KeyVault.
KeyVaultReference	Identifies the Azure key vault associated with a Batch account.
LinuxUserConfiguration	Properties used to create a user account on a Linux node.
MetadataItem	A name-value pair associated with a Batch service resource. The Batch service does not assign any meaning to this metadata; it is solely for the use of user code.
MountConfiguration	The file system to mount on each node.
NetworkConfiguration	The network configuration for a pool.
NetworkSecurityGroupRule	A network security group rule to apply to an inbound endpoint.
NFSMountConfiguration	Information used to connect to an NFS file system.
NodePlacementConfiguration	Node placement configuration for batch pools. Allocation configuration used by Batch Service to provision the nodes.
OperationDisplay	The object that describes the operation.
OSDisk	Settings for the operating system disk of the virtual machine.
PoolCreateHeaders	Defines headers for Create operation.
PoolDeleteHeaders	Defines headers for Delete operation.
PoolDisableAutoScaleHeaders	Defines headers for DisableAutoScale operation.
PoolEndpointConfiguration	The endpoint configuration for a pool.
PoolGetHeaders	Defines headers for Get operation.
PoolStopResizeHeaders	Defines headers for StopResize operation.
PoolUpdateHeaders	Defines headers for Update operation.
PrivateEndpoint	The private endpoint of the private endpoint connection.
PrivateEndpointConnectionUpdateHeaders	Defines headers for Update operation.
PrivateLinkServiceConnectionState	The private link service connection state of the private endpoint connection.
PublicIPAddressConfiguration	The public IP Address configuration of the networking configuration of a Pool.
ResizeError	An error that occurred when resizing a pool.
ResizeOperationStatus	Details about the current or last completed resize operation. Describes either the current operation (if the pool AllocationState is Resizing) or the previously completed operation (if the AllocationState is Steady).
ResourceFile	A single file or multiple files to be downloaded to a compute node.
ScaleSettings	Scale settings for the pool. Defines the desired size of the pool. This can either be 'fixedScale' where the requested targetDedicatedNodes is specified, or 'autoScale' which defines a formula which is periodically reevaluated. If this property is not specified, the pool will have a fixed scale with 0 targetDedicatedNodes.
SkuCapability	A SKU capability, such as the number of cores.
StartTask	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. In some cases the start task may be re-run even though the node was not rebooted. Due to this, start tasks should be idempotent and exit gracefully if the setup they're performing has already been done. Special care should be taken to avoid start tasks which create breakaway process or install/launch services from the start task working directory, as this will block Batch from being able to re-run the start task.
TaskContainerSettings	The container settings for a task.
TaskSchedulingPolicy	Specifies how tasks should be distributed across compute nodes.
UserAccount	Properties used to create a user on an Azure Batch node.
UserAssignedIdentities	The list of associated user identities.
UserIdentity	The definition of the user identity under which the task is run. Specify either the userName or autoUser property, but not both.
VirtualMachineConfiguration	The configuration for compute nodes in a pool based on the Azure Virtual Machines infrastructure.
VirtualMachineFamilyCoreQuota	A VM Family and its associated core quota for the Batch account.
VMExtension	The configuration for virtual machine extensions.
WindowsConfiguration	Windows operating system settings to apply to the virtual machine.
WindowsUserConfiguration	Properties used to create a user account on a Windows node.

Interfaces

Application	An immutable client-side representation of an Azure Batch account application.
ApplicationPackage	An immutable client-side representation of an Azure Batch application package.
BatchAccount	An immutable client-side representation of an Azure Batch account.
BatchAccounts	Entry point to Azure Batch account management API.
Pool	An immutable client-side representation of an Azure Batch account pool.
Application.UpdateDefinitionStages.Blank<ParentT>	The first stage of a Batch application definition.
Application.DefinitionStages.Blank<ParentT>	The first stage of a batch application definition.
BatchAccount.DefinitionStages.Blank	The first stage of a Batch account definition.
Pool.DefinitionStages.Blank<ParentT>	The first stage of a batch pool definition.
Pool.UpdateDefinitionStages.Blank<ParentT>	The first stage of a Batch pool definition.
Application.Definition<ParentT>	The entirety of a Batch application definition as a part of a Batch account definition.
BatchAccount.Definition	The entirety of a Batch account definition.
Pool.Definition<ParentT>	The entirety of a Batch pool definition as a part of a Batch account definition.
Application.DefinitionStages	Grouping of all the application package definition stages.
BatchAccount.DefinitionStages	Grouping of all the Batch account definition stages.
Pool.DefinitionStages	Grouping of all the pool definition stages.
Pool.Update	The entirety of a Batch pool update as a part of a Batch account update.
BatchAccount.Update	The template for a Batch account update operation, containing all the settings that can be modified.
Application.Update	The entirety of a Batch application update as a part of a Batch account update.
Pool.UpdateDefinition<ParentT>	The entirety of a Batch pool definition as a part of parent update.
Application.UpdateDefinition<ParentT>	The entirety of a Batch application definition as a part of parent update.
Pool.UpdateDefinitionStages	Grouping of pool definition stages as part of a Batch account update.
Application.UpdateDefinitionStages	Grouping of application definition stages as part of a Batch account update.
BatchAccount.UpdateStages	Grouping of all Batch account update stages.
Pool.UpdateStages	Grouping of Batch pool update stages.
Application.UpdateStages	Grouping of Batch application update stages.
BatchAccount.DefinitionStages.WithApplication	The stage of a Batch account definition allowing the creation of a Batch application.
BatchAccount.UpdateStages.WithApplication	The stage of a Batch account definition allowing the creation of a Batch application.
BatchAccount.DefinitionStages.WithApplicationAndStorage	The stage of a Batch account definition allowing adding an application and a storage account.
Application.UpdateStages.WithApplicationPackage	The stage of a Batch application update allowing the creation of an application package.
Application.UpdateDefinitionStages.WithApplicationPackage<ParentT>	The stage of a Batch application definition allowing the creation of an application package.
Application.DefinitionStages.WithApplicationPackage<ParentT>	The stage of a Batch application definition that allows the creation of an application package.
Pool.UpdateDefinitionStages.WithAttach<ParentT>	The stage of a Batch pool definition allowing the creation of configurations.
Application.UpdateDefinitionStages.WithAttach<ParentT>	The final stage of a Batch application definition. At this stage, any remaining optional settings can be specified, or the application definition can be attached to the parent batch Account update.
Pool.DefinitionStages.WithAttach<ParentT>	The stage of a Batch pool definition that allows the creation of a pool.
Pool.UpdateStages.WithAttach	The stage of a Batch pool update allowing the creation of configurations.
Application.DefinitionStages.WithAttach<ParentT>	The final stage of the application definition. At this stage, any remaining optional settings can be specified, or the application definition can be attached to the parent batch account definition.
BatchAccount.DefinitionStages.WithCreate	A Batch account definition with sufficient inputs to create a new Batch account in the cloud, but exposing additional optional inputs to specify.
BatchAccount.DefinitionStages.WithCreateAndApplication	The stage of a Batch account definition allowing the adding of a Batch application or creating the Batch account.
BatchAccount.DefinitionStages.WithGroup	The stage of a Batch account definition allowing the resource group to be specified.
Application.UpdateStages.WithOptionalProperties	The stage of an application update allowing to enable or disable auto upgrade of the application.
BatchAccount.UpdateStages.WithPool	The stage of a Batch account definition allowing the creation of a Batch pool.
BatchAccount.DefinitionStages.WithPool	The stage of a Batch account definition allowing the creation of a Batch pool.
BatchAccount.DefinitionStages.WithStorage	The stage of a Batch account definition allowing to associate storage accounts with the Batch account.
BatchAccount.UpdateStages.WithStorageAccount	The stage of a Batch account update allowing to specify a storage account.

Enums

AccountKeyType	Defines values for AccountKeyType.
AllocationState	Defines values for AllocationState.
AuthenticationMode	Defines values for AuthenticationMode.
AutoStorageAuthenticationMode	Defines values for AutoStorageAuthenticationMode.
AutoUserScope	Defines values for AutoUserScope.
CachingType	Defines values for CachingType.
CertificateFormat	Defines values for CertificateFormat.
CertificateProvisioningState	Defines values for CertificateProvisioningState.
CertificateStoreLocation	Defines values for CertificateStoreLocation.
CertificateVisibility	Defines values for CertificateVisibility.
ComputeNodeDeallocationOption	Defines values for ComputeNodeDeallocationOption.
ComputeNodeFillType	Defines values for ComputeNodeFillType.
ContainerWorkingDirectory	Defines values for ContainerWorkingDirectory.
DiffDiskPlacement	Defines values for DiffDiskPlacement.
DiskEncryptionTarget	Defines values for DiskEncryptionTarget.
ElevationLevel	Defines values for ElevationLevel.
InboundEndpointProtocol	Defines values for InboundEndpointProtocol.
InterNodeCommunicationState	Defines values for InterNodeCommunicationState.
IPAddressProvisioningType	Defines values for IPAddressProvisioningType.
KeySource	Defines values for KeySource.
LoginMode	Defines values for LoginMode.
NameAvailabilityReason	Defines values for NameAvailabilityReason.
NetworkSecurityGroupRuleAccess	Defines values for NetworkSecurityGroupRuleAccess.
NodePlacementPolicyType	Defines values for NodePlacementPolicyType.
PackageState	Defines values for PackageState.
PoolAllocationMode	Defines values for PoolAllocationMode.
PoolIdentityType	Defines values for PoolIdentityType.
PoolProvisioningState	Defines values for PoolProvisioningState.
PrivateEndpointConnectionProvisioningState	Defines values for PrivateEndpointConnectionProvisioningState.
PrivateLinkServiceConnectionStatus	Defines values for PrivateLinkServiceConnectionStatus.
ProvisioningState	Defines values for ProvisioningState.
PublicNetworkAccessType	Defines values for PublicNetworkAccessType.
ResourceIdentityType	Defines values for ResourceIdentityType.
StorageAccountType	Defines values for StorageAccountType.