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

2025/06/19 • 11 new methods

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

⚼ Request

POST:  /executions
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
identifier:
{
Description: The user-assigned identifier of the session. ,
Required: True ,
}
string ,
operation-id:
{
Description: The id of this execution operation. ,
Required: False ,
}
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 (202)

{
$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 ,
}
,
}
,
}
,
}
CodeExecution_Get (new)
Description :  Get the code execution result.
Reference :  Link ¶

⚼ Request

GET:  /executions/{executionId}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
executionId:
{
Description: Session code execution id. ,
Required: True ,
}
string ,
identifier:
{
Description: The user-assigned identifier of the session. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
$headers:
{
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 ,
}
,
}
,
}
,
}
SessionResourceFiles_List (new)
Description :  List the file resources.
Reference :  Link ¶

⚼ Request

GET:  /files
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
identifier:
{
Description: The user-assigned identifier of the session. ,
Required: True ,
}
string ,
path:
{
Description: The path of the file after uploaded. ,
Required: False ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The SessionResourceFile items on this page ,
Required: True ,
}
[
{
name:
{
Description: The name of the file. ,
Required: True ,
}
string ,
type:
{
Description: The type of the session resource file. ,
Required: True ,
}
string ,
contentType:
{
Description: The type of the content of this file. ,
Required: False ,
}
string ,
sizeInBytes:
{
Description: The size of the file. ,
Format: int64 ,
Required: False ,
}
integer ,
lastModifiedAt:
{
Description: The date time in RFC3339 format when the file was last modified. ,
Format: date-time ,
Required: True ,
}
string ,
}
,
]
,
nextLink:
{
Description: The link to the next page of items ,
Format: uri ,
Required: False ,
}
string ,
}

⚐ 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 ,
}
,
}
,
}
,
}
SessionResourceFiles_Upload (new)
Description :  Upload a file to a session.
Reference :  Link ¶

⚼ Request

POST:  /files
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
identifier:
{
Description: The user-assigned identifier of the session. ,
Required: True ,
}
string ,
path:
{
Description: The path of the file after uploaded. ,
Required: False ,
}
string ,
file:
{
Description: The file to upload. ,
Required: True ,
}
file ,
}

⚐ Response (200)

{
name:
{
Description: The name of the file. ,
Required: True ,
}
string ,
type:
{
Description: The type of the session resource file. ,
Required: True ,
}
string ,
contentType:
{
Description: The type of the content of this file. ,
Required: False ,
}
string ,
sizeInBytes:
{
Description: The size of the file. ,
Format: int64 ,
Required: False ,
}
integer ,
lastModifiedAt:
{
Description: The date time in RFC3339 format when the file was last modified. ,
Format: date-time ,
Required: True ,
}
string ,
}

⚐ 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 ,
}
,
}
,
}
,
}
SessionResourceFiles_Get (new)
Description :  Get the file resource.
Reference :  Link ¶

⚼ Request

GET:  /files/{name}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
name:
{
Description: The name of the file. ,
Required: True ,
}
string ,
identifier:
{
Description: The user-assigned identifier of the session. ,
Required: True ,
}
string ,
path:
{
Description: The path of the file after uploaded. ,
Required: False ,
}
string ,
}

⚐ Response (200)

{
name:
{
Description: The name of the file. ,
Required: True ,
}
string ,
type:
{
Description: The type of the session resource file. ,
Required: True ,
}
string ,
contentType:
{
Description: The type of the content of this file. ,
Required: False ,
}
string ,
sizeInBytes:
{
Description: The size of the file. ,
Format: int64 ,
Required: False ,
}
integer ,
lastModifiedAt:
{
Description: The date time in RFC3339 format when the file was last modified. ,
Format: date-time ,
Required: True ,
}
string ,
}

⚐ 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 ,
}
,
}
,
}
,
}
SessionResourceFiles_Delete (new)
Description :  Delete the file.
Reference :  Link ¶

⚼ Request

DELETE:  /files/{name}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
name:
{
Description: The name of the file. ,
Required: True ,
}
string ,
identifier:
{
Description: The user-assigned identifier of the session. ,
Required: True ,
}
string ,
path:
{
Description: The path of the file after uploaded. ,
Required: False ,
}
string ,
}

⚐ Response (204)

{}

⚐ 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 ,
}
,
}
,
}
,
}
SessionResourceFiles_GetContent (new)
Description :  Get the content of the file.
Reference :  Link ¶

⚼ Request

GET:  /files/{name}/content
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
name:
{
Description: The name of the file. ,
Required: True ,
}
string ,
identifier:
{
Description: The user-assigned identifier of the session. ,
Required: True ,
}
string ,
path:
{
Description: The path of the file after uploaded. ,
Required: False ,
}
string ,
}

⚐ Response (200)

{
$schema: file ,
}

⚐ 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 ,
}
,
}
,
}
,
}
ListSessions_Get (new)
Description :  List the sessions.
Reference :  Link ¶

⚼ Request

GET:  /listSessions
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
skip:
{
Description: The offset for pagination purpose. ,
Format: int32 ,
Required: False ,
}
integer ,
}

⚐ Response (200)

{
sessions:
{
Description: The list of sessions. ,
Required: True ,
}
[
{
identifier:
{
Description: The identifier of the session. ,
Required: True ,
}
string ,
createdAt:
{
Description: The date and time when the session was created. ,
Format: date-time ,
Required: True ,
}
string ,
lastAccessedAt:
{
Description: The date and time when the session was last accessed. ,
Format: date-time ,
Required: True ,
}
string ,
expireAt:
{
Description: The date and time when the session will expire. ,
Format: date-time ,
Required: True ,
}
string ,
etag:
{
Description: The ETag of the session, representing the underlying container ID. ,
Required: True ,
}
string ,
}
,
]
,
nextLink:
{
Description: The link to the next page of sessions. ,
Format: uri ,
Required: False ,
}
string ,
}

⚐ 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 ,
}
,
}
,
}
,
}
SessionPoolMetadata_Get (new)
Description :  Get the metadata information.
Reference :  Link ¶

⚼ Request

GET:  /metadata
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
runtimes:
{
Description: List of runtimes. ,
Required: True ,
}
[
{
name:
{
Description: Name of the runtime. ,
Required: True ,
}
string ,
version:
{
Description: Version of the runtime. ,
Required: True ,
}
string ,
}
,
]
,
preInstalledPackages:
{
Description: List of pre-installed packages. ,
Required: True ,
}
[
{
name:
{
Description: Name of the package. ,
Required: True ,
}
string ,
version:
{
Description: Version of the package. ,
Required: True ,
}
string ,
}
,
]
,
createdAt:
{
Description: Creation date in RFC3339 format. ,
Format: date-time ,
Required: True ,
}
string ,
lastUpdatedAt:
{
Description: Last updated date in RFC3339 format. ,
Format: date-time ,
Required: True ,
}
string ,
jupyterKernel:
{
Description: Jupyter kernel information. ,
Required: True ,
}
{
name:
{
Description: Name of the kernel. ,
Required: True ,
}
string ,
version:
{
Description: Version of the kernel. ,
Required: True ,
}
string ,
projectUrl:
{
Description: Project URL of the kernel. ,
Format: uri ,
Required: True ,
}
string ,
description:
{
Description: Description of the kernel. ,
Required: True ,
}
string ,
}
,
}

⚐ 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 ,
}
,
}
,
}
,
}
SessionManagement_Get (new)
Description :  Get the session.
Reference :  Link ¶

⚼ Request

GET:  /session
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
identifier:
{
Description: The user-assigned identifier of the session. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
identifier:
{
Description: The identifier of the session. ,
Required: True ,
}
string ,
createdAt:
{
Description: The date and time when the session was created. ,
Format: date-time ,
Required: True ,
}
string ,
lastAccessedAt:
{
Description: The date and time when the session was last accessed. ,
Format: date-time ,
Required: True ,
}
string ,
expireAt:
{
Description: The date and time when the session will expire. ,
Format: date-time ,
Required: True ,
}
string ,
etag:
{
Description: The ETag of the session, representing the underlying container ID. ,
Required: True ,
}
string ,
}

⚐ 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 ,
}
,
}
,
}
,
}
SessionManagement_Delete (new)
Description :  Delete the session.
Reference :  Link ¶

⚼ Request

DELETE:  /session
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
identifier:
{
Description: The user-assigned identifier of the session. ,
Required: True ,
}
string ,
}

⚐ Response (204)

{}

⚐ 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 ,
}
,
}
,
}
,
}