Microsoft.MachineLearningServices workspaces/computes 2019-05-01

10/07/2020
7 minutes to read

Template format

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

JSON
Bicep

{
  "name": "string",
  "type": "Microsoft.MachineLearningServices/workspaces/computes",
  "apiVersion": "2019-05-01",
  "identity": {
    "type": "SystemAssigned"
  },
  "location": "string",
  "tags": {},
  "properties": see-variations-below
}

Bicep is currently in preview. For more information, see Project Bicep.

resource symbolicname 'Microsoft.MachineLearningServices/workspaces/computes@2019-05-01' = {
  name: 'string'
  identity: {
    type: 'SystemAssigned'
  }
  location: 'string'
  tags: {}
  properties: see-variations-below
}

For AKS, use:

JSON
Bicep

{
  "computeType": "AKS",
  "computeLocation": "string",
  "description": "string",
  "resourceId": "string",
  "properties": {
    "agentCount": "integer",
    "agentVMSize": "string",
    "aksNetworkingConfiguration": {
      "dnsServiceIP": "string",
      "dockerBridgeCidr": "string",
      "serviceCidr": "string",
      "subnetId": "string"
    },
    "clusterFqdn": "string",
    "sslConfiguration": {
      "cert": "string",
      "cname": "string",
      "key": "string",
      "status": "string"
    }
  }
}

{
  computeType: 'AKS'
  computeLocation: 'string'
  description: 'string'
  resourceId: 'string'
  properties: {
    agentCount: int
    agentVMSize: 'string'
    aksNetworkingConfiguration: {
      dnsServiceIP: 'string'
      dockerBridgeCidr: 'string'
      serviceCidr: 'string'
      subnetId: 'string'
    }
    clusterFqdn: 'string'
    sslConfiguration: {
      cert: 'string'
      cname: 'string'
      key: 'string'
      status: 'string'
    }
  }
}

For AmlCompute, use:

JSON
Bicep

{
  "computeType": "AmlCompute",
  "computeLocation": "string",
  "description": "string",
  "resourceId": "string",
  "properties": {
    "remoteLoginPortPublicAccess": "string",
    "scaleSettings": {
      "maxNodeCount": "integer",
      "minNodeCount": "integer",
      "nodeIdleTimeBeforeScaleDown": "string"
    },
    "subnet": {
      "id": "string"
    },
    "userAccountCredentials": {
      "adminUserName": "string",
      "adminUserPassword": "string",
      "adminUserSshPublicKey": "string"
    },
    "vmPriority": "string",
    "vmSize": "string"
  }
}

{
  computeType: 'AmlCompute'
  computeLocation: 'string'
  description: 'string'
  resourceId: 'string'
  properties: {
    remoteLoginPortPublicAccess: 'string'
    scaleSettings: {
      maxNodeCount: int
      minNodeCount: int
      nodeIdleTimeBeforeScaleDown: 'string'
    }
    subnet: {
      id: 'string'
    }
    userAccountCredentials: {
      adminUserName: 'string'
      adminUserPassword: 'string'
      adminUserSshPublicKey: 'string'
    }
    vmPriority: 'string'
    vmSize: 'string'
  }
}

For Databricks, use:

JSON
Bicep

{
  "computeType": "Databricks",
  "computeLocation": "string",
  "description": "string",
  "resourceId": "string",
  "properties": {
    "databricksAccessToken": "string"
  }
}

{
  computeType: 'Databricks'
  computeLocation: 'string'
  description: 'string'
  resourceId: 'string'
  properties: {
    databricksAccessToken: 'string'
  }
}

For DataFactory, use:

JSON
Bicep

{
  "computeType": "DataFactory",
  "computeLocation": "string",
  "description": "string",
  "resourceId": "string",
  "properties": {
  }
}

{
  computeType: 'DataFactory'
  computeLocation: 'string'
  description: 'string'
  resourceId: 'string'
  properties: {
  }
}

For DataLakeAnalytics, use:

JSON
Bicep

{
  "computeType": "DataLakeAnalytics",
  "computeLocation": "string",
  "description": "string",
  "resourceId": "string",
  "properties": {
    "dataLakeStoreAccountName": "string"
  }
}

{
  computeType: 'DataLakeAnalytics'
  computeLocation: 'string'
  description: 'string'
  resourceId: 'string'
  properties: {
    dataLakeStoreAccountName: 'string'
  }
}

For HDInsight, use:

JSON
Bicep

{
  "computeType": "HDInsight",
  "computeLocation": "string",
  "description": "string",
  "resourceId": "string",
  "properties": {
    "sshPort": "integer",
    "address": "string",
    "administratorAccount": {
      "username": "string",
      "password": "string",
      "publicKeyData": "string",
      "privateKeyData": "string"
    }
  }
}

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

For VirtualMachine, use:

JSON
Bicep

{
  "computeType": "VirtualMachine",
  "computeLocation": "string",
  "description": "string",
  "resourceId": "string",
  "properties": {
    "virtualMachineSize": "string",
    "sshPort": "integer",
    "address": "string",
    "administratorAccount": {
      "username": "string",
      "password": "string",
      "publicKeyData": "string",
      "privateKeyData": "string"
    }
  }
}

{
  computeType: 'VirtualMachine'
  computeLocation: 'string'
  description: 'string'
  resourceId: 'string'
  properties: {
    virtualMachineSize: 'string'
    sshPort: int
    address: 'string'
    administratorAccount: {
      username: 'string'
      password: 'string'
      publicKeyData: 'string'
      privateKeyData: 'string'
    }
  }
}

Property values

The following tables describe the values you need to set in the schema.

Microsoft.MachineLearningServices/workspaces/computes object

Note

In Bicep, type and apiVersion are specified in the first line of the resource declaration. Use the format <type>@<apiVersion>. Don't set those properties in the resource body.

Name	Type	Required	Value
name	string	Yes	Name of the Azure Machine Learning compute.
type	enum	Yes	For JSON -computes -or- Microsoft.MachineLearningServices/workspaces/computes See Set name and type for child resources.
apiVersion	enum	Yes	For JSON - 2019-05-01
identity	object	No	The identity of the resource. - Identity object
location	string	No	Specifies the location of the resource.
tags	object	No	Contains resource tags defined as key/value pairs.
properties	object	Yes	Compute properties - Compute object

Identity object

Name	Type	Required	Value
type	enum	No	The identity type. - SystemAssigned

Compute object

Name	Type	Required	Value
computeLocation	string	No	Location for the underlying compute
description	string	No	The description of the Machine Learning compute.
resourceId	string	No	ARM resource id of the underlying compute
computeType	string	Yes	AKS, AmlCompute, Databricks, DataFactory, DataLakeAnalytics, HDInsight, VirtualMachine
properties	object	Yes	AKS object, AmlCompute object, Databricks object, DataLakeAnalytics object, HDInsight object, VirtualMachine object

AKS object

Name	Type	Required	Value
agentCount	integer	No	Number of agents
agentVMSize	string	No	Agent virtual machine size
aksNetworkingConfiguration	object	No	AKS networking configuration for vnet - AKSNetworking object
clusterFqdn	string	No	Cluster full qualified domain name
sslConfiguration	object	No	SSL configuration - SSLConfiguration object

AKSNetworking object

Name	Type	Required	Value
dnsServiceIP	string	No	An IP address assigned to the Kubernetes DNS service. It must be within the Kubernetes service address range specified in serviceCidr.
dockerBridgeCidr	string	No	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	No	A CIDR notation IP range from which to assign service cluster IPs. It must not overlap with any Subnet IP ranges.
subnetId	string	No	Virtual network subnet resource ID the compute nodes belong to

SSLConfiguration object

Name	Type	Required	Value
cert	string	No	Cert data
cname	string	No	CNAME of the cert
key	string	No	Key data
status	string	No	Enable or disable ssl for scoring - Disabled, Enabled

AmlCompute object

Name	Type	Required	Value
remoteLoginPortPublicAccess	string	No	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. - Enabled, Disabled, NotSpecified
scaleSettings	object	No	Scale settings for AML Compute - ScaleSettings object
subnet	object	No	Virtual network subnet resource ID the compute nodes belong to. - ResourceID object
userAccountCredentials	object	No	Credentials for an administrator user account that will be created on each compute node. - UserAccountCredentials object
vmPriority	string	No	Virtual Machine priority - Dedicated, LowPriority
vmSize	string	No	Virtual Machine Size

ScaleSetting object

Name	Type	Required	Value
maxNodeCount	integer	Yes	Max number of nodes to use
minNodeCount	integer	No	Min number of nodes to use
nodeIdleTimeBeforeScaleDown	string	No	Node Idle Time before scaling down amlCompute

ResourceID object

Name	Type	Required	Value
id	string	Yes	The ID of the resource

UserAccountCredentials object

Name	Type	Required	Value
adminUserName	string	Yes	Name of the administrator user account which can be used to SSH to nodes.
adminUserPassword	string	No	Password of the administrator user account.
adminUserSshPublicKey	string	No	SSH public key of the administrator user account.

Databricks object

Name	Type	Required	Value
databricksAccessToken	string	No	Databricks access token

DataLakeAnalytics object

Name	Type	Required	Value
dataLakeStoreAccountName	string	No	DataLake Store Account Name

HDInsight object

Name	Type	Required	Value
sshPort	integer	No	Port open for ssh connections on the master node of the cluster.
address	string	No	Public IP address of the master node of the cluster.
administratorAccount	object	No	Admin credentials for master node of the cluster - VirtualMachineSshCredentials object

VirtualMachineSshCredentials object

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

VirtualMachine object

Name	Type	Required	Value
virtualMachineSize	string	No	Virtual Machine size
sshPort	integer	No	Port open for ssh connections.
address	string	No	Public IP address of the virtual machine.
administratorAccount	object	No	Admin credentials for virtual machine - VirtualMachineSshCredentials object

Quickstart templates

The following quickstart templates deploy this resource type.

Template	Description
Create a Machine Learning Service ADLA Compute.	This template creates a Machine Learning Service ADLA Compute.
Create a Machine Learning Service Aks Compute.	This template creates a Machine Learning Service Aks Compute.
Create a Machine Learning Service DSVM Compute.	This template creates a Machine Learning Service DSVM Compute.
Create a Machine Learning Service HDInsight cluster	This template creates a Machine Learning Service HDInsight cluster
Create an Azure Machine Learning aks compute.	This template creates an Azure Machine Learning aks compute.
Create an Azure Machine Learning compute cluster.	This template creates an Azure Machine Learning compute cluster.
Create an Azure Machine Learning compute instance	This template creates an Azure Machine Learning compute instance on behalf of another user
Create a LinkedService in Azure Machine Learning workspace.	This template creates a LinkedService in an existing Azure Machine Learning workspace.
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.