Microsoft.MachineLearningServices workspaces/labelingJobs 2021-03-01-preview
Article
01/12/2024
1 contributor
Feedback
In this article
Bicep resource definition
The workspaces/labelingJobs resource type can be deployed with operations that target:
For a list of changed properties in each API version, see change log .
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'
parent: resourceSymbolicName
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'
}
}
}
Set the mediaType property to specify the type of object.
For Image , use:
mediaType: 'Image'
annotationType: 'string'
For Text , use:
mediaType: 'Text'
annotationType: 'Classification'
Property values
workspaces/labelingJobs
Name
Description
Value
name
The resource name See how to set names and types for child resources in Bicep .
string (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)
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.
object
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
LabelingJobInstructions
Name
Description
Value
uri
The link to a page with detailed labeling instructions for labelers.
string
LabelingJobLabelCategories
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
{customized property}
LabelClass
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
{customized property}
LabelClass
Name
Description
Value
mediaType
Set the object type
Image Text (required)
LabelingJobImageProperties
Name
Description
Value
mediaType
[Required] Media type of the job.
'Image' (required)
annotationType
Annotation type of image labeling job.
'BoundingBox' 'Classification' 'InstanceSegmentation'
LabelingJobTextProperties
Name
Description
Value
mediaType
[Required] Media type of the job.
'Text' (required)
annotationType
Annotation type of text labeling job.
'Classification'
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
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
{customized property}
string
LabelingJobProperties
Name
Description
Value
{customized property}
string
ARM template resource definition
The workspaces/labelingJobs resource type can be deployed with operations that target:
For a list of changed properties in each API version, see change log .
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"
}
}
}
Set the mediaType property to specify the type of object.
For Image , use:
"mediaType": "Image",
"annotationType": "string"
For Text , use:
"mediaType": "Text",
"annotationType": "Classification"
Property values
workspaces/labelingJobs
Name
Description
Value
type
The resource type
'Microsoft.MachineLearningServices/workspaces/labelingJobs'
apiVersion
The resource api version
'2021-03-01-preview'
name
The resource name See how to set names and types for child resources in JSON ARM templates .
string (required)
properties
[Required] Additional attributes of the entity.
LabelingJob (required)
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.
object
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
LabelingJobInstructions
Name
Description
Value
uri
The link to a page with detailed labeling instructions for labelers.
string
LabelingJobLabelCategories
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
{customized property}
LabelClass
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
{customized property}
LabelClass
Name
Description
Value
mediaType
Set the object type
Image Text (required)
LabelingJobImageProperties
Name
Description
Value
mediaType
[Required] Media type of the job.
'Image' (required)
annotationType
Annotation type of image labeling job.
'BoundingBox' 'Classification' 'InstanceSegmentation'
LabelingJobTextProperties
Name
Description
Value
mediaType
[Required] Media type of the job.
'Text' (required)
annotationType
Annotation type of text labeling job.
'Classification'
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
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
{customized property}
string
LabelingJobProperties
Name
Description
Value
{customized property}
string
The workspaces/labelingJobs resource type can be deployed with operations that target:
For a list of changed properties in each API version, see change log .
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"
parent_id = "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"
}
}
})
}
Set the mediaType property to specify the type of object.
For Image , use:
mediaType = "Image"
annotationType = "string"
For Text , use:
mediaType = "Text"
annotationType = "Classification"
Property values
workspaces/labelingJobs
Name
Description
Value
type
The resource type
"Microsoft.MachineLearningServices/workspaces/labelingJobs@2021-03-01-preview"
name
The resource name
string (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)
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.
object
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
LabelingJobInstructions
Name
Description
Value
uri
The link to a page with detailed labeling instructions for labelers.
string
LabelingJobLabelCategories
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
{customized property}
LabelClass
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
{customized property}
LabelClass
Name
Description
Value
mediaType
Set the object type
Image Text (required)
LabelingJobImageProperties
Name
Description
Value
mediaType
[Required] Media type of the job.
"Image" (required)
annotationType
Annotation type of image labeling job.
"BoundingBox" "Classification" "InstanceSegmentation"
LabelingJobTextProperties
Name
Description
Value
mediaType
[Required] Media type of the job.
"Text" (required)
annotationType
Annotation type of text labeling job.
"Classification"
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
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
{customized property}
string
LabelingJobProperties
Name
Description
Value
{customized property}
string