Compute - Create Or Update

Service:: Machine Learning

API Version:: 2025-09-01

Creates or updates compute. This call will overwrite a compute if it exists. This is a nonrecoverable operation. If your intent is to create a new compute, do a GET first to verify that it does not exist yet.

PUT https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/computes/{computeName}?api-version=2025-09-01

URI Parameters

Name	In	Required	Type	Description
computeName	path	True	string	Name of the Azure Machine Learning compute.
resourceGroupName	path	True	string minLength: 1 maxLength: 90	The name of the resource group. The name is case insensitive.
subscriptionId	path	True	string minLength: 1	The ID of the target subscription.
workspaceName	path	True	string pattern: ^[a-zA-Z0-9][a-zA-Z0-9_-]{2,32}$	Name of Azure Machine Learning workspace.
api-version	query	True	string minLength: 1	The API version to use for this operation.

Request Body

Name	Type	Description
identity	ManagedServiceIdentity	The identity of the resource.
location	string	Specifies the location of the resource.
properties	Compute: AKS Kubernetes AmlCompute ComputeInstance VirtualMachine HDInsight DataFactory Databricks DataLakeAnalytics SynapseSpark	Compute properties
sku	Sku	The sku of the workspace.
tags	object	Contains resource tags defined as key/value pairs.

Responses

Name	Type	Description
200 OK	ComputeResource	Compute creation or update initiated.
201 Created	ComputeResource	Compute creation or update initiated. Headers Azure-AsyncOperation: string
Other Status Codes	ErrorResponse	Error response describing why the request failed.

Name

Type

Description

200 OK

ComputeResource

Compute creation or update initiated.

201 Created

ComputeResource

Compute creation or update initiated.

Headers

Azure-AsyncOperation: string

Other Status Codes

ErrorResponse

Error response describing why the request failed.

Security

azure_auth

Azure Active Directory OAuth2 Flow.

Type: oauth2
Flow: implicit
Authorization URL: https://login.microsoftonline.com/common/oauth2/authorize

Scopes

Name	Description
user_impersonation	impersonate your user account

Examples

Attach a Kubernetes Compute

Create a AML Compute

Create a DataFactory Compute

Create an AKS Compute

Create an ComputeInstance Compute

Create an ComputeInstance Compute with minimal inputs

Create an ComputeInstance Compute with Schedules

Update a AML Compute

Update an AKS Compute

Attach a Kubernetes Compute

Sample request

HTTP

PUT https://management.azure.com/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/testrg123/providers/Microsoft.MachineLearningServices/workspaces/workspaces123/computes/compute123?api-version=2025-09-01

{
  "location": "eastus",
  "properties": {
    "description": "some compute",
    "resourceId": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourcegroups/testrg123/providers/Microsoft.ContainerService/managedClusters/compute123-56826-c9b00420020b2",
    "computeType": "Kubernetes",
    "properties": {
      "namespace": "default",
      "defaultInstanceType": "defaultInstanceType",
      "instanceTypes": {
        "defaultInstanceType": {
          "nodeSelector": null,
          "resources": {
            "requests": {
              "cpu": "1",
              "memory": "4Gi",
              "nvidia.com/gpu": null
            },
            "limits": {
              "cpu": "1",
              "memory": "4Gi",
              "nvidia.com/gpu": null
            }
          }
        }
      }
    }
  }
}

Sample response

Status code:: 200

{
  "id": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/testrg123/providers/Microsoft.MachineLearningServices/workspaces/workspaces123/computes/compute123",
  "type": "Microsoft.MachineLearningServices/workspaces/computes",
  "name": "compute123",
  "location": "eastus",
  "properties": {
    "description": "some compute",
    "resourceId": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourcegroups/testrg123/providers/Microsoft.ContainerService/managedClusters/compute123-56826-c9b00420020b2",
    "computeType": "Kubernetes",
    "provisioningState": "Creating",
    "properties": {
      "relayConnectionString": null,
      "serviceBusConnectionString": null,
      "extensionPrincipalId": null,
      "extensionInstanceReleaseTrain": "stable",
      "vcName": null,
      "namespace": "default",
      "defaultInstanceType": "defaultInstanceType",
      "instanceTypes": {
        "defaultInstanceType": {
          "nodeSelector": null,
          "resources": {
            "requests": {
              "cpu": "1",
              "memory": "4Gi",
              "nvidia.com/gpu": null
            },
            "limits": {
              "cpu": "1",
              "memory": "4Gi",
              "nvidia.com/gpu": null
            }
          }
        }
      }
    }
  }
}

Status code:: 201

Azure-AsyncOperation: https://management.azure.com/subscriptions/...pathToOperationStatus...

{
  "id": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/testrg123/providers/Microsoft.MachineLearningServices/workspaces/workspaces123/computes/compute123",
  "type": "Microsoft.MachineLearningServices/workspaces/computes",
  "name": "compute123",
  "location": "eastus",
  "properties": {
    "description": "some compute",
    "resourceId": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourcegroups/testrg123/providers/Microsoft.ContainerService/managedClusters/compute123-56826-c9b00420020b2",
    "computeType": "Kubernetes",
    "provisioningState": "Creating",
    "properties": {
      "relayConnectionString": null,
      "serviceBusConnectionString": null,
      "extensionPrincipalId": null,
      "extensionInstanceReleaseTrain": "stable",
      "vcName": null,
      "namespace": "default",
      "defaultInstanceType": "defaultInstanceType",
      "instanceTypes": {
        "defaultInstanceType": {
          "nodeSelector": null,
          "resources": {
            "requests": {
              "cpu": "1",
              "memory": "4Gi",
              "nvidia.com/gpu": null
            },
            "limits": {
              "cpu": "1",
              "memory": "4Gi",
              "nvidia.com/gpu": null
            }
          }
        }
      }
    }
  }
}

Create a AML Compute

Sample request

HTTP

PUT https://management.azure.com/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/testrg123/providers/Microsoft.MachineLearningServices/workspaces/workspaces123/computes/compute123?api-version=2025-09-01

{
  "location": "eastus",
  "properties": {
    "computeType": "AmlCompute",
    "properties": {
      "vmSize": "STANDARD_NC6",
      "vmPriority": "Dedicated",
      "osType": "Windows",
      "virtualMachineImage": {
        "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.Compute/galleries/myImageGallery/images/myImageDefinition/versions/0.0.1"
      },
      "isolatedNetwork": false,
      "scaleSettings": {
        "maxNodeCount": 1,
        "minNodeCount": 0,
        "nodeIdleTimeBeforeScaleDown": "PT5M"
      },
      "remoteLoginPortPublicAccess": "NotSpecified",
      "enableNodePublicIp": true
    }
  }
}

Sample response

Status code:: 200

{
  "id": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/testrg123/providers/Microsoft.MachineLearningServices/workspaces/workspaces123/computes/compute123",
  "type": "Microsoft.MachineLearningServices/workspaces/computes",
  "name": "compute123",
  "location": "eastus",
  "properties": {
    "computeType": "AmlCompute",
    "provisioningState": "Creating"
  }
}

Status code:: 201

Azure-AsyncOperation: https://management.azure.com/subscriptions/...pathToOperationStatus...

{
  "id": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/testrg123/providers/Microsoft.MachineLearningServices/workspaces/workspaces123/computes/compute123",
  "type": "Microsoft.MachineLearningServices/workspaces/computes",
  "name": "compute123",
  "location": "eastus",
  "properties": {
    "computeType": "AmlCompute",
    "provisioningState": "Creating"
  }
}

Create a DataFactory Compute

Sample request

HTTP

PUT https://management.azure.com/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/testrg123/providers/Microsoft.MachineLearningServices/workspaces/workspaces123/computes/compute123?api-version=2025-09-01

{
  "location": "eastus",
  "properties": {
    "computeType": "DataFactory"
  }
}

Sample response

Status code:: 200

{
  "id": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/testrg123/providers/Microsoft.MachineLearningServices/workspaces/workspaces123/computes/compute123",
  "type": "Microsoft.MachineLearningServices/workspaces/computes",
  "name": "compute123",
  "location": "eastus",
  "properties": {
    "computeType": "DataFactory",
    "provisioningState": "Creating"
  }
}

Status code:: 201

Azure-AsyncOperation: https://management.azure.com/subscriptions/...pathToOperationStatus...

{
  "id": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/testrg123/providers/Microsoft.MachineLearningServices/workspaces/workspaces123/computes/compute123",
  "type": "Microsoft.MachineLearningServices/workspaces/computes",
  "name": "compute123",
  "location": "eastus",
  "properties": {
    "computeType": "DataFactory",
    "provisioningState": "Creating"
  }
}

Create an AKS Compute

Sample request

HTTP

PUT https://management.azure.com/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/testrg123/providers/Microsoft.MachineLearningServices/workspaces/workspaces123/computes/compute123?api-version=2025-09-01

{
  "location": "eastus",
  "properties": {
    "computeType": "AKS"
  }
}

Sample response

Status code:: 200

{
  "id": "subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/testrg123/providers/Microsoft.MachineLearningServices/workspaces/workspaces123/computes/compute123",
  "type": "Microsoft.MachineLearningServices/workspaces/computes",
  "name": "compute123",
  "location": "eastus",
  "properties": {
    "computeType": "AKS",
    "provisioningState": "Creating"
  }
}

Status code:: 201

Azure-AsyncOperation: https://management.azure.com/subscriptions/...pathToOperationStatus...

{
  "id": "subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/testrg123/providers/Microsoft.MachineLearningServices/workspaces/workspaces123/computes/compute123",
  "type": "Microsoft.MachineLearningServices/workspaces/computes",
  "name": "compute123",
  "location": "eastus",
  "properties": {
    "computeType": "AKS",
    "provisioningState": "Creating"
  }
}

Create an ComputeInstance Compute

Sample request

HTTP

PUT https://management.azure.com/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/testrg123/providers/Microsoft.MachineLearningServices/workspaces/workspaces123/computes/compute123?api-version=2025-09-01

{
  "location": "eastus",
  "properties": {
    "computeType": "ComputeInstance",
    "properties": {
      "vmSize": "STANDARD_NC6",
      "subnet": {
        "id": "test-subnet-resource-id"
      },
      "applicationSharingPolicy": "Personal",
      "customServices": [
        {
          "docker": {
            "privileged": true
          },
          "environmentVariables": {
            "test_variable": {
              "type": "local",
              "value": "test_value"
            }
          },
          "volumes": [
            {
              "type": "bind",
              "readOnly": false,
              "source": "/home/azureuser/cloudfiles",
              "target": "/home/azureuser/cloudfiles"
            }
          ],
          "endpoints": [
            {
              "name": "connect",
              "target": 8787,
              "published": 8787,
              "protocol": "http"
            }
          ],
          "image": {
            "type": "docker",
            "reference": "ghcr.io/azure/rocker-rstudio-ml-verse:latest"
          },
          "name": "rstudio"
        }
      ],
      "sshSettings": {
        "sshPublicAccess": "Disabled"
      },
      "computeInstanceAuthorizationType": "personal",
      "personalComputeInstanceSettings": {
        "assignedUser": {
          "objectId": "00000000-0000-0000-0000-000000000000",
          "tenantId": "00000000-0000-0000-0000-000000000000"
        }
      }
    }
  }
}

Sample response

Status code:: 200

{
  "id": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/testrg123/providers/Microsoft.MachineLearningServices/workspaces/workspaces123/computes/compute123",
  "type": "Microsoft.MachineLearningServices/workspaces/computes",
  "name": "compute123",
  "location": "eastus",
  "properties": {
    "computeType": "ComputeInstance",
    "provisioningState": "Creating"
  }
}

Status code:: 201

Azure-AsyncOperation: https://management.azure.com/subscriptions/...pathToOperationStatus...

{
  "id": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/testrg123/providers/Microsoft.MachineLearningServices/workspaces/workspaces123/computes/compute123",
  "type": "Microsoft.MachineLearningServices/workspaces/computes",
  "name": "compute123",
  "location": "eastus",
  "properties": {
    "computeType": "ComputeInstance",
    "provisioningState": "Creating"
  }
}

Create an ComputeInstance Compute with minimal inputs

Sample request

HTTP

PUT https://management.azure.com/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/testrg123/providers/Microsoft.MachineLearningServices/workspaces/workspaces123/computes/compute123?api-version=2025-09-01

{
  "location": "eastus",
  "properties": {
    "computeType": "ComputeInstance",
    "properties": {
      "vmSize": "STANDARD_NC6"
    }
  }
}

Sample response

Status code:: 200

{
  "id": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/testrg123/providers/Microsoft.MachineLearningServices/workspaces/workspaces123/computes/compute123",
  "type": "Microsoft.MachineLearningServices/workspaces/computes",
  "name": "compute123",
  "location": "eastus",
  "properties": {
    "computeType": "ComputeInstance",
    "provisioningState": "Creating"
  }
}

Status code:: 201

Azure-AsyncOperation: https://management.azure.com/subscriptions/...pathToOperationStatus...

{
  "id": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/testrg123/providers/Microsoft.MachineLearningServices/workspaces/workspaces123/computes/compute123",
  "type": "Microsoft.MachineLearningServices/workspaces/computes",
  "name": "compute123",
  "location": "eastus",
  "properties": {
    "computeType": "ComputeInstance",
    "provisioningState": "Creating"
  }
}

Create an ComputeInstance Compute with Schedules

Sample request

HTTP

PUT https://management.azure.com/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/testrg123/providers/Microsoft.MachineLearningServices/workspaces/workspaces123/computes/compute123?api-version=2025-09-01

{
  "location": "eastus",
  "properties": {
    "computeType": "ComputeInstance",
    "properties": {
      "vmSize": "STANDARD_NC6",
      "applicationSharingPolicy": "Personal",
      "sshSettings": {
        "sshPublicAccess": "Disabled"
      },
      "computeInstanceAuthorizationType": "personal",
      "personalComputeInstanceSettings": {
        "assignedUser": {
          "objectId": "00000000-0000-0000-0000-000000000000",
          "tenantId": "00000000-0000-0000-0000-000000000000"
        }
      },
      "schedules": {
        "computeStartStop": [
          {
            "status": "Enabled",
            "action": "Stop",
            "triggerType": "Cron",
            "cron": {
              "expression": "0 18 * * *",
              "startTime": "2021-04-23T01:30:00",
              "timeZone": "Pacific Standard Time"
            }
          }
        ]
      }
    }
  }
}

Sample response

Status code:: 200

{
  "id": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/testrg123/providers/Microsoft.MachineLearningServices/workspaces/workspaces123/computes/compute123",
  "type": "Microsoft.MachineLearningServices/workspaces/computes",
  "name": "compute123",
  "location": "eastus",
  "properties": {
    "computeType": "ComputeInstance",
    "provisioningState": "Creating"
  }
}

Status code:: 201

Azure-AsyncOperation: https://management.azure.com/subscriptions/...pathToOperationStatus...

{
  "id": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/testrg123/providers/Microsoft.MachineLearningServices/workspaces/workspaces123/computes/compute123",
  "type": "Microsoft.MachineLearningServices/workspaces/computes",
  "name": "compute123",
  "location": "eastus",
  "properties": {
    "computeType": "ComputeInstance",
    "provisioningState": "Creating"
  }
}

Update a AML Compute

Sample request

HTTP

PUT https://management.azure.com/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/testrg123/providers/Microsoft.MachineLearningServices/workspaces/workspaces123/computes/compute123?api-version=2025-09-01

{
  "location": "eastus",
  "properties": {
    "computeType": "AmlCompute",
    "description": "some compute",
    "properties": {
      "scaleSettings": {
        "maxNodeCount": 4,
        "minNodeCount": 4,
        "nodeIdleTimeBeforeScaleDown": "PT5M"
      }
    }
  }
}

Sample response

Status code:: 200

{
  "id": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/testrg123/providers/Microsoft.MachineLearningServices/workspaces/workspaces123/computes/compute123",
  "type": "Microsoft.MachineLearningServices/workspaces/computes",
  "name": "compute123",
  "location": "eastus2",
  "properties": {
    "description": "some compute",
    "createdOn": "2021-04-01T22:00:00.0000000+00:00",
    "modifiedOn": "2021-04-01T22:00:00.0000000+00:00",
    "computeType": "AmlCompute",
    "provisioningState": "Succeeded",
    "properties": {
      "vmSize": "STANDARD_NC6",
      "vmPriority": "Dedicated",
      "osType": "Windows",
      "virtualMachineImage": null,
      "isolatedNetwork": false,
      "subnet": {
        "id": "test-subnet-resource-id"
      },
      "scaleSettings": {
        "maxNodeCount": 1,
        "minNodeCount": 0,
        "nodeIdleTimeBeforeScaleDown": "PT5M"
      },
      "remoteLoginPortPublicAccess": "Enabled",
      "allocationState": "Resizing",
      "allocationStateTransitionTime": "2017-09-27T22:28:08.998Z",
      "errors": null,
      "currentNodeCount": 0,
      "targetNodeCount": 1,
      "nodeStateCounts": {
        "preparingNodeCount": 0,
        "runningNodeCount": 0,
        "idleNodeCount": 0,
        "unusableNodeCount": 0,
        "leavingNodeCount": 0,
        "preemptedNodeCount": 0
      },
      "enableNodePublicIp": true
    }
  }
}

Status code:: 201

Azure-AsyncOperation: https://management.azure.com/subscriptions/...pathToOperationStatus...

{
  "id": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/testrg123/providers/Microsoft.MachineLearningServices/workspaces/workspaces123/computes/compute123",
  "type": "Microsoft.MachineLearningServices/workspaces/computes",
  "name": "compute123",
  "location": "eastus2",
  "properties": {
    "description": "some compute",
    "computeType": "AmlCompute",
    "provisioningState": "Updating"
  }
}

Update an AKS Compute

Sample request

HTTP

PUT https://management.azure.com/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/testrg123/providers/Microsoft.MachineLearningServices/workspaces/workspaces123/computes/compute123?api-version=2025-09-01

{
  "location": "eastus",
  "properties": {
    "description": "some compute",
    "resourceId": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourcegroups/testrg123/providers/Microsoft.ContainerService/managedClusters/compute123-56826-c9b00420020b2",
    "computeType": "AKS",
    "properties": {
      "agentCount": 4
    }
  }
}

Sample response

Status code:: 200

{
  "id": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/testrg123/providers/Microsoft.MachineLearningServices/workspaces/workspaces123/computes/compute123",
  "type": "Microsoft.MachineLearningServices/workspaces/computes",
  "name": "compute123",
  "location": "eastus",
  "properties": {
    "description": "some compute",
    "resourceId": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourcegroups/testrg123/providers/Microsoft.ContainerService/managedClusters/compute123-56826-c9b00420020b2",
    "computeType": "AKS",
    "provisioningState": "Succeeded",
    "properties": {
      "agentCount": 4
    }
  }
}

Status code:: 201

Azure-AsyncOperation: https://management.azure.com/subscriptions/...pathToOperationStatus...

{
  "id": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/testrg123/providers/Microsoft.MachineLearningServices/workspaces/workspaces123/computes/compute123",
  "type": "Microsoft.MachineLearningServices/workspaces/computes",
  "name": "compute123",
  "location": "eastus",
  "properties": {
    "description": "some compute",
    "resourceId": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourcegroups/testrg123/providers/Microsoft.ContainerService/managedClusters/compute123-56826-c9b00420020b2",
    "computeType": "AKS",
    "provisioningState": "Updating"
  }
}

Definitions

Name	Description
AKS	A Machine Learning compute based on AKS.
AksNetworkingConfiguration	Advance configuration for AKS networking
AllocationState	Allocation state.
AmlCompute	An Azure Machine Learning compute.
AmlComputeProperties	AML Compute properties
applicationSharingPolicy	Sharing policy for applications on this compute instance
AssignedUser	A user that can be assigned to a compute instance.
autosave	Auto save settings.
BindOptions	Describes the bind options for the container
caching	Caching type of Data Disk.
ClusterPurpose	Intended usage of the cluster
ComputeInstance	An Azure Machine Learning compute instance.
ComputeInstanceApplication	Defines an Aml Instance application and its connectivity endpoint URI.
ComputeInstanceAuthorizationType	Compute Instance Authorization type.
ComputeInstanceConnectivityEndpoints	Defines all connectivity endpoints and properties for an ComputeInstance.
ComputeInstanceContainer	Defines an Aml Instance container.
ComputeInstanceCreatedBy	Describes information on user who created this ComputeInstance.
ComputeInstanceDataDisk	Defines an Aml Instance DataDisk.
ComputeInstanceDataMount	Defines an Aml Instance DataMount.
ComputeInstanceEnvironmentInfo	Environment information
ComputeInstanceLastOperation	The last operation on ComputeInstance.
ComputeInstanceProperties	Compute Instance properties
ComputeInstanceSshSettings	Specifies policy and settings for SSH access.
ComputeInstanceState	Current state of an ComputeInstance.
ComputeInstanceVersion	Version of computeInstance.
ComputePowerAction	The compute power action.
ComputeRecurrenceFrequency	Enum to describe the frequency of a compute recurrence schedule
ComputeRecurrenceSchedule
ComputeResource	Machine Learning compute object wrapped into ARM resource envelope.
ComputeSchedules	The list of schedules to be applied on the computes
ComputeStartStopSchedule	Compute start stop schedule properties
ComputeTriggerType	Is the trigger type recurrence or cron.
ComputeType	The type of compute
ComputeWeekDay	Enum of weekday
createdByType	The type of identity that created the resource.
Cron	The workflow trigger cron for ComputeStartStop schedule type.
CustomService	Specifies the custom service configuration
Databricks	A DataFactory compute.
DatabricksProperties	Properties of Databricks
DataFactory	A DataFactory compute.
DataLakeAnalytics	A DataLakeAnalytics compute.
Docker	Docker container configuration
Endpoint	Describes the endpoint configuration for the container
EnvironmentVariable	Environment Variables for the container
EnvironmentVariableType	Type of Environment Variable
ErrorAdditionalInfo	The resource management error additional info.
ErrorDetail	The error detail.
ErrorResponse	Error response
HDInsight	A HDInsight compute.
HDInsightProperties	HDInsight compute properties
Image	Describes the Image Specifications
ImageMetadata	Returns metadata about the operating system image for this compute instance.
ImageType	Type of the image
InstanceTypeSchema	Instance type schema.
Kubernetes	A Machine Learning compute based on Kubernetes Compute.
KubernetesProperties	Kubernetes properties
LoadBalancerType	Load Balancer Type
ManagedServiceIdentity	Managed service identity (system assigned and/or user assigned identities)
ManagedServiceIdentityType	Type of managed service identity (where both SystemAssigned and UserAssigned types are allowed).
mountAction	Mount Action.
mountState	Mount state.
network	network of this container.
NodeStateCounts	Counts of various compute node states on the amlCompute.
OperationName	Name of the last operation.
OperationStatus	Operation status.
operationTrigger	Trigger of operation.
OsType	Compute OS Type
PersonalComputeInstanceSettings	Settings for a personal compute instance.
Properties	AKS properties
protocol	Endpoint Communication Protocol
ProvisioningState	The provision state of the cluster. Valid values are Unknown, Updating, Provisioning, Succeeded, and Failed.
provisioningStatus	The current deployment state of schedule.
Recurrence	The workflow trigger recurrence for ComputeStartStop schedule type.
remoteLoginPortPublicAccess	Close remote Login Access Port
ResourceId	Represents a resource ID. For example, for a subnet, it is the resource URL for the subnet.
Resources	Resource requests/limits for this instance type
ScaleSettings	scale settings for AML Compute
ScheduleBase
ScheduleProvisioningState	The current deployment state of schedule.
ScheduleStatus	Is the schedule enabled or disabled?
ScriptReference	Script reference
ScriptsToExecute	Customized setup scripts
SetupScripts	Details of customized scripts to execute for setting up the cluster.
Sku	The resource model definition representing SKU
SkuTier	This field is required to be implemented by the Resource Provider if the service has more than one tier, but is not required on a PUT.
sourceType	Data source type.
sshPublicAccess	Access policy for SSH
SslConfigStatus	Enable or disable ssl for scoring
SslConfiguration	The ssl configuration for scoring
storageAccountType	type of this storage account.
SynapseSpark	A SynapseSpark compute.
systemData	Metadata pertaining to creation and last modification of the resource.
SystemService	A system service running on a compute.
TmpfsOptions	Describes the tmpfs options for the container
UserAccountCredentials	Settings for user account that gets created on each on the nodes of a compute.
UserAssignedIdentity	User assigned identity properties
VirtualMachine	A Machine Learning compute based on Azure Virtual Machines.
VirtualMachineImage	Virtual Machine image for Windows AML Compute
VirtualMachineSshCredentials	Admin credentials for virtual machine
VmPriority	Virtual Machine priority
VolumeDefinition	Describes the volume configuration for the container
VolumeDefinitionType	Type of Volume Definition
VolumeOptions	Describes the volume options for the container

AKS

Object

A Machine Learning compute based on AKS.

Name	Type	Description
computeLocation	string	Location for the underlying compute
computeType	string: AKS	The type of compute
createdOn	string (date-time)	The time at which the compute was created.
description	string	The description of the Machine Learning compute.
disableLocalAuth	boolean	Opt-out of local authentication and ensure customers can use only MSI and AAD exclusively for authentication.
isAttachedCompute	boolean	Indicating whether the compute was provisioned by user and brought from outside if true, or machine learning service provisioned it if false.
modifiedOn	string (date-time)	The time at which the compute was last modified.
properties	Properties	AKS properties
provisioningErrors	ErrorResponse[]	Errors during provisioning
provisioningState	ProvisioningState	The provision state of the cluster. Valid values are Unknown, Updating, Provisioning, Succeeded, and Failed.
resourceId	string	ARM resource id of the underlying compute

AksNetworkingConfiguration

Object

Advance configuration for AKS networking

Name	Type	Description
dnsServiceIP	string pattern: ^(?:(?:25[0-5]\|2[0-4][0-9]\|[01]?[0-9][0-9]?)\.){3}(?:25[0-5]\|2[0-4][0-9]\|[01]?[0-9][0-9]?)$	An IP address assigned to the Kubernetes DNS service. It must be within the Kubernetes service address range specified in serviceCidr.
dockerBridgeCidr	string pattern: ^([0-9]{1,3}\.){3}[0-9]{1,3}(\/([0-9]\|[1-2][0-9]\|3[0-2]))?$	A CIDR notation IP range assigned to the Docker bridge network. It must not overlap with any Subnet IP ranges or the Kubernetes service address range.
serviceCidr	string pattern: ^([0-9]{1,3}\.){3}[0-9]{1,3}(\/([0-9]\|[1-2][0-9]\|3[0-2]))?$	A CIDR notation IP range from which to assign service cluster IPs. It must not overlap with any Subnet IP ranges.
subnetId	string	Virtual network subnet resource ID the compute nodes belong to

AllocationState

Enumeration

Allocation state.

Value	Description
Steady
Resizing

AmlCompute

Object

An Azure Machine Learning compute.

Name	Type	Description
computeLocation	string	Location for the underlying compute
computeType	string: AmlCompute	The type of compute
createdOn	string (date-time)	The time at which the compute was created.
description	string	The description of the Machine Learning compute.
disableLocalAuth	boolean	Opt-out of local authentication and ensure customers can use only MSI and AAD exclusively for authentication.
isAttachedCompute	boolean	Indicating whether the compute was provisioned by user and brought from outside if true, or machine learning service provisioned it if false.
modifiedOn	string (date-time)	The time at which the compute was last modified.
properties	AmlComputeProperties	Properties of AmlCompute
provisioningErrors	ErrorResponse[]	Errors during provisioning
provisioningState	ProvisioningState	The provision state of the cluster. Valid values are Unknown, Updating, Provisioning, Succeeded, and Failed.
resourceId	string	ARM resource id of the underlying compute

AmlComputeProperties

Object

AML Compute properties

Name	Type	Default value	Description
allocationState	AllocationState		Allocation state. Allocation state of the compute. Possible values are: steady - Indicates that the compute is not resizing. There are no changes to the number of compute nodes in the compute in progress. A compute enters this state when it is created and when no operations are being performed on the compute to change the number of compute nodes. resizing - Indicates that the compute is resizing; that is, compute nodes are being added to or removed from the compute.
allocationStateTransitionTime	string (date-time)		Allocation state transition time. The time at which the compute entered its current allocation state.
currentNodeCount	integer (int32)		Current node count. The number of compute nodes currently assigned to the compute.
enableNodePublicIp	boolean	True	Enable node public IP. Enable or disable node public IP address provisioning. Possible values are: Possible values are: true - Indicates that the compute nodes will have public IPs provisioned. false - Indicates that the compute nodes will have a private endpoint and no public IPs.
errors	ErrorResponse[]		Errors. Collection of errors encountered by various compute nodes during node setup.
isolatedNetwork	boolean		Network is isolated or not
nodeStateCounts	NodeStateCounts		Node state counts. Counts of various node states on the compute.
osType	OsType	Linux	Compute OS Type
propertyBag	object		A property bag containing additional properties.
remoteLoginPortPublicAccess	remoteLoginPortPublicAccess	NotSpecified	Close remote Login Access Port State of the public SSH port. Possible values are: Disabled - Indicates that the public ssh port is closed on all nodes of the cluster. Enabled - Indicates that the public ssh port is open on all nodes of the cluster. NotSpecified - Indicates that the public ssh port is closed on all nodes of the cluster if VNet is defined, else is open all public nodes. It can be default only during cluster creation time, after creation it will be either enabled or disabled.
scaleSettings	ScaleSettings		Scale settings for AML Compute
subnet	ResourceId		Subnet. Virtual network subnet resource ID the compute nodes belong to.
targetNodeCount	integer (int32)		Target node count. The target number of compute nodes for the compute. If the allocationState is resizing, this property denotes the target node count for the ongoing resize operation. If the allocationState is steady, this property denotes the target node count for the previous resize operation.
userAccountCredentials	UserAccountCredentials		User account credentials. Credentials for an administrator user account that will be created on each compute node.
virtualMachineImage	VirtualMachineImage		Virtual Machine image for AML Compute - windows only
vmPriority	VmPriority		Virtual Machine priority
vmSize	string		Virtual Machine Size

applicationSharingPolicy

Enumeration

Sharing policy for applications on this compute instance

Value	Description
Personal
Shared

AssignedUser

Object

A user that can be assigned to a compute instance.

Name	Type	Description
objectId	string	User’s AAD Object Id.
tenantId	string	User’s AAD Tenant Id.

autosave

Enumeration

Auto save settings.

Value	Description
None
Local
Remote

BindOptions

Object

Describes the bind options for the container

Name	Type	Description
createHostPath	boolean	Indicate whether to create host path.
propagation	string	Type of Bind Option
selinux	string	Mention the selinux options.

caching

Enumeration

Caching type of Data Disk.

Value	Description
None
ReadOnly
ReadWrite

ClusterPurpose

Enumeration

Intended usage of the cluster

Value	Description
FastProd
DenseProd
DevTest

ComputeInstance

Object

An Azure Machine Learning compute instance.

Name	Type	Description
computeLocation	string	Location for the underlying compute
computeType	string: ComputeInstance	The type of compute
createdOn	string (date-time)	The time at which the compute was created.
description	string	The description of the Machine Learning compute.
disableLocalAuth	boolean	Opt-out of local authentication and ensure customers can use only MSI and AAD exclusively for authentication.
isAttachedCompute	boolean	Indicating whether the compute was provisioned by user and brought from outside if true, or machine learning service provisioned it if false.
modifiedOn	string (date-time)	The time at which the compute was last modified.
properties	ComputeInstanceProperties	Properties of ComputeInstance
provisioningErrors	ErrorResponse[]	Errors during provisioning
provisioningState	ProvisioningState	The provision state of the cluster. Valid values are Unknown, Updating, Provisioning, Succeeded, and Failed.
resourceId	string	ARM resource id of the underlying compute

ComputeInstanceApplication

Object

Defines an Aml Instance application and its connectivity endpoint URI.

Name	Type	Description
displayName	string	Name of the ComputeInstance application.
endpointUri	string	Application' endpoint URI.

ComputeInstanceAuthorizationType

Enumeration

Compute Instance Authorization type.

Value	Description
personal

ComputeInstanceConnectivityEndpoints

Object

Defines all connectivity endpoints and properties for an ComputeInstance.

Name	Type	Description
privateIpAddress	string	Private IP Address of this ComputeInstance (local to the VNET in which the compute instance is deployed).
publicIpAddress	string	Public IP Address of this ComputeInstance.

ComputeInstanceContainer

Object

Defines an Aml Instance container.

Name	Type	Description
autosave	autosave	Auto save settings.
environment	ComputeInstanceEnvironmentInfo	Environment information of this container.
gpu	string	Information of GPU.
name	string	Name of the ComputeInstance container.
network	network	network of this container.
services	object[]	services of this containers.

ComputeInstanceCreatedBy

Object

Describes information on user who created this ComputeInstance.

Name	Type	Description
userId	string	Uniquely identifies the user within his/her organization.
userName	string	Name of the user.
userOrgId	string	Uniquely identifies user' Azure Active Directory organization.

ComputeInstanceDataDisk

Object

Defines an Aml Instance DataDisk.

Name	Type	Default value	Description
caching	caching		Caching type of Data Disk.
diskSizeGB	integer (int32)		The initial disk size in gigabytes. The initial disk size in gigabytes.
lun	integer (int32)		The logical unit number. The lun is used to uniquely identify each data disk. If attaching multiple disks, each should have a distinct lun.
storageAccountType	storageAccountType	Standard_LRS	type of this storage account.

ComputeInstanceDataMount

Object

Defines an Aml Instance DataMount.

Name	Type	Description
createdBy	string	who this data mount created by.
error	string	Error of this data mount.
mountAction	mountAction	Mount Action.
mountName	string	name of the ComputeInstance data mount.
mountPath	string	Path of this data mount.
mountState	mountState	Mount state.
mountedOn	string (date-time)	Mounted time. The time when the disk mounted.
source	string	Source of the ComputeInstance data mount.
sourceType	sourceType	Data source type.

ComputeInstanceEnvironmentInfo

Object

Environment information

Name	Type	Description
name	string	name of environment.
version	string	version of environment.

ComputeInstanceLastOperation

Object

The last operation on ComputeInstance.

Name	Type	Description
operationName	OperationName	Name of the last operation.
operationStatus	OperationStatus	Operation status.
operationTime	string (date-time)	Time of the last operation.
operationTrigger	operationTrigger	Trigger of operation.

ComputeInstanceProperties

Object

Compute Instance properties

Name	Type	Default value	Description
applicationSharingPolicy	applicationSharingPolicy	Shared	Sharing policy for applications on this compute instance Policy for sharing applications on this compute instance among users of parent workspace. If Personal, only the creator can access applications on this compute instance. When Shared, any workspace user can access applications on this instance depending on his/her assigned role.
applications	ComputeInstanceApplication[]		Describes available applications and their endpoints on this ComputeInstance.
computeInstanceAuthorizationType	ComputeInstanceAuthorizationType	personal	Compute Instance Authorization type. The Compute Instance Authorization type. Available values are personal (default).
connectivityEndpoints	ComputeInstanceConnectivityEndpoints		Describes all connectivity endpoints available for this ComputeInstance.
containers	ComputeInstanceContainer[]		Describes informations of containers on this ComputeInstance.
createdBy	ComputeInstanceCreatedBy		Describes information on user who created this ComputeInstance.
customServices	CustomService[]		List of Custom Services added to the compute.
dataDisks	ComputeInstanceDataDisk[]		Describes informations of dataDisks on this ComputeInstance.
dataMounts	ComputeInstanceDataMount[]		Describes informations of dataMounts on this ComputeInstance.
enableNodePublicIp	boolean		Enable node public IP. Enable or disable node public IP address provisioning. Possible values are: Possible values are: true - Indicates that the compute nodes will have public IPs provisioned. false - Indicates that the compute nodes will have a private endpoint and no public IPs.
errors	ErrorResponse[]		Errors. Collection of errors encountered on this ComputeInstance.
lastOperation	ComputeInstanceLastOperation		The last operation on ComputeInstance.
osImageMetadata	ImageMetadata		Returns metadata about the operating system image for this compute instance.
personalComputeInstanceSettings	PersonalComputeInstanceSettings		Personal Compute Instance settings. Settings for a personal compute instance.
schedules	ComputeSchedules		The list of schedules to be applied on the computes.
setupScripts	SetupScripts		Details of customized scripts to execute for setting up the cluster.
sshSettings	ComputeInstanceSshSettings		Specifies policy and settings for SSH access.
state	ComputeInstanceState		The current state of this ComputeInstance.
subnet	ResourceId		Subnet. Virtual network subnet resource ID the compute nodes belong to.
versions	ComputeInstanceVersion		ComputeInstance version.
vmSize	string		Virtual Machine Size

ComputeInstanceSshSettings

Object

Specifies policy and settings for SSH access.

Name	Type	Default value	Description
adminPublicKey	string		Specifies the SSH rsa public key file as a string. Use "ssh-keygen -t rsa -b 2048" to generate your SSH key pairs.
adminUserName	string		Describes the admin user name.
sshPort	integer (int32)		Describes the port for connecting through SSH.
sshPublicAccess	sshPublicAccess	Disabled	Access policy for SSH State of the public SSH port. Possible values are: Disabled - Indicates that the public ssh port is closed on this instance. Enabled - Indicates that the public ssh port is open and accessible according to the VNet/subnet policy if applicable.

ComputeInstanceState

Enumeration

Current state of an ComputeInstance.

Value	Description
Creating
CreateFailed
Deleting
Running
Restarting
JobRunning
SettingUp
SetupFailed
Starting
Stopped
Stopping
UserSettingUp
UserSetupFailed
Unknown
Unusable

ComputeInstanceVersion

Object

Version of computeInstance.

Name	Type	Description
runtime	string	Runtime of compute instance.

ComputePowerAction

Enumeration

The compute power action.

Value	Description
Start
Stop

ComputeRecurrenceFrequency

Enumeration

Enum to describe the frequency of a compute recurrence schedule

Value	Description
Minute	Minute frequency
Hour	Hour frequency
Day	Day frequency
Week	Week frequency
Month	Month frequency

ComputeRecurrenceSchedule

Object

Name	Type	Description
hours	integer[] (int32)	[Required] List of hours for the schedule.
minutes	integer[] (int32)	[Required] List of minutes for the schedule.
monthDays	integer[] (int32)	List of month days for the schedule
weekDays	ComputeWeekDay[]	List of days for the schedule.

ComputeResource

Object

Machine Learning compute object wrapped into ARM resource envelope.

Name	Type	Description
id	string	Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
identity	ManagedServiceIdentity	The identity of the resource.
location	string	Specifies the location of the resource.
name	string	The name of the resource
properties	Compute: AKS AmlCompute ComputeInstance DataFactory DataLakeAnalytics Databricks HDInsight Kubernetes SynapseSpark VirtualMachine	Compute properties
sku	Sku	The sku of the workspace.
systemData	systemData	Azure Resource Manager metadata containing createdBy and modifiedBy information.
tags	object	Contains resource tags defined as key/value pairs.
type	string	The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"

ComputeSchedules

Object

The list of schedules to be applied on the computes

Name	Type	Description
computeStartStop	ComputeStartStopSchedule[]	The list of compute start stop schedules to be applied.

ComputeStartStopSchedule

Object

Compute start stop schedule properties

Name	Type	Description
action	ComputePowerAction	[Required] The compute power action.
cron	Cron	Required if triggerType is Cron.
id	string	A system assigned id for the schedule.
provisioningStatus	provisioningStatus	The current deployment state of schedule.
recurrence	Recurrence	Required if triggerType is Recurrence.
schedule	ScheduleBase	[Deprecated] Not used any more.
status	ScheduleStatus	Is the schedule enabled or disabled?
triggerType	ComputeTriggerType	[Required] The schedule trigger type.

ComputeTriggerType

Enumeration

Is the trigger type recurrence or cron.

Value	Description
Recurrence
Cron

ComputeType

Enumeration

The type of compute

Value	Description
AKS
Kubernetes
AmlCompute
ComputeInstance
DataFactory
VirtualMachine
HDInsight
Databricks
DataLakeAnalytics
SynapseSpark

ComputeWeekDay

Enumeration

Enum of weekday

Value	Description
Monday	Monday weekday
Tuesday	Tuesday weekday
Wednesday	Wednesday weekday
Thursday	Thursday weekday
Friday	Friday weekday
Saturday	Saturday weekday
Sunday	Sunday weekday

createdByType

Enumeration

The type of identity that created the resource.

Value	Description
User
Application
ManagedIdentity
Key

Cron

Object

The workflow trigger cron for ComputeStartStop schedule type.

Name	Type	Default value	Description
expression	string		[Required] Specifies cron expression of schedule. The expression should follow NCronTab format.
startTime	string		The start time in yyyy-MM-ddTHH:mm:ss format.
timeZone	string	UTC	Specifies time zone in which the schedule runs. TimeZone should follow Windows time zone format. Refer: https://docs.microsoft.com/en-us/windows-hardware/manufacture/desktop/default-time-zones?view=windows-11

CustomService

Object

Specifies the custom service configuration

Name	Type	Description
docker	Docker	Describes the docker settings for the image
endpoints	Endpoint[]	Configuring the endpoints for the container
environmentVariables	<string, EnvironmentVariable>	Environment Variable for the container
image	Image	Describes the Image Specifications
name	string	Name of the Custom Service
volumes	VolumeDefinition[]	Configuring the volumes for the container

Databricks

Object

A DataFactory compute.

Name	Type	Description
computeLocation	string	Location for the underlying compute
computeType	string: Databricks	The type of compute
createdOn	string (date-time)	The time at which the compute was created.
description	string	The description of the Machine Learning compute.
disableLocalAuth	boolean	Opt-out of local authentication and ensure customers can use only MSI and AAD exclusively for authentication.
isAttachedCompute	boolean	Indicating whether the compute was provisioned by user and brought from outside if true, or machine learning service provisioned it if false.
modifiedOn	string (date-time)	The time at which the compute was last modified.
properties	DatabricksProperties	Properties of Databricks
provisioningErrors	ErrorResponse[]	Errors during provisioning
provisioningState	ProvisioningState	The provision state of the cluster. Valid values are Unknown, Updating, Provisioning, Succeeded, and Failed.
resourceId	string	ARM resource id of the underlying compute

DatabricksProperties

Object

Properties of Databricks

Name	Type	Description
databricksAccessToken	string	Databricks access token
workspaceUrl	string	Workspace Url

DataFactory

Object

A DataFactory compute.

Name	Type	Description
computeLocation	string	Location for the underlying compute
computeType	string: DataFactory	The type of compute
createdOn	string (date-time)	The time at which the compute was created.
description	string	The description of the Machine Learning compute.
disableLocalAuth	boolean	Opt-out of local authentication and ensure customers can use only MSI and AAD exclusively for authentication.
isAttachedCompute	boolean	Indicating whether the compute was provisioned by user and brought from outside if true, or machine learning service provisioned it if false.
modifiedOn	string (date-time)	The time at which the compute was last modified.
provisioningErrors	ErrorResponse[]	Errors during provisioning
provisioningState	ProvisioningState	The provision state of the cluster. Valid values are Unknown, Updating, Provisioning, Succeeded, and Failed.
resourceId	string	ARM resource id of the underlying compute

DataLakeAnalytics

Object

A DataLakeAnalytics compute.

Name	Type	Description
computeLocation	string	Location for the underlying compute
computeType	string: DataLakeAnalytics	The type of compute
createdOn	string (date-time)	The time at which the compute was created.
description	string	The description of the Machine Learning compute.
disableLocalAuth	boolean	Opt-out of local authentication and ensure customers can use only MSI and AAD exclusively for authentication.
isAttachedCompute	boolean	Indicating whether the compute was provisioned by user and brought from outside if true, or machine learning service provisioned it if false.
modifiedOn	string (date-time)	The time at which the compute was last modified.
properties	Properties
provisioningErrors	ErrorResponse[]	Errors during provisioning
provisioningState	ProvisioningState	The provision state of the cluster. Valid values are Unknown, Updating, Provisioning, Succeeded, and Failed.
resourceId	string	ARM resource id of the underlying compute

Docker

Object

Docker container configuration

Name	Type	Description
privileged	boolean	Indicate whether container shall run in privileged or non-privileged mode.

Endpoint

Object

Describes the endpoint configuration for the container

Name	Type	Default value	Description
hostIp	string		Host IP over which the application is exposed from the container
name	string		Name of the Endpoint
protocol	protocol	tcp	Endpoint Communication Protocol Protocol over which communication will happen over this endpoint
published	integer (int32)		Port over which the application is exposed from container.
target	integer (int32)		Application port inside the container.

EnvironmentVariable

Object

Environment Variables for the container

Name	Type	Default value	Description
type	EnvironmentVariableType	local	Type of Environment Variable Type of the Environment Variable. Possible values are: local - For local variable
value	string		Value of the Environment variable

EnvironmentVariableType

Enumeration

Type of Environment Variable

Value	Description
local

ErrorAdditionalInfo

Object

The resource management error additional info.

Name	Type	Description
info	object	The additional info.
type	string	The additional info type.

ErrorDetail

Object

The error detail.

Name	Type	Description
additionalInfo	ErrorAdditionalInfo[]	The error additional info.
code	string	The error code.
details	ErrorDetail[]	The error details.
message	string	The error message.
target	string	The error target.

ErrorResponse

Object

Error response

Name	Type	Description
error	ErrorDetail	The error object.

HDInsight

Object

A HDInsight compute.

Name	Type	Description
computeLocation	string	Location for the underlying compute
computeType	string: HDInsight	The type of compute
createdOn	string (date-time)	The time at which the compute was created.
description	string	The description of the Machine Learning compute.
disableLocalAuth	boolean	Opt-out of local authentication and ensure customers can use only MSI and AAD exclusively for authentication.
isAttachedCompute	boolean	Indicating whether the compute was provisioned by user and brought from outside if true, or machine learning service provisioned it if false.
modifiedOn	string (date-time)	The time at which the compute was last modified.
properties	HDInsightProperties	HDInsight compute properties
provisioningErrors	ErrorResponse[]	Errors during provisioning
provisioningState	ProvisioningState	The provision state of the cluster. Valid values are Unknown, Updating, Provisioning, Succeeded, and Failed.
resourceId	string	ARM resource id of the underlying compute

HDInsightProperties

Object

HDInsight compute properties

Name	Type	Description
address	string	Public IP address of the master node of the cluster.
administratorAccount	VirtualMachineSshCredentials	Admin credentials for master node of the cluster
sshPort	integer (int32)	Port open for ssh connections on the master node of the cluster.

Image

Object

Describes the Image Specifications

Name	Type	Default value	Description
reference	string		Image reference
type	ImageType	docker	Type of the image Type of the image. Possible values are: docker - For docker images. azureml - For AzureML images

ImageMetadata

Object

Returns metadata about the operating system image for this compute instance.

Name	Type	Description
currentImageVersion	string	Specifies the current operating system image version this compute instance is running on.
isLatestOsImageVersion	boolean	Specifies whether this compute instance is running on the latest operating system image.
latestImageVersion	string	Specifies the latest available operating system image version.

ImageType

Enumeration

Type of the image

Value	Description
docker
azureml

InstanceTypeSchema

Object

Instance type schema.

Name	Type	Description
nodeSelector	object	Node Selector
resources	Resources	Resource requests/limits for this instance type

Kubernetes

Object

A Machine Learning compute based on Kubernetes Compute.

Name	Type	Description
computeLocation	string	Location for the underlying compute
computeType	string: Kubernetes	The type of compute
createdOn	string (date-time)	The time at which the compute was created.
description	string	The description of the Machine Learning compute.
disableLocalAuth	boolean	Opt-out of local authentication and ensure customers can use only MSI and AAD exclusively for authentication.
isAttachedCompute	boolean	Indicating whether the compute was provisioned by user and brought from outside if true, or machine learning service provisioned it if false.
modifiedOn	string (date-time)	The time at which the compute was last modified.
properties	KubernetesProperties	Properties of Kubernetes
provisioningErrors	ErrorResponse[]	Errors during provisioning
provisioningState	ProvisioningState	The provision state of the cluster. Valid values are Unknown, Updating, Provisioning, Succeeded, and Failed.
resourceId	string	ARM resource id of the underlying compute

KubernetesProperties

Object

Kubernetes properties

Name	Type	Default value	Description
defaultInstanceType	string		Default instance type
extensionInstanceReleaseTrain	string		Extension instance release train.
extensionPrincipalId	string		Extension principal-id.
instanceTypes	<string, InstanceTypeSchema>		Instance Type Schema
namespace	string	default	Compute namespace
relayConnectionString	string		Relay connection string.
serviceBusConnectionString	string		ServiceBus connection string.
vcName	string		VC name.

LoadBalancerType

Enumeration

Load Balancer Type

Value	Description
PublicIp
InternalLoadBalancer

ManagedServiceIdentity

Object

Managed service identity (system assigned and/or user assigned identities)

Name	Type	Description
principalId	string (uuid)	The service principal ID of the system assigned identity. This property will only be provided for a system assigned identity.
tenantId	string (uuid)	The tenant ID of the system assigned identity. This property will only be provided for a system assigned identity.
type	ManagedServiceIdentityType	Type of managed service identity (where both SystemAssigned and UserAssigned types are allowed).
userAssignedIdentities	<string, UserAssignedIdentity>	User-Assigned Identities The set of user assigned identities associated with the resource. The userAssignedIdentities dictionary keys will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}. The dictionary values can be empty objects ({}) in requests.

ManagedServiceIdentityType

Enumeration

Type of managed service identity (where both SystemAssigned and UserAssigned types are allowed).

Value	Description
None
SystemAssigned
UserAssigned
SystemAssigned,UserAssigned

mountAction

Enumeration

Mount Action.

Value	Description
Mount
Unmount

mountState

Enumeration

Mount state.

Value	Description
MountRequested
Mounted
MountFailed
UnmountRequested
UnmountFailed
Unmounted

network

Enumeration

network of this container.

Value	Description
Bridge
Host

NodeStateCounts

Object

Counts of various compute node states on the amlCompute.

Name	Type	Description
idleNodeCount	integer (int32)	Idle node count. Number of compute nodes in idle state.
leavingNodeCount	integer (int32)	Leaving node count. Number of compute nodes which are leaving the amlCompute.
preemptedNodeCount	integer (int32)	Preempted node count. Number of compute nodes which are in preempted state.
preparingNodeCount	integer (int32)	Preparing node count. Number of compute nodes which are being prepared.
runningNodeCount	integer (int32)	Running node count. Number of compute nodes which are running jobs.
unusableNodeCount	integer (int32)	Unusable node count. Number of compute nodes which are in unusable state.

OperationName

Enumeration

Name of the last operation.

Value	Description
Create
Start
Stop
Restart
Reimage
Delete

OperationStatus

Enumeration

Operation status.

Value	Description
InProgress
Succeeded
CreateFailed
StartFailed
StopFailed
RestartFailed
ReimageFailed
DeleteFailed

operationTrigger

Enumeration

Trigger of operation.

Value	Description
User
Schedule
IdleShutdown

OsType

Enumeration

Compute OS Type

Value	Description
Linux
Windows

PersonalComputeInstanceSettings

Object

Settings for a personal compute instance.

Name	Type	Description
assignedUser	AssignedUser	Assigned User. A user explicitly assigned to a personal compute instance.

Properties

Object

AKS properties

Name	Type	Default value	Description
agentCount	integer (int32) minimum: 0		Number of agents
agentVmSize	string		Agent virtual machine size
aksNetworkingConfiguration	AksNetworkingConfiguration		AKS networking configuration for vnet
clusterFqdn	string		Cluster full qualified domain name
clusterPurpose	ClusterPurpose	FastProd	Intended usage of the cluster
loadBalancerSubnet	string		Load Balancer Subnet
loadBalancerType	LoadBalancerType	PublicIp	Load Balancer Type
sslConfiguration	SslConfiguration		SSL configuration
systemServices	SystemService[]		System services

protocol

Enumeration

Endpoint Communication Protocol

Value	Description
tcp
udp
http

ProvisioningState

Enumeration

The provision state of the cluster. Valid values are Unknown, Updating, Provisioning, Succeeded, and Failed.

Value	Description
Unknown
Updating
Creating
Deleting
Succeeded
Failed
Canceled

provisioningStatus

Enumeration

The current deployment state of schedule.

Value	Description
Completed
Provisioning
Failed

Recurrence

Object

The workflow trigger recurrence for ComputeStartStop schedule type.

Name	Type	Default value	Description
frequency	ComputeRecurrenceFrequency		[Required] The frequency to trigger schedule.
interval	integer (int32)		[Required] Specifies schedule interval in conjunction with frequency
schedule	ComputeRecurrenceSchedule		[Required] The recurrence schedule.
startTime	string		The start time in yyyy-MM-ddTHH:mm:ss format.
timeZone	string	UTC	Specifies time zone in which the schedule runs. TimeZone should follow Windows time zone format. Refer: https://docs.microsoft.com/en-us/windows-hardware/manufacture/desktop/default-time-zones?view=windows-11

remoteLoginPortPublicAccess

Enumeration

Close remote Login Access Port

Value	Description
Enabled
Disabled
NotSpecified

ResourceId

Object

Represents a resource ID. For example, for a subnet, it is the resource URL for the subnet.

Name	Type	Description
id	string	The ID of the resource

Resources

Object

Resource requests/limits for this instance type

Name	Type	Description
limits	object	Resource limits for this instance type
requests	object	Resource requests for this instance type

ScaleSettings

Object

scale settings for AML Compute

Name	Type	Default value	Description
maxNodeCount	integer (int32)		Max number of nodes to use
minNodeCount	integer (int32)	0	Min number of nodes to use
nodeIdleTimeBeforeScaleDown	string (duration)		Node Idle Time before scaling down amlCompute. This string needs to be in the RFC Format.

ScheduleBase

Object

Name	Type	Description
id	string	A system assigned id for the schedule.
provisioningStatus	ScheduleProvisioningState	The current deployment state of schedule.
status	ScheduleStatus	Is the schedule enabled or disabled?

ScheduleProvisioningState

Enumeration

The current deployment state of schedule.

Value	Description
Completed
Provisioning
Failed

ScheduleStatus

Enumeration

Is the schedule enabled or disabled?

Value	Description
Enabled
Disabled

ScriptReference

Object

Script reference

Name	Type	Description
scriptArguments	string	Optional command line arguments passed to the script to run.
scriptData	string	The location of scripts in the mounted volume.
scriptSource	string	The storage source of the script: workspace.
timeout	string	Optional time period passed to timeout command.

ScriptsToExecute

Object

Customized setup scripts

Name	Type	Description
creationScript	ScriptReference	Script that's run only once during provision of the compute.
startupScript	ScriptReference	Script that's run every time the machine starts.

SetupScripts

Object

Details of customized scripts to execute for setting up the cluster.

Name	Type	Description
scripts	ScriptsToExecute	Customized setup scripts

Sku

Object

The resource model definition representing SKU

Name	Type	Description
capacity	integer (int32)	If the SKU supports scale out/in then the capacity integer should be included. If scale out/in is not possible for the resource this may be omitted.
family	string	If the service has different generations of hardware, for the same SKU, then that can be captured here.
name	string	The name of the SKU. Ex - P3. It is typically a letter+number code
size	string	The SKU size. When the name field is the combination of tier and some other value, this would be the standalone code.
tier	SkuTier	This field is required to be implemented by the Resource Provider if the service has more than one tier, but is not required on a PUT.

SkuTier

Enumeration

This field is required to be implemented by the Resource Provider if the service has more than one tier, but is not required on a PUT.

Value	Description
Free
Basic
Standard
Premium

sourceType

Enumeration

Data source type.

Value	Description
Dataset
Datastore
URI

sshPublicAccess

Enumeration

Access policy for SSH

Value	Description
Enabled
Disabled

SslConfigStatus

Enumeration

Enable or disable ssl for scoring

Value	Description
Disabled
Enabled
Auto

SslConfiguration

Object

The ssl configuration for scoring

Name	Type	Description
cert	string	Cert data
cname	string	CNAME of the cert
key	string	Key data
leafDomainLabel	string	Leaf domain label of public endpoint
overwriteExistingDomain	boolean	Indicates whether to overwrite existing domain label.
status	SslConfigStatus	Enable or disable ssl for scoring

storageAccountType

Enumeration

type of this storage account.

Value	Description
Standard_LRS
Premium_LRS

SynapseSpark

Object

A SynapseSpark compute.

Name	Type	Description
computeLocation	string	Location for the underlying compute
computeType	string: SynapseSpark	The type of compute
createdOn	string (date-time)	The time at which the compute was created.
description	string	The description of the Machine Learning compute.
disableLocalAuth	boolean	Opt-out of local authentication and ensure customers can use only MSI and AAD exclusively for authentication.
isAttachedCompute	boolean	Indicating whether the compute was provisioned by user and brought from outside if true, or machine learning service provisioned it if false.
modifiedOn	string (date-time)	The time at which the compute was last modified.
properties	Properties
provisioningErrors	ErrorResponse[]	Errors during provisioning
provisioningState	ProvisioningState	The provision state of the cluster. Valid values are Unknown, Updating, Provisioning, Succeeded, and Failed.
resourceId	string	ARM resource id of the underlying compute

systemData

Object

Metadata pertaining to creation and last modification of the resource.

Name	Type	Description
createdAt	string (date-time)	The timestamp of resource creation (UTC).
createdBy	string	The identity that created the resource.
createdByType	createdByType	The type of identity that created the resource.
lastModifiedAt	string (date-time)	The timestamp of resource last modification (UTC)
lastModifiedBy	string	The identity that last modified the resource.
lastModifiedByType	createdByType	The type of identity that last modified the resource.

SystemService

Object

A system service running on a compute.

Name	Type	Description
publicIpAddress	string	Public IP address
systemServiceType	string	The type of this system service.
version	string	The version for this type.

TmpfsOptions

Object

Describes the tmpfs options for the container

Name	Type	Description
size	integer (int32)	Mention the Tmpfs size

UserAccountCredentials

Object

Settings for user account that gets created on each on the nodes of a compute.

Name	Type	Description
adminUserName	string	User name. Name of the administrator user account which can be used to SSH to nodes.
adminUserPassword	string	Password. Password of the administrator user account.
adminUserSshPublicKey	string	SSH public key. SSH public key of the administrator user account.

UserAssignedIdentity

Object

User assigned identity properties

Name	Type	Description
clientId	string (uuid)	The client ID of the assigned identity.
principalId	string (uuid)	The principal ID of the assigned identity.

VirtualMachine

Object

A Machine Learning compute based on Azure Virtual Machines.

Name	Type	Description
computeLocation	string	Location for the underlying compute
computeType	string: VirtualMachine	The type of compute
createdOn	string (date-time)	The time at which the compute was created.
description	string	The description of the Machine Learning compute.
disableLocalAuth	boolean	Opt-out of local authentication and ensure customers can use only MSI and AAD exclusively for authentication.
isAttachedCompute	boolean	Indicating whether the compute was provisioned by user and brought from outside if true, or machine learning service provisioned it if false.
modifiedOn	string (date-time)	The time at which the compute was last modified.
properties	Properties
provisioningErrors	ErrorResponse[]	Errors during provisioning
provisioningState	ProvisioningState	The provision state of the cluster. Valid values are Unknown, Updating, Provisioning, Succeeded, and Failed.
resourceId	string	ARM resource id of the underlying compute

VirtualMachineImage

Object

Virtual Machine image for Windows AML Compute

Name	Type	Description
id	string	Virtual Machine image path

VirtualMachineSshCredentials

Object

Admin credentials for virtual machine

Name	Type	Description
password	string	Password of admin account
privateKeyData	string	Private key data
publicKeyData	string	Public key data
username	string	Username of admin account

VmPriority

Enumeration

Virtual Machine priority

Value	Description
Dedicated
LowPriority

VolumeDefinition

Object

Describes the volume configuration for the container

Name	Type	Default value	Description
bind	BindOptions		Bind Options of the mount
consistency	string		Consistency of the volume
readOnly	boolean		Indicate whether to mount volume as readOnly. Default value for this is false.
source	string		Source of the mount. For bind mounts this is the host path.
target	string		Target of the mount. For bind mounts this is the path in the container.
tmpfs	TmpfsOptions		tmpfs option of the mount
type	VolumeDefinitionType	bind	Type of Volume Definition Type of Volume Definition. Possible Values: bind,volume,tmpfs,npipe
volume	VolumeOptions		Volume Options of the mount

VolumeDefinitionType

Enumeration

Type of Volume Definition

Value	Description
bind
volume
tmpfs
npipe

VolumeOptions

Object

Describes the volume options for the container

Name	Type	Description
nocopy	boolean	Indicate whether volume is nocopy