compute-envs

Describe compute environment

Changed on Oct 20, 2026

Retrieves the details of the compute environment identified by the given computeEnvId.

get/compute-envs/{computeEnvId}

Request

The document declares no server URL.
Auth
HTTP bearer

Path parameters

computeEnvIdstring required

Compute environment string identifier

Query parameters

workspaceIdinteger

Workspace numeric identifier

attributesComputeEnvQueryAttribute[]

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

Response

Example response

{
  "computeEnv": {
    "config": {
      "forge": {
        "bootDiskSizeGB": 100,
        "containerRegIds": [
          "2dzgMSW1UqQHFhZqGQZ99X"
        ],
        "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"
    }
  }
}

Changes

Oct 20, 2026adab9fd613a4 Revision changes
- info
  added the optional property /// to the response with the status
- info
  added the optional property /// to the response with the status
- info
  added the optional property /// to the response with the status
- info
  added the optional property /// to the response with the status
- info
  added the optional property /// to the response with the status
- info
  added the optional property /// to the response with the status
- info
  added the optional property /// to the response with the status
- info
  added the optional property /// to the response with the status
- info
  added the optional property /// to the response with the status
- info
  added the optional property /// to the response with the status
- info
  added the optional property /// to the response with the status
- info
  added the optional property /// to the response with the status
- info
  added the optional property /// to the response with the status
- info
  added the optional property /// to the response with the status
- info
  added the optional property /// to the response with the status
- info
  added the optional property /// to the response with the status
- info
  added the optional property /// to the response with the status
- info
  added the optional property /// to the response with the status
- info
  added the optional property /// to the response with the status
- info
  added the optional property /// to the response with the status
Oct 6, 20260e1a1696f553 Revision changes
- breaking
  the response property //// became nullable for the status
- info
  added the optional property /// to the response with the status
- info
  added the optional property /// to the response with the status
- info
  the ///// response's property pattern ^[0-9A-Za-z]{1,22}$ was added for the status

Operation history (14 revisions)