Microsoft.ConfidentialLedger (preview:2024-08-22)

2025/03/06 • 2 new, 1 updated methods

GetRuntimeOptions (new)
Description :  It returns the runtime options
Reference :  Link ¶

⚼ Request

GET:  /app/userDefinedEndpoints/runtimeOptions
{
api-version:
{
Description: The API version to be used with the HTTP request. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
log_exception_details:
{
Required: False ,
}
boolean ,
max_cached_interpreters:
{
Format: int64 ,
Required: False ,
}
integer ,
max_execution_time_ms:
{
Format: int64 ,
Required: False ,
}
integer ,
max_heap_bytes:
{
Format: int64 ,
Required: False ,
}
integer ,
max_stack_bytes:
{
Format: int64 ,
Required: False ,
}
integer ,
return_exception_details:
{
Required: False ,
}
boolean ,
}

⚐ Response (default)

{
error:
{
Description: An error response from Confidential Ledger. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
}
,
}
UpdateRuntimeOptions (new)
Description :  Updates the runtime options.
Reference :  Link ¶

⚼ Request

PATCH:  /app/userDefinedEndpoints/runtimeOptions
{
api-version:
{
Description: The API version to be used with the HTTP request. ,
Required: True ,
}
string ,
JSRuntimeOptions:
{
Description: JS runtime options ,
Required: True ,
}
{
log_exception_details:
{
Required: False ,
}
boolean ,
max_cached_interpreters:
{
Format: int64 ,
Required: False ,
}
integer ,
max_execution_time_ms:
{
Format: int64 ,
Required: False ,
}
integer ,
max_heap_bytes:
{
Format: int64 ,
Required: False ,
}
integer ,
max_stack_bytes:
{
Format: int64 ,
Required: False ,
}
integer ,
return_exception_details:
{
Required: False ,
}
boolean ,
}
,
}

⚐ Response (200)

{
log_exception_details:
{
Required: False ,
}
boolean ,
max_cached_interpreters:
{
Format: int64 ,
Required: False ,
}
integer ,
max_execution_time_ms:
{
Format: int64 ,
Required: False ,
}
integer ,
max_heap_bytes:
{
Format: int64 ,
Required: False ,
}
integer ,
max_stack_bytes:
{
Format: int64 ,
Required: False ,
}
integer ,
return_exception_details:
{
Required: False ,
}
boolean ,
}

⚐ Response (default)

{
error:
{
Description: An error response from Confidential Ledger. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
}
,
}
GetUserDefinedEndpointsModule (updated)
Description :  It gets the module for the user defined endpoint.
Reference :  Link ¶

⚶ Changes

{
  "#id": "GetUserDefinedEndpointsModule",
  "$parameters": {
    "@added_c61b286f65514b23968136933d56a214": {
      "#name": "module_name",
      "Description": "module name of the user defined endpoint",
      "Required": true,
      "Type": "string"
    },
    "@removed_ff8d5988bc994214a6b7d5c47a223ffd": {
      "#name": "module",
      "Description": "module name of the user defined endpoint",
      "Required": true,
      "Type": "string"
    }
  }
}

⚼ Request

GET:  /app/userDefinedEndpoints/modules
{
api-version:
{
Description: The API version to be used with the HTTP request. ,
Required: True ,
}
string ,
module_name:
{
Description: module name of the user defined endpoint ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
module:
{
Required: True ,
}
string ,
name:
{
Required: True ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: An error response from Confidential Ledger. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
}
,
}