v12

latestOpenAPI 3.0.1raw.githubusercontent.com2026-08-01252498556.8 KB
actions

Describe action

Retrieves the details of the action identified by the given actionId.

get/actions/{actionId}

Path parameters

actionIdstring required

Action string identifier

Query parameters

workspaceIdinteger

Workspace numeric identifier

attributesActionQueryAttribute[]

Additional attribute values to include in the response (labels). Returns an empty value (labels: null) if omitted.

Response

OK

Example response

{
  "action": {
    "launch": {
      "computeEnv": {
        "config": {
          "forge": {
            "bootDiskSizeGB": 100,
            "headPool": {
              "bootDiskSizeGB": 100
            },
            "workerPool": {
              "bootDiskSizeGB": 100
            }
          },
          "headJobCpus": 1,
          "headJobMemoryMb": 4096,
          "jobMaxWallClockTime": "7d",
          "subnetId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myRg/providers/Microsoft.Network/virtualNetworks/myVnet/subnets/mySubnet"
        }
      }
    }
  }
}