From 718c3d8b58cf9a2220f79f5adce6bb6d8d2b0409 Mon Sep 17 00:00:00 2001 From: rikogeln <40666347+rikogeln@users.noreply.github.com> Date: Tue, 2 Mar 2021 17:42:53 +0000 Subject: [PATCH] Azure Remote REST API 2021-01-01 (#13239) * copy of unchanged 2021-01-01-preview * rename folder 2021-01-01-preview to 2021-01-01 * promote 2021-01-01-preview to 2021-01-01 --- .../2021-01-01/examples/CreateConversion.json | 120 ++ .../2021-01-01/examples/CreateSession.json | 90 ++ .../2021-01-01/examples/GetConversion.json | 69 + .../2021-01-01/examples/GetSession.json | 61 + .../2021-01-01/examples/ListConversions.json | 85 + .../2021-01-01/examples/ListSessions.json | 73 + .../2021-01-01/examples/StopSession.json | 48 + .../2021-01-01/examples/UpdateSession.json | 75 + .../stable/2021-01-01/mr-arr.json | 1393 +++++++++++++++++ .../mixedreality/data-plane/readme.md | 13 +- 10 files changed, 2025 insertions(+), 2 deletions(-) create mode 100644 specification/mixedreality/data-plane/Microsoft.MixedReality/stable/2021-01-01/examples/CreateConversion.json create mode 100644 specification/mixedreality/data-plane/Microsoft.MixedReality/stable/2021-01-01/examples/CreateSession.json create mode 100644 specification/mixedreality/data-plane/Microsoft.MixedReality/stable/2021-01-01/examples/GetConversion.json create mode 100644 specification/mixedreality/data-plane/Microsoft.MixedReality/stable/2021-01-01/examples/GetSession.json create mode 100644 specification/mixedreality/data-plane/Microsoft.MixedReality/stable/2021-01-01/examples/ListConversions.json create mode 100644 specification/mixedreality/data-plane/Microsoft.MixedReality/stable/2021-01-01/examples/ListSessions.json create mode 100644 specification/mixedreality/data-plane/Microsoft.MixedReality/stable/2021-01-01/examples/StopSession.json create mode 100644 specification/mixedreality/data-plane/Microsoft.MixedReality/stable/2021-01-01/examples/UpdateSession.json create mode 100644 specification/mixedreality/data-plane/Microsoft.MixedReality/stable/2021-01-01/mr-arr.json diff --git a/specification/mixedreality/data-plane/Microsoft.MixedReality/stable/2021-01-01/examples/CreateConversion.json b/specification/mixedreality/data-plane/Microsoft.MixedReality/stable/2021-01-01/examples/CreateConversion.json new file mode 100644 index 000000000000..b883d2e0ef67 --- /dev/null +++ b/specification/mixedreality/data-plane/Microsoft.MixedReality/stable/2021-01-01/examples/CreateConversion.json @@ -0,0 +1,120 @@ +{ + "parameters": { + "endpoint": "https://remoterendering.eastus.mixedreality.azure.com", + "api-version": "2021-01-01", + "account_id": "30ea64bd-100f-4bf0-adc9-29fa45d4880c", + "conversion_id": "contoso-conversion-fbc3646c-0b97-4553-81ca-6fae2bfb754e", + "body": { + "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" + } + } + } + }, + "responses": { + "201": { + "headers": { + "MS-CV": "dKEFmka2kkSlDmp/af+sOw" + }, + "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 + } + }, + "200": { + "headers": { + "MS-CV": "dKEFmka2kkSlDmp/af+sOw" + }, + "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 + } + }, + "400": { + "headers": { + "MS-CV": "dKEFmka2kkSlDmp/af+sOw" + }, + "body": { + "error": { + "code": "BadRequest", + "message": "The request was malformed." + } + } + }, + "409": { + "headers": { + "MS-CV": "dKEFmka2kkSlDmp/af+sOw" + }, + "body": { + "error": { + "code": "Conflict", + "message": "A resource already exists under the given ID." + } + } + }, + "401": { + "headers": { + "WWW-Authenticate": "Bearer error=\"invalid_token\"", + "MS-CV": "dKEFmka2kkSlDmp/af+sOw" + } + }, + "403": { + "headers": { + "MS-CV": "dKEFmka2kkSlDmp/af+sOw" + } + }, + "429": { + "headers": { + "Retry-After": 15, + "MS-CV": "dKEFmka2kkSlDmp/af+sOw" + } + }, + "500": { + "headers": { + "MS-CV": "dKEFmka2kkSlDmp/af+sOw" + }, + "body": { + "error": { + "code": "InternalServerError", + "message": "An internal server error occurred." + } + } + } + } +} diff --git a/specification/mixedreality/data-plane/Microsoft.MixedReality/stable/2021-01-01/examples/CreateSession.json b/specification/mixedreality/data-plane/Microsoft.MixedReality/stable/2021-01-01/examples/CreateSession.json new file mode 100644 index 000000000000..2f0a54481823 --- /dev/null +++ b/specification/mixedreality/data-plane/Microsoft.MixedReality/stable/2021-01-01/examples/CreateSession.json @@ -0,0 +1,90 @@ +{ + "parameters": { + "endpoint": "https://remoterendering.eastus.mixedreality.azure.com", + "api-version": "2021-01-01", + "account_id": "30ea64bd-100f-4bf0-adc9-29fa45d4880c", + "session_id": "contoso-session-c2b8ac1d-9494-4852-a59c-8c28813adc28", + "body": { + "maxLeaseTimeMinutes": 60, + "size": "Standard" + } + }, + "responses": { + "201": { + "headers": { + "MS-CV": "dKEFmka2kkSlDmp/af+sOw" + }, + "body": { + "id": "contoso-session-c2b8ac1d-9494-4852-a59c-8c28813adc28", + "creationTime": "2020-11-11T11:11:11.111Z", + "maxLeaseTimeMinutes": 60, + "size": "Standard", + "status": "Starting", + "error": null + } + }, + "200": { + "headers": { + "MS-CV": "dKEFmka2kkSlDmp/af+sOw" + }, + "body": { + "id": "contoso-session-c2b8ac1d-9494-4852-a59c-8c28813adc28", + "creationTime": "2020-11-11T11:11:11.111Z", + "maxLeaseTimeMinutes": 60, + "size": "Standard", + "status": "Starting", + "error": null + } + }, + "400": { + "headers": { + "MS-CV": "dKEFmka2kkSlDmp/af+sOw" + }, + "body": { + "error": { + "code": "BadRequest", + "message": "The request was malformed." + } + } + }, + "409": { + "headers": { + "MS-CV": "dKEFmka2kkSlDmp/af+sOw" + }, + "body": { + "error": { + "code": "Conflict", + "message": "A resource already exists under the given ID." + } + } + }, + "401": { + "headers": { + "WWW-Authenticate": "Bearer error=\"invalid_token\"", + "MS-CV": "dKEFmka2kkSlDmp/af+sOw" + } + }, + "403": { + "headers": { + "MS-CV": "dKEFmka2kkSlDmp/af+sOw" + } + }, + "429": { + "headers": { + "Retry-After": 15, + "MS-CV": "dKEFmka2kkSlDmp/af+sOw" + } + }, + "500": { + "headers": { + "MS-CV": "dKEFmka2kkSlDmp/af+sOw" + }, + "body": { + "error": { + "code": "InternalServerError", + "message": "An internal server error occurred." + } + } + } + } +} diff --git a/specification/mixedreality/data-plane/Microsoft.MixedReality/stable/2021-01-01/examples/GetConversion.json b/specification/mixedreality/data-plane/Microsoft.MixedReality/stable/2021-01-01/examples/GetConversion.json new file mode 100644 index 000000000000..8163c4a06823 --- /dev/null +++ b/specification/mixedreality/data-plane/Microsoft.MixedReality/stable/2021-01-01/examples/GetConversion.json @@ -0,0 +1,69 @@ +{ + "parameters": { + "endpoint": "https://remoterendering.eastus.mixedreality.azure.com", + "api-version": "2021-01-01", + "account_id": "30ea64bd-100f-4bf0-adc9-29fa45d4880c", + "conversion_id": "contoso-conversion-fbc3646c-0b97-4553-81ca-6fae2bfb754e" + }, + "responses": { + "200": { + "headers": { + "MS-CV": "dKEFmka2kkSlDmp/af+sOw" + }, + "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": "Succeeded", + "error": null, + "output": { + "outputAssetUri": "https://contosostorage01.blob.core.windows.net/arrOutput/conversionOutput/fbc3646c-0b97-4553-81ca-6fae2bfb754e/convertedHouse.arrAsset" + } + } + }, + "401": { + "headers": { + "WWW-Authenticate": "Bearer error=\"invalid_token\"", + "MS-CV": "dKEFmka2kkSlDmp/af+sOw" + } + }, + "403": { + "headers": { + "MS-CV": "dKEFmka2kkSlDmp/af+sOw" + } + }, + "404": { + "headers": { + "MS-CV": "dKEFmka2kkSlDmp/af+sOw" + } + }, + "429": { + "headers": { + "Retry-After": 15, + "MS-CV": "dKEFmka2kkSlDmp/af+sOw" + } + }, + "500": { + "headers": { + "MS-CV": "dKEFmka2kkSlDmp/af+sOw" + }, + "body": { + "error": { + "code": "InternalServerError", + "message": "An internal server error occurred." + } + } + } + } +} diff --git a/specification/mixedreality/data-plane/Microsoft.MixedReality/stable/2021-01-01/examples/GetSession.json b/specification/mixedreality/data-plane/Microsoft.MixedReality/stable/2021-01-01/examples/GetSession.json new file mode 100644 index 000000000000..01525ee7f91a --- /dev/null +++ b/specification/mixedreality/data-plane/Microsoft.MixedReality/stable/2021-01-01/examples/GetSession.json @@ -0,0 +1,61 @@ +{ + "parameters": { + "endpoint": "https://remoterendering.eastus.mixedreality.azure.com", + "api-version": "2021-01-01", + "account_id": "30ea64bd-100f-4bf0-adc9-29fa45d4880c", + "session_id": "contoso-session-c2b8ac1d-9494-4852-a59c-8c28813adc28" + }, + "responses": { + "200": { + "headers": { + "MS-CV": "dKEFmka2kkSlDmp/af+sOw" + }, + "body": { + "id": "contoso-session-c2b8ac1d-9494-4852-a59c-8c28813adc28", + "creationTime": "2020-11-11T11:11:11.111Z", + "arrInspectorPort": 50052, + "handshakePort": 50051, + "elapsedTimeMinutes": 10, + "hostname": "d4cefb7b-10b9-4631-934d-67445ffa9126.remoterenderingvm.westus2.mixedreality.azure.com", + "maxLeaseTimeMinutes": 60, + "size": "Standard", + "status": "Ready", + "error": null, + "teraflops": 10.6 + } + }, + "401": { + "headers": { + "WWW-Authenticate": "Bearer error=\"invalid_token\"", + "MS-CV": "dKEFmka2kkSlDmp/af+sOw" + } + }, + "403": { + "headers": { + "MS-CV": "dKEFmka2kkSlDmp/af+sOw" + } + }, + "404": { + "headers": { + "MS-CV": "dKEFmka2kkSlDmp/af+sOw" + } + }, + "429": { + "headers": { + "Retry-After": 15, + "MS-CV": "dKEFmka2kkSlDmp/af+sOw" + } + }, + "500": { + "headers": { + "MS-CV": "dKEFmka2kkSlDmp/af+sOw" + }, + "body": { + "error": { + "code": "InternalServerError", + "message": "An internal server error occurred." + } + } + } + } +} diff --git a/specification/mixedreality/data-plane/Microsoft.MixedReality/stable/2021-01-01/examples/ListConversions.json b/specification/mixedreality/data-plane/Microsoft.MixedReality/stable/2021-01-01/examples/ListConversions.json new file mode 100644 index 000000000000..e88e219e9686 --- /dev/null +++ b/specification/mixedreality/data-plane/Microsoft.MixedReality/stable/2021-01-01/examples/ListConversions.json @@ -0,0 +1,85 @@ +{ + "parameters": { + "endpoint": "https://remoterendering.eastus.mixedreality.azure.com", + "api-version": "2021-01-01", + "account_id": "30ea64bd-100f-4bf0-adc9-29fa45d4880c", + "conversion_id": "contoso-conversion-fbc3646c-0b97-4553-81ca-6fae2bfb754e" + }, + "responses": { + "200": { + "headers": { + "MS-CV": "dKEFmka2kkSlDmp/af+sOw" + }, + "body": { + "conversions": [ + { + "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": "Succeeded", + "error": null, + "output": { + "outputAssetUri": "https://contosostorage01.blob.core.windows.net/arrOutput/conversionOutput/fbc3646c-0b97-4553-81ca-6fae2bfb754e/convertedHouse.arrAsset" + } + }, + { + "id": "contoso-conversion-7da568fb-f3da-4b6d-ba75-d18c8e5a015e", + "creationTime": "2021-02-02T11:11:11.111Z", + "settings": { + "inputLocation": { + "storageContainerUri": "https://contosostorage01.blob.core.windows.net/arrInput", + "blobPrefix": "models/", + "relativeInputAssetPath": "barrel.fbx" + }, + "outputLocation": { + "storageContainerUri": "https://contosostorage01.blob.core.windows.net/arrOutput", + "blobPrefix": "conversionOutput/7da568fb-f3da-4b6d-ba75-d18c8e5a015e" + } + }, + "status": "Running", + "error": null + } + ] + } + }, + "401": { + "headers": { + "WWW-Authenticate": "Bearer error=\"invalid_token\"", + "MS-CV": "dKEFmka2kkSlDmp/af+sOw" + } + }, + "403": { + "headers": { + "MS-CV": "dKEFmka2kkSlDmp/af+sOw" + } + }, + "429": { + "headers": { + "Retry-After": 15, + "MS-CV": "dKEFmka2kkSlDmp/af+sOw" + } + }, + "500": { + "headers": { + "MS-CV": "dKEFmka2kkSlDmp/af+sOw" + }, + "body": { + "error": { + "code": "InternalServerError", + "message": "An internal server error occurred." + } + } + } + } +} diff --git a/specification/mixedreality/data-plane/Microsoft.MixedReality/stable/2021-01-01/examples/ListSessions.json b/specification/mixedreality/data-plane/Microsoft.MixedReality/stable/2021-01-01/examples/ListSessions.json new file mode 100644 index 000000000000..c08a8ed2a60b --- /dev/null +++ b/specification/mixedreality/data-plane/Microsoft.MixedReality/stable/2021-01-01/examples/ListSessions.json @@ -0,0 +1,73 @@ +{ + "parameters": { + "endpoint": "https://remoterendering.eastus.mixedreality.azure.com", + "api-version": "2021-01-01", + "account_id": "30ea64bd-100f-4bf0-adc9-29fa45d4880c", + "conversion_id": "contoso-session-c2b8ac1d-9494-4852-a59c-8c28813adc28" + }, + "responses": { + "200": { + "headers": { + "MS-CV": "dKEFmka2kkSlDmp/af+sOw" + }, + "body": { + "sessions": [ + { + "id": "contoso-session-c2b8ac1d-9494-4852-a59c-8c28813adc28", + "creationTime": "2020-11-11T11:11:11.111Z", + "arrInspectorPort": 50052, + "handshakePort": 50051, + "elapsedTimeMinutes": 59, + "hostname": "d4cefb7b-10b9-4631-934d-67445ffa9126.remoterenderingvm.westus2.mixedreality.azure.com", + "maxLeaseTimeMinutes": 60, + "size": "Standard", + "status": "Stopped", + "error": null, + "teraflops": 10.6 + }, + { + "id": "contoso-session-03c200ce-faf8-4238-8db9-872ac9dd501d", + "creationTime": "2021-01-01T11:11:11.111Z", + "arrInspectorPort": 50053, + "handshakePort": 50052, + "elapsedTimeMinutes": 12, + "hostname": "615854b8-1748-4f2e-9522-bf8523d7299c.remoterenderingvm.westus2.mixedreality.azure.com", + "maxLeaseTimeMinutes": 72, + "size": "Standard", + "status": "Ready", + "error": null, + "teraflops": 10.6 + } + ] + } + }, + "401": { + "headers": { + "WWW-Authenticate": "Bearer error=\"invalid_token\"", + "MS-CV": "dKEFmka2kkSlDmp/af+sOw" + } + }, + "403": { + "headers": { + "MS-CV": "dKEFmka2kkSlDmp/af+sOw" + } + }, + "429": { + "headers": { + "Retry-After": 15, + "MS-CV": "dKEFmka2kkSlDmp/af+sOw" + } + }, + "500": { + "headers": { + "MS-CV": "dKEFmka2kkSlDmp/af+sOw" + }, + "body": { + "error": { + "code": "InternalServerError", + "message": "An internal server error occurred." + } + } + } + } +} diff --git a/specification/mixedreality/data-plane/Microsoft.MixedReality/stable/2021-01-01/examples/StopSession.json b/specification/mixedreality/data-plane/Microsoft.MixedReality/stable/2021-01-01/examples/StopSession.json new file mode 100644 index 000000000000..daa48418a7b9 --- /dev/null +++ b/specification/mixedreality/data-plane/Microsoft.MixedReality/stable/2021-01-01/examples/StopSession.json @@ -0,0 +1,48 @@ +{ + "parameters": { + "endpoint": "https://remoterendering.eastus.mixedreality.azure.com", + "api-version": "2021-01-01", + "account_id": "30ea64bd-100f-4bf0-adc9-29fa45d4880c", + "session_id": "contoso-session-c2b8ac1d-9494-4852-a59c-8c28813adc28" + }, + "responses": { + "204": { + "headers": { + "MS-CV": "dKEFmka2kkSlDmp/af+sOw" + } + }, + "401": { + "headers": { + "WWW-Authenticate": "Bearer error=\"invalid_token\"", + "MS-CV": "dKEFmka2kkSlDmp/af+sOw" + } + }, + "403": { + "headers": { + "MS-CV": "dKEFmka2kkSlDmp/af+sOw" + } + }, + "404": { + "headers": { + "MS-CV": "dKEFmka2kkSlDmp/af+sOw" + } + }, + "429": { + "headers": { + "Retry-After": 15, + "MS-CV": "dKEFmka2kkSlDmp/af+sOw" + } + }, + "500": { + "headers": { + "MS-CV": "dKEFmka2kkSlDmp/af+sOw" + }, + "body": { + "error": { + "code": "InternalServerError", + "message": "An internal server error occurred." + } + } + } + } +} diff --git a/specification/mixedreality/data-plane/Microsoft.MixedReality/stable/2021-01-01/examples/UpdateSession.json b/specification/mixedreality/data-plane/Microsoft.MixedReality/stable/2021-01-01/examples/UpdateSession.json new file mode 100644 index 000000000000..7c220f73cfa5 --- /dev/null +++ b/specification/mixedreality/data-plane/Microsoft.MixedReality/stable/2021-01-01/examples/UpdateSession.json @@ -0,0 +1,75 @@ +{ + "parameters": { + "endpoint": "https://remoterendering.eastus.mixedreality.azure.com", + "api-version": "2021-01-01", + "account_id": "30ea64bd-100f-4bf0-adc9-29fa45d4880c", + "session_id": "contoso-session-c2b8ac1d-9494-4852-a59c-8c28813adc28", + "body": { + "maxLeaseTimeMinutes": 72 + } + }, + "responses": { + "200": { + "headers": { + "MS-CV": "dKEFmka2kkSlDmp/af+sOw" + }, + "body": { + "id": "contoso-session-c2b8ac1d-9494-4852-a59c-8c28813adc28", + "creationTime": "2020-11-11T11:11:11.111Z", + "arrInspectorPort": 50052, + "handshakePort": 50051, + "elapsedTimeMinutes": 10, + "hostname": "d4cefb7b-10b9-4631-934d-67445ffa9126.remoterenderingvm.westus2.mixedreality.azure.com", + "maxLeaseTimeMinutes": 72, + "size": "Standard", + "status": "Ready", + "error": null, + "teraflops": 10.6 + } + }, + "401": { + "headers": { + "WWW-Authenticate": "Bearer error=\"invalid_token\"", + "MS-CV": "dKEFmka2kkSlDmp/af+sOw" + } + }, + "403": { + "headers": { + "MS-CV": "dKEFmka2kkSlDmp/af+sOw" + } + }, + "404": { + "headers": { + "MS-CV": "dKEFmka2kkSlDmp/af+sOw" + } + }, + "422": { + "headers": { + "MS-CV": "dKEFmka2kkSlDmp/af+sOw" + }, + "body": { + "error": { + "code": "UnprocessableEntity", + "message": "The request was malformed." + } + } + }, + "429": { + "headers": { + "Retry-After": 15, + "MS-CV": "dKEFmka2kkSlDmp/af+sOw" + } + }, + "500": { + "headers": { + "MS-CV": "dKEFmka2kkSlDmp/af+sOw" + }, + "body": { + "error": { + "code": "InternalServerError", + "message": "An internal server error occurred." + } + } + } + } +} diff --git a/specification/mixedreality/data-plane/Microsoft.MixedReality/stable/2021-01-01/mr-arr.json b/specification/mixedreality/data-plane/Microsoft.MixedReality/stable/2021-01-01/mr-arr.json new file mode 100644 index 000000000000..f7b57b0d7fb8 --- /dev/null +++ b/specification/mixedreality/data-plane/Microsoft.MixedReality/stable/2021-01-01/mr-arr.json @@ -0,0 +1,1393 @@ +{ + "swagger": "2.0", + "info": { + "description": "Describing the [Azure Remote Rendering](https://docs.microsoft.com/azure/remote-rendering/) REST API for rendering sessions and asset conversions. \n\nAll requests to these APIs must be authenticated using the Secure Token Service as described in the [Azure Remote rendering documentation chapter about authentication](https://docs.microsoft.com/azure/remote-rendering/how-tos/tokens).\n", + "title": "MixedRealityRemoteRendering", + "version": "2021-01-01" + }, + "x-ms-parameterized-host": { + "hostTemplate": "{endpoint}", + "useSchemePrefix": false, + "parameters": [ + { + "$ref": "#/parameters/Endpoint" + } + ] + }, + "schemes": [ + "https" + ], + "paths": { + "/accounts/{account_id}/conversions/{conversion_id}": { + "put": { + "operationId": "RemoteRendering_CreateConversion", + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "x-ms-examples": { + "Create a conversion": { + "$ref": "./examples/CreateConversion.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/api_version" + }, + { + "$ref": "#/parameters/account_id" + }, + { + "$ref": "#/parameters/conversion_id" + }, + { + "description": "Request body configuring the settings for an asset conversion.", + "in": "body", + "name": "body", + "required": true, + "schema": { + "$ref": "#/definitions/create_conversion_settings" + } + } + ], + "responses": { + "200": { + "description": "OK. Indicates that there was already a conversion with the same settings present. This is expected when a conversion creation is retried.", + "headers": { + "MS-CV": { + "description": "Microsoft Correlation Vector. Include this value when reporting issues.", + "type": "string" + } + }, + "schema": { + "$ref": "#/definitions/conversion" + } + }, + "201": { + "description": "Created. A new conversion was created.", + "headers": { + "MS-CV": { + "description": "Microsoft Correlation Vector. Include this value when reporting issues.", + "type": "string" + } + }, + "schema": { + "$ref": "#/definitions/conversion" + } + }, + "400": { + "description": "Bad Request. Returned error object describes which issues occurred.", + "x-ms-error-response": true, + "headers": { + "MS-CV": { + "description": "Microsoft Correlation Vector. Include this value when reporting issues.", + "type": "string" + } + }, + "schema": { + "$ref": "#/definitions/error_response" + } + }, + "401": { + "description": "Unauthorized. Missing or invalid authorization.", + "x-ms-error-response": true, + "headers": { + "MS-CV": { + "description": "Microsoft Correlation Vector. Include this value when reporting issues.", + "type": "string" + }, + "WWW-Authenticate": { + "description": "Describes the error encountered while trying to authenticate the resource.", + "type": "string" + } + } + }, + "403": { + "description": "Forbidden. Authorization insufficient for given resource.", + "x-ms-error-response": true, + "headers": { + "MS-CV": { + "description": "Microsoft Correlation Vector. Include this value when reporting issues.", + "type": "string" + } + } + }, + "409": { + "description": "Conflict. A conversion already exists. An error object describes which issues occurred.", + "x-ms-error-response": true, + "headers": { + "MS-CV": { + "description": "Microsoft Correlation Vector. Include this value when reporting issues.", + "type": "string" + } + }, + "schema": { + "$ref": "#/definitions/error_response" + } + }, + "429": { + "description": "Too Many Requests. The rate limit has been exceeded. Retry the request after the duration given in the Retry-After header.", + "x-ms-error-response": true, + "headers": { + "MS-CV": { + "description": "Microsoft Correlation Vector. Include this value when reporting issues.", + "type": "string" + }, + "Retry-After": { + "description": "The minimum number of seconds to wait before not getting this response anymore.", + "type": "integer" + } + } + }, + "500": { + "description": "Internal Error. Server has encountered an internal error. Retrying the request may produce successful results.", + "x-ms-error-response": true, + "schema": { + "$ref": "#/definitions/error_response" + } + } + }, + "tags": [ + "conversion" + ], + "summary": "Creates a conversion using an asset stored in an Azure Blob Storage account." + }, + "get": { + "operationId": "RemoteRendering_GetConversion", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/api_version" + }, + { + "$ref": "#/parameters/account_id" + }, + { + "$ref": "#/parameters/conversion_id" + } + ], + "x-ms-examples": { + "Get a single conversion by ID": { + "$ref": "./examples/GetConversion.json" + } + }, + "responses": { + "200": { + "description": "OK.", + "headers": { + "MS-CV": { + "description": "Microsoft Correlation Vector. Include this value when reporting issues.", + "type": "string" + }, + "Retry-After": { + "description": "Time in seconds when the status of this conversion should be polled again", + "type": "integer" + } + }, + "schema": { + "$ref": "#/definitions/conversion" + } + }, + "401": { + "description": "Unauthorized. Missing or invalid authorization.", + "x-ms-error-response": true, + "headers": { + "MS-CV": { + "description": "Microsoft Correlation Vector. Include this value when reporting issues.", + "type": "string" + }, + "WWW-Authenticate": { + "description": "Describes the error encountered while trying to authenticate the resource.", + "type": "string" + } + } + }, + "403": { + "description": "Forbidden. Authorization insufficient for given resource.", + "x-ms-error-response": true, + "headers": { + "MS-CV": { + "description": "Microsoft Correlation Vector. Include this value when reporting issues.", + "type": "string" + } + } + }, + "404": { + "description": "Not found. No conversion with the provided conversion ID exists.", + "x-ms-error-response": true, + "headers": { + "MS-CV": { + "description": "Microsoft Correlation Vector. Include this value when reporting issues.", + "type": "string" + } + } + }, + "429": { + "description": "Too Many Requests. The rate limit has been exceeded. Retry the request after the duration given in the Retry-After header.", + "x-ms-error-response": true, + "headers": { + "MS-CV": { + "description": "Microsoft Correlation Vector. Include this value when reporting issues.", + "type": "string" + }, + "Retry-After": { + "description": "The minimum number of seconds to wait before not getting this response anymore.", + "type": "integer" + } + } + }, + "500": { + "description": "Internal Error. Server has encountered an internal error. Retrying the request may produce successful results.", + "x-ms-error-response": true, + "headers": { + "MS-CV": { + "description": "Microsoft Correlation Vector. Include this value when reporting issues.", + "type": "string" + } + }, + "schema": { + "$ref": "#/definitions/error_response" + } + } + }, + "tags": [ + "conversion" + ], + "summary": "Gets the status of a particular conversion." + } + }, + "/accounts/{account_id}/conversions": { + "get": { + "operationId": "RemoteRendering_ListConversions", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/api_version" + }, + { + "$ref": "#/parameters/account_id" + } + ], + "x-ms-examples": { + "List conversions": { + "$ref": "./examples/ListConversions.json" + } + }, + "responses": { + "200": { + "description": "OK.", + "headers": { + "MS-CV": { + "description": "Microsoft Correlation Vector. Include this value when reporting issues.", + "type": "string" + } + }, + "schema": { + "$ref": "#/definitions/conversion_list" + } + }, + "401": { + "description": "Unauthorized. Missing or invalid authorization.", + "x-ms-error-response": true, + "headers": { + "MS-CV": { + "description": "Microsoft Correlation Vector. Include this value when reporting errors to the Azure Remote Rendering team.", + "type": "string" + }, + "WWW-Authenticate": { + "description": "Describes the error encountered while trying to authenticate the resource.", + "type": "string" + } + } + }, + "403": { + "description": "Forbidden. Authorization insufficient for given resource.", + "x-ms-error-response": true, + "headers": { + "MS-CV": { + "description": "Microsoft Correlation Vector. Include this value when reporting errors to the Azure Remote Rendering team.", + "type": "string" + } + } + }, + "429": { + "description": "Too Many Requests. The rate limit has been exceeded. Retry the request after the duration given in the Retry-After header.", + "x-ms-error-response": true, + "headers": { + "MS-CV": { + "description": "Microsoft Correlation Vector. Include this value when reporting errors to the Azure Remote Rendering team.", + "type": "string" + }, + "Retry-After": { + "description": "The minimum number of seconds to wait before not getting this response anymore.", + "type": "integer" + } + } + }, + "500": { + "description": "Internal Error. Server has encountered an internal error. Retrying the request may produce successful results.", + "x-ms-error-response": true, + "headers": { + "MS-CV": { + "description": "Microsoft Correlation Vector. Include this value when reporting errors to the Azure Remote Rendering team.", + "type": "string" + } + }, + "schema": { + "$ref": "#/definitions/error_response" + } + } + }, + "x-ms-pageable": { + "itemName": "conversions", + "nextLinkName": "@nextLink" + }, + "tags": [ + "conversion" + ], + "summary": "Gets a list of all conversions." + } + }, + "/accounts/{account_id}/sessions/{session_id}": { + "put": { + "operationId": "RemoteRendering_CreateSession", + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/api_version" + }, + { + "$ref": "#/parameters/account_id" + }, + { + "$ref": "#/parameters/session_id" + }, + { + "description": "Settings of the session to be created.", + "in": "body", + "name": "body", + "required": true, + "schema": { + "$ref": "#/definitions/create_session_settings" + } + } + ], + "x-ms-examples": { + "Create a rendering session": { + "$ref": "./examples/CreateSession.json" + } + }, + "responses": { + "200": { + "description": "OK. Indicates that there was already a session with the same settings present. This is expected when session creation is retried.", + "schema": { + "$ref": "#/definitions/session_properties" + } + }, + "201": { + "description": "Created. The session was created successfully.", + "schema": { + "$ref": "#/definitions/session_properties" + }, + "headers": { + "MS-CV": { + "description": "Microsoft Correlation Vector. Include this value when reporting issues.", + "type": "string" + } + } + }, + "400": { + "description": "Bad Request. Returned error object describes which issues occurred.", + "x-ms-error-response": true, + "headers": { + "MS-CV": { + "description": "Microsoft Correlation Vector. Include this value when reporting issues.", + "type": "string" + } + }, + "schema": { + "$ref": "#/definitions/error_response" + } + }, + "401": { + "description": "Unauthorized. Missing or invalid authorization.", + "x-ms-error-response": true, + "headers": { + "MS-CV": { + "description": "Microsoft Correlation Vector. Include this value when reporting issues.", + "type": "string" + }, + "WWW-Authenticate": { + "description": "Describes the error encountered while trying to authenticate the resource.", + "type": "string" + } + } + }, + "403": { + "description": "Forbidden. Authorization insufficient for given resource.", + "x-ms-error-response": true, + "headers": { + "MS-CV": { + "description": "Microsoft Correlation Vector. Include this value when reporting issues.", + "type": "string" + } + } + }, + "409": { + "description": "Conflict. A rendering session with the ID already exists for the remote rendering account.", + "x-ms-error-response": true, + "schema": { + "$ref": "#/definitions/error_response" + } + }, + "429": { + "description": "Too Many Requests. The rate limit has been exceeded. Retry the request after the duration given in the Retry-After header.", + "x-ms-error-response": true, + "headers": { + "MS-CV": { + "description": "Microsoft Correlation Vector. Include this value when reporting issues.", + "type": "string" + }, + "Retry-After": { + "description": "The minimum number of seconds to wait before not getting this response anymore.", + "type": "integer" + } + } + }, + "500": { + "description": "Internal Error. Server has encountered an internal error. Retrying the request may produce successful results.", + "x-ms-error-response": true, + "headers": { + "MS-CV": { + "description": "Microsoft Correlation Vector. Include this value when reporting issues.", + "type": "string" + } + }, + "schema": { + "$ref": "#/definitions/error_response" + } + } + }, + "tags": [ + "rendering session" + ], + "summary": "Creates a new rendering session." + }, + "get": { + "operationId": "RemoteRendering_GetSession", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/api_version" + }, + { + "$ref": "#/parameters/account_id" + }, + { + "$ref": "#/parameters/session_id" + } + ], + "x-ms-examples": { + "Get a previously created session by ID": { + "$ref": "./examples/GetSession.json" + } + }, + "responses": { + "200": { + "description": "OK.", + "schema": { + "$ref": "#/definitions/session_properties" + } + }, + "401": { + "description": "Unauthorized. Missing or invalid authorization.", + "x-ms-error-response": true, + "headers": { + "MS-CV": { + "description": "Microsoft Correlation Vector. Include this value when reporting issues.", + "type": "string" + }, + "WWW-Authenticate": { + "description": "Describes the error encountered while trying to authenticate the resource.", + "type": "string" + } + } + }, + "403": { + "description": "Forbidden. Authorization insufficient for given resource.", + "x-ms-error-response": true, + "headers": { + "MS-CV": { + "description": "Microsoft Correlation Vector. Include this value when reporting issues.", + "type": "string" + } + } + }, + "404": { + "description": "Not found. No session with the provided session ID exists.", + "x-ms-error-response": true, + "headers": { + "MS-CV": { + "description": "Microsoft Correlation Vector. Include this value when reporting issues.", + "type": "string" + } + } + }, + "429": { + "description": "Too Many Requests. The rate limit has been exceeded. Retry the request after the duration given in the Retry-After header.", + "x-ms-error-response": true, + "headers": { + "MS-CV": { + "description": "Microsoft Correlation Vector. Include this value when reporting issues.", + "type": "string" + }, + "Retry-After": { + "description": "The minimum number of seconds to wait before not getting this response anymore.", + "type": "integer" + } + } + }, + "500": { + "description": "Internal Error. Server has encountered an internal error. Retrying the request may produce successful results.", + "x-ms-error-response": true, + "headers": { + "MS-CV": { + "description": "Microsoft Correlation Vector. Include this value when reporting issues.", + "type": "string" + } + }, + "schema": { + "$ref": "#/definitions/error_response" + } + } + }, + "tags": [ + "rendering session" + ], + "summary": "Gets the properties of a particular rendering session." + }, + "patch": { + "operationId": "RemoteRendering_UpdateSession", + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/api_version" + }, + { + "$ref": "#/parameters/account_id" + }, + { + "$ref": "#/parameters/session_id" + }, + { + "description": "Settings used to update the session.", + "in": "body", + "name": "body", + "required": true, + "schema": { + "$ref": "#/definitions/update_session_settings" + } + } + ], + "x-ms-examples": { + "Update a session": { + "$ref": "./examples/UpdateSession.json" + } + }, + "responses": { + "200": { + "description": "OK. Session has been updated.", + "schema": { + "$ref": "#/definitions/session_properties" + } + }, + "401": { + "description": "Unauthorized. Missing or invalid authorization.", + "x-ms-error-response": true, + "headers": { + "MS-CV": { + "description": "Microsoft Correlation Vector. Include this value when reporting issues.", + "type": "string" + }, + "WWW-Authenticate": { + "description": "Describes the error encountered while trying to authenticate the resource.", + "type": "string" + } + } + }, + "403": { + "description": "Forbidden. Authorization insufficient for given resource.", + "x-ms-error-response": true, + "headers": { + "MS-CV": { + "description": "Microsoft Correlation Vector. Include this value when reporting issues.", + "type": "string" + } + } + }, + "404": { + "description": "Not found. No session with the provided session ID exists.", + "x-ms-error-response": true, + "headers": { + "MS-CV": { + "description": "Microsoft Correlation Vector. Include this value when reporting issues.", + "type": "string" + } + } + }, + "429": { + "description": "Too Many Requests. The rate limit has been exceeded. Retry the request after the duration given in the Retry-After header.", + "x-ms-error-response": true, + "headers": { + "MS-CV": { + "description": "Microsoft Correlation Vector. Include this value when reporting issues.", + "type": "string" + }, + "Retry-After": { + "description": "The minimum number of seconds to wait before not getting this response anymore.", + "type": "integer" + } + } + }, + "422": { + "description": "Unprocessable Entity. The maxLeaseTimeMinutes value was invalid. It has to be bigger than the current value of maxLeaseTimeMinutes.", + "x-ms-error-response": true, + "headers": { + "MS-CV": { + "description": "Microsoft Correlation Vector. Include this value when reporting issues.", + "type": "string" + } + }, + "schema": { + "$ref": "#/definitions/error_response" + } + }, + "500": { + "description": "Internal Error. Server has encountered an internal error. Retrying the request may produce successful results.", + "x-ms-error-response": true, + "headers": { + "MS-CV": { + "description": "Microsoft Correlation Vector. Include this value when reporting issues.", + "type": "string" + } + }, + "schema": { + "$ref": "#/definitions/error_response" + } + } + }, + "tags": [ + "rendering session" + ], + "summary": "Updates the max lease time of a particular rendering session." + } + }, + "/accounts/{account_id}/sessions/{session_id}/:stop": { + "post": { + "operationId": "RemoteRendering_StopSession", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/api_version" + }, + { + "$ref": "#/parameters/account_id" + }, + { + "$ref": "#/parameters/session_id" + } + ], + "x-ms-examples": { + "Stop a session": { + "$ref": "./examples/StopSession.json" + } + }, + "responses": { + "204": { + "description": "NoContent. Stop request was successful. The rendering session is stopped.", + "headers": { + "MS-CV": { + "description": "Microsoft Correlation Vector. Include this value when reporting issues.", + "type": "string" + } + } + }, + "401": { + "description": "Unauthorized. Missing or invalid authorization.", + "x-ms-error-response": true, + "headers": { + "MS-CV": { + "description": "Microsoft Correlation Vector. Include this value when reporting issues.", + "type": "string" + }, + "WWW-Authenticate": { + "description": "Describes the error encountered while trying to authenticate the resource.", + "type": "string" + } + } + }, + "403": { + "description": "Forbidden. Authorization insufficient for given resource.", + "x-ms-error-response": true, + "headers": { + "MS-CV": { + "description": "Microsoft Correlation Vector. Include this value when reporting issues.", + "type": "string" + } + } + }, + "404": { + "description": "Not found. No session with the provided session ID exists.", + "x-ms-error-response": true, + "headers": { + "MS-CV": { + "description": "Microsoft Correlation Vector. Include this value when reporting issues.", + "type": "string" + } + } + }, + "429": { + "description": "Too Many Requests. The rate limit has been exceeded. Retry the request after the duration given in the Retry-After header.", + "x-ms-error-response": true, + "headers": { + "MS-CV": { + "description": "Microsoft Correlation Vector. Include this value when reporting issues.", + "type": "string" + }, + "Retry-After": { + "description": "The minimum number of seconds to wait before not getting this response anymore.", + "type": "integer" + } + } + }, + "500": { + "description": "Internal Error. Server has encountered an internal error. Retrying the request may produce successful results.", + "x-ms-error-response": true, + "headers": { + "MS-CV": { + "description": "Microsoft Correlation Vector. Include this value when reporting issues.", + "type": "string" + } + }, + "schema": { + "$ref": "#/definitions/error_response" + } + } + }, + "tags": [ + "rendering session" + ], + "summary": "Stops a particular rendering session." + } + }, + "/accounts/{account_id}/sessions": { + "get": { + "operationId": "RemoteRendering_ListSessions", + "produces": [ + "application/json" + ], + "x-ms-pageable": { + "itemName": "sessions", + "nextLinkName": "@nextLink" + }, + "parameters": [ + { + "$ref": "#/parameters/api_version" + }, + { + "$ref": "#/parameters/account_id" + } + ], + "x-ms-examples": { + "List sessions": { + "$ref": "./examples/ListSessions.json" + } + }, + "responses": { + "200": { + "description": "OK. Returns the list of sessions which are in a 'Starting' or 'Ready' state.", + "schema": { + "$ref": "#/definitions/sessions_list" + } + }, + "401": { + "description": "Unauthorized. Missing or invalid authorization.", + "x-ms-error-response": true, + "headers": { + "MS-CV": { + "description": "Microsoft Correlation Vector. Include this value when reporting issues.", + "type": "string" + }, + "WWW-Authenticate": { + "description": "Describes the error encountered while trying to authenticate the resource.", + "type": "string" + } + } + }, + "403": { + "description": "Forbidden. Authorization insufficient for given resource.", + "x-ms-error-response": true, + "headers": { + "MS-CV": { + "description": "Microsoft Correlation Vector. Include this value when reporting issues.", + "type": "string" + } + } + }, + "429": { + "description": "Too Many Requests. The rate limit has been exceeded. Retry the request after the duration given in the Retry-After header.", + "x-ms-error-response": true, + "headers": { + "MS-CV": { + "description": "Microsoft Correlation Vector. Include this value when reporting issues.", + "type": "string" + }, + "Retry-After": { + "description": "The minimum number of seconds to wait before not getting this response anymore.", + "type": "integer" + } + } + }, + "500": { + "description": "Internal Error. Server has encountered an internal error. Retrying the request may produce successful results.", + "x-ms-error-response": true, + "headers": { + "MS-CV": { + "description": "Microsoft Correlation Vector. Include this value when reporting issues.", + "type": "string" + } + }, + "schema": { + "$ref": "#/definitions/error_response" + } + } + }, + "tags": [ + "rendering session" + ], + "summary": "Gets a list of all rendering sessions." + } + } + }, + "definitions": { + "conversion": { + "description": "The properties of the conversion.", + "properties": { + "id": { + "type": "string", + "description": "The ID of the conversion supplied when the conversion was created." + }, + "settings": { + "$ref": "#/definitions/conversion_settings" + }, + "output": { + "type": "object", + "description": "Information about the output of a successful conversion. Only present when the status of the conversion is 'Succeeded'.", + "properties": { + "outputAssetUri": { + "type": "string", + "description": "URI of the asset generated by the conversion process.", + "format": "uri", + "example": "https://contoso.blob.core.windows.net/arr/architecture-output/house.arrAsset", + "readOnly": true + } + }, + "readOnly": true + }, + "error": { + "x-nullable": true, + "description": "The error object containing details about the conversion failure.", + "type": "object", + "$ref": "#/definitions/error", + "example": null + }, + "status": { + "$ref": "#/definitions/conversion_status" + }, + "creationTime": { + "type": "string", + "description": "The time when the conversion was created. Date and time in ISO 8601 format.", + "format": "date-time" + } + }, + "required": [ + "id", + "settings", + "status", + "error", + "creationTime" + ], + "type": "object" + }, + "conversion_list": { + "description": "List of conversions.", + "properties": { + "conversions": { + "items": { + "$ref": "#/definitions/conversion" + }, + "type": "array", + "description": "The list of conversions." + }, + "@nextLink": { + "description": "If more conversions are available this field will contain a URL where the next batch of conversions can be requested. This URL will need the same authentication as all calls to the Azure Remote Rendering API.", + "type": "string", + "readOnly": true + } + }, + "required": [ + "conversions" + ], + "type": "object" + }, + "conversion_input_settings": { + "properties": { + "storageContainerUri": { + "type": "string", + "description": "The URI of the Azure blob storage container containing the input model.", + "format": "uri", + "example": "https://contosostorage01.blob.core.windows.net/arrInput" + }, + "storageContainerReadListSas": { + "type": "string", + "description": "An Azure blob storage container shared access signature giving read and list access to the storage container. Optional. If not provided, the Azure Remote Rendering account needs to be linked with the storage account containing the blob container. See https://docs.microsoft.com/azure/remote-rendering/how-tos/create-an-account#link-storage-accounts for details. For security purposes this field will never be filled out in responses bodies." + }, + "blobPrefix": { + "type": "string", + "description": "Only Blobs starting with this prefix will be downloaded to perform the conversion. Optional. If not provided, all Blobs from the container will be downloaded.", + "example": "models/" + }, + "relativeInputAssetPath": { + "type": "string", + "description": "The relative path starting at blobPrefix (or at the container root if blobPrefix is not provided) to the input model. Must point to a file with a supported file format ending. See https://docs.microsoft.com/azure/remote-rendering/how-tos/conversion/model-conversion for details.", + "example": "house.fbx" + } + }, + "required": [ + "storageContainerUri", + "relativeInputAssetPath" + ], + "type": "object", + "description": "Conversion input settings describe the origin of conversion input." + }, + "conversion_output_settings": { + "properties": { + "storageContainerUri": { + "type": "string", + "description": "The URI of the Azure blob storage container where the result of the conversion should be written to.", + "format": "uri", + "example": "https://contosostorage01.blob.core.windows.net/arrOutput" + }, + "storageContainerWriteSas": { + "type": "string", + "description": "An Azure blob storage container shared access signature giving write access to the storage container. Optional. If not provided, the Azure Remote Rendering account needs to be linked with the storage account containing the blob container. See https://docs.microsoft.com/azure/remote-rendering/how-tos/create-an-account#link-storage-accounts for details. For security purposes this field will never be filled out in responses bodies." + }, + "blobPrefix": { + "type": "string", + "description": "A prefix which gets prepended in front of all files produced by the conversion process. Will be treated as a virtual folder. Optional. If not provided, output files will be stored at the container root.", + "example": "conversionOutput/fbc3646c-0b97-4553-81ca-6fae2bfb754e" + }, + "outputAssetFilename": { + "type": "string", + "description": "The file name of the output asset. Must end in '.arrAsset'. Optional. If not provided, file name will the same name as the input asset, with '.arrAsset' extension", + "example": "house.arrAsset" + } + }, + "required": [ + "storageContainerUri" + ], + "type": "object", + "description": "Conversion output settings describe the destination of conversion output." + }, + "create_conversion_settings": { + "description": "Request to start a conversion", + "properties": { + "settings": { + "$ref": "#/definitions/conversion_settings" + } + }, + "required": [ + "settings" + ], + "type": "object" + }, + "conversion_settings": { + "description": "Conversion settings describe the origin of input files and destination of output files.", + "properties": { + "inputLocation": { + "$ref": "#/definitions/conversion_input_settings" + }, + "outputLocation": { + "$ref": "#/definitions/conversion_output_settings" + } + }, + "required": [ + "inputLocation", + "outputLocation" + ], + "type": "object" + }, + "conversion_status": { + "description": "The status of the conversion. Terminal states are 'Cancelled', 'Failed', and 'Succeeded'.", + "enum": [ + "NotStarted", + "Running", + "Cancelled", + "Failed", + "Succeeded" + ], + "type": "string", + "x-ms-enum": { + "name": "conversion_status", + "modelAsString": true, + "values": [ + { + "value": "NotStarted", + "description": "The conversion was created but hasn't started." + }, + { + "value": "Running", + "description": "The conversion is running." + }, + { + "value": "Cancelled", + "description": "The conversion was cancelled. This is a terminal state." + }, + { + "value": "Failed", + "description": "The conversion has failed. Check the 'error' field for more details. This is a terminal state." + }, + { + "value": "Succeeded", + "description": "The conversion has succeeded. Check the 'output' field for output asset location. This is a terminal state." + } + ] + } + }, + "error_response": { + "description": "The error response containing details of why the request failed.", + "properties": { + "error": { + "description": "The error object containing details of why the request failed.", + "type": "object", + "$ref": "#/definitions/error" + } + }, + "type": "object", + "required": [ + "error" + ] + }, + "error": { + "description": "The error object containing details of why the request failed.", + "properties": { + "code": { + "type": "string", + "description": "Error code." + }, + "message": { + "type": "string", + "description": "A human-readable representation of the error." + }, + "details": { + "type": "array", + "items": { + "$ref": "#/definitions/error" + }, + "description": "An array of details about specific errors that led to this reported error.", + "readOnly": true + }, + "target": { + "description": "The target of the particular error (e.g., the name of the property in error).", + "type": "string", + "readOnly": true + }, + "innerError": { + "type": "object", + "$ref": "#/definitions/error", + "description": "An object containing more specific information than the current object about the error.", + "readOnly": true + } + }, + "type": "object", + "required": [ + "code", + "message" + ] + }, + "session_properties": { + "description": "The properties of a rendering session.", + "properties": { + "id": { + "example": "contoso-session-c2b8ac1d-9494-4852-a59c-8c28813adc28", + "type": "string", + "description": "The ID of the session supplied when the session was created." + }, + "arrInspectorPort": { + "example": 50052, + "maximum": 65534, + "minimum": 49152, + "type": "integer", + "description": "The TCP port at which the Azure Remote Rendering Inspector tool is hosted.", + "readOnly": true + }, + "handshakePort": { + "example": 50051, + "maximum": 65534, + "minimum": 49152, + "type": "integer", + "description": "The TCP port used for the handshake when establishing a connection.", + "readOnly": true + }, + "elapsedTimeMinutes": { + "description": "Amount of time in minutes the session is or was in the 'Ready' state. Time is rounded down to a full minute.", + "example": 10, + "type": "integer", + "readOnly": true + }, + "hostname": { + "example": "d4cefb7b-10b9-4631-934d-67445ffa9126.remoterenderingvm.westus2.mixedreality.azure.com", + "type": "string", + "description": "The hostname under which the rendering session is reachable.", + "readOnly": true + }, + "maxLeaseTimeMinutes": { + "type": "integer", + "description": "The time in minutes the session will run after reaching the 'Ready' state.", + "example": 60, + "readOnly": true + }, + "size": { + "$ref": "#/definitions/session_size", + "example": "Standard" + }, + "status": { + "$ref": "#/definitions/session_status", + "example": "Ready" + }, + "teraflops": { + "example": 10.6, + "format": "float", + "type": "number", + "description": "The computational power of the rendering session GPU measured in teraflops.", + "readOnly": true + }, + "error": { + "x-nullable": true, + "description": "The error object containing details about the rendering session startup failure.", + "type": "object", + "$ref": "#/definitions/error", + "example": null, + "readOnly": true + }, + "creationTime": { + "type": "string", + "format": "date-time", + "description": "The time when the rendering session was created. Date and time in ISO 8601 format.", + "readOnly": true + } + }, + "type": "object", + "required": [ + "id", + "size", + "status" + ] + }, + "create_session_settings": { + "description": "Settings of the session to be created.", + "properties": { + "maxLeaseTimeMinutes": { + "example": 60, + "type": "integer", + "description": "The time in minutes the session will run after reaching the 'Ready' state. It has to be between 0 and 1440." + }, + "size": { + "$ref": "#/definitions/session_size" + } + }, + "type": "object", + "required": [ + "maxLeaseTimeMinutes", + "size" + ] + }, + "update_session_settings": { + "description": "Settings used to update the session.", + "type": "object", + "properties": { + "maxLeaseTimeMinutes": { + "description": "Update to the time the session will run after it reached the 'Ready' state. It has to be larger than the current value of maxLeaseTimeMinutes and less than 1440.", + "example": 72, + "type": "integer" + } + }, + "required": [ + "maxLeaseTimeMinutes" + ] + }, + "session_status": { + "enum": [ + "Error", + "Expired", + "Starting", + "Ready", + "Stopped" + ], + "x-ms-enum": { + "name": "session_status", + "modelAsString": true, + "values": [ + { + "value": "Error", + "description": "The rendering session has encountered an error, and is unusable. This is a terminal state." + }, + { + "value": "Expired", + "description": "The rendering session enters the 'Expired' state when it has been in the 'Ready' state longer than its lease time. This is a terminal state." + }, + { + "value": "Starting", + "description": "The rendering session is starting, but not accepting incoming connections yet." + }, + { + "value": "Ready", + "description": "The rendering session is ready for incoming connections." + }, + { + "value": "Stopped", + "description": "The rendering session has been stopped with the 'Stop Session' operation. This is a terminal state." + } + ] + }, + "type": "string", + "example": "Ready", + "description": "The status of the rendering session. Terminal states are 'Error', 'Expired', and 'Stopped'." + }, + "session_size": { + "enum": [ + "Standard", + "Premium" + ], + "x-ms-enum": { + "name": "session_size", + "modelAsString": true, + "values": [ + { + "value": "Standard", + "description": "Standard rendering session size." + }, + { + "value": "Premium", + "description": "Premium rendering session size." + } + ] + }, + "example": "Standard", + "type": "string", + "description": "The size of the server used for the rendering session. The size impacts the number of polygons the server can render. Refer to https://docs.microsoft.com/azure/remote-rendering/reference/vm-sizes for details." + }, + "sessions_list": { + "description": "The result of a list sessions request.", + "type": "object", + "properties": { + "sessions": { + "type": "array", + "description": "The list of rendering sessions. Does not include sessions in 'Stopped' state.", + "items": { + "$ref": "#/definitions/session_properties" + } + }, + "@nextLink": { + "description": "If more rendering sessions are available this field will contain a URL where the next batch of sessions can be requested. This URL will need the same authentication as all calls to the Azure Remote Rendering API.", + "type": "string", + "readOnly": true + } + }, + "required": [ + "sessions" + ] + } + }, + "parameters": { + "Endpoint": { + "name": "endpoint", + "description": "The endpoint to use e.g. https://remoterendering.eastus.mixedreality.azure.com. A list can be found at https://docs.microsoft.com/azure/remote-rendering/reference/regions.", + "required": true, + "type": "string", + "in": "path", + "x-ms-skip-url-encoding": true, + "x-ms-parameter-location": "client" + }, + "api_version": { + "name": "api-version", + "in": "query", + "description": "The API version to be used with the HTTP request.", + "required": true, + "type": "string", + "x-example": "2021-01-01", + "x-ms-parameter-location": "method" + }, + "account_id": { + "name": "account_id", + "description": "The Azure Remote Rendering account ID.", + "format": "uuid", + "in": "path", + "required": true, + "type": "string", + "x-example": "30ea64bd-100f-4bf0-adc9-29fa45d4880c", + "x-ms-parameter-location": "method" + }, + "conversion_id": { + "description": "An ID uniquely identifying the conversion for the given account. The ID is case sensitive, can contain any combination of alphanumeric characters including hyphens and underscores, and cannot contain more than 256 characters.", + "in": "path", + "name": "conversion_id", + "required": true, + "type": "string", + "x-example": "contoso-conversion-fbc3646c-0b97-4553-81ca-6fae2bfb754e", + "x-ms-parameter-location": "method" + }, + "session_id": { + "name": "session_id", + "description": "An ID uniquely identifying the rendering session for the given account. The ID is case sensitive, can contain any combination of alphanumeric characters including hyphens and underscores, and cannot contain more than 256 characters.", + "in": "path", + "required": true, + "type": "string", + "x-example": "contoso-session-c2b8ac1d-9494-4852-a59c-8c28813adc28", + "x-ms-parameter-location": "method" + } + }, + "securityDefinitions": { + "MrcBearerAuth": { + "in": "header", + "name": "Authorization", + "type": "apiKey", + "description": "A bearer token returned by the Mixed Reality Secure Token Service. See https://docs.microsoft.com/azure/remote-rendering/how-tos/tokens for details." + } + }, + "security": [ + { + "MrcBearerAuth": [] + } + ] +} diff --git a/specification/mixedreality/data-plane/readme.md b/specification/mixedreality/data-plane/readme.md index 3700423ad07b..f9cdfa11af3a 100644 --- a/specification/mixedreality/data-plane/readme.md +++ b/specification/mixedreality/data-plane/readme.md @@ -34,9 +34,18 @@ directive: These are the global settings for Azure Mixed Reality Client. ```yaml -title: MixedRealityObjectAnchors +title: MixedRealityRemoteRendering openapi-type: data-plane -tag: package-0.2-preview.0 +tag: package-2021-01-01 +``` + +### Tag: package-2021-01-01 + +These settings apply only when `--tag=package-2021-01-01` is specified on the command line. + +``` yaml $(tag) == 'package-2021-01-01' +input-file: +- Microsoft.MixedReality/stable/2021-01-01/mr-arr.json ``` ### Tag: package-0.2-preview.0