Remote Rendering - Create Conversion
Crée une conversion à l’aide d’une ressource stockée dans un compte Stockage Blob Azure.
PUT {endpoint}/accounts/{account_id}/conversions/{conversion_id}?api-version=2021-01-01
Paramètres URI
Nom | Dans | Obligatoire | Type | Description |
---|---|---|---|---|
account_id
|
path | True |
string uuid |
ID de compte Azure Remote Rendering. |
conversion_id
|
path | True |
string |
ID identifiant de manière unique la conversion pour le compte donné. L’ID respecte la casse, peut contenir n’importe quelle combinaison de caractères alphanumériques, y compris des traits d’union et des traits de soulignement, et ne peut pas contenir plus de 256 caractères. |
endpoint
|
path | True |
string |
Point de terminaison à utiliser, par exemple https://remoterendering.eastus.mixedreality.azure.com. Vous trouverez une liste à l’adresse https://docs.microsoft.com/azure/remote-rendering/reference/regions. |
api-version
|
query | True |
string |
Version de l’API à utiliser avec la requête HTTP. |
En-tête de la demande
Nom | Obligatoire | Type | Description |
---|---|---|---|
Authorization | True |
string |
Jeton du porteur retourné par le service de jeton sécurisé Mixed Reality. Pour plus d'informations, consultez https://docs.microsoft.com/azure/remote-rendering/how-tos/tokens. |
Corps de la demande
Nom | Obligatoire | Type | Description |
---|---|---|---|
settings | True |
Les paramètres de conversion décrivent l’origine des fichiers d’entrée et la destination des fichiers de sortie. |
Réponses
Nom | Type | Description |
---|---|---|
200 OK |
OK. Indique qu’il y avait déjà une conversion avec les mêmes paramètres présents. Cela est attendu lorsqu’une nouvelle tentative de création de conversion est effectuée. En-têtes MS-CV: string |
|
201 Created |
Créé. Une nouvelle conversion a été créée. En-têtes MS-CV: string |
|
400 Bad Request |
Demande incorrecte. L’objet d’erreur retourné décrit les problèmes qui se sont produits. En-têtes MS-CV: string |
|
401 Unauthorized |
Non autorisé. Autorisation manquante ou non valide. En-têtes
|
|
403 Forbidden |
Interdit. Autorisation insuffisante pour une ressource donnée. En-têtes MS-CV: string |
|
429 Too Many Requests |
Trop de demandes. La limite de débit a été dépassée. Réessayez la demande après la durée indiquée dans l’en-tête Retry-After. En-têtes
|
|
500 Internal Server Error |
Erreur interne. Le serveur a rencontré une erreur interne. La nouvelle tentative de la demande peut produire des résultats réussis. |
|
Other Status Codes |
Conflit. Une conversion existe déjà. Un objet d’erreur décrit les problèmes qui se sont produits. En-têtes MS-CV: string |
Sécurité
Authorization
Jeton du porteur retourné par le service de jeton sécurisé Mixed Reality. Pour plus d'informations, consultez https://docs.microsoft.com/azure/remote-rendering/how-tos/tokens.
Type:
apiKey
Dans:
header
Exemples
Create a conversion
Exemple de requête
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"
}
}
}
Exemple de réponse
MS-CV: dKEFmka2kkSlDmp/af+sOw
{
"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
}
MS-CV: dKEFmka2kkSlDmp/af+sOw
{
"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
}
MS-CV: dKEFmka2kkSlDmp/af+sOw
{
"error": {
"code": "BadRequest",
"message": "The request was malformed."
}
}
MS-CV: dKEFmka2kkSlDmp/af+sOw
{
"error": {
"code": "Conflict",
"message": "A resource already exists under the given ID."
}
}
WWW-Authenticate: Bearer error="invalid_token"
MS-CV: dKEFmka2kkSlDmp/af+sOw
MS-CV: dKEFmka2kkSlDmp/af+sOw
Retry-After: 15
MS-CV: dKEFmka2kkSlDmp/af+sOw
MS-CV: dKEFmka2kkSlDmp/af+sOw
{
"error": {
"code": "InternalServerError",
"message": "An internal server error occurred."
}
}
Définitions
Nom | Description |
---|---|
conversion |
Propriétés de la conversion. |
conversion_input_settings |
Les paramètres d’entrée de conversion décrivent l’origine de l’entrée de conversion. |
conversion_output_settings |
Les paramètres de sortie de conversion décrivent la destination de la sortie de conversion. |
conversion_settings |
Les paramètres de conversion décrivent l’origine des fichiers d’entrée et la destination des fichiers de sortie. |
conversion_status |
Status de la conversion. Les états de terminal sont « Cancelled », « Failed » et « Succeeded ». |
create_conversion_settings |
Demande de démarrage d’une conversion |
error |
Objet d’erreur contenant les détails de la raison de l’échec de la demande. |
error_response |
Réponse d’erreur contenant des détails sur la raison de l’échec de la demande. |
Output |
Informations sur la sortie d’une conversion réussie. Présent uniquement lorsque le status de la conversion est « Réussi ». |
conversion
Propriétés de la conversion.
Nom | Type | Description |
---|---|---|
creationTime |
string |
Heure de création de la conversion. Date et heure au format ISO 8601. |
error |
Objet d’erreur contenant des détails sur l’échec de conversion. |
|
id |
string |
ID de la conversion fournie lors de la création de la conversion. |
output |
Informations sur la sortie d’une conversion réussie. Présent uniquement lorsque le status de la conversion est « Réussi ». |
|
settings |
Les paramètres de conversion décrivent l’origine des fichiers d’entrée et la destination des fichiers de sortie. |
|
status |
Status de la conversion. Les états de terminal sont « Cancelled », « Failed » et « Succeeded ». |
conversion_input_settings
Les paramètres d’entrée de conversion décrivent l’origine de l’entrée de conversion.
Nom | Type | Description |
---|---|---|
blobPrefix |
string |
Seuls les objets blob commençant par ce préfixe sont téléchargés pour effectuer la conversion. facultatif. S’ils ne sont pas fournis, tous les objets blob du conteneur sont téléchargés. |
relativeInputAssetPath |
string |
Chemin d’accès relatif commençant à blobPrefix (ou à la racine du conteneur si blobPrefix n’est pas fourni) au modèle d’entrée. Doit pointer vers un fichier dont le format de fichier pris en charge se termine. Pour plus d'informations, consultez https://docs.microsoft.com/azure/remote-rendering/how-tos/conversion/model-conversion. |
storageContainerReadListSas |
string |
Signature d’accès partagé au conteneur de stockage Blob Azure qui donne un accès en lecture et en liste au conteneur de stockage. facultatif. S’il n’est pas fourni, le compte Azure Remote Rendering doit être lié au compte de stockage contenant le conteneur d’objets blob. Pour plus d'informations, consultez https://docs.microsoft.com/azure/remote-rendering/how-tos/create-an-account#link-storage-accounts. Pour des raisons de sécurité, ce champ ne sera jamais rempli dans les corps des réponses. |
storageContainerUri |
string |
URI du conteneur de stockage d’objets blob Azure contenant le modèle d’entrée. |
conversion_output_settings
Les paramètres de sortie de conversion décrivent la destination de la sortie de conversion.
Nom | Type | Description |
---|---|---|
blobPrefix |
string |
Préfixe qui est ajouté devant tous les fichiers générés par le processus de conversion. Sera traité comme un dossier virtuel. facultatif. S’ils ne sont pas fournis, les fichiers de sortie sont stockés à la racine du conteneur. |
outputAssetFilename |
string |
Nom de fichier de la ressource de sortie. Doit se terminer par « .arrAsset ». facultatif. S’il n’est pas fourni, le nom de fichier aura le même nom que la ressource d’entrée, avec l’extension '.arrAsset' |
storageContainerUri |
string |
URI du conteneur de stockage d’objets blob Azure dans lequel le résultat de la conversion doit être écrit. |
storageContainerWriteSas |
string |
Signature d’accès partagé du conteneur de stockage Blob Azure donnant un accès en écriture au conteneur de stockage. facultatif. S’il n’est pas fourni, le compte Azure Remote Rendering doit être lié au compte de stockage contenant le conteneur d’objets blob. Pour plus d'informations, consultez https://docs.microsoft.com/azure/remote-rendering/how-tos/create-an-account#link-storage-accounts. Pour des raisons de sécurité, ce champ ne sera jamais rempli dans les corps des réponses. |
conversion_settings
Les paramètres de conversion décrivent l’origine des fichiers d’entrée et la destination des fichiers de sortie.
Nom | Type | Description |
---|---|---|
inputLocation |
Les paramètres d’entrée de conversion décrivent l’origine de l’entrée de conversion. |
|
outputLocation |
Les paramètres de sortie de conversion décrivent la destination de la sortie de conversion. |
conversion_status
Status de la conversion. Les états de terminal sont « Cancelled », « Failed » et « Succeeded ».
Nom | Type | Description |
---|---|---|
Cancelled |
string |
La conversion a été annulée. Il s’agit d’un état terminal. |
Failed |
string |
La conversion a échoué. Pour plus d’informations, consultez le champ « erreur ». Il s’agit d’un état terminal. |
NotStarted |
string |
La conversion a été créée, mais n’a pas démarré. |
Running |
string |
La conversion est en cours d’exécution. |
Succeeded |
string |
La conversion a réussi. Vérifiez l’emplacement de la ressource de sortie dans le champ « output ». Il s’agit d’un état terminal. |
create_conversion_settings
Demande de démarrage d’une conversion
Nom | Type | Description |
---|---|---|
settings |
Les paramètres de conversion décrivent l’origine des fichiers d’entrée et la destination des fichiers de sortie. |
error
Objet d’erreur contenant les détails de la raison de l’échec de la demande.
Nom | Type | Description |
---|---|---|
code |
string |
Code d’erreur. |
details |
error[] |
Tableau de détails sur les erreurs spécifiques qui ont conduit à cette erreur signalée. |
innerError |
Objet contenant des informations plus spécifiques que l’objet actuel sur l’erreur. |
|
message |
string |
Représentation lisible de l’erreur. |
target |
string |
Cible de l’erreur particulière (par exemple, le nom de la propriété dans l’erreur). |
error_response
Réponse d’erreur contenant des détails sur la raison de l’échec de la demande.
Nom | Type | Description |
---|---|---|
error |
Objet d’erreur contenant les détails de la raison de l’échec de la demande. |
Output
Informations sur la sortie d’une conversion réussie. Présent uniquement lorsque le status de la conversion est « Réussi ».
Nom | Type | Description |
---|---|---|
outputAssetUri |
string |
URI de la ressource générée par le processus de conversion. |