Microsoft.MachineLearningServices workspaces/computes 2020-08-01

Article
12/09/2024

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@2020-08-01' = {
  parent: resourceSymbolicName
  identity: {
    type: 'string'
    userAssignedIdentities: {
      {customized property}: {}
    }
  }
  location: 'string'
  name: 'string'
  properties: {
    computeLocation: 'string'
    description: 'string'
    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'
    sslConfiguration: {
      cert: 'string'
      cname: 'string'
      key: 'string'
      status: 'string'
    }
  }
}

For AmlCompute, use:

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

For ComputeInstance, use:

{
  computeType: 'ComputeInstance'
  properties: {
    applicationSharingPolicy: 'string'
    computeInstanceAuthorizationType: 'string'
    personalComputeInstanceSettings: {
      assignedUser: {
        objectId: 'string'
        tenantId: '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'
  }
}

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

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 = 1
agentVmSize	Agent virtual machine size	string
aksNetworkingConfiguration	AKS networking configuration for vnet	AksNetworkingConfiguration
clusterFqdn	Cluster full qualified domain name	string
sslConfiguration	SSL configuration	SslConfiguration

AmlCompute

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

AmlComputeProperties

Name	Description	Value
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
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)

ComponentsSgqdofSchemasIdentityPropertiesUserassignedidentitiesAdditionalproperties

Name	Description	Value

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 'VirtualMachine' for type VirtualMachine.	'AKS' 'AmlCompute' 'ComputeInstance' 'Databricks' 'DataFactory' 'DataLakeAnalytics' 'HDInsight' 'VirtualMachine' (required)
description	The description of the Machine Learning compute.	string
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
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

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' (required)
userAssignedIdentities	The list of user identities associated with resource. The user identity dictionary key references will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}'.	IdentityUserAssignedIdentities

IdentityUserAssignedIdentities

Name	Description	Value