Share via

Job [SPFSDK][VMMREF]

  • Article

 

Applies To: Windows Azure Pack

A job entity represents a task that Virtual Machine Manager (VMM) has either completed or is in progress.

Inheritance Hierarchy

VMM
  Job

Entity Properties

For more information about how the properties of an entity interact with HTTP operations, see Entity Basics.

Name

Create (POST)

Read (GET)

Update (PUT)

Delete (DELETE)

Type

Nullable

Description

ID

-

Optional

Required

-

Edm.Guid

False

Key Property

The identifier of the job.

StampId

-

Optional

Required

-

Edm.Guid

False

Key Property

The identifier of the stamp.

AdditionalMessages

-

Optional

-

-

Collection(ErrorInfo)

False

Error messages associated with the job.

AreAuditRecordsAvailable

-

Optional

-

-

Edm.Boolean

True

Indicates whether audit records are available.

CmdletName

-

Optional

-

-

Edm.String

True

Specifies the name of a cmdlet associated with the job.

CurrentStepId

-

Optional

-

-

Edm.Guid

True

The identifier of the current step of the job.

Description

-

Optional

-

-

Edm.String

True

A description of the job.

EndTime

-

Optional

-

-

Edm.DateTime

True

The date and time the job ended.

ErrorInfo

-

Optional

-

-

ErrorInfo

True

An error or success message associated with the job.

IsCompleted

-

Optional

-

-

Edm.Boolean

True

Indicates whether the job has completed.

IsRestartable

-

Optional

-

-

Edm.Boolean

True

Indicates whether the job can be restarted.

IsStoppable

-

Optional

-

-

Edm.Boolean

True

Indicates whether the job can be stopped.

IsVisible

-

Optional

-

-

Edm.Boolean

True

Indicates whether the job is visible.

Name

-

Optional

-

-

Edm.String

True

The name of the Job.

Owner

-

Optional

-

-

Edm.String

True

The user that initiated the job.

OwnerSID

-

Optional

-

-

Edm.String

True

The security identifier of the job owner.

Password

-

Optional

Optional

-

Edm.String

True

The password of the user specified in the UserName property.

Progress

-

Optional

-

-

Edm.String

True

The progress of the job.

ProgressValue

-

Optional

-

-

Edm.Int32

True

The percent of the job completed.

PROTipID

-

Optional

-

-

Edm.Guid

True

The identifier of the PRO tip that triggered this action. This enables the auditing of PRO tips.

ResultName

-

Optional

-

-

Edm.String

True

The name of the job result.

ResultObjectID

-

Optional

-

-

Edm.Guid

True

The identifier of the object resulting from the job.

ResultObjectType

-

Optional

-

-

Edm.String

True

The type of object resulting from the job.

ResultObjectTypeName

-

Optional

-

-

Edm.String

True

The name of the type of object resulting from the job.

RootStepId

-

Optional

-

-

Edm.Guid

True

The identifier of the root step of the job.

SkipLastFailedStep

-

Optional

Optional

-

Edm.Boolean

True

Indicates whether to skip the last step that failed when the job is restarted.

Source

-

Optional

-

-

Edm.String

True

The source used by the job.

StartTime

-

Optional

-

-

Edm.DateTime

True

Indicates the date and time the job was started.

Status

-

Optional

-

-

Edm.String

True

Indicates whether the job status is in progress, failed, or completed.

StatusString

-

Optional

-

-

Edm.String

True

Indicates the job status.

StepsLoaded

-

Optional

-

-

Edm.Boolean

True

Indicates whether steps have been loaded for the job.

Target

-

Optional

-

-

Edm.String

True

The resource created or modified by the job.

TargetObjectID

-

Optional

-

-

Edm.Guid

True

The identifier of the target of the job.

TargetObjectType

-

Optional

-

-

Edm.String

True

The type of resource created or modified by the job.

UserName

-

Optional

Optional

-

Edm.String

True

The name of the user who attempted to restart the job.

WasNotifiedOfCancel

-

Optional

-

-

Edm.Boolean

True

Indicates whether there was a notification to cancel the job.

Relationships

None

OData Operations

None

Examples

See Also

Entities [SPFSDK][VMMREF]
Jobs Collection [SPFSDK][VMMREF]