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' = {
parent: resourceSymbolicName
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:
{
annotationType: 'string'
mediaType: 'Image'
}
For Text, use:
{
annotationType: 'string'
mediaType: 'Text'
}
Property Values
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) |
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
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
LabelClass
| Name |
Description |
Value |
| displayName |
Display name of the label class. |
string |
| subclasses |
Dictionary of subclasses of the label class. |
LabelClassSubclasses |
LabelClassSubclasses
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
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
LabelingJobProperties
LabelingJobTextProperties
| Name |
Description |
Value |
| annotationType |
Annotation type of text labeling job. |
'Classification' |
| mediaType |
[Required] Media type of the job. |
'Text' (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:
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:
{
"annotationType": "string",
"mediaType": "Image"
}
For Text, use:
{
"annotationType": "string",
"mediaType": "Text"
}
Property Values
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' |
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
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
LabelClass
| Name |
Description |
Value |
| displayName |
Display name of the label class. |
string |
| subclasses |
Dictionary of subclasses of the label class. |
LabelClassSubclasses |
LabelClassSubclasses
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
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
LabelingJobProperties
LabelingJobTextProperties
| Name |
Description |
Value |
| annotationType |
Annotation type of text labeling job. |
'Classification' |
| mediaType |
[Required] Media type of the job. |
'Text' (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 |
Usage Examples
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 = {
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:
{
annotationType = "string"
mediaType = "Image"
}
For Text, use:
{
annotationType = "string"
mediaType = "Text"
}
Property Values
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" |
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
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
LabelClass
| Name |
Description |
Value |
| displayName |
Display name of the label class. |
string |
| subclasses |
Dictionary of subclasses of the label class. |
LabelClassSubclasses |
LabelClassSubclasses
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
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
LabelingJobProperties
LabelingJobTextProperties
| Name |
Description |
Value |
| annotationType |
Annotation type of text labeling job. |
'Classification' |
| mediaType |
[Required] Media type of the job. |
'Text' (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 |