タスク
Task は Asset に対する作業の個々の操作で、Job で定義されます。
このトピックは、Task
エンティティを概説し、また Media Services REST API でさまざまな操作を実行する方法を示します。
重要
Media Services でエンティティにアクセスするときは、HTTP 要求で特定のヘッダー フィールドと値を設定する必要があります。
詳細については、「 Media Services REST API 開発のセットアップ」および「Media Services REST APIを使用した Media Services への接続」を参照してください。
Task エンティティのプロパティ
プロパティ | Type | 説明 |
---|---|---|
Id 読み取り専用です。 作成時に Media Services によって設定されます。 |
Edm.String | 一意識別子。 |
Configuration 省略可能。 |
Edm.String | エンコードや保護など、Task で実行する処理アクションを定義するプリセット。 最大長は 100000 です。 |
EndTime 読み取り専用です。 Media Services で設定します。 |
Edm.DateTime | タスクが完了、失敗、または取り消された日時。 |
ErrorDetails 読み取り専用です。 Media Services で設定します。 |
Collection(ErrorDetail) | Task の実行時に発生するエラーを説明するコードと詳細メッセージのコレクション。 |
HistoricalEvents 読み取り専用です。 Media Services で設定します。 |
Collection(TaskHistoricalEvent) | タスクの実行に関連するイベントを記述する TaskHistoricalEvent オブジェクトのコレクション。 |
MediaProcessorId 必須。 |
Edm.String | Task で使用される MediaProcessor の ID。 /API/MediaProcessors で GET 要求を実行して、有効な値を取得できます。 |
Name 省略可能。 |
Edm.String | 省略可能。 Task のフレンドリ名。 最大長は 4000 です。 |
PerfMessage 読み取り専用です。 Media Services で設定します。 |
Edm.String | Task に関するパフォーマンス情報を格納します。 |
Priority 省略可能。 |
Edm.Int32 | タスクの優先度。 値が大きいほど、他のタスクと比較して優先度が高いことを示します。 . たとえば、Priority = 40 のタスクは、Priority = 30 のタスクの前に処理されます。 上限は MaxInt と等しくなります。 |
Progress 読み取り専用です。 Media Services で設定します。 |
Edm.Double | 0 ~ 100% を示す値。 |
RunningDuration 読み取り専用です。 Media Services で設定します。 |
Edm.Double | Task の経過時間 (秒単位)。 |
StartTime 読み取り専用です。 Media Services で設定します。 |
Edm.DateTime | Task が開始した日時。 |
State 読み取り専用です。 Media Services で設定します。 |
Edm.Int32 | Task の状態。 有効な値は次のとおりです。 - None = 0 - アクティブ = 1 - 実行中 = 2 - 完了 = 3 |
TaskBody 必須。 |
Edm.String | Task の実行対象である入力資産と出力資産に関する情報を格納する XML ドキュメント。 Task は入力資産と出力資産を最低 1 つずつ持つ必要があります。 XML ドキュメントは以下の形式になります。 <taskBody> <inputAsset> JobInputAsset(0)</inputAsset> <inputAsset> JobInputAsset(1)</inputAsset> <outputAsset assetCreationOptions=”1” assetName=”output” storageAccountName=”mystoreagename”> JobOutputAsset(0) </outputAsset> <taskBody> outputAsset> 要素には<、次の属性を指定できます。 - assetCreationOptions (または AssetCreationOptions)。 この属性の値は、None=0x0、StorageEncrypted=0x1、CommonEncryptionProtected=0x2、EnvelopeEncryptionProtected=0x4 のいずれかになります。 既定値は StorageEncrypted です。 - assetName (または AssetName)。 指定しない場合、Media Services は、ジョブ名 (またはジョブ名が空の場合はジョブ ID) でサフィックスが付いた親 outputAsset 要素の形式で名前を設定します。 - storageAccountName (または StorageAccountName)。 出力資産が配置されるストレージ アカウントの名前です。 指定しない場合、ユーザーの既定のストレージ アカウントが使用されます。 タスクは、複数のタスクに依存でき、複数の依存関係を設定することもできます。 たとえば、タスク A に <inputAsset> として<参照される outputAsset> がタスク B によって存在する場合、タスク B はタスク A に依存します。その結果、Media Services はタスク B を処理する前にタスク A の処理を完了する必要があります。 |
Options 必須。 作成後は読み取り専用です。 |
Edm.Int32 | Task の作成に使用できる暗号化オプションを示す列挙値。 有効な値は次のとおりです。 - None = 0 - ProtectedConfiguration = 1 |
EncryptionKeyId 省略可能。 |
Edm.String | 暗号化されたキー ID。 |
EncryptionScheme 省略可能。 |
Edm.String | 構成ファイルで使用する EncryptionScheme。 有効な値は "ConfigurationEncryption" です。 |
EncryptionVersion 省略可能。 |
Edm.String | 使用する暗号化構成のバージョン。 現在サポートされているバージョンは "1.0" です。 |
InitializationVector 省略可能。 |
Edm.String | 構成ファイルの InitializationVector。 最大長は 4000 です。 |
OutputMediaAssets 読み取り専用です。 Media Services で設定します。 |
資産 エンティティ セット | 特定の Task を ID 値で参照してアクセスできるナビゲーション プロパティ。 返されるエンティティ セットには、指定されたタスクにリンクされているすべての OutputMediaAsset エンティティが含まれます。 |
InputMediaAssets 読み取り専用です。 Media Services で設定します。 |
資産 エンティティ セット | 特定の Task を ID 値で参照してアクセスできるナビゲーション プロパティ。 返されるエンティティ セットには、指定された Task にリンクされているすべての InputMediaAsset エンティティが含まれます。 |
TaskNotificationSubscriptions 必須。 |
TaskNotificationSubscription エンティティ セット | 通知エンドポイント タスクの状態の変更を定義します。 また、 は、通知するタスクの進行状況を含めるかどうかを示します。 |
タスクを作成する
Task は、Job を作成することによって作成します。 例については、「Media Encoder Standardを使用して資産をエンコードする方法」を参照してください。
タスクを一覧表示する
タスクは、GET HTTP 要求を使用して取得します。
Method | 要求 URI | HTTP バージョン |
---|---|---|
GET | <https:// accountname.restv2>。<location.media.azure.net/api/Tasks> | HTTP/1.1 |
Method | 要求 URI | HTTP バージョン |
---|---|---|
GET | <https:// accountname.restv2>。<location.media.azure.net/api/Jobs>('jobid')/Tasks | HTTP/1.1 |
要求のサンプル
最新 x-ms-version:
の を取得するには、「 Media Services REST」を参照してください。
GET https://<accountname>.restv2.<location>.media.azure.net/api/Jobs('nb:jid:UUID:b1f956b3-774c-bb44-a3f7-ee47e23add31')/Tasks HTTP/1.1
Content-Type: application/json;odata=verbose
Accept: application/json;odata=verbose
DataServiceVersion: 3.0
MaxDataServiceVersion: 3.0
x-ms-version: 2.19
Authorization: Bearer <token value>
Host: media.windows.net
参照
AccessPolicy
Asset
ContentKey
ジョブ
ジョブ
JobTemplate
ロケーター
MediaProcessor
TaskTemplate
クォータと制限