Jobs - Create

ジョブの作成
ジョブを作成します。

PUT https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Media/mediaServices/{accountName}/transforms/{transformName}/jobs/{jobName}?api-version=2020-05-01

URI パラメーター

Name In Required Type Description
accountName
path True
  • string

Media Services アカウント名。

jobName
path True
  • string

ジョブ名。

resourceGroupName
path True
  • string

Azure サブスクリプション内のリソースグループの名前。

subscriptionId
path True
  • string

Microsoft Azure サブスクリプションの一意の識別子。

transformName
path True
  • string

変換名。

api-version
query True
  • string

クライアント要求で使用する API のバージョン。

要求本文

Name Required Type Description
properties.input True JobInput:

ジョブに対する入力。

properties.outputs True JobOutput[]:

ジョブの出力。

properties.correlationData
  • object

ユーザーが指定したキーと値のペア (ジョブと JobOutput 状態イベントで返されます)。

properties.description
  • string

ジョブに関する顧客指定の説明 (省略可能)。

properties.priority

ジョブの処理の優先順位。 優先順位が高いジョブは、優先順位が低いジョブより前に処理されます。 設定されていない場合、既定値は normal です。

応答

Name Type Description
201 Created

作成済み

Other Status Codes

詳細なエラー情報。

Create a Job

Sample Request

PUT https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/contosoresources/providers/Microsoft.Media/mediaServices/contosomedia/transforms/exampleTransform/jobs/job1?api-version=2020-05-01
{
  "properties": {
    "input": {
      "@odata.type": "#Microsoft.Media.JobInputAsset",
      "assetName": "job1-InputAsset"
    },
    "outputs": [
      {
        "@odata.type": "#Microsoft.Media.JobOutputAsset",
        "assetName": "job1-OutputAsset"
      }
    ],
    "correlationData": {
      "key1": "value1",
      "Key 2": "Value 2"
    }
  }
}

Sample Response

{
  "name": "job1",
  "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/contosoresources/providers/Microsoft.Media/mediaservices/contosomedia/transforms/exampleTransform/jobs/job1",
  "type": "Microsoft.Media/mediaservices/transforms/jobs",
  "properties": {
    "created": "2020-09-25T03:52:07.7751982Z",
    "state": "Queued",
    "input": {
      "@odata.type": "#Microsoft.Media.JobInputAsset",
      "files": [],
      "assetName": "job1-InputAsset"
    },
    "lastModified": "2020-09-25T03:52:07.7751982Z",
    "outputs": [
      {
        "@odata.type": "#Microsoft.Media.JobOutputAsset",
        "state": "Queued",
        "progress": 0,
        "label": "BuiltInStandardEncoderPreset_0",
        "assetName": "job1-OutputAsset"
      }
    ],
    "priority": "Normal",
    "correlationData": {
      "key1": "value1",
      "Key 2": "Value 2"
    }
  }
}

定義

AbsoluteClipTime

メディアファイル内の絶対時刻の位置としてクリップの時間を指定します。 絶対時刻は、メディアファイルが0のタイムスタンプから開始されたかどうかによって、別の位置を指すことができます。

ApiError

API エラーです。

Job

ジョブリソースの種類。 進行状況と状態は、ジョブをポーリングするか、EventGrid を使用してイベントをサブスクライブすることによって取得できます。

JobError

JobOutput エラーの詳細。

JobErrorCategory

エラーの分類に役立ちます。

JobErrorCode

エラーを説明するエラーコード。

JobErrorDetail

JobOutput エラーの詳細。

JobInputAsset

ジョブへの入力の資産を表します。

JobInputClip

ジョブの入力ファイルを表します。

JobInputHttp

HTTPS ジョブ入力を表します。

JobInputs

ジョブへの入力の一覧を示します。

JobOutputAsset

JobOutput として使用される資産を表します。

JobRetry

ジョブを再試行できる可能性があることを示します。 再試行に失敗した場合は、azure Portal で Azure サポートにお問い合わせください。

JobState

JobOutput の状態を示します。

ODataError

エラーに関する情報。

Priority

変換内の TransformOutputs の相対的な優先順位を設定します。 これにより、サービスが TransformOutputs の処理に使用する優先度が設定されます。 既定の優先順位は Normal です。

UtcClipTime

メディアファイル内の Utc 時刻位置としてのクリップ時刻を指定します。 Utc 時刻は、メディアファイルが0のタイムスタンプから開始されたかどうかに応じて、別の位置を指すことができます。

AbsoluteClipTime

メディアファイル内の絶対時刻の位置としてクリップの時間を指定します。 絶対時刻は、メディアファイルが0のタイムスタンプから開始されたかどうかによって、別の位置を指すことができます。

Name Type Description
@odata.type string:
  • #Microsoft.Media.AbsoluteClipTime

派生型の識別子。

time
  • string

入力メディアのタイムライン上の時刻位置。 通常、この形式は、///の期間として指定されます。 例: PT30S 30 秒。

ApiError

API エラーです。

Name Type Description
error

エラープロパティ。

Job

ジョブリソースの種類。 進行状況と状態は、ジョブをポーリングするか、EventGrid を使用してイベントをサブスクライブすることによって取得できます。

Name Type Description
id
  • string

リソースの完全修飾リソース ID。 例-/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}

name
  • string

リソースの名前

properties.correlationData
  • object

ユーザーが指定したキーと値のペア (ジョブと JobOutput 状態イベントで返されます)。

properties.created
  • string

顧客がジョブを作成した UTC 日時 (' YYYY-MM-Yyyy-mm-ddthh: mm: ssZ ' 形式)。

properties.description
  • string

ジョブに関する顧客指定の説明 (省略可能)。

properties.endTime
  • string

このジョブが処理を終了した UTC 日時。

properties.input JobInput:

ジョブに対する入力。

properties.lastModified
  • string

顧客が最後にジョブを更新した日時 (' YYYY-MM-Yyyy-mm-ddthh: mm: ssZ ' 形式)。

properties.outputs JobOutput[]:

ジョブの出力。

properties.priority

ジョブの処理の優先順位。 優先順位が高いジョブは、優先順位が低いジョブより前に処理されます。 設定されていない場合、既定値は normal です。

properties.startTime
  • string

このジョブの処理が開始された UTC 日時。

properties.state

ジョブの現在の状態。

type
  • string

リソースの型。 例: "Microsoft. Compute/virtualMachines" または "Microsoft. Storage/storageAccounts"

JobError

JobOutput エラーの詳細。

Name Type Description
category

エラーの分類に役立ちます。

code

エラーを説明するエラーコード。

details

この報告されたエラーによって発生した特定のエラーに関する詳細の配列。

message
  • string

人間が判読できる、エラーの言語に依存した表現。

retry

ジョブを再試行できる可能性があることを示します。 再試行に失敗した場合は、azure Portal で Azure サポートにお問い合わせください。

JobErrorCategory

エラーの分類に役立ちます。

Name Type Description
Configuration
  • string

エラーは構成に関連しています。

Content
  • string

このエラーは、入力ファイルのデータに関連しています。

Download
  • string

ダウンロードに関連するエラーです。

Service
  • string

このエラーはサービスに関連しています。

Upload
  • string

アップロード関連のエラーです。

JobErrorCode

エラーを説明するエラーコード。

Name Type Description
ConfigurationUnsupported
  • string

入力ファイルと、適用された構成設定の組み合わせに問題がありました。構成設定を修正し、同じ入力で再試行するか、構成に一致するように入力を変更してください。

ContentMalformed
  • string

入力コンテンツに問題が発生しました (例: ゼロバイトファイル、または破損/非 decodable ファイル)。

ContentUnsupported
  • string

入力の形式 (有効ではないメディアファイル、またはサポートされていないファイル/コーデック) で問題が発生しました。入力ファイルの有効性を確認してください。

DownloadNotAccessible
  • string

入力ファイルをダウンロードしようとしているときに、ファイルにアクセスできませんでした。ソースが使用可能かどうかを確認してください。

DownloadTransientError
  • string

入力ファイルをダウンロードしようとしているときに、転送中に問題が発生しました (ストレージサービス、ネットワークエラー)。詳細を確認し、ソースを確認してください。

ServiceError
  • string

致命的なサービスエラーです。サポートにお問い合わせください。

ServiceTransientError
  • string

一時的なエラーです。再試行が失敗した場合は、再試行してください。サポートにお問い合わせください。

UploadNotAccessible
  • string

出力ファイルをアップロードしようとしているときに、宛先に到達できませんでした。転送先が使用可能かどうかを確認してください。

UploadTransientError
  • string

出力ファイルをアップロードしようとしているときに、転送中に問題が発生しました (ストレージサービス、ネットワークエラー)。詳細を確認し、宛先を確認してください。

JobErrorDetail

JobOutput エラーの詳細。

Name Type Description
code
  • string

エラーの詳細を記述するコード。

message
  • string

人間が判読できるエラーの表現。

JobInputAsset

ジョブへの入力の資産を表します。

Name Type Description
@odata.type string:
  • #Microsoft.Media.JobInputAsset

派生型の識別子。

assetName
  • string

入力資産の名前。

end ClipTime:

処理を終了する入力メディアのタイムライン上のポイントを定義します。 既定値は入力メディアの末尾です。

files
  • string[]

ファイルの一覧。 JobInputHttp の場合に必須です。 それぞれ最大4000文字です。

label
  • string

JobInputClip に割り当てられているラベル。これは、変換で使用される参照を満たすために使用されます。 たとえば、"xyz" というラベルが付いたイメージファイルを作成し、エンコードされる前に入力ビデオにオーバーレイとして適用するように変換を作成することができます。 ジョブを送信する場合、JobInputs の1つだけがイメージファイルである必要があり、"xyz" というラベルが付いている必要があります。

start ClipTime:

処理を開始する入力メディアのタイムライン上のポイントを定義します。 既定値は入力メディアの先頭です。

JobInputClip

ジョブの入力ファイルを表します。

Name Type Description
@odata.type string:
  • #Microsoft.Media.JobInputClip

派生型の識別子。

end ClipTime:

処理を終了する入力メディアのタイムライン上のポイントを定義します。 既定値は入力メディアの末尾です。

files
  • string[]

ファイルの一覧。 JobInputHttp の場合に必須です。 それぞれ最大4000文字です。

label
  • string

JobInputClip に割り当てられているラベル。これは、変換で使用される参照を満たすために使用されます。 たとえば、"xyz" というラベルが付いたイメージファイルを作成し、エンコードされる前に入力ビデオにオーバーレイとして適用するように変換を作成することができます。 ジョブを送信する場合、JobInputs の1つだけがイメージファイルである必要があり、"xyz" というラベルが付いている必要があります。

start ClipTime:

処理を開始する入力メディアのタイムライン上のポイントを定義します。 既定値は入力メディアの先頭です。

JobInputHttp

HTTPS ジョブ入力を表します。

Name Type Description
@odata.type string:
  • #Microsoft.Media.JobInputHttp

派生型の識別子。

baseUri
  • string

HTTPS ジョブ入力のベース URI。 指定したファイル名と連結されます。 ベース uri が指定されていない場合、指定されたファイルリストは完全修飾 uri と見なされます。 最大文字数は4000文字です。

end ClipTime:

処理を終了する入力メディアのタイムライン上のポイントを定義します。 既定値は入力メディアの末尾です。

files
  • string[]

ファイルの一覧。 JobInputHttp の場合に必須です。 それぞれ最大4000文字です。

label
  • string

JobInputClip に割り当てられているラベル。これは、変換で使用される参照を満たすために使用されます。 たとえば、"xyz" というラベルが付いたイメージファイルを作成し、エンコードされる前に入力ビデオにオーバーレイとして適用するように変換を作成することができます。 ジョブを送信する場合、JobInputs の1つだけがイメージファイルである必要があり、"xyz" というラベルが付いている必要があります。

start ClipTime:

処理を開始する入力メディアのタイムライン上のポイントを定義します。 既定値は入力メディアの先頭です。

JobInputs

ジョブへの入力の一覧を示します。

Name Type Description
@odata.type string:
  • #Microsoft.Media.JobInputs

派生型の識別子。

inputs JobInput[]:

ジョブへの入力の一覧。

JobOutputAsset

JobOutput として使用される資産を表します。

Name Type Description
@odata.type string:
  • #Microsoft.Media.JobOutputAsset

派生型の識別子。

assetName
  • string

出力資産の名前。

endTime
  • string

このジョブの出力が処理を終了した UTC 日時。

error

JobOutput がエラー状態の場合は、エラーの詳細が含まれています。

label
  • string

ジョブを一意に識別できるように、JobOutput に割り当てられたラベル。 これは、変換に複数の TransformOutput がある場合に便利です。これにより、ジョブに複数の JobOutput が含まれるようになります。 このような場合は、ジョブを送信するときに、変換の TransformOutputs と同じ順序で2つ以上の JobOutputs を追加します。 その後、イベントまたは GET 要求でジョブを取得するときに、ラベルを使用して JobOutput を簡単に識別できます。 ラベルが指定されていない場合は、既定値 ' {presetName} _ {outputIndex} ' が使用されます。プリセット名は対応する TransformOutput のプリセットの名前であり、出力インデックスはジョブ内のこの JobOutput の相対インデックスです。 このインデックスは、変換内の対応する TransformOutput の相対インデックスと同じであることに注意してください。

progress
  • integer

JobOutput が処理状態の場合は、ジョブ完了率が含まれます。 この値は推定値であり、ジョブの完了時間を予測するために使用するためのものではありません。 JobOutput が完了したかどうかを判断するには、State プロパティを使用します。

startTime
  • string

このジョブの出力の処理が開始された UTC 日時。

state

JobOutput の状態を示します。

JobRetry

ジョブを再試行できる可能性があることを示します。 再試行に失敗した場合は、azure Portal で Azure サポートにお問い合わせください。

Name Type Description
DoNotRetry
  • string

問題を調査してから、根本的な問題が修正された後に、ジョブを修正または再試行して再送信する必要があります。

MayRetry
  • string

問題は、一定の期間待機し、同じジョブを再送信すると解決される場合があります。

JobState

JobOutput の状態を示します。

Name Type Description
Canceled
  • string

ジョブは取り消されました。 これは、ジョブの最終的な状態です。

Canceling
  • string

ジョブは取り消されています。 これは、ジョブの一時的な状態です。

Error
  • string

ジョブでエラーが発生しました。 これは、ジョブの最終的な状態です。

Finished
  • string

ジョブが完了しました。 これは、ジョブの最終的な状態です。

Processing
  • string

ジョブは処理中です。 これは、ジョブの一時的な状態です。

Queued
  • string

ジョブはキューに登録された状態であり、リソースが使用可能になるのを待機しています。 これは一時的な状態です。

Scheduled
  • string

ジョブは、使用可能なリソースで実行されるようにスケジュールされています。 これは、キューに登録された状態と処理状態の間の一時的な状態です。

ODataError

エラーに関する情報。

Name Type Description
code
  • string

言語に依存しないエラー名。

details

エラーの詳細です。

message
  • string

エラー メッセージ。

target
  • string

エラーのターゲット (たとえば、エラーのプロパティの名前)。

Priority

変換内の TransformOutputs の相対的な優先順位を設定します。 これにより、サービスが TransformOutputs の処理に使用する優先度が設定されます。 既定の優先順位は Normal です。

Name Type Description
High
  • string

他より優先される TransformOutputs に使用されます。

Low
  • string

通常の高優先度の TransformOutputs の後に生成できる TransformOutputs に使用されます。

Normal
  • string

通常の優先順位で生成できる TransformOutputs に使用されます。

UtcClipTime

メディアファイル内の Utc 時刻位置としてのクリップ時刻を指定します。 Utc 時刻は、メディアファイルが0のタイムスタンプから開始されたかどうかに応じて、別の位置を指すことができます。

Name Type Description
@odata.type string:
  • #Microsoft.Media.UtcClipTime

派生型の識別子。

time
  • string

Utc 時刻に基づく入力メディアのタイムライン上の時刻位置。