Share via

Job Class

  • Reference

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

Variables are only populated by the server, and will be ignored when sending a request.

Inheritance
azure.mgmt.media.models._models_py3.ProxyResource
Job

Constructor

Job(*, description: str | None = None, input: _models.JobInput | None = None, outputs: List[_models.JobOutput] | None = None, priority: str | _models.Priority | None = None, correlation_data: Dict[str, str] | None = None, **kwargs)

Keyword-Only Parameters

Name Description
description
str

Optional customer supplied description of the Job.
input
JobInput

The inputs for the Job.
outputs
list[JobOutput]

The outputs for the Job.
priority
str or 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. Known values are: "Low", "Normal", and "High".
correlation_data
dict[str, str]

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

Variables

Name Description
id
str

Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}.
name
str

The name of the resource.
type
str

The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts".
system_data
SystemData

The system metadata relating to this resource.
created
datetime

The UTC date and time when the customer has created the Job, in 'YYYY-MM-DDThh:mm:ssZ' format.
state
str or JobState

The current state of the job. Known values are: "Canceled", "Canceling", "Error", "Finished", "Processing", "Queued", and "Scheduled".
description
str

Optional customer supplied description of the Job.
input
JobInput

The inputs for the Job.
last_modified
datetime

The UTC date and time when the customer has last updated the Job, in 'YYYY-MM-DDThh:mm:ssZ' format.
outputs
list[JobOutput]

The outputs for the Job.
priority
str or 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. Known values are: "Low", "Normal", and "High".
correlation_data
dict[str, str]

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

The UTC date and time at which this Job began processing.
end_time
datetime

The UTC date and time at which this Job finished processing.