Microsoft.MachineLearningServices workspaces/computes 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' = {
  parent: resourceSymbolicName
  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

Microsoft.MachineLearningServices/workspaces/computes

AKS

AKSProperties

BatchAI

BatchAIProperties

Compute

DataFactory

HDInsight

HDInsightProperties

Identity

ResourceTags

ScaleSettings

SslConfiguration

SystemService

VirtualMachine

VirtualMachineProperties

VirtualMachineSshCredentials

Usage Examples

Azure Quickstart Samples

The following Azure Quickstart templates contain Bicep samples for deploying this resource type.

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

Microsoft.MachineLearningServices/workspaces/computes

AKS

AKSProperties

BatchAI

BatchAIProperties

Compute

DataFactory

HDInsight

HDInsightProperties

Identity

ResourceTags

ScaleSettings

SslConfiguration

SystemService

VirtualMachine

VirtualMachineProperties

VirtualMachineSshCredentials

Usage Examples

Azure Quickstart Templates

The following Azure 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"
  parent_id = "string"
  identity {
    type = "string"
    identity_ids = [
      "string"
    ]
  }
  location = "string"
  tags = {
    {customized property} = "string"
  }
  body = {
    properties = {
      computeLocation = "string"
      description = "string"
      resourceId = "string"
      computeType = "string"
      // For remaining properties, see Compute objects
    }
  }
}

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

Microsoft.MachineLearningServices/workspaces/computes

AKS

AKSProperties

BatchAI

BatchAIProperties

Compute

DataFactory

HDInsight

HDInsightProperties

Identity

ResourceTags

ScaleSettings

SslConfiguration

SystemService

VirtualMachine

VirtualMachineProperties

VirtualMachineSshCredentials