Microsoft.MachineLearningServices workspaces/computes 2022-10-01-preview

Article
11/21/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@2022-10-01-preview' = {
  identity: {
    type: 'string'
    userAssignedIdentities: {
      {customized property}: {}
    }
  }
  location: 'string'
  name: 'string'
  properties: {
    description: 'string'
    resourceId: 'string'
    computeType: 'string'
    // For remaining properties, see Compute objects
  }
  sku: {
    capacity: int
    family: 'string'
    name: 'string'
    size: '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'
    propertyBag: any(Azure.Bicep.Types.Concrete.AnyType)
    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'
    autologgerSettings: {
      mlflowAutologger: 'string'
    }
    computeInstanceAuthorizationType: 'string'
    customServices: [
      {
        docker: {
          privileged: bool
        }
        endpoints: [
          {
            hostIp: 'string'
            name: 'string'
            protocol: 'string'
            published: int
            target: int
          }
        ]
        environmentVariables: {
          {customized property}: {
            type: 'string'
            value: 'string'
          }
        }
        image: {
          reference: 'string'
          type: 'string'
        }
        name: 'string'
        volumes: [
          {
            bind: {
              createHostPath: bool
              propagation: 'string'
              selinux: 'string'
            }
            consistency: 'string'
            readOnly: bool
            source: 'string'
            target: 'string'
            tmpfs: {
              size: int
            }
            type: 'string'
            volume: {
              nocopy: bool
            }
          }
        ]
      }
    ]
    enableNodePublicIp: bool
    idleTimeBeforeShutdown: '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 Kubernetes, use:

{
  computeType: 'Kubernetes'
  properties: {
    defaultInstanceType: 'string'
    extensionInstanceReleaseTrain: 'string'
    extensionPrincipalId: 'string'
    instanceTypes: {
      {customized property}: {
        nodeSelector: {
          {customized property}: 'string'
        }
        resources: {
          limits: {
            {customized property}: 'string'
          }
          requests: {
            {customized property}: 'string'
          }
        }
      }
    }
    namespace: 'string'
    relayConnectionString: 'string'
    serviceBusConnectionString: 'string'
    vcName: 'string'
  }
}

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
    notebookServerPort: int
    sshPort: int
    virtualMachineSize: 'string'
  }
}

Property values

AKS

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

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

AKSSchemaProperties

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	Properties of AmlCompute	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'
propertyBag	A property bag containing additional properties.	any
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

BindOptions

Name	Description	Value
createHostPath	Indicate whether to create host path.	bool
propagation	Type of Bind Option	string
selinux	Mention the selinux options.	string

Compute

Name	Description	Value
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 'Kubernetes' for type Kubernetes. Set to 'SynapseSpark' for type SynapseSpark. Set to 'VirtualMachine' for type VirtualMachine.	'AKS' 'AmlCompute' 'ComputeInstance' 'Databricks' 'DataFactory' 'DataLakeAnalytics' 'HDInsight' 'Kubernetes' 'SynapseSpark' '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	Properties of ComputeInstance	ComputeInstanceProperties

ComputeInstanceAutologgerSettings

Name	Description	Value
mlflowAutologger	Indicates whether mlflow autologger is enabled for notebooks.	'Disabled' 'Enabled'

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'
autologgerSettings	Specifies settings for autologger.	ComputeInstanceAutologgerSettings
computeInstanceAuthorizationType	The Compute Instance Authorization type. Available values are personal (default).	'personal'
customServices	List of Custom Services added to the compute.	CustomService[]
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
idleTimeBeforeShutdown	Stops compute instance after user defined period of inactivity. Time is defined in ISO8601 format. Minimum is 15 min, maximum is 3 days.	string
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'

ComputeResourceTags

Name	Description	Value

CustomService

Name	Description	Value
docker	Describes the docker settings for the image	Docker
endpoints	Configuring the endpoints for the container	Endpoint[]
environmentVariables	Environment Variable for the container	CustomServiceEnvironmentVariables
image	Describes the Image Specifications	Image
name	Name of the Custom Service	string
volumes	Configuring the volumes for the container	VolumeDefinition[]

CustomServiceEnvironmentVariables

Name	Description	Value

Databricks

Name	Description	Value
computeType	The type of compute	'Databricks' (required)
properties	Properties of Databricks	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		DataLakeAnalyticsSchemaProperties

DataLakeAnalyticsSchemaProperties

Name	Description	Value
dataLakeStoreAccountName	DataLake Store Account Name	string

Docker

Name	Description	Value
privileged	Indicate whether container shall run in privileged or non-privileged mode.	bool

Endpoint

Name	Description	Value
hostIp	Host IP over which the application is exposed from the container	string
name	Name of the Endpoint	string
protocol	Protocol over which communication will happen over this endpoint	'http' 'tcp' 'udp'
published	Port over which the application is exposed from container.	int
target	Application port inside the container.	int

EnvironmentVariable

Name	Description	Value
type	Type of the Environment Variable. Possible values are: local - For local variable	'local'
value	Value of the Environment variable	string

HDInsight

Name	Description	Value
computeType	The type of compute	'HDInsight' (required)
properties	HDInsight compute 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

Image

Name	Description	Value
reference	Image reference URL	string
type	Type of the image. Possible values are: docker - For docker images. azureml - For AzureML images	'azureml' 'docker'

InstanceResourceSchema

Name	Description	Value

InstanceResourceSchema

Name	Description	Value

InstanceTypeSchema

Name	Description	Value
nodeSelector	Node Selector	InstanceTypeSchemaNodeSelector
resources	Resource requests/limits for this instance type	InstanceTypeSchemaResources

InstanceTypeSchemaNodeSelector

Name	Description	Value

InstanceTypeSchemaResources

Name	Description	Value
limits	Resource limits for this instance type	InstanceResourceSchema
requests	Resource requests for this instance type	InstanceResourceSchema

Kubernetes

Name	Description	Value
computeType	The type of compute	'Kubernetes' (required)
properties	Properties of Kubernetes	KubernetesProperties

KubernetesProperties

Name	Description	Value
defaultInstanceType	Default instance type	string
extensionInstanceReleaseTrain	Extension instance release train.	string
extensionPrincipalId	Extension principal-id.	string
instanceTypes	Instance Type Schema	KubernetesPropertiesInstanceTypes
namespace	Compute namespace	string
relayConnectionString	Relay connection string.	string Constraints: Sensitive value. Pass in as a secure parameter.
serviceBusConnectionString	ServiceBus connection string.	string Constraints: Sensitive value. Pass in as a secure parameter.
vcName	VC name.	string

KubernetesPropertiesInstanceTypes

Name	Description	Value

ManagedServiceIdentity

Name	Description	Value
type	Type of managed service identity (where both SystemAssigned and UserAssigned types are allowed).	'None' 'SystemAssigned' 'SystemAssigned,UserAssigned' 'UserAssigned' (required)
userAssignedIdentities	The set of user assigned identities associated with the resource. The userAssignedIdentities dictionary keys will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}. The dictionary values can be empty objects ({}) in requests.	UserAssignedIdentities