models Package

Classes

AppInsightsReference	Azure Application Insights information for performance counters reporting. All required parameters must be populated in order to send to Azure.
AutoScaleSettings	Auto-scale settings for the cluster. The system automatically scales the cluster up and down (within minimumNodeCount and maximumNodeCount) based on the number of queued and running jobs assigned to the cluster. All required parameters must be populated in order to send to Azure.
AzureBlobFileSystemReference	Azure Blob Storage Container mounting configuration. All required parameters must be populated in order to send to Azure.
AzureFileShareReference	Azure File Share mounting configuration. All required parameters must be populated in order to send to Azure.
AzureStorageCredentialsInfo	Azure storage account credentials.
BatchAIError	An error response from the Batch AI service. Variables are only populated by the server, and will be ignored when sending a request.
CNTKsettings	CNTK (aka Microsoft Cognitive Toolkit) job settings.
Caffe2Settings	Caffe2 job settings. All required parameters must be populated in order to send to Azure.
CaffeSettings	Caffe job settings.
ChainerSettings	Chainer job settings. All required parameters must be populated in order to send to Azure.
CloudErrorBody	An error response from the Batch AI service. Variables are only populated by the server, and will be ignored when sending a request.
Cluster	Information about a Cluster. Variables are only populated by the server, and will be ignored when sending a request.
ClusterCreateParameters	Cluster creation operation.
ClusterListResult	Values returned by the List Clusters operation. Variables are only populated by the server, and will be ignored when sending a request.
ClusterUpdateParameters	Cluster update parameters.
ClustersListByWorkspaceOptions	Parameter group.
ContainerSettings	Docker container settings. All required parameters must be populated in order to send to Azure.
CustomMpiSettings	Custom MPI job settings. All required parameters must be populated in order to send to Azure.
CustomToolkitSettings	Custom tool kit job settings.
DataDisks	Data disks settings. All required parameters must be populated in order to send to Azure.
EnvironmentVariable	An environment variable definition. All required parameters must be populated in order to send to Azure.
EnvironmentVariableWithSecretValue	An environment variable with secret value definition. All required parameters must be populated in order to send to Azure.
Experiment	Experiment information. Variables are only populated by the server, and will be ignored when sending a request.
ExperimentListResult	Values returned by the List operation. Variables are only populated by the server, and will be ignored when sending a request.
ExperimentsListByWorkspaceOptions	Parameter group.
File	Properties of the file or directory. Variables are only populated by the server, and will be ignored when sending a request.
FileListResult	Values returned by the List operation. Variables are only populated by the server, and will be ignored when sending a request.
FileServer	File Server information. Variables are only populated by the server, and will be ignored when sending a request.
FileServerCreateParameters	File Server creation parameters.
FileServerListResult	Values returned by the File Server List operation. Variables are only populated by the server, and will be ignored when sending a request.
FileServerReference	File Server mounting configuration. All required parameters must be populated in order to send to Azure.
FileServersListByWorkspaceOptions	Parameter group.
HorovodSettings	Specifies the settings for Horovod job. All required parameters must be populated in order to send to Azure.
ImageReference	The OS image reference. All required parameters must be populated in order to send to Azure.
ImageSourceRegistry	Information about docker image for the job. All required parameters must be populated in order to send to Azure.
InputDirectory	Input directory for the job. All required parameters must be populated in order to send to Azure.
Job	Information about a Job. Variables are only populated by the server, and will be ignored when sending a request.
JobBasePropertiesConstraints	Constraints associated with the Job.
JobCreateParameters	Job creation parameters.
JobListResult	Values returned by the List operation. Variables are only populated by the server, and will be ignored when sending a request.
JobPreparation	Job preparation settings. All required parameters must be populated in order to send to Azure.
JobPropertiesConstraints	Constraints associated with the Job.
JobPropertiesExecutionInfo	Information about the execution of a job. Variables are only populated by the server, and will be ignored when sending a request.
JobsListByExperimentOptions	Parameter group.
JobsListOutputFilesOptions	Parameter group. All required parameters must be populated in order to send to Azure.
KeyVaultSecretReference	Key Vault Secret reference. All required parameters must be populated in order to send to Azure.
ListUsagesResult	The List Usages operation response. Variables are only populated by the server, and will be ignored when sending a request.
ManualScaleSettings	Manual scale settings for the cluster. All required parameters must be populated in order to send to Azure.
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. Variables are only populated by the server, and will be ignored when sending a request.
Operation	Details of a REST API operation. Variables are only populated by the server, and will be ignored when sending a request.
OperationDisplay	The object that describes the operation. Variables are only populated by the server, and will be ignored when sending a request.
OperationListResult	Contains the list of all operations supported by BatchAI resource provider. Variables are only populated by the server, and will be ignored when sending a request.
OutputDirectory	Output directory for the job. All required parameters must be populated in order to send to Azure.
PerformanceCountersSettings	Performance counters reporting settings. All required parameters must be populated in order to send to Azure.
PrivateRegistryCredentials	Credentials to access a container image in a private repository. All required parameters must be populated in order to send to Azure.
ProxyResource	A definition of an Azure proxy resource. Variables are only populated by the server, and will be ignored when sending a request.
PyTorchSettings	pyTorch job settings. All required parameters must be populated in order to send to Azure.
RemoteLoginInformation	Login details to SSH to a compute node in cluster. Variables are only populated by the server, and will be ignored when sending a request.
RemoteLoginInformationListResult	Values returned by the List operation. Variables are only populated by the server, and will be ignored when sending a request.
Resource	A definition of an Azure resource. Variables are only populated by the server, and will be ignored when sending a request.
ResourceId	Represents a resource ID. For example, for a subnet, it is the resource URL for the subnet. All required parameters must be populated in order to send to Azure.
ScaleSettings	At least one of manual or autoScale settings must be specified. Only one of manual or autoScale settings can be specified. If autoScale settings are specified, the system automatically scales the cluster up and down (within the supplied limits) based on the pending jobs on the cluster.
SetupTask	Specifies a setup task which can be used to customize the compute nodes of the cluster. Variables are only populated by the server, and will be ignored when sending a request. All required parameters must be populated in order to send to Azure.
SshConfiguration	SSH configuration. All required parameters must be populated in order to send to Azure.
TensorFlowSettings	TensorFlow job settings. All required parameters must be populated in order to send to Azure.
UnmanagedFileSystemReference	Unmanaged file system mounting configuration. All required parameters must be populated in order to send to Azure.
Usage	Describes Batch AI Resource Usage. Variables are only populated by the server, and will be ignored when sending a request.
UsageName	The Usage Names. Variables are only populated by the server, and will be ignored when sending a request.
UserAccountSettings	Settings for user account that gets created on each on the nodes of a cluster. All required parameters must be populated in order to send to Azure.
VirtualMachineConfiguration	VM configuration.
Workspace	Batch AI Workspace information. Variables are only populated by the server, and will be ignored when sending a request.
WorkspaceCreateParameters	Workspace creation parameters. All required parameters must be populated in order to send to Azure.
WorkspaceListResult	Values returned by the List operation. Variables are only populated by the server, and will be ignored when sending a request.
WorkspaceUpdateParameters	Workspace update parameters.
WorkspacesListByResourceGroupOptions	Parameter group.
WorkspacesListOptions	Parameter group.

Enums

AllocationState	Allocation state of the cluster. Possible values are: steady - Indicates that the cluster is not resizing. There are no changes to the number of compute nodes in the cluster in progress. A cluster enters this state when it is created and when no operations are being performed on the cluster to change the number of compute nodes. resizing - Indicates that the cluster is resizing; that is, compute nodes are being added to or removed from the cluster.
CachingType	Caching type for the disks. Available values are none (default), readonly, readwrite. Caching type can be set only for VM sizes supporting premium storage.
DeallocationOption	Actions which should be performed when compute nodes are removed from the cluster. Possible values are: requeue (default) - Terminate running jobs and requeue them so the jobs will run again. Remove compute nodes as soon as jobs have been terminated; terminate - Terminate running jobs. The jobs will not run again. Remove compute nodes as soon as jobs have been terminated. waitforjobcompletion - Allow currently running jobs to complete. Schedule no new jobs while waiting. Remove compute nodes when all jobs have completed.
ExecutionState	The current state of the job. Possible values are: queued - The job is queued and able to run. A job enters this state when it is created, or when it is awaiting a retry after a failed run. running - The job is running on a compute cluster. This includes job-level preparation such as downloading resource files or set up container specified on the job - it does not necessarily mean that the job command line has started executing. terminating - The job is terminated by the user, the terminate operation is in progress. succeeded - The job has completed running successfully and exited with exit code 0. failed - The job has finished unsuccessfully (failed with a non-zero exit code) and has exhausted its retry limit. A job is also marked as failed if an error occurred launching the job.
FileServerProvisioningState	Provisioning state of the File Server. Possible values: creating - The File Server is getting created; updating - The File Server creation has been accepted and it is getting updated; deleting - The user has requested that the File Server be deleted, and it is in the process of being deleted; failed - The File Server creation has failed with the specified error code. Details about the error code are specified in the message field; succeeded - The File Server creation has succeeded.
FileType	Type of the file. Possible values are file and directory.
JobPriority	Scheduling priority associated with the job. Possible values: low, normal, high.
ProvisioningState	Provisioning state of the cluster. Possible value are: creating - Specifies that the cluster is being created. succeeded - Specifies that the cluster has been created successfully. failed - Specifies that the cluster creation has failed. deleting - Specifies that the cluster is being deleted.
StorageAccountType	Type of storage account to be used on the disk. Possible values are: Standard_LRS or Premium_LRS. Premium storage account type can only be used with VM sizes supporting premium storage.
ToolType	The toolkit type of the job.
UsageUnit	An enum describing the unit of usage measurement.
VmPriority	VM priority. Allowed values are: dedicated (default) and lowpriority.