com.azure.resourcemanager.batch.models

Package:: com.azure.resourcemanager.batch.models

Maven Artifact:: com.azure.resourcemanager:azure-resourcemanager-batch:3.0.0

Package containing the data models for Batch. The Batch Management Client.

Classes

AccessRule	Access rule in a network security perimeter configuration profile.
AccessRuleDirection	Direction of Access Rule.
AccessRuleProperties	Properties of Access Rule.
AccessRulePropertiesSubscription	The AccessRulePropertiesSubscription model.
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.
AutomaticOSUpgradePolicy	The configuration parameters used for performing automatic OS upgrade.
AzureBlobFileSystemConfiguration	Information used to connect to an Azure Storage Container using Blobfuse.
AzureFileShareConfiguration	Information used to connect to an Azure Fileshare.
BatchAccountCreateParameters	Parameters supplied to the Create operation.
BatchAccountIdentity	The identity of the Batch account, if configured.
BatchAccountRegenerateKeyParameters	Parameters supplied to the RegenerateKey operation.
BatchAccountUpdateParameters	Parameters for updating an Azure Batch account.
BatchPoolIdentity	The identity of the Batch pool, if configured.
CheckNameAvailabilityParameters	Parameters for a check name availability request.
CifsMountConfiguration	Information used to connect to a CIFS file system.
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.
ContainerHostBatchBindMountEntry	The entry of path and mount mode you want to mount into task container.
ContainerHostDataPath	The paths which will be mounted to container task's container.
ContainerRegistry	A private container registry.
ContainerType	The container technology to be used.
DataDisk	Settings which will be used by the data disks associated to Compute Nodes in the Pool.
DeploymentConfiguration	Deployment configuration properties.
DiffDiskSettings	Specifies the ephemeral Disk Settings for the operating system disk used by the virtual machine.
DiskCustomerManagedKey	The Customer Managed Key reference to encrypt the Disk.
DiskEncryptionConfiguration	The disk encryption configuration applied on compute nodes in the pool.
DiskEncryptionSetParameters	The ARM resource id of the disk encryption set.
EncryptionProperties	Configures how customer data is encrypted inside the Batch account.
EndpointAccessProfile	Network access profile for Batch endpoint.
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.
HostEndpointSettings	Specifies particular host endpoint settings.
HostEndpointSettingsModeTypes	Specifies the access control policy execution mode.
IPFamily	The IP families used to specify IP versions available to the pool.
IPTag	Specifies how tasks should be distributed across compute nodes.
ImageReference	A reference to an Azure Virtual Machines Marketplace image or the Azure Image resource of a custom Virtual Machine.
InboundNatPool	A inbound NAT pool that can be used to address specific ports on compute nodes in a Batch pool externally.
IpRule	Rule to filter client IP address.
IssueType	Type of issue.
JobDefaultOrder	The order for scheduling tasks from different jobs with the same priority.
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.
ManagedDisk	The managed disk parameters.
MetadataItem	A name-value pair associated with a Batch service resource.
MountConfiguration	The file system to mount on each node.
NetworkConfiguration	The network configuration for a pool.
NetworkProfile	Network profile for Batch account, which contains network rule settings for each endpoint.
NetworkSecurityGroupRule	A network security group rule to apply to an inbound endpoint.
NetworkSecurityPerimeter	Information about a network security perimeter (NSP).
NetworkSecurityPerimeterConfigurationProperties	Network security configuration properties.
NetworkSecurityPerimeterConfigurationProvisioningState	Provisioning state of a network security perimeter configuration that is being created or updated.
NetworkSecurityProfile	Network security perimeter configuration profile.
NfsMountConfiguration	Information used to connect to an NFS file system.
NodePlacementConfiguration	Node placement configuration for Batch pools.
OSDisk	Settings for the operating system disk of the virtual machine.
OperationDisplay	The object that describes the operation.
PoolEndpointConfiguration	The endpoint configuration for a pool.
PoolsCreateHeaders	The PoolsCreateHeaders model.
PoolsCreateResponse	Contains all response data for the create operation.
PoolsDisableAutoScaleHeaders	The PoolsDisableAutoScaleHeaders model.
PoolsDisableAutoScaleResponse	Contains all response data for the disableAutoScale operation.
PoolsGetHeaders	The PoolsGetHeaders model.
PoolsGetResponse	Contains all response data for the get operation.
PoolsStopResizeHeaders	The PoolsStopResizeHeaders model.
PoolsStopResizeResponse	Contains all response data for the stopResize operation.
PoolsUpdateHeaders	The PoolsUpdateHeaders model.
PoolsUpdateResponse	Contains all response data for the update operation.
PrivateEndpoint	The private endpoint of the private endpoint connection.
PrivateLinkServiceConnectionState	The private link service connection state of the private endpoint connection.
ProvisioningIssue	Describes a provisioning issue for a network security perimeter configuration.
ProvisioningIssueProperties	Details of a provisioning issue for a network security perimeter (NSP) configuration.
ProxyAgentSettings	Specifies ProxyAgent settings while creating the virtual machine.
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.
ResourceAssociation	Information about resource association.
ResourceAssociationAccessMode	Access mode of the resource association.
ResourceFile	A single file or multiple files to be downloaded to a compute node.
RollingUpgradePolicy	The configuration parameters used while performing a rolling upgrade.
ScaleSettings	Scale settings for the pool Defines the desired size of the pool.
SecurityEncryptionTypes	Specifies the EncryptionType of the managed disk.
SecurityProfile	Specifies the security profile settings for the virtual machine or virtual machine scale set.
ServiceArtifactReference	Specifies the service artifact reference id used to set same image version for all virtual machines in the scale set when using 'latest' image version.
Severity	Severity of the issue.
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.
TaskContainerSettings	The container settings for a task.
TaskSchedulingPolicy	Specifies how tasks should be distributed across compute nodes.
UefiSettings	Specifies the security settings like secure boot and vTPM used while creating the virtual machine.
UpgradePolicy	Describes an upgrade policy - automatic, manual, or rolling.
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.
VMDiskSecurityProfile	Specifies the security profile settings for the managed disk.
VMExtension	The configuration for virtual machine extensions.
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.
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 Application.
Application.Definition	The entirety of the Application definition.
Application.DefinitionStages	The Application definition stages.
Application.DefinitionStages.Blank	The first stage of the Application definition.
Application.DefinitionStages.WithAllowUpdates	The stage of the Application definition allowing to specify allowUpdates.
Application.DefinitionStages.WithCreate	The stage of the Application definition which contains all the minimum required properties for the resource to be created, but also allows for any other optional properties to be specified.
Application.DefinitionStages.WithDefaultVersion	The stage of the Application definition allowing to specify defaultVersion.
Application.DefinitionStages.WithDisplayName	The stage of the Application definition allowing to specify displayName.
Application.DefinitionStages.WithParentResource	The stage of the Application definition allowing to specify parent resource.
Application.DefinitionStages.WithTags	The stage of the Application definition allowing to specify tags.
Application.Update	The template for Application update.
Application.UpdateStages	The Application update stages.
Application.UpdateStages.WithAllowUpdates	The stage of the Application update allowing to specify allowUpdates.
Application.UpdateStages.WithDefaultVersion	The stage of the Application update allowing to specify defaultVersion.
Application.UpdateStages.WithDisplayName	The stage of the Application update allowing to specify displayName.
Application.UpdateStages.WithTags	The stage of the Application update allowing to specify tags.
ApplicationPackage	An immutable client-side representation of ApplicationPackage.
ApplicationPackage.Definition	The entirety of the ApplicationPackage definition.
ApplicationPackage.DefinitionStages	The ApplicationPackage definition stages.
ApplicationPackage.DefinitionStages.Blank	The first stage of the ApplicationPackage definition.
ApplicationPackage.DefinitionStages.WithCreate	The stage of the ApplicationPackage definition which contains all the minimum required properties for the resource to be created, but also allows for any other optional properties to be specified.
ApplicationPackage.DefinitionStages.WithParentResource	The stage of the ApplicationPackage definition allowing to specify parent resource.
ApplicationPackage.DefinitionStages.WithTags	The stage of the ApplicationPackage definition allowing to specify tags.
ApplicationPackages	Resource collection API of ApplicationPackages.
Applications	Resource collection API of Applications.
BatchAccount	An immutable client-side representation of BatchAccount.
BatchAccount.Definition	The entirety of the BatchAccount definition.
BatchAccount.DefinitionStages	The BatchAccount definition stages.
BatchAccount.DefinitionStages.Blank	The first stage of the BatchAccount definition.
BatchAccount.DefinitionStages.WithAllowedAuthenticationModes	The stage of the BatchAccount definition allowing to specify allowedAuthenticationModes.
BatchAccount.DefinitionStages.WithAutoStorage	The stage of the BatchAccount definition allowing to specify autoStorage.
BatchAccount.DefinitionStages.WithCreate	The stage of the BatchAccount definition which contains all the minimum required properties for the resource to be created, but also allows for any other optional properties to be specified.
BatchAccount.DefinitionStages.WithEncryption	The stage of the BatchAccount definition allowing to specify encryption.
BatchAccount.DefinitionStages.WithIdentity	The stage of the BatchAccount definition allowing to specify identity.
BatchAccount.DefinitionStages.WithKeyVaultReference	The stage of the BatchAccount definition allowing to specify keyVaultReference.
BatchAccount.DefinitionStages.WithLocation	The stage of the BatchAccount definition allowing to specify location.
BatchAccount.DefinitionStages.WithNetworkProfile	The stage of the BatchAccount definition allowing to specify networkProfile.
BatchAccount.DefinitionStages.WithPoolAllocationMode	The stage of the BatchAccount definition allowing to specify poolAllocationMode.
BatchAccount.DefinitionStages.WithPublicNetworkAccess	The stage of the BatchAccount definition allowing to specify publicNetworkAccess.
BatchAccount.DefinitionStages.WithResourceGroup	The stage of the BatchAccount definition allowing to specify parent resource.
BatchAccount.DefinitionStages.WithTags	The stage of the BatchAccount definition allowing to specify tags.
BatchAccount.Update	The template for BatchAccount update.
BatchAccount.UpdateStages	The BatchAccount update stages.
BatchAccount.UpdateStages.WithAllowedAuthenticationModes	The stage of the BatchAccount update allowing to specify allowedAuthenticationModes.
BatchAccount.UpdateStages.WithAutoStorage	The stage of the BatchAccount update allowing to specify autoStorage.
BatchAccount.UpdateStages.WithEncryption	The stage of the BatchAccount update allowing to specify encryption.
BatchAccount.UpdateStages.WithIdentity	The stage of the BatchAccount update allowing to specify identity.
BatchAccount.UpdateStages.WithNetworkProfile	The stage of the BatchAccount update allowing to specify networkProfile.
BatchAccount.UpdateStages.WithPublicNetworkAccess	The stage of the BatchAccount update allowing to specify publicNetworkAccess.
BatchAccount.UpdateStages.WithTags	The stage of the BatchAccount update allowing to specify tags.
BatchAccountKeys	An immutable client-side representation of BatchAccountKeys.
BatchAccounts	Resource collection API of BatchAccounts.
BatchLocationQuota	An immutable client-side representation of BatchLocationQuota.
CheckNameAvailabilityResult	An immutable client-side representation of CheckNameAvailabilityResult.
DetectorResponse	An immutable client-side representation of DetectorResponse.
Locations	Resource collection API of Locations.
NetworkSecurityPerimeterConfiguration	An immutable client-side representation of NetworkSecurityPerimeterConfiguration.
NetworkSecurityPerimeters	Resource collection API of NetworkSecurityPerimeters.
Operation	An immutable client-side representation of Operation.
Operations	Resource collection API of Operations.
OutboundEnvironmentEndpoint	An immutable client-side representation of OutboundEnvironmentEndpoint.
Pool	An immutable client-side representation of Pool.
Pool.Definition	The entirety of the Pool definition.
Pool.DefinitionStages	The Pool definition stages.
Pool.DefinitionStages.Blank	The first stage of the Pool definition.
Pool.DefinitionStages.WithApplicationPackages	The stage of the Pool definition allowing to specify applicationPackages.
Pool.DefinitionStages.WithCreate	The stage of the Pool definition which contains all the minimum required properties for the resource to be created, but also allows for any other optional properties to be specified.
Pool.DefinitionStages.WithDeploymentConfiguration	The stage of the Pool definition allowing to specify deploymentConfiguration.
Pool.DefinitionStages.WithDisplayName	The stage of the Pool definition allowing to specify displayName.
Pool.DefinitionStages.WithIdentity	The stage of the Pool definition allowing to specify identity.
Pool.DefinitionStages.WithIfMatch	The stage of the Pool definition allowing to specify ifMatch.
Pool.DefinitionStages.WithIfNoneMatch	The stage of the Pool definition allowing to specify ifNoneMatch.
Pool.DefinitionStages.WithInterNodeCommunication	The stage of the Pool definition allowing to specify interNodeCommunication.
Pool.DefinitionStages.WithMetadata	The stage of the Pool definition allowing to specify metadata.
Pool.DefinitionStages.WithMountConfiguration	The stage of the Pool definition allowing to specify mountConfiguration.
Pool.DefinitionStages.WithNetworkConfiguration	The stage of the Pool definition allowing to specify networkConfiguration.
Pool.DefinitionStages.WithParentResource	The stage of the Pool definition allowing to specify parent resource.
Pool.DefinitionStages.WithScaleSettings	The stage of the Pool definition allowing to specify scaleSettings.
Pool.DefinitionStages.WithStartTask	The stage of the Pool definition allowing to specify startTask.
Pool.DefinitionStages.WithTags	The stage of the Pool definition allowing to specify tags.
Pool.DefinitionStages.WithTaskSchedulingPolicy	The stage of the Pool definition allowing to specify taskSchedulingPolicy.
Pool.DefinitionStages.WithTaskSlotsPerNode	The stage of the Pool definition allowing to specify taskSlotsPerNode.
Pool.DefinitionStages.WithUpgradePolicy	The stage of the Pool definition allowing to specify upgradePolicy.
Pool.DefinitionStages.WithUserAccounts	The stage of the Pool definition allowing to specify userAccounts.
Pool.DefinitionStages.WithVmSize	The stage of the Pool definition allowing to specify vmSize.
Pool.Update	The template for Pool update.
Pool.UpdateStages	The Pool update stages.
Pool.UpdateStages.WithApplicationPackages	The stage of the Pool update allowing to specify applicationPackages.
Pool.UpdateStages.WithDeploymentConfiguration	The stage of the Pool update allowing to specify deploymentConfiguration.
Pool.UpdateStages.WithDisplayName	The stage of the Pool update allowing to specify displayName.
Pool.UpdateStages.WithIdentity	The stage of the Pool update allowing to specify identity.
Pool.UpdateStages.WithIfMatch	The stage of the Pool update allowing to specify ifMatch.
Pool.UpdateStages.WithInterNodeCommunication	The stage of the Pool update allowing to specify interNodeCommunication.
Pool.UpdateStages.WithMetadata	The stage of the Pool update allowing to specify metadata.
Pool.UpdateStages.WithMountConfiguration	The stage of the Pool update allowing to specify mountConfiguration.
Pool.UpdateStages.WithNetworkConfiguration	The stage of the Pool update allowing to specify networkConfiguration.
Pool.UpdateStages.WithScaleSettings	The stage of the Pool update allowing to specify scaleSettings.
Pool.UpdateStages.WithStartTask	The stage of the Pool update allowing to specify startTask.
Pool.UpdateStages.WithTags	The stage of the Pool update allowing to specify tags.
Pool.UpdateStages.WithTaskSchedulingPolicy	The stage of the Pool update allowing to specify taskSchedulingPolicy.
Pool.UpdateStages.WithTaskSlotsPerNode	The stage of the Pool update allowing to specify taskSlotsPerNode.
Pool.UpdateStages.WithUpgradePolicy	The stage of the Pool update allowing to specify upgradePolicy.
Pool.UpdateStages.WithUserAccounts	The stage of the Pool update allowing to specify userAccounts.
Pool.UpdateStages.WithVmSize	The stage of the Pool update allowing to specify vmSize.
Pools	Resource collection API of Pools.
PrivateEndpointConnection	An immutable client-side representation of PrivateEndpointConnection.
PrivateEndpointConnections	Resource collection API of PrivateEndpointConnections.
PrivateLinkResource	An immutable client-side representation of PrivateLinkResource.
PrivateLinkResources	Resource collection API of PrivateLinkResources.
SupportedSku	An immutable client-side representation of SupportedSku.

Enums

AccountKeyType	The type of account key to regenerate.
AllocationState	Whether the pool is resizing.
AuthenticationMode	The authentication mode for the Batch account.
AutoStorageAuthenticationMode	The authentication mode which the Batch service will use to manage the auto-storage account.
AutoUserScope	The default value is Pool.
CachingType	The type of caching to enable for the disk.
ComputeNodeDeallocationOption	Determines what to do with a node and its running task(s) after it has been selected for deallocation.
ComputeNodeFillType	How tasks should be distributed across compute nodes.
ContainerWorkingDirectory	A flag to indicate where the container task working directory is.
DiffDiskPlacement	The location where the OS disk should be placed.
DiskEncryptionTarget	The disks to encrypt on each compute node.
DynamicVNetAssignmentScope	The scope of dynamic vnet assignment.
ElevationLevel	The elevation level of the user.
EndpointAccessDefaultAction	Default action for endpoint access.
InboundEndpointProtocol	The protocol of the endpoint.
InterNodeCommunicationState	This imposes restrictions on which nodes can be assigned to the pool.
IpAddressProvisioningType	The provisioning type for Public IP Addresses for the Batch Pool.
IpRuleAction	The action when client IP address is matched.
KeySource	Type of the key source.
LoginMode	Specifies login mode for the user.
NameAvailabilityReason	Gets the reason that a Batch account name could not be used.
NetworkSecurityGroupRuleAccess	The action that should be taken for a specified IP address, subnet range or tag.
NodePlacementPolicyType	The default value is regional.
PackageState	The current state of the application package.
PoolAllocationMode	The allocation mode for creating pools in the Batch account.
PoolIdentityType	The type of identity used for the Batch Pool.
PoolProvisioningState	The current state of the pool.
PrivateEndpointConnectionProvisioningState	The provisioning state of the private endpoint connection.
PrivateLinkServiceConnectionStatus	The status of the Batch private endpoint connection.
ProvisioningState	The provisioned state of the resource.
PublicNetworkAccessType	The network access type for operating on the resources in the Batch account.
ResourceIdentityType	The type of identity used for the Batch account.
ResourceType	The result of the request to list operations.
SecurityTypes	Specifies the SecurityType of the virtual machine.
StorageAccountType	The storage account type for use in creating data disks or OS disk.
UpgradeMode	Specifies the mode of an upgrade to virtual machines in the scale set. Possible values are: Manual - You control the application of updates to virtual machines in the scale set.

Feedback

Was this page helpful?