Microsoft.MachineLearningServices workspaces/jobs 2022-05-01

Article
12/09/2024

Bicep resource definition

The workspaces/jobs resource type can be deployed with operations that target:

Resource groups - See resource group deployment commands

For a list of changed properties in each API version, see change log.

Resource format

To create a Microsoft.MachineLearningServices/workspaces/jobs resource, add the following Bicep to your template.

resource symbolicname 'Microsoft.MachineLearningServices/workspaces/jobs@2022-05-01' = {
  parent: resourceSymbolicName
  name: 'string'
  properties: {
    computeId: 'string'
    description: 'string'
    displayName: 'string'
    experimentName: 'string'
    identity: {
      identityType: 'string'
      // For remaining properties, see IdentityConfiguration objects
    }
    isArchived: bool
    properties: {
      {customized property}: 'string'
    }
    services: {
      {customized property}: {
        endpoint: 'string'
        jobServiceType: 'string'
        port: int
        properties: {
          {customized property}: 'string'
        }
      }
    }
    tags: {
      {customized property}: 'string'
    }
    jobType: 'string'
    // For remaining properties, see JobBaseProperties objects
  }
}

JobBaseProperties objects

Set the jobType property to specify the type of object.

For Command, use:

{
  codeId: 'string'
  command: 'string'
  distribution: {
    distributionType: 'string'
    // For remaining properties, see DistributionConfiguration objects
  }
  environmentId: 'string'
  environmentVariables: {
    {customized property}: 'string'
  }
  inputs: {
    {customized property}: {
      description: 'string'
      jobInputType: 'string'
      // For remaining properties, see JobInput objects
    }
  }
  jobType: 'Command'
  limits: {
    jobLimitsType: 'string'
    timeout: 'string'
  }
  outputs: {
    {customized property}: {
      description: 'string'
      jobOutputType: 'string'
      // For remaining properties, see JobOutput objects
    }
  }
  resources: {
    instanceCount: int
    instanceType: 'string'
    properties: {
      {customized property}: any(Azure.Bicep.Types.Concrete.AnyType)
    }
  }
}

For Pipeline, use:

{
  inputs: {
    {customized property}: {
      description: 'string'
      jobInputType: 'string'
      // For remaining properties, see JobInput objects
    }
  }
  jobs: {
    {customized property}: any(Azure.Bicep.Types.Concrete.AnyType)
  }
  jobType: 'Pipeline'
  outputs: {
    {customized property}: {
      description: 'string'
      jobOutputType: 'string'
      // For remaining properties, see JobOutput objects
    }
  }
  settings: any(Azure.Bicep.Types.Concrete.AnyType)
}

For Sweep, use:

{
  earlyTermination: {
    delayEvaluation: int
    evaluationInterval: int
    policyType: 'string'
    // For remaining properties, see EarlyTerminationPolicy objects
  }
  inputs: {
    {customized property}: {
      description: 'string'
      jobInputType: 'string'
      // For remaining properties, see JobInput objects
    }
  }
  jobType: 'Sweep'
  limits: {
    jobLimitsType: 'string'
    maxConcurrentTrials: int
    maxTotalTrials: int
    timeout: 'string'
    trialTimeout: 'string'
  }
  objective: {
    goal: 'string'
    primaryMetric: 'string'
  }
  outputs: {
    {customized property}: {
      description: 'string'
      jobOutputType: 'string'
      // For remaining properties, see JobOutput objects
    }
  }
  samplingAlgorithm: {
    samplingAlgorithmType: 'string'
    // For remaining properties, see SamplingAlgorithm objects
  }
  searchSpace: any(Azure.Bicep.Types.Concrete.AnyType)
  trial: {
    codeId: 'string'
    command: 'string'
    distribution: {
      distributionType: 'string'
      // For remaining properties, see DistributionConfiguration objects
    }
    environmentId: 'string'
    environmentVariables: {
      {customized property}: 'string'
    }
    resources: {
      instanceCount: int
      instanceType: 'string'
      properties: {
        {customized property}: any(Azure.Bicep.Types.Concrete.AnyType)
      }
    }
  }
}

IdentityConfiguration objects

Set the identityType property to specify the type of object.

For AMLToken, use:

{
  identityType: 'AMLToken'
}

For Managed, use:

{
  clientId: 'string'
  identityType: 'Managed'
  objectId: 'string'
  resourceId: 'string'
}

For UserIdentity, use:

{
  identityType: 'UserIdentity'
}

DistributionConfiguration objects

Set the distributionType property to specify the type of object.

For Mpi, use:

{
  distributionType: 'Mpi'
  processCountPerInstance: int
}

For PyTorch, use:

{
  distributionType: 'PyTorch'
  processCountPerInstance: int
}

For TensorFlow, use:

{
  distributionType: 'TensorFlow'
  parameterServerCount: int
  workerCount: int
}

EarlyTerminationPolicy objects

Set the policyType property to specify the type of object.

For Bandit, use:

{
  policyType: 'Bandit'
  slackAmount: int
  slackFactor: int
}

For MedianStopping, use:

{
  policyType: 'MedianStopping'
}

For TruncationSelection, use:

{
  policyType: 'TruncationSelection'
  truncationPercentage: int
}

JobInput objects

Set the jobInputType property to specify the type of object.

For custom_model, use:

{
  jobInputType: 'custom_model'
  mode: 'string'
  uri: 'string'
}

For literal, use:

{
  jobInputType: 'literal'
  value: 'string'
}

For mlflow_model, use:

{
  jobInputType: 'mlflow_model'
  mode: 'string'
  uri: 'string'
}

For mltable, use:

{
  jobInputType: 'mltable'
  mode: 'string'
  uri: 'string'
}

For triton_model, use:

{
  jobInputType: 'triton_model'
  mode: 'string'
  uri: 'string'
}

For uri_file, use:

{
  jobInputType: 'uri_file'
  mode: 'string'
  uri: 'string'
}

For uri_folder, use:

{
  jobInputType: 'uri_folder'
  mode: 'string'
  uri: 'string'
}

JobOutput objects

Set the jobOutputType property to specify the type of object.

For custom_model, use:

{
  jobOutputType: 'custom_model'
  mode: 'string'
  uri: 'string'
}

For mlflow_model, use:

{
  jobOutputType: 'mlflow_model'
  mode: 'string'
  uri: 'string'
}

For mltable, use:

{
  jobOutputType: 'mltable'
  mode: 'string'
  uri: 'string'
}

For triton_model, use:

{
  jobOutputType: 'triton_model'
  mode: 'string'
  uri: 'string'
}

For uri_file, use:

{
  jobOutputType: 'uri_file'
  mode: 'string'
  uri: 'string'
}

For uri_folder, use:

{
  jobOutputType: 'uri_folder'
  mode: 'string'
  uri: 'string'
}

SamplingAlgorithm objects

Set the samplingAlgorithmType property to specify the type of object.

For Bayesian, use:

{
  samplingAlgorithmType: 'Bayesian'
}

For Grid, use:

{
  samplingAlgorithmType: 'Grid'
}

For Random, use:

{
  rule: 'string'
  samplingAlgorithmType: 'Random'
  seed: int
}

Property values

AmlToken

Name	Description	Value
identityType	[Required] Specifies the type of identity framework.	'AMLToken' (required)

BanditPolicy

Name	Description	Value
policyType	[Required] Name of policy configuration	'Bandit' (required)
slackAmount	Absolute distance allowed from the best performing run.	int
slackFactor	Ratio of the allowed distance from the best performing run.	int

BayesianSamplingAlgorithm

Name	Description	Value
samplingAlgorithmType	[Required] The algorithm used for generating hyperparameter values, along with configuration properties	'Bayesian' (required)

CommandJob

Name	Description	Value
codeId	ARM resource ID of the code asset.	string
command	[Required] The command to execute on startup of the job. eg. "python train.py"	string Constraints: Min length = 1 Pattern = `[a-zA-Z0-9_]` (required)
distribution	Distribution configuration of the job. If set, this should be one of Mpi, Tensorflow, PyTorch, or null.	DistributionConfiguration
environmentId	[Required] The ARM resource ID of the Environment specification for the job.	string Constraints: Pattern = `[a-zA-Z0-9_]` (required)
environmentVariables	Environment variables included in the job.	CommandJobEnvironmentVariables
inputs	Mapping of input data bindings used in the job.	CommandJobInputs
jobType	[Required] Specifies the type of job.	'Command' (required)
limits	Command Job limit.	CommandJobLimits
outputs	Mapping of output data bindings used in the job.	CommandJobOutputs
resources	Compute Resource configuration for the job.	ResourceConfiguration

CommandJobEnvironmentVariables

Name	Description	Value

CommandJobInputs

Name	Description	Value

CommandJobLimits

Name	Description	Value
jobLimitsType	[Required] JobLimit type.	'Command' 'Sweep' (required)
timeout	The max run duration in ISO 8601 format, after which the job will be cancelled. Only supports duration with precision as low as Seconds.	string

CommandJobOutputs

Name	Description	Value

CustomModelJobInput

Name	Description	Value
jobInputType	[Required] Specifies the type of job.	'custom_model' (required)
mode	Input Asset Delivery Mode.	'Direct' 'Download' 'EvalDownload' 'EvalMount' 'ReadOnlyMount' 'ReadWriteMount'
uri	[Required] Input Asset URI.	string Constraints: Pattern = `[a-zA-Z0-9_]` (required)

CustomModelJobOutput

Name	Description	Value
jobOutputType	[Required] Specifies the type of job.	'custom_model' (required)
mode	Output Asset Delivery Mode.	'ReadWriteMount' 'Upload'
uri	Output Asset URI.	string

DistributionConfiguration

Name	Description	Value
distributionType	Set to 'Mpi' for type Mpi. Set to 'PyTorch' for type PyTorch. Set to 'TensorFlow' for type TensorFlow.	'Mpi' 'PyTorch' 'TensorFlow' (required)

EarlyTerminationPolicy

Name	Description	Value
delayEvaluation	Number of intervals by which to delay the first evaluation.	int
evaluationInterval	Interval (number of runs) between policy evaluations.	int
policyType	Set to 'Bandit' for type BanditPolicy. Set to 'MedianStopping' for type MedianStoppingPolicy. Set to 'TruncationSelection' for type TruncationSelectionPolicy.	'Bandit' 'MedianStopping' 'TruncationSelection' (required)

GridSamplingAlgorithm

Name	Description	Value
samplingAlgorithmType	[Required] The algorithm used for generating hyperparameter values, along with configuration properties	'Grid' (required)

IdentityConfiguration

Name	Description	Value
identityType	Set to 'AMLToken' for type AmlToken. Set to 'Managed' for type ManagedIdentity. Set to 'UserIdentity' for type UserIdentity.	'AMLToken' 'Managed' 'UserIdentity' (required)

JobBaseProperties

Name	Description	Value
computeId	ARM resource ID of the compute resource.	string
description	The asset description text.	string
displayName	Display name of job.	string
experimentName	The name of the experiment the job belongs to. If not set, the job is placed in the "Default" experiment.	string
identity	Identity configuration. If set, this should be one of AmlToken, ManagedIdentity, UserIdentity or null. Defaults to AmlToken if null.	IdentityConfiguration
isArchived	Is the asset archived?	bool
jobType	Set to 'Command' for type CommandJob. Set to 'Pipeline' for type PipelineJob. Set to 'Sweep' for type SweepJob.	'Command' 'Pipeline' 'Sweep' (required)
properties	The asset property dictionary.	ResourceBaseProperties
services	List of JobEndpoints. For local jobs, a job endpoint will have an endpoint value of FileStreamObject.	JobBaseServices
tags	Tag dictionary. Tags can be added, removed, and updated.	ResourceBaseTags

JobBaseServices

Name	Description	Value

JobInput

Name	Description	Value
description	Description for the input.	string
jobInputType	Set to 'custom_model' for type CustomModelJobInput. Set to 'literal' for type LiteralJobInput. Set to 'mlflow_model' for type MLFlowModelJobInput. Set to 'mltable' for type MLTableJobInput. Set to 'triton_model' for type TritonModelJobInput. Set to 'uri_file' for type UriFileJobInput. Set to 'uri_folder' for type UriFolderJobInput.	'custom_model' 'literal' 'mlflow_model' 'mltable' 'triton_model' 'uri_file' 'uri_folder' (required)

JobOutput

Name	Description	Value
description	Description for the output.	string
jobOutputType	Set to 'custom_model' for type CustomModelJobOutput. Set to 'mlflow_model' for type MLFlowModelJobOutput. Set to 'mltable' for type MLTableJobOutput. Set to 'triton_model' for type TritonModelJobOutput. Set to 'uri_file' for type UriFileJobOutput. Set to 'uri_folder' for type UriFolderJobOutput.	'custom_model' 'mlflow_model' 'mltable' 'triton_model' 'uri_file' 'uri_folder' (required)

JobService

Name	Description	Value
endpoint	Url for endpoint.	string
jobServiceType	Endpoint type.	string
port	Port for endpoint.	int
properties	Additional properties to set on the endpoint.	JobServiceProperties

JobServiceProperties

Name	Description	Value

LiteralJobInput

Name	Description	Value
jobInputType	[Required] Specifies the type of job.	'literal' (required)
value	[Required] Literal value for the input.	string Constraints: Pattern = `[a-zA-Z0-9_]` (required)

ManagedIdentity

Name	Description	Value
clientId	Specifies a user-assigned identity by client ID. For system-assigned, do not set this field.	string Constraints: Min length = 36 Max length = 36 Pattern = `^[0-9a-fA-F]{8}-([0-9a-fA-F]{4}-){3}[0-9a-fA-F]{12}$`
identityType	[Required] Specifies the type of identity framework.	'Managed' (required)
objectId	Specifies a user-assigned identity by object ID. For system-assigned, do not set this field.	string Constraints: Min length = 36 Max length = 36 Pattern = `^[0-9a-fA-F]{8}-([0-9a-fA-F]{4}-){3}[0-9a-fA-F]{12}$`
resourceId	Specifies a user-assigned identity by ARM resource ID. For system-assigned, do not set this field.	string

MedianStoppingPolicy

Name	Description	Value
policyType	[Required] Name of policy configuration	'MedianStopping' (required)