Share via

JobBaseProperties interface

  • Reference
Package:
@azure/arm-machinelearning

Base definition for a job.

Extends
ResourceBase

Properties

componentId

ARM resource ID of the component resource.
computeId

ARM resource ID of the compute resource.
displayName

Display name of job.
experimentName

The name of the experiment the job belongs to. If not set, the job is placed in the "Default" experiment.
identity

Identity configuration. If set, this should be one of AmlToken, ManagedIdentity, UserIdentity or null. Defaults to AmlToken if null.
isArchived

Is the asset archived?
jobType

[Required] Specifies the type of job.
notificationSetting

Notification setting for the job
services

List of JobEndpoints. For local jobs, a job endpoint will have an endpoint value of FileStreamObject.
status

Status of the job. NOTE: This property will not be serialized. It can only be populated by the server.

Inherited Properties

description

The asset description text.
properties

The asset property dictionary.
tags

Tag dictionary. Tags can be added, removed, and updated.

Property Details

componentId

ARM resource ID of the component resource.

componentId?: string

Property Value

string

computeId

ARM resource ID of the compute resource.

computeId?: string

Property Value

string

displayName

Display name of job.

displayName?: string

Property Value

string

experimentName

The name of the experiment the job belongs to. If not set, the job is placed in the "Default" experiment.

experimentName?: string

Property Value

string

identity

Identity configuration. If set, this should be one of AmlToken, ManagedIdentity, UserIdentity or null. Defaults to AmlToken if null.

identity?: IdentityConfigurationUnion

Property Value

IdentityConfigurationUnion

isArchived

Is the asset archived?

isArchived?: boolean

Property Value

boolean

jobType

[Required] Specifies the type of job.

jobType: string

Property Value

string

notificationSetting

Notification setting for the job

notificationSetting?: NotificationSetting

Property Value

NotificationSetting

services

List of JobEndpoints. For local jobs, a job endpoint will have an endpoint value of FileStreamObject.

services?: {[propertyName: string]: JobService | null}

Property Value

{[propertyName: string]: JobService | null}

status

Status of the job. NOTE: This property will not be serialized. It can only be populated by the server.

status?: string

Property Value

string

Inherited Property Details

description

The asset description text.

description?: string

Property Value

string

Inherited From ResourceBase.description

properties

The asset property dictionary.

properties?: {[propertyName: string]: string | null}

Property Value

{[propertyName: string]: string | null}

Inherited From ResourceBase.properties

tags

Tag dictionary. Tags can be added, removed, and updated.

tags?: {[propertyName: string]: string | null}

Property Value

{[propertyName: string]: string | null}

Inherited From ResourceBase.tags