Share via

Job interface

  • Reference
Package:
@azure/arm-mediaservices

A Job resource type. The progress and state can be obtained by polling a Job or subscribing to events using EventGrid.

Extends
ProxyResource

Properties

correlationData

Customer provided key, value pairs that will be returned in Job and JobOutput state events.
created

The UTC date and time when the customer has created the Job, in 'YYYY-MM-DDThh:mm:ssZ' format. NOTE: This property will not be serialized. It can only be populated by the server.
description

Optional customer supplied description of the Job.
endTime

The UTC date and time at which this Job finished processing. NOTE: This property will not be serialized. It can only be populated by the server.
input

The inputs for the Job.
lastModified

The UTC date and time when the customer has last updated the Job, in 'YYYY-MM-DDThh:mm:ssZ' format. NOTE: This property will not be serialized. It can only be populated by the server.
outputs

The outputs for the Job.
priority

Priority with which the job should be processed. Higher priority jobs are processed before lower priority jobs. If not set, the default is normal.
startTime

The UTC date and time at which this Job began processing. NOTE: This property will not be serialized. It can only be populated by the server.
state

The current state of the job. NOTE: This property will not be serialized. It can only be populated by the server.
systemData

The system metadata relating to this resource. NOTE: This property will not be serialized. It can only be populated by the server.

Inherited Properties

id

Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName} NOTE: This property will not be serialized. It can only be populated by the server.
name

The name of the resource NOTE: This property will not be serialized. It can only be populated by the server.
type

The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts" NOTE: This property will not be serialized. It can only be populated by the server.

Property Details

correlationData

Customer provided key, value pairs that will be returned in Job and JobOutput state events.

correlationData?: {[propertyName: string]: string}

Property Value

{[propertyName: string]: string}

created

The UTC date and time when the customer has created the Job, in 'YYYY-MM-DDThh:mm:ssZ' format. NOTE: This property will not be serialized. It can only be populated by the server.

created?: Date

Property Value

Date

description

Optional customer supplied description of the Job.

description?: string

Property Value

string

endTime

The UTC date and time at which this Job finished processing. NOTE: This property will not be serialized. It can only be populated by the server.

endTime?: Date

Property Value

Date

input

The inputs for the Job.

input?: JobInputUnion

Property Value

JobInputUnion

lastModified

The UTC date and time when the customer has last updated the Job, in 'YYYY-MM-DDThh:mm:ssZ' format. NOTE: This property will not be serialized. It can only be populated by the server.

lastModified?: Date

Property Value

Date

outputs

The outputs for the Job.

outputs?: JobOutputUnion[]

Property Value

JobOutputUnion[]

priority

Priority with which the job should be processed. Higher priority jobs are processed before lower priority jobs. If not set, the default is normal.

priority?: string

Property Value

string

startTime

The UTC date and time at which this Job began processing. NOTE: This property will not be serialized. It can only be populated by the server.

startTime?: Date

Property Value

Date

state

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

state?: string

Property Value

string

systemData

The system metadata relating to this resource. NOTE: This property will not be serialized. It can only be populated by the server.

systemData?: SystemData

Property Value

SystemData

Inherited Property Details

id

Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName} NOTE: This property will not be serialized. It can only be populated by the server.

id?: string

Property Value

string

Inherited From ProxyResource.id

name

The name of the resource NOTE: This property will not be serialized. It can only be populated by the server.

name?: string

Property Value

string

Inherited From ProxyResource.name

type

The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts" NOTE: This property will not be serialized. It can only be populated by the server.

type?: string

Property Value

string

Inherited From ProxyResource.type