Microsoft.Media (preview:2022-05-01)

2025/05/26 • 11 deleted methods

Transforms_List (removed)
Description :  Lists the Transforms in the account.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Media/mediaServices/{accountName}/transforms
{
subscriptionId:
{
Description: The unique identifier for a Microsoft Azure subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group within the Azure subscription. ,
Required: True ,
}
string ,
accountName:
{
Description: The Media Services account name. ,
Required: True ,
}
string ,
api-version:
{
Description: The version of the API to be used with the client request. ,
Required: True ,
}
string ,
$filter:
{
Description: Restricts the set of items returned. ,
Required: False ,
}
string ,
$orderby:
{
Description: Specifies the key by which the result collection should be ordered. ,
Required: False ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: A collection of Transform items. ,
Required: False ,
}
[
{
properties:
{
Description: The resource properties. ,
Required: False ,
}
{
created:
{
Description: The UTC date and time when the Transform was created, in 'YYYY-MM-DDThh:mm:ssZ' format. ,
Format: date-time ,
Required: False ,
}
string ,
description:
{
Description: An optional verbose description of the Transform. ,
Required: False ,
}
string ,
lastModified:
{
Description: The UTC date and time when the Transform was last updated, in 'YYYY-MM-DDThh:mm:ssZ' format. ,
Format: date-time ,
Required: False ,
}
string ,
outputs:
{
Description: An array of one or more TransformOutputs that the Transform should generate. ,
Required: True ,
}
[
{
onError:
{
Description: A Transform can define more than one outputs. This property defines what the service should do when one output fails - either continue to produce other outputs, or, stop the other outputs. The overall Job state will not reflect failures of outputs that are specified with 'ContinueJob'. The default is 'StopProcessingJob'. ,
Enum:
{
StopProcessingJob: Tells the service that if this TransformOutput fails, then any other incomplete TransformOutputs can be stopped. ,
ContinueJob: Tells the service that if this TransformOutput fails, then allow any other TransformOutput to continue. ,
}
,
Required: False ,
}
enum ,
relativePriority:
{
Description: Sets the relative priority of the TransformOutputs within a Transform. This sets the priority that the service uses for processing TransformOutputs. The default priority is Normal. ,
Enum:
{
Low: Used for TransformOutputs that can be generated after Normal and High priority TransformOutputs. ,
Normal: Used for TransformOutputs that can be generated at Normal priority. ,
High: Used for TransformOutputs that should take precedence over others. ,
}
,
Required: False ,
}
enum ,
preset:
{
Description: Preset that describes the operations that will be used to modify, transcode, or extract insights from the source file to generate the output. ,
Required: True ,
}
{
@odata.type:
{
Description: The discriminator for derived types. ,
Required: True ,
}
string ,
}
,
}
,
]
,
}
,
systemData:
{
Description: The system metadata relating to this resource. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}
,
]
,
@odata.nextLink:
{
Description: A link to the next page of the collection (when the collection contains too many results to return in one response). ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
Transforms_Get (removed)
Description :  Gets a Transform.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Media/mediaServices/{accountName}/transforms/{transformName}
{
subscriptionId:
{
Description: The unique identifier for a Microsoft Azure subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group within the Azure subscription. ,
Required: True ,
}
string ,
accountName:
{
Description: The Media Services account name. ,
Required: True ,
}
string ,
transformName:
{
Description: The Transform name. ,
Required: True ,
}
string ,
api-version:
{
Description: The version of the API to be used with the client request. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: The resource properties. ,
Required: False ,
}
{
created:
{
Description: The UTC date and time when the Transform was created, in 'YYYY-MM-DDThh:mm:ssZ' format. ,
Format: date-time ,
Required: False ,
}
string ,
description:
{
Description: An optional verbose description of the Transform. ,
Required: False ,
}
string ,
lastModified:
{
Description: The UTC date and time when the Transform was last updated, in 'YYYY-MM-DDThh:mm:ssZ' format. ,
Format: date-time ,
Required: False ,
}
string ,
outputs:
{
Description: An array of one or more TransformOutputs that the Transform should generate. ,
Required: True ,
}
[
{
onError:
{
Description: A Transform can define more than one outputs. This property defines what the service should do when one output fails - either continue to produce other outputs, or, stop the other outputs. The overall Job state will not reflect failures of outputs that are specified with 'ContinueJob'. The default is 'StopProcessingJob'. ,
Enum:
{
StopProcessingJob: Tells the service that if this TransformOutput fails, then any other incomplete TransformOutputs can be stopped. ,
ContinueJob: Tells the service that if this TransformOutput fails, then allow any other TransformOutput to continue. ,
}
,
Required: False ,
}
enum ,
relativePriority:
{
Description: Sets the relative priority of the TransformOutputs within a Transform. This sets the priority that the service uses for processing TransformOutputs. The default priority is Normal. ,
Enum:
{
Low: Used for TransformOutputs that can be generated after Normal and High priority TransformOutputs. ,
Normal: Used for TransformOutputs that can be generated at Normal priority. ,
High: Used for TransformOutputs that should take precedence over others. ,
}
,
Required: False ,
}
enum ,
preset:
{
Description: Preset that describes the operations that will be used to modify, transcode, or extract insights from the source file to generate the output. ,
Required: True ,
}
{
@odata.type:
{
Description: The discriminator for derived types. ,
Required: True ,
}
string ,
}
,
}
,
]
,
}
,
systemData:
{
Description: The system metadata relating to this resource. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
Transforms_CreateOrUpdate (removed)
Description :  Creates or updates a new Transform.
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Media/mediaServices/{accountName}/transforms/{transformName}
{
subscriptionId:
{
Description: The unique identifier for a Microsoft Azure subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group within the Azure subscription. ,
Required: True ,
}
string ,
accountName:
{
Description: The Media Services account name. ,
Required: True ,
}
string ,
transformName:
{
Description: The Transform name. ,
Required: True ,
}
string ,
parameters:
{
Description: The request parameters ,
Required: True ,
}
{
properties:
{
Description: The resource properties. ,
Required: False ,
}
{
created:
{
Description: The UTC date and time when the Transform was created, in 'YYYY-MM-DDThh:mm:ssZ' format. ,
Format: date-time ,
Required: False ,
}
string ,
description:
{
Description: An optional verbose description of the Transform. ,
Required: False ,
}
string ,
lastModified:
{
Description: The UTC date and time when the Transform was last updated, in 'YYYY-MM-DDThh:mm:ssZ' format. ,
Format: date-time ,
Required: False ,
}
string ,
outputs:
{
Description: An array of one or more TransformOutputs that the Transform should generate. ,
Required: True ,
}
[
{
onError:
{
Description: A Transform can define more than one outputs. This property defines what the service should do when one output fails - either continue to produce other outputs, or, stop the other outputs. The overall Job state will not reflect failures of outputs that are specified with 'ContinueJob'. The default is 'StopProcessingJob'. ,
Enum:
{
StopProcessingJob: Tells the service that if this TransformOutput fails, then any other incomplete TransformOutputs can be stopped. ,
ContinueJob: Tells the service that if this TransformOutput fails, then allow any other TransformOutput to continue. ,
}
,
Required: False ,
}
enum ,
relativePriority:
{
Description: Sets the relative priority of the TransformOutputs within a Transform. This sets the priority that the service uses for processing TransformOutputs. The default priority is Normal. ,
Enum:
{
Low: Used for TransformOutputs that can be generated after Normal and High priority TransformOutputs. ,
Normal: Used for TransformOutputs that can be generated at Normal priority. ,
High: Used for TransformOutputs that should take precedence over others. ,
}
,
Required: False ,
}
enum ,
preset:
{
Description: Preset that describes the operations that will be used to modify, transcode, or extract insights from the source file to generate the output. ,
Required: True ,
}
{
@odata.type:
{
Description: The discriminator for derived types. ,
Required: True ,
}
string ,
}
,
}
,
]
,
}
,
systemData:
{
Description: The system metadata relating to this resource. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}
,
api-version:
{
Description: The version of the API to be used with the client request. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: The resource properties. ,
Required: False ,
}
{
created:
{
Description: The UTC date and time when the Transform was created, in 'YYYY-MM-DDThh:mm:ssZ' format. ,
Format: date-time ,
Required: False ,
}
string ,
description:
{
Description: An optional verbose description of the Transform. ,
Required: False ,
}
string ,
lastModified:
{
Description: The UTC date and time when the Transform was last updated, in 'YYYY-MM-DDThh:mm:ssZ' format. ,
Format: date-time ,
Required: False ,
}
string ,
outputs:
{
Description: An array of one or more TransformOutputs that the Transform should generate. ,
Required: True ,
}
[
{
onError:
{
Description: A Transform can define more than one outputs. This property defines what the service should do when one output fails - either continue to produce other outputs, or, stop the other outputs. The overall Job state will not reflect failures of outputs that are specified with 'ContinueJob'. The default is 'StopProcessingJob'. ,
Enum:
{
StopProcessingJob: Tells the service that if this TransformOutput fails, then any other incomplete TransformOutputs can be stopped. ,
ContinueJob: Tells the service that if this TransformOutput fails, then allow any other TransformOutput to continue. ,
}
,
Required: False ,
}
enum ,
relativePriority:
{
Description: Sets the relative priority of the TransformOutputs within a Transform. This sets the priority that the service uses for processing TransformOutputs. The default priority is Normal. ,
Enum:
{
Low: Used for TransformOutputs that can be generated after Normal and High priority TransformOutputs. ,
Normal: Used for TransformOutputs that can be generated at Normal priority. ,
High: Used for TransformOutputs that should take precedence over others. ,
}
,
Required: False ,
}
enum ,
preset:
{
Description: Preset that describes the operations that will be used to modify, transcode, or extract insights from the source file to generate the output. ,
Required: True ,
}
{
@odata.type:
{
Description: The discriminator for derived types. ,
Required: True ,
}
string ,
}
,
}
,
]
,
}
,
systemData:
{
Description: The system metadata relating to this resource. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}

⚐ Response (201)

{
properties:
{
Description: The resource properties. ,
Required: False ,
}
{
created:
{
Description: The UTC date and time when the Transform was created, in 'YYYY-MM-DDThh:mm:ssZ' format. ,
Format: date-time ,
Required: False ,
}
string ,
description:
{
Description: An optional verbose description of the Transform. ,
Required: False ,
}
string ,
lastModified:
{
Description: The UTC date and time when the Transform was last updated, in 'YYYY-MM-DDThh:mm:ssZ' format. ,
Format: date-time ,
Required: False ,
}
string ,
outputs:
{
Description: An array of one or more TransformOutputs that the Transform should generate. ,
Required: True ,
}
[
{
onError:
{
Description: A Transform can define more than one outputs. This property defines what the service should do when one output fails - either continue to produce other outputs, or, stop the other outputs. The overall Job state will not reflect failures of outputs that are specified with 'ContinueJob'. The default is 'StopProcessingJob'. ,
Enum:
{
StopProcessingJob: Tells the service that if this TransformOutput fails, then any other incomplete TransformOutputs can be stopped. ,
ContinueJob: Tells the service that if this TransformOutput fails, then allow any other TransformOutput to continue. ,
}
,
Required: False ,
}
enum ,
relativePriority:
{
Description: Sets the relative priority of the TransformOutputs within a Transform. This sets the priority that the service uses for processing TransformOutputs. The default priority is Normal. ,
Enum:
{
Low: Used for TransformOutputs that can be generated after Normal and High priority TransformOutputs. ,
Normal: Used for TransformOutputs that can be generated at Normal priority. ,
High: Used for TransformOutputs that should take precedence over others. ,
}
,
Required: False ,
}
enum ,
preset:
{
Description: Preset that describes the operations that will be used to modify, transcode, or extract insights from the source file to generate the output. ,
Required: True ,
}
{
@odata.type:
{
Description: The discriminator for derived types. ,
Required: True ,
}
string ,
}
,
}
,
]
,
}
,
systemData:
{
Description: The system metadata relating to this resource. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
Transforms_Delete (removed)
Description :  Deletes a Transform.
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Media/mediaServices/{accountName}/transforms/{transformName}
{
subscriptionId:
{
Description: The unique identifier for a Microsoft Azure subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group within the Azure subscription. ,
Required: True ,
}
string ,
accountName:
{
Description: The Media Services account name. ,
Required: True ,
}
string ,
transformName:
{
Description: The Transform name. ,
Required: True ,
}
string ,
api-version:
{
Description: The version of the API to be used with the client request. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{}

⚐ Response (204)

{}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
Transforms_Update (removed)
Description :  Updates a Transform.
Reference :  Link ¶

⚼ Request

PATCH:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Media/mediaServices/{accountName}/transforms/{transformName}
{
subscriptionId:
{
Description: The unique identifier for a Microsoft Azure subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group within the Azure subscription. ,
Required: True ,
}
string ,
accountName:
{
Description: The Media Services account name. ,
Required: True ,
}
string ,
transformName:
{
Description: The Transform name. ,
Required: True ,
}
string ,
parameters:
{
Description: The request parameters ,
Required: True ,
}
{
properties:
{
Description: The resource properties. ,
Required: False ,
}
{
created:
{
Description: The UTC date and time when the Transform was created, in 'YYYY-MM-DDThh:mm:ssZ' format. ,
Format: date-time ,
Required: False ,
}
string ,
description:
{
Description: An optional verbose description of the Transform. ,
Required: False ,
}
string ,
lastModified:
{
Description: The UTC date and time when the Transform was last updated, in 'YYYY-MM-DDThh:mm:ssZ' format. ,
Format: date-time ,
Required: False ,
}
string ,
outputs:
{
Description: An array of one or more TransformOutputs that the Transform should generate. ,
Required: True ,
}
[
{
onError:
{
Description: A Transform can define more than one outputs. This property defines what the service should do when one output fails - either continue to produce other outputs, or, stop the other outputs. The overall Job state will not reflect failures of outputs that are specified with 'ContinueJob'. The default is 'StopProcessingJob'. ,
Enum:
{
StopProcessingJob: Tells the service that if this TransformOutput fails, then any other incomplete TransformOutputs can be stopped. ,
ContinueJob: Tells the service that if this TransformOutput fails, then allow any other TransformOutput to continue. ,
}
,
Required: False ,
}
enum ,
relativePriority:
{
Description: Sets the relative priority of the TransformOutputs within a Transform. This sets the priority that the service uses for processing TransformOutputs. The default priority is Normal. ,
Enum:
{
Low: Used for TransformOutputs that can be generated after Normal and High priority TransformOutputs. ,
Normal: Used for TransformOutputs that can be generated at Normal priority. ,
High: Used for TransformOutputs that should take precedence over others. ,
}
,
Required: False ,
}
enum ,
preset:
{
Description: Preset that describes the operations that will be used to modify, transcode, or extract insights from the source file to generate the output. ,
Required: True ,
}
{
@odata.type:
{
Description: The discriminator for derived types. ,
Required: True ,
}
string ,
}
,
}
,
]
,
}
,
systemData:
{
Description: The system metadata relating to this resource. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}
,
api-version:
{
Description: The version of the API to be used with the client request. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: The resource properties. ,
Required: False ,
}
{
created:
{
Description: The UTC date and time when the Transform was created, in 'YYYY-MM-DDThh:mm:ssZ' format. ,
Format: date-time ,
Required: False ,
}
string ,
description:
{
Description: An optional verbose description of the Transform. ,
Required: False ,
}
string ,
lastModified:
{
Description: The UTC date and time when the Transform was last updated, in 'YYYY-MM-DDThh:mm:ssZ' format. ,
Format: date-time ,
Required: False ,
}
string ,
outputs:
{
Description: An array of one or more TransformOutputs that the Transform should generate. ,
Required: True ,
}
[
{
onError:
{
Description: A Transform can define more than one outputs. This property defines what the service should do when one output fails - either continue to produce other outputs, or, stop the other outputs. The overall Job state will not reflect failures of outputs that are specified with 'ContinueJob'. The default is 'StopProcessingJob'. ,
Enum:
{
StopProcessingJob: Tells the service that if this TransformOutput fails, then any other incomplete TransformOutputs can be stopped. ,
ContinueJob: Tells the service that if this TransformOutput fails, then allow any other TransformOutput to continue. ,
}
,
Required: False ,
}
enum ,
relativePriority:
{
Description: Sets the relative priority of the TransformOutputs within a Transform. This sets the priority that the service uses for processing TransformOutputs. The default priority is Normal. ,
Enum:
{
Low: Used for TransformOutputs that can be generated after Normal and High priority TransformOutputs. ,
Normal: Used for TransformOutputs that can be generated at Normal priority. ,
High: Used for TransformOutputs that should take precedence over others. ,
}
,
Required: False ,
}
enum ,
preset:
{
Description: Preset that describes the operations that will be used to modify, transcode, or extract insights from the source file to generate the output. ,
Required: True ,
}
{
@odata.type:
{
Description: The discriminator for derived types. ,
Required: True ,
}
string ,
}
,
}
,
]
,
}
,
systemData:
{
Description: The system metadata relating to this resource. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
Jobs_List (removed)
Description :  Lists all of the Jobs for the Transform.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Media/mediaServices/{accountName}/transforms/{transformName}/jobs
{
subscriptionId:
{
Description: The unique identifier for a Microsoft Azure subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group within the Azure subscription. ,
Required: True ,
}
string ,
accountName:
{
Description: The Media Services account name. ,
Required: True ,
}
string ,
transformName:
{
Description: The Transform name. ,
Required: True ,
}
string ,
api-version:
{
Description: The version of the API to be used with the client request. ,
Required: True ,
}
string ,
$filter:
{
Description: Restricts the set of items returned. ,
Required: False ,
}
string ,
$orderby:
{
Description: Specifies the key by which the result collection should be ordered. ,
Required: False ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: A collection of Job items. ,
Required: False ,
}
[
{
properties:
{
Description: The resource properties. ,
Required: False ,
}
{
created:
{
Description: The UTC date and time when the customer has created the Job, in 'YYYY-MM-DDThh:mm:ssZ' format. ,
Format: date-time ,
Required: False ,
}
string ,
state:
{
Description: The current state of the job. ,
Enum:
{
Canceled: The job was canceled. This is a final state for the job. ,
Canceling: The job is in the process of being canceled. This is a transient state for the job. ,
Error: The job has encountered an error. This is a final state for the job. ,
Finished: The job is finished. This is a final state for the job. ,
Processing: The job is processing. This is a transient state for the job. ,
Queued: The job is in a queued state, waiting for resources to become available. This is a transient state. ,
Scheduled: The job is being scheduled to run on an available resource. This is a transient state, between queued and processing states. ,
}
,
Required: False ,
}
enum ,
description:
{
Description: Optional customer supplied description of the Job. ,
Required: False ,
}
string ,
input:
{
Description: The inputs for the Job. ,
Required: True ,
}
{
@odata.type:
{
Description: The discriminator for derived types. ,
Required: True ,
}
string ,
}
,
lastModified:
{
Description: The UTC date and time when the customer has last updated the Job, in 'YYYY-MM-DDThh:mm:ssZ' format. ,
Format: date-time ,
Required: False ,
}
string ,
outputs:
{
Description: The outputs for the Job. ,
Required: True ,
}
[
{
@odata.type:
{
Description: The discriminator for derived types. ,
Required: True ,
}
string ,
error:
{
Description: If the JobOutput is in the Error state, it contains the details of the error. ,
Required: False ,
}
{
code:
{
Description: Error code describing the error. ,
Enum:
{
ServiceError: Fatal service error, please contact support. ,
ServiceTransientError: Transient error, please retry, if retry is unsuccessful, please contact support. ,
DownloadNotAccessible: While trying to download the input files, the files were not accessible, please check the availability of the source. ,
DownloadTransientError: While trying to download the input files, there was an issue during transfer (storage service, network errors), see details and check your source. ,
UploadNotAccessible: While trying to upload the output files, the destination was not reachable, please check the availability of the destination. ,
UploadTransientError: While trying to upload the output files, there was an issue during transfer (storage service, network errors), see details and check your destination. ,
ConfigurationUnsupported: There was a problem with the combination of input files and the configuration settings applied, fix the configuration settings and retry with the same input, or change input to match the configuration. ,
ContentMalformed: There was a problem with the input content (for example: zero byte files, or corrupt/non-decodable files), check the input files. ,
ContentUnsupported: There was a problem with the format of the input (not valid media file, or an unsupported file/codec), check the validity of the input files. ,
IdentityUnsupported: There was an error verifying to the account identity. Check and fix the identity configurations and retry. If unsuccessful, please contact support. ,
}
,
Required: False ,
}
enum ,
message:
{
Description: A human-readable language-dependent representation of the error. ,
Required: False ,
}
string ,
category:
{
Description: Helps with categorization of errors. ,
Enum:
{
Service: The error is service related. ,
Download: The error is download related. ,
Upload: The error is upload related. ,
Configuration: The error is configuration related. ,
Content: The error is related to data in the input files. ,
Account: The error is related to account information. ,
}
,
Required: False ,
}
enum ,
retry:
{
Description: Indicates that it may be possible to retry the Job. If retry is unsuccessful, please contact Azure support via Azure Portal. ,
Enum:
{
DoNotRetry: Issue needs to be investigated and then the job resubmitted with corrections or retried once the underlying issue has been corrected. ,
MayRetry: Issue may be resolved after waiting for a period of time and resubmitting the same Job. ,
}
,
Required: False ,
}
enum ,
details:
{
Description: An array of details about specific errors that led to this reported error. ,
Required: False ,
}
[
{
code:
{
Description: Code describing the error detail. ,
Required: False ,
}
string ,
message:
{
Description: A human-readable representation of the error. ,
Required: False ,
}
string ,
}
,
]
,
}
,
presetOverride:
{
Description: A preset used to override the preset in the corresponding transform output. ,
Required: False ,
}
{
@odata.type:
{
Description: The discriminator for derived types. ,
Required: True ,
}
string ,
}
,
state:
{
Description: Describes the state of the JobOutput. ,
Enum:
{
Canceled: The job was canceled. This is a final state for the job. ,
Canceling: The job is in the process of being canceled. This is a transient state for the job. ,
Error: The job has encountered an error. This is a final state for the job. ,
Finished: The job is finished. This is a final state for the job. ,
Processing: The job is processing. This is a transient state for the job. ,
Queued: The job is in a queued state, waiting for resources to become available. This is a transient state. ,
Scheduled: The job is being scheduled to run on an available resource. This is a transient state, between queued and processing states. ,
}
,
Required: False ,
}
enum ,
progress:
{
Description: 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. To determine if the JobOutput is complete, use the State property. ,
Format: int32 ,
Required: False ,
}
integer ,
label:
{
Description: A label that is assigned to a JobOutput in order to help uniquely identify it. This is useful when your Transform has more than one TransformOutput, whereby your Job has more than one JobOutput. In such cases, when you submit the Job, you will add two or more JobOutputs, in the same order as TransformOutputs in the Transform. Subsequently, when you retrieve the Job, either through events or on a GET request, you can use the label to easily identify the JobOutput. If a label is not provided, a default value of '{presetName}_{outputIndex}' will be used, where the preset name is the name of the preset in the corresponding TransformOutput and the output index is the relative index of the this JobOutput within the Job. Note that this index is the same as the relative index of the corresponding TransformOutput within its Transform. ,
Required: False ,
}
string ,
startTime:
{
Description: The UTC date and time at which this Job Output began processing. ,
Format: date-time ,
Required: False ,
}
string ,
endTime:
{
Description: The UTC date and time at which this Job Output finished processing. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
]
,
priority:
{
Description: Priority with which the job should be processed. Higher priority jobs are processed before lower priority jobs. If not set, the default is normal. ,
Enum:
{
Low: Used for TransformOutputs that can be generated after Normal and High priority TransformOutputs. ,
Normal: Used for TransformOutputs that can be generated at Normal priority. ,
High: Used for TransformOutputs that should take precedence over others. ,
}
,
Required: False ,
}
enum ,
correlationData:
{
Description: Customer provided key, value pairs that will be returned in Job and JobOutput state events. ,
Required: False ,
}
object ,
startTime:
{
Description: The UTC date and time at which this Job began processing. ,
Format: date-time ,
Required: False ,
}
string ,
endTime:
{
Description: The UTC date and time at which this Job finished processing. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
systemData:
{
Description: The system metadata relating to this resource. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}
,
]
,
@odata.nextLink:
{
Description: A link to the next page of the collection (when the collection contains too many results to return in one response). ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
Jobs_Get (removed)
Description :  Gets a Job.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Media/mediaServices/{accountName}/transforms/{transformName}/jobs/{jobName}
{
subscriptionId:
{
Description: The unique identifier for a Microsoft Azure subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group within the Azure subscription. ,
Required: True ,
}
string ,
accountName:
{
Description: The Media Services account name. ,
Required: True ,
}
string ,
transformName:
{
Description: The Transform name. ,
Required: True ,
}
string ,
jobName:
{
Description: The Job name. ,
Required: True ,
}
string ,
api-version:
{
Description: The version of the API to be used with the client request. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: The resource properties. ,
Required: False ,
}
{
created:
{
Description: The UTC date and time when the customer has created the Job, in 'YYYY-MM-DDThh:mm:ssZ' format. ,
Format: date-time ,
Required: False ,
}
string ,
state:
{
Description: The current state of the job. ,
Enum:
{
Canceled: The job was canceled. This is a final state for the job. ,
Canceling: The job is in the process of being canceled. This is a transient state for the job. ,
Error: The job has encountered an error. This is a final state for the job. ,
Finished: The job is finished. This is a final state for the job. ,
Processing: The job is processing. This is a transient state for the job. ,
Queued: The job is in a queued state, waiting for resources to become available. This is a transient state. ,
Scheduled: The job is being scheduled to run on an available resource. This is a transient state, between queued and processing states. ,
}
,
Required: False ,
}
enum ,
description:
{
Description: Optional customer supplied description of the Job. ,
Required: False ,
}
string ,
input:
{
Description: The inputs for the Job. ,
Required: True ,
}
{
@odata.type:
{
Description: The discriminator for derived types. ,
Required: True ,
}
string ,
}
,
lastModified:
{
Description: The UTC date and time when the customer has last updated the Job, in 'YYYY-MM-DDThh:mm:ssZ' format. ,
Format: date-time ,
Required: False ,
}
string ,
outputs:
{
Description: The outputs for the Job. ,
Required: True ,
}
[
{
@odata.type:
{
Description: The discriminator for derived types. ,
Required: True ,
}
string ,
error:
{
Description: If the JobOutput is in the Error state, it contains the details of the error. ,
Required: False ,
}
{
code:
{
Description: Error code describing the error. ,
Enum:
{
ServiceError: Fatal service error, please contact support. ,
ServiceTransientError: Transient error, please retry, if retry is unsuccessful, please contact support. ,
DownloadNotAccessible: While trying to download the input files, the files were not accessible, please check the availability of the source. ,
DownloadTransientError: While trying to download the input files, there was an issue during transfer (storage service, network errors), see details and check your source. ,
UploadNotAccessible: While trying to upload the output files, the destination was not reachable, please check the availability of the destination. ,
UploadTransientError: While trying to upload the output files, there was an issue during transfer (storage service, network errors), see details and check your destination. ,
ConfigurationUnsupported: There was a problem with the combination of input files and the configuration settings applied, fix the configuration settings and retry with the same input, or change input to match the configuration. ,
ContentMalformed: There was a problem with the input content (for example: zero byte files, or corrupt/non-decodable files), check the input files. ,
ContentUnsupported: There was a problem with the format of the input (not valid media file, or an unsupported file/codec), check the validity of the input files. ,
IdentityUnsupported: There was an error verifying to the account identity. Check and fix the identity configurations and retry. If unsuccessful, please contact support. ,
}
,
Required: False ,
}
enum ,
message:
{
Description: A human-readable language-dependent representation of the error. ,
Required: False ,
}
string ,
category:
{
Description: Helps with categorization of errors. ,
Enum:
{
Service: The error is service related. ,
Download: The error is download related. ,
Upload: The error is upload related. ,
Configuration: The error is configuration related. ,
Content: The error is related to data in the input files. ,
Account: The error is related to account information. ,
}
,
Required: False ,
}
enum ,
retry:
{
Description: Indicates that it may be possible to retry the Job. If retry is unsuccessful, please contact Azure support via Azure Portal. ,
Enum:
{
DoNotRetry: Issue needs to be investigated and then the job resubmitted with corrections or retried once the underlying issue has been corrected. ,
MayRetry: Issue may be resolved after waiting for a period of time and resubmitting the same Job. ,
}
,
Required: False ,
}
enum ,
details:
{
Description: An array of details about specific errors that led to this reported error. ,
Required: False ,
}
[
{
code:
{
Description: Code describing the error detail. ,
Required: False ,
}
string ,
message:
{
Description: A human-readable representation of the error. ,
Required: False ,
}
string ,
}
,
]
,
}
,
presetOverride:
{
Description: A preset used to override the preset in the corresponding transform output. ,
Required: False ,
}
{
@odata.type:
{
Description: The discriminator for derived types. ,
Required: True ,
}
string ,
}
,
state:
{
Description: Describes the state of the JobOutput. ,
Enum:
{
Canceled: The job was canceled. This is a final state for the job. ,
Canceling: The job is in the process of being canceled. This is a transient state for the job. ,
Error: The job has encountered an error. This is a final state for the job. ,
Finished: The job is finished. This is a final state for the job. ,
Processing: The job is processing. This is a transient state for the job. ,
Queued: The job is in a queued state, waiting for resources to become available. This is a transient state. ,
Scheduled: The job is being scheduled to run on an available resource. This is a transient state, between queued and processing states. ,
}
,
Required: False ,
}
enum ,
progress:
{
Description: 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. To determine if the JobOutput is complete, use the State property. ,
Format: int32 ,
Required: False ,
}
integer ,
label:
{
Description: A label that is assigned to a JobOutput in order to help uniquely identify it. This is useful when your Transform has more than one TransformOutput, whereby your Job has more than one JobOutput. In such cases, when you submit the Job, you will add two or more JobOutputs, in the same order as TransformOutputs in the Transform. Subsequently, when you retrieve the Job, either through events or on a GET request, you can use the label to easily identify the JobOutput. If a label is not provided, a default value of '{presetName}_{outputIndex}' will be used, where the preset name is the name of the preset in the corresponding TransformOutput and the output index is the relative index of the this JobOutput within the Job. Note that this index is the same as the relative index of the corresponding TransformOutput within its Transform. ,
Required: False ,
}
string ,
startTime:
{
Description: The UTC date and time at which this Job Output began processing. ,
Format: date-time ,
Required: False ,
}
string ,
endTime:
{
Description: The UTC date and time at which this Job Output finished processing. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
]
,
priority:
{
Description: Priority with which the job should be processed. Higher priority jobs are processed before lower priority jobs. If not set, the default is normal. ,
Enum:
{
Low: Used for TransformOutputs that can be generated after Normal and High priority TransformOutputs. ,
Normal: Used for TransformOutputs that can be generated at Normal priority. ,
High: Used for TransformOutputs that should take precedence over others. ,
}
,
Required: False ,
}
enum ,
correlationData:
{
Description: Customer provided key, value pairs that will be returned in Job and JobOutput state events. ,
Required: False ,
}
object ,
startTime:
{
Description: The UTC date and time at which this Job began processing. ,
Format: date-time ,
Required: False ,
}
string ,
endTime:
{
Description: The UTC date and time at which this Job finished processing. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
systemData:
{
Description: The system metadata relating to this resource. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
Jobs_Create (removed)
Description :  Creates a Job.
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Media/mediaServices/{accountName}/transforms/{transformName}/jobs/{jobName}
{
subscriptionId:
{
Description: The unique identifier for a Microsoft Azure subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group within the Azure subscription. ,
Required: True ,
}
string ,
accountName:
{
Description: The Media Services account name. ,
Required: True ,
}
string ,
transformName:
{
Description: The Transform name. ,
Required: True ,
}
string ,
jobName:
{
Description: The Job name. ,
Required: True ,
}
string ,
parameters:
{
Description: The request parameters ,
Required: True ,
}
{
properties:
{
Description: The resource properties. ,
Required: False ,
}
{
created:
{
Description: The UTC date and time when the customer has created the Job, in 'YYYY-MM-DDThh:mm:ssZ' format. ,
Format: date-time ,
Required: False ,
}
string ,
state:
{
Description: The current state of the job. ,
Enum:
{
Canceled: The job was canceled. This is a final state for the job. ,
Canceling: The job is in the process of being canceled. This is a transient state for the job. ,
Error: The job has encountered an error. This is a final state for the job. ,
Finished: The job is finished. This is a final state for the job. ,
Processing: The job is processing. This is a transient state for the job. ,
Queued: The job is in a queued state, waiting for resources to become available. This is a transient state. ,
Scheduled: The job is being scheduled to run on an available resource. This is a transient state, between queued and processing states. ,
}
,
Required: False ,
}
enum ,
description:
{
Description: Optional customer supplied description of the Job. ,
Required: False ,
}
string ,
input:
{
Description: The inputs for the Job. ,
Required: True ,
}
{
@odata.type:
{
Description: The discriminator for derived types. ,
Required: True ,
}
string ,
}
,
lastModified:
{
Description: The UTC date and time when the customer has last updated the Job, in 'YYYY-MM-DDThh:mm:ssZ' format. ,
Format: date-time ,
Required: False ,
}
string ,
outputs:
{
Description: The outputs for the Job. ,
Required: True ,
}
[
{
@odata.type:
{
Description: The discriminator for derived types. ,
Required: True ,
}
string ,
error:
{
Description: If the JobOutput is in the Error state, it contains the details of the error. ,
Required: False ,
}
{
code:
{
Description: Error code describing the error. ,
Enum:
{
ServiceError: Fatal service error, please contact support. ,
ServiceTransientError: Transient error, please retry, if retry is unsuccessful, please contact support. ,
DownloadNotAccessible: While trying to download the input files, the files were not accessible, please check the availability of the source. ,
DownloadTransientError: While trying to download the input files, there was an issue during transfer (storage service, network errors), see details and check your source. ,
UploadNotAccessible: While trying to upload the output files, the destination was not reachable, please check the availability of the destination. ,
UploadTransientError: While trying to upload the output files, there was an issue during transfer (storage service, network errors), see details and check your destination. ,
ConfigurationUnsupported: There was a problem with the combination of input files and the configuration settings applied, fix the configuration settings and retry with the same input, or change input to match the configuration. ,
ContentMalformed: There was a problem with the input content (for example: zero byte files, or corrupt/non-decodable files), check the input files. ,
ContentUnsupported: There was a problem with the format of the input (not valid media file, or an unsupported file/codec), check the validity of the input files. ,
IdentityUnsupported: There was an error verifying to the account identity. Check and fix the identity configurations and retry. If unsuccessful, please contact support. ,
}
,
Required: False ,
}
enum ,
message:
{
Description: A human-readable language-dependent representation of the error. ,
Required: False ,
}
string ,
category:
{
Description: Helps with categorization of errors. ,
Enum:
{
Service: The error is service related. ,
Download: The error is download related. ,
Upload: The error is upload related. ,
Configuration: The error is configuration related. ,
Content: The error is related to data in the input files. ,
Account: The error is related to account information. ,
}
,
Required: False ,
}
enum ,
retry:
{
Description: Indicates that it may be possible to retry the Job. If retry is unsuccessful, please contact Azure support via Azure Portal. ,
Enum:
{
DoNotRetry: Issue needs to be investigated and then the job resubmitted with corrections or retried once the underlying issue has been corrected. ,
MayRetry: Issue may be resolved after waiting for a period of time and resubmitting the same Job. ,
}
,
Required: False ,
}
enum ,
details:
{
Description: An array of details about specific errors that led to this reported error. ,
Required: False ,
}
[
{
code:
{
Description: Code describing the error detail. ,
Required: False ,
}
string ,
message:
{
Description: A human-readable representation of the error. ,
Required: False ,
}
string ,
}
,
]
,
}
,
presetOverride:
{
Description: A preset used to override the preset in the corresponding transform output. ,
Required: False ,
}
{
@odata.type:
{
Description: The discriminator for derived types. ,
Required: True ,
}
string ,
}
,
state:
{
Description: Describes the state of the JobOutput. ,
Enum:
{
Canceled: The job was canceled. This is a final state for the job. ,
Canceling: The job is in the process of being canceled. This is a transient state for the job. ,
Error: The job has encountered an error. This is a final state for the job. ,
Finished: The job is finished. This is a final state for the job. ,
Processing: The job is processing. This is a transient state for the job. ,
Queued: The job is in a queued state, waiting for resources to become available. This is a transient state. ,
Scheduled: The job is being scheduled to run on an available resource. This is a transient state, between queued and processing states. ,
}
,
Required: False ,
}
enum ,
progress:
{
Description: 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. To determine if the JobOutput is complete, use the State property. ,
Format: int32 ,
Required: False ,
}
integer ,
label:
{
Description: A label that is assigned to a JobOutput in order to help uniquely identify it. This is useful when your Transform has more than one TransformOutput, whereby your Job has more than one JobOutput. In such cases, when you submit the Job, you will add two or more JobOutputs, in the same order as TransformOutputs in the Transform. Subsequently, when you retrieve the Job, either through events or on a GET request, you can use the label to easily identify the JobOutput. If a label is not provided, a default value of '{presetName}_{outputIndex}' will be used, where the preset name is the name of the preset in the corresponding TransformOutput and the output index is the relative index of the this JobOutput within the Job. Note that this index is the same as the relative index of the corresponding TransformOutput within its Transform. ,
Required: False ,
}
string ,
startTime:
{
Description: The UTC date and time at which this Job Output began processing. ,
Format: date-time ,
Required: False ,
}
string ,
endTime:
{
Description: The UTC date and time at which this Job Output finished processing. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
]
,
priority:
{
Description: Priority with which the job should be processed. Higher priority jobs are processed before lower priority jobs. If not set, the default is normal. ,
Enum:
{
Low: Used for TransformOutputs that can be generated after Normal and High priority TransformOutputs. ,
Normal: Used for TransformOutputs that can be generated at Normal priority. ,
High: Used for TransformOutputs that should take precedence over others. ,
}
,
Required: False ,
}
enum ,
correlationData:
{
Description: Customer provided key, value pairs that will be returned in Job and JobOutput state events. ,
Required: False ,
}
object ,
startTime:
{
Description: The UTC date and time at which this Job began processing. ,
Format: date-time ,
Required: False ,
}
string ,
endTime:
{
Description: The UTC date and time at which this Job finished processing. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
systemData:
{
Description: The system metadata relating to this resource. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}
,
api-version:
{
Description: The version of the API to be used with the client request. ,
Required: True ,
}
string ,
}

⚐ Response (201)

{
properties:
{
Description: The resource properties. ,
Required: False ,
}
{
created:
{
Description: The UTC date and time when the customer has created the Job, in 'YYYY-MM-DDThh:mm:ssZ' format. ,
Format: date-time ,
Required: False ,
}
string ,
state:
{
Description: The current state of the job. ,
Enum:
{
Canceled: The job was canceled. This is a final state for the job. ,
Canceling: The job is in the process of being canceled. This is a transient state for the job. ,
Error: The job has encountered an error. This is a final state for the job. ,
Finished: The job is finished. This is a final state for the job. ,
Processing: The job is processing. This is a transient state for the job. ,
Queued: The job is in a queued state, waiting for resources to become available. This is a transient state. ,
Scheduled: The job is being scheduled to run on an available resource. This is a transient state, between queued and processing states. ,
}
,
Required: False ,
}
enum ,
description:
{
Description: Optional customer supplied description of the Job. ,
Required: False ,
}
string ,
input:
{
Description: The inputs for the Job. ,
Required: True ,
}
{
@odata.type:
{
Description: The discriminator for derived types. ,
Required: True ,
}
string ,
}
,
lastModified:
{
Description: The UTC date and time when the customer has last updated the Job, in 'YYYY-MM-DDThh:mm:ssZ' format. ,
Format: date-time ,
Required: False ,
}
string ,
outputs:
{
Description: The outputs for the Job. ,
Required: True ,
}
[
{
@odata.type:
{
Description: The discriminator for derived types. ,
Required: True ,
}
string ,
error:
{
Description: If the JobOutput is in the Error state, it contains the details of the error. ,
Required: False ,
}
{
code:
{
Description: Error code describing the error. ,
Enum:
{
ServiceError: Fatal service error, please contact support. ,
ServiceTransientError: Transient error, please retry, if retry is unsuccessful, please contact support. ,
DownloadNotAccessible: While trying to download the input files, the files were not accessible, please check the availability of the source. ,
DownloadTransientError: While trying to download the input files, there was an issue during transfer (storage service, network errors), see details and check your source. ,
UploadNotAccessible: While trying to upload the output files, the destination was not reachable, please check the availability of the destination. ,
UploadTransientError: While trying to upload the output files, there was an issue during transfer (storage service, network errors), see details and check your destination. ,
ConfigurationUnsupported: There was a problem with the combination of input files and the configuration settings applied, fix the configuration settings and retry with the same input, or change input to match the configuration. ,
ContentMalformed: There was a problem with the input content (for example: zero byte files, or corrupt/non-decodable files), check the input files. ,
ContentUnsupported: There was a problem with the format of the input (not valid media file, or an unsupported file/codec), check the validity of the input files. ,
IdentityUnsupported: There was an error verifying to the account identity. Check and fix the identity configurations and retry. If unsuccessful, please contact support. ,
}
,
Required: False ,
}
enum ,
message:
{
Description: A human-readable language-dependent representation of the error. ,
Required: False ,
}
string ,
category:
{
Description: Helps with categorization of errors. ,
Enum:
{
Service: The error is service related. ,
Download: The error is download related. ,
Upload: The error is upload related. ,
Configuration: The error is configuration related. ,
Content: The error is related to data in the input files. ,
Account: The error is related to account information. ,
}
,
Required: False ,
}
enum ,
retry:
{
Description: Indicates that it may be possible to retry the Job. If retry is unsuccessful, please contact Azure support via Azure Portal. ,
Enum:
{
DoNotRetry: Issue needs to be investigated and then the job resubmitted with corrections or retried once the underlying issue has been corrected. ,
MayRetry: Issue may be resolved after waiting for a period of time and resubmitting the same Job. ,
}
,
Required: False ,
}
enum ,
details:
{
Description: An array of details about specific errors that led to this reported error. ,
Required: False ,
}
[
{
code:
{
Description: Code describing the error detail. ,
Required: False ,
}
string ,
message:
{
Description: A human-readable representation of the error. ,
Required: False ,
}
string ,
}
,
]
,
}
,
presetOverride:
{
Description: A preset used to override the preset in the corresponding transform output. ,
Required: False ,
}
{
@odata.type:
{
Description: The discriminator for derived types. ,
Required: True ,
}
string ,
}
,
state:
{
Description: Describes the state of the JobOutput. ,
Enum:
{
Canceled: The job was canceled. This is a final state for the job. ,
Canceling: The job is in the process of being canceled. This is a transient state for the job. ,
Error: The job has encountered an error. This is a final state for the job. ,
Finished: The job is finished. This is a final state for the job. ,
Processing: The job is processing. This is a transient state for the job. ,
Queued: The job is in a queued state, waiting for resources to become available. This is a transient state. ,
Scheduled: The job is being scheduled to run on an available resource. This is a transient state, between queued and processing states. ,
}
,
Required: False ,
}
enum ,
progress:
{
Description: 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. To determine if the JobOutput is complete, use the State property. ,
Format: int32 ,
Required: False ,
}
integer ,
label:
{
Description: A label that is assigned to a JobOutput in order to help uniquely identify it. This is useful when your Transform has more than one TransformOutput, whereby your Job has more than one JobOutput. In such cases, when you submit the Job, you will add two or more JobOutputs, in the same order as TransformOutputs in the Transform. Subsequently, when you retrieve the Job, either through events or on a GET request, you can use the label to easily identify the JobOutput. If a label is not provided, a default value of '{presetName}_{outputIndex}' will be used, where the preset name is the name of the preset in the corresponding TransformOutput and the output index is the relative index of the this JobOutput within the Job. Note that this index is the same as the relative index of the corresponding TransformOutput within its Transform. ,
Required: False ,
}
string ,
startTime:
{
Description: The UTC date and time at which this Job Output began processing. ,
Format: date-time ,
Required: False ,
}
string ,
endTime:
{
Description: The UTC date and time at which this Job Output finished processing. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
]
,
priority:
{
Description: Priority with which the job should be processed. Higher priority jobs are processed before lower priority jobs. If not set, the default is normal. ,
Enum:
{
Low: Used for TransformOutputs that can be generated after Normal and High priority TransformOutputs. ,
Normal: Used for TransformOutputs that can be generated at Normal priority. ,
High: Used for TransformOutputs that should take precedence over others. ,
}
,
Required: False ,
}
enum ,
correlationData:
{
Description: Customer provided key, value pairs that will be returned in Job and JobOutput state events. ,
Required: False ,
}
object ,
startTime:
{
Description: The UTC date and time at which this Job began processing. ,
Format: date-time ,
Required: False ,
}
string ,
endTime:
{
Description: The UTC date and time at which this Job finished processing. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
systemData:
{
Description: The system metadata relating to this resource. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
Jobs_Delete (removed)
Description :  Deletes a Job.
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Media/mediaServices/{accountName}/transforms/{transformName}/jobs/{jobName}
{
subscriptionId:
{
Description: The unique identifier for a Microsoft Azure subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group within the Azure subscription. ,
Required: True ,
}
string ,
accountName:
{
Description: The Media Services account name. ,
Required: True ,
}
string ,
transformName:
{
Description: The Transform name. ,
Required: True ,
}
string ,
jobName:
{
Description: The Job name. ,
Required: True ,
}
string ,
api-version:
{
Description: The version of the API to be used with the client request. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{}

⚐ Response (204)

{}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
Jobs_Update (removed)
Description :  Update is only supported for description and priority. Updating Priority will take effect when the Job state is Queued or Scheduled and depending on the timing the priority update may be ignored.
Reference :  Link ¶

⚼ Request

PATCH:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Media/mediaServices/{accountName}/transforms/{transformName}/jobs/{jobName}
{
subscriptionId:
{
Description: The unique identifier for a Microsoft Azure subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group within the Azure subscription. ,
Required: True ,
}
string ,
accountName:
{
Description: The Media Services account name. ,
Required: True ,
}
string ,
transformName:
{
Description: The Transform name. ,
Required: True ,
}
string ,
jobName:
{
Description: The Job name. ,
Required: True ,
}
string ,
parameters:
{
Description: The request parameters ,
Required: True ,
}
{
properties:
{
Description: The resource properties. ,
Required: False ,
}
{
created:
{
Description: The UTC date and time when the customer has created the Job, in 'YYYY-MM-DDThh:mm:ssZ' format. ,
Format: date-time ,
Required: False ,
}
string ,
state:
{
Description: The current state of the job. ,
Enum:
{
Canceled: The job was canceled. This is a final state for the job. ,
Canceling: The job is in the process of being canceled. This is a transient state for the job. ,
Error: The job has encountered an error. This is a final state for the job. ,
Finished: The job is finished. This is a final state for the job. ,
Processing: The job is processing. This is a transient state for the job. ,
Queued: The job is in a queued state, waiting for resources to become available. This is a transient state. ,
Scheduled: The job is being scheduled to run on an available resource. This is a transient state, between queued and processing states. ,
}
,
Required: False ,
}
enum ,
description:
{
Description: Optional customer supplied description of the Job. ,
Required: False ,
}
string ,
input:
{
Description: The inputs for the Job. ,
Required: True ,
}
{
@odata.type:
{
Description: The discriminator for derived types. ,
Required: True ,
}
string ,
}
,
lastModified:
{
Description: The UTC date and time when the customer has last updated the Job, in 'YYYY-MM-DDThh:mm:ssZ' format. ,
Format: date-time ,
Required: False ,
}
string ,
outputs:
{
Description: The outputs for the Job. ,
Required: True ,
}
[
{
@odata.type:
{
Description: The discriminator for derived types. ,
Required: True ,
}
string ,
error:
{
Description: If the JobOutput is in the Error state, it contains the details of the error. ,
Required: False ,
}
{
code:
{
Description: Error code describing the error. ,
Enum:
{
ServiceError: Fatal service error, please contact support. ,
ServiceTransientError: Transient error, please retry, if retry is unsuccessful, please contact support. ,
DownloadNotAccessible: While trying to download the input files, the files were not accessible, please check the availability of the source. ,
DownloadTransientError: While trying to download the input files, there was an issue during transfer (storage service, network errors), see details and check your source. ,
UploadNotAccessible: While trying to upload the output files, the destination was not reachable, please check the availability of the destination. ,
UploadTransientError: While trying to upload the output files, there was an issue during transfer (storage service, network errors), see details and check your destination. ,
ConfigurationUnsupported: There was a problem with the combination of input files and the configuration settings applied, fix the configuration settings and retry with the same input, or change input to match the configuration. ,
ContentMalformed: There was a problem with the input content (for example: zero byte files, or corrupt/non-decodable files), check the input files. ,
ContentUnsupported: There was a problem with the format of the input (not valid media file, or an unsupported file/codec), check the validity of the input files. ,
IdentityUnsupported: There was an error verifying to the account identity. Check and fix the identity configurations and retry. If unsuccessful, please contact support. ,
}
,
Required: False ,
}
enum ,
message:
{
Description: A human-readable language-dependent representation of the error. ,
Required: False ,
}
string ,
category:
{
Description: Helps with categorization of errors. ,
Enum:
{
Service: The error is service related. ,
Download: The error is download related. ,
Upload: The error is upload related. ,
Configuration: The error is configuration related. ,
Content: The error is related to data in the input files. ,
Account: The error is related to account information. ,
}
,
Required: False ,
}
enum ,
retry:
{
Description: Indicates that it may be possible to retry the Job. If retry is unsuccessful, please contact Azure support via Azure Portal. ,
Enum:
{
DoNotRetry: Issue needs to be investigated and then the job resubmitted with corrections or retried once the underlying issue has been corrected. ,
MayRetry: Issue may be resolved after waiting for a period of time and resubmitting the same Job. ,
}
,
Required: False ,
}
enum ,
details:
{
Description: An array of details about specific errors that led to this reported error. ,
Required: False ,
}
[
{
code:
{
Description: Code describing the error detail. ,
Required: False ,
}
string ,
message:
{
Description: A human-readable representation of the error. ,
Required: False ,
}
string ,
}
,
]
,
}
,
presetOverride:
{
Description: A preset used to override the preset in the corresponding transform output. ,
Required: False ,
}
{
@odata.type:
{
Description: The discriminator for derived types. ,
Required: True ,
}
string ,
}
,
state:
{
Description: Describes the state of the JobOutput. ,
Enum:
{
Canceled: The job was canceled. This is a final state for the job. ,
Canceling: The job is in the process of being canceled. This is a transient state for the job. ,
Error: The job has encountered an error. This is a final state for the job. ,
Finished: The job is finished. This is a final state for the job. ,
Processing: The job is processing. This is a transient state for the job. ,
Queued: The job is in a queued state, waiting for resources to become available. This is a transient state. ,
Scheduled: The job is being scheduled to run on an available resource. This is a transient state, between queued and processing states. ,
}
,
Required: False ,
}
enum ,
progress:
{
Description: 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. To determine if the JobOutput is complete, use the State property. ,
Format: int32 ,
Required: False ,
}
integer ,
label:
{
Description: A label that is assigned to a JobOutput in order to help uniquely identify it. This is useful when your Transform has more than one TransformOutput, whereby your Job has more than one JobOutput. In such cases, when you submit the Job, you will add two or more JobOutputs, in the same order as TransformOutputs in the Transform. Subsequently, when you retrieve the Job, either through events or on a GET request, you can use the label to easily identify the JobOutput. If a label is not provided, a default value of '{presetName}_{outputIndex}' will be used, where the preset name is the name of the preset in the corresponding TransformOutput and the output index is the relative index of the this JobOutput within the Job. Note that this index is the same as the relative index of the corresponding TransformOutput within its Transform. ,
Required: False ,
}
string ,
startTime:
{
Description: The UTC date and time at which this Job Output began processing. ,
Format: date-time ,
Required: False ,
}
string ,
endTime:
{
Description: The UTC date and time at which this Job Output finished processing. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
]
,
priority:
{
Description: Priority with which the job should be processed. Higher priority jobs are processed before lower priority jobs. If not set, the default is normal. ,
Enum:
{
Low: Used for TransformOutputs that can be generated after Normal and High priority TransformOutputs. ,
Normal: Used for TransformOutputs that can be generated at Normal priority. ,
High: Used for TransformOutputs that should take precedence over others. ,
}
,
Required: False ,
}
enum ,
correlationData:
{
Description: Customer provided key, value pairs that will be returned in Job and JobOutput state events. ,
Required: False ,
}
object ,
startTime:
{
Description: The UTC date and time at which this Job began processing. ,
Format: date-time ,
Required: False ,
}
string ,
endTime:
{
Description: The UTC date and time at which this Job finished processing. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
systemData:
{
Description: The system metadata relating to this resource. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}
,
api-version:
{
Description: The version of the API to be used with the client request. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: The resource properties. ,
Required: False ,
}
{
created:
{
Description: The UTC date and time when the customer has created the Job, in 'YYYY-MM-DDThh:mm:ssZ' format. ,
Format: date-time ,
Required: False ,
}
string ,
state:
{
Description: The current state of the job. ,
Enum:
{
Canceled: The job was canceled. This is a final state for the job. ,
Canceling: The job is in the process of being canceled. This is a transient state for the job. ,
Error: The job has encountered an error. This is a final state for the job. ,
Finished: The job is finished. This is a final state for the job. ,
Processing: The job is processing. This is a transient state for the job. ,
Queued: The job is in a queued state, waiting for resources to become available. This is a transient state. ,
Scheduled: The job is being scheduled to run on an available resource. This is a transient state, between queued and processing states. ,
}
,
Required: False ,
}
enum ,
description:
{
Description: Optional customer supplied description of the Job. ,
Required: False ,
}
string ,
input:
{
Description: The inputs for the Job. ,
Required: True ,
}
{
@odata.type:
{
Description: The discriminator for derived types. ,
Required: True ,
}
string ,
}
,
lastModified:
{
Description: The UTC date and time when the customer has last updated the Job, in 'YYYY-MM-DDThh:mm:ssZ' format. ,
Format: date-time ,
Required: False ,
}
string ,
outputs:
{
Description: The outputs for the Job. ,
Required: True ,
}
[
{
@odata.type:
{
Description: The discriminator for derived types. ,
Required: True ,
}
string ,
error:
{
Description: If the JobOutput is in the Error state, it contains the details of the error. ,
Required: False ,
}
{
code:
{
Description: Error code describing the error. ,
Enum:
{
ServiceError: Fatal service error, please contact support. ,
ServiceTransientError: Transient error, please retry, if retry is unsuccessful, please contact support. ,
DownloadNotAccessible: While trying to download the input files, the files were not accessible, please check the availability of the source. ,
DownloadTransientError: While trying to download the input files, there was an issue during transfer (storage service, network errors), see details and check your source. ,
UploadNotAccessible: While trying to upload the output files, the destination was not reachable, please check the availability of the destination. ,
UploadTransientError: While trying to upload the output files, there was an issue during transfer (storage service, network errors), see details and check your destination. ,
ConfigurationUnsupported: There was a problem with the combination of input files and the configuration settings applied, fix the configuration settings and retry with the same input, or change input to match the configuration. ,
ContentMalformed: There was a problem with the input content (for example: zero byte files, or corrupt/non-decodable files), check the input files. ,
ContentUnsupported: There was a problem with the format of the input (not valid media file, or an unsupported file/codec), check the validity of the input files. ,
IdentityUnsupported: There was an error verifying to the account identity. Check and fix the identity configurations and retry. If unsuccessful, please contact support. ,
}
,
Required: False ,
}
enum ,
message:
{
Description: A human-readable language-dependent representation of the error. ,
Required: False ,
}
string ,
category:
{
Description: Helps with categorization of errors. ,
Enum:
{
Service: The error is service related. ,
Download: The error is download related. ,
Upload: The error is upload related. ,
Configuration: The error is configuration related. ,
Content: The error is related to data in the input files. ,
Account: The error is related to account information. ,
}
,
Required: False ,
}
enum ,
retry:
{
Description: Indicates that it may be possible to retry the Job. If retry is unsuccessful, please contact Azure support via Azure Portal. ,
Enum:
{
DoNotRetry: Issue needs to be investigated and then the job resubmitted with corrections or retried once the underlying issue has been corrected. ,
MayRetry: Issue may be resolved after waiting for a period of time and resubmitting the same Job. ,
}
,
Required: False ,
}
enum ,
details:
{
Description: An array of details about specific errors that led to this reported error. ,
Required: False ,
}
[
{
code:
{
Description: Code describing the error detail. ,
Required: False ,
}
string ,
message:
{
Description: A human-readable representation of the error. ,
Required: False ,
}
string ,
}
,
]
,
}
,
presetOverride:
{
Description: A preset used to override the preset in the corresponding transform output. ,
Required: False ,
}
{
@odata.type:
{
Description: The discriminator for derived types. ,
Required: True ,
}
string ,
}
,
state:
{
Description: Describes the state of the JobOutput. ,
Enum:
{
Canceled: The job was canceled. This is a final state for the job. ,
Canceling: The job is in the process of being canceled. This is a transient state for the job. ,
Error: The job has encountered an error. This is a final state for the job. ,
Finished: The job is finished. This is a final state for the job. ,
Processing: The job is processing. This is a transient state for the job. ,
Queued: The job is in a queued state, waiting for resources to become available. This is a transient state. ,
Scheduled: The job is being scheduled to run on an available resource. This is a transient state, between queued and processing states. ,
}
,
Required: False ,
}
enum ,
progress:
{
Description: 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. To determine if the JobOutput is complete, use the State property. ,
Format: int32 ,
Required: False ,
}
integer ,
label:
{
Description: A label that is assigned to a JobOutput in order to help uniquely identify it. This is useful when your Transform has more than one TransformOutput, whereby your Job has more than one JobOutput. In such cases, when you submit the Job, you will add two or more JobOutputs, in the same order as TransformOutputs in the Transform. Subsequently, when you retrieve the Job, either through events or on a GET request, you can use the label to easily identify the JobOutput. If a label is not provided, a default value of '{presetName}_{outputIndex}' will be used, where the preset name is the name of the preset in the corresponding TransformOutput and the output index is the relative index of the this JobOutput within the Job. Note that this index is the same as the relative index of the corresponding TransformOutput within its Transform. ,
Required: False ,
}
string ,
startTime:
{
Description: The UTC date and time at which this Job Output began processing. ,
Format: date-time ,
Required: False ,
}
string ,
endTime:
{
Description: The UTC date and time at which this Job Output finished processing. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
]
,
priority:
{
Description: Priority with which the job should be processed. Higher priority jobs are processed before lower priority jobs. If not set, the default is normal. ,
Enum:
{
Low: Used for TransformOutputs that can be generated after Normal and High priority TransformOutputs. ,
Normal: Used for TransformOutputs that can be generated at Normal priority. ,
High: Used for TransformOutputs that should take precedence over others. ,
}
,
Required: False ,
}
enum ,
correlationData:
{
Description: Customer provided key, value pairs that will be returned in Job and JobOutput state events. ,
Required: False ,
}
object ,
startTime:
{
Description: The UTC date and time at which this Job began processing. ,
Format: date-time ,
Required: False ,
}
string ,
endTime:
{
Description: The UTC date and time at which this Job finished processing. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
systemData:
{
Description: The system metadata relating to this resource. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
Jobs_CancelJob (removed)
Description :  Cancel a Job.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Media/mediaServices/{accountName}/transforms/{transformName}/jobs/{jobName}/cancelJob
{
subscriptionId:
{
Description: The unique identifier for a Microsoft Azure subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group within the Azure subscription. ,
Required: True ,
}
string ,
accountName:
{
Description: The Media Services account name. ,
Required: True ,
}
string ,
transformName:
{
Description: The Transform name. ,
Required: True ,
}
string ,
jobName:
{
Description: The Job name. ,
Required: True ,
}
string ,
api-version:
{
Description: The version of the API to be used with the client request. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}