@azure/arm-batchai package
Classes
| BatchAIManagementClient | |
| BatchAIManagementClientContext | |
| Clusters |
Class representing a Clusters. |
| Experiments |
Class representing a Experiments. |
| FileServers |
Class representing a FileServers. |
| Jobs |
Class representing a Jobs. |
| Operations |
Class representing a Operations. |
| Usages |
Class representing a Usages. |
| Workspaces |
Class representing a Workspaces. |
Interfaces
| AppInsightsReference |
An interface representing AppInsightsReference. Azure Application Insights information for performance counters reporting. |
| AutoScaleSettings |
An interface representing 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. |
| AzureBlobFileSystemReference |
An interface representing AzureBlobFileSystemReference. Azure Blob Storage Container mounting configuration. |
| AzureFileShareReference |
An interface representing AzureFileShareReference. Azure File Share mounting configuration. |
| AzureStorageCredentialsInfo |
An interface representing AzureStorageCredentialsInfo. Azure storage account credentials. |
| BaseResource |
An empty interface. |
| BatchAIError |
An interface representing BatchAIError. An error response from the Batch AI service. |
| BatchAIManagementClientOptions |
An interface representing BatchAIManagementClientOptions. |
| Caffe2Settings |
An interface representing Caffe2Settings. Caffe2 job settings. |
| CaffeSettings |
An interface representing CaffeSettings. Caffe job settings. |
| ChainerSettings |
An interface representing ChainerSettings. Chainer job settings. |
| CloudError |
Provides additional information about an http error response returned from a Microsoft Azure service. |
| Cluster |
An interface representing Cluster. Information about a Cluster. |
| ClusterCreateParameters |
An interface representing ClusterCreateParameters. Cluster creation operation. |
| ClusterListResult |
An interface representing the ClusterListResult. Values returned by the List Clusters operation. |
| ClustersListByWorkspaceOptionalParams |
An interface representing ClustersListByWorkspaceOptionalParams. Optional Parameters. |
| ClustersListByWorkspaceOptions |
An interface representing ClustersListByWorkspaceOptions. Additional parameters for listByWorkspace operation. |
| ClustersUpdateOptionalParams |
An interface representing ClustersUpdateOptionalParams. Optional Parameters. |
| ClusterUpdateParameters |
An interface representing ClusterUpdateParameters. Cluster update parameters. |
| CNTKsettings |
An interface representing CNTKsettings. CNTK (aka Microsoft Cognitive Toolkit) job settings. |
| ContainerSettings |
An interface representing ContainerSettings. Docker container settings. |
| CustomMpiSettings |
An interface representing CustomMpiSettings. Custom MPI job settings. |
| CustomToolkitSettings |
An interface representing CustomToolkitSettings. Custom tool kit job settings. |
| DataDisks |
An interface representing DataDisks. Data disks settings. |
| EnvironmentVariable |
An interface representing EnvironmentVariable. An environment variable definition. |
| EnvironmentVariableWithSecretValue |
An interface representing EnvironmentVariableWithSecretValue. An environment variable with secret value definition. |
| Experiment |
An interface representing Experiment. Experiment information. |
| ExperimentListResult |
An interface representing the ExperimentListResult. Values returned by the List operation. |
| ExperimentsListByWorkspaceOptionalParams |
An interface representing ExperimentsListByWorkspaceOptionalParams. Optional Parameters. |
| ExperimentsListByWorkspaceOptions |
An interface representing ExperimentsListByWorkspaceOptions. Additional parameters for listByWorkspace operation. |
| File |
An interface representing File. Properties of the file or directory. |
| FileListResult |
An interface representing the FileListResult. Values returned by the List operation. |
| FileServer |
An interface representing FileServer. File Server information. |
| FileServerCreateParameters |
An interface representing FileServerCreateParameters. File Server creation parameters. |
| FileServerListResult |
An interface representing the FileServerListResult. Values returned by the File Server List operation. |
| FileServerReference |
An interface representing FileServerReference. File Server mounting configuration. |
| FileServersListByWorkspaceOptionalParams |
An interface representing FileServersListByWorkspaceOptionalParams. Optional Parameters. |
| FileServersListByWorkspaceOptions |
An interface representing FileServersListByWorkspaceOptions. Additional parameters for listByWorkspace operation. |
| HorovodSettings |
An interface representing HorovodSettings. Specifies the settings for Horovod job. |
| ImageReference |
An interface representing ImageReference. The OS image reference. |
| ImageSourceRegistry |
An interface representing ImageSourceRegistry. Information about docker image for the job. |
| InputDirectory |
An interface representing InputDirectory. Input directory for the job. |
| Job |
An interface representing Job. Information about a Job. |
| JobBasePropertiesConstraints |
An interface representing JobBasePropertiesConstraints. Constraints associated with the Job. |
| JobCreateParameters |
An interface representing JobCreateParameters. Job creation parameters. |
| JobListResult |
An interface representing the JobListResult. Values returned by the List operation. |
| JobPreparation |
An interface representing JobPreparation. Job preparation settings. |
| JobPropertiesConstraints |
An interface representing JobPropertiesConstraints. Constraints associated with the Job. |
| JobPropertiesExecutionInfo |
An interface representing JobPropertiesExecutionInfo. Information about the execution of a job. |
| JobsListByExperimentOptionalParams |
An interface representing JobsListByExperimentOptionalParams. Optional Parameters. |
| JobsListByExperimentOptions |
An interface representing JobsListByExperimentOptions. Additional parameters for listByExperiment operation. |
| JobsListOutputFilesOptions |
An interface representing JobsListOutputFilesOptions. Additional parameters for listOutputFiles operation. |
| KeyVaultSecretReference |
An interface representing KeyVaultSecretReference. Key Vault Secret reference. |
| ListUsagesResult |
An interface representing the ListUsagesResult. The List Usages operation response. |
| ManualScaleSettings |
An interface representing ManualScaleSettings. Manual scale settings for the cluster. |
| MountSettings |
An interface representing MountSettings. File Server mount Information. |
| MountVolumes |
An interface representing MountVolumes. Details of volumes to mount on the cluster. |
| NameValuePair |
An interface representing NameValuePair. Name-value pair. |
| NodeSetup |
An interface representing NodeSetup. Node setup settings. |
| NodeStateCounts |
An interface representing NodeStateCounts. Counts of various compute node states on the cluster. |
| Operation |
An interface representing Operation. |
| OperationDisplay |
An interface representing OperationDisplay. The object that describes the operation. |
| OperationListResult |
An interface representing the OperationListResult. |
| OutputDirectory |
An interface representing OutputDirectory. Output directory for the job. |
| PerformanceCountersSettings |
An interface representing PerformanceCountersSettings. Performance counters reporting settings. |
| PrivateRegistryCredentials |
An interface representing PrivateRegistryCredentials. Credentials to access a container image in a private repository. |
| ProxyResource |
An interface representing ProxyResource. A definition of an Azure proxy resource. |
| PyTorchSettings |
An interface representing PyTorchSettings. pyTorch job settings. |
| RemoteLoginInformation |
An interface representing RemoteLoginInformation. Login details to SSH to a compute node in cluster. |
| RemoteLoginInformationListResult |
An interface representing the RemoteLoginInformationListResult. Values returned by the List operation. |
| Resource |
An interface representing Resource. A definition of an Azure resource. |
| ResourceId |
An interface representing ResourceId. Represents a resource ID. For example, for a subnet, it is the resource URL for the subnet. |
| ScaleSettings |
An interface representing 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 |
An interface representing SetupTask. Specifies a setup task which can be used to customize the compute nodes of the cluster. |
| SshConfiguration |
An interface representing SshConfiguration. SSH configuration. |
| TensorFlowSettings |
An interface representing TensorFlowSettings. TensorFlow job settings. |
| UnmanagedFileSystemReference |
An interface representing UnmanagedFileSystemReference. Unmananged file system mounting configuration. |
| Usage |
An interface representing Usage. Describes Batch AI Resource Usage. |
| UsageName |
An interface representing UsageName. The Usage Names. |
| UserAccountSettings |
An interface representing UserAccountSettings. Settings for user account that gets created on each on the nodes of a cluster. |
| VirtualMachineConfiguration |
An interface representing VirtualMachineConfiguration. VM configuration. |
| Workspace |
An interface representing Workspace. Batch AI Workspace information. |
| WorkspaceCreateParameters |
An interface representing WorkspaceCreateParameters. Workspace creation parameters. |
| WorkspaceListResult |
An interface representing the WorkspaceListResult. Values returned by the List operation. |
| WorkspacesListByResourceGroupOptionalParams |
An interface representing WorkspacesListByResourceGroupOptionalParams. Optional Parameters. |
| WorkspacesListByResourceGroupOptions |
An interface representing WorkspacesListByResourceGroupOptions. Additional parameters for listByResourceGroup operation. |
| WorkspacesListOptionalParams |
An interface representing WorkspacesListOptionalParams. Optional Parameters. |
| WorkspacesListOptions |
An interface representing WorkspacesListOptions. Additional parameters for list operation. |
| WorkspacesUpdateOptionalParams |
An interface representing WorkspacesUpdateOptionalParams. Optional Parameters. |
| WorkspaceUpdateParameters |
An interface representing WorkspaceUpdateParameters. Workspace update parameters. |
Type Aliases
| AllocationState |
Defines values for AllocationState. Possible values include: 'steady', 'resizing' |
| CachingType |
Defines values for CachingType. Possible values include: 'none', 'readonly', 'readwrite' |
| ClustersBeginCreateResponse |
Contains response data for the beginCreate operation. |
| ClustersCreateResponse |
Contains response data for the create operation. |
| ClustersGetResponse |
Contains response data for the get operation. |
| ClustersListByWorkspaceNextResponse |
Contains response data for the listByWorkspaceNext operation. |
| ClustersListByWorkspaceResponse |
Contains response data for the listByWorkspace operation. |
| ClustersListRemoteLoginInformationNextResponse |
Contains response data for the listRemoteLoginInformationNext operation. |
| ClustersListRemoteLoginInformationResponse |
Contains response data for the listRemoteLoginInformation operation. |
| ClustersUpdateResponse |
Contains response data for the update operation. |
| DeallocationOption |
Defines values for DeallocationOption. Possible values include: 'requeue', 'terminate', 'waitforjobcompletion' |
| ExecutionState |
Defines values for ExecutionState. Possible values include: 'queued', 'running', 'terminating', 'succeeded', 'failed' |
| ExperimentsBeginCreateResponse |
Contains response data for the beginCreate operation. |
| ExperimentsCreateResponse |
Contains response data for the create operation. |
| ExperimentsGetResponse |
Contains response data for the get operation. |
| ExperimentsListByWorkspaceNextResponse |
Contains response data for the listByWorkspaceNext operation. |
| ExperimentsListByWorkspaceResponse |
Contains response data for the listByWorkspace operation. |
| FileServerProvisioningState |
Defines values for FileServerProvisioningState. Possible values include: 'creating', 'updating', 'deleting', 'succeeded', 'failed' |
| FileServersBeginCreateResponse |
Contains response data for the beginCreate operation. |
| FileServersCreateResponse |
Contains response data for the create operation. |
| FileServersGetResponse |
Contains response data for the get operation. |
| FileServersListByWorkspaceNextResponse |
Contains response data for the listByWorkspaceNext operation. |
| FileServersListByWorkspaceResponse |
Contains response data for the listByWorkspace operation. |
| FileType |
Defines values for FileType. Possible values include: 'file', 'directory' |
| JobPriority |
Defines values for JobPriority. Possible values include: 'low', 'normal', 'high' |
| JobsBeginCreateResponse |
Contains response data for the beginCreate operation. |
| JobsCreateResponse |
Contains response data for the create operation. |
| JobsGetResponse |
Contains response data for the get operation. |
| JobsListByExperimentNextResponse |
Contains response data for the listByExperimentNext operation. |
| JobsListByExperimentResponse |
Contains response data for the listByExperiment operation. |
| JobsListOutputFilesNextResponse |
Contains response data for the listOutputFilesNext operation. |
| JobsListOutputFilesResponse |
Contains response data for the listOutputFiles operation. |
| JobsListRemoteLoginInformationNextResponse |
Contains response data for the listRemoteLoginInformationNext operation. |
| JobsListRemoteLoginInformationResponse |
Contains response data for the listRemoteLoginInformation operation. |
| OperationsListNextResponse |
Contains response data for the listNext operation. |
| OperationsListResponse |
Contains response data for the list operation. |
| ProvisioningState |
Defines values for ProvisioningState. Possible values include: 'creating', 'succeeded', 'failed', 'deleting' |
| StorageAccountType |
Defines values for StorageAccountType. Possible values include: 'Standard_LRS', 'Premium_LRS' |
| ToolType |
Defines values for ToolType. Possible values include: 'cntk', 'tensorflow', 'caffe', 'caffe2', 'chainer', 'horovod', 'custommpi', 'custom' |
| UsagesListNextResponse |
Contains response data for the listNext operation. |
| UsagesListResponse |
Contains response data for the list operation. |
| UsageUnit |
Defines values for UsageUnit. Possible values include: 'Count' |
| VmPriority |
Defines values for VmPriority. Possible values include: 'dedicated', 'lowpriority' |
| WorkspacesBeginCreateResponse |
Contains response data for the beginCreate operation. |
| WorkspacesCreateResponse |
Contains response data for the create operation. |
| WorkspacesGetResponse |
Contains response data for the get operation. |
| WorkspacesListByResourceGroupNextResponse |
Contains response data for the listByResourceGroupNext operation. |
| WorkspacesListByResourceGroupResponse |
Contains response data for the listByResourceGroup operation. |
| WorkspacesListNextResponse |
Contains response data for the listNext operation. |
| WorkspacesListResponse |
Contains response data for the list operation. |
| WorkspacesUpdateResponse |
Contains response data for the update operation. |