Microsoft.MachineLearningServices workspaces/labelingJobs 2021-03-01-preview

• Latest
• 2024-04-01-preview
• 2024-01-01-preview
• 2023-08-01-preview
• 2023-06-01-preview
• 2023-04-01-preview
• 2023-02-01-preview
• 2022-12-01-preview
• 2022-10-01-preview
• 2022-06-01-preview
• 2021-03-01-preview
• 2020-09-01-preview

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@2021-03-01-preview' = {
  name: 'string'
  properties: {
    datasetConfiguration: {
      assetName: 'string'
      datasetVersion: 'string'
      incrementalDatasetRefreshEnabled: bool
    }
    description: 'string'
    jobInstructions: {
      uri: 'string'
    }
    jobType: 'string'
    labelCategories: {
      {customized property}: {
        allowMultiSelect: bool
        classes: {
          {customized property}: {
            displayName: 'string'
            subclasses: {
              {customized property}: ...
            }
          }
        }
        displayName: 'string'
      }
    }
    labelingJobMediaProperties: {
      mediaType: 'string'
      // For remaining properties, see LabelingJobMediaProperties objects
    }
    mlAssistConfiguration: {
      inferencingComputeBinding: {
        instanceCount: int
        instanceType: 'string'
        isLocal: bool
        location: 'string'
        properties: {
          {customized property}: 'string'
        }
        target: 'string'
      }
      mlAssistEnabled: bool
      trainingComputeBinding: {
        instanceCount: int
        instanceType: 'string'
        isLocal: bool
        location: 'string'
        properties: {
          {customized property}: 'string'
        }
        target: 'string'
      }
    }
    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'
}

Property values

ComputeConfiguration

Name	Description	Value
instanceCount	Number of instances or nodes.	int
instanceType	SKU type to run on.	string
isLocal	Set to true for jobs running on local compute.	bool
location	Location for virtual cluster run.	string
properties	Additional properties.	ComputeConfigurationProperties
target	ARM resource ID of the Compute you are targeting. If not provided the resource will be deployed as Managed.	string

ComputeConfigurationProperties

Name	Description	Value

LabelCategory

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

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

LabelingDatasetConfiguration

Name	Description	Value
assetName	Name of the data asset to perform labeling.	string
datasetVersion	AML dataset version.	string
incrementalDatasetRefreshEnabled	Indicates whether to enable incremental dataset refresh.	bool

LabelingJob

Name	Description	Value
datasetConfiguration	Configuration of dataset used in the job.	LabelingDatasetConfiguration
description	The asset description text.	string
jobInstructions	Labeling instructions of the job.	LabelingJobInstructions
jobType	[Required] Specifies the type of job. This field should always be set to "Labeling".	'Command' 'Labeling' '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.	LabelingJobProperties
tags	Tag dictionary. Tags can be added, removed, and updated.	LabelingJobTags

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

LabelingJobTags

Name	Description	Value

LabelingJobTextProperties

Name	Description	Value
annotationType	Annotation type of text labeling job.	'Classification'
mediaType	[Required] Media type of the job.	'Text' (required)

Microsoft.MachineLearningServices/workspaces/labelingJobs

Name	Description	Value
name	The resource name	string Constraints: Pattern = ^[a-zA-Z0-9][a-zA-Z0-9\-_]{0,254}$ (required)
parent	In Bicep, you can specify the parent resource for a child resource. You only need to add this property when the child resource is declared outside of the parent resource. For more information, see Child resource outside parent resource.	Symbolic name for resource of type: workspaces
properties	[Required] Additional attributes of the entity.	LabelingJob (required)

MLAssistConfiguration

Name	Description	Value
inferencingComputeBinding	AML compute binding used in inferencing.	ComputeConfiguration
mlAssistEnabled	Indicates whether MLAssist feature is enabled.	bool
trainingComputeBinding	AML compute binding used in training.	ComputeConfiguration

ARM template 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 JSON to your template.

{
  "type": "Microsoft.MachineLearningServices/workspaces/labelingJobs",
  "apiVersion": "2021-03-01-preview",
  "name": "string",
  "properties": {
    "datasetConfiguration": {
      "assetName": "string",
      "datasetVersion": "string",
      "incrementalDatasetRefreshEnabled": "bool"
    },
    "description": "string",
    "jobInstructions": {
      "uri": "string"
    },
    "jobType": "string",
    "labelCategories": {
      "{customized property}": {
        "allowMultiSelect": "bool",
        "classes": {
          "{customized property}": {
            "displayName": "string",
            "subclasses": {
              "{customized property}": ...
            }
          }
        },
        "displayName": "string"
      }
    },
    "labelingJobMediaProperties": {
      "mediaType": "string"
      // For remaining properties, see LabelingJobMediaProperties objects
    },
    "mlAssistConfiguration": {
      "inferencingComputeBinding": {
        "instanceCount": "int",
        "instanceType": "string",
        "isLocal": "bool",
        "location": "string",
        "properties": {
          "{customized property}": "string"
        },
        "target": "string"
      },
      "mlAssistEnabled": "bool",
      "trainingComputeBinding": {
        "instanceCount": "int",
        "instanceType": "string",
        "isLocal": "bool",
        "location": "string",
        "properties": {
          "{customized property}": "string"
        },
        "target": "string"
      }
    },
    "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"
}

Property values

ComputeConfiguration

Name	Description	Value
instanceCount	Number of instances or nodes.	int
instanceType	SKU type to run on.	string
isLocal	Set to true for jobs running on local compute.	bool
location	Location for virtual cluster run.	string
properties	Additional properties.	ComputeConfigurationProperties
target	ARM resource ID of the Compute you are targeting. If not provided the resource will be deployed as Managed.	string

ComputeConfigurationProperties

Name	Description	Value

LabelCategory

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

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

LabelingDatasetConfiguration

Name	Description	Value
assetName	Name of the data asset to perform labeling.	string
datasetVersion	AML dataset version.	string
incrementalDatasetRefreshEnabled	Indicates whether to enable incremental dataset refresh.	bool

LabelingJob

Name	Description	Value
datasetConfiguration	Configuration of dataset used in the job.	LabelingDatasetConfiguration
description	The asset description text.	string
jobInstructions	Labeling instructions of the job.	LabelingJobInstructions
jobType	[Required] Specifies the type of job. This field should always be set to "Labeling".	'Command' 'Labeling' '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.	LabelingJobProperties
tags	Tag dictionary. Tags can be added, removed, and updated.	LabelingJobTags

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

LabelingJobTags

Name	Description	Value

LabelingJobTextProperties

Name	Description	Value
annotationType	Annotation type of text labeling job.	'Classification'
mediaType	[Required] Media type of the job.	'Text' (required)

Microsoft.MachineLearningServices/workspaces/labelingJobs

Name	Description	Value
apiVersion	The api version	'2021-03-01-preview'
name	The resource name	string Constraints: Pattern = ^[a-zA-Z0-9][a-zA-Z0-9\-_]{0,254}$ (required)
properties	[Required] Additional attributes of the entity.	LabelingJob (required)
type	The resource type	'Microsoft.MachineLearningServices/workspaces/labelingJobs'

MLAssistConfiguration

Name	Description	Value
inferencingComputeBinding	AML compute binding used in inferencing.	ComputeConfiguration
mlAssistEnabled	Indicates whether MLAssist feature is enabled.	bool
trainingComputeBinding	AML compute binding used in training.	ComputeConfiguration

Terraform (AzAPI provider) resource definition

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

• Resource groups

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 Terraform to your template.

resource "azapi_resource" "symbolicname" {
  type = "Microsoft.MachineLearningServices/workspaces/labelingJobs@2021-03-01-preview"
  name = "string"
  body = jsonencode({
    properties = {
      datasetConfiguration = {
        assetName = "string"
        datasetVersion = "string"
        incrementalDatasetRefreshEnabled = bool
      }
      description = "string"
      jobInstructions = {
        uri = "string"
      }
      jobType = "string"
      labelCategories = {
        {customized property} = {
          allowMultiSelect = bool
          classes = {
            {customized property} = {
              displayName = "string"
              subclasses = {
                {customized property} = ...
              }
            }
          }
          displayName = "string"
        }
      }
      labelingJobMediaProperties = {
        mediaType = "string"
        // For remaining properties, see LabelingJobMediaProperties objects
      }
      mlAssistConfiguration = {
        inferencingComputeBinding = {
          instanceCount = int
          instanceType = "string"
          isLocal = bool
          location = "string"
          properties = {
            {customized property} = "string"
          }
          target = "string"
        }
        mlAssistEnabled = bool
        trainingComputeBinding = {
          instanceCount = int
          instanceType = "string"
          isLocal = bool
          location = "string"
          properties = {
            {customized property} = "string"
          }
          target = "string"
        }
      }
      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"
}

Property values

ComputeConfiguration

Name	Description	Value
instanceCount	Number of instances or nodes.	int
instanceType	SKU type to run on.	string
isLocal	Set to true for jobs running on local compute.	bool
location	Location for virtual cluster run.	string
properties	Additional properties.	ComputeConfigurationProperties
target	ARM resource ID of the Compute you are targeting. If not provided the resource will be deployed as Managed.	string

ComputeConfigurationProperties

Name	Description	Value

LabelCategory

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

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

LabelingDatasetConfiguration

Name	Description	Value
assetName	Name of the data asset to perform labeling.	string
datasetVersion	AML dataset version.	string
incrementalDatasetRefreshEnabled	Indicates whether to enable incremental dataset refresh.	bool

LabelingJob

Name	Description	Value
datasetConfiguration	Configuration of dataset used in the job.	LabelingDatasetConfiguration
description	The asset description text.	string
jobInstructions	Labeling instructions of the job.	LabelingJobInstructions
jobType	[Required] Specifies the type of job. This field should always be set to "Labeling".	'Command' 'Labeling' '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.	LabelingJobProperties
tags	Tag dictionary. Tags can be added, removed, and updated.	LabelingJobTags

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

LabelingJobTags

Name	Description	Value

LabelingJobTextProperties

Name	Description	Value
annotationType	Annotation type of text labeling job.	'Classification'
mediaType	[Required] Media type of the job.	'Text' (required)

Microsoft.MachineLearningServices/workspaces/labelingJobs

Name	Description	Value
name	The resource name	string Constraints: Pattern = ^[a-zA-Z0-9][a-zA-Z0-9\-_]{0,254}$ (required)
parent_id	The ID of the resource that is the parent for this resource.	ID for resource of type: workspaces
properties	[Required] Additional attributes of the entity.	LabelingJob (required)
type	The resource type	"Microsoft.MachineLearningServices/workspaces/labelingJobs@2021-03-01-preview"

MLAssistConfiguration

Name	Description	Value
inferencingComputeBinding	AML compute binding used in inferencing.	ComputeConfiguration
mlAssistEnabled	Indicates whether MLAssist feature is enabled.	bool
trainingComputeBinding	AML compute binding used in training.	ComputeConfiguration