Microsoft.App.DynamicSessions (preview:2025-02-02)

2025/08/07 • 1 updated methods

CodeExecution_Execute (updated)
Description :  Execute code in a session.
Reference :  Link ¶

⚶ Changes

{
  "#id": "CodeExecution_Execute",
  "$responses": {
    "@added_7555ec733b134098a837d8d9e041a6db": {
      "#status": "200",
      "$headers": [
        {
          "#name": "operation-location",
          "Description": "The location for monitoring the operation state.",
          "Type": "string"
        },
        {
          "#name": "operation-id",
          "Description": "The id of this execution operation.",
          "Type": "string"
        },
        {
          "#name": "x-ms-error-code",
          "Description": "String error code indicating what went wrong.",
          "Type": "string"
        }
      ],
      "$schema": {
        "Description": "The session code execution resource.",
        "Type": "object",
        "$properties": [
          {
            "#name": "id",
            "Description": "Session code execution id.",
            "Required": true,
            "Type": "string"
          },
          {
            "#name": "identifier",
            "Description": "The identifier of the session.",
            "Required": true,
            "Type": "string"
          },
          {
            "#name": "executionType",
            "Description": "The execution type of the code execution request.",
            "Enum": [
              [
                "Synchronous",
                "Synchronous"
              ],
              [
                "Asynchronous",
                "Asynchronous"
              ]
            ],
            "Required": true,
            "Type": "string"
          },
          {
            "#name": "status",
            "Description": "The status of the code execution operation, indicates whether succeeded or not.",
            "Enum": [
              [
                "NotStarted",
                "The operation has not started."
              ],
              [
                "Running",
                "The operation is in progress."
              ],
              [
                "Succeeded",
                "The operation has completed successfully."
              ],
              [
                "Failed",
                "The operation has failed."
              ],
              [
                "Canceled",
                "The operation has been canceled by the user."
              ]
            ],
            "Required": true,
            "Type": "string"
          },
          {
            "#name": "error",
            "Description": "The error of this code execution if failed.",
            "Required": false,
            "Type": "object",
            "$properties": [
              {
                "#name": "error",
                "Description": "The error object.",
                "Required": true,
                "Type": "object",
                "$properties": [
                  {
                    "#name": "code",
                    "Description": "One of a server-defined set of error codes.",
                    "Required": true,
                    "Type": "string"
                  },
                  {
                    "#name": "message",
                    "Description": "A human-readable representation of the error.",
                    "Required": true,
                    "Type": "string"
                  },
                  {
                    "#name": "target",
                    "Description": "The target of the error.",
                    "Required": false,
                    "Type": "string"
                  },
                  {
                    "#name": "details",
                    "Description": "An array of details about specific errors that led to this reported error.",
                    "Required": false,
                    "Type": "array",
                    "$items": {
                      "Type": "string"
                    }
                  },
                  {
                    "#name": "innererror",
                    "Description": "An object containing more specific information than the current object about the error.",
                    "Required": false,
                    "Type": "object",
                    "$properties": [
                      {
                        "#name": "code",
                        "Description": "One of a server-defined set of error codes.",
                        "Required": false,
                        "Type": "string"
                      },
                      {
                        "#name": "innererror",
                        "Required": false,
                        "Type": "string"
                      }
                    ]
                  }
                ]
              }
            ]
          },
          {
            "#name": "result",
            "Description": "The result of this code execution operation.",
            "Required": false,
            "Type": "object",
            "$properties": [
              {
                "#name": "stdout",
                "Description": "The standard output of the code execution.",
                "Required": false,
                "Type": "string"
              },
              {
                "#name": "stderr",
                "Description": "The standard error of the code execution.",
                "Required": false,
                "Type": "string"
              },
              {
                "#name": "executionResult",
                "Description": "The result of the code execution. The type of this field is same as the type of actual result of the code execution after being Json serialized.",
                "Required": false,
                "Type": "string"
              },
              {
                "#name": "executionTimeInMilliseconds",
                "Description": "The execution time of the code in milliseconds.",
                "Format": "int64",
                "Required": false,
                "Type": "integer"
              }
            ]
          }
        ]
      }
    },
    "@removed_80ffcfc156b4492a887688a07f47b493": {
      "#status": "202",
      "$headers": [
        {
          "#name": "operation-location",
          "Description": "The location for monitoring the operation state.",
          "Type": "string"
        },
        {
          "#name": "operation-id",
          "Description": "The id of this execution operation.",
          "Type": "string"
        },
        {
          "#name": "x-ms-error-code",
          "Description": "String error code indicating what went wrong.",
          "Type": "string"
        }
      ],
      "$schema": {
        "Description": "The session code execution resource.",
        "Type": "object",
        "$properties": [
          {
            "#name": "id",
            "Description": "Session code execution id.",
            "Required": true,
            "Type": "string"
          },
          {
            "#name": "identifier",
            "Description": "The identifier of the session.",
            "Required": true,
            "Type": "string"
          },
          {
            "#name": "executionType",
            "Description": "The execution type of the code execution request.",
            "Enum": [
              [
                "Synchronous",
                "Synchronous"
              ],
              [
                "Asynchronous",
                "Asynchronous"
              ]
            ],
            "Required": true,
            "Type": "string"
          },
          {
            "#name": "status",
            "Description": "The status of the code execution operation, indicates whether succeeded or not.",
            "Enum": [
              [
                "NotStarted",
                "The operation has not started."
              ],
              [
                "Running",
                "The operation is in progress."
              ],
              [
                "Succeeded",
                "The operation has completed successfully."
              ],
              [
                "Failed",
                "The operation has failed."
              ],
              [
                "Canceled",
                "The operation has been canceled by the user."
              ]
            ],
            "Required": true,
            "Type": "string"
          },
          {
            "#name": "error",
            "Description": "The error of this code execution if failed.",
            "Required": false,
            "Type": "object",
            "$properties": [
              {
                "#name": "error",
                "Description": "The error object.",
                "Required": true,
                "Type": "object",
                "$properties": [
                  {
                    "#name": "code",
                    "Description": "One of a server-defined set of error codes.",
                    "Required": true,
                    "Type": "string"
                  },
                  {
                    "#name": "message",
                    "Description": "A human-readable representation of the error.",
                    "Required": true,
                    "Type": "string"
                  },
                  {
                    "#name": "target",
                    "Description": "The target of the error.",
                    "Required": false,
                    "Type": "string"
                  },
                  {
                    "#name": "details",
                    "Description": "An array of details about specific errors that led to this reported error.",
                    "Required": false,
                    "Type": "array",
                    "$items": {
                      "Type": "string"
                    }
                  },
                  {
                    "#name": "innererror",
                    "Description": "An object containing more specific information than the current object about the error.",
                    "Required": false,
                    "Type": "object",
                    "$properties": [
                      {
                        "#name": "code",
                        "Description": "One of a server-defined set of error codes.",
                        "Required": false,
                        "Type": "string"
                      },
                      {
                        "#name": "innererror",
                        "Required": false,
                        "Type": "string"
                      }
                    ]
                  }
                ]
              }
            ]
          },
          {
            "#name": "result",
            "Description": "The result of this code execution operation.",
            "Required": false,
            "Type": "object",
            "$properties": [
              {
                "#name": "stdout",
                "Description": "The standard output of the code execution.",
                "Required": false,
                "Type": "string"
              },
              {
                "#name": "stderr",
                "Description": "The standard error of the code execution.",
                "Required": false,
                "Type": "string"
              },
              {
                "#name": "executionResult",
                "Description": "The result of the code execution. The type of this field is same as the type of actual result of the code execution after being Json serialized.",
                "Required": false,
                "Type": "string"
              },
              {
                "#name": "executionTimeInMilliseconds",
                "Description": "The execution time of the code in milliseconds.",
                "Format": "int64",
                "Required": false,
                "Type": "integer"
              }
            ]
          }
        ]
      }
    }
  }
}

⚼ Request

POST:  /executions
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
operation-id:
{
Description: The id of this execution operation. ,
Required: False ,
}
string ,
identifier:
{
Description: The user-assigned identifier of the session. ,
Required: True ,
}
string ,
codeExecutionRequest:
{
Description: The request to execute code. ,
Required: True ,
}
{
codeInputType:
{
Description: The code input type of the code execution request. ,
Enum:
{
Inline: Inline. ,
InlineBase64: InlineBase64. ,
InlineText: InlineText. ,
}
,
Required: True ,
}
enum ,
executionType:
{
Description: The execution type of the code execution request. ,
Enum:
{
Synchronous: Synchronous ,
Asynchronous: Asynchronous ,
}
,
Required: True ,
}
enum ,
code:
{
Description: The string of the code to execute, based on CodeInputType. ,
Required: True ,
}
string ,
timeoutInSeconds:
{
Description: Code execution timeout in seconds. ,
Format: int64 ,
Required: True ,
}
integer ,
}
,
}

⚐ Response (200)

{
$headers:
{
operation-location:
{
Description: The location for monitoring the operation state. ,
}
string ,
operation-id:
{
Description: The id of this execution operation. ,
}
string ,
x-ms-error-code:
{
Description: String error code indicating what went wrong. ,
}
string ,
}
,
$schema:
{
Description: The session code execution resource. ,
}
{
id:
{
Description: Session code execution id. ,
Required: True ,
}
string ,
identifier:
{
Description: The identifier of the session. ,
Required: True ,
}
string ,
executionType:
{
Description: The execution type of the code execution request. ,
Enum:
{
Synchronous: Synchronous ,
Asynchronous: Asynchronous ,
}
,
Required: True ,
}
enum ,
status:
{
Description: The status of the code execution operation, indicates whether succeeded or not. ,
Enum:
{
NotStarted: The operation has not started. ,
Running: The operation is in progress. ,
Succeeded: The operation has completed successfully. ,
Failed: The operation has failed. ,
Canceled: The operation has been canceled by the user. ,
}
,
Required: True ,
}
enum ,
error:
{
Description: The error of this code execution if failed. ,
Required: False ,
}
{
error:
{
Description: The error object. ,
Required: True ,
}
{
code:
{
Description: One of a server-defined set of error codes. ,
Required: True ,
}
string ,
message:
{
Description: A human-readable representation of the error. ,
Required: True ,
}
string ,
target:
{
Description: The target of the error. ,
Required: False ,
}
string ,
details:
{
Description: An array of details about specific errors that led to this reported error. ,
Required: False ,
}
[
string ,
]
,
innererror:
{
Description: An object containing more specific information than the current object about the error. ,
Required: False ,
}
{
code:
{
Description: One of a server-defined set of error codes. ,
Required: False ,
}
string ,
innererror:
{
Required: False ,
}
string ,
}
,
}
,
}
,
result:
{
Description: The result of this code execution operation. ,
Required: False ,
}
{
stdout:
{
Description: The standard output of the code execution. ,
Required: False ,
}
string ,
stderr:
{
Description: The standard error of the code execution. ,
Required: False ,
}
string ,
executionResult:
{
Description: The result of the code execution. The type of this field is same as the type of actual result of the code execution after being Json serialized. ,
Required: False ,
}
string ,
executionTimeInMilliseconds:
{
Description: The execution time of the code in milliseconds. ,
Format: int64 ,
Required: False ,
}
integer ,
}
,
}
,
}

⚐ Response (default)

{
$headers:
{
x-ms-error-code:
{
Description: String error code indicating what went wrong. ,
}
string ,
}
,
$schema:
{
Description: A response containing error details. ,
}
{
error:
{
Description: The error object. ,
Required: True ,
}
{
code:
{
Description: One of a server-defined set of error codes. ,
Required: True ,
}
string ,
message:
{
Description: A human-readable representation of the error. ,
Required: True ,
}
string ,
target:
{
Description: The target of the error. ,
Required: False ,
}
string ,
details:
{
Description: An array of details about specific errors that led to this reported error. ,
Required: False ,
}
[
string ,
]
,
innererror:
{
Description: An object containing more specific information than the current object about the error. ,
Required: False ,
}
{
code:
{
Description: One of a server-defined set of error codes. ,
Required: False ,
}
string ,
innererror:
{
Required: False ,
}
string ,
}
,
}
,
}
,
}