Package com.microsoft.azure.management.batchai

This package contains the classes for BatchAIManagementClient.

See: Description

Interface Summary

Interface	Description
AzureBlobFileSystem	Client-side representation for AzureBlobFileSystemReference.
AzureBlobFileSystem.Definition<ParentT>	Definition of azure blob file system reference.
AzureBlobFileSystem.DefinitionStages	Definition stages for azure blob file system reference.
AzureBlobFileSystem.DefinitionStages.Blank<ParentT>
AzureBlobFileSystem.DefinitionStages.WithAttach<ParentT>
AzureBlobFileSystem.DefinitionStages.WithAzureStorageCredentials<ParentT>
AzureBlobFileSystem.DefinitionStages.WithMountOptions<ParentT>
AzureBlobFileSystem.DefinitionStages.WithRelativeMountPath<ParentT>
AzureBlobFileSystem.DefinitionStages.WithStorageAccount<ParentT>
AzureBlobFileSystem.DefinitionStages.WithStorageContainerName<ParentT>
AzureFileShare	Client-side representation for AzureFileShareReference.
AzureFileShare.Definition<ParentT>	Definition of azure file share reference.
AzureFileShare.DefinitionStages	Definition stages for azure file share reference.
AzureFileShare.DefinitionStages.Blank<ParentT>
AzureFileShare.DefinitionStages.WithAttach<ParentT>
AzureFileShare.DefinitionStages.WithAzureFileUrl<ParentT>
AzureFileShare.DefinitionStages.WithAzureStorageCredentials<ParentT>
AzureFileShare.DefinitionStages.WithDirectoryMode<ParentT>
AzureFileShare.DefinitionStages.WithFileMode<ParentT>
AzureFileShare.DefinitionStages.WithRelativeMountPath<ParentT>
AzureFileShare.DefinitionStages.WithStorageAccount<ParentT>
BatchAICluster	Entry point for Batch AI cluster management API in Azure.
BatchAICluster.Definition	The entirety of a Batch AI cluster definition.
BatchAICluster.DefinitionStages	Grouping of Batch AI cluster definition stages.
BatchAICluster.DefinitionStages.Blank	The first stage of a Batch AI cluster definition.
BatchAICluster.DefinitionStages.WithAppInsightsKey
BatchAICluster.DefinitionStages.WithAppInsightsResourceId	Specifies Azure Application Insights information for performance counters reporting.
BatchAICluster.DefinitionStages.WithCreate	The stage of the definition which contains all the minimum required inputs for the resource to be created but also allows for any other optional settings to be specified.
BatchAICluster.DefinitionStages.WithScaleSettings	Specifies scale settings for the cluster.
BatchAICluster.DefinitionStages.WithSetupTask	Specifies a setup task which can be used to customize the compute nodes of the cluster.
BatchAICluster.DefinitionStages.WithSubnet	Defines subnet for the cluster.
BatchAICluster.DefinitionStages.WithUserCredentials	Specifies the credentials to use for authentication on each of the nodes of a cluster.
BatchAICluster.DefinitionStages.WithUserName	Specifies the name of the administrator account that gets created on each of the nodes of a cluster.
BatchAICluster.DefinitionStages.WithVirtualMachineImage	Specifies virtual machine image.
BatchAICluster.DefinitionStages.WithVMPriority
BatchAICluster.DefinitionStages.WithVMSize	The stage of a Batch AI cluster definition allowing to specify virtual machine size.
BatchAICluster.Update	The template for an update operation, containing all the settings that can be modified.
BatchAICluster.UpdateStages	Grouping of Batch AI cluster update stages.
BatchAICluster.UpdateStages.WithScaleSettings
BatchAIClusters	Entry point to Batch AI cluster management API in Azure.
BatchAIExperiment	Entry point for Batch AI Experiment management API in Azure.
BatchAIExperiment.Definition	The entirety of a Batch AI experiment definition.
BatchAIExperiment.DefinitionStages	Grouping of Batch AI experiment definition stages.
BatchAIExperiment.DefinitionStages.WithCreate	The stage of the definition which contains all the minimum required inputs for the resource to be created but also allows for any other optional settings to be specified.
BatchAIExperiments	Entry point to Batch AI experiments management API in Azure.
BatchAIFileServer	Entry point for Batch AI file server management API in Azure.
BatchAIFileServer.Definition	The entirety of a Batch AI file server definition.
BatchAIFileServer.DefinitionStages	Grouping of Batch AI file server definition stages.
BatchAIFileServer.DefinitionStages.Blank	The first stage of a Batch AI file server definition.
BatchAIFileServer.DefinitionStages.WithCreate	The stage of the definition which contains all the minimum required inputs for the resource to be created but also allows for any other optional settings to be specified.
BatchAIFileServer.DefinitionStages.WithDataDisks	This stage of a Batch AI file server definition allows to specify data disks parameters.
BatchAIFileServer.DefinitionStages.WithSubnet	Defines subnet for the file server.
BatchAIFileServer.DefinitionStages.WithUserCredentials	This stage of a Batch AI file server definition allows to specify user credentials.
BatchAIFileServer.DefinitionStages.WithUserName	This stage of a Batch AI file server definition allows to specify administrator account name.
BatchAIFileServer.DefinitionStages.WithVMSize	This stage of a Batch AI file server definition allows to specify virtual machine size.
BatchAIFileServers	Entry point to Batch AI file servers management API in Azure.
BatchAIJob	Client-side representation of Batch AI Job object, associated with Batch AI Cluster.
BatchAIJob.Definition	The entirety of the Batch AI job definition.
BatchAIJob.DefinitionStages	Grouping of Batch AI job definition stages.
BatchAIJob.DefinitionStages.Blank	The first stage of Batch AI job definition.
BatchAIJob.DefinitionStages.WithCluster	The stage of the Batch AI job definition allowing to specify cluster for the job.
BatchAIJob.DefinitionStages.WithContainerSettings	Specifies details of the container registry and image such as name, URL and credentials.
BatchAIJob.DefinitionStages.WithCreate	The stage of a virtual network gateway connection definition with sufficient inputs to create a new connection in the cloud, but exposing additional optional settings to specify.
BatchAIJob.DefinitionStages.WithEnvironmentVariable	Allows to specify environment variables.
BatchAIJob.DefinitionStages.WithEnvironmentVariableSecretValue	The stage of the Batch AI job definition allowing to specify environment variables with secrets.
BatchAIJob.DefinitionStages.WithInputDirectory
BatchAIJob.DefinitionStages.WithJobPreparation	Specifies the command line to be executed before tool kit is launched.
BatchAIJob.DefinitionStages.WithNodeCount	The stage of the definition allowing to specify number of compute nodes to run the job on.
BatchAIJob.DefinitionStages.WithOutputDirectory
BatchAIJob.DefinitionStages.WithStdOutErrPathPrefix	The stage of the job definition allowing to specify where Batch AI will upload stdout and stderr of the job.
BatchAIJob.DefinitionStages.WithToolType
BatchAIJobs	Entry point for Batch AI jobs management API in Azure.
BatchAIUsage	An immutable client-side representation of an Azure Batch AI resource usage info object.
BatchAIUsages	Entry point for Batch AI resource usage management API.
BatchAIWorkspace	Type representing Workspace.
BatchAIWorkspace.Definition	The entirety of the Workspace definition.
BatchAIWorkspace.DefinitionStages	Grouping of Workspace definition stages.
BatchAIWorkspace.DefinitionStages.Blank	The first stage of a Workspace definition.
BatchAIWorkspace.DefinitionStages.WithCreate	The stage of the definition which contains all the minimum required inputs for the resource to be created (via Creatable.create()), but also allows for any other optional settings to be specified.
BatchAIWorkspace.DefinitionStages.WithGroup	The stage of the Workspace definition allowing to specify the resource group.
BatchAIWorkspace.Update	The template for a Workspace update operation, containing all the settings that can be modified.
BatchAIWorkspaces	Entry point to virtual network gateways management API in Azure.
ContainerImageSettings	Specifies settings for container image.
ContainerImageSettings.Definition<ParentT>	Definition of ContainerImage settings.
ContainerImageSettings.DefinitionStages	Definition stages for container image settings.
ContainerImageSettings.DefinitionStages.Blank<ParentT>	The first stage of the output directory settings definition.
ContainerImageSettings.DefinitionStages.WithAttach<ParentT>	The final stage of the output directory settings definition.
ContainerImageSettings.DefinitionStages.WithRegistryCredentials<ParentT>	Specifies container registry credentials.
ContainerImageSettings.DefinitionStages.WithShmSize<ParentT>	Specifies size of /dev/shm.
FileServer	Client-side representation for FileServerReference.
FileServer.Definition<ParentT>	Definition of file server reference.
FileServer.DefinitionStages	Definition stages for azure blob file system reference.
FileServer.DefinitionStages.Blank<ParentT>
FileServer.DefinitionStages.WithAttach<ParentT>
FileServer.DefinitionStages.WithFileServer<ParentT>
FileServer.DefinitionStages.WithMountOptions<ParentT>
FileServer.DefinitionStages.WithRelativeMountPath<ParentT>
FileServer.DefinitionStages.WithSourceDirectory<ParentT>
NodeSetupTask	A client-side representation of a mode setup task of a Batch AI cluster.
NodeSetupTask.Definition<ParentT>	The entirety of a setup task definition.
NodeSetupTask.DefinitionStages	Grouping of node setup definition stages.
NodeSetupTask.DefinitionStages.Blank<ParentT>	The first stage of the node setup definition.
NodeSetupTask.DefinitionStages.WithAttach<ParentT>	The final stage of the setup task definition.
NodeSetupTask.DefinitionStages.WithCommandLine<ParentT>	The stage of the setup task definition allowing to specify the command line instructions.
NodeSetupTask.DefinitionStages.WithEnvironmentVariable<ParentT>	The stage of the setup task definition allowing to specify environment variables.
NodeSetupTask.DefinitionStages.WithEnvironmentVariableSecretValue<ParentT>	The stage of the setup task definition allowing to specify environment variables with secrets.
NodeSetupTask.DefinitionStages.WithStdOutErrPath<ParentT>	The stage of the setup task definition allowing to specify where Batch AI will upload stdout and stderr of the setup task.
OutputDirectorySettings	Specifies the settings for output directory.
OutputDirectorySettings.Definition<ParentT>	Definition of output directory settings.
OutputDirectorySettings.DefinitionStages	Definition stages for OutputDirectory settings.
OutputDirectorySettings.DefinitionStages.Blank<ParentT>	The first stage of the output directory settings definition.
OutputDirectorySettings.DefinitionStages.WithAttach<ParentT>	The final stage of the output directory settings definition.
OutputDirectorySettings.DefinitionStages.WithPathPrefix<ParentT>	Specifies the prefix path where the output directory will be created.
OutputDirectorySettings.DefinitionStages.WithPathSuffix<ParentT>	Specifies the suffix path where the output directory will be created.
OutputFile	An immutable client-side representation of Batch AI output file.
RemoteLoginInformation	An immutable client-side representation of Batch AI remote login details to SSH/RDP to a compute node in cluster.
ToolTypeSettings	Contains configuration definitions for different tool types.
ToolTypeSettings.Caffe	Specifies the settings for Caffe job.
ToolTypeSettings.Caffe.Definition<ParentT>	Definition of Caffe settings.
ToolTypeSettings.Caffe.DefinitionStages	Definition stages for Caffe settings.
ToolTypeSettings.Caffe.DefinitionStages.Blank<ParentT>	The first stage of the Caffe settings definition.
ToolTypeSettings.Caffe.DefinitionStages.WithAttach<ParentT>	The final stage of the Caffe settings definition.
ToolTypeSettings.Caffe.DefinitionStages.WithAttachAndPythonInterpreter<ParentT>
ToolTypeSettings.Caffe.DefinitionStages.WithFileType<ParentT>	Specifies the path and file name of the python script to execute the job or the path of the config file.
ToolTypeSettings.Caffe2	Specifies the settings for Caffe2 job.
ToolTypeSettings.Caffe2.Definition<ParentT>	Definition of Caffe2 settings.
ToolTypeSettings.Caffe2.DefinitionStages	Definition stages for Caffe2 settings.
ToolTypeSettings.Caffe2.DefinitionStages.Blank<ParentT>	The first stage of the Caffe2 settings definition.
ToolTypeSettings.Caffe2.DefinitionStages.WithAttach<ParentT>	The final stage of the Caffe2 settings definition.
ToolTypeSettings.Caffe2.DefinitionStages.WithAttachAndPythonInterpreter<ParentT>
ToolTypeSettings.Caffe2.DefinitionStages.WithPython<ParentT>	Specifies python script file path to execute the job.
ToolTypeSettings.Chainer	Specifies the settings for Chainer job.
ToolTypeSettings.Chainer.Definition<ParentT>	Definition of Chainer settings.
ToolTypeSettings.Chainer.DefinitionStages	Definition stages for Chainer job settings.
ToolTypeSettings.Chainer.DefinitionStages.Blank<ParentT>	The first stage of the Chainer settings definition.
ToolTypeSettings.Chainer.DefinitionStages.WithAttach<ParentT>	The final stage of the Chainer settings definition.
ToolTypeSettings.Chainer.DefinitionStages.WithAttachAndPythonInterpreter<ParentT>
ToolTypeSettings.Chainer.DefinitionStages.WithPython<ParentT>	Specifies python script file path to execute the job.
ToolTypeSettings.CognitiveToolkit	Client-side representation for Microsoft Cognitive Toolkit settings.
ToolTypeSettings.CognitiveToolkit.Definition<ParentT>	Definition of azure cognitive toolkit settings.
ToolTypeSettings.CognitiveToolkit.DefinitionStages	Definition stages for azure cognitive toolkit settings.
ToolTypeSettings.CognitiveToolkit.DefinitionStages.Blank<ParentT>	The first stage of the Microsoft Cognitive Toolkit settings definition.
ToolTypeSettings.CognitiveToolkit.DefinitionStages.WithAttach<ParentT>	The final stage of the Microsoft Cognitive Toolkit settings definition.
ToolTypeSettings.CognitiveToolkit.DefinitionStages.WithAttachAndPythonInterpreter<ParentT>
ToolTypeSettings.CognitiveToolkit.DefinitionStages.WithLanguageType<ParentT>	Specifies the language type and script/config file path to use for Microsoft Cognitive Toolkit job.
ToolTypeSettings.CustomMpi	Client-side representation for the settings for a custom MPI job.
ToolTypeSettings.CustomMpi.Definition<ParentT>	Definition of the settings for a custom MPI job.
ToolTypeSettings.CustomMpi.DefinitionStages	Definition stages for a custom MPI job.
ToolTypeSettings.CustomMpi.DefinitionStages.Blank<ParentT>	The first stage of the custom MPI job settings definition.
ToolTypeSettings.CustomMpi.DefinitionStages.WithAttach<ParentT>	The final stage of the custom MPI job settings definition.
ToolTypeSettings.CustomMpi.DefinitionStages.WithAttachAndProcessCount<ParentT>	At this stage, any process count settings can be specified, or the custom MPI job settings definition can be attached to the parent Batch AI job definition.
ToolTypeSettings.CustomMpi.DefinitionStages.WithCommandLine<ParentT>	Specifies the program and program command line parameters to be executed by mpi runtime.
ToolTypeSettings.CustomToolkit	Client-side representation for the settings for a custom toolkit job.
ToolTypeSettings.CustomToolkit.Definition<ParentT>	Definition of the settings for a custom toolkit job.
ToolTypeSettings.CustomToolkit.DefinitionStages	Definition stages for a custom toolkit job.
ToolTypeSettings.CustomToolkit.DefinitionStages.Blank<ParentT>	The first stage of the custom toolkit job settings definition.
ToolTypeSettings.CustomToolkit.DefinitionStages.WithAttach<ParentT>	The final stage of the custom toolkit job settings definition.
ToolTypeSettings.CustomToolkit.DefinitionStages.WithCommandLine<ParentT>	Specifies the command line to execute the custom toolkit Job.
ToolTypeSettings.DefinitionStages	Common definition stages.
ToolTypeSettings.DefinitionStages.WithCommandLineArgs<ReturnT>	Specifies command line arguments for the job.
ToolTypeSettings.DefinitionStages.WithProcessCount<ReturnT>	Specifies number of processes parameter that is passed to MPI runtime.
ToolTypeSettings.DefinitionStages.WithPythonInterpreter<ReturnT>	Specifies the path to python interpreter.
ToolTypeSettings.Horovod	Client-side representation for Horovod job settings.
ToolTypeSettings.Horovod.Definition<ParentT>	Definition of the settings for Horovod job.
ToolTypeSettings.Horovod.DefinitionStages	Definition stages for the Horovod job settings.
ToolTypeSettings.Horovod.DefinitionStages.Blank<ParentT>	The first stage of the Horovode job settings definition.
ToolTypeSettings.Horovod.DefinitionStages.WithAttach<ParentT>	The final stage of the Horovod job settings definition.
ToolTypeSettings.Horovod.DefinitionStages.WithPython<ParentT>	Specifies python script file path to execute the job.
ToolTypeSettings.PyTorch	Client-side representation for PyTorch toolkit settings.
ToolTypeSettings.PyTorch.Definition<ParentT>	Definition of PyTorch toolkit settings.
ToolTypeSettings.PyTorch.DefinitionStages	Definition stages for PyTorch toolkit settings.
ToolTypeSettings.PyTorch.DefinitionStages.Blank<ParentT>	The first stage of the PyTorch settings definition.
ToolTypeSettings.PyTorch.DefinitionStages.WithAttach<ParentT>	The final stage of the PyTorch Toolkit settings definition.
ToolTypeSettings.PyTorch.DefinitionStages.WithPython<ParentT>	Specifies python script file path to execute the job.
ToolTypeSettings.TensorFlow	Specifies the settings for TensorFlow job.
ToolTypeSettings.TensorFlow.Definition<ParentT>	Definition of TensorFlow job settings.
ToolTypeSettings.TensorFlow.DefinitionStages	Definition stages for TensorFlow job settings.
ToolTypeSettings.TensorFlow.DefinitionStages.Blank<ParentT>	The first stage of the TensorFlow settings definition.
ToolTypeSettings.TensorFlow.DefinitionStages.WithAttach<ParentT>	The final stage of the TensorFlow settings definition.
ToolTypeSettings.TensorFlow.DefinitionStages.WithMasterCommandLineArgs<ParentT>
ToolTypeSettings.TensorFlow.DefinitionStages.WithPython<ParentT>	Specifies python script file path.

Class Summary

Class	Description
AllocationState	Defines values for AllocationState.
AppInsightsReference	Azure Application Insights information for performance counters reporting.
AutoScaleSettings	Auto-scale settings for the cluster.
AzureBlobFileSystemReference	Azure Blob Storage Container mounting configuration.
AzureFileShareReference	Azure File Share mounting configuration.
AzureStorageCredentialsInfo	Azure storage account credentials.
BatchAIError	An error response from the Batch AI service.
Caffe2Settings	Caffe2 job settings.
CaffeSettings	Caffe job settings.
ChainerSettings	Chainer job settings.
ClusterCreateParameters	Cluster creation operation.
ClustersListByWorkspaceOptions	Additional parameters for listByWorkspace operation.
ClusterUpdateParameters	Cluster update parameters.
CNTKsettings	CNTK (aka Microsoft Cognitive Toolkit) job settings.
ContainerSettings	Docker container settings.
CustomMpiSettings	Custom MPI job settings.
CustomToolkitSettings	Custom tool kit job settings.
DataDisks	Data disks settings.
DeallocationOption	Defines values for DeallocationOption.
EnvironmentVariable	An environment variable definition.
EnvironmentVariableWithSecretValue	An environment variable with secret value definition.
ExecutionState	Defines values for ExecutionState.
ExperimentsListByWorkspaceOptions	Additional parameters for listByWorkspace operation.
FileServerCreateParameters	File Server creation parameters.
FileServerProvisioningState	Defines values for FileServerProvisioningState.
FileServerReference	File Server mounting configuration.
FileServersListByWorkspaceOptions	Additional parameters for listByWorkspace operation.
FileType	Defines values for FileType.
HorovodSettings	Specifies the settings for Horovod job.
ImageReference	The OS image reference.
ImageSourceRegistry	Information about docker image for the job.
InputDirectory	Input directory for the job.
JobBasePropertiesConstraints	Constraints associated with the Job.
JobCreateParameters	Job creation parameters.
JobPreparation	Job preparation settings.
JobPriority	Defines values for JobPriority.
JobPropertiesConstraints	Constraints associated with the Job.
JobPropertiesExecutionInfo	Information about the execution of a job.
JobsListByExperimentOptions	Additional parameters for listByExperiment operation.
JobsListOutputFilesOptions	Additional parameters for listOutputFiles operation.
KeyVaultSecretReference	Key Vault Secret reference.
ManualScaleSettings	Manual scale settings for the cluster.
MountSettings	File Server mount Information.
MountVolumes	Details of volumes to mount on the cluster.
NameValuePair	Name-value pair.
NodeSetup	Node setup settings.
NodeStateCounts	Counts of various compute node states on the cluster.
OperationDisplay	The object that describes the operation.
OutputDirectory	Output directory for the job.
PerformanceCountersSettings	Performance counters reporting settings.
PrivateRegistryCredentials	Credentials to access a container image in a private repository.
ProvisioningState	Defines values for ProvisioningState.
PyTorchSettings	pyTorch job settings.
ResourceId	Represents a resource ID.
ScaleSettings	At least one of manual or autoScale settings must be specified.
SetupTask	Specifies a setup task which can be used to customize the compute nodes of the cluster.
SshConfiguration	SSH configuration.
StorageAccountType	Defines values for StorageAccountType.
TensorFlowSettings	TensorFlow job settings.
ToolType	Defines values for ToolType.
UnmanagedFileSystemReference	Unmananged file system mounting configuration.
UsageName	The Usage Names.
UsageUnit	Defines values for UsageUnit.
UserAccountSettings	Settings for user account that gets created on each on the nodes of a cluster.
VirtualMachineConfiguration	VM configuration.
WorkspaceCreateParameters	Workspace creation parameters.
WorkspacesListByResourceGroupOptions	Additional parameters for listByResourceGroup operation.
WorkspacesListOptions	Additional parameters for list operation.
WorkspaceUpdateParameters	Workspace update parameters.

Enum Summary

Enum	Description
CachingType	Defines values for CachingType.
VmPriority	Defines values for VmPriority.

Package com.microsoft.azure.management.batchai Description

This package contains the classes for BatchAIManagementClient. The Azure BatchAI Management API.