Microsoft.MachineLearningServices workspaces/labelingJobs 2022-10-01-preview

Article
12/09/2024

Bicep resource definition

The workspaces/labelingJobs 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/labelingJobs resource, add the following Bicep to your template.

resource symbolicname 'Microsoft.MachineLearningServices/workspaces/labelingJobs@2022-10-01-preview' = {
  parent: resourceSymbolicName
  name: 'string'
  properties: {
    componentId: 'string'
    computeId: 'string'
    dataConfiguration: {
      dataId: 'string'
      incrementalDataRefreshEnabled: bool
    }
    description: 'string'
    displayName: 'string'
    experimentName: 'string'
    identity: {
      identityType: 'string'
      // For remaining properties, see IdentityConfiguration objects
    }
    isArchived: bool
    jobInstructions: {
      uri: 'string'
    }
    jobType: 'string'
    labelCategories: {
      {customized property}: {
        classes: {
          {customized property}: {
            displayName: 'string'
            subclasses: {
              {customized property}: ...
            }
          }
        }
        displayName: 'string'
        multiSelectEnabled: bool
      }
    }
    labelingJobMediaProperties: {
      mediaType: 'string'
      // For remaining properties, see LabelingJobMediaProperties objects
    }
    mlAssistConfiguration: {
      mlAssist: 'string'
      // For remaining properties, see MLAssistConfiguration objects
    }
    properties: {
      {customized property}: 'string'
    }
    services: {
      {customized property}: {
        endpoint: 'string'
        jobServiceType: 'string'
        nodes: {
          nodesValueType: 'string'
          // For remaining properties, see Nodes objects
        }
        port: int
        properties: {
          {customized property}: 'string'
        }
      }
    }
    tags: {
      {customized property}: 'string'
    }
  }
}

LabelingJobMediaProperties objects

Set the mediaType property to specify the type of object.

For Image, use:

{
  annotationType: 'string'
  mediaType: 'Image'
}

For Text, use:

{
  annotationType: 'string'
  mediaType: 'Text'
}

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'
}

MLAssistConfiguration objects

Set the mlAssist property to specify the type of object.

For Disabled, use:

{
  mlAssist: 'Disabled'
}

For Enabled, use:

{
  inferencingComputeBinding: 'string'
  mlAssist: 'Enabled'
  trainingComputeBinding: 'string'
}

Nodes objects

Set the nodesValueType property to specify the type of object.

For All, use:

{
  nodesValueType: 'All'
}

Property values

AllNodes

Name	Description	Value
nodesValueType	[Required] Type of the Nodes value	'All' (required)

AmlToken

Name	Description	Value
identityType	[Required] Specifies the type of identity framework.	'AMLToken' (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)

JobBaseServices

Name	Description	Value

JobService

Name	Description	Value
endpoint	Url for endpoint.	string
jobServiceType	Endpoint type.	string
nodes	Nodes that user would like to start the service on. If Nodes is not set or set to null, the service will only be started on leader node.	Nodes
port	Port for endpoint set by user.	int
properties	Additional properties to set on the endpoint.	JobServiceProperties

JobServiceProperties

Name	Description	Value

LabelCategory

Name	Description	Value
classes	Dictionary of label classes in this category.	LabelCategoryClasses
displayName	Display name of the label category.	string
multiSelectEnabled	Indicates whether it is allowed to select multiple classes in this category.	bool

LabelCategoryClasses

Name	Description	Value

LabelClass

Name	Description	Value
displayName	Display name of the label class.	string
subclasses	Dictionary of subclasses of the label class.	LabelClassSubclasses

LabelClassSubclasses

Name	Description	Value

LabelingDataConfiguration

Name	Description	Value
dataId	Resource Id of the data asset to perform labeling.	string
incrementalDataRefreshEnabled	Indicates whether to enable incremental data refresh.	bool

LabelingJobImageProperties

Name	Description	Value
annotationType	Annotation type of image labeling job.	'BoundingBox' 'Classification' 'InstanceSegmentation'
mediaType	[Required] Media type of the job.	'Image' (required)

LabelingJobInstructions

Name	Description	Value
uri	The link to a page with detailed labeling instructions for labelers.	string

LabelingJobLabelCategories

Name	Description	Value

LabelingJobMediaProperties

Name	Description	Value
mediaType	Set to 'Image' for type LabelingJobImageProperties. Set to 'Text' for type LabelingJobTextProperties.	'Image' 'Text' (required)

LabelingJobProperties

Name	Description	Value
componentId	ARM resource ID of the component resource.	string
computeId	ARM resource ID of the compute resource.	string
dataConfiguration	Configuration of data used in the job.	LabelingDataConfiguration
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
jobInstructions	Labeling instructions of the job.	LabelingJobInstructions
jobType	[Required] Specifies the type of job.	'AutoML' 'Command' 'Labeling' 'Pipeline' 'Spark' 'Sweep' (required)
labelCategories	Label categories of the job.	LabelingJobLabelCategories
labelingJobMediaProperties	Media type specific properties in the job.	LabelingJobMediaProperties
mlAssistConfiguration	Configuration of MLAssist feature in the job.	MLAssistConfiguration
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

LabelingJobTextProperties

Name	Description	Value
annotationType	Annotation type of text labeling job.	'Classification' 'NamedEntityRecognition'
mediaType	[Required] Media type of the job.	'Text' (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