Azure Native

Pulumi Official
Package maintained by Pulumi
v1.68.2 published on Tuesday, Aug 16, 2022 by Pulumi

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:

LabelingJobId string

Name and identifier for LabelingJob.

ResourceGroupName string

Name of the resource group in which workspace is located.

WorkspaceName string

Name of Azure Machine Learning workspace.

IncludeJobInstructions bool

Boolean value to indicate whether to include JobInstructions in response.

IncludeLabelCategories bool

Boolean value to indicate whether to include LabelCategories in response.

LabelingJobId string

Name and identifier for LabelingJob.

ResourceGroupName string

Name of the resource group in which workspace is located.

WorkspaceName string

Name of Azure Machine Learning workspace.

IncludeJobInstructions bool

Boolean value to indicate whether to include JobInstructions in response.

IncludeLabelCategories bool

Boolean value to indicate whether to include LabelCategories in response.

labelingJobId String

Name and identifier for LabelingJob.

resourceGroupName String

Name of the resource group in which workspace is located.

workspaceName String

Name of Azure Machine Learning workspace.

includeJobInstructions Boolean

Boolean value to indicate whether to include JobInstructions in response.

includeLabelCategories Boolean

Boolean value to indicate whether to include LabelCategories in response.

labelingJobId string

Name and identifier for LabelingJob.

resourceGroupName string

Name of the resource group in which workspace is located.

workspaceName string

Name of Azure Machine Learning workspace.

includeJobInstructions boolean

Boolean value to indicate whether to include JobInstructions in response.

includeLabelCategories boolean

Boolean value to indicate whether to include LabelCategories in response.

labeling_job_id str

Name and identifier for LabelingJob.

resource_group_name str

Name of the resource group in which workspace is located.

workspace_name str

Name of Azure Machine Learning workspace.

include_job_instructions bool

Boolean value to indicate whether to include JobInstructions in response.

include_label_categories bool

Boolean value to indicate whether to include LabelCategories in response.

labelingJobId String

Name and identifier for LabelingJob.

resourceGroupName String

Name of the resource group in which workspace is located.

workspaceName String

Name of Azure Machine Learning workspace.

includeJobInstructions Boolean

Boolean value to indicate whether to include JobInstructions in response.

includeLabelCategories Boolean

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.AzureNative.MachineLearningServices.Outputs.LabelingJobPropertiesResponse

Definition of a labeling job.

SystemData Pulumi.AzureNative.MachineLearningServices.Outputs.SystemDataResponse

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 LabelingJobPropertiesResponse

Definition of a labeling job.

SystemData SystemDataResponse

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 LabelingJobPropertiesResponse

Definition of a labeling job.

systemData SystemDataResponse

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 LabelingJobPropertiesResponse

Definition of a labeling job.

systemData SystemDataResponse

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 LabelingJobPropertiesResponse

Definition of a labeling job.

system_data SystemDataResponse

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.

systemData Property Map

Metadata pertaining to creation and last modification of the resource.

type String

The resource provider and type.

Supporting Types

ComputeBindingResponse

ComputeId string

ID of the compute resource.

NodeCount int

Number of nodes.

ComputeId string

ID of the compute resource.

NodeCount int

Number of nodes.

computeId String

ID of the compute resource.

nodeCount Integer

Number of nodes.

computeId string

ID of the compute resource.

nodeCount number

Number of nodes.

compute_id str

ID of the compute resource.

node_count int

Number of nodes.

computeId String

ID of the compute resource.

nodeCount Number

Number of nodes.

LabelCategoryResponse

Classes Dictionary<string, Pulumi.AzureNative.MachineLearningServices.Inputs.LabelClassResponse>

Dictionary of label classes in this category.

AllowMultiSelect bool

Indicates whether it is allowed to select multiple classes in this category.

DisplayName string

Display name of the label category.

Classes map[string]LabelClassResponse

Dictionary of label classes in this category.

AllowMultiSelect bool

Indicates whether it is allowed to select multiple classes in this category.

DisplayName string

Display name of the label category.

classes Map<String,LabelClassResponse>

Dictionary of label classes in this category.

allowMultiSelect Boolean

Indicates whether it is allowed to select multiple classes in this category.

displayName String

Display name of the label category.

classes {[key: string]: LabelClassResponse}

Dictionary of label classes in this category.

allowMultiSelect boolean

Indicates whether it is allowed to select multiple classes in this category.

displayName string

Display name of the label category.

classes Mapping[str, LabelClassResponse]

Dictionary of label classes in this category.

allow_multi_select bool

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.

allowMultiSelect Boolean

Indicates whether it is allowed to select multiple classes in this category.

displayName String

Display name of the label category.

LabelClassResponse

DisplayName string

Display name of the label class.

Subclasses Dictionary<string, Pulumi.AzureNative.MachineLearningServices.Inputs.LabelClassResponse>

Dictionary of subclasses of the label class.

DisplayName string

Display name of the label class.

Subclasses map[string]LabelClassResponse

Dictionary of subclasses of the label class.

displayName String

Display name of the label class.

subclasses Map<String,LabelClassResponse>

Dictionary of subclasses of the label class.

displayName string

Display name of the label class.

subclasses {[key: string]: LabelClassResponse}

Dictionary of subclasses of the label class.

display_name str

Display name of the label class.

subclasses Mapping[str, LabelClassResponse]

Dictionary of subclasses of the label class.

displayName String

Display name of the label class.

subclasses Map<Property Map>

Dictionary of subclasses of the label class.

LabelingDatasetConfigurationResponse

AssetName string

Name of the data asset to perform labeling.

DatasetVersion string

AML dataset version.

EnableIncrementalDatasetRefresh bool

Indicates whether to enable incremental dataset refresh.

AssetName string

Name of the data asset to perform labeling.

DatasetVersion string

AML dataset version.

EnableIncrementalDatasetRefresh bool

Indicates whether to enable incremental dataset refresh.

assetName String

Name of the data asset to perform labeling.

datasetVersion String

AML dataset version.

enableIncrementalDatasetRefresh Boolean

Indicates whether to enable incremental dataset refresh.

assetName string

Name of the data asset to perform labeling.

datasetVersion string

AML dataset version.

enableIncrementalDatasetRefresh boolean

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_dataset_refresh bool

Indicates whether to enable incremental dataset refresh.

assetName String

Name of the data asset to perform labeling.

datasetVersion String

AML dataset version.

enableIncrementalDatasetRefresh Boolean

Indicates whether to enable incremental dataset refresh.

LabelingJobImagePropertiesResponse

MediaType string

Media type of data asset.

AnnotationType string

Annotation type of image labeling tasks.

MediaType string

Media type of data asset.

AnnotationType string

Annotation type of image labeling tasks.

mediaType String

Media type of data asset.

annotationType String

Annotation type of image labeling tasks.

mediaType string

Media type of data asset.

annotationType string

Annotation type of image labeling tasks.

media_type str

Media type of data asset.

annotation_type str

Annotation type of image labeling tasks.

mediaType String

Media type of data asset.

annotationType 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

CreatedTimeUtc string

Created time of the job in UTC timezone.

DatasetConfiguration Pulumi.AzureNative.MachineLearningServices.Inputs.LabelingDatasetConfigurationResponse

Dataset configuration for the job.

JobInstructions Pulumi.AzureNative.MachineLearningServices.Inputs.LabelingJobInstructionsResponse

Instructions for the job.

LabelCategories Dictionary<string, Pulumi.AzureNative.MachineLearningServices.Inputs.LabelCategoryResponse>

Label categories of the job.

LabelingJobMediaProperties Pulumi.AzureNative.MachineLearningServices.Inputs.LabelingJobImagePropertiesResponse

Media specific properties in a labeling job.

ProgressMetrics Pulumi.AzureNative.MachineLearningServices.Inputs.ProgressMetricsResponse

Progress metrics of the job.

ProjectId string

Internal id of the job(Previously called project).

Status string

Status of the job.

StatusMessages List<Pulumi.AzureNative.MachineLearningServices.Inputs.StatusMessageResponse>

Status messages of the job.

MlAssistConfiguration Pulumi.AzureNative.MachineLearningServices.Inputs.MLAssistConfigurationResponse

Machine learning assisted configuration for the job.

Properties Dictionary<string, string>

The job property dictionary. Properties can be added, but not removed or altered.

Tags Dictionary<string, string>

The job tag dictionary. Tags can be added, removed, and updated.

CreatedTimeUtc string

Created time of the job in UTC timezone.

DatasetConfiguration LabelingDatasetConfigurationResponse

Dataset configuration for the job.

JobInstructions LabelingJobInstructionsResponse

Instructions for the job.

LabelCategories map[string]LabelCategoryResponse

Label categories of the job.

LabelingJobMediaProperties LabelingJobImagePropertiesResponse

Media specific properties in a labeling job.

ProgressMetrics ProgressMetricsResponse

Progress metrics of the job.

ProjectId string

Internal id of the job(Previously called project).

Status string

Status of the job.

StatusMessages []StatusMessageResponse

Status messages of the job.

MlAssistConfiguration MLAssistConfigurationResponse

Machine learning assisted configuration for the job.

Properties map[string]string

The job property dictionary. Properties can be added, but not removed or altered.

Tags map[string]string

The job tag dictionary. Tags can be added, removed, and updated.

createdTimeUtc String

Created time of the job in UTC timezone.

datasetConfiguration LabelingDatasetConfigurationResponse

Dataset configuration for the job.

jobInstructions LabelingJobInstructionsResponse

Instructions for the job.

labelCategories Map<String,LabelCategoryResponse>

Label categories of the job.

labelingJobMediaProperties LabelingJobImagePropertiesResponse

Media specific properties in a labeling job.

progressMetrics ProgressMetricsResponse

Progress metrics of the job.

projectId String

Internal id of the job(Previously called project).

status String

Status of the job.

statusMessages List<StatusMessageResponse>

Status messages of the job.

mlAssistConfiguration MLAssistConfigurationResponse

Machine learning assisted configuration for the job.

properties Map<String,String>

The job property dictionary. Properties can be added, but not removed or altered.

tags Map<String,String>

The job tag dictionary. Tags can be added, removed, and updated.

createdTimeUtc string

Created time of the job in UTC timezone.

datasetConfiguration LabelingDatasetConfigurationResponse

Dataset configuration for the job.

jobInstructions LabelingJobInstructionsResponse

Instructions for the job.

labelCategories {[key: string]: LabelCategoryResponse}

Label categories of the job.

labelingJobMediaProperties LabelingJobImagePropertiesResponse

Media specific properties in a labeling job.

progressMetrics ProgressMetricsResponse

Progress metrics of the job.

projectId string

Internal id of the job(Previously called project).

status string

Status of the job.

statusMessages StatusMessageResponse[]

Status messages of the job.

mlAssistConfiguration MLAssistConfigurationResponse

Machine learning assisted configuration for the job.

properties {[key: string]: string}

The job property dictionary. Properties can be added, but not removed or altered.

tags {[key: string]: string}

The job tag dictionary. Tags can be added, removed, and updated.

created_time_utc str

Created time of the job in UTC timezone.

dataset_configuration LabelingDatasetConfigurationResponse

Dataset configuration for the job.

job_instructions LabelingJobInstructionsResponse

Instructions for the job.

label_categories Mapping[str, LabelCategoryResponse]

Label categories of the job.

labeling_job_media_properties LabelingJobImagePropertiesResponse

Media specific properties in a labeling job.

progress_metrics ProgressMetricsResponse

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[StatusMessageResponse]

Status messages of the job.

ml_assist_configuration MLAssistConfigurationResponse

Machine learning assisted configuration for the job.

properties Mapping[str, str]

The job property dictionary. Properties can be added, but not removed or altered.

tags Mapping[str, str]

The job tag dictionary. Tags can be added, removed, and updated.

createdTimeUtc String

Created time of the job in UTC timezone.

datasetConfiguration Property Map

Dataset configuration for the job.

jobInstructions Property Map

Instructions for the job.

labelCategories Map<Property Map>

Label categories of the job.

labelingJobMediaProperties Property Map

Media specific properties in a labeling job.

progressMetrics Property Map

Progress metrics of the job.

projectId String

Internal id of the job(Previously called project).

status String

Status of the job.

statusMessages List<Property Map>

Status messages of the job.

mlAssistConfiguration Property Map

Machine learning assisted configuration for the job.

properties Map<String>

The job property dictionary. Properties can be added, but not removed or altered.

tags Map<String>

The job tag dictionary. Tags can be added, removed, and updated.

MLAssistConfigurationResponse

InferencingComputeBinding Pulumi.AzureNative.MachineLearningServices.Inputs.ComputeBindingResponse

The compute designated for inferencing.

ModelNamePrefix string

Name prefix to use for machine learning model. For each iteration modelName will be appended with iteration e.g.{modelName}_{i}.

TrainingComputeBinding Pulumi.AzureNative.MachineLearningServices.Inputs.ComputeBindingResponse

The compute designated for training.

MlAssistEnabled bool

Indicates whether MLAssist feature is enabled.

PrelabelAccuracyThreshold double

Prelabel accuracy threshold used in MLAssist feature.

InferencingComputeBinding ComputeBindingResponse

The compute designated for inferencing.

ModelNamePrefix string

Name prefix to use for machine learning model. For each iteration modelName will be appended with iteration e.g.{modelName}_{i}.

TrainingComputeBinding ComputeBindingResponse

The compute designated for training.

MlAssistEnabled bool

Indicates whether MLAssist feature is enabled.

PrelabelAccuracyThreshold float64

Prelabel accuracy threshold used in MLAssist feature.

inferencingComputeBinding ComputeBindingResponse

The compute designated for inferencing.

modelNamePrefix String

Name prefix to use for machine learning model. For each iteration modelName will be appended with iteration e.g.{modelName}_{i}.

trainingComputeBinding ComputeBindingResponse

The compute designated for training.

mlAssistEnabled Boolean

Indicates whether MLAssist feature is enabled.

prelabelAccuracyThreshold Double

Prelabel accuracy threshold used in MLAssist feature.

inferencingComputeBinding ComputeBindingResponse

The compute designated for inferencing.

modelNamePrefix string

Name prefix to use for machine learning model. For each iteration modelName will be appended with iteration e.g.{modelName}_{i}.

trainingComputeBinding ComputeBindingResponse

The compute designated for training.

mlAssistEnabled boolean

Indicates whether MLAssist feature is enabled.

prelabelAccuracyThreshold number

Prelabel accuracy threshold used in MLAssist feature.

inferencing_compute_binding ComputeBindingResponse

The compute designated for inferencing.

model_name_prefix str

Name prefix to use for machine learning model. For each iteration modelName will be appended with iteration e.g.{modelName}_{i}.

training_compute_binding ComputeBindingResponse

The compute designated for training.

ml_assist_enabled bool

Indicates whether MLAssist feature is enabled.

prelabel_accuracy_threshold float

Prelabel accuracy threshold used in MLAssist feature.

inferencingComputeBinding Property Map

The compute designated for inferencing.

modelNamePrefix String

Name prefix to use for machine learning model. For each iteration modelName will be appended with iteration e.g.{modelName}_{i}.

trainingComputeBinding Property Map

The compute designated for training.

mlAssistEnabled Boolean

Indicates whether MLAssist feature is enabled.

prelabelAccuracyThreshold Number

Prelabel accuracy threshold used in MLAssist feature.

ProgressMetricsResponse

CompletedDatapointCount double

The completed datapoint count.

IncrementalDatasetLastRefreshTime string

The time of last successful incremental dataset refresh in UTC.

SkippedDatapointCount double

The skipped datapoint count.

TotalDatapointCount double

The total datapoint count.

CompletedDatapointCount float64

The completed datapoint count.

IncrementalDatasetLastRefreshTime string

The time of last successful incremental dataset refresh in UTC.

SkippedDatapointCount float64

The skipped datapoint count.

TotalDatapointCount float64

The total datapoint count.

completedDatapointCount Double

The completed datapoint count.

incrementalDatasetLastRefreshTime String

The time of last successful incremental dataset refresh in UTC.

skippedDatapointCount Double

The skipped datapoint count.

totalDatapointCount Double

The total datapoint count.

completedDatapointCount number

The completed datapoint count.

incrementalDatasetLastRefreshTime string

The time of last successful incremental dataset refresh in UTC.

skippedDatapointCount number

The skipped datapoint count.

totalDatapointCount number

The total datapoint count.

completed_datapoint_count float

The completed datapoint count.

incremental_dataset_last_refresh_time str

The time of last successful incremental dataset refresh in UTC.

skipped_datapoint_count float

The skipped datapoint count.

total_datapoint_count float

The total datapoint count.

completedDatapointCount Number

The completed datapoint count.

incrementalDatasetLastRefreshTime String

The time of last successful incremental dataset refresh in UTC.

skippedDatapointCount Number

The skipped datapoint count.

totalDatapointCount Number

The total datapoint count.

StatusMessageResponse

Code string

Service-defined message code.

CreatedTimeUtc string

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.

CreatedTimeUtc string

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.

createdTimeUtc String

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.

createdTimeUtc string

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_utc str

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.

createdTimeUtc String

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

CreatedAt string

The timestamp of resource creation (UTC)

CreatedBy string

An identifier for the identity that created the resource

CreatedByType string

The type of identity that created the resource

LastModifiedAt string

The timestamp of resource last modification (UTC)

LastModifiedBy string

An identifier for the identity that last modified the resource

LastModifiedByType string

The type of identity that last modified the resource

CreatedAt string

The timestamp of resource creation (UTC)

CreatedBy string

An identifier for the identity that created the resource

CreatedByType string

The type of identity that created the resource

LastModifiedAt string

The timestamp of resource last modification (UTC)

LastModifiedBy string

An identifier for the identity that last modified the resource

LastModifiedByType string

The type of identity that last modified the resource

createdAt String

The timestamp of resource creation (UTC)

createdBy String

An identifier for the identity that created the resource

createdByType String

The type of identity that created the resource

lastModifiedAt String

The timestamp of resource last modification (UTC)

lastModifiedBy String

An identifier for the identity that last modified the resource

lastModifiedByType String

The type of identity that last modified the resource

createdAt string

The timestamp of resource creation (UTC)

createdBy string

An identifier for the identity that created the resource

createdByType string

The type of identity that created the resource

lastModifiedAt string

The timestamp of resource last modification (UTC)

lastModifiedBy string

An identifier for the identity that last modified the resource

lastModifiedByType string

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_type str

The type of identity that created the resource

last_modified_at str

The timestamp of resource last modification (UTC)

last_modified_by str

An identifier for the identity that last modified the resource

last_modified_by_type str

The type of identity that last modified the resource

createdAt String

The timestamp of resource creation (UTC)

createdBy String

An identifier for the identity that created the resource

createdByType String

The type of identity that created the resource

lastModifiedAt String

The timestamp of resource last modification (UTC)

lastModifiedBy String

An identifier for the identity that last modified the resource

lastModifiedByType String

The type of identity that last modified the resource

Package Details

Repository
https://github.com/pulumi/pulumi-azure-native
License
Apache-2.0