JobPutSchema
object
Properties of the job
Show 5 propertiesHide 5 properties
correlationDatamap from strings to anyOptional
Customer provided key, value pairs that will be returned in Job and JobOutput state events.
Show value schemaHide value schema
[any key]any
descriptionstring or nullOptional<=1024 characters
The description of the Job.
inputobjectRequired
The inputs of the Job.
Show 2 variantsHide 2 variants
Discriminated by @odata.type. Select one variant:
#Microsoft.Media.JobInputAssetobjectJobInputAsset
@odata.typestringRequired
The discriminator for derived types.
assetNamestringRequired
The name of the input Asset
endobjectOptional
Defines a point on the timeline of the input media at which processing will end. Defaults to the end of the input media.
Show 2 variantsHide 2 variants
Discriminated by @odata.type. Select one variant:
#Microsoft.Media.AbsoluteClipTimeobjectAbsoluteClipTime
@odata.typestringRequired
The discriminator for derived types.
timestringOptionalpattern: ^P(?:(?P<years>\d+)Y)?(?:(?P<months>\d+)M)?(?:(?P<weeks>\d+)W)?(?:(?P<days>\d+)D)?T(?:(?P<hours>\d+)H)?(?:(?P<minutes>\d+)M)?(?:(?P<seconds_fract>(?:\d*.)?\d+)S)?$
The time position on the timeline of the input media. Specified as an ISO8601 period. e.g PT30S for 30 seconds.
#Microsoft.Media.UtcClipTimeobjectUtcClipTime
@odata.typestringRequired
The discriminator for derived types.
timestringOptionalformat: date-time
The time position on the timeline of the input media based on UTC time.
SCTE-35 signal trigger. Recording starts/stops at the first matching signal.
Show 3 propertiesHide 3 properties
filterslist of list of mapssOptional
Outer array is OR-combined; each inner array is AND-combined field matchers.
Show value schemaHide value schema
[any key]any
Bounds the signal search to [anchor+startOffset, anchor+endOffset]. Anchor is
time if present, else dispatch_time (start) or resolved_start (end).Show 2 propertiesHide 2 properties
endOffsetstringRequired
Closes the signal-search window relative to the anchor (ISO 8601 Duration, e.g. "PT2M").
startOffsetstringRequired
Opens the signal-search window relative to the anchor (ISO 8601 Duration; negative allowed, e.g. "-PT5M").
signalTypeenumRequired
Signal type.
Allowed values:SCTE35
fileslist of stringsOptional
List of files.
labelstringOptional
A label that is assigned to a JobInputClip
startobjectOptional
Defines a point on the timeline of the input media at which processing will start. Defaults to the beginning of the input media.
Show 2 variantsHide 2 variants
Discriminated by @odata.type. Select one variant:
#Microsoft.Media.AbsoluteClipTimeobjectAbsoluteClipTime
@odata.typestringRequired
The discriminator for derived types.
timestringOptionalpattern: ^P(?:(?P<years>\d+)Y)?(?:(?P<months>\d+)M)?(?:(?P<weeks>\d+)W)?(?:(?P<days>\d+)D)?T(?:(?P<hours>\d+)H)?(?:(?P<minutes>\d+)M)?(?:(?P<seconds_fract>(?:\d*.)?\d+)S)?$
The time position on the timeline of the input media. Specified as an ISO8601 period. e.g PT30S for 30 seconds.
#Microsoft.Media.UtcClipTimeobjectUtcClipTime
@odata.typestringRequired
The discriminator for derived types.
timestringOptionalformat: date-time
The time position on the timeline of the input media based on UTC time.
SCTE-35 signal trigger. Recording starts/stops at the first matching signal.
Show 3 propertiesHide 3 properties
filterslist of list of mapssOptional
Outer array is OR-combined; each inner array is AND-combined field matchers.
Show value schemaHide value schema
[any key]any
Bounds the signal search to [anchor+startOffset, anchor+endOffset]. Anchor is
time if present, else dispatch_time (start) or resolved_start (end).Show 2 propertiesHide 2 properties
endOffsetstringRequired
Closes the signal-search window relative to the anchor (ISO 8601 Duration, e.g. "PT2M").
startOffsetstringRequired
Opens the signal-search window relative to the anchor (ISO 8601 Duration; negative allowed, e.g. "-PT5M").
signalTypeenumRequired
Signal type.
Allowed values:SCTE35
#Microsoft.Media.JobInputHttpobjectJobInputHttp
@odata.typestringRequired
The discriminator for derived types.
baseUristringOptional
Base URI for HTTPS job input. It will be concatenated with provided file names. If no base uri is given, then the provided file list is assumed to be fully qualified uris.
endobjectOptional
(NOT IMPLEMENTED) Defines a point on the timeline of the input media at which processing will end. Defaults to the end of the input media.
Show 2 variantsHide 2 variants
Discriminated by @odata.type. Select one variant:
#Microsoft.Media.AbsoluteClipTimeobjectAbsoluteClipTime
@odata.typestringRequired
The discriminator for derived types.
timestringOptionalpattern: ^P(?:(?P<years>\d+)Y)?(?:(?P<months>\d+)M)?(?:(?P<weeks>\d+)W)?(?:(?P<days>\d+)D)?T(?:(?P<hours>\d+)H)?(?:(?P<minutes>\d+)M)?(?:(?P<seconds_fract>(?:\d*.)?\d+)S)?$
The time position on the timeline of the input media. Specified as an ISO8601 period. e.g PT30S for 30 seconds.
#Microsoft.Media.UtcClipTimeobjectUtcClipTime
@odata.typestringRequired
The discriminator for derived types.
timestringOptionalformat: date-time
The time position on the timeline of the input media based on UTC time.
SCTE-35 signal trigger. Recording starts/stops at the first matching signal.
Show 3 propertiesHide 3 properties
filterslist of list of mapssOptional
Outer array is OR-combined; each inner array is AND-combined field matchers.
Show value schemaHide value schema
[any key]any
Bounds the signal search to [anchor+startOffset, anchor+endOffset]. Anchor is
time if present, else dispatch_time (start) or resolved_start (end).Show 2 propertiesHide 2 properties
endOffsetstringRequired
Closes the signal-search window relative to the anchor (ISO 8601 Duration, e.g. "PT2M").
startOffsetstringRequired
Opens the signal-search window relative to the anchor (ISO 8601 Duration; negative allowed, e.g. "-PT5M").
signalTypeenumRequired
Signal type.
Allowed values:SCTE35
fileslist of stringsRequired
List of files. Required for JobInputHttp.
labelstringOptional
A label that is assigned to a JobInputClip
startobjectOptional
(NOT IMPLEMENTED) Defines a point on the timeline of the input media at which processing will start. Defaults to the beginning of the input media.
Show 2 variantsHide 2 variants
Discriminated by @odata.type. Select one variant:
#Microsoft.Media.AbsoluteClipTimeobjectAbsoluteClipTime
@odata.typestringRequired
The discriminator for derived types.
timestringOptionalpattern: ^P(?:(?P<years>\d+)Y)?(?:(?P<months>\d+)M)?(?:(?P<weeks>\d+)W)?(?:(?P<days>\d+)D)?T(?:(?P<hours>\d+)H)?(?:(?P<minutes>\d+)M)?(?:(?P<seconds_fract>(?:\d*.)?\d+)S)?$
The time position on the timeline of the input media. Specified as an ISO8601 period. e.g PT30S for 30 seconds.
#Microsoft.Media.UtcClipTimeobjectUtcClipTime
@odata.typestringRequired
The discriminator for derived types.
timestringOptionalformat: date-time
The time position on the timeline of the input media based on UTC time.
SCTE-35 signal trigger. Recording starts/stops at the first matching signal.
Show 3 propertiesHide 3 properties
filterslist of list of mapssOptional
Outer array is OR-combined; each inner array is AND-combined field matchers.
Show value schemaHide value schema
[any key]any
Bounds the signal search to [anchor+startOffset, anchor+endOffset]. Anchor is
time if present, else dispatch_time (start) or resolved_start (end).Show 2 propertiesHide 2 properties
endOffsetstringRequired
Closes the signal-search window relative to the anchor (ISO 8601 Duration, e.g. "PT2M").
startOffsetstringRequired
Opens the signal-search window relative to the anchor (ISO 8601 Duration; negative allowed, e.g. "-PT5M").
signalTypeenumRequired
Signal type.
Allowed values:SCTE35
outputslist of objectsRequired
The outputs for the Job.
Show 1 variantHide 1 variant
Discriminated by @odata.type. Select one variant:
#Microsoft.Media.JobOutputAssetobjectJobOutputAsset
@odata.typestringRequired
The discriminator for derived types.
assetNamestringRequired
The name of the output Asset
endTimestring or nullOptional
The UTC date and time at which this Output finished processing.
Details of the Job Output if it is in error state.
Show 4 propertiesHide 4 properties
categoryenumOptional
Allowed values:AccountConfigurationContentDownloadServiceUpload
codeenumOptional
Allowed values:ConfigurationUnsupportedContentMalformedContentUnsupportedDownloadNotAccessibleDownloadTransientErrorIdentityUnsupportedServiceErrorServiceTransientErrorUploadNotAccessibleUploadTransientError
messagestringOptional
retryenumOptional
Allowed values:DoNotRetryMayRetry
labelstringOptional
A label that is assigned to a JobOutput in order to help uniquely identify it.
progressinteger or nullOptionalDefaults to 0
If the JobOutput is in a Processing state, this contains the Job completion percentage. The value is an estimate and not intended to be used to predict Job completion times.
startTimestring or nullOptional
The UTC date and time at which this Output began processing.
stateenum or nullOptionalDefaults to Queued
The current state of the job.
Allowed values:CanceledCancelingErrorFinishedProcessingQueuedScheduled
priorityenumOptionalDefaults to Normal
Priority with which the job should be processed. Higher priority jobs are processed before lower priority jobs. If not set, the default is normal.
Allowed values:HighLowNormal