Azure Native
getLabelingJob
Machine Learning labeling job object wrapped into ARM resource envelope. API Version: 2020-09-01-preview.
Using getLabelingJob
Two invocation forms are available. The direct form accepts plain arguments and either blocks until the result value is available, or returns a Promise-wrapped result. The output form accepts Input-wrapped arguments and returns an Output-wrapped result.
function getLabelingJob(args: GetLabelingJobArgs, opts?: InvokeOptions): Promise<GetLabelingJobResult>
function getLabelingJobOutput(args: GetLabelingJobOutputArgs, opts?: InvokeOptions): Output<GetLabelingJobResult>
def get_labeling_job(include_job_instructions: Optional[bool] = None,
include_label_categories: Optional[bool] = None,
labeling_job_id: Optional[str] = None,
resource_group_name: Optional[str] = None,
workspace_name: Optional[str] = None,
opts: Optional[InvokeOptions] = None) -> GetLabelingJobResult
def get_labeling_job_output(include_job_instructions: Optional[pulumi.Input[bool]] = None,
include_label_categories: Optional[pulumi.Input[bool]] = None,
labeling_job_id: Optional[pulumi.Input[str]] = None,
resource_group_name: Optional[pulumi.Input[str]] = None,
workspace_name: Optional[pulumi.Input[str]] = None,
opts: Optional[InvokeOptions] = None) -> Output[GetLabelingJobResult]
func LookupLabelingJob(ctx *Context, args *LookupLabelingJobArgs, opts ...InvokeOption) (*LookupLabelingJobResult, error)
func LookupLabelingJobOutput(ctx *Context, args *LookupLabelingJobOutputArgs, opts ...InvokeOption) LookupLabelingJobResultOutput
> Note: This function is named LookupLabelingJob
in the Go SDK.
public static class GetLabelingJob
{
public static Task<GetLabelingJobResult> InvokeAsync(GetLabelingJobArgs args, InvokeOptions? opts = null)
public static Output<GetLabelingJobResult> Invoke(GetLabelingJobInvokeArgs args, InvokeOptions? opts = null)
}
public static CompletableFuture<GetLabelingJobResult> getLabelingJob(GetLabelingJobArgs args, InvokeOptions options)
// Output-based functions aren't available in Java yet
Fn::Invoke:
Function: azure-native:machinelearningservices:getLabelingJob
Arguments:
# Arguments dictionary
The following arguments are supported:
- Labeling
Job stringId Name and identifier for LabelingJob.
- Resource
Group stringName Name of the resource group in which workspace is located.
- Workspace
Name string Name of Azure Machine Learning workspace.
- Include
Job boolInstructions Boolean value to indicate whether to include JobInstructions in response.
- Include
Label boolCategories Boolean value to indicate whether to include LabelCategories in response.
- Labeling
Job stringId Name and identifier for LabelingJob.
- Resource
Group stringName Name of the resource group in which workspace is located.
- Workspace
Name string Name of Azure Machine Learning workspace.
- Include
Job boolInstructions Boolean value to indicate whether to include JobInstructions in response.
- Include
Label boolCategories Boolean value to indicate whether to include LabelCategories in response.
- labeling
Job StringId Name and identifier for LabelingJob.
- resource
Group StringName Name of the resource group in which workspace is located.
- workspace
Name String Name of Azure Machine Learning workspace.
- include
Job BooleanInstructions Boolean value to indicate whether to include JobInstructions in response.
- include
Label BooleanCategories Boolean value to indicate whether to include LabelCategories in response.
- labeling
Job stringId Name and identifier for LabelingJob.
- resource
Group stringName Name of the resource group in which workspace is located.
- workspace
Name string Name of Azure Machine Learning workspace.
- include
Job booleanInstructions Boolean value to indicate whether to include JobInstructions in response.
- include
Label booleanCategories Boolean value to indicate whether to include LabelCategories in response.
- labeling_
job_ strid Name and identifier for LabelingJob.
- resource_
group_ strname Name of the resource group in which workspace is located.
- workspace_
name str Name of Azure Machine Learning workspace.
- include_
job_ boolinstructions Boolean value to indicate whether to include JobInstructions in response.
- include_
label_ boolcategories Boolean value to indicate whether to include LabelCategories in response.
- labeling
Job StringId Name and identifier for LabelingJob.
- resource
Group StringName Name of the resource group in which workspace is located.
- workspace
Name String Name of Azure Machine Learning workspace.
- include
Job BooleanInstructions Boolean value to indicate whether to include JobInstructions in response.
- include
Label BooleanCategories Boolean value to indicate whether to include LabelCategories in response.
getLabelingJob Result
The following output properties are available:
- Id string
The resource URL of the entity (not URL encoded).
- Name string
The name of the resource entity.
- Properties
Pulumi.
Azure Native. Machine Learning Services. Outputs. Labeling Job Properties Response Definition of a labeling job.
- System
Data Pulumi.Azure Native. Machine Learning Services. Outputs. System Data Response Metadata pertaining to creation and last modification of the resource.
- Type string
The resource provider and type.
- Id string
The resource URL of the entity (not URL encoded).
- Name string
The name of the resource entity.
- Properties
Labeling
Job Properties Response Definition of a labeling job.
- System
Data SystemData Response Metadata pertaining to creation and last modification of the resource.
- Type string
The resource provider and type.
- id String
The resource URL of the entity (not URL encoded).
- name String
The name of the resource entity.
- properties
Labeling
Job Properties Response Definition of a labeling job.
- system
Data SystemData Response Metadata pertaining to creation and last modification of the resource.
- type String
The resource provider and type.
- id string
The resource URL of the entity (not URL encoded).
- name string
The name of the resource entity.
- properties
Labeling
Job Properties Response Definition of a labeling job.
- system
Data SystemData Response Metadata pertaining to creation and last modification of the resource.
- type string
The resource provider and type.
- id str
The resource URL of the entity (not URL encoded).
- name str
The name of the resource entity.
- properties
Labeling
Job Properties Response Definition of a labeling job.
- system_
data SystemData Response Metadata pertaining to creation and last modification of the resource.
- type str
The resource provider and type.
- id String
The resource URL of the entity (not URL encoded).
- name String
The name of the resource entity.
- properties Property Map
Definition of a labeling job.
- system
Data Property Map Metadata pertaining to creation and last modification of the resource.
- type String
The resource provider and type.
Supporting Types
ComputeBindingResponse
- compute_
id str ID of the compute resource.
- node_
count int Number of nodes.
LabelCategoryResponse
- Classes
Dictionary<string, Pulumi.
Azure Native. Machine Learning Services. Inputs. Label Class Response> Dictionary of label classes in this category.
- Allow
Multi boolSelect Indicates whether it is allowed to select multiple classes in this category.
- Display
Name string Display name of the label category.
- Classes
map[string]Label
Class Response Dictionary of label classes in this category.
- Allow
Multi boolSelect Indicates whether it is allowed to select multiple classes in this category.
- Display
Name string Display name of the label category.
- classes
Map<String,Label
Class Response> Dictionary of label classes in this category.
- allow
Multi BooleanSelect Indicates whether it is allowed to select multiple classes in this category.
- display
Name String Display name of the label category.
- classes
{[key: string]: Label
Class Response} Dictionary of label classes in this category.
- allow
Multi booleanSelect Indicates whether it is allowed to select multiple classes in this category.
- display
Name string Display name of the label category.
- classes
Mapping[str, Label
Class Response] Dictionary of label classes in this category.
- allow_
multi_ boolselect Indicates whether it is allowed to select multiple classes in this category.
- display_
name str Display name of the label category.
- classes Map<Property Map>
Dictionary of label classes in this category.
- allow
Multi BooleanSelect Indicates whether it is allowed to select multiple classes in this category.
- display
Name String Display name of the label category.
LabelClassResponse
- Display
Name string Display name of the label class.
- Subclasses
Dictionary<string, Pulumi.
Azure Native. Machine Learning Services. Inputs. Label Class Response> Dictionary of subclasses of the label class.
- Display
Name string Display name of the label class.
- Subclasses
map[string]Label
Class Response Dictionary of subclasses of the label class.
- display
Name String Display name of the label class.
- subclasses
Map<String,Label
Class Response> Dictionary of subclasses of the label class.
- display
Name string Display name of the label class.
- subclasses
{[key: string]: Label
Class Response} Dictionary of subclasses of the label class.
- display_
name str Display name of the label class.
- subclasses
Mapping[str, Label
Class Response] Dictionary of subclasses of the label class.
- display
Name String Display name of the label class.
- subclasses Map<Property Map>
Dictionary of subclasses of the label class.
LabelingDatasetConfigurationResponse
- Asset
Name string Name of the data asset to perform labeling.
- Dataset
Version string AML dataset version.
- Enable
Incremental boolDataset Refresh Indicates whether to enable incremental dataset refresh.
- Asset
Name string Name of the data asset to perform labeling.
- Dataset
Version string AML dataset version.
- Enable
Incremental boolDataset Refresh Indicates whether to enable incremental dataset refresh.
- asset
Name String Name of the data asset to perform labeling.
- dataset
Version String AML dataset version.
- enable
Incremental BooleanDataset Refresh Indicates whether to enable incremental dataset refresh.
- asset
Name string Name of the data asset to perform labeling.
- dataset
Version string AML dataset version.
- enable
Incremental booleanDataset Refresh Indicates whether to enable incremental dataset refresh.
- asset_
name str Name of the data asset to perform labeling.
- dataset_
version str AML dataset version.
- enable_
incremental_ booldataset_ refresh Indicates whether to enable incremental dataset refresh.
- asset
Name String Name of the data asset to perform labeling.
- dataset
Version String AML dataset version.
- enable
Incremental BooleanDataset Refresh Indicates whether to enable incremental dataset refresh.
LabelingJobImagePropertiesResponse
- Media
Type string Media type of data asset.
- Annotation
Type string Annotation type of image labeling tasks.
- Media
Type string Media type of data asset.
- Annotation
Type string Annotation type of image labeling tasks.
- media
Type String Media type of data asset.
- annotation
Type String Annotation type of image labeling tasks.
- media
Type string Media type of data asset.
- annotation
Type string Annotation type of image labeling tasks.
- media_
type str Media type of data asset.
- annotation_
type str Annotation type of image labeling tasks.
- media
Type String Media type of data asset.
- annotation
Type String Annotation type of image labeling tasks.
LabelingJobInstructionsResponse
- Uri string
The link to a page with detailed labeling instructions for labelers.
- Uri string
The link to a page with detailed labeling instructions for labelers.
- uri String
The link to a page with detailed labeling instructions for labelers.
- uri string
The link to a page with detailed labeling instructions for labelers.
- uri str
The link to a page with detailed labeling instructions for labelers.
- uri String
The link to a page with detailed labeling instructions for labelers.
LabelingJobPropertiesResponse
- Created
Time stringUtc Created time of the job in UTC timezone.
- Dataset
Configuration Pulumi.Azure Native. Machine Learning Services. Inputs. Labeling Dataset Configuration Response Dataset configuration for the job.
- Job
Instructions Pulumi.Azure Native. Machine Learning Services. Inputs. Labeling Job Instructions Response Instructions for the job.
- Label
Categories Dictionary<string, Pulumi.Azure Native. Machine Learning Services. Inputs. Label Category Response> Label categories of the job.
- Labeling
Job Pulumi.Media Properties Azure Native. Machine Learning Services. Inputs. Labeling Job Image Properties Response Media specific properties in a labeling job.
- Progress
Metrics Pulumi.Azure Native. Machine Learning Services. Inputs. Progress Metrics Response Progress metrics of the job.
- Project
Id string Internal id of the job(Previously called project).
- Status string
Status of the job.
- Status
Messages List<Pulumi.Azure Native. Machine Learning Services. Inputs. Status Message Response> Status messages of the job.
- Ml
Assist Pulumi.Configuration Azure Native. Machine Learning Services. Inputs. MLAssist Configuration Response Machine learning assisted configuration for the job.
- Properties Dictionary<string, string>
The job property dictionary. Properties can be added, but not removed or altered.
- Dictionary<string, string>
The job tag dictionary. Tags can be added, removed, and updated.
- Created
Time stringUtc Created time of the job in UTC timezone.
- Dataset
Configuration LabelingDataset Configuration Response Dataset configuration for the job.
- Job
Instructions LabelingJob Instructions Response Instructions for the job.
- Label
Categories map[string]LabelCategory Response Label categories of the job.
- Labeling
Job LabelingMedia Properties Job Image Properties Response Media specific properties in a labeling job.
- Progress
Metrics ProgressMetrics Response Progress metrics of the job.
- Project
Id string Internal id of the job(Previously called project).
- Status string
Status of the job.
- Status
Messages []StatusMessage Response Status messages of the job.
- Ml
Assist MLAssistConfiguration Configuration Response Machine learning assisted configuration for the job.
- Properties map[string]string
The job property dictionary. Properties can be added, but not removed or altered.
- map[string]string
The job tag dictionary. Tags can be added, removed, and updated.
- created
Time StringUtc Created time of the job in UTC timezone.
- dataset
Configuration LabelingDataset Configuration Response Dataset configuration for the job.
- job
Instructions LabelingJob Instructions Response Instructions for the job.
- label
Categories Map<String,LabelCategory Response> Label categories of the job.
- labeling
Job LabelingMedia Properties Job Image Properties Response Media specific properties in a labeling job.
- progress
Metrics ProgressMetrics Response Progress metrics of the job.
- project
Id String Internal id of the job(Previously called project).
- status String
Status of the job.
- status
Messages List<StatusMessage Response> Status messages of the job.
- ml
Assist MLAssistConfiguration Configuration Response Machine learning assisted configuration for the job.
- properties Map<String,String>
The job property dictionary. Properties can be added, but not removed or altered.
- Map<String,String>
The job tag dictionary. Tags can be added, removed, and updated.
- created
Time stringUtc Created time of the job in UTC timezone.
- dataset
Configuration LabelingDataset Configuration Response Dataset configuration for the job.
- job
Instructions LabelingJob Instructions Response Instructions for the job.
- label
Categories {[key: string]: LabelCategory Response} Label categories of the job.
- labeling
Job LabelingMedia Properties Job Image Properties Response Media specific properties in a labeling job.
- progress
Metrics ProgressMetrics Response Progress metrics of the job.
- project
Id string Internal id of the job(Previously called project).
- status string
Status of the job.
- status
Messages StatusMessage Response[] Status messages of the job.
- ml
Assist MLAssistConfiguration Configuration Response Machine learning assisted configuration for the job.
- properties {[key: string]: string}
The job property dictionary. Properties can be added, but not removed or altered.
- {[key: string]: string}
The job tag dictionary. Tags can be added, removed, and updated.
- created_
time_ strutc Created time of the job in UTC timezone.
- dataset_
configuration LabelingDataset Configuration Response Dataset configuration for the job.
- job_
instructions LabelingJob Instructions Response Instructions for the job.
- label_
categories Mapping[str, LabelCategory Response] Label categories of the job.
- labeling_
job_ Labelingmedia_ properties Job Image Properties Response Media specific properties in a labeling job.
- progress_
metrics ProgressMetrics Response Progress metrics of the job.
- project_
id str Internal id of the job(Previously called project).
- status str
Status of the job.
- status_
messages Sequence[StatusMessage Response] Status messages of the job.
- ml_
assist_ MLAssistconfiguration Configuration Response Machine learning assisted configuration for the job.
- properties Mapping[str, str]
The job property dictionary. Properties can be added, but not removed or altered.
- Mapping[str, str]
The job tag dictionary. Tags can be added, removed, and updated.
- created
Time StringUtc Created time of the job in UTC timezone.
- dataset
Configuration Property Map Dataset configuration for the job.
- job
Instructions Property Map Instructions for the job.
- label
Categories Map<Property Map> Label categories of the job.
- labeling
Job Property MapMedia Properties Media specific properties in a labeling job.
- progress
Metrics Property Map Progress metrics of the job.
- project
Id String Internal id of the job(Previously called project).
- status String
Status of the job.
- status
Messages List<Property Map> Status messages of the job.
- ml
Assist Property MapConfiguration Machine learning assisted configuration for the job.
- properties Map<String>
The job property dictionary. Properties can be added, but not removed or altered.
- Map<String>
The job tag dictionary. Tags can be added, removed, and updated.
MLAssistConfigurationResponse
- Inferencing
Compute Pulumi.Binding Azure Native. Machine Learning Services. Inputs. Compute Binding Response The compute designated for inferencing.
- Model
Name stringPrefix Name prefix to use for machine learning model. For each iteration modelName will be appended with iteration e.g.{modelName}_{i}.
- Training
Compute Pulumi.Binding Azure Native. Machine Learning Services. Inputs. Compute Binding Response The compute designated for training.
- Ml
Assist boolEnabled Indicates whether MLAssist feature is enabled.
- Prelabel
Accuracy doubleThreshold Prelabel accuracy threshold used in MLAssist feature.
- Inferencing
Compute ComputeBinding Binding Response The compute designated for inferencing.
- Model
Name stringPrefix Name prefix to use for machine learning model. For each iteration modelName will be appended with iteration e.g.{modelName}_{i}.
- Training
Compute ComputeBinding Binding Response The compute designated for training.
- Ml
Assist boolEnabled Indicates whether MLAssist feature is enabled.
- Prelabel
Accuracy float64Threshold Prelabel accuracy threshold used in MLAssist feature.
- inferencing
Compute ComputeBinding Binding Response The compute designated for inferencing.
- model
Name StringPrefix Name prefix to use for machine learning model. For each iteration modelName will be appended with iteration e.g.{modelName}_{i}.
- training
Compute ComputeBinding Binding Response The compute designated for training.
- ml
Assist BooleanEnabled Indicates whether MLAssist feature is enabled.
- prelabel
Accuracy DoubleThreshold Prelabel accuracy threshold used in MLAssist feature.
- inferencing
Compute ComputeBinding Binding Response The compute designated for inferencing.
- model
Name stringPrefix Name prefix to use for machine learning model. For each iteration modelName will be appended with iteration e.g.{modelName}_{i}.
- training
Compute ComputeBinding Binding Response The compute designated for training.
- ml
Assist booleanEnabled Indicates whether MLAssist feature is enabled.
- prelabel
Accuracy numberThreshold Prelabel accuracy threshold used in MLAssist feature.
- inferencing_
compute_ Computebinding Binding Response The compute designated for inferencing.
- model_
name_ strprefix Name prefix to use for machine learning model. For each iteration modelName will be appended with iteration e.g.{modelName}_{i}.
- training_
compute_ Computebinding Binding Response The compute designated for training.
- ml_
assist_ boolenabled Indicates whether MLAssist feature is enabled.
- prelabel_
accuracy_ floatthreshold Prelabel accuracy threshold used in MLAssist feature.
- inferencing
Compute Property MapBinding The compute designated for inferencing.
- model
Name StringPrefix Name prefix to use for machine learning model. For each iteration modelName will be appended with iteration e.g.{modelName}_{i}.
- training
Compute Property MapBinding The compute designated for training.
- ml
Assist BooleanEnabled Indicates whether MLAssist feature is enabled.
- prelabel
Accuracy NumberThreshold Prelabel accuracy threshold used in MLAssist feature.
ProgressMetricsResponse
- Completed
Datapoint doubleCount The completed datapoint count.
- Incremental
Dataset stringLast Refresh Time The time of last successful incremental dataset refresh in UTC.
- Skipped
Datapoint doubleCount The skipped datapoint count.
- Total
Datapoint doubleCount The total datapoint count.
- Completed
Datapoint float64Count The completed datapoint count.
- Incremental
Dataset stringLast Refresh Time The time of last successful incremental dataset refresh in UTC.
- Skipped
Datapoint float64Count The skipped datapoint count.
- Total
Datapoint float64Count The total datapoint count.
- completed
Datapoint DoubleCount The completed datapoint count.
- incremental
Dataset StringLast Refresh Time The time of last successful incremental dataset refresh in UTC.
- skipped
Datapoint DoubleCount The skipped datapoint count.
- total
Datapoint DoubleCount The total datapoint count.
- completed
Datapoint numberCount The completed datapoint count.
- incremental
Dataset stringLast Refresh Time The time of last successful incremental dataset refresh in UTC.
- skipped
Datapoint numberCount The skipped datapoint count.
- total
Datapoint numberCount The total datapoint count.
- completed_
datapoint_ floatcount The completed datapoint count.
- incremental_
dataset_ strlast_ refresh_ time The time of last successful incremental dataset refresh in UTC.
- skipped_
datapoint_ floatcount The skipped datapoint count.
- total_
datapoint_ floatcount The total datapoint count.
- completed
Datapoint NumberCount The completed datapoint count.
- incremental
Dataset StringLast Refresh Time The time of last successful incremental dataset refresh in UTC.
- skipped
Datapoint NumberCount The skipped datapoint count.
- total
Datapoint NumberCount The total datapoint count.
StatusMessageResponse
- Code string
Service-defined message code.
- Created
Time stringUtc Time in UTC at which the message was created.
- Level string
Severity level of the status message.
- Message string
A human-readable representation of the message code.
- Code string
Service-defined message code.
- Created
Time stringUtc Time in UTC at which the message was created.
- Level string
Severity level of the status message.
- Message string
A human-readable representation of the message code.
- code String
Service-defined message code.
- created
Time StringUtc Time in UTC at which the message was created.
- level String
Severity level of the status message.
- message String
A human-readable representation of the message code.
- code string
Service-defined message code.
- created
Time stringUtc Time in UTC at which the message was created.
- level string
Severity level of the status message.
- message string
A human-readable representation of the message code.
- code str
Service-defined message code.
- created_
time_ strutc Time in UTC at which the message was created.
- level str
Severity level of the status message.
- message str
A human-readable representation of the message code.
- code String
Service-defined message code.
- created
Time StringUtc Time in UTC at which the message was created.
- level String
Severity level of the status message.
- message String
A human-readable representation of the message code.
SystemDataResponse
- Created
At string The timestamp of resource creation (UTC)
- Created
By string An identifier for the identity that created the resource
- Created
By stringType The type of identity that created the resource
- Last
Modified stringAt The timestamp of resource last modification (UTC)
- Last
Modified stringBy An identifier for the identity that last modified the resource
- Last
Modified stringBy Type The type of identity that last modified the resource
- Created
At string The timestamp of resource creation (UTC)
- Created
By string An identifier for the identity that created the resource
- Created
By stringType The type of identity that created the resource
- Last
Modified stringAt The timestamp of resource last modification (UTC)
- Last
Modified stringBy An identifier for the identity that last modified the resource
- Last
Modified stringBy Type The type of identity that last modified the resource
- created
At String The timestamp of resource creation (UTC)
- created
By String An identifier for the identity that created the resource
- created
By StringType The type of identity that created the resource
- last
Modified StringAt The timestamp of resource last modification (UTC)
- last
Modified StringBy An identifier for the identity that last modified the resource
- last
Modified StringBy Type The type of identity that last modified the resource
- created
At string The timestamp of resource creation (UTC)
- created
By string An identifier for the identity that created the resource
- created
By stringType The type of identity that created the resource
- last
Modified stringAt The timestamp of resource last modification (UTC)
- last
Modified stringBy An identifier for the identity that last modified the resource
- last
Modified stringBy Type The type of identity that last modified the resource
- created_
at str The timestamp of resource creation (UTC)
- created_
by str An identifier for the identity that created the resource
- created_
by_ strtype The type of identity that created the resource
- last_
modified_ strat The timestamp of resource last modification (UTC)
- last_
modified_ strby An identifier for the identity that last modified the resource
- last_
modified_ strby_ type The type of identity that last modified the resource
- created
At String The timestamp of resource creation (UTC)
- created
By String An identifier for the identity that created the resource
- created
By StringType The type of identity that created the resource
- last
Modified StringAt The timestamp of resource last modification (UTC)
- last
Modified StringBy An identifier for the identity that last modified the resource
- last
Modified StringBy Type The type of identity that last modified the resource
Package Details
- Repository
- https://github.com/pulumi/pulumi-azure-native
- License
- Apache-2.0