Microsoft.MachineLearningServices workspaces/computes 2021-04-01

Bicep resource definition

The workspaces/computes resource type can be deployed with operations that target:

For a list of changed properties in each API version, see change log.

Resource format

To create a Microsoft.MachineLearningServices/workspaces/computes resource, add the following Bicep to your template.

resource symbolicname 'Microsoft.MachineLearningServices/workspaces/computes@2021-04-01' = {
  identity: {
    type: 'string'
    userAssignedIdentities: {
      {customized property}: {}
    }
  }
  location: 'string'
  name: 'string'
  properties: {
    computeLocation: 'string'
    description: 'string'
    disableLocalAuth: bool
    resourceId: 'string'
    computeType: 'string'
    // For remaining properties, see Compute objects
  }
  sku: {
    name: 'string'
    tier: 'string'
  }
  tags: {
    {customized property}: 'string'
  }
}

Compute objects

Set the computeType property to specify the type of object.

For AKS, use:

{
  computeType: 'AKS'
  properties: {
    agentCount: int
    agentVmSize: 'string'
    aksNetworkingConfiguration: {
      dnsServiceIP: 'string'
      dockerBridgeCidr: 'string'
      serviceCidr: 'string'
      subnetId: 'string'
    }
    clusterFqdn: 'string'
    clusterPurpose: 'string'
    loadBalancerSubnet: 'string'
    loadBalancerType: 'string'
    sslConfiguration: {
      cert: 'string'
      cname: 'string'
      key: 'string'
      leafDomainLabel: 'string'
      overwriteExistingDomain: bool
      status: 'string'
    }
  }
}

For AmlCompute, use:

{
  computeType: 'AmlCompute'
  properties: {
    enableNodePublicIp: bool
    isolatedNetwork: bool
    osType: 'string'
    remoteLoginPortPublicAccess: 'string'
    scaleSettings: {
      maxNodeCount: int
      minNodeCount: int
      nodeIdleTimeBeforeScaleDown: 'string'
    }
    subnet: {
      id: 'string'
    }
    userAccountCredentials: {
      adminUserName: 'string'
      adminUserPassword: 'string'
      adminUserSshPublicKey: 'string'
    }
    virtualMachineImage: {
      id: 'string'
    }
    vmPriority: 'string'
    vmSize: 'string'
  }
}

For ComputeInstance, use:

{
  computeType: 'ComputeInstance'
  properties: {
    applicationSharingPolicy: 'string'
    computeInstanceAuthorizationType: 'string'
    personalComputeInstanceSettings: {
      assignedUser: {
        objectId: 'string'
        tenantId: 'string'
      }
    }
    setupScripts: {
      scripts: {
        creationScript: {
          scriptArguments: 'string'
          scriptData: 'string'
          scriptSource: 'string'
          timeout: 'string'
        }
        startupScript: {
          scriptArguments: 'string'
          scriptData: 'string'
          scriptSource: 'string'
          timeout: 'string'
        }
      }
    }
    sshSettings: {
      adminPublicKey: 'string'
      sshPublicAccess: 'string'
    }
    subnet: {
      id: 'string'
    }
    vmSize: 'string'
  }
}

For DataFactory, use:

{
  computeType: 'DataFactory'
}

For DataLakeAnalytics, use:

{
  computeType: 'DataLakeAnalytics'
  properties: {
    dataLakeStoreAccountName: 'string'
  }
}

For Databricks, use:

{
  computeType: 'Databricks'
  properties: {
    databricksAccessToken: 'string'
    workspaceUrl: 'string'
  }
}

For HDInsight, use:

{
  computeType: 'HDInsight'
  properties: {
    address: 'string'
    administratorAccount: {
      password: 'string'
      privateKeyData: 'string'
      publicKeyData: 'string'
      username: 'string'
    }
    sshPort: int
  }
}

For SynapseSpark, use:

{
  computeType: 'SynapseSpark'
  properties: {
    autoPauseProperties: {
      delayInMinutes: int
      enabled: bool
    }
    autoScaleProperties: {
      enabled: bool
      maxNodeCount: int
      minNodeCount: int
    }
    nodeCount: int
    nodeSize: 'string'
    nodeSizeFamily: 'string'
    poolName: 'string'
    resourceGroup: 'string'
    sparkVersion: 'string'
    subscriptionId: 'string'
    workspaceName: 'string'
  }
}

For VirtualMachine, use:

{
  computeType: 'VirtualMachine'
  properties: {
    address: 'string'
    administratorAccount: {
      password: 'string'
      privateKeyData: 'string'
      publicKeyData: 'string'
      username: 'string'
    }
    isNotebookInstanceCompute: bool
    sshPort: int
    virtualMachineSize: 'string'
  }
}

Property values

AKS

Name Description Value
computeType The type of compute 'AKS' (required)
properties AKS properties AKSProperties

AksNetworkingConfiguration

Name Description Value
dnsServiceIP An IP address assigned to the Kubernetes DNS service. It must be within the Kubernetes service address range specified in serviceCidr. string

Constraints:
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]?)$
dockerBridgeCidr 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. string

Constraints:
Pattern = ^([0-9]{1,3}\.){3}[0-9]{1,3}(\/([0-9]|[1-2][0-9]|3[0-2]))?$
serviceCidr A CIDR notation IP range from which to assign service cluster IPs. It must not overlap with any Subnet IP ranges. string

Constraints:
Pattern = ^([0-9]{1,3}\.){3}[0-9]{1,3}(\/([0-9]|[1-2][0-9]|3[0-2]))?$
subnetId Virtual network subnet resource ID the compute nodes belong to string

AKSProperties

Name Description Value
agentCount Number of agents int

Constraints:
Min value = 0
agentVmSize Agent virtual machine size string
aksNetworkingConfiguration AKS networking configuration for vnet AksNetworkingConfiguration
clusterFqdn Cluster full qualified domain name string
clusterPurpose Intended usage of the cluster 'DenseProd'
'DevTest'
'FastProd'
loadBalancerSubnet Load Balancer Subnet string
loadBalancerType Load Balancer Type 'InternalLoadBalancer'
'PublicIp'
sslConfiguration SSL configuration SslConfiguration

AmlCompute

Name Description Value
computeType The type of compute 'AmlCompute' (required)
properties AML Compute properties AmlComputeProperties

AmlComputeProperties

Name Description Value
enableNodePublicIp 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. bool
isolatedNetwork Network is isolated or not bool
osType Compute OS Type 'Linux'
'Windows'
remoteLoginPortPublicAccess 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. 'Disabled'
'Enabled'
'NotSpecified'
scaleSettings Scale settings for AML Compute ScaleSettings
subnet Virtual network subnet resource ID the compute nodes belong to. ResourceId
userAccountCredentials Credentials for an administrator user account that will be created on each compute node. UserAccountCredentials
virtualMachineImage Virtual Machine image for AML Compute - windows only VirtualMachineImage
vmPriority Virtual Machine priority 'Dedicated'
'LowPriority'
vmSize Virtual Machine Size string

AssignedUser

Name Description Value
objectId User’s AAD Object Id. string (required)
tenantId User’s AAD Tenant Id. string (required)

AutoPauseProperties

Name Description Value
delayInMinutes int
enabled bool

AutoScaleProperties

Name Description Value
enabled bool
maxNodeCount int
minNodeCount int

Compute

Name Description Value
computeLocation Location for the underlying compute string
computeType Set to 'AKS' for type AKS. Set to 'AmlCompute' for type AmlCompute. Set to 'ComputeInstance' for type ComputeInstance. Set to 'DataFactory' for type DataFactory. Set to 'DataLakeAnalytics' for type DataLakeAnalytics. Set to 'Databricks' for type Databricks. Set to 'HDInsight' for type HDInsight. Set to 'SynapseSpark' for type SynapseSpark. Set to 'VirtualMachine' for type VirtualMachine. 'AKS'
'AmlCompute'
'ComputeInstance'
'Databricks'
'DataFactory'
'DataLakeAnalytics'
'HDInsight'
'SynapseSpark'
'VirtualMachine' (required)
description The description of the Machine Learning compute. string
disableLocalAuth Opt-out of local authentication and ensure customers can use only MSI and AAD exclusively for authentication. bool
resourceId ARM resource id of the underlying compute string

ComputeInstance

Name Description Value
computeType The type of compute 'ComputeInstance' (required)
properties Compute Instance properties ComputeInstanceProperties

ComputeInstanceProperties

Name Description Value
applicationSharingPolicy 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. 'Personal'
'Shared'
computeInstanceAuthorizationType The Compute Instance Authorization type. Available values are personal (default). 'personal'
personalComputeInstanceSettings Settings for a personal compute instance. PersonalComputeInstanceSettings
setupScripts Details of customized scripts to execute for setting up the cluster. SetupScripts
sshSettings Specifies policy and settings for SSH access. ComputeInstanceSshSettings
subnet Virtual network subnet resource ID the compute nodes belong to. ResourceId
vmSize Virtual Machine Size string

ComputeInstanceSshSettings

Name Description Value
adminPublicKey Specifies the SSH rsa public key file as a string. Use "ssh-keygen -t rsa -b 2048" to generate your SSH key pairs. string
sshPublicAccess 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. 'Disabled'
'Enabled'

Databricks

Name Description Value
computeType The type of compute 'Databricks' (required)
properties DatabricksProperties

DatabricksProperties

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

DataFactory

Name Description Value
computeType The type of compute 'DataFactory' (required)

DataLakeAnalytics

Name Description Value
computeType The type of compute 'DataLakeAnalytics' (required)
properties DataLakeAnalyticsProperties

DataLakeAnalyticsProperties

Name Description Value
dataLakeStoreAccountName DataLake Store Account Name string

HDInsight

Name Description Value
computeType The type of compute 'HDInsight' (required)
properties HDInsightProperties

HDInsightProperties

Name Description Value
address Public IP address of the master node of the cluster. string
administratorAccount Admin credentials for master node of the cluster VirtualMachineSshCredentials
sshPort Port open for ssh connections on the master node of the cluster. int

Identity

Name Description Value
type The identity type. 'None'
'SystemAssigned'
'SystemAssigned,UserAssigned'
'UserAssigned'
userAssignedIdentities The user assigned identities associated with the resource. UserAssignedIdentities

Microsoft.MachineLearningServices/workspaces/computes

Name Description Value
identity The identity of the resource. Identity
location Specifies the location of the resource. string
name The resource name string (required)
parent In Bicep, you can specify the parent resource for a child resource. You only need to add this property when the child resource is declared outside of the parent resource.

For more information, see Child resource outside parent resource.
Symbolic name for resource of type: workspaces
properties Compute properties Compute
sku The sku of the workspace. Sku
tags Resource tags Dictionary of tag names and values. See Tags in templates

PersonalComputeInstanceSettings

Name Description Value
assignedUser A user explicitly assigned to a personal compute instance. AssignedUser

ResourceId

Name Description Value
id The ID of the resource string (required)

ResourceTags

Name Description Value

ScaleSettings

Name Description Value
maxNodeCount Max number of nodes to use int (required)
minNodeCount Min number of nodes to use int
nodeIdleTimeBeforeScaleDown Node Idle Time before scaling down amlCompute. This string needs to be in the RFC Format. string

ScriptReference

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

ScriptsToExecute

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

SetupScripts

Name Description Value
scripts Customized setup scripts ScriptsToExecute

Sku

Name Description Value
name Name of the sku string
tier Tier of the sku like Basic or Enterprise string

SslConfiguration

Name Description Value
cert Cert data string
cname CNAME of the cert string
key Key data string
leafDomainLabel Leaf domain label of public endpoint string
overwriteExistingDomain Indicates whether to overwrite existing domain label. bool
status Enable or disable ssl for scoring 'Auto'
'Disabled'
'Enabled'

SynapseSpark

Name Description Value
computeType The type of compute 'SynapseSpark' (required)
properties AKS properties SynapseSparkPoolPropertiesProperties

SynapseSparkPoolPropertiesProperties

Name Description Value
autoPauseProperties Auto pause properties. AutoPauseProperties
autoScaleProperties Auto scale properties. AutoScaleProperties
nodeCount The number of compute nodes currently assigned to the compute. int
nodeSize Node size. string
nodeSizeFamily Node size family. string
poolName Pool name. string
resourceGroup Name of the resource group in which workspace is located. string
sparkVersion Spark version. string
subscriptionId Azure subscription identifier. string
workspaceName Name of Azure Machine Learning workspace. string

UserAccountCredentials

Name Description Value
adminUserName Name of the administrator user account which can be used to SSH to nodes. string (required)
adminUserPassword Password of the administrator user account. string
adminUserSshPublicKey SSH public key of the administrator user account. string

UserAssignedIdentities

Name Description Value

UserAssignedIdentity

Name Description Value

VirtualMachine

Name Description Value
computeType The type of compute 'VirtualMachine' (required)
properties VirtualMachineProperties

VirtualMachineImage

Name Description Value
id Virtual Machine image path string (required)

VirtualMachineProperties

Name Description Value
address Public IP address of the virtual machine. string
administratorAccount Admin credentials for virtual machine VirtualMachineSshCredentials
isNotebookInstanceCompute Indicates whether this compute will be used for running notebooks. bool
sshPort Port open for ssh connections. int
virtualMachineSize Virtual Machine size string

VirtualMachineSshCredentials

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

Quickstart samples

The following quickstart samples deploy this resource type.

Bicep File Description
Azure Machine Learning end-to-end secure setup This set of Bicep templates demonstrates how to set up Azure Machine Learning end-to-end in a secure set up. This reference implementation includes the Workspace, a compute cluster, compute instance and attached private AKS cluster.
Azure Machine Learning end-to-end secure setup (legacy) This set of Bicep templates demonstrates how to set up Azure Machine Learning end-to-end in a secure set up. This reference implementation includes the Workspace, a compute cluster, compute instance and attached private AKS cluster.
Create an AKS compute target with a Private IP address This template creates an AKS compute target in given Azure Machine Learning service workspace with a private IP address.

ARM template resource definition

The workspaces/computes resource type can be deployed with operations that target:

For a list of changed properties in each API version, see change log.

Resource format

To create a Microsoft.MachineLearningServices/workspaces/computes resource, add the following JSON to your template.

{
  "type": "Microsoft.MachineLearningServices/workspaces/computes",
  "apiVersion": "2021-04-01",
  "name": "string",
  "identity": {
    "type": "string",
    "userAssignedIdentities": {
      "{customized property}": {
      }
    }
  },
  "location": "string",
  "properties": {
    "computeLocation": "string",
    "description": "string",
    "disableLocalAuth": "bool",
    "resourceId": "string",
    "computeType": "string"
    // For remaining properties, see Compute objects
  },
  "sku": {
    "name": "string",
    "tier": "string"
  },
  "tags": {
    "{customized property}": "string"
  }
}

Compute objects

Set the computeType property to specify the type of object.

For AKS, use:

{
  "computeType": "AKS",
  "properties": {
    "agentCount": "int",
    "agentVmSize": "string",
    "aksNetworkingConfiguration": {
      "dnsServiceIP": "string",
      "dockerBridgeCidr": "string",
      "serviceCidr": "string",
      "subnetId": "string"
    },
    "clusterFqdn": "string",
    "clusterPurpose": "string",
    "loadBalancerSubnet": "string",
    "loadBalancerType": "string",
    "sslConfiguration": {
      "cert": "string",
      "cname": "string",
      "key": "string",
      "leafDomainLabel": "string",
      "overwriteExistingDomain": "bool",
      "status": "string"
    }
  }
}

For AmlCompute, use:

{
  "computeType": "AmlCompute",
  "properties": {
    "enableNodePublicIp": "bool",
    "isolatedNetwork": "bool",
    "osType": "string",
    "remoteLoginPortPublicAccess": "string",
    "scaleSettings": {
      "maxNodeCount": "int",
      "minNodeCount": "int",
      "nodeIdleTimeBeforeScaleDown": "string"
    },
    "subnet": {
      "id": "string"
    },
    "userAccountCredentials": {
      "adminUserName": "string",
      "adminUserPassword": "string",
      "adminUserSshPublicKey": "string"
    },
    "virtualMachineImage": {
      "id": "string"
    },
    "vmPriority": "string",
    "vmSize": "string"
  }
}

For ComputeInstance, use:

{
  "computeType": "ComputeInstance",
  "properties": {
    "applicationSharingPolicy": "string",
    "computeInstanceAuthorizationType": "string",
    "personalComputeInstanceSettings": {
      "assignedUser": {
        "objectId": "string",
        "tenantId": "string"
      }
    },
    "setupScripts": {
      "scripts": {
        "creationScript": {
          "scriptArguments": "string",
          "scriptData": "string",
          "scriptSource": "string",
          "timeout": "string"
        },
        "startupScript": {
          "scriptArguments": "string",
          "scriptData": "string",
          "scriptSource": "string",
          "timeout": "string"
        }
      }
    },
    "sshSettings": {
      "adminPublicKey": "string",
      "sshPublicAccess": "string"
    },
    "subnet": {
      "id": "string"
    },
    "vmSize": "string"
  }
}

For DataFactory, use:

{
  "computeType": "DataFactory"
}

For DataLakeAnalytics, use:

{
  "computeType": "DataLakeAnalytics",
  "properties": {
    "dataLakeStoreAccountName": "string"
  }
}

For Databricks, use:

{
  "computeType": "Databricks",
  "properties": {
    "databricksAccessToken": "string",
    "workspaceUrl": "string"
  }
}

For HDInsight, use:

{
  "computeType": "HDInsight",
  "properties": {
    "address": "string",
    "administratorAccount": {
      "password": "string",
      "privateKeyData": "string",
      "publicKeyData": "string",
      "username": "string"
    },
    "sshPort": "int"
  }
}

For SynapseSpark, use:

{
  "computeType": "SynapseSpark",
  "properties": {
    "autoPauseProperties": {
      "delayInMinutes": "int",
      "enabled": "bool"
    },
    "autoScaleProperties": {
      "enabled": "bool",
      "maxNodeCount": "int",
      "minNodeCount": "int"
    },
    "nodeCount": "int",
    "nodeSize": "string",
    "nodeSizeFamily": "string",
    "poolName": "string",
    "resourceGroup": "string",
    "sparkVersion": "string",
    "subscriptionId": "string",
    "workspaceName": "string"
  }
}

For VirtualMachine, use:

{
  "computeType": "VirtualMachine",
  "properties": {
    "address": "string",
    "administratorAccount": {
      "password": "string",
      "privateKeyData": "string",
      "publicKeyData": "string",
      "username": "string"
    },
    "isNotebookInstanceCompute": "bool",
    "sshPort": "int",
    "virtualMachineSize": "string"
  }
}

Property values

AKS

Name Description Value
computeType The type of compute 'AKS' (required)
properties AKS properties AKSProperties

AksNetworkingConfiguration

Name Description Value
dnsServiceIP An IP address assigned to the Kubernetes DNS service. It must be within the Kubernetes service address range specified in serviceCidr. string

Constraints:
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]?)$
dockerBridgeCidr 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. string

Constraints:
Pattern = ^([0-9]{1,3}\.){3}[0-9]{1,3}(\/([0-9]|[1-2][0-9]|3[0-2]))?$
serviceCidr A CIDR notation IP range from which to assign service cluster IPs. It must not overlap with any Subnet IP ranges. string

Constraints:
Pattern = ^([0-9]{1,3}\.){3}[0-9]{1,3}(\/([0-9]|[1-2][0-9]|3[0-2]))?$
subnetId Virtual network subnet resource ID the compute nodes belong to string

AKSProperties

Name Description Value
agentCount Number of agents int

Constraints:
Min value = 0
agentVmSize Agent virtual machine size string
aksNetworkingConfiguration AKS networking configuration for vnet AksNetworkingConfiguration
clusterFqdn Cluster full qualified domain name string
clusterPurpose Intended usage of the cluster 'DenseProd'
'DevTest'
'FastProd'
loadBalancerSubnet Load Balancer Subnet string
loadBalancerType Load Balancer Type 'InternalLoadBalancer'
'PublicIp'
sslConfiguration SSL configuration SslConfiguration

AmlCompute

Name Description Value
computeType The type of compute 'AmlCompute' (required)
properties AML Compute properties AmlComputeProperties

AmlComputeProperties

Name Description Value
enableNodePublicIp 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. bool
isolatedNetwork Network is isolated or not bool
osType Compute OS Type 'Linux'
'Windows'
remoteLoginPortPublicAccess 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. 'Disabled'
'Enabled'
'NotSpecified'
scaleSettings Scale settings for AML Compute ScaleSettings
subnet Virtual network subnet resource ID the compute nodes belong to. ResourceId
userAccountCredentials Credentials for an administrator user account that will be created on each compute node. UserAccountCredentials
virtualMachineImage Virtual Machine image for AML Compute - windows only VirtualMachineImage
vmPriority Virtual Machine priority 'Dedicated'
'LowPriority'
vmSize Virtual Machine Size string

AssignedUser

Name Description Value
objectId User’s AAD Object Id. string (required)
tenantId User’s AAD Tenant Id. string (required)

AutoPauseProperties

Name Description Value
delayInMinutes int
enabled bool

AutoScaleProperties

Name Description Value
enabled bool
maxNodeCount int
minNodeCount int

Compute

Name Description Value
computeLocation Location for the underlying compute string
computeType Set to 'AKS' for type AKS. Set to 'AmlCompute' for type AmlCompute. Set to 'ComputeInstance' for type ComputeInstance. Set to 'DataFactory' for type DataFactory. Set to 'DataLakeAnalytics' for type DataLakeAnalytics. Set to 'Databricks' for type Databricks. Set to 'HDInsight' for type HDInsight. Set to 'SynapseSpark' for type SynapseSpark. Set to 'VirtualMachine' for type VirtualMachine. 'AKS'
'AmlCompute'
'ComputeInstance'
'Databricks'
'DataFactory'
'DataLakeAnalytics'
'HDInsight'
'SynapseSpark'
'VirtualMachine' (required)
description The description of the Machine Learning compute. string
disableLocalAuth Opt-out of local authentication and ensure customers can use only MSI and AAD exclusively for authentication. bool
resourceId ARM resource id of the underlying compute string

ComputeInstance

Name Description Value
computeType The type of compute 'ComputeInstance' (required)
properties Compute Instance properties ComputeInstanceProperties

ComputeInstanceProperties

Name Description Value
applicationSharingPolicy 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. 'Personal'
'Shared'
computeInstanceAuthorizationType The Compute Instance Authorization type. Available values are personal (default). 'personal'
personalComputeInstanceSettings Settings for a personal compute instance. PersonalComputeInstanceSettings
setupScripts Details of customized scripts to execute for setting up the cluster. SetupScripts
sshSettings Specifies policy and settings for SSH access. ComputeInstanceSshSettings
subnet Virtual network subnet resource ID the compute nodes belong to. ResourceId
vmSize Virtual Machine Size string

ComputeInstanceSshSettings

Name Description Value
adminPublicKey Specifies the SSH rsa public key file as a string. Use "ssh-keygen -t rsa -b 2048" to generate your SSH key pairs. string
sshPublicAccess 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. 'Disabled'
'Enabled'

Databricks

Name Description Value
computeType The type of compute 'Databricks' (required)
properties DatabricksProperties

DatabricksProperties

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

DataFactory

Name Description Value
computeType The type of compute 'DataFactory' (required)

DataLakeAnalytics

Name Description Value
computeType The type of compute 'DataLakeAnalytics' (required)
properties DataLakeAnalyticsProperties

DataLakeAnalyticsProperties

Name Description Value
dataLakeStoreAccountName DataLake Store Account Name string

HDInsight

Name Description Value
computeType The type of compute 'HDInsight' (required)
properties HDInsightProperties

HDInsightProperties

Name Description Value
address Public IP address of the master node of the cluster. string
administratorAccount Admin credentials for master node of the cluster VirtualMachineSshCredentials
sshPort Port open for ssh connections on the master node of the cluster. int

Identity

Name Description Value
type The identity type. 'None'
'SystemAssigned'
'SystemAssigned,UserAssigned'
'UserAssigned'
userAssignedIdentities The user assigned identities associated with the resource. UserAssignedIdentities

Microsoft.MachineLearningServices/workspaces/computes

Name Description Value
apiVersion The api version '2021-04-01'
identity The identity of the resource. Identity
location Specifies the location of the resource. string
name The resource name string (required)
properties Compute properties Compute
sku The sku of the workspace. Sku
tags Resource tags Dictionary of tag names and values. See Tags in templates
type The resource type 'Microsoft.MachineLearningServices/workspaces/computes'

PersonalComputeInstanceSettings

Name Description Value
assignedUser A user explicitly assigned to a personal compute instance. AssignedUser

ResourceId

Name Description Value
id The ID of the resource string (required)

ResourceTags

Name Description Value

ScaleSettings

Name Description Value
maxNodeCount Max number of nodes to use int (required)
minNodeCount Min number of nodes to use int
nodeIdleTimeBeforeScaleDown Node Idle Time before scaling down amlCompute. This string needs to be in the RFC Format. string

ScriptReference

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

ScriptsToExecute

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

SetupScripts

Name Description Value
scripts Customized setup scripts ScriptsToExecute

Sku

Name Description Value
name Name of the sku string
tier Tier of the sku like Basic or Enterprise string

SslConfiguration

Name Description Value
cert Cert data string
cname CNAME of the cert string
key Key data string
leafDomainLabel Leaf domain label of public endpoint string
overwriteExistingDomain Indicates whether to overwrite existing domain label. bool
status Enable or disable ssl for scoring 'Auto'
'Disabled'
'Enabled'

SynapseSpark

Name Description Value
computeType The type of compute 'SynapseSpark' (required)
properties AKS properties SynapseSparkPoolPropertiesProperties

SynapseSparkPoolPropertiesProperties

Name Description Value
autoPauseProperties Auto pause properties. AutoPauseProperties
autoScaleProperties Auto scale properties. AutoScaleProperties
nodeCount The number of compute nodes currently assigned to the compute. int
nodeSize Node size. string
nodeSizeFamily Node size family. string
poolName Pool name. string
resourceGroup Name of the resource group in which workspace is located. string
sparkVersion Spark version. string
subscriptionId Azure subscription identifier. string
workspaceName Name of Azure Machine Learning workspace. string

UserAccountCredentials

Name Description Value
adminUserName Name of the administrator user account which can be used to SSH to nodes. string (required)
adminUserPassword Password of the administrator user account. string
adminUserSshPublicKey SSH public key of the administrator user account. string

UserAssignedIdentities

Name Description Value

UserAssignedIdentity

Name Description Value

VirtualMachine

Name Description Value
computeType The type of compute 'VirtualMachine' (required)
properties VirtualMachineProperties

VirtualMachineImage

Name Description Value
id Virtual Machine image path string (required)

VirtualMachineProperties

Name Description Value
address Public IP address of the virtual machine. string
administratorAccount Admin credentials for virtual machine VirtualMachineSshCredentials
isNotebookInstanceCompute Indicates whether this compute will be used for running notebooks. bool
sshPort Port open for ssh connections. int
virtualMachineSize Virtual Machine size string

VirtualMachineSshCredentials

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

Quickstart templates

The following quickstart templates deploy this resource type.

Template Description
Azure Machine Learning end-to-end secure setup

Deploy to Azure
This set of Bicep templates demonstrates how to set up Azure Machine Learning end-to-end in a secure set up. This reference implementation includes the Workspace, a compute cluster, compute instance and attached private AKS cluster.
Azure Machine Learning end-to-end secure setup (legacy)

Deploy to Azure
This set of Bicep templates demonstrates how to set up Azure Machine Learning end-to-end in a secure set up. This reference implementation includes the Workspace, a compute cluster, compute instance and attached private AKS cluster.
Create a LinkedService in Azure Machine Learning workspace

Deploy to Azure
This template creates a LinkedService in an existing Azure Machine Learning workspace.
Create a Machine Learning Service ADLA Compute

Deploy to Azure
This template creates a Machine Learning Service ADLA Compute.
Create a Machine Learning Service Aks Compute

Deploy to Azure
This template creates a Machine Learning Service Aks Compute.
Create a Machine Learning Service DSVM Compute

Deploy to Azure
This template creates a Machine Learning Service DSVM Compute.
Create a Machine Learning Service HDInsight cluster

Deploy to Azure
This template creates a Machine Learning Service HDInsight cluster
Create an AKS compute target with a Private IP address

Deploy to Azure
This template creates an AKS compute target in given Azure Machine Learning service workspace with a private IP address.
Create an Azure Machine Learning aks compute

Deploy to Azure
This template creates an Azure Machine Learning aks compute.
Create an Azure Machine Learning compute cluster

Deploy to Azure
This template creates an Azure Machine Learning compute cluster.
Create an Azure Machine Learning compute instance

Deploy to Azure
This template creates an Azure Machine Learning compute instance on behalf of another user with a sample inline setup script

Terraform (AzAPI provider) resource definition

The workspaces/computes resource type can be deployed with operations that target:

  • Resource groups

For a list of changed properties in each API version, see change log.

Resource format

To create a Microsoft.MachineLearningServices/workspaces/computes resource, add the following Terraform to your template.

resource "azapi_resource" "symbolicname" {
  type = "Microsoft.MachineLearningServices/workspaces/computes@2021-04-01"
  name = "string"
  identity = {
    type = "string"
    userAssignedIdentities = {
      {customized property} = {
      }
    }
  }
  location = "string"
  body = jsonencode({
    properties = {
      computeLocation = "string"
      description = "string"
      disableLocalAuth = bool
      resourceId = "string"
      computeType = "string"
      // For remaining properties, see Compute objects
    }
  })
  sku = {
    name = "string"
    tier = "string"
  }
  tags = {
    {customized property} = "string"
  }
}

Compute objects

Set the computeType property to specify the type of object.

For AKS, use:

{
  computeType = "AKS"
  properties = {
    agentCount = int
    agentVmSize = "string"
    aksNetworkingConfiguration = {
      dnsServiceIP = "string"
      dockerBridgeCidr = "string"
      serviceCidr = "string"
      subnetId = "string"
    }
    clusterFqdn = "string"
    clusterPurpose = "string"
    loadBalancerSubnet = "string"
    loadBalancerType = "string"
    sslConfiguration = {
      cert = "string"
      cname = "string"
      key = "string"
      leafDomainLabel = "string"
      overwriteExistingDomain = bool
      status = "string"
    }
  }
}

For AmlCompute, use:

{
  computeType = "AmlCompute"
  properties = {
    enableNodePublicIp = bool
    isolatedNetwork = bool
    osType = "string"
    remoteLoginPortPublicAccess = "string"
    scaleSettings = {
      maxNodeCount = int
      minNodeCount = int
      nodeIdleTimeBeforeScaleDown = "string"
    }
    subnet = {
      id = "string"
    }
    userAccountCredentials = {
      adminUserName = "string"
      adminUserPassword = "string"
      adminUserSshPublicKey = "string"
    }
    virtualMachineImage = {
      id = "string"
    }
    vmPriority = "string"
    vmSize = "string"
  }
}

For ComputeInstance, use:

{
  computeType = "ComputeInstance"
  properties = {
    applicationSharingPolicy = "string"
    computeInstanceAuthorizationType = "string"
    personalComputeInstanceSettings = {
      assignedUser = {
        objectId = "string"
        tenantId = "string"
      }
    }
    setupScripts = {
      scripts = {
        creationScript = {
          scriptArguments = "string"
          scriptData = "string"
          scriptSource = "string"
          timeout = "string"
        }
        startupScript = {
          scriptArguments = "string"
          scriptData = "string"
          scriptSource = "string"
          timeout = "string"
        }
      }
    }
    sshSettings = {
      adminPublicKey = "string"
      sshPublicAccess = "string"
    }
    subnet = {
      id = "string"
    }
    vmSize = "string"
  }
}

For DataFactory, use:

{
  computeType = "DataFactory"
}

For DataLakeAnalytics, use:

{
  computeType = "DataLakeAnalytics"
  properties = {
    dataLakeStoreAccountName = "string"
  }
}

For Databricks, use:

{
  computeType = "Databricks"
  properties = {
    databricksAccessToken = "string"
    workspaceUrl = "string"
  }
}

For HDInsight, use:

{
  computeType = "HDInsight"
  properties = {
    address = "string"
    administratorAccount = {
      password = "string"
      privateKeyData = "string"
      publicKeyData = "string"
      username = "string"
    }
    sshPort = int
  }
}

For SynapseSpark, use:

{
  computeType = "SynapseSpark"
  properties = {
    autoPauseProperties = {
      delayInMinutes = int
      enabled = bool
    }
    autoScaleProperties = {
      enabled = bool
      maxNodeCount = int
      minNodeCount = int
    }
    nodeCount = int
    nodeSize = "string"
    nodeSizeFamily = "string"
    poolName = "string"
    resourceGroup = "string"
    sparkVersion = "string"
    subscriptionId = "string"
    workspaceName = "string"
  }
}

For VirtualMachine, use:

{
  computeType = "VirtualMachine"
  properties = {
    address = "string"
    administratorAccount = {
      password = "string"
      privateKeyData = "string"
      publicKeyData = "string"
      username = "string"
    }
    isNotebookInstanceCompute = bool
    sshPort = int
    virtualMachineSize = "string"
  }
}

Property values

AKS

Name Description Value
computeType The type of compute 'AKS' (required)
properties AKS properties AKSProperties

AksNetworkingConfiguration

Name Description Value
dnsServiceIP An IP address assigned to the Kubernetes DNS service. It must be within the Kubernetes service address range specified in serviceCidr. string

Constraints:
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]?)$
dockerBridgeCidr 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. string

Constraints:
Pattern = ^([0-9]{1,3}\.){3}[0-9]{1,3}(\/([0-9]|[1-2][0-9]|3[0-2]))?$
serviceCidr A CIDR notation IP range from which to assign service cluster IPs. It must not overlap with any Subnet IP ranges. string

Constraints:
Pattern = ^([0-9]{1,3}\.){3}[0-9]{1,3}(\/([0-9]|[1-2][0-9]|3[0-2]))?$
subnetId Virtual network subnet resource ID the compute nodes belong to string

AKSProperties

Name Description Value
agentCount Number of agents int

Constraints:
Min value = 0
agentVmSize Agent virtual machine size string
aksNetworkingConfiguration AKS networking configuration for vnet AksNetworkingConfiguration
clusterFqdn Cluster full qualified domain name string
clusterPurpose Intended usage of the cluster 'DenseProd'
'DevTest'
'FastProd'
loadBalancerSubnet Load Balancer Subnet string
loadBalancerType Load Balancer Type 'InternalLoadBalancer'
'PublicIp'
sslConfiguration SSL configuration SslConfiguration

AmlCompute

Name Description Value
computeType The type of compute 'AmlCompute' (required)
properties AML Compute properties AmlComputeProperties

AmlComputeProperties

Name Description Value
enableNodePublicIp 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. bool
isolatedNetwork Network is isolated or not bool
osType Compute OS Type 'Linux'
'Windows'
remoteLoginPortPublicAccess 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. 'Disabled'
'Enabled'
'NotSpecified'
scaleSettings Scale settings for AML Compute ScaleSettings
subnet Virtual network subnet resource ID the compute nodes belong to. ResourceId
userAccountCredentials Credentials for an administrator user account that will be created on each compute node. UserAccountCredentials
virtualMachineImage Virtual Machine image for AML Compute - windows only VirtualMachineImage
vmPriority Virtual Machine priority 'Dedicated'
'LowPriority'
vmSize Virtual Machine Size string

AssignedUser

Name Description Value
objectId User’s AAD Object Id. string (required)
tenantId User’s AAD Tenant Id. string (required)

AutoPauseProperties

Name Description Value
delayInMinutes int
enabled bool

AutoScaleProperties

Name Description Value
enabled bool
maxNodeCount int
minNodeCount int

Compute

Name Description Value
computeLocation Location for the underlying compute string
computeType Set to 'AKS' for type AKS. Set to 'AmlCompute' for type AmlCompute. Set to 'ComputeInstance' for type ComputeInstance. Set to 'DataFactory' for type DataFactory. Set to 'DataLakeAnalytics' for type DataLakeAnalytics. Set to 'Databricks' for type Databricks. Set to 'HDInsight' for type HDInsight. Set to 'SynapseSpark' for type SynapseSpark. Set to 'VirtualMachine' for type VirtualMachine. 'AKS'
'AmlCompute'
'ComputeInstance'
'Databricks'
'DataFactory'
'DataLakeAnalytics'
'HDInsight'
'SynapseSpark'
'VirtualMachine' (required)
description The description of the Machine Learning compute. string
disableLocalAuth Opt-out of local authentication and ensure customers can use only MSI and AAD exclusively for authentication. bool
resourceId ARM resource id of the underlying compute string

ComputeInstance

Name Description Value
computeType The type of compute 'ComputeInstance' (required)
properties Compute Instance properties ComputeInstanceProperties

ComputeInstanceProperties

Name Description Value
applicationSharingPolicy 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. 'Personal'
'Shared'
computeInstanceAuthorizationType The Compute Instance Authorization type. Available values are personal (default). 'personal'
personalComputeInstanceSettings Settings for a personal compute instance. PersonalComputeInstanceSettings
setupScripts Details of customized scripts to execute for setting up the cluster. SetupScripts
sshSettings Specifies policy and settings for SSH access. ComputeInstanceSshSettings
subnet Virtual network subnet resource ID the compute nodes belong to. ResourceId
vmSize Virtual Machine Size string

ComputeInstanceSshSettings

Name Description Value
adminPublicKey Specifies the SSH rsa public key file as a string. Use "ssh-keygen -t rsa -b 2048" to generate your SSH key pairs. string
sshPublicAccess 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. 'Disabled'
'Enabled'

Databricks

Name Description Value
computeType The type of compute 'Databricks' (required)
properties DatabricksProperties

DatabricksProperties

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

DataFactory

Name Description Value
computeType The type of compute 'DataFactory' (required)

DataLakeAnalytics

Name Description Value
computeType The type of compute 'DataLakeAnalytics' (required)
properties DataLakeAnalyticsProperties

DataLakeAnalyticsProperties

Name Description Value
dataLakeStoreAccountName DataLake Store Account Name string

HDInsight

Name Description Value
computeType The type of compute 'HDInsight' (required)
properties HDInsightProperties

HDInsightProperties

Name Description Value
address Public IP address of the master node of the cluster. string
administratorAccount Admin credentials for master node of the cluster VirtualMachineSshCredentials
sshPort Port open for ssh connections on the master node of the cluster. int

Identity

Name Description Value
type The identity type. 'None'
'SystemAssigned'
'SystemAssigned,UserAssigned'
'UserAssigned'
userAssignedIdentities The user assigned identities associated with the resource. UserAssignedIdentities

Microsoft.MachineLearningServices/workspaces/computes

Name Description Value
identity The identity of the resource. Identity
location Specifies the location of the resource. string
name The resource name string (required)
parent_id The ID of the resource that is the parent for this resource. ID for resource of type: workspaces
properties Compute properties Compute
sku The sku of the workspace. Sku
tags Resource tags Dictionary of tag names and values.
type The resource type "Microsoft.MachineLearningServices/workspaces/computes@2021-04-01"

PersonalComputeInstanceSettings

Name Description Value
assignedUser A user explicitly assigned to a personal compute instance. AssignedUser

ResourceId

Name Description Value
id The ID of the resource string (required)

ResourceTags

Name Description Value

ScaleSettings

Name Description Value
maxNodeCount Max number of nodes to use int (required)
minNodeCount Min number of nodes to use int
nodeIdleTimeBeforeScaleDown Node Idle Time before scaling down amlCompute. This string needs to be in the RFC Format. string

ScriptReference

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

ScriptsToExecute

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

SetupScripts

Name Description Value
scripts Customized setup scripts ScriptsToExecute

Sku

Name Description Value
name Name of the sku string
tier Tier of the sku like Basic or Enterprise string

SslConfiguration

Name Description Value
cert Cert data string
cname CNAME of the cert string
key Key data string
leafDomainLabel Leaf domain label of public endpoint string
overwriteExistingDomain Indicates whether to overwrite existing domain label. bool
status Enable or disable ssl for scoring 'Auto'
'Disabled'
'Enabled'

SynapseSpark

Name Description Value
computeType The type of compute 'SynapseSpark' (required)
properties AKS properties SynapseSparkPoolPropertiesProperties

SynapseSparkPoolPropertiesProperties

Name Description Value
autoPauseProperties Auto pause properties. AutoPauseProperties
autoScaleProperties Auto scale properties. AutoScaleProperties
nodeCount The number of compute nodes currently assigned to the compute. int
nodeSize Node size. string
nodeSizeFamily Node size family. string
poolName Pool name. string
resourceGroup Name of the resource group in which workspace is located. string
sparkVersion Spark version. string
subscriptionId Azure subscription identifier. string
workspaceName Name of Azure Machine Learning workspace. string

UserAccountCredentials

Name Description Value
adminUserName Name of the administrator user account which can be used to SSH to nodes. string (required)
adminUserPassword Password of the administrator user account. string
adminUserSshPublicKey SSH public key of the administrator user account. string

UserAssignedIdentities

Name Description Value

UserAssignedIdentity

Name Description Value

VirtualMachine

Name Description Value
computeType The type of compute 'VirtualMachine' (required)
properties VirtualMachineProperties

VirtualMachineImage

Name Description Value
id Virtual Machine image path string (required)

VirtualMachineProperties

Name Description Value
address Public IP address of the virtual machine. string
administratorAccount Admin credentials for virtual machine VirtualMachineSshCredentials
isNotebookInstanceCompute Indicates whether this compute will be used for running notebooks. bool
sshPort Port open for ssh connections. int
virtualMachineSize Virtual Machine size string

VirtualMachineSshCredentials

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