@azure/arm-batchai

Index

Classes

Interfaces

Type aliases

Variables

Object literals

Type aliases

AllocationState

AllocationState: "steady" | "resizing"

Defines values for AllocationState. Possible values include: 'steady', 'resizing'

readonly
enum: {string}

CachingType

CachingType: "none" | "readonly" | "readwrite"

Defines values for CachingType. Possible values include: 'none', 'readonly', 'readwrite'

readonly
enum: {string}

ClustersBeginCreateResponse

ClustersBeginCreateResponse: Cluster & object

Contains response data for the beginCreate operation.

ClustersCreateResponse

ClustersCreateResponse: Cluster & object

Contains response data for the create operation.

ClustersGetResponse

ClustersGetResponse: Cluster & object

Contains response data for the get operation.

ClustersListByWorkspaceNextResponse

ClustersListByWorkspaceNextResponse: ClusterListResult & object

Contains response data for the listByWorkspaceNext operation.

ClustersListByWorkspaceResponse

ClustersListByWorkspaceResponse: ClusterListResult & object

Contains response data for the listByWorkspace operation.

ClustersListRemoteLoginInformationNextResponse

ClustersListRemoteLoginInformationNextResponse: RemoteLoginInformationListResult & object

Contains response data for the listRemoteLoginInformationNext operation.

ClustersListRemoteLoginInformationResponse

ClustersListRemoteLoginInformationResponse: RemoteLoginInformationListResult & object

Contains response data for the listRemoteLoginInformation operation.

ClustersUpdateResponse

ClustersUpdateResponse: Cluster & object

Contains response data for the update operation.

DeallocationOption

DeallocationOption: "requeue" | "terminate" | "waitforjobcompletion"

Defines values for DeallocationOption. Possible values include: 'requeue', 'terminate', 'waitforjobcompletion'

readonly
enum: {string}

ExecutionState

ExecutionState: "queued" | "running" | "terminating" | "succeeded" | "failed"

Defines values for ExecutionState. Possible values include: 'queued', 'running', 'terminating', 'succeeded', 'failed'

readonly
enum: {string}

ExperimentsBeginCreateResponse

ExperimentsBeginCreateResponse: Experiment & object

Contains response data for the beginCreate operation.

ExperimentsCreateResponse

ExperimentsCreateResponse: Experiment & object

Contains response data for the create operation.

ExperimentsGetResponse

ExperimentsGetResponse: Experiment & object

Contains response data for the get operation.

ExperimentsListByWorkspaceNextResponse

ExperimentsListByWorkspaceNextResponse: ExperimentListResult & object

Contains response data for the listByWorkspaceNext operation.

ExperimentsListByWorkspaceResponse

ExperimentsListByWorkspaceResponse: ExperimentListResult & object

Contains response data for the listByWorkspace operation.

FileServerProvisioningState

FileServerProvisioningState: "creating" | "updating" | "deleting" | "succeeded" | "failed"

Defines values for FileServerProvisioningState. Possible values include: 'creating', 'updating', 'deleting', 'succeeded', 'failed'

readonly
enum: {string}

FileServersBeginCreateResponse

FileServersBeginCreateResponse: FileServer & object

Contains response data for the beginCreate operation.

FileServersCreateResponse

FileServersCreateResponse: FileServer & object

Contains response data for the create operation.

FileServersGetResponse

FileServersGetResponse: FileServer & object

Contains response data for the get operation.

FileServersListByWorkspaceNextResponse

FileServersListByWorkspaceNextResponse: FileServerListResult & object

Contains response data for the listByWorkspaceNext operation.

FileServersListByWorkspaceResponse

FileServersListByWorkspaceResponse: FileServerListResult & object

Contains response data for the listByWorkspace operation.

FileType

FileType: "file" | "directory"

Defines values for FileType. Possible values include: 'file', 'directory'

readonly
enum: {string}

JobPriority

JobPriority: "low" | "normal" | "high"

Defines values for JobPriority. Possible values include: 'low', 'normal', 'high'

readonly
enum: {string}

JobsBeginCreateResponse

JobsBeginCreateResponse: Job & object

Contains response data for the beginCreate operation.

JobsCreateResponse

JobsCreateResponse: Job & object

Contains response data for the create operation.

JobsGetResponse

JobsGetResponse: Job & object

Contains response data for the get operation.

JobsListByExperimentNextResponse

JobsListByExperimentNextResponse: JobListResult & object

Contains response data for the listByExperimentNext operation.

JobsListByExperimentResponse

JobsListByExperimentResponse: JobListResult & object

Contains response data for the listByExperiment operation.

JobsListOutputFilesNextResponse

JobsListOutputFilesNextResponse: FileListResult & object

Contains response data for the listOutputFilesNext operation.

JobsListOutputFilesResponse

JobsListOutputFilesResponse: FileListResult & object

Contains response data for the listOutputFiles operation.

JobsListRemoteLoginInformationNextResponse

JobsListRemoteLoginInformationNextResponse: RemoteLoginInformationListResult & object

Contains response data for the listRemoteLoginInformationNext operation.

JobsListRemoteLoginInformationResponse

JobsListRemoteLoginInformationResponse: RemoteLoginInformationListResult & object

Contains response data for the listRemoteLoginInformation operation.

OperationsListNextResponse

OperationsListNextResponse: OperationListResult & object

Contains response data for the listNext operation.

OperationsListResponse

OperationsListResponse: OperationListResult & object

Contains response data for the list operation.

ProvisioningState

ProvisioningState: "creating" | "succeeded" | "failed" | "deleting"

Defines values for ProvisioningState. Possible values include: 'creating', 'succeeded', 'failed', 'deleting'

readonly
enum: {string}

StorageAccountType

StorageAccountType: "Standard_LRS" | "Premium_LRS"

Defines values for StorageAccountType. Possible values include: 'Standard_LRS', 'Premium_LRS'

readonly
enum: {string}

ToolType

Defines values for ToolType. Possible values include: 'cntk', 'tensorflow', 'caffe', 'caffe2', 'chainer', 'horovod', 'custommpi', 'custom'

readonly
enum: {string}

UsageUnit

UsageUnit: "Count"

Defines values for UsageUnit. Possible values include: 'Count'

readonly
enum: {string}

UsagesListNextResponse

UsagesListNextResponse: ListUsagesResult & object

Contains response data for the listNext operation.

UsagesListResponse

UsagesListResponse: ListUsagesResult & object

Contains response data for the list operation.

VmPriority

VmPriority: "dedicated" | "lowpriority"

Defines values for VmPriority. Possible values include: 'dedicated', 'lowpriority'

readonly
enum: {string}

WorkspacesBeginCreateResponse

WorkspacesBeginCreateResponse: Workspace & object

Contains response data for the beginCreate operation.

WorkspacesCreateResponse

WorkspacesCreateResponse: Workspace & object

Contains response data for the create operation.

WorkspacesGetResponse

WorkspacesGetResponse: Workspace & object

Contains response data for the get operation.

WorkspacesListByResourceGroupNextResponse

WorkspacesListByResourceGroupNextResponse: WorkspaceListResult & object

Contains response data for the listByResourceGroupNext operation.

WorkspacesListByResourceGroupResponse

WorkspacesListByResourceGroupResponse: WorkspaceListResult & object

Contains response data for the listByResourceGroup operation.

WorkspacesListNextResponse

WorkspacesListNextResponse: WorkspaceListResult & object

Contains response data for the listNext operation.

WorkspacesListResponse

WorkspacesListResponse: WorkspaceListResult & object

Contains response data for the list operation.

WorkspacesUpdateResponse

WorkspacesUpdateResponse: Workspace & object

Contains response data for the update operation.

Variables

Const BaseResource

BaseResource: any = BaseResourceMapper

Const CloudError

CloudError: any = CloudErrorMapper

Object literals

Const AppInsightsReference

AppInsightsReference: object

serializedName

serializedName: string = "AppInsightsReference"

type

type: object

className

className: string = "AppInsightsReference"

name

modelProperties

modelProperties: object

component

component: object

required

className

className: string = "KeyVaultSecretReference"

name

Const AutoScaleSettings

AutoScaleSettings: object

serializedName

serializedName: string = "AutoScaleSettings"

type

type: object

className

className: string = "AutoScaleSettings"

name

modelProperties

type

type: object

name

containerName

name

azureFileUrl

azureFileUrl: object

required

required: boolean = true

serializedName

serializedName: string = "azureFileUrl"

type

type: object

name

credentials

type

type: object

name

details

details: object

readOnly

readOnly: boolean = true

serializedName

serializedName: string = "details"

type

type: object

className

className: string = "Caffe2Settings"

name

modelProperties

type

type: object

name

Const CaffeSettings

CaffeSettings: object

serializedName

serializedName: string = "CaffeSettings"

type

type: object

className

className: string = "CaffeSettings"

name

modelProperties

className

className: string = "ChainerSettings"

name

modelProperties

type

type: object

name

Const Cluster

Cluster: object

serializedName

serializedName: string = "Cluster"

type

type: object

className

className: string = "Cluster"

name

modelProperties

name

element

element: object

type

type: object

className

className: string = "BatchAIError"

name

nodeSetup

nodeSetup: object

serializedName

serializedName: string = "properties.nodeSetup"

type

type: object

className

className: string = "NodeSetup"

name

nodeStateCounts

nodeStateCounts: object

readOnly

readOnly: boolean = true

serializedName

serializedName: string = "properties.nodeStateCounts"

type

type: object

className

className: string = "NodeStateCounts"

name

provisioningState

allowedValues

allowedValues: string[] = ["dedicated","lowpriority"]

name

vmSize

vmSize: object

serializedName

serializedName: string = "properties.vmSize"

type

type: object

name

Const ClusterCreateParameters

ClusterCreateParameters: object

serializedName

serializedName: string = "ClusterCreateParameters"

type

type: object

className

className: string = "ClusterCreateParameters"

name

modelProperties

className

className: string = "UserAccountSettings"

name

virtualMachineConfiguration

virtualMachineConfiguration: object

serializedName

serializedName: string = "properties.virtualMachineConfiguration"

type

type: object

className

className: string = "VirtualMachineConfiguration"

name

vmPriority

type

type: object

name

value

className

className: string = "ImageSourceRegistry"

name

shmSize

shmSize: object

serializedName

serializedName: string = "shmSize"

type

type: object

name

Const CustomMpiSettings

className

className: string = "EnvironmentVariable"

name

modelProperties

modelProperties: object

serializedName: string = "valueSecretReference"

type

type: object

className

className: string = "KeyVaultSecretReference"

name

Const Experiment

Experiment: object

serializedName

serializedName: string = "Experiment"

type

type: object

className

className: string = "Experiment"

name

modelProperties

modelProperties: object

creationTime

creationTime: object

readOnly

readOnly: boolean = true

serializedName

serializedName: string = "properties.creationTime"

type

type: object

name

provisioningState

type

type: object

name

value

value: object

readOnly

readOnly: boolean = true

serializedName

serializedName: string = ""

type

type: object

name

element

element: object

type

type: object

className

className: string = "Experiment"

type: object

className

className: string = "MountSettings"

name

provisioningState

className

className: string = "FileServerCreateParameters"

name

modelProperties

modelProperties: object

dataDisks

dataDisks: object

required

required: boolean = true

serializedName

serializedName: string = "properties.dataDisks"

type

type: object

className

className: string = "DataDisks"

name

sshConfiguration

type

type: object

className

className: string = "FileServerReference"

name

modelProperties

modelProperties: object

fileServer

fileServer: object

required

defaultValue

defaultValue: number = 1000

type

type: object

name

Const HorovodSettings

HorovodSettings: object

serializedName

serializedName: string = "HorovodSettings"

type

type: object

className

className: string = "HorovodSettings"

name

modelProperties

type

type: object

name

Const ImageReference

ImageReference: object

serializedName

serializedName: string = "ImageReference"

type

type: object

className

className: string = "ImageReference"

name

modelProperties

className

className: string = "ImageSourceRegistry"

name

modelProperties

modelProperties: object

credentials

credentials: object

serializedName

serializedName: string = "credentials"

type

type: object

className

className: string = "PrivateRegistryCredentials"

name

image

className

className: string = "InputDirectory"

name

modelProperties

name

environmentVariables

environmentVariables: object

serializedName

serializedName: string = "properties.environmentVariables"

type

type: object

name

jobPreparation

jobPreparation: object

serializedName

serializedName: string = "properties.jobPreparation"

type

type: object

className

className: string = "JobPreparation"

name

mountVolumes

className

className: string = "TensorFlowSettings"

name

toolType

toolType: object

serializedName

serializedName: string = "properties.toolType"

type

type: object

name

Const JobBasePropertiesConstraints

JobBasePropertiesConstraints: object

serializedName

serializedName: string = "JobBaseProperties_constraints"

type

type: object

className

className: string = "JobBasePropertiesConstraints"

name

modelProperties

type

type: object

className

className: string = "JobPreparation"

name

mountVolumes

mountVolumes: object

serializedName

serializedName: string = "properties.mountVolumes"

type

type: object

className

className: string = "MountVolumes"

name

nodeCount

className

className: string = "PyTorchSettings"

name

schedulingPriority

schedulingPriority: object

defaultValue

defaultValue: string = "normal"

serializedName

serializedName: string = "properties.schedulingPriority"

type

type: object

name

secrets

secrets: object

serializedName

serializedName: string = "properties.secrets"

type

type: object

modelProperties: object

nextLink

nextLink: object

readOnly

readOnly: boolean = true

serializedName

serializedName: string = "nextLink"

type

type: object

name

value

className

className: string = "JobPreparation"

name

modelProperties

type

type: object

name

Const JobPropertiesExecutionInfo

JobPropertiesExecutionInfo: object

serializedName

serializedName: string = "JobProperties_executionInfo"

type

type: object

className

className: string = "JobPropertiesExecutionInfo"

name

modelProperties

modelProperties: object

endTime

endTime: object

readOnly

readOnly: boolean = true

serializedName

serializedName: string = "endTime"

type

type: object

name

errors

errors: object

readOnly

readOnly: boolean = true

serializedName

serializedName: string = "errors"

type

type: object

JobsListByExperimentOptions: object

type

type: object

className

className: string = "JobsListByExperimentOptions"

name

modelProperties

className

className: string = "KeyVaultSecretReference"

name

modelProperties

modelProperties: object

secretUrl

secretUrl: object

required

required: boolean = true

serializedName

serializedName: string = "secretUrl"

type

type: object

name

sourceVault

type

type: object

name

value

className

className: string = "ManualScaleSettings"

name

modelProperties

modelProperties: object

nodeDeallocationOption

nodeDeallocationOption: object

defaultValue

defaultValue: string = "requeue"

serializedName

serializedName: string = "nodeDeallocationOption"

type

type: object

name

targetNodeCount

className

className: string = "MountVolumes"

name

modelProperties

className

className: string = "NameValuePair"

name

modelProperties

modelProperties: object

name

serializedName

serializedName: string = "name"

type

type: object

name

value

value: object

serializedName

serializedName: string = "value"

type

type: object

name

Const NodeSetup

NodeSetup: object

serializedName

serializedName: string = "NodeSetup"

type

type: object

className

className: string = "NodeSetup"

name

modelProperties

type

type: object

className

className: string = "OperationDisplay"

name

name

readOnly

readOnly: boolean = true

serializedName

serializedName: string = "name"

type

type: object

name

origin

className

className: string = "OperationDisplay"

name

modelProperties

type

type: object

name

value

className

className: string = "OutputDirectory"

name

modelProperties

modelProperties: object

id

id: object

required

required: boolean = true

serializedName

serializedName: string = "id"

type

type: object

name

pathPrefix

className

className: string = "PerformanceCountersSettings"

name

modelProperties

modelProperties: object

appInsightsReference

type

type: object

type

type: object

name

Const RemoteLoginInformation

RemoteLoginInformation: object

serializedName

serializedName: string = "RemoteLoginInformation"

type

type: object

className

className: string = "RemoteLoginInformation"

name

modelProperties

type

type: object

name

value

className

className: string = "Resource"

name

modelProperties

modelProperties: object

id

id: object

readOnly

readOnly: boolean = true

serializedName

serializedName: string = "id"

type

type: object

name

location

location: object

readOnly

readOnly: boolean = true

serializedName

serializedName: string = "location"

type

type: object

type: object

className

className: string = "ResourceId"

name

modelProperties

element: object

type

type: object

name

userAccountSettings

type

type: object

className

className: string = "UnmanagedFileSystemReference"

name

modelProperties

type

type: object

name

limit

limit: object

readOnly

readOnly: boolean = true

serializedName

serializedName: string = "limit"

type

type: object

adminUserSshPublicKey: object

serializedName

serializedName: string = "adminUserSshPublicKey"

type

type: object

name

Const VirtualMachineConfiguration

VirtualMachineConfiguration: object

serializedName

serializedName: string = "VirtualMachineConfiguration"

type

type: object

className

className: string = "VirtualMachineConfiguration"

name

modelProperties

type

type: object

name

provisioningState

type

type: object

name

serializedName

serializedName: string = "tags"

type

type: object

name

value

value: object

type

type: object

name

Const WorkspaceListResult

WorkspaceListResult: object

serializedName

serializedName: string = "WorkspaceListResult"

type

type: object

className

className: string = "WorkspaceListResult"

name

modelProperties

modelProperties: object

nextLink

nextLink: object

readOnly

readOnly: boolean = true

serializedName

serializedName: string = "nextLink"

type

type: object

name

value

className

className: string = "WorkspaceUpdateParameters"

name

modelProperties

className

className: string = "WorkspacesListByResourceGroupOptions"

name

modelProperties

modelProperties: object

maxResults

maxResults: object

defaultValue

defaultValue: number = 1000

type

type: object

name

Const WorkspacesListOptions

WorkspacesListOptions: object

type

type: object

className

className: string = "WorkspacesListOptions"

parameterPath: string = "clusterName"

mapper

mapper: object

required

MaxLength

MaxLength: number = 64

MinLength

MinLength: number = 1

Pattern

Pattern: RegExp = /^[-\w_]+$/

type

type: object

name

Const fileServerName

fileServerName: object

parameterPath

parameterPath: string = "fileServerName"

mapper

mapper: object

required

required: boolean = true

serializedName

serializedName: string = "fileServerName"

constraints

constraints: object

MaxLength

MaxLength: number = 64

MinLength

MinLength: number = 1

Pattern

Pattern: RegExp = /^[-\w_]+$/

type

type: object

name

Const jobName

jobName: object

parameterPath

parameterPath: string = "jobName"

mapper

mapper: object

required

required: boolean = true

serializedName

serializedName: string = "jobName"

constraints

constraints: object

MaxLength

MaxLength: number = 64

MinLength

MinLength: number = 1

Pattern

Pattern: RegExp = /^[-\w_]+$/

type

type: object

name

Const linkexpiryinminutes

linkexpiryinminutes: object

parameterPath

parameterPath: string[] = ["jobsListOutputFilesOptions","linkexpiryinminutes"]

mapper

mapper: object

defaultValue

defaultValue: number = 60

serializedName

serializedName: string = "linkexpiryinminutes"

constraints

constraints: object

InclusiveMaximum

InclusiveMaximum: number = 600

InclusiveMinimum

InclusiveMinimum: number = 5

type

type: object

name

Const location

location: object

parameterPath

parameterPath: string = "location"

mapper

mapper: object

required

required: boolean = true

serializedName

serializedName: string = "location"

constraints

constraints: object

Pattern

Pattern: RegExp = /^[-\w\._]+$/

type

type: object

name

Const maxResults0

maxResults0: object

parameterPath

parameterPath: string[] = ["options","workspacesListOptions","maxResults"]

mapper

mapper: object

defaultValue

defaultValue: number = 1000

serializedName

serializedName: string = "maxresults"

constraints

constraints: object

InclusiveMaximum

InclusiveMaximum: number = 1000

InclusiveMinimum

InclusiveMinimum: number = 1

type

type: object

name

Const maxResults1

maxResults1: object

parameterPath

parameterPath: string[] = ["options","workspacesListByResourceGroupOptions","maxResults"]

mapper

mapper: object

defaultValue

defaultValue: number = 1000

serializedName

serializedName: string = "maxresults"

constraints

constraints: object

InclusiveMaximum

InclusiveMaximum: number = 1000

InclusiveMinimum

InclusiveMinimum: number = 1

type

type: object

name

Const maxResults2

maxResults2: object

parameterPath

parameterPath: string[] = ["options","experimentsListByWorkspaceOptions","maxResults"]

mapper

mapper: object

defaultValue

defaultValue: number = 1000

serializedName

serializedName: string = "maxresults"

constraints

constraints: object

InclusiveMaximum

InclusiveMaximum: number = 1000

InclusiveMinimum

InclusiveMinimum: number = 1

type

type: object

name

Const maxResults3

maxResults3: object

parameterPath

parameterPath: string[] = ["options","jobsListByExperimentOptions","maxResults"]

mapper

mapper: object

defaultValue

defaultValue: number = 1000

serializedName

serializedName: string = "maxresults"

constraints

constraints: object

InclusiveMaximum

InclusiveMaximum: number = 1000

InclusiveMinimum

InclusiveMinimum: number = 1

type

type: object

name

Const maxResults4

maxResults4: object

parameterPath

parameterPath: string[] = ["jobsListOutputFilesOptions","maxResults"]

mapper

mapper: object

defaultValue

defaultValue: number = 1000

serializedName

serializedName: string = "maxresults"

constraints

constraints: object

InclusiveMaximum

InclusiveMaximum: number = 1000

InclusiveMinimum

InclusiveMinimum: number = 1

type

type: object

name

Const maxResults5

maxResults5: object

parameterPath

parameterPath: string[] = ["options","fileServersListByWorkspaceOptions","maxResults"]

mapper

mapper: object

defaultValue

defaultValue: number = 1000

serializedName

serializedName: string = "maxresults"

constraints

constraints: object

InclusiveMaximum

InclusiveMaximum: number = 1000

InclusiveMinimum

InclusiveMinimum: number = 1

type

type: object

name

Const maxResults6

maxResults6: object

parameterPath

parameterPath: string[] = ["options","clustersListByWorkspaceOptions","maxResults"]

mapper

mapper: object

defaultValue

defaultValue: number = 1000

serializedName

serializedName: string = "maxresults"

constraints

constraints: object

InclusiveMaximum

InclusiveMaximum: number = 1000

InclusiveMinimum

InclusiveMinimum: number = 1

type

type: object

name

Const nextPageLink

Pattern

Pattern: RegExp = /^[-\w\._]+$/

type

type: object

name

Const subscriptionId

subscriptionId: object

parameterPath

parameterPath: string = "subscriptionId"

mapper

mapper: object

required

required: boolean = true

serializedName

serializedName: string = "subscriptionId"

type

type: object

name

Const workspaceName

workspaceName: object

parameterPath

parameterPath: string = "workspaceName"

mapper

mapper: object

required

required: boolean = true

serializedName

serializedName: string = "workspaceName"

constraints

constraints: object

MaxLength

MaxLength: number = 64

MinLength

MinLength: number = 1

Pattern

Pattern: RegExp = /^[-\w_]+$/

type

type: object

name