Remote Rendering - Create Conversion

リファレンス

Service:: Mixed Reality

API Version:: 2021-01-01

Azure Blob Storage アカウントに格納されている資産を使用して変換を作成します。

PUT {endpoint}/accounts/{account_id}/conversions/{conversion_id}?api-version=2021-01-01

URI パラメーター

名前	/	必須	型	説明
account_id	path	True	string uuid	Azure Remote Rendering アカウント ID。
conversion_id	path	True	string	指定されたアカウントの変換を一意に識別する ID。 ID では大文字と小文字が区別され、ハイフンやアンダースコアを含む英数字の任意の組み合わせを含めることができます。また、256 文字を超えることはできません。
endpoint	path	True	string	使用するエンドポイント (例: https://remoterendering.eastus.mixedreality.azure.com)。リストはにあります https://docs.microsoft.com/azure/remote-rendering/reference/regions。
api-version	query	True	string	HTTP 要求で使用される API バージョン。

要求ヘッダー

名前	必須	型	説明
Authorization	True	string	セキュリティで保護されたトークンサービスによって返されるベアラートークンMixed Reality。詳細については、https://docs.microsoft.com/azure/remote-rendering/how-tos/tokens を参照してください。

要求本文

名前	必須	型	説明
settings	True	conversion_settings	変換設定では、入力ファイルの配信元と出力ファイルの出力先が記述されます。

応答

名前	型	説明
200 OK	conversion	OK です。同じ設定の変換が既に存在することを示します。これは、変換の作成が再試行されるときに想定されます。 Headers MS-CV: string
201 Created	conversion	作成されました。新しい変換が作成されました。 Headers MS-CV: string
400 Bad Request	error_response	正しくない要求。返されたエラーオブジェクトは、発生した問題を示します。 Headers MS-CV: string
401 Unauthorized		権限がありません。承認が見つからないか無効です。 Headers MS-CV: string WWW-Authenticate: string
403 Forbidden		Forbidden. 特定のリソースに対する承認が不十分です。 Headers MS-CV: string
500 Internal Server Error	error_response	内部エラー。サーバーで内部エラーが発生しました。要求を再試行すると、正常な結果が生成される可能性があります。
Other Status Codes	error_response	競合しています。変換は既に存在します。エラーオブジェクトは、発生した問題を示します。 Headers MS-CV: string
Other Status Codes		要求が多すぎます。レート制限を超えました。 Retry-After ヘッダーで指定された期間が経過したら、要求を再試行します。 Headers MS-CV: string Retry-After: integer

セキュリティ

Authorization

セキュリティで保護されたトークンサービスによって返されるベアラートークンMixed Reality。詳細については、https://docs.microsoft.com/azure/remote-rendering/how-tos/tokens を参照してください。

Type: apiKey
In: header

例

Create a conversion

Sample Request

HTTP

PUT https://remoterendering.eastus.mixedreality.azure.com/accounts/30ea64bd-100f-4bf0-adc9-29fa45d4880c/conversions/contoso-conversion-fbc3646c-0b97-4553-81ca-6fae2bfb754e?api-version=2021-01-01

{
  "settings": {
    "inputLocation": {
      "storageContainerUri": "https://contosostorage01.blob.core.windows.net/arrinput",
      "blobPrefix": "models/",
      "relativeInputAssetPath": "house.fbx"
    },
    "outputLocation": {
      "storageContainerUri": "https://contosostorage01.blob.core.windows.net/arroutput",
      "blobPrefix": "conversionOutput/fbc3646c-0b97-4553-81ca-6fae2bfb754e",
      "outputAssetFilename": "convertedHouse.arrAsset"
    }
  }
}

Sample Response

Status code:: 201

MS-CV: dKEFmka2kkSlDmp/af+sOw

Response Body

{
  "id": "contoso-conversion-fbc3646c-0b97-4553-81ca-6fae2bfb754e",
  "creationTime": "2021-01-01T11:11:11.111Z",
  "settings": {
    "inputLocation": {
      "storageContainerUri": "https://contosostorage01.blob.core.windows.net/arrinput",
      "blobPrefix": "models/",
      "relativeInputAssetPath": "house.fbx"
    },
    "outputLocation": {
      "storageContainerUri": "https://contosostorage01.blob.core.windows.net/arroutput",
      "blobPrefix": "conversionOutput/fbc3646c-0b97-4553-81ca-6fae2bfb754e",
      "outputAssetFilename": "convertedHouse.arrAsset"
    }
  },
  "status": "NotStarted",
  "error": null
}

Status code:: 200

MS-CV: dKEFmka2kkSlDmp/af+sOw

Response Body

{
  "id": "contoso-conversion-fbc3646c-0b97-4553-81ca-6fae2bfb754e",
  "creationTime": "2021-01-01T11:11:11.111Z",
  "settings": {
    "inputLocation": {
      "storageContainerUri": "https://contosostorage01.blob.core.windows.net/arrinput",
      "blobPrefix": "models/",
      "relativeInputAssetPath": "house.fbx"
    },
    "outputLocation": {
      "storageContainerUri": "https://contosostorage01.blob.core.windows.net/arroutput",
      "blobPrefix": "conversionOutput/fbc3646c-0b97-4553-81ca-6fae2bfb754e",
      "outputAssetFilename": "convertedHouse.arrAsset"
    }
  },
  "status": "NotStarted",
  "error": null
}

Status code:: 400

MS-CV: dKEFmka2kkSlDmp/af+sOw

Response Body

{
  "error": {
    "code": "BadRequest",
    "message": "The request was malformed."
  }
}

Status code:: 409

MS-CV: dKEFmka2kkSlDmp/af+sOw

Response Body

{
  "error": {
    "code": "Conflict",
    "message": "A resource already exists under the given ID."
  }
}

Status code:: 401

WWW-Authenticate: Bearer error="invalid_token"
MS-CV: dKEFmka2kkSlDmp/af+sOw

Status code:: 403

MS-CV: dKEFmka2kkSlDmp/af+sOw

Status code:: 429

Retry-After: 15
MS-CV: dKEFmka2kkSlDmp/af+sOw

Status code:: 500

MS-CV: dKEFmka2kkSlDmp/af+sOw

Response Body

{
  "error": {
    "code": "InternalServerError",
    "message": "An internal server error occurred."
  }
}

定義

名前	説明
conversion	変換のプロパティ。
conversion_input_settings	変換入力設定は、変換入力の起点を表します。
conversion_output_settings	変換出力の設定では、変換出力の変換先が記述されます。
conversion_settings	変換設定では、入力ファイルの配信元と出力ファイルの出力先が記述されます。
conversion_status	変換の状態。ターミナルの状態は、'Cancelled'、'Failed'、および 'Succeeded' です。
create_conversion_settings	変換の開始を要求する
error	要求が失敗した理由の詳細を含む error オブジェクト。
error_response	要求が失敗した理由の詳細を含むエラー応答。
Output	変換成功の出力に関する情報。変換の状態が "Succeeded" の場合にのみ存在します。

conversion

変換のプロパティ。

名前	型	説明
creationTime	string	変換が作成された時刻。 ISO 8601 形式の日付と時刻。
error	error	変換エラーに関する詳細を含む error オブジェクト。
id	string	変換の作成時に指定された変換の ID。
output	Output	変換成功の出力に関する情報。変換の状態が "Succeeded" の場合にのみ存在します。
settings	conversion_settings	変換設定では、入力ファイルの配信元と出力ファイルの出力先が記述されます。
status	conversion_status	変換の状態。ターミナルの状態は、'Cancelled'、'Failed'、および 'Succeeded' です。

conversion_input_settings

変換入力設定は、変換入力の起点を表します。

名前	型	説明
blobPrefix	string	このプレフィックスで始まる BLOB のみがダウンロードされ、変換が実行されます。省略可能。指定しない場合、コンテナーからのすべての BLOB がダウンロードされます。
relativeInputAssetPath	string	入力モデルへの blobPrefix (または blobPrefix が指定されていない場合はコンテナールート) から始まる相対パス。サポートされているファイル形式で終わるファイルを指す必要があります。詳細については、https://docs.microsoft.com/azure/remote-rendering/how-tos/conversion/model-conversion を参照してください。
storageContainerReadListSas	string	ストレージコンテナーへの読み取りと一覧のアクセス権を付与する Azure BLOB ストレージコンテナーの共有アクセス署名。省略可能。指定しない場合は、Azure Remote Rendering アカウントを BLOB コンテナーを含むストレージアカウントにリンクする必要があります。詳細については、https://docs.microsoft.com/azure/remote-rendering/how-tos/create-an-account#link-storage-accounts を参照してください。セキュリティ上の理由から、このフィールドは応答本文に入力されません。
storageContainerUri	string	入力モデルを含む Azure BLOB ストレージコンテナーの URI。

conversion_output_settings

変換出力の設定では、変換出力の変換先が記述されます。

名前	型	説明
blobPrefix	string	変換プロセスによって生成されるすべてのファイルの前に付加されるプレフィックス。仮想フォルダーとして扱われます。省略可能。指定しない場合、出力ファイルはコンテナールートに格納されます。
outputAssetFilename	string	出力資産のファイル名。 '.arrAsset' で終わる必要があります。省略可能。指定しない場合、ファイル名は入力資産と同じ名前になり、拡張子は '.arrAsset' になります
storageContainerUri	string	変換の結果を書き込む必要がある Azure BLOB ストレージコンテナーの URI。
storageContainerWriteSas	string	ストレージコンテナーへの書き込みアクセス権を付与する Azure BLOB ストレージコンテナーの共有アクセス署名。省略可能。指定しない場合は、Azure Remote Rendering アカウントを BLOB コンテナーを含むストレージアカウントにリンクする必要があります。詳細については、https://docs.microsoft.com/azure/remote-rendering/how-tos/create-an-account#link-storage-accounts を参照してください。セキュリティ上の理由から、このフィールドは応答本文に入力されません。

conversion_settings

変換設定では、入力ファイルの配信元と出力ファイルの出力先が記述されます。

名前	型	説明
inputLocation	conversion_input_settings	変換入力設定は、変換入力の起点を表します。
outputLocation	conversion_output_settings	変換出力の設定では、変換出力の変換先が記述されます。

conversion_status

変換の状態。ターミナルの状態は、'Cancelled'、'Failed'、および 'Succeeded' です。

名前	型	説明
Cancelled	string	変換が取り消されました。これは終了状態です。
Failed	string	変換に失敗しました。詳細については、'error' フィールドを確認してください。これは終了状態です。
NotStarted	string	変換は作成されましたが、まだ開始されていません。
Running	string	変換が実行されています。
Succeeded	string	変換が成功しました。 [出力] フィールドで出力資産の場所を確認します。これは終了状態です。

create_conversion_settings

変換の開始を要求する

名前	型	説明
settings	conversion_settings	変換設定では、入力ファイルの配信元と出力ファイルの出力先が記述されます。

error

要求が失敗した理由の詳細を含む error オブジェクト。

名前	型	説明
code	string	エラーコード。
details	error[]	この報告されたエラーの原因となった特定のエラーに関する詳細の配列。
innerError	error	エラーに関する現在のオブジェクトよりも具体的な情報を含むオブジェクト。
message	string	エラーの人間が判読できる表現。
target	string	特定のエラーのターゲット (たとえば、エラーのプロパティの名前)。

error_response

要求が失敗した理由の詳細を含むエラー応答。

名前	型	説明
error	error	要求が失敗した理由の詳細を含む error オブジェクト。

Output

変換成功の出力に関する情報。変換の状態が "Succeeded" の場合にのみ存在します。

名前	型	説明
outputAssetUri	string	変換プロセスによって生成される資産の URI。

次の方法で共有