Microsoft.MachineLearningServices workspaces/computes 2018-03-01-preview

• Latest
• 2024-10-01
• 2024-10-01-preview
• 2024-07-01-preview
• 2024-04-01
• 2024-04-01-preview
• 2024-01-01-preview
• 2023-10-01
• 2023-08-01-preview
• 2023-06-01-preview
• 2023-04-01
• 2023-04-01-preview
• 2023-02-01-preview
• 2022-12-01-preview
• 2022-10-01
• 2022-10-01-preview
• 2022-06-01-preview
• 2022-05-01
• 2022-02-01-preview
• 2022-01-01-preview
• 2021-07-01
• 2021-04-01
• 2021-03-01-preview
• 2021-01-01
• 2020-09-01-preview
• 2020-08-01
• 2020-06-01
• 2020-05-15-preview
• 2020-05-01-preview
• 2020-04-01
• 2020-03-01
• 2020-02-18-preview
• 2020-01-01
• 2019-11-01
• 2019-06-01
• 2019-05-01
• 2018-11-19
• 2018-03-01-preview

Bicep resource definition

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

• Resource groups - See resource group deployment commands

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@2018-03-01-preview' = {
  identity: {
    type: 'SystemAssigned'
  }
  location: 'string'
  name: 'string'
  properties: {
    computeLocation: 'string'
    description: 'string'
    resourceId: 'string'
    computeType: 'string'
    // For remaining properties, see Compute objects
  }
  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'
    clusterFqdn: 'string'
    sslConfiguration: {
      cert: 'string'
      cname: 'string'
      key: 'string'
      status: 'string'
    }
    systemServices: [
      {}
    ]
  }
}

For BatchAI, use:

{
  computeType: 'BatchAI'
  properties: {
    scaleSettings: {
      autoScaleEnabled: bool
      maxNodeCount: int
      minNodeCount: int
    }
    vmPriority: 'string'
    vmSize: 'string'
  }
}

For DataFactory, use:

{
  computeType: 'DataFactory'
}

For HDInsight, use:

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

For VirtualMachine, use:

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

Property values

AKS

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

AKSProperties

Name	Description	Value
agentCount	Number of agents	int Constraints: Min value = 1
agentVMSize	Agent virtual machine size	string
clusterFqdn	Cluster full qualified domain name	string
sslConfiguration	SSL configuration	SslConfiguration
systemServices	System services	SystemService[]

BatchAI

Name	Description	Value
computeType	The type of compute	'BatchAI' (required)
properties	BatchAI properties	BatchAIProperties

BatchAIProperties

Name	Description	Value
scaleSettings	Scale settings for BatchAI	ScaleSettings
vmPriority	Virtual Machine priority	string
vmSize	Virtual Machine Size	string

Compute

Name	Description	Value
computeLocation	Location for the underlying compute	string
computeType	Set to 'AKS' for type AKS. Set to 'BatchAI' for type BatchAI. Set to 'DataFactory' for type DataFactory. Set to 'HDInsight' for type HDInsight. Set to 'VirtualMachine' for type VirtualMachine.	'AKS' 'BatchAI' 'DataFactory' 'HDInsight' 'VirtualMachine' (required)
description	The description of the Machine Learning compute.	string
resourceId	ARM resource id of the compute	string

DataFactory

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

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.	'SystemAssigned'

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
tags	Resource tags	Dictionary of tag names and values. See Tags in templates

ResourceTags

Name	Description	Value

ScaleSettings

Name	Description	Value
autoScaleEnabled	Enable or disable auto scale	bool
maxNodeCount	Max number of nodes to use	int
minNodeCount	Min number of nodes to use	int

SslConfiguration

Name	Description	Value
cert	Cert data	string
cname	CNAME of the cert	string
key	Key data	string
status	Enable or disable SSL for scoring	'Disabled' 'Enabled'

SystemService

Name	Description	Value

VirtualMachine

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

VirtualMachineProperties

Name	Description	Value
address	Public IP address of the virtual machine.	string
administratorAccount	Admin credentials for virtual machine	VirtualMachineSshCredentials
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:

• Resource groups - See resource group deployment commands

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": "2018-03-01-preview",
  "name": "string",
  "identity": {
    "type": "SystemAssigned"
  },
  "location": "string",
  "properties": {
    "computeLocation": "string",
    "description": "string",
    "resourceId": "string",
    "computeType": "string"
    // For remaining properties, see Compute objects
  },
  "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",
    "clusterFqdn": "string",
    "sslConfiguration": {
      "cert": "string",
      "cname": "string",
      "key": "string",
      "status": "string"
    },
    "systemServices": [
      {
      }
    ]
  }
}

For BatchAI, use:

{
  "computeType": "BatchAI",
  "properties": {
    "scaleSettings": {
      "autoScaleEnabled": "bool",
      "maxNodeCount": "int",
      "minNodeCount": "int"
    },
    "vmPriority": "string",
    "vmSize": "string"
  }
}

For DataFactory, use:

{
  "computeType": "DataFactory"
}

For HDInsight, use:

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

For VirtualMachine, use:

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

Property values

AKS

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

AKSProperties

Name	Description	Value
agentCount	Number of agents	int Constraints: Min value = 1
agentVMSize	Agent virtual machine size	string
clusterFqdn	Cluster full qualified domain name	string
sslConfiguration	SSL configuration	SslConfiguration
systemServices	System services	SystemService[]

BatchAI

Name	Description	Value
computeType	The type of compute	'BatchAI' (required)
properties	BatchAI properties	BatchAIProperties

BatchAIProperties

Name	Description	Value
scaleSettings	Scale settings for BatchAI	ScaleSettings
vmPriority	Virtual Machine priority	string
vmSize	Virtual Machine Size	string

Compute

Name	Description	Value
computeLocation	Location for the underlying compute	string
computeType	Set to 'AKS' for type AKS. Set to 'BatchAI' for type BatchAI. Set to 'DataFactory' for type DataFactory. Set to 'HDInsight' for type HDInsight. Set to 'VirtualMachine' for type VirtualMachine.	'AKS' 'BatchAI' 'DataFactory' 'HDInsight' 'VirtualMachine' (required)
description	The description of the Machine Learning compute.	string
resourceId	ARM resource id of the compute	string

DataFactory

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

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.	'SystemAssigned'

Microsoft.MachineLearningServices/workspaces/computes

Name	Description	Value
apiVersion	The api version	'2018-03-01-preview'
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
tags	Resource tags	Dictionary of tag names and values. See Tags in templates
type	The resource type	'Microsoft.MachineLearningServices/workspaces/computes'

ResourceTags

Name	Description	Value

ScaleSettings

Name	Description	Value
autoScaleEnabled	Enable or disable auto scale	bool
maxNodeCount	Max number of nodes to use	int
minNodeCount	Min number of nodes to use	int

SslConfiguration

Name	Description	Value
cert	Cert data	string
cname	CNAME of the cert	string
key	Key data	string
status	Enable or disable SSL for scoring	'Disabled' 'Enabled'

SystemService

Name	Description	Value

VirtualMachine

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

VirtualMachineProperties

Name	Description	Value
address	Public IP address of the virtual machine.	string
administratorAccount	Admin credentials for virtual machine	VirtualMachineSshCredentials
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	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 a LinkedService in Azure Machine Learning workspace	This template creates a LinkedService in an existing Azure Machine Learning workspace.
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 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.
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 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@2018-03-01-preview"
  name = "string"
  identity = {
    type = "SystemAssigned"
  }
  location = "string"
  body = jsonencode({
    properties = {
      computeLocation = "string"
      description = "string"
      resourceId = "string"
      computeType = "string"
      // For remaining properties, see Compute objects
    }
  })
  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"
    clusterFqdn = "string"
    sslConfiguration = {
      cert = "string"
      cname = "string"
      key = "string"
      status = "string"
    }
    systemServices = [
      {
      }
    ]
  }
}

For BatchAI, use:

{
  computeType = "BatchAI"
  properties = {
    scaleSettings = {
      autoScaleEnabled = bool
      maxNodeCount = int
      minNodeCount = int
    }
    vmPriority = "string"
    vmSize = "string"
  }
}

For DataFactory, use:

{
  computeType = "DataFactory"
}

For HDInsight, use:

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

For VirtualMachine, use:

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

Property values

AKS

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

AKSProperties

Name	Description	Value
agentCount	Number of agents	int Constraints: Min value = 1
agentVMSize	Agent virtual machine size	string
clusterFqdn	Cluster full qualified domain name	string
sslConfiguration	SSL configuration	SslConfiguration
systemServices	System services	SystemService[]

BatchAI

Name	Description	Value
computeType	The type of compute	'BatchAI' (required)
properties	BatchAI properties	BatchAIProperties

BatchAIProperties

Name	Description	Value
scaleSettings	Scale settings for BatchAI	ScaleSettings
vmPriority	Virtual Machine priority	string
vmSize	Virtual Machine Size	string

Compute

Name	Description	Value
computeLocation	Location for the underlying compute	string
computeType	Set to 'AKS' for type AKS. Set to 'BatchAI' for type BatchAI. Set to 'DataFactory' for type DataFactory. Set to 'HDInsight' for type HDInsight. Set to 'VirtualMachine' for type VirtualMachine.	'AKS' 'BatchAI' 'DataFactory' 'HDInsight' 'VirtualMachine' (required)
description	The description of the Machine Learning compute.	string
resourceId	ARM resource id of the compute	string

DataFactory

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

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.	'SystemAssigned'

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
tags	Resource tags	Dictionary of tag names and values.
type	The resource type	"Microsoft.MachineLearningServices/workspaces/computes@2018-03-01-preview"

ResourceTags

Name	Description	Value

ScaleSettings

Name	Description	Value
autoScaleEnabled	Enable or disable auto scale	bool
maxNodeCount	Max number of nodes to use	int
minNodeCount	Min number of nodes to use	int

SslConfiguration

Name	Description	Value
cert	Cert data	string
cname	CNAME of the cert	string
key	Key data	string
status	Enable or disable SSL for scoring	'Disabled' 'Enabled'

SystemService

Name	Description	Value

VirtualMachine

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

VirtualMachineProperties

Name	Description	Value
address	Public IP address of the virtual machine.	string
administratorAccount	Admin credentials for virtual machine	VirtualMachineSshCredentials
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